You can embed Report Designer with Report Server to create, edit, browse and publish reports using the Report Server built-in API service.
Follow this steps to integrate Report Server with Bold Reports® Designer version higher than
v5.2.xx
To get started, create a Blazor Server App template application and name it BlazorReportingTools
using Visual Studio 2022. If this template is not available for you, refer to this link to configure the system environment.
The source code for this Blazor reporting components app is available on GitHub.
Start Visual Studio 2022 and click Create new project.
Choose Blazor Server App, and then click Next.
Change the project name, and then click Next.
Select Blazor server app, and then click Create
BoldReports.Net.Core
, System.Data.SqlClient
and Microsoft.AspNetCore.Mvc.NewtonsoftJson
packages, and install them in your Blazor application. The following table provides details about the packages and their usage.Package | Purpose |
---|---|
BoldReports.AspNet.Core |
Creates Web API service is used to process the reports. |
System.Data.SqlClient |
Should be referenced in the project when the RDL report renders visual data from the SQL Server or SQL Azure data source based on the RDL design. The package version should be higher than 4.1.0. |
Microsoft.AspNetCore.Mvc.NewtonsoftJson |
ASP.NET Core MVC features that use Newtonsoft.Json . Includes input and output formatter for JSON and JSON Patch. The package version should be higher than 3.1.2. |
Refer to the NuGet Packages section to learn more details about installing and configuring Report designer NuGet packages.
Directly refer all the required scripts and style sheets from CDN links.
Reference the following online CDN links along with the boldreports-interop.js
interop file in the head section of Pages/_Host.cshtml
to use our JavaScript reporting controls in the Blazor application.
<!-- Report Designer component styles -->
<link href="https://cdn.boldreports.com/9.1.7/content/v2.0/tailwind-light/bold.report-designer.min.css" rel="stylesheet" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/codemirror.min.css" rel="stylesheet" />
<link href="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/show-hint.min.css" rel="stylesheet" />
<script src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.6.0/jquery.min.js"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/codemirror.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/show-hint.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/addon/hint/sql-hint.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/mode/sql/sql.min.js" type="text/javascript"></script>
<script src="https://cdnjs.cloudflare.com/ajax/libs/codemirror/5.37.0/mode/vb/vb.min.js" type="text/javascript"></script>
<!-- Report Designer component dependent scripts -->
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/common/bold.reports.common.min.js"></script>
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/common/bold.reports.widgets.min.js"></script>
<!-- Report Viewer and Designer component scripts -->
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/bold.report-viewer.min.js"></script>
<script src="https://cdn.boldreports.com/9.1.7/scripts/v2.0/bold.report-designer.min.js"></script>
<!-- Blazor interop file -->
<script src="~/scripts/boldreports-interop.js"></script>
The Report Designer requires the serviceAuthorizationToken
, serviceUrl
, and reportServerUrl
to perform the API actions with Bold Report Server. You can provide the information from Report Server, as shown in the following explained manner.
serviceUrl
– Report Server Reporting Service information should be provided for this API.reportServerUrl
- Report Server Reporting Server information should be provided for this API.serviceAuthorizationToken
– Authorization token to communicate with serviceUrl.Create a Data/BoldReportOptions.cs
class with the following code to hold the RDL report designer properties.
[Data/BoldReportOptions.cs]
namespace BlazorReportingTools.Data
{
public class RenderReportDesigner
{
public string ServiceURL { get; set; }
public string ServerURL { get; set; }
public string AuthorizationToken { get; set; }
}
}
Create a boldreports-interop.js
file inside the wwwroot/scripts
folder and use the following code snippet to invoke the Bold Report Designer JavaScript control.
// Interop file to render the Bold Report designer component with properties.
window.BoldReports = {
RenderDesigner: function (elementID, reportDesignerOptions) {
$("#" + elementID).boldReportDesigner({
serviceUrl: reportDesignerOptions.serviceURL,
reportServerUrl: reportDesignerOptions.serverURL,
serviceAuthorizationToken: reportDesignerOptions.authorizationToken
});
}
}
Open a index.razor
page. Remove existing codes and add the following codes
@page "/"
@using Microsoft.JSInterop
@using Microsoft.AspNetCore.Components
@inject IJSRuntime JSRuntime
@using BlazorReportingTools.Data;
<div id="report-designer" style="width: 100%;height: 950px"></div>
@code {
// Reportdesigner options
RenderReportDesigner designerOptions = new RenderReportDesigner();
// Used to render the Bold Report designer component in Blazor page.
public async void RenderReportDesigner()
{
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
// Initial rendering of Bold Report designer
protected override void OnAfterRender(bool firstRender)
{
RenderReportDesigner();
}
}
If you need to know the difference between
reportServiceUrl
andreportServerUrl
, refer to the Difference between Report Service URL and Report Server URL.
You can follow one of the procedure from below based on your Report Server type,
Generate token with your user credentials and assign it to serviceAuthorizationToken. You can refer to the documentation here, to generate the token by using credentials.
public async void RenderReportDesigner()
{
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
You can refer to the documentation here on how to generate the token within an application.
Set the Bold Report Server built-in service URL to the report-service-url
property. The report-service-url
property value should be in format of https://<<Report server name>>/reporting/reportservice/api/designer
.
public async void RenderReportDesigner()
{
designerOptions.ServiceURL = "https://on-premise-demo.boldreports.com/reporting/reportservice/api/Designer";
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
Set the Bold Report Server built-in server URL to the report-server-url
property. The report-server-url
property value should be in format of https://<<Report server name>>/reporting/api/site/<<site name>>
.
public async void RenderReportDesigner()
{
designerOptions.ServiceURL = "https://on-premise-demo.boldreports.com/reporting/reportservice/api/Designer";
designerOptions.ServerURL = "https://on-premise-demo.boldreports.com/reporting/api/site/site1";
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
Generate token with your user credentials and assign it to serviceAuthorizationToken. You can refer the documentation here, to generate the token by using credentials.
public async void RenderReportDesigner()
{
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
You can refer to the documentation here on how to generate the token within an application.
Set the Bold Report Server built-in service URL to the report-service-url
property. The report-service-url
property value is a https://service.boldreports.com/api/Designer
.
public async void RenderReportDesigner()
{
designerOptions.ServiceURL = "https://service.boldreports.com/api/Designer";
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}
Set the Bold Report Server built-in server URL to the report-server-url
property. The report-server-url
property value should be in format of https://<<Report server name>>/reporting/api/
.
public async void RenderReportDesigner()
{
designerOptions.ServiceURL = "https://service.boldreports.com/api/Designer";
designerOptions.ServerURL = "https://acmecorp.boldreports.com/reporting/api/";
designerOptions.AuthorizationToken = "bearer <server token>";
await JSRuntime.InvokeVoidAsync("BoldReports.RenderDesigner", "report-designer", designerOptions);
}