Articles in this section
Category / Section

How to migrate Bold BI instance from one machine to another

Published:

Follow the step-by-step process below to migrate the Bold BI instance of Embedded Analytics Server from one machine to another, using the existing database connection.

Steps to back up the Bold BI Database

Follow the instructions below to backup and restore the databases of the UMS and BI tenants.

Database TypeHelp Link
PostgresSQLPostgreSQL: Documentation: 8.1: Backup and Restore
MS SQLBack Up and Restore of SQL Server Databases - SQL Server | Microsoft Learn
MySQLMySQL :: MySQL 8.0 Reference Manual :: 7 Backup and Recovery
Once the backup and restore process is done, please follow the below steps to update the restored database in the Bold BI application.
Once the backup is taken, make sure to stop the old instance of Bold BI application because if any changes made in the old instance, then they won't be available in the new instance.

Steps to migrate the resource folder

Generally, the dashboard and data sources are saved as files in the deployment location, and we need to migrate those resources to the new location.
  1. Install the Bold BI application on the new machine, which is the new instance to where you want to migrate.

  2. Stop the Bold BI application of the new machine by following the below KB article.
    How to Stop and Start the Bold BI Application on Different Environment

  3. Now, take a backup of the app_data folder of the new machine, which is available in the below location.

  4. Environmentapp_Data Location
    Linux/var/www/bold-services/application/

    Default deployment location: /var/www/bold-services/application
    Windows{Deployed Location}/app_data/

    Default deployment location: C:\BoldServices
    DockerNeed to backup the persistent volume used for app_data
    KubernetesFor Kubernetes need to backup the Fileshare for different cloud providers.
    EKS File storagehttps://docs.aws.amazon.com/efs/latest/ug/awsbackup.html
    AKS File storagehttps://learn.microsoft.com/en-us/azure/backup/backup-afs
    GKE File storagehttps://cloud.google.com/filestore/docs/backups

  5. Once the backup is taken, delete the app_data folder on the new machine, then copy and paste the app_data folder from the old machine to the new machine location in where the resources files present.

    Note that we need to replace the entire app_data location because some encrypted contents will be only decrypted with the key present in the app_data location. If the key mismatches, then we can't decrypt the existing information.

    Once the backup is taken, make sure to stop the old instance of Bold BI application because if any changes made in the site won't be available in the new instance.

Steps to modify the URL in UMS

  1. Follow the below guidance document to reset the database connection of the UMS in the new instance.
    Reset Application Database – Admin Utility | Bold BI

  2. If you are using IP, you can ignore this step and proceed directly to step 3.
    a. If you are using the same custom domain, make sure CNAME record for your domain is mapped with the new IP address in the DNS provider.

    b. Alternatively, if you are using a different custom domain, create a CNAME record for your domain with the new IP address in your DNS provider, and then use that domain in Bold BI.

  3. Refer to the KB article below to update your domain or IP in the new instance and skip Site URL configuration in Bold BI application and How to change individual tenant site URL sections of that article and continue further steps below.

  4. The UMS service is ready with the restored database. Now, we need to update the UMS URL with the DNS or IP of the new instance in the application. We can update the UMS URL either through the UI or using admin utility. Refer to the sections below for instructions on how to update it.

Steps to modify the UMS database connection and URL

    Update UMS URL using UI
    1. Now start the Bold BI application of new instance by following the below article.
      How to Stop and Start the Bold BI Application on Different Environment

    2. Go to {new_instance_domain}/ums/administration page and login into the application.

      Note: We need to access the UMS site directly without accessing the tenant site with the new machine domain or IP.
      Example: {your_domain}/ums/administration
    3. Now update the UMS URL with the new machine DNS or IP in the site URL, and also ensure the checkbox shown below is not checked because enabling this checkbox will update all the tenant site URLs also.

      img1.png
    4. Then, click the Save button to save the changes.

    Update UMS URL using Admin Utility
    Like the UMS database connection reset using the admin utility, which is specified in the link, we can update the UMS URL.

    1. Open the utility location based on the Bold BI hosted environment as specified in the above link.
    2. Run the following command to update the UMS URL as shown below:
      Syncfusion.Server.Commands.Utility.exe  updatedomain -dns "<new_domain>”
    3. The UMS service is ready with an updated URL. To change the tenant site URL, you can refer to the section below. So start the new instance site by following the below article.
      How to Stop and Start the Bold BI Application on Different Environment

Steps to modify the tenant sites database connection and URL

We can update the BI tenant sites database connection and URL one by one using UI interaction.
    Update using UI
    1. Go to UMS site listing page by clicking Sites option in the left panel.
      {new_instance_domain}/ums/sites
      Picture2.png

    2. Now, select Edit option from a specific site under context menu option,
      Picture3.png

    3. Provide the new URL here and click Next.
      img5.png
    4. Enter the tenant site's database information of the restored database and click Update.
      Picture5.png
    5. Repeat the above steps for all the tenant sites one by one.
    6. Now all the tenant sites on the new instance machine are pointed to the latest domain or IP with the restored database. So, restart the Bold BI application by referring to the below link and access the tenant sites.
      How to Restart Bold BI application
    Update using Admin Utility
  1. Refer to the article below for instructions on how to update the database connections of bulk tenant sites using the admin utility.
  2. Now all the tenant sites in the destination instance are pointed to the restored DB and start or restart the Bold BI application by referring to the below link and access the tenant sites.
    How to Restart Bold BI application
  3. To update the tenant site URL for individual sites in the UI by referring to the above section Update using UI.
  4. Now stop and start the Bold BI to reinitialize the modified URL application settings.

Steps to modify the data store connection of Tenant Sites

DataStore is an intermediate database used to store imported data from web data sources and statistic files, with a scheduled refresh option to update data. Refer to the document Data Extract Storage Settings – Embedded BI | Bold BI Docs and modify the database connection details of this settings.
If you modified the tenant site URL and database connection using the utility as mentioned in above section, utility itself contains option to set same database connection details to data store settings.

Steps to modify the data source connection

  • If you are migrating the data source's SQL database servers along with the Bold BI application, please create a support ticket using this link in order to get guidance on updating the connection string of the bulk data sources.

Note

  • It is recommended to migrate the Bold BI database to the same or a higher version of the Bold BI instance in the new location. However, it is not recommended to use lower version of Bold BI in the new instance because during upgrade process we may altered the database tables or columns.

Related Links

Other Migration related KB articles

Was this article useful?
Like
Dislike
Help us improve this page
Please provide feedback or comments
RR
Written by Raji Rajendran
Updated
Comments (0)
Please  to leave a comment
Access denied
Access denied