Localization Support in Bold BI Application

Localization involves adapting a website into different linguistic and cultural contexts, which goes beyond simple text translation.

By default, the Bold BI application is available in English (en-US) localization.

Please refer to the following documentation to add a new localization or edit the existing localization:

NOTE: For applying localization files in Bold BI version 4.2.69 or earlier, Please refer to the Bold BI version 4.2.69 or earlier guide.

Add a new localization

1. Create a folder named locale inside the app_data folder in the deployed location.

2. Create a folder inside the locale folder and specify the folder name in the locale language code in which you wish to generate the localization file.

   Please refer to the sample language code. For example, create a folder called fr-FR to represent the French language code.

   

3. Create application folders with the following names inside the language code folder for each service:

   • bi
   • bi-dataservice
   • ums

   

4. To add messages.pot in the application folder created above, please refer to this.

5. To create a locale file messages.po from messages.pot, either use the manual edit option or an online tool for the BI and UMS services. Refer to this for guidance.

6. To create a locale file messages.po from default.po, either use the manual edit option or an online tool for the Designer service. Refer to this for instructions.

NOTE: By default, Bold BI is deployed in C:\BoldServices for Windows and /var/www/bold-services/application for Linux.

How to add the default locale file in the application folder

1. BI Service

   • Copy the messages.pot file from the bi\web\locale\ folder and paste it inside app_data\locale\[language-folder]\bi\ folder.

     

2. UMS Service

   • Copy the messages.pot file from the idp\web\locale\ folder and paste it inside app_data\locale\[language-folder]\ums\ folder.

     

3. Designer Services

   • Copy the default.po file from the bi\dataservice\locale folder and paste it inside app_data\locale\[language-folder]\bi-dataservice\ folder.

     

   • Copy the locale.js file from the bi\dataservice\locale\en-us folder and paste it inside app_data\locale\[language-folder]\bi-dataservice\ folder.

     

How to generate the localization file for another language

You can generate the localization file for the application in two ways:

1. Manual edit
2. Auto-generate using online tools

NOTE:
• After generating the messages.po file for bi-dataservice you need to run the locale utility. Refer to this link to generate the locale js file.
• Restart the site to apply the generated language for the application.

Manual edit

1. BI or UMS

   • Rename the messages.pot file to messages.po. This will generate the localization file for the BI service.

     

   BI-DATASERVICE

   • Rename the default.po file to messages.po.

     

   The file contains two variables: msgid and msgstr.

   msgid contains the product content in the default language.

   msgstr is empty and represents the translated language.

2. Convert the content in msgid to the equivalent language of the desired localization support. Replace this converted content into the empty string in msgstr.

3. Change the locale Language code at the top of the messages.po file.

Here, the sample converted locale file will appear as follows:

Auto-generate using any tools

1. BI or UMS

   • Rename the messages.pot file to messages.po.

   BI-DATASERVICE

   • Rename the previously pasted default.po file to messages.po.

2. Use the online site to generate the localization file.

3. Browse to select the messages.po file in the application folder on the site.

   

4. Change the language in the To option to the desired language for generating the localization file.

   

5. Select the Analyze option and then click Translate.

   

   

6. At the top of the page, there is a download icon. Use it to download the file.

   

7. Change the downloaded file name to messages.po and paste it into the respective application folder inside the app_data\locale\[language-folder]\.

How to generate the locale JS file for bi-DataService

1. Download the locale Utility. Once the download is completed, extract the .Zip file.

2. Open the appsettings.json file in an editor and modify the boldbi_custom_locale_path as the deployed path of the application designer locale files and boldbi_locale_path locale as the deployed path of default designer locale files.

   

3. Run the BoldBI.Locale.Utility.exe file.

   

4. After running the utility, a locale.js file will be generated in the newly created localized folder path of the designer locale app_data\locale\[language-folder]\bi-dataservice\.

   

5. Open the appsettings.json file in an editor from the location {Deployed Location}\bi\dataservice and change the locale path as the app data location ../../app_data/locale in the property locale-path.

   

Where to change the localization in the application

Global language settings

After generating the localization file using the preceding steps, you can set the global language in the UMS application.

This language is applied to UMS, BI, and Designer Service when there is no language is selected in site settings or user preference settings and the Application language should be set to Inherit from global settings in site settings.

Site language settings

Change the localization on the site settings page. By default, the site language is selected as English. If you want to change the language, you can switch to the desired language after generating the localization file for the BI and BI-DATASERVICE services using the above steps.

Admins can enforce a language for all users on the site. If the admin enforces a language, then the user preference settings are disabled.

User preference settings

By clicking the Update application language details through your account link on the profile page, the user will be redirected to the UMS profile page where they can set their own language preference.

A user can set any language as the preferred language, and it will be applied to all sites. However, if the admin disables the user language preference on any site, then the user’s preferred language will not be applied on that site.