Getting Started with JavaScript Report Viewer

24 Aug 20216 minutes to read

This section explains you the steps required to display a report which is already created and added to your application. The Report Viewer requires a Web API service to process the report files, so you must create any one of the following Web API service.

After creating the Web API service, add the Report Viewer to your application page to render the reports.

IMPORTANT

The Report Viewer is only for rendering the reports. You must use a report generation tool to create a report and to learn more about this, refer to the Create Report section for creating new reports.

This tutorial uses the same Web API service application created in Create ASP.NET Web API Service tutorial.

Adding already created report

Create a folder App_Data in your application for storage and add already created reports to it.

NOTE

In this tutorial, the Sales Order Detail.rdl report is used, and it can be downloaded from here. You can add the reports from Syncfusion installation location. For more information, see Samples and demos.

Adding scripts and CSS references

Create an HTML page in your application, then add scripts and style sheets that are mandatorily required to use the Report Viewer which are listed as follows in an appropriate order.

ej.web.all.min.css
jquery-1.10.2.min.js
jquery.easing.min.js
ej.web.all.min.js

You can use the following code in <head> tag of the Report Viewer HTML page.

HTML

<link href="https://cdn.syncfusion.com/24.2.3/js/web/flat-azure/ej.web.all.min.css" rel="stylesheet" />
<script src="https://code.jquery.com/jquery-1.10.2.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery-easing/1.3/jquery.easing.min.js" type="text/javascript"></script>
<script src="https://cdn.syncfusion.com/24.2.3/js/web/ej.web.all.min.js" type="text/javascript"></script>

Initialize Report Viewer

Add the following code in the <body> tag in the Report Viewer HTML page. Set the reportPath and reportServiceUrl properties of the Report Viewer

HTML

<div style="height: 600px; width: 950px;">
        <!-- Creating a div tag which will act as a container for ejReportViewer widget.-->
        <div style="height: 600px; width: 950px; min-height: 400px;" id="viewer"></div>
        <!-- Setting property and initializing ejReportViewer widget.-->
        <script type="text/javascript">
            $(function () {
                $("#viewer").ejReportViewer({
                    reportServiceUrl: "/api/ReportsApi",
                    reportPath: '~/App_Data/Sales Order Detail.rdl'
                });
            });
        </script>
    </div>

NOTE

The report path property is set to the RDL report that is added in the project App_Data folder.
In this tutorial the Report Viewer page and Web API service are in the same application.

Run the application

Build and run the application, the report rendered in the Report Viewer as shown in the following screenshot.
Sales order detail report preview

Render report in print mode

By default, reports are rendered in normal layout in which the print margins are not displayed. To view the render the report as like printable output, set the printMode property value as true as shown in the following code snippet.

JAVASCRIPT

<script type="text/javascript">
        $(function () {
            $("#viewer").ejReportViewer({
                reportServiceUrl: "/api/ReportsApi",
                reportPath: '~/App_Data/Sales Order Detail.rdl',
                printMode:true
            });
        });
    </script>

Set data source credential

You can specify credentials in the Web API service for the report data sources that use Windows Authentication, database authentication, or custom authentication. Create a new DataSourceCredentials object with the data source name, username and password then add it to the DataSourceCredentials property in the OnInitReportOptions method as in the below code snippet.

public void OnInitReportOptions(ReportViewerOptions reportOption)
{
    //Here the "AdventureWorks" is the data source name provided in report definition. Name property is case sensitive.
    reportOption.ReportModel.DataSourceCredentials.Add(new Syncfusion.Reports.EJ.DataSourceCredentials("AdventureWorks", "demoreadonly@data-platform-demo", "N@c)=Y8s*1&dh"));
}

NOTE

The data source name is case sensitive, so the name should be same as available in the report definition.

Change data source connection string

You can change the connection string of a report data source before it is loaded in the Report Viewer. The DataSourceCredentials class provides the option to set and update the modified connection string as in the following code snippet.

public class ReportsApiController : ApiController, IReportController
    {
        ……        
        public void OnInitReportOptions(ReportViewerOptions reportOption)
        {
            reportOption.ReportModel.DataSourceCredentials.Add(new Syncfusion.Reports.EJ.DataSourceCredentials("AdventureWorks", "demoreadonly@data-platform-demo","N@c)=Y8s*1&dh","Data Source=dataplatformdemodata.syncfusion.com;Initial Catalog=AdventureWorks;"));        
        }
    }

NOTE

The previous code shows an option to change the connection string only, but the class provides multiple options to change data source information. To learn more about this, refer to the DataSourceCredentials class.