Migrate to Classic Report Designer application
To migrate a JavaScript Report Designer application from Syncfusion® Essential Studio to the classic Bold Reports® Report Designer, 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.
Use these steps to migrate from Syncfusion® Essential Studio release to Bold Reports® version lesser than
v5.2.xx
The following sections provide step-by-step instructions for migrating the Report Designer from Syncfusion® Essential Studio release version to Bold Reports® version 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.jsbold.report-designer-widgets.min.jsbold.report-designer-widgets.min.jsej.chart.min.jsej2-base.min.js ej2-data.min.jsej2-pdf-export.min.js ej2-svg-base.min.jsej2-lineargauge.min.jsej2-circulargauge.min.jsej2-maps.min.jsbold.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-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.ej2-base.min.js - Renders the gauge item. Add this script only if your report contains the gauge report item.ej2-data.min.js - Renders the gauge item. Add this script only if your report contains the gauge report item.ej2-pdf-export.min.js - Renders the gauge item. Add this script only if your report contains the gauge report item.ej2-svg-base.min.js - Renders the gauge item. Add this script only if your report contains the gauge report item.ej2-lineargauge.min.js - Renders the linear gauge item. Add this script only if your report contains the linear gauge report item.ej2-circulargauge.min.js - Renders the circular gauge item. Add this script only if your report contains the circular gauge report item.ej2-maps.min.js - Renders the map item. Add this script only if your report contains the map report item.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.reports.all.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.reports.all.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 |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
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 to the classic 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:
-
Open the Report Designer Web API controller.
-
Configure the following scripts and styles in
OnInitReportOptionson Web API controller:jquery-1.7.1.min.jsbold.reports.common.min.jsbold.reports.widgets.min.jsej.chart.min.js- Exports the chart item. Add this script only if your report contains the chart report item.ej2-base.min.js,ej2-data.min.js,ej2-pdf-export.min.js,ej2-svg-base.min.js,ej2-lineargauge.min.jsandej2-circulargauge.min.js- Exports the gauge item. Add this script only if your report contains the gauge report item.ej2-maps.min.js- Exports the map item. Add this script only if your report contains the map report item.bold.report-viewer.min.js
-
You can replace the
OnInitReportOptionsaction 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", //Gauge component scripts resourcesPath + @"\bold-reports\common\ej2-base.min.js", resourcesPath + @"\bold-reports\common\ej2-data.min.js", resourcesPath + @"\bold-reports\common\ej2-pdf-export.min.js", resourcesPath + @"\bold-reports\common\ej2-svg-base.min.js", resourcesPath + @"\bold-reports\data-visualization\ej2-lineargauge.min.js", resourcesPath + @"\bold-reports\data-visualization\ej2-circulargauge.min.js", //Map component script resourcesPath + @"\bold-reports\data-visualization\ej2-maps.min.js", //Report viewer Script resourcesPath + @"\bold-reports\data-visualization\ej.chart.min.js", resourcesPath + @"\bold-reports\bold.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 preceding script configurations.