Report processing actions are sent in an Ajax request to exchange data with the Web API service. You can handle post actions event to customize the Ajax requests.
AjaxBeforeLoadAjaxSuccessAjaxErrorThis event can be triggered before an Ajax request is sent to the Report Viewer Web API service. It allows you to set additional headers and custom data in the Ajax request. The following code sample demonstrates adding custom authorization header and passing default parameter values to service.
Initialize the ajaxBeforeLoad event in the script and add the authorization token to the headers property.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" ajax-before-load="onAjaxRequest"></bold-report-viewer>
<script type="text/javascript">
function onAjaxRequest(args) {
args.headers.push({ Key: 'Authorization', Value: btoa('guest', 'demo@123') });
}
</script>In this tutorial, the
sales-order-detail.rdlreport is used, and it can be downloaded from here.
Get the custom header value from the HttpContext header collection using the key name specified at client side.
private Microsoft.Extensions.Primitives.StringValues authenticationHeader;
[HttpPost]
public object PostReportAction([FromBody] Dictionary<string, object> jsonResult)
{
//jsonArray = jsonResult;
if (jsonResult != null)
{
//Get client side custom ajax header and store in local variable
HttpContext.Request.Headers.TryGetValue("Authorization", out authenticationHeader);
//Perform your custom validation here
if (authenticationHeader == "")
{
return new Exception("Authentication failed!!!");
}
else
{
return ReportHelper.ProcessReport(jsonResult, this, _cache);
}
}
return ReportHelper.ProcessReport(jsonResult, this, this._cache);
}Perform your own action to validate the header values.
Use the data property to set custom data to the server in the Ajax request. In the following code sample, parameter values are passed to the server side.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" ajax-before-load="onAjaxRequest"></bold-report-viewer>
<script type="text/javascript">
function onAjaxRequest(args) {
//Passing custom data to server
var customerID = "CI0021";
args.data = customerID;
}
</script>The custom data values are stored in the customData header key, and you can store them in the local property. The following code sample demonstrates to change the datasource connection strings based on Customer ID in the OnInitReportOptions method.
string customerID = null;
[HttpPost]
public object PostReportAction([FromBody] Dictionary<string, object> jsonResult)
{
if (jsonResult != null)
{
if (jsonResult.ContainsKey("customData"))
{
//Get client side custom data and store in local variable.
customerID = jsonResult["customData"].ToString();
}
}
return ReportHelper.ProcessReport(jsonResult, this, this._cache);
}
[NonAction]
public void OnInitReportOptions(ReportViewerOptions reportOption)
{
if (customerID != null)
{
if(customerID.Contains("CI0021"))
{
//If you are changing the connection string based on customer id then could you please change the connection string as below.
//reportOption.ReportModel.DataSourceCredentials.Add(new BoldReports.Web.DataSourceCredentials("<Datasource name>", "<connection string>"));
reportOption.ReportModel.DataSourceCredentials.Add(new BoldReports.Web.DataSourceCredentials("<database>", "Data Source=<instancename>;Initial Catalog=<database>;"));
}
else if(customerID.Contains("CI0022"))
{
//If you are changing the connection string based on customer id then could you please change the connection string as below.
//reportOption.ReportModel.DataSourceCredentials.Add(new BoldReports.Web.DataSourceCredentials("<Datasource name>", "<connection string>"));
reportOption.ReportModel.DataSourceCredentials.Add(new BoldReports.Web.DataSourceCredentials("<database>", "Data Source=<instancename>;Initial Catalog=<database>;"));
}
}
}To perform custom action or show user defined message, use the ajaxSuccess event on the successful Ajax request.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" ajax-before-load="onAjaxRequest" ajax-success="onAjaxSuccess"></bold-report-viewer>
<script type="text/javascript">
function onAjaxRequest(args) {
args.headers.push({ Key: 'Authorization', Value: btoa('guest', 'demo@123') });
//Passing custom parameter data to server
args.data = [{ name: 'SalesOrderNumber', labels: ['SO50756'], values: ['SO50756'] }];
}
function onAjaxSuccess(args) {
//Perform your custom success message here
alert("Ajax request success!!!");
}
</script>The ajaxError event is called, if an error occurred with the request, you can display the customized error detail in the event method.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" ajax-before-load="onAjaxRequest" ajax-error="onAjaxFailure"></bold-report-viewer>
<script type="text/javascript">
function onAjaxRequest(args) {
args.headers.push({ Key: 'Authorization', Value: btoa('guest', 'demo@123') });
//Passing custom parameter data to server
args.data = [{ name: 'SalesOrderNumber', labels: ['SO50756'], values: ['SO50756'] }];
}
function onAjaxFailure(args) {
alert("Status: " + args.status + "\n" +
"Error: " + args.responseText);
}
</script>You can never have both an error and a success callback with a request.
The actionName event argument allows to change the methods of IReportController to custom WEB API action endpoints.
Create a new Web Api action method in Report Viewer API controller as in the following code snippet,
[HttpPost]
public object PostReportCustomAction([FromBody] Dictionary<string, object> jsonArray)
{
return ReportHelper.ProcessReport(jsonArray, this, this._cache);
}The custom method must have the
Dictionary<TKey, TValue>argument and add codeReportHelper.ProcessReportfor processing the report.
Register the event ajaxBeforeLoad in your html page and set the newly created name to actionName property as in the below code snippet.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" ajax-before-load="onAjaxRequest"></bold-report-viewer>
<script type="text/javascript">
function onAjaxRequest(args) {
args.actionName = "PostReportCustomAction";
}
</script>Create a new Web Api action method in Report Viewer API controller as in the following code snippet,
[HttpPost]
public object ExportReportCustomAction()
{
return ReportHelper.ProcessReport(null, this, _cache);
}The custom method must have the code
ReportHelper.ProcessReportfor exporting the report.
Register the event onExportProgressChanged in your html page and set the newly created name to actionName property as in the below code snippet.
<bold-report-viewer id="viewer" report-service-url="/api/ReportViewer" processing-mode="Remote" report-path="sales-order-detail.rdl" export-progress-changed="onExportProgressChanged"></bold-report-viewer>
<script type="text/javascript">
function onExportProgressChanged(args) {
if(args.stage === "exportStarted"){
args.actionName = "ExportReportCustomAction";
}
}
</script>