Articles in this section

Customize the Help Link in Bold Reports Server

Published:
Updated:

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

  1. Sign in to Report Server using an administrator account.
  2. Click the Profile icon in and select Manage Sites from the dropdown menu.
    Manage Sites page

Note: Administrator privileges are required to access the Manage Sites page.

Step 2: Access the Configuration Settings

  1. On the Manage Sites page, click the Settings icon in the left navigation pane.
  2. Select Configuration from the menu.
  3. In the Configuration options, select config.json from the file dropdown list.
    Configuration settings

Step 3: Update the Custom Help Link

  1. Before editing, back up config.json so you can restore the existing configuration if needed.
  2. Locate the WhiteLabelHelpLink section. Edit only this section; do not replace the rest of the configuration file.
  3. Set EnableCustomDomain to true and replace the example ReportsCustomDomain URL 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.json file. Preserve the existing root object and all other configuration settings. If the section already exists, update its values rather than adding a duplicate key.

    Custom help link configuration

Step 4: Verify the Configuration

  1. Navigate back to the Reports page.
  2. Click the Help icon.
  3. Verify that the link opens the URL configured in ReportsCustomDomain.
    Custom Help link in Report Server

Related Articles

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
Comments (0)
Access denied
Access denied