Articles in this section

How to Update the Database Server IP Address or Hostname for a Bold BI Site (UMS and Site Database Settings)

Published:

Overview

When the database server IP address or hostname changes, the connection details must be updated in both the UMS (User Management Service) database and the individual Bold BI site database. Updating only the UMS database is not sufficient. This article explains where and how to update both configurations to restore connectivity in a Bold BI Embedded (multi‑tenant) environment.

Below are the configuration steps:

Update the UMS Database Connection

1. Update the UMS database using the Bold BI command line tool

Note: The procedure for accessing the Bold BI Admin Utility varies depending on the deployment type. For Docker deployments, access the utility from within the UMS container before updating the database connection settings. The steps in this article include Docker-specific instructions for locating and accessing the utility.

Docker Deployment: Steps to Locate the Installation Utility Directory

List the Running Containers

  • Open a terminal and run:
docker ps 
  • Verify that the UMS container (id_ums_container) is running.
    image.png

Access the UMS Container

  • Run the following command:
docker exec -it id_ums_container bash 
  • A successful connection should display a prompt similar to:
root@eccfdcbd5955:/application/idp/ums# 

Locate the Installation Utility Directory

  • Run the following command:
find /application -type d 2>/dev/null | grep -i util 

image.png

  • This command identifies the utility-related directories available within the UMS container.
    Navigate to the Installation Utility Directory
  • Run:
cd /application/idp/ums/appdatafiles/installutils 
  • Verify the contents of the directory:
ls -la 
  • This confirms that the installation utility files are available within the container.
    image.png

Note: The utility location in Docker deployments differs from traditional Windows installations that use the Admin Utility installation directory. In Docker deployments, the utility files are located under:

/application/idp/ums/appdatafiles/installutils 

After confirming the installation utility location, proceed with the database update procedure described in the
Reset Application Database using Command Line Tools documentation to update the UMS database connection details with the new database server IP address or hostname.

2. Verify the UMS database update

  • Ensure that the command completes successfully and that the updated database details are saved without errors.

3. Restart the Bold BI application

  • After updating the UMS database connection, restart the Bold BI Embedded application so that all services reconnect using the new database IP address.
  • Once restarted, the UMS should connect successfully to the database using the updated IP address.

For Docker deployments, restart the containers after completing the database update operation.

Update the Database IP Address for the Site

Updating the UMS database alone does not update the database connection details for individual sites. Each site must be updated separately.

4. Open the UMS portal

  • Log in using a UMS administrator account (https://<your-domain/ums)
    image.png

    5. Navigate to the Sites section
  • In the UMS portal, navigate to Sites.
  • Locate the site whose database server IP address or hostname has changed.
    image.png

    6. Update the site database configuration
  • Click the More Actions (⋮) menu and select Edit.
    image.png
  • Proceed to the Select Database step.
  • Update the following values as required:
    • Server Name (new database hostname or IP address)
    • Port Number
    • Database Name
    • Username
    • Password
  • Click Update to save the changes.
    image.png

    image.png

Validate the Update

7. Verify site access

  • Open the site’s URL.
  • Sign in to the site.
  • Verify that the site home page loads successfully.
  • Open an existing dashboard.
  • Confirm that dashboards load successfully and that no database connection errors are displayed.

Conclusion

  • To update a database IP address in a Bold BI Embedded environment, the change must be applied in both places:
    • The UMS database using the Admin Utility and a service restart.
    • The individual site database configuration through the UMS portal.
  • If the site-level database configuration is not updated, the site will continue to experience database connection issues even if the UMS is working correctly.

Related Articles

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
EO
Written by Erick Oloo Awino
Updated:
Comments (0)
Access denied
Access denied