Migrate Report Designer application

To migrate a JavaScript Report Designer application from Syncfusion® Essential Studio to Bold Reports®, replace the old scripts, styles, assemblies, packages, namespaces and control initialization with the Bold Reports® ones. Bold Reports® introduces new client-side and server-side assemblies to resolve the compatibility problem between Essential Studio Report Designer versions, with changes in both the Web API service and the client-side scripts.

The following sections provide step-by-step instructions for migrating the Report Designer from Syncfusion® Essential Studio release version to Bold Reports® version higher than v5.2.xx of JavaScript Report Designer application:

Client-side migration

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 follows:

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. It renders the Bold Reports® 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 the preceding script name changes.

Server-side migration

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.

Packages

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

Syncfusion.Web.ReportViewer

BoldReports.Web
Script and Style Packages Syncfusion.JavaScript.ReportDesigner

Syncfusion.JavaScript

BoldReports.JavaScript

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 the preceding assembly and namespace changes, modify the Report Designer Web API Controller in your application.

Control initialization

Old code snippet New code snippet
$("#container").ejReportDesigner(); $("#container").boldReportDesigner();

How do I configure report export after migrating the JavaScript Report Designer?

The BoldReports.Web assembly can export the reports with data visualization components such as chart, gauge, and map, only if you configure the web scripts in the Report Designer Web API controller. To configure the scripts in the Web API controller, use 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 the Report Designer Web API controller using the following 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",
        //Report viewer Script
        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 preceding script configurations.