Bold Reports

https://help.boldreports.com
Admin
Bold Reports provides modern Business Intelligence (BI) reporting tools for creating, deploying, and...
Tokens:1,140,099
Snippets:19,492
Trust Score:9
Update:1 month ago
Show doc for...
Tokens:
Raw
### Linux Installation Path Example

Source: https://help.boldreports.com/embedded-reporting/faq/how-to-deploy-puppeteer-manually

Example path for the location of the chrome executable after manual installation on Linux.

```text
C:\Users\Public\Documents\Bold Reports\Embedded Reporting\Samples\ASP.NET Core\wwwroot\puppeteer\Win64-901912\chrome-linux\chrome
```

--------------------------------

### Windows Installation Path Example

Source: https://help.boldreports.com/embedded-reporting/faq/how-to-deploy-puppeteer-manually

Example path for the location of the chrome.exe executable after manual installation on Windows.

```text
C:\Users\Public\Documents\Bold Reports\Embedded Reporting\Samples\ASP.NET Core\wwwroot\puppeteer\Win64-901912\chrome-win\chrome.exe
```

--------------------------------

### Bold Reports NuGet Installation Examples

Source: https://help.boldreports.com/embedded-reporting/aspnet-web-forms-reporting/report-designer/nuget-packages

Specific examples for installing BoldReports packages using the Package Manager Console.

```powershell
# install specified package in default project
Install-Package BoldReports.WebForms

#install specified package in default project with specified Package Source
Install-Package BoldReports.Web –Source “https://api.nuget.org/v3/index.json”

#install specified package in specified project
Install-Package BoldReports.WebForms -ProjectName BoldReportingApplication
```

--------------------------------

### Silent Installation Command Example

Source: https://help.boldreports.com/embedded-reporting/faq/silent-installation

A concrete example of the command-line string used to perform a silent installation.

```text
/Install silent /InstallPath:C:\Program Files (x86)\New\Report /pidkey:@1243453sdffdfvv /isdesktopshortcut:TRUE /Log "C:\Program Files (x86)\New\Install.log"
```

--------------------------------

### Installing BoldReports.Web via Console

Source: https://help.boldreports.com/embedded-reporting/angular-reporting/report-designer/nuget-packages

Specific examples for installing the BoldReports.Web package using various console parameters.

```powershell
# install specified package in default project
Install-Package BoldReports.Web

#install specified package in default project with specified Package Source
Install-Package BoldReports.Web –Source “https://api.nuget.org/v3/index.json”

#install specified package in specified project
Install-Package BoldReports.Web -ProjectName BoldReportingApplication
```

--------------------------------

### Start Application

Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/server-integration-with-classic-report-designer

Command to start the application after configuration.

```bash
      npm run start
```

--------------------------------

### Clone and Start React Boilerplate

Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/add-web-report-designer-to-a-react-boilerplate-application

Commands to clone the repository, navigate to the directory, install dependencies, and start the application.

```bash
> git clone https://github.com/boldreports/react-boilerplate.git
> cd react-boilerplate
> npm install
> npm start
```

--------------------------------

### Enable and Start Nginx

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-reports-using-rpm-package

Ensure Nginx is enabled and running after package installation.

```bash
systemctl  enable nginx
systemctl start nginx
```

--------------------------------

### Layout Page Localization Setup

Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-designer/how-to/localization-classic-report-designer

Example of a full layout page configuration including the necessary CSS and script references for localization.

```html
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>@ViewData["Title"] - Render Report Designer in French localization</title>

    <environment include="Development">
        <link href="https://cdn.boldreports.com/14.1.12/content/material/bold.reports.all.min.css" rel="stylesheet" />
        <link href="https://cdn.boldreports.com/14.1.12/content/material/bold.reportdesigner.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" />
    </environment>
</head>
<body style="height:100%;width:100%;padding:0;">
    <environment include="Development">
        <script src="https://cdn.boldreports.com/external/jquery-1.10.2.min.js" type="text/javascript"></script>
        <script src="https://cdn.boldreports.com/external/jsrender.min.js" type="text/javascript"></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.44.0/mode/vb/vb.min.js" type="text/javascript"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/common/bold.reports.common.min.js"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/common/bold.reports.widgets.min.js"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/common/bold.report-designer-widgets.min.js"></script>
        <!--Chart component script added before the Report Designer and viewer script to render report with chart report item-->
        <script src="https://cdn.boldreports.com/14.1.12/scripts/data-visualization/ej.chart.min.js"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/bold.report-viewer.min.js" type="text/javascript"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/bold.report-designer.min.js" type="text/javascript"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/l10n/reportdesigner/ej.localetexts.fr-FR.min.js"></script>
        <script src="https://cdn.boldreports.com/14.1.12/scripts/i18n/ej.culture.fr-FR.min.js"></script>
    </environment>
    <div class="container body-content" style="height:100%;width:100%;">
        @RenderBody()
        <bold-script-manager></bold-script-manager>
    </div>
@RenderSection("Scripts", required: false)
</body>
</html>
```

