Customize the Help Link in Bold Reports Server
In Bold Reports® Report Server, the Help icon can link to your organization’s documentation or support site. Pointing it to a familiar internal knowledge base or support portal helps users find organization-specific guidance from the product. Configure the WhiteLabelHelpLink section in config.json to set a custom destination.
Applies to: Bold Reports Report Server. Confirm the configuration keys and behavior for your installed version before applying this change.
Step-by-Step Instructions
Step 1: Open the Manage Sites Page
- Sign in to Report Server using an administrator account.
- Click the Profile icon in and select Manage Sites from the dropdown menu.
Note: Administrator privileges are required to access the Manage Sites page.
Step 2: Access the Configuration Settings
- On the Manage Sites page, click the Settings icon in the left navigation pane.
- Select Configuration from the menu.
- In the Configuration options, select
config.jsonfrom the file dropdown list.
Step 3: Update the Custom Help Link
- Before editing, back up
config.jsonso you can restore the existing configuration if needed. - Locate the
WhiteLabelHelpLinksection. Edit only this section; do not replace the rest of the configuration file. - Set
EnableCustomDomaintotrueand replace the exampleReportsCustomDomainURL with your organization’s documentation or support URL and save the changes.
-
For example, update or add this section within the existing JSON configuration:
"WhiteLabelHelpLink": { "EnableCustomDomain": true, "ReportsCustomDomain": "https://docs.yourcompany.com/reporting-guide" } -
Do not paste this snippet as a replacement for the complete
config.jsonfile. Preserve the existing root object and all other configuration settings. If the section already exists, update its values rather than adding a duplicate key.
Step 4: Verify the Configuration
- Navigate back to the Reports page.
- Click the Help icon.
- Verify that the link opens the URL configured in
ReportsCustomDomain.