Migrate Report Viewer application

In our Bold Reports new assemblies are introduced for both client and server-side to resolve the compatibility problem between Essential Studio Report Viewer versions. It has changes in both Web API service and client-side scripts.

This section provides step-by-step instructions for migrating Report Viewer from Syncfusion Essential Studio release version to Bold Reports version of ASP.NET Web Forms Report Viewer application:

Client-side migration

1. In the Solution Explorer, right-click the References and remove the following assembly references:

   • Syncfusion.EJ
   • Syncfusion.EJ.Web

2. Add the assembly from the Bold Reports NuGet package BoldReports.WebForms. To add from NuGet, right-click the project or solution in the Solution Explorer tab, and choose Manage NuGet Packages. Search for BoldReports.WebForms NuGet package, and install in your application.

Refer to the NuGet Packages section to learn more details about installing and configuring Report Viewer NuGet packages.

Scripts and CSS references

1. Remove the following scripts and CSS references from the Report Viewer Default.aspx page.

   • ej.web.all.min.css
   • ej.web.all.min.js

2. The Report Viewer scripts and style sheets are added to the Scripts and Content folders in your application when installing the BoldReports.WebForms NuGet package. Add scripts as in the following code sample.

   <link href="Content/bold-reports/v2.0/tailwind-light/bold.report-viewer.min.css" rel="stylesheet" />
   <script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js" type="text/javascript"></script>
   <script src="Scripts/bold-reports/v2.0/common/bold.reports.common.min.js"></script>
   <script src="Scripts/bold-reports/v2.0/common/bold.reports.widgets.min.js"></script>
   <script src="Scripts/bold-reports/v2.0/bold.report-viewer.min.js"></script>

Adding data visualization scripts

To render the report with data visualization components such as chart, gauge, and map items, add scripts of the visualization element. The following table shows the script reference that needs to be added in Report Viewer page for data visualization elements.

The following code can be used to render the chart, gauge, and map report items in Report Viewer.

<link href="Content/bold-reports/v2.0/tailwind-light/bold.report-viewer.min.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js" type="text/javascript"></script>
<script src="Scripts/bold-reports/v2.0/common/bold.reports.common.min.js"></script>
<script src="Scripts/bold-reports/v2.0/common/bold.reports.widgets.min.js"></script>
<script src="Scripts/bold-reports/v2.0/bold.report-viewer.min.js"></script>

Control initialization

1. The component prefix has been changed from ej to Bold.

2. Open the Web.config file and add the BoldReports.WebForms assembly reference to the <system.web.pages.controls> element with Bold tag prefix.

   <configuration>
       ....
       ....
       <system.web>
           ....
           <pages>
           ....
           <controls>
               <add assembly="BoldReports.WebForms" namespace="BoldReports.WebForms" tagPrefix="Bold" />
               ....
           </controls>
           </pages>
       </system.web>
       ....
       ....
   </configuration>

3. Open the Report Viewer component page.

4. Replace the tag ej:ReportViewer as Bold:ReportViewer.

   <div style="height: 650px;width: 950px;min-height:404px;">
       <Bold:ReportViewer runat="server" ID="viewer">
       </Bold:ReportViewer>
   </div>

   If your application contains Report Viewer initialization in multiple pages then replace in all the pages.

Server-side migration

1. In the Solution Explorer, right-click the References and remove the Syncfusion.EJ.ReportViewer assembly reference.
2. Add the assembly from the Bold Reports NuGet package BoldReports.Web. To add from NuGet, right-click the project or solution in the Solution Explorer tab, and choose Manage NuGet Packages. Search for BoldReports.Web NuGet package, and then install in your application.

Refer to the NuGet Packages section to learn more details about installing and configuring Report Viewer NuGet packages.

Web API Controller

1. The IReportController interface is moved to BoldReports.Web.ReportViewer. Open the Report Viewer Web API Controller file and remove the following using statement.

   using Syncfusion.EJ.ReportViewer;

2. Add the following using statement.

   using BoldReports.Web.ReportViewer;

Your application is successfully upgraded to the latest version of Report Viewer, and you can run the application with new assemblies.

Report export configuration

Now, the BoldReports.Web can export the reports with data visualization components only using web components. It is mandatory to configure the web scripts in Report Viewer Web API controller for exporting data visualization components such as chart, gauge, and map that are used in report definition. To configure the scripts in Web API, refer to the following steps:

1. Open the Report Viewer Web API controller.

2. Configure the following scripts and styles in OnInitReportOptions on Web API controller:

   • bold.report-viewer.min.css
   • jquery.min.js
   • bold.reports.common.min.js
   • bold.reports.widgets.min.js
   • bold.report-viewer.min.js

3. Replace the following codes in Report Viewer Web API controller.

   [NonAction]
   public void OnInitReportOptions(ReportViewerOptions reportOption)
   {
       var resourcesPath = System.Web.Hosting.HostingEnvironment.MapPath("~/Scripts");
   
       reportOption.ReportModel.ExportResources.Scripts = new List<string>
       {
           resourcesPath + @"\bold-reports\v2.0\common\bold.reports.common.min.js",
           resourcesPath + @"\bold-reports\v2.0\common\bold.reports.widgets.min.js",
           //Report Viewer Component Script
           resourcesPath + @"\bold-reports\v2.0\bold.report-viewer.min.js"
       };
   
       reportOption.ReportModel.ExportResources.DependentScripts = new List<string>
       {
           "https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"
       };
   }

   The data visulization components will not export without the above script configurations.