### Initialize React Project with Create React App Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/add-web-report-viewer-to-a-react-application Commands to install Create React App globally and create a new React application. Creates a build setup with no configuration and includes react, react-dom, react-scripts, and other required dependencies. ```Shell npm install create-react-app -g create-react-app reports ``` -------------------------------- ### Example NuGet Package Installations Source: https://help.boldreports.com/embedded-reporting/javascript-reporting/report-viewer/nuget-packages Demonstrates concrete examples of the Package Manager Console commands for installing the BoldReports.Web package. These examples show how to install to the default project, specify an online source, and target a named project. ```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 BoldReportsApplication ``` -------------------------------- ### Install Bold Reports on Rocky Linux (Example) Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rocky-os Executes the Bold Reports installation script with example parameters. It specifies a new installation, the 'root' user, a host URL, and enables automatic Nginx configuration. ```bash sudo bash install-boldreports.sh -i new -u root -h http://linux.example.com -n true ``` -------------------------------- ### Clone and Start React Boilerplate Application Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/add-web-report-designer-to-a-react-boilerplate-application Commands to clone the Bold Reports React Boilerplate repository, navigate to the directory, install dependencies, and start the application. Ensures the project is set up and running. ```bash > git clone https://github.com/boldreports/react-boilerplate.git > cd react-boilerplate > npm install > npm start ``` -------------------------------- ### Example Bold Reports Linux Installation Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-debian-linux An example of how to execute the Bold Reports installation script for a new installation, specifying the user, host URL, and enabling Nginx auto-configuration. ```bash sudo bash install-boldreports.sh -i new -u www-data -h http://linux.example.com -n true ``` -------------------------------- ### Bold Reports Installation Script Example Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-opensuse-15 Provides an example of the command-line syntax and an actual command to deploy Bold Reports on Linux. It demonstrates how to specify installation type ('new'), user ('www-data'), host URL ('http://linux.example.com'), and whether to auto-configure Nginx ('true'). ```bash sudo bash install-boldreports.sh -i new -u root -h http://linux.example.com -n true # Example for new installation: sudo bash install-boldreports.sh -i new -u www-data -h http://linux.example.com -n true ``` -------------------------------- ### Install Bold Reports React Package Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/add-web-report-viewer-to-a-react-application Installs Bold Reports React library with version-specific commands. For React versions greater than 16, use the latest package. For React 16 or less, use version 5.3.8 to avoid compatibility issues. ```Shell cd reports npm install create-react-class --save ``` ```Shell npm install @boldreports/react-reporting-components@latest --save-dev ``` ```Shell npm install @boldreports/react-reporting-components@5.3.8 --save-dev ``` -------------------------------- ### Example: Bold Reports Silent Installation (No SubApp) Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/windows-installer/silent-installation An example command line demonstrating the parameters for a silent installation or upgrade of Bold Reports Enterprise Edition. This includes specific paths, port numbers, and site names. ```batch start "" /wait boldreports_enterprisereporting_9.1.7_0250.exe /Install Silent /InstallPath:"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\" /DeploymentPath:"C:\BoldServices\" /IISPortNo:65301 /IISSiteName:"BoldReportsEnterpriseReporting" /IsSetFirewall:TRUE /IsUpgrade:TRUE /IsCommonLogin:FALSE /IsDesktopShortcut:TRUE /IsStartMenuShortcut:TRUE /IsSilentStartUp:FALSE ``` -------------------------------- ### Install PV Tool on RHEL Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to install the `pv` tool using the `dnf` package manager on RHEL. ```bash sudo dnf install pv ``` -------------------------------- ### Execute Bold Reports Installation Script Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-using-rpm-package Runs the Bold Reports installation script with parameters for initial setup, user account, host URL, and SSL configuration. Must be executed from the /opt/boldreports/boldreports-package/ directory. The script deploys the application with specified configuration and is the final step in the installation process. ```shell sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true or false} # Example: sudo bash install-boldreports.sh -i new -u root -h http://linux.example.com -n true ``` -------------------------------- ### Starting the React Application with npm Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/add-web-report-designer-to-a-react-boilerplate-application Run the npm start command in the terminal to build, bundle, and serve the React application locally. This starts the development server accessible at http://localhost:3000. Requires Node.js and npm; no inputs or outputs beyond console logs; limitations include port conflicts if 3000 is in use. ```bash npm start ``` -------------------------------- ### Deploy Bold Reports Application Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to deploy the Bold Reports application using the install script and various command line arguments. ```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 root -h http://linux.example.com -n true ``` ```bash sudo bash install-boldreports.sh -i new -u www-data -h http://linux.example.com -n true ``` -------------------------------- ### Enable and Start Nginx Service Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-using-rpm-package Configures Nginx to start automatically on boot and starts the service immediately. Nginx serves as the web server for Bold Reports. Requires systemd-based Linux distribution and Nginx to be installed as a dependency. ```shell systemctl enable nginx systemctl start nginx ``` -------------------------------- ### Install Nginx on OpenSUSE 15 Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-opensuse-15 Installs Nginx web server on OpenSUSE 15. This involves refreshing repositories, adding the Nginx repository, importing the signing key, and finally installing the Nginx package. The service is then started and enabled to run on boot. ```bash sudo zypper refresh sudo zypper addrepo https://nginx.org/packages/sles/15 nginx sudo rpm --import https://nginx.org/keys/nginx_signing.key sudo rpm -qa gpg-pubkey sudo zypper refresh sudo zypper install nginx sudo systemctl start nginx sudo systemctl enable nginx ``` -------------------------------- ### Example: Bold Reports Silent Installation (Combination Case) Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/windows-installer/silent-installation An example command line for a silent upgrade of Bold Reports Enterprise Edition in a combination installation with Bold BI. This demonstrates the use of parameters like IsCommonLogin set to TRUE. ```batch start "" /wait boldreports_enterprisereporting_9.1.7_0250.exe /Install Silent /InstallPath:"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\" /DeploymentPath:"C:\BoldServices\" /IISPortNo:65301 /IISSiteName:"BoldReportsEnterpriseReporting" /IsSetFirewall:TRUE /IsUpgrade:TRUE /IsCommonLogin:TRUE /IsDesktopShortcut:TRUE /IsStartMenuShortcut:TRUE /IsSilentStartUp:FALSE ``` -------------------------------- ### Install Wget Package on RHEL Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to install the `wget` package using the `dnf` package manager on RHEL. It is used to download the Bold Reports package. ```bash sudo dnf install wget ``` -------------------------------- ### Example: Bold Reports Silent Installation (Sub-Application) Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/windows-installer/silent-installation An example command line for silently installing Bold Reports Enterprise Edition as a sub-application. This specifies the parent IIS site, sub-application name, and domain name. ```batch start "" /wait boldreports_enterprisereporting_9.1.7_0250.exe /Install Silent /InstallPath:"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\" /DeploymentPath:"C:\BoldServices\" /IISSiteName:"Default Web Site" /IISSubAppName:Bold /IISSubAppDomainName:"http://localhost" /IsSetFirewall:TRUE /IsUpgrade:FALSE /IsCommonLogin:FALSE /IsDesktopShortcut:TRUE /IsStartMenuShortcut:TRUE /IsSilentStartUp:FALSE ``` -------------------------------- ### Install GDIPlus Package on RHEL Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to install the `GDIPlus` package using `dnf` and `yum` package managers on RHEL. Ensure that EPEL repository is enabled. ```bash sudo dnf install https://dl.fedoraproject.org/pub/epel/epel-release-latest-9.noarch.rpm ``` ```bash sudo yum install epel-release ``` ```bash sudo yum install libgdiplus ``` -------------------------------- ### Example FULL_TABLE Configuration in YAML Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/strip A complete example of a YAML configuration for the Stripe connector using FULL_TABLE data refresh mode, including settings for multiple tables and interval-based updates. ```YAML version: 1 encrypt_credentials: false plugins: extractors: - name: stripe_data connectorname: stripe config: stripe_secret_key: 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 Zip Package on RHEL Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to install the `zip` package using the `dnf` package manager on RHEL. It is a prerequisite for extracting the Bold Reports package. ```bash sudo dnf install zip ``` -------------------------------- ### Silent Install or Upgrade Bold Reports via Command Line Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/windows-installer/silent-installation Executes a silent installation or upgrade of Bold Reports using command-line parameters to configure installation paths, IIS settings, firewall rules, shortcuts, and common login options. Requires administrative privileges and the specific Bold Reports installer executable. Outputs include setup progress and potential log files; limitations include dependency on Windows environment and valid exe versions. ```batch start "" /wait boldreports_enterprisereporting_9.1.7_0250.exe /Install Silent /InstallPath:"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\" /DeploymentPath:"C:\BoldServices\" /IISSiteName:"Default Web Site" /IISSubAppName:Bold /IISSubAppDomainName:"http://localhost" /IsSetFirewall:true /IsUpgrade:TRUE /IsCommonLogin:FALSE /IsDesktopShortcut:TRUE /IsStartMenuShortcut:TRUE /IsSilentStartUp:FALSE ``` ```batch start "" /wait boldreports_enterprisereporting_(version)_(timestamp).exe /InstallPath:{Location to install} /DeploymentPath:{Deployment path} /IISSiteName:{siteName} /IISSubAppName:{Sub app name} /IISSubAppDomainName:{Sub app domain name} /IsSetFirewall:{TRUE/FALSE} /IsUpgrade:TRUE /IsCommonLogin:TRUE /IsDesktopShortcut:{TRUE/FALSE} /IsStartMenuShortcut:{TRUE/FALSE} /IsSilentStartUp:{TRUE/FALSE} ``` ```batch start "" /wait boldreports_enterprisereporting_9.1.7_0250.exe /Install Silent /InstallPath:"C:\Program Files (x86)\Bold Reports\Enterprise Reporting\" /DeploymentPath:"C:\BoldServices\" /IISSiteName:"Default Web Site" /IISSubAppName:Bold /IISSubAppDomainName:"http://localhost" /IsSetFirewall:true /IsUpgrade:TRUE /IsCommonLogin:TRUE /IsDesktopShortcut:TRUE /IsStartMenuShortcut:TRUE /IsSilentStartUp:FALSE ``` -------------------------------- ### Run and Build Bold Reports React Application Using NPM Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/add-classic-web-report-designer-to-a-react-boilerplate-typescript-application These commands start the development server and build the application for production deployment. Requires Node.js and NPM installed. Running 'npm start' launches the app at http://localhost:3000. 'npm run build' generates a 'build' folder with optimized files. No specific inputs or outputs beyond standard NPM behavior; ensure dependencies are installed via 'npm install'. ```shell npm start ``` ```shell npm run build ``` -------------------------------- ### Zendesk Support FULL_TABLE Configuration Example (YAML) Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/zendesk-support A complete YAML example demonstrating the configuration for Zendesk Support using the FULL_TABLE data refresh mode. This snippet shows how to set up credentials, specify tables to extract, and define metadata properties including replication key and refresh intervals. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: zendesk_data connectorname: zendesk config: subdomain: email: 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 ``` -------------------------------- ### Start React Application Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/add-classic-web-report-designer-to-a-react-typescript-application Command to start the React development server and run the application. This command compiles the React code and launches the application, typically in a web browser, allowing for development and testing. ```bash npm run start ``` -------------------------------- ### Install Bold Reports React Package and Dependencies Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/add-web-report-viewer-to-a-react-boilerplate-typescript-application Installs the Bold Reports React reporting components package. It includes conditional installation based on the React version and also installs the required 'create-react-class' package. ```bash npm install @boldreports/react-reporting-components@latest --save-dev npm install create-react-class --save-dev ``` -------------------------------- ### Install Bold Reports React Package Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/add-web-report-designer-to-a-react-boilerplate-application Installs the Bold Reports React reporting components package. It provides two installation options based on the React version used in the project, along with installing the required 'create-react-class' package. ```bash npm install @boldreports/react-reporting-components@latest —save-dev ``` ```bash npm install @boldreports/react-reporting-components@5.3.8 —save-dev ``` ```bash npm install create-react-class --save-dev ``` -------------------------------- ### API Configuration Source: https://help.boldreports.com/embedded-reporting/javascript-reporting/report-designer/how-to/getting-started-with-report-designer-classic Configuration details for the Reporting API including CORS policy and service URL setup required for client-side integration. ```APIDOC ## API Configuration ### Base URL The Reporting API is accessed through a service URL configured in the client application: ```javascript serviceUrl: "https://demos.boldreports.com/services/api/ReportingAPI" ``` ### CORS Policy The API controller is configured with permissive CORS settings: - **Origins**: * (All origins allowed) - **Headers**: * (All headers allowed) - **Methods**: * (All HTTP methods allowed) ### Implementation Notes - Controller implements `IReportDesignerController` interface - Uses `ReportDesignerHelper` for processing requests - Stores temporary files in `~/Cache/{key}/` directory - Supports file operations through `SetData` and `GetData` methods ### JavaScript Integration Example ```javascript $(function () { $("#designer").boldReportDesigner({ serviceUrl: "https://demos.boldreports.com/services/api/ReportingAPI" }); }); ``` ``` -------------------------------- ### Install Bold Reports React Package (npm) Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/add-classic-web-report-designer-to-a-react-typescript-application Installs the official Bold Reports React reporting components package. This package provides the necessary components and functionalities to integrate Bold Reports Designer into a React application. ```bash npm install @boldreports/react-reporting-components --save ``` -------------------------------- ### Install Bold Reports React and create-react-class Packages Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/add-classic-web-report-designer-to-a-react-boilerplate-application Installs the Bold Reports React component package and the `create-react-class` dependency, which is required for rendering Bold Reports components in a React application. Use the `--save-dev` flag to add them as development dependencies. ```bash npm install @boldreports/react-reporting-components --save-dev npm install create-react-class --save-dev ``` -------------------------------- ### Download and Deploy Bold Reports Linux Package Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-opensuse-15 Downloads the Bold Reports Linux package using wget and then extracts it using unzip. The deployment is initiated by executing an install script with parameters for installation type, user, host URL, and Nginx configuration. ```bash sudo wget {Bold Reports Linux package link} sudo unzip {Bold Reports Linux package zip file} cd BoldReports_EnterpriseReporting-Linux sudo bash install-boldreports.sh -i {new} -u {user} -h {host URL} -n {true or false} ``` -------------------------------- ### Blazor Application Configuration (Program.cs) Source: https://help.boldreports.com/embedded-reporting/blazor-reporting/report-writer/report-writer-getting-started This C# snippet demonstrates the minimal setup for a Blazor application in the `Program.cs` file. It configures services, sets up the HTTP request pipeline, and maps Blazor endpoints. This is essential for the Blazor application to run and handle routing, including the client-side interactions for report export. ```csharp var builder = WebApplication.CreateBuilder(args); // Add services to the container. builder.Services.AddRazorPages(); builder.Services.AddServerSideBlazor(); var app = builder.Build(); // Configure the HTTP request pipeline. if (!app.Environment.IsDevelopment()) { app.UseExceptionHandler("/Error"); app.UseHsts(); } app.UseHttpsRedirection(); app.UseStaticFiles(); app.UseRouting(); app.MapControllers(); app.MapBlazorHub(); app.MapFallbackToPage("/_Host"); app.Run(); ``` -------------------------------- ### Notion Connector Configuration Example (YAML) Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/notion This snippet shows an example YAML configuration for the Notion connector within a Bold Reports setup. It specifies connection properties like the API key and selected database IDs. Ensure the API key and selected_database_ids are replaced with your actual credentials. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: Notion_data connectorname: Notion config: api_key: properties: selected_database_ids: ``` -------------------------------- ### C# ReportViewerController Setup and Report Loading Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-viewer/how-to/getting-started-report-viewer-classic This C# code demonstrates the setup of an ASP.NET Core API Controller for BoldReports. It includes dependency injection for caching and hosting environment, methods for initializing report options by loading a report from a stream, and processing report actions from the client. ```csharp using Microsoft.AspNetCore.Mvc; using System.IO; using BoldReports.Web.ReportViewer; using System.Collections.Generic; [Route("api/[controller]/[action]")] public class ReportViewerController : Controller, IReportController { // Report viewer requires a memory cache to store the information of consecutive client request and // have the rendered Report Viewer information in server. private Microsoft.Extensions.Caching.Memory.IMemoryCache _cache; // IWebHostEnvironment used with sample to get the application data from wwwroot. private Microsoft.AspNetCore.Hosting.IWebHostEnvironment _hostingEnvironment; // Post action to process the report from server based json parameters and send the result back to the client. public ReportViewerController(Microsoft.Extensions.Caching.Memory.IMemoryCache memoryCache, Microsoft.AspNetCore.Hosting.IWebHostEnvironment hostingEnvironment) { _cache = memoryCache; _hostingEnvironment = hostingEnvironment; } // Post action to process the report from server based json parameters and send the result back to the client. [HttpPost] public object PostReportAction([FromBody] Dictionary jsonArray) { //Contains helper methods that help to process a Post or Get request from the Report Viewer control and return the response to the Report Viewer control return ReportHelper.ProcessReport(jsonArray, this, this._cache); } // Method will be called to initialize the report information to load the report with ReportHelper for processing. [NonAction] public void OnInitReportOptions(ReportViewerOptions reportOption) { string basePath = _hostingEnvironment.WebRootPath; // Here, we have loaded the sales-order-detail.rdl report from application the folder wwwroot\Resources. sales-order-detail.rdl should be there in wwwroot\Resources application folder. FileStream inputStream = new FileStream(basePath + @"\Resources\" + reportOption.ReportModel.ReportPath, FileMode.Open, FileAccess.Read); MemoryStream reportStream = new MemoryStream(); inputStream.CopyTo(reportStream); reportStream.Position = 0; inputStream.Close(); reportOption.ReportModel.Stream = reportStream; } // Method will be called when reported is loaded with internally to start to layout process with ReportHelper. [NonAction] public void OnReportLoaded(ReportViewerOptions reportOption) { } //Get action for getting resources from the report [ActionName("GetResource")] [AcceptVerbs("GET")] // Method will be called from Report Viewer client to get the image src for Image report item. ``` -------------------------------- ### Initialize IWebHostEnvironment in HomeController Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-writer/how-to/export-ssrs-rdl-report-in-asp-net-core-2-1-version Sets up the hosting environment dependency for accessing application resources. Requires Microsoft.AspNetCore.Hosting.IWebHostEnvironment dependency. Provides access to wwwroot folder for report loading. ```csharp // IWebHostEnvironment used with sample to get the application data from wwwroot. private Microsoft.AspNetCore.Hosting.IWebHostEnvironment _hostingEnvironment; // IWebHostEnvironment initialized with controller to get the data from application data folder. public HomeController(Microsoft.AspNetCore.Hosting.IWebHostEnvironment hostingEnvironment) { _hostingEnvironment = hostingEnvironment; } ``` -------------------------------- ### YAML Configuration for Data Connectors Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/working-with-projects Example YAML configuration file for setting up data connectors, including MySQL and PostgreSQL. It specifies connection details, credentials, and tables to select. This file format is used to configure the source data connector. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: MySQL connectorname: MySQL schemaname: config: host: localhost port: 3306 username: root database: sakila password: +NQCHLZ1l/RaR1L0HK+0jg== drivername: mysql+pymysql select: - inventory - payment - name: PostgreSQL connectorname: PostgreSQL schemaname: test config: host: localhost port: 5438 username: postgres database: demo password: +NQCHLZ1l/RaR1L0HK+0jg== drivername: postgresql+pg8000 select: - ticket_metrics ``` -------------------------------- ### Install Python and Pip Dependencies Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/deploy-in-linux/bold-reports-on-rhel This snippet demonstrates how to install `python3-pip` and several Python packages using `yum` and `pip` on RHEL. It is used for installing ETL application dependencies. ```bash sudo yum -y install python3-pip && python3.9 -m pip install duckdb===1.1.2 dlt===0.5.4 pymysql pyodbc pg8000 poetry pandas===2.2.2 "dlt[parquet]" "dlt[filesystem]" ``` -------------------------------- ### Example Jira Connector Configuration in YAML Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/jira Provides a complete YAML configuration example for setting up the Jira connector. This includes version, credential encryption settings, and extractor configuration with placeholder values for subdomain, email, API token, and queries. ```yaml version: encrypt_credentials: false plugins: extractors: - name: jiradb connectorname: Jira config: subdomain: email: api_token: properties: # queries: "created >= -30d order by created DESC" queries: ``` -------------------------------- ### Configure Report Viewer Service URL and Report Path Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/add-web-report-viewer-to-a-react-application This code snippet updates the `App.js` file to configure the Bold Reports Web Report Viewer with a specific `reportServiceUrl` and `reportPath`. It uses an online service URL for demonstration and specifies a sample report path. ```javascript /* eslint-disable */ import React from 'react'; import './App.css'; //Report Viewer source import '@boldreports/javascript-reporting-controls/Content/v2.0/tailwind-light/bold.report-viewer.min.css'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.common.min'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.widgets.min'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-viewer.min'; //Reports react base import '@boldreports/react-reporting-components/Scripts/bold.reports.react.min'; var viewerStyle = {'height': '700px', 'width': '100%'}; function App() { return (
); } export default App; ``` -------------------------------- ### HubSpot Configuration Example (YAML) Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/hubspot This example demonstrates how to configure the HubSpot connector in a YAML file. It shows the necessary properties including connector name, API key, and data extraction settings. ```YAML version: 1 encrypt_credentials: false plugins: extractors: - name: HubSpot_data connectorname: HubSpot config: api_key: select: -Table1 -Table2 properties: includehistory: ``` -------------------------------- ### Integrate Bold Reports Web Report Viewer Component Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-viewer/add-web-report-viewer-to-a-react-application This JavaScript code integrates the Bold Reports Web Report Viewer component into a React application. It imports necessary CSS and script files for the viewer and its common functionalities, and includes a basic `BoldReportViewerComponent` placeholder. ```javascript /* eslint-disable */ import React from 'react'; import './App.css'; //Report Viewer source import '@boldreports/javascript-reporting-controls/Content/v2.0/tailwind-light/bold.report-viewer.min.css'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.common.min'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/common/bold.reports.widgets.min'; import '@boldreports/javascript-reporting-controls/Scripts/v2.0/bold.report-viewer.min'; //Reports react base import '@boldreports/react-reporting-components/Scripts/bold.reports.react.min'; var viewerStyle = {'height': '700px', 'width': '100%'}; function App() { return (
); } export default App; ``` -------------------------------- ### Full MySQL Connector Configuration Example (YAML) Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/mysql An example YAML configuration demonstrating the FULL_TABLE method for a MySQL connector. It includes connection details, selected tables, and specific metadata settings for each table with interval-based refresh. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: tap_postgres connectorname: MySQL config: host: Hostname or IP address of the server port: Server running port username: Username password: Password database: Database drivername: mysql+pymysql 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 ``` -------------------------------- ### ReportViewerController Configuration Source: https://help.boldreports.com/embedded-reporting/aspnet-mvc-reporting/report-viewer/how-to/getting-started-report-viewer-classic Details on setting up the ReportViewerController, including inheriting IReportController, implementing methods, and configuring routing in WebApiConfig.cs. ```APIDOC ## ReportViewerController Configuration ### Description This section outlines the steps to create and configure the `ReportViewerController` in an ASP.NET Web API project to handle Bold Reports requests. ### Controller Implementation 1. **Create Controller:** Add a new `Web API Controller Class` named `ReportViewerController.cs` to the `Controller` folder. 2. **Inherit Interface:** Inherit the `IReportController` interface and implement its methods. 3. **Implement Methods:** * `PostReportAction(Dictionary jsonResult)`: Handles POST requests for report processing. * `GetResource(string key, string resourcetype, bool isPrint)`: Handles GET requests for report resources. * `OnInitReportOptions(ReportViewerOptions reportOption)`: (Optional) Called during report option initialization. * `OnReportLoaded(ReportViewerOptions reportOption)`: (Optional) Called when the report is loaded. ```csharp using BoldReports.Web.ReportViewer; using System.Collections.Generic; using System.Web.Http; public class ReportViewerController : ApiController, IReportController { // Post action for processing the RDL/RDLC report public object PostReportAction(Dictionary jsonResult) { return ReportHelper.ProcessReport(jsonResult, this); } // Get action for getting resources from the report [System.Web.Http.ActionName("GetResource")] [AcceptVerbs("GET")] public object GetResource(string key, string resourcetype, bool isPrint) { return ReportHelper.GetResource(key, resourcetype, isPrint); } // Method that will be called when initialize the report options before start processing the report [NonAction] public void OnInitReportOptions(ReportViewerOptions reportOption) { // You can update report options here } // Method that will be called when reported is loaded [NonAction] public void OnReportLoaded(ReportViewerOptions reportOption) { //You can update report options here } } ``` ### Routing Configuration Modify the `WebApiConfig.cs` file to include action names in the URI: ```csharp public static class WebApiConfig { public static void Register(HttpConfiguration config) { config.MapHttpAttributeRoutes(); config.Routes.MapHttpRoute( name: "DefaultApi", routeTemplate: "api/{controller}/{action}/{id}", defaults: new { id = RouteParameter.Optional } ); } } ``` ### Report Viewer Initialization Set the `ReportServiceUrl` and `ReportPath` properties when initializing the Report Viewer: ```csharp @(Html.Bold().ReportViewer("viewer") .ReportServiceUrl("/api/ReportViewer") .ReportPath("~/Resources/sales-order-detail.rdl") ) ``` * **ReportServiceUrl**: Should match the base URL of your `ReportViewerController`. * **ReportPath**: Specifies the path to your RDL report file within the project. ``` -------------------------------- ### Bold Reports Silent Installation Parameters (Sub-Application) Source: https://help.boldreports.com/enterprise-reporting/administrator-guide/installation/windows-installer/silent-installation Parameters for a silent installation of Bold Reports Enterprise Edition as a sub-application in IIS. This setup allows for hosting Bold Reports under an existing IIS site. ```batch start "" /wait boldreports_enterprisereporting_(version)_(timestamp).exe /InstallPath:{Location to install} /DeploymentPath:{Deployment path} /IISSiteName:{siteName} /IISSubAppName:{Sub app name} /IISSubAppDomainName:{Sub app domain name} /IsSetFirewall:{TRUE/FALSE} /IsUpgrade:FALSE /IsCommonLogin:FALSE /IsDesktopShortcut:{TRUE/FALSE} /IsStartMenuShortcut:{TRUE/FALSE} /IsSilentStartUp:{TRUE/FALSE} ``` -------------------------------- ### Build React Application for Production Source: https://help.boldreports.com/embedded-reporting/react-reporting/report-designer/how-to/getting-started-with-report-designer-classic This command generates a production-ready build of the React application. It optimizes the code, bundles assets, and creates a `build` folder containing static files that can be deployed to a web server. This process is essential for deploying the application. ```bash npm run build ``` -------------------------------- ### Loading Report by GUID in Bold Report Viewer Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-viewer/reportserver-report This example illustrates an alternative method for specifying a report using its unique identifier (GUID) in the `report-path` property. This approach is useful when direct file paths are not preferred or when reports are managed by GUIDs. ```html ``` -------------------------------- ### Install BoldReports NuGet Packages for .NET Core Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-viewer/how-to/getting-started-report-viewer-classic Installs the core BoldReports packages for .NET Core applications. `BoldReports.Net.Core` is used for Web API services to process reports, and `BoldReports.AspNet.Core` provides tag helpers for client-side reporting controls. ```csharp Install-Package BoldReports.Net.Core Install-Package BoldReports.AspNet.Core ``` -------------------------------- ### Salesforce Connector Example Configuration Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/salesforce An example YAML configuration demonstrating how to set up the Salesforce data extractor within a Bold Reports pipeline. It includes credentials and specifies tables to select. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: Salesforce_data connectorname: Salesforce config: username: password: security_token: select: - TABLE1 - TABLE2 ``` -------------------------------- ### Complete ReportViewerController Implementation Source: https://help.boldreports.com/embedded-reporting/aspnet-core-reporting/report-viewer/how-to/create-your-first-app-in-asp-net-core-2-1-version Full implementation of ReportViewerController with dependency injection, PostReportAction method for processing client requests, OnInitReportOptions for report loading, OnReportLoaded callback, and GetResource method for retrieving report resources. Requires memory cache and hosting environment dependencies. ```csharp [Route("api/[controller]/[action]")] public class ReportViewerController : Controller, IReportController { // Report viewer requires a memory cache to store the information of consecutive client request and // have the rendered Report Viewer information in server. private Microsoft.Extensions.Caching.Memory.IMemoryCache _cache; // IHostingEnvironment used with sample to get the application data from wwwroot. private Microsoft.AspNetCore.Hosting.IHostingEnvironment _hostingEnvironment; // Post action to process the report from server based json parameters and send the result back to the client. public ReportViewerController(Microsoft.Extensions.Caching.Memory.IMemoryCache memoryCache, Microsoft.AspNetCore.Hosting.IHostingEnvironment hostingEnvironment) { _cache = memoryCache; _hostingEnvironment = hostingEnvironment; } // Post action to process the report from server based json parameters and send the result back to the client. [HttpPost] public object PostReportAction([FromBody] Dictionary jsonArray) { //Contains helper methods that help to process a Post or Get request from the Report Viewer control and return the response to the Report Viewer control return ReportHelper.ProcessReport(jsonArray, this, this._cache); } // Method will be called to initialize the report information to load the report with ReportHelper for processing. [NonAction] public void OnInitReportOptions(ReportViewerOptions reportOption) { string basePath = _hostingEnvironment.WebRootPath; // Here, we have loaded the sales-order-detail.rdl report from application the folder wwwroot\Resources. sales-order-detail.rdl should be there in wwwroot\Resources application folder. FileStream inputStream = new FileStream(basePath + @"\Resources\" + reportOption.ReportModel.ReportPath, FileMode.Open, FileAccess.Read); MemoryStream reportStream = new MemoryStream(); inputStream.CopyTo(reportStream); reportStream.Position = 0; inputStream.Close(); reportOption.ReportModel.Stream = reportStream; } // Method will be called when reported is loaded with internally to start to layout process with ReportHelper. [NonAction] public void OnReportLoaded(ReportViewerOptions reportOption) { } //Get action for getting resources from the report [ActionName("GetResource")] [AcceptVerbs("GET")] // Method will be called from Report Viewer client to get the image src for Image report item. public object GetResource(ReportResource resource) ``` -------------------------------- ### PostgreSQL Configuration Example Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/postgresql Configuration of PostgreSQL connector within Bold Reports, showcasing connectivity details and data selection. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: tap_postgres connectorname: PostgreSQL config: host: port: username: database: password: drivername: postgresql+pg8000 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 ``` -------------------------------- ### GET /GetImage Source: https://help.boldreports.com/embedded-reporting/javascript-reporting/report-designer/how-to/getting-started-with-report-designer-classic Retrieves images used within reports by their name and key. Returns the image content as an HTTP response message for use in report rendering. ```APIDOC ## GET /GetImage ### Description Retrieves images used within reports by their name and key. Returns the image content as an HTTP response message for use in report rendering. ### Method GET ### Endpoint /services/api/ReportingAPI/GetImage ### Parameters #### Query Parameters - **key** (string) - Required - The unique key for request identification - **image** (string) - Required - The name of requested image ### Response #### Success Response (200) Returns the image as HttpResponseMessage content with appropriate image MIME type ### Example ```http GET /services/api/ReportingAPI/GetImage?key=abc123&image=logo.png HTTP/1.1 Host: demos.boldreports.com ``` ``` -------------------------------- ### Full MSSQL Example Configuration (YAML) Source: https://help.boldreports.com/enterprise-reporting/designer-guide/manage-content/working-with-bold-data-hub/data-connectors/sql Provides a complete YAML configuration example for connecting to an MSSQL database using Bold Reports. It includes connection details, table selection, and FULL_TABLE metadata refresh settings with interval configurations. ```yaml version: 1 encrypt_credentials: false plugins: extractors: - name: tap_postgres connectorname: MSSQL config: host: Hostname or IP address of the server port: Server running port username: Username password: Password database: Database drivername: mssql+pyodbc #if ODBC Driver 18 for SQL Server is installed, use the following driver: ODBC+Driver+18+for+SQ+Server driver: ODBC+Driver+17+for+SQL+Server 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 ```