Search results

Migrate Report Designer application

In our Report Platform release version v4.1.0.x, new reporting assemblies, scripts, and styles are introduced for both desktop and web components to resolve the compatibility problem between Essential Studio and Report Platform component versions.

The following migration changes must be implemented in your existing Report Designer application, which was created using our Report Platform v3.2.0.42 and below versions.

NPM packages

Platform Old Package New Package
Javascript

syncfusion-javascript

@syncfusion/reporting-javascript
Angular

ej-angular2

@syncfusion/reporting-angular
Globalize

syncfusion-ej-global

@syncfusion/reporting-global

The above Javascript NPM packages contain the following scripts and styles required for Reporting components.

Reporting Component Styles Scripts Usage
Report Viewer ej.reports.all.min.css ej.reporting.common.min.js

ej.reporting.widgets.min.js

ej.chart.min.js

ej.lineargauge.min.js

ej.circulargauge.min.js

ej.map.min.js

ej.report-viewer.min.js

ej.reports.all.min.css - It contains the styles and css references of reporting dependent components.

ej.reporting.common.min.js - Common script for reporting widgets.

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

ej.chart.min.js - Renders the chart item. Add this script only if your report contains the chart report item.

ej.lineargauge.min.js - Renders the linear gauge item. Add this script only if your report contains the linear gauge report item.

ej.circulargauge.min.js - Renders the circular gauge item. Add this script only if your report contains the circular gauge report item.

ej.map.min.js - Renders the map item. Add this script only if your report contains the map report item.

ej.report-viewer.min.js - Renders the Syncfusion Report Viewer widget.

Report Designer ej.reports.all.min.css

ej.reportdesigner.min.css
ej.reporting.common.min.js

ej.reporting.widgets.min.js

ej.report-designer-widgets.min.js

ej.chart.min.js

ej.lineargauge.min.js

ej.circulargauge.min.js

ej.map.min.js

ej.report-viewer.min.js

ej.report-designer.min.js
ej.reports.all.min.css - It contains the styles and css references of reporting dependent components.

ej.reportdesigner.min.css - It contains the styles and css references of Report Designer Component.

ej.reporting.common.min.js - Common script for reporting widgets.

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

ej.report-designer-widgets.min.js - It contains the scripts of Report Designer dependent controls.

ej.chart.min.js - Renders the chart item. Add this script only if your report contains the chart report item.

ej.lineargauge.min.js - Renders the linear gauge item. Add this script only if your report contains the linear gauge report item.

ej.circulargauge.min.js - Renders the circular gauge item. Add this script only if your report contains the circular gauge report item.

ej.map.min.js - Renders the map item. Add this script only if your report contains the map report item.

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

ej.report-designer.min.js - Renders the Syncfusion Report Designer widget.

Server-side migration

Assemblies

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

Syncfusion.EJ.ReportDesigner.dll
Syncfusion.Reporting.Web.dll The Syncfusion.EJ.ReportViewer.dll and Syncfusion.EJ.ReportDesigner.dll assemblies have been combined as Syncfusion.Reporting.Web.dll.

Packages

Old Packages New Packages
Syncfusion.Web.ReportDesigner

Syncfusion.Web.ReportViewer

Syncfusion.Reporting.Web

Namespace changes

Assembly Name

Old Namespace

New Namespace

Syncfusion.Reporting.Web.dll

Syncfusion.Reports.EJ

Syncfusion.Reporting.Web

Syncfusion.EJ.ReportWriter

Syncfusion.Reporting.Writer

Syncfusion.EJ.ReportViewer

Syncfusion.Reporting.Web.ReportViewer

Syncfusion.EJ.ReportDesigner

Syncfusion.Reporting.Web.ReportDesigner

Syncfusion.Reports.EJ.Data

Syncfusion.Reporting.Data

Syncfusion.Reporting

Syncfusion.Reporting.Extensions.Configuration

Syncfusion.EJ.RDL.ServerProcessor

Syncfusion.Reporting.ServerProcessor

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

Report export configuration

The Syncfusion.Reporting.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-1.7.1.min.js
    • ej.reporting.common.min.js
    • ej.reporting.widgets.min.js
    • ej.chart.min.js - Exports the chart item. Add this script only if your report contains the chart report item.
    • ej.lineargauge.min.js and ej.circulargauge.min.js - Exports the gauge item. Add this script only if your report contains the gauge report item.
    • ej.map.min.js - Exports the map item. Add this script only if your report contains the map report item.
    • ej.report-viewer.min.js
  3. You can replace the OnInitReportOptions action in Report Designer Web API controller using below code snippet.

    public void OnInitReportOptions(ReportViewerOptions reportOption)
    {
        var resourcesPath = System.Web.Hosting.HostingEnvironment.MapPath("~/Scripts");
    
        reportOption.ReportModel.ExportResources.Scripts = new List<string>
        {
            resourcesPath + @"\reports\common\ej.reporting.common.min.js",
            resourcesPath + @"\reports\common\ej.reporting.widgets.min.js",
            //Chart component script
            resourcesPath + @"\reports\data-visualization\ej.chart.min.js",
            //Gauge component scripts
            resourcesPath + @"\reports\data-visualization\ej.lineargauge.min.js",
            resourcesPath + @"\reports\data-visualization\ej.circulargauge.min.js",
            //Map component script
            resourcesPath + @"\reports\data-visualization\ej.map.min.js",
            //Report viewer Script
            resourcesPath + @"\reports\data-visualization\ej.chart.min.js",
            resourcesPath + @"\reports\ej.report-viewer.min.js"
        };
    
        reportOption.ReportModel.ExportResources.DependentScripts = new List<string>
        {
            resourcesPath + @"\jquery-1.7.1.min.js"
        };
    }

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