Switch source Connection String using Bold BI Connection Updater - Step-by-Step Guide

Bold BI Connection Updater is a utility designed to assist in modifying connection properties within Dashboards and Draft files. This tool is particularly useful when there is a need to update the connection strings in bulk, such as after changing database servers or credentials.

Steps to Run Bold BI Connection Updater

To ensure the proper use of the Bold BI Connection Updater, follow the steps outlined below:

Step 1: Download and Extract Utility

Download the Bold BI Connection Updater zip file and extract its contents to the following directory on your server:

Step 2: Backup Important Data

Before proceeding, create a backup of the following folder to prevent any data loss:

Step 3: Edit Configuration File

Navigate to the extracted folder and open the appsettings.json file in a text editor. Update the old and new connection details in the specified region of the file. Only the necessary details need to be provided.

Windows	Linux

Step 4: Specify Site ID

If you are updating credentials for a single site, specify the Site ID in the tenant_list property.

The Site ID, also known as the client ID, can be found on the Manage Sites page within Bold BI.

Step 5: Filter Specific Data Source

To modify the connection string for a particular data source, it is necessary to input the Item ID of the data source in the filter property. Multiple data source Item IDs can be entered, separated by semicolons, to update connections efficiently.

Step 6: Save Changes

After making the necessary updates, save the changes to the appsettings.json file.

Step 7: Run the Updater

Windows:

Run the BoldBI.ConnectionUpdator.exe and wait for the process to complete. The status will be shown as below once the process is completed.

Linux:

Execute the following command to run the Bold BI Connection Updater. Ensure that you are in the directory where the BoldBI.ConnectionUpdator.dll is located:

/var/www/bold-services/dotnet/dotnet BoldBI.ConnectionUpdator.dll

Wait for the process to complete. The status of the operation will be displayed upon completion.

By following the steps above, you can effectively use the Bold BI Connection Updater to manage and update your dashboard connection strings efficiently.

Important Notes

• The Bold BI Connection Updater is version-specific and should be used with the corresponding version of Bold BI.
• Always ensure that you have a complete backup of your data before running the utility.
• In MySQL connection type, the database name must match the schema name or use an equivalent input in appsettings.json file.
• In the appsettings.json file, if any one of the properties is used in either the old connections or the new connections, all other empty properties should be removed from both the old connections and the new connections before running the utility.
• Only MongoDB and SQL based live mode data sources are supported in the utility.
• Also can be run in Kubernetes and Docker deployments