How to Automate Site Creation in Bold BI Using the Site Generation Utility
Introduction
Managing multiple clients or departments often requires creating several tenant sites in Bold BI. However, creating these sites manually can become tedious and time-consuming—especially at scale. To address this, Bold BI offers a powerful Site Generation Utility that automates the site creation and ensures consistency across deployments.
The Site Generation Utility is designed to help users create multiple sites dynamically in Bold BI without requiring manual intervention. By using this utility, organizations can streamline the site creation process, ensuring consistency and efficiency while reducing the chances of manual errors. This Knowledge Base article provides a step-by-step guide on how to use the Site Generation Utility effectively.
Step 1: Prerequisite and Preprocessing
The Site Generation Utility application is not currently available for public access. To acquire the version of the Site Generation Utility compatible with your Bold BI version, please reach out to Bold BI support for assistance. This utility application is accessible for On-premises versions starting from v7.8 and above.
Step 2: Extract the Utility
Extract the Site Generation Utility and you can find the files as shown in below image.
Step 3: Update payload.json
Open the payload.json file in your code editor. This file holds the configuration settings required for the utility to function properly.
| Property | Description | Example Value |
|---|---|---|
ClientId |
Enter the Client ID. | Refer to this KB article to obtain Client ID. |
ClientSecret |
Enter the Client Secret. | Refer to this KB article to obtain Client Secret. |
AppURL |
Provide the URL of your Bold BI® application. | http://localhost:64277 |
Email |
Enter the admin’s email address. | admin@example.com |
Number of Sites |
Specify how many sites you want to create. | 10 |
N |
Define the starting number for site generation. | 1 |
Template |
Define the naming template for your sites. Sites will be created sequentially based on this template. | Test (e.g., Test1, Test2 … Test10) |
Configure Database Settings
Refer to the following KB article for an example database configuration request based on the servers:
Sample Request for Database
| Property | Description | Example Value |
|---|---|---|
ServerType |
Type of database server. | 3 |
ServerName |
Name of your database server (e.g., PostgreSQL, MySQL, MSSQL Server). | MSSQL Server |
Port |
Database connection port number. | 1433 |
Username |
Username with access to the database. | admin_user |
Password |
Password for the database (keep secure). | •••••••• |
DatabaseName |
Name of the database to store site data. | UserDB |
IsNewDatabase |
Set to true if you’re using a new database, otherwise false. |
true |
SslEnabled (Optional) |
Set to true to enable SSL for secure database connections; otherwise set to false. |
false |
- Repeat the above configurations in the Datastore Configuration section.
- Save the changes in the
payload.jsonfile.
Step 4: Run the Utility
- Run the BoldBI_Site_Generation_Utility.exe to begin the site generation process.
Step 5: Verify Site Creation in Bold BI
- Once execution is complete, the specified number of sites/tenants will be successfully created within Bold BI Server.
- Log in to Bold BI Server and verify the generated sites to ensure correctness.
Conclusion
By following these steps, users can successfully create multiple sites dynamically in Bold BI with minimal manual effort. This Site Generation Utility is an efficient tool for automating the site creation process while ensuring consistency and accuracy. If any issues arise during the process, users are encouraged to contact Bold BI Support for assistance.
