Search results
Suggest a FeaturePDF

Migrate Report Designer application

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

This section provides step-by-step instructions for migrating Report Designer from Syncfusion® Essential Studio release version to Bold Reports® version higher than v5.2.xx of ASP.NET Web Forms Report Designer application.

Scripts

Old Scripts New Scripts Description
ej.web.all.min.js bold.reports.common.min.js
bold.reports.widgets.min.js
bold.report-viewer.min.js
We have removed the dependency scripts for report designer from existing ej.web.all.min.js script and provided the dependency scripts as below:

bold.reports.common.min.js - Common script for reporting widgets.

bold.reports.widgets.min.js - It contains the scripts of dependent controls that are common for both Report Designer and Report Viewer.

bold.report-viewer.min.js - Previews the reports designed with Report Designer.

ej.reportdesigner.min.js bold.report-designer.min.js Renamed the report designer script file and it used to render the Bold Report Designer widget.

Styles

Old Scripts New Scripts Description
ej.web.all.min.css bold.report-designer.min.css We have removed the dependent controls styles for report designer from existing ej.web.all.min.css script and provided the dependent controls styles as bold.report-designer.min.css.

Remove the old scripts and styles references from existing application, then add the new scripts and styles references based on above script name changes.

Assemblies

Purpose Old Assemblies New Assemblies Description
Base Assemblies Syncfusion.EJ.ReportViewer.dll

Syncfusion.EJ.ReportDesigner.dll
BoldReports.Web.dll The Syncfusion.EJ.ReportViewer.dll and Syncfusion.EJ.ReportDesigner.dll assemblies have been combined as BoldReports.Web.dll.
ASP.NET Web Forms Helper Assemblies Syncfusion.EJ.dll

Syncfusion.EJ.Web.dll
BoldReports.WebForms.dll The Syncfusion.EJ.dll and Syncfusion.EJ.Web.dll assemblies have been combined as BoldReports.WebForms.dll.

Packages

Purpose Old Packages New Packages
Server Side Helper Syncfusion.ReportDesigner.AspNet

Syncfusion.ReportViewer.AspNet

BoldReports.Web
Control Syncfusion.AspNet

BoldReports.WebForms

Register tag prefix in Web.config file

The ASP.NET webforms reporting components tag prefix has been changed from ej to SF. Open the Web.config file and add the BoldReports.WebForms assembly reference to the <system.web.pages.controls> element with SF tag prefix.

Old code snippet New code snippet
<configuration>
....
....
<system.web>
....
....
<pages>
<controls>
....
....
<add assembly="Syncfusion.EJ.Web" namespace="Syncfusion.EJ.Web" tagPrefix="EJ"/>
</controls>
</pages>
</system.web>
....
....
</configuration>
<configuration>
....
....
<system.web>
....
....
<pages>
<controls>
....
....
<add assembly="BoldReports.WebForms" namespace="BoldReports.WebForms" tagPrefix="Bold"/>
</controls>
</pages>
</system.web>
....
....
</configuration>

Namespace changes

Assembly Name

Old Namespace

New Namespace

BoldReports.Web.dll

Syncfusion.Reports.EJ

BoldReports.Web

Syncfusion.EJ.ReportWriter

BoldReports.Writer

Syncfusion.EJ.ReportViewer

BoldReports.Web.ReportViewer

Syncfusion.EJ.ReportDesigner

BoldReports.Web.ReportDesigner

Syncfusion.Reports.EJ.Data

BoldReports.Data

Syncfusion.Reporting

BoldReports.Configuration

Syncfusion.EJ.RDL.ServerProcessor

BoldReports.ServerProcessor

Based on above assembly and namespace changes, modify the Report Designer Web API Controller in your application.

Control initialization

Old code snippet New code snippet
<ej:ReportDesigner runat="server" ID="designer"> </ej:ReportDesigner> <Bold:ReportDesigner runat="server" ID="designer"> </Bold:ReportDesigner>

Report export configuration

The BoldReports.Web assembly can export the reports with data visualization components such as chart, gauge, and map, only if we configure the web scripts in Report Designer Web API controller. To configure the scripts in Web API controller, refer to the following steps:

  1. Open the Report Designer Web API controller.

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

    • jquery-3.6.0.min.js
    • bold.reports.common.min.js
    • bold.reports.widgets.min.js
    • bold.report-viewer.min.js
  3. You can replace the OnInitReportOptions action in Report Designer Web API controller using below code snippet.

    [NonAction]
    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        var resourcesPath = System.Web.Hosting.HostingEnvironment.MapPath("~/Scripts");
    
        reportOption.ReportModel.ExportResources.Scripts = new List<string>
        {
            resourcesPath + @"\bold-reports\common\bold.reports.common.min.js",
            resourcesPath + @"\bold-reports\common\bold.reports.widgets.min.js",
            resourcesPath + @"\bold-reports\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 visualization components will not export without the above script configurations.