--------------------------------

### Complete Configuration Example

Source: https://help.boldreports.com/mcp-server/api/configuration

A full example of the MCP server configuration including URL, type, and headers.

```json
{
  "boldreports_mcp": {
    "url": "https://mcp.boldreports.com/api/",
    "type": "http",
    "headers": {
      "Authorization": "Bearer eyJhbGciOi...",
      "X-BoldReports-BaseUrl": "https://{yourdomain}/reporting/api/site/{tenant-name}"
    }
  }
}
```

--------------------------------

### Install pv tool

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/upgrade-linux-server

Install the pv utility required for the upgrade process.

```bash
sudo apt-get install pv
```

--------------------------------

### Install Wget

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-reports-on-alma-linux

Command to install the wget utility.

```bash
sudo dnf install wget
```

--------------------------------

### Complete Program.cs Configuration

Source: https://help.boldreports.com/report-viewer-sdk/blazor-reporting/report-viewer/add-report-viewer-to-a-blazor-application

Full configuration for Program.cs including service registration and middleware setup for the Blazor application.

```csharp
using BlazorReportingTools.Components;

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.
builder.Services.AddControllers();
builder.Services.AddMemoryCache();
var app = builder.Build();

// Configure the HTTP request pipeline.
if (!app.Environment.IsDevelopment())
{
    app.UseExceptionHandler("/Error", createScopeForErrors: true);
    // The default HSTS value is 30 days. You may want to change this for production scenarios, see https://aka.ms/aspnetcore-hsts.
    app.UseHsts();
}

app.UseHttpsRedirection();

app.UseStaticFiles();
app.UseAntiforgery();

app.MapRazorComponents<App>()
    .AddInteractiveServerRenderMode();
app.MapControllers();
app.Run();
```

--------------------------------

### Generate Authentication Token in C#

Source: https://help.boldreports.com/enterprise-reporting/developer-guide/how-to/generate-authentication-token-for-user-by-using-embed-secret-key-api

This example demonstrates how to construct the request body, sign the message using HMACSHA256, and call the token endpoint.

```csharp
public class Token
{
    public string access_token { get; set; }

    public string token_type { get; set; }

    public string expires_in { get; set; }

    public string email { get; set; }

    public string error { get; set; }

    public string error_description { get; set; }

}

private static string tokenurl = "/reporting/api/site/site1/token";
private static string boldReportsUrl = "https://demo.example.com"; // Provide your Bold Reports<sup>®</sup> URL
private static string username = "user@example.com"; // Provide your Email ID
private static string nonce = Guid.NewGuid().ToString();
private static string timeStamp = DateTimeToUnixTimeStamp(DateTime.UtcNow).ToString();
private static string secretCode = "lettffAEI0FtKDGdrDekEv7WUbHwOwO"; // Provide your embed secret key value from the Bold Reports<sup>®</sup> Report Server Embed Settings.

public static void Main(string[] args)
{
    ServicePointManager.SecurityProtocol = SecurityProtocolType.Tls | SecurityProtocolType.Tls11 | SecurityProtocolType.Tls12; // This is required while running the Bold Reports<sup>®</sup> from Azure App Service
    GetToken();
}

public static Token GetToken()
{
    var client = new HttpClient();
    client.BaseAddress = new Uri(boldReportsUrl);
    client.DefaultRequestHeaders.Accept.Clear();
    client.DefaultRequestHeaders.ConnectionClose = true;
    string embedMessage = "embed_nonce=" + nonce + "&user_email=" + username + "&timestamp=" + timeStamp;
    string signature = SignURL(embedMessage.ToLower(), secretCode);

    var content = new FormUrlEncodedContent(new[]
    {
       new KeyValuePair<string, string>("grant_type", "embed_secret"),
       new KeyValuePair<string, string>("username", username),
       new KeyValuePair<string, string>("embed_nonce", nonce),
       new KeyValuePair<string, string>("embed_signature", signature),
       new KeyValuePair<string, string>("timestamp", timeStamp)
    });

    var result = client.PostAsync(tokenurl, content).Result;

    string resultContent = result.Content.ReadAsStringAsync().Result;

    if (JsonConvert.DeserializeObject<Token>(resultContent)?.error == "authorization_failed")
    {
        Console.WriteLine("authorization_failed: " + JsonConvert.DeserializeObject<Token>(resultContent)?.error_description);
        Console.ReadLine();
        Environment.Exit(-1);
    }

    return JsonConvert.DeserializeObject<Token>(resultContent);
}

public static double DateTimeToUnixTimeStamp(DateTime dateTime)
{
    DateTime unixStart = new DateTime(1970, 1, 1, 0, 0, 0, 0, System.DateTimeKind.Utc);
    long unixTimeStampInTicks = (dateTime.ToUniversalTime() - unixStart).Ticks;
    return unixTimeStampInTicks / TimeSpan.TicksPerSecond;
}

public static string SignURL(string embedMessage, string secretcode)
{
    var encoding = new UTF8Encoding();
    var keyBytes = encoding.GetBytes(secretcode);
    var messageBytes = encoding.GetBytes(embedMessage);
    using (var hmacsha1 = new HMACSHA256(keyBytes))
        {
            var hashMessage = hmacsha1.ComputeHash(messageBytes);
            return Convert.ToBase64String(hashMessage);
        }
}
```

--------------------------------

### Complete implementation example

Source: https://help.boldreports.com/embedded-reporting/aspnet-web-forms-reporting/report-writer/error-logging

A full example showing report loading, export handling, and integrated error logging.

```csharp
protected void ExportButton_Click(object sender, EventArgs e)
{
     // Here, we have loaded the sales-order-detail sample report from application the folder Resources.
    FileStream reportStream = new FileStream(Server.MapPath("~/Resources/sales-order-detail.rdl"), FileMode.Open, FileAccess.Read);
    BoldReports.Writer.ReportWriter writer = new BoldReports.Writer.ReportWriter();
    writer.ReportErrorOccurred += Writer_ReportErrorOccurred;
    string fileName = null;
    WriterFormat format;
    string type = null;

    if (this.ExportFormat.SelectedValue == "PDF")
    {
        fileName = "sales-order-detail.pdf";
        format = WriterFormat.PDF;
    }
    else if (this.ExportFormat.SelectedValue == "Word")
    {
        fileName = "sales-order-detail.docx";
        format = WriterFormat.Word;
    }
    else if (this.ExportFormat.SelectedValue == "Html")
    {
        fileName = "sales-order-detail.Html";
        format = WriterFormat.HTML;
    }
    else if (this.ExportFormat.SelectedValue == "PPT")
    {
        fileName = "sales-order-detail.ppt";
        format = WriterFormat.PPT;
    }
    else
    {
        fileName = "sales-order-detail.xlsx";
        format = WriterFormat.Excel;
    }
    writer.LoadReport(reportStream);
    HttpContext httpContext = System.Web.HttpContext.Current;
    writer.Save(fileName, format, httpContext.Response);
    }
}
private void Writer_ReportErrorOccurred(object sender, ReportErrorOccurredEventArgs e)
{
    WriteLogs(string.Format("Class Name: {0} \n Method Name: {1} \n Error Message: {2}", e.ClassName, e.MethodName, e.Message));
}

private void WriteLogs(string errorMessage)
{
    string filePath = Path.Combine(Server.MapPath("~/Resources/ErrorDetails.txt"));
    using (StreamWriter writer = new StreamWriter(filePath, true))
    {
        writer.AutoFlush = true;
        writer.WriteLine(errorMessage);
    }
}
```

--------------------------------

### Install Data Hub via Command Prompt

Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/installation

Run the BoldETL.msi file from the installation directory using administrative privileges to correctly configure the service and application pool.

```text
“C:\Program Files (x86) \Bold Reports\Enterprise Reporting\BoldETL>BoldETL.msi”
“C:\Program Files (x86) \Bold Reports Enterprise Edition\BoldETL>BoldETL.msi”
```

--------------------------------

### Run the application

Source: https://help.boldreports.com/embedded-reporting/javascript-reporting/report-viewer/faq/add-web-report-viewer-to-a-vue-application

Execute this command in the terminal to start the development server.

```bash
 npm run serve
```

--------------------------------

### Start Containers and View Logs

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-docker/bold-reports-on-docker/bold-reports-on-single-container

Starts the Bold Reports and PostgreSQL containers in detached mode and follows the logs to monitor installation status.

```bash
docker-compose up -d; docker-compose logs -f boldreports
```

--------------------------------

### Layout Page Localization Setup

Source: https://help.boldreports.com/embedded-reporting/aspnet-mvc-reporting/report-viewer/localization

Example of integrating localization scripts within the _Layout.cshtml file.

```html
<!DOCTYPE html>
<html>
<head>
    <meta charset="utf-8" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0">
    <title>@ViewBag.Title - Render Report Viewer in French localization</title>
    @Styles.Render("~/Content/css")
    @Styles.Render("~/content/bold-reports/v2.0/tailwind-light/bold.report-viewer.min.css")
    @Scripts.Render("~/bundles/modernizr")
</head>
<body>
    <div style="min-height: 600px;width: 100%;">
        @RenderBody()
    </div>
    @Scripts.Render("~/bundles/jquery")
    @Scripts.Render("~/bundles/bootstrap")
    <!-- Report Viewer component dependent script -->
    @Scripts.Render("~/Scripts/bold-reports/v2.0/common/bold.reports.common.min.js")
    @Scripts.Render("~/Scripts/bold-reports/v2.0/common/bold.reports.widgets.min.js")
    <!-- Report Viewer component script-->
    @Scripts.Render("~/Scripts/bold-reports/v2.0/bold.report-viewer.min.js")
    <!-- Report Viewer french localization scripts-->
    @Scripts.Render("~/Scripts/v2.0/localization/l10n/ej.localetexts.fr-FR.min.js")
    @RenderSection("scripts", required: false)
    @Html.Bold().ScriptManager()
</body>
</html>
```

--------------------------------

### Local SQL Server Connection String

Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-designer/designer-guide/manage-data/data-connectors/sql-data-source

Example connection string for a SQL Server Database Engine instance installed on the local machine.

```text
Data source=<InstanceName>; initial catalog=AdventureWorks
```

--------------------------------

### Navigate to project directory and install dependencies

Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/how-to/getting-started-report-viewer-classic

Changes the working directory to the project root and installs the create-react-class package.

```bash
 cd reports
```

```bash
npm install create-react-class --save
```

--------------------------------

### Install Database Client Libraries

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/install-opt-library

Executes the installation script for specified database client libraries.

```bash
$sudo bash install-optional.libs.sh install-optional-libs {user} postgresql,snowflake,mysql,oracle,googlebigquery,mongodb
```

--------------------------------

### Export SSRS Report Example

Source: https://help.boldreports.com/embedded-reporting/aspnet-web-forms-reporting/report-writer/export-ssrs-report

A complete implementation for exporting an SSRS report, including server configuration, credential setup, and format selection.

```csharp
protected void ExportButton_Click(object sender, EventArgs e)
{
    string fileName = null;
    WriterFormat format;
    HttpContext httpContext = System.Web.HttpContext.Current;
    BoldReports.Writer.ReportWriter writer = new BoldReports.Writer.ReportWriter();
    writer.ReportProcessingMode = ProcessingMode.Remote;
    writer.ReportServerUrl = "http://<servername>/Reports_SSRS";
    writer.ReportPath= Server.MapPath("/SSRSSamples2/Territory Sales");
    writer.ReportServerCredential = new System.Net.NetworkCredential("username", "password");
    List<BoldReports.Web.DataSourceCredentials> dataSourceCredentialsList = new List<BoldReports.Web.DataSourceCredentials>();
    dataSourceCredentialsList.Add(new BoldReports.Web.DataSourceCredentials("datasource name", "username", "password"));
    writer.SetDataSourceCredentials(dataSourceCredentialsList);

    if (this.ExportFormat.SelectedValue == "PDF")
    {
        fileName = "sales-order-detail.pdf";
        format = WriterFormat.PDF;
    }
    else if (this.ExportFormat.SelectedValue == "Word")
    {
        fileName = "sales-order-detail.docx";
        format = WriterFormat.Word;
    }
    else if (this.ExportFormat.SelectedValue == "Html")
    {
        fileName = "sales-order-detail.Html";
        format = WriterFormat.HTML;
    }
    else if (this.ExportFormat.SelectedValue == "PPT")
    {
        fileName = "sales-order-detail.ppt";
        format = WriterFormat.PPT;
    }
    else
    {
        fileName = "sales-order-detail.xlsx";
        format = WriterFormat.Excel;
    }
    writer.Save(fileName, format, httpContext.Response);
}
```

--------------------------------

### Configure ReportViewer with Bold Report Server

Source: https://help.boldreports.com/embedded-reporting/aspnet-mvc-reporting/report-viewer/reportserver-report

Step-by-step configuration of the ReportViewer component, starting with the authorization token and culminating in the full report path setup.

```csharp
@(Html.Bold().ReportViewer("viewer")
    .ServiceAuthorizationToken("bearer <server token>")
)
```

```csharp
@(Html.Bold().ReportViewer("viewer")
    .ServiceAuthorizationToken("bearer <server token>")
    .ReportServiceUrl(@"https://service.boldreports.com/api/Viewer")
)
```

```csharp
@(Html.Bold().ReportViewer("viewer")
    .ServiceAuthorizationToken("bearer <server token>")
    .ReportServiceUrl(@"https://service.boldreports.com/api/Viewer")
    .ReportServerUrl(@"https://acmecorp.boldreports.com/reporting/api")
)
```

```csharp
@(Html.Bold().ReportViewer("viewer")
    .ServiceAuthorizationToken("bearer <server token>")
    .ReportServiceUrl(@"https://service.boldreports.com/api/Viewer")
    .ReportServerUrl(@"https://acmecorp.boldreports.com/reporting/api")
    .ReportPath("/Sample Reports/Company Sales")
)
```

--------------------------------

### FULL_TABLE Configuration Example

Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/zendesk-talk

Complete YAML configuration example for the FULL_TABLE replication method.

```yaml
version: 1.0.1
encrypt_credentials: false
plugins:
  extractors:
    - name: zendesk_data
      connectorname: zendesk
      config:
        subdomain: subdomain
        email: mail
        password: password
        token: <>
        Oauth token: <>
      Select:
        - TABLE1
        - TABLE2
      metadata:
        TABLE1:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: '2023-07-19 00:00:00'
          interval_type: days
          interval_value: 6
        TABLE2:
          replication_method: FULL_TABLE
          replication_key: last_modified_on
          replication_value: '2023-07-19 00:00:00'
          interval_type: days
          interval_value: 6
```

--------------------------------

### Install EPEL Repository

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-reports-using-rpm-package

Install the EPEL repository required for Bold Reports installation.

```bash
sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm
```

--------------------------------

### Execute Installation Script

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-report-ubuntu

Commands to run the installation script for standard or SSL-enabled deployments.

```bash
 sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true or false}
```

```bash
    sudo bash install-boldreports.sh -i new -u www-data -h http://linux.example.com -n true
```

```bash
    sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true or false} --ssl-cert {ssl certificate path} --ssl-key {ssl key path}
```

```bash
    sudo bash install-boldreports.sh -i new -u www-data -h https://linux.example.com -n true --ssl-cert /etc/ssl/domain.crt --ssl-key /etc/ssl/domain.key
```

--------------------------------

### Run Bold Reports Installation Script

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-reports-using-rpm-package

Execute the installation script with required parameters to set up Bold Reports.

```bash
sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true or false}
eg : sudo bash install-boldreports.sh -i new -u root -h http://linux.example.com -n true
```

--------------------------------

### Install libicu

Source: https://help.boldreports.com/enterprise-reporting/deployment/deploy-on-linux/bold-reports-on-rocky-os

Command to install the libicu package.

```bash
sudo dnf install libicu
```
Tokens:
Raw