Creating and applying a custom language pack

Creating a custom language pack

Perform the following steps to customize your language pack:

1. Run the tssh locale command from the installationDirectory\truesightpserver\bin folder:

   tssh locale add <language-name> <language-code> <resourceFileName>

   language-name - Name of language that you want to be displayed in the language drop-down list on the TrueSight console. For example, English, Chinese, French. 

   language-code - ID for the language. For example, en for English, zh for Chinese, fr for French. 

   resourceFileName - JSON file for the language. The format for this file is <language-code>.json. For example, en.json, zh.json, fr.json. 

   For example, consider a scenario in which you want to add the French language.

   tssh locale add French fr fr.json
2. Stop the TrueSight Presentation Server.
3. Configure the json file for the new language:
   1. Navigate to the installationDirectory\truesightpserver\modules\tomcat\webapps\ROOT\WEB-INF\classes\ folder and make a copy of the en.json file in the same folder.
   2. Rename the copied en.json file as the new language that you want to add. For example, rename the en.json file as fr.json.

   3. Edit the new json file and add the following:

      user.preferences.language.<language-name>": "<localized string for the language display name>"

      For example, in the fr.json file, add "user.preferences.language.french": "français".

   4. Save the new <language-code>.json file (for example, fr.json) and make a copy of it.

   5. Open the ROOT.war file located in the installationDirectory\truesightpserver\modules\tomcat\webapps\ folder with any extractor utility (for example, WinZip) and navigate to the \WEB-INF\classes\ folder. Move the copied <language-code>.json file to this folder.

      Note

      If you add special characters in the new json file, ensure to save the file using the UTF-8 encoding.

4. Add the i18n message of newly added language in all the pre-existing locale json files located in the installationDirectory\truesightpserver\modules\tomcat\webapps\ROOT.war\WEB-INF\classes\ folder. 
   1. Navigate to the installationDirectory\truesightpserver\modules\tomcat\webapps\ROOT\WEB-INF\classes\ folder.

   2. Edit the en.json file and add the following for the new language: 

      user.preferences.language.<language-name>": "<localized string for the language display name> - <Language-display-name>"

      For example, add "user.preferences.language.french": "français - French".

   3. Save the en.json file and make a copy of it.
   4. Open the ROOT.war file located in the installationDirectory\truesightpserver\modules\tomcat\webapps\ folder with any extractor utility and navigate to the \WEB-INF\classes\ folder. Move the copied en.json file to this folder.
   5. Repeat steps from a to d to add the i18n message for the new language in the zh.json and de.json files.
5. Download the angular-locale_<language-code>.js file for the new language from the github website and move this file in the installationDirectory\truesightpserver\modules\tomcat\webapps\ROOT.war\i18n\ folder. For example, download and add the angular-locale_fr.js file.
6. Add the json file having the localized text in all war files for the TrueSight console labels: 
   1. Navigate to the installationDirectory\truesightpserver\modules\tomcat\webapps\cmaApp\WEB-INF\classes\ folder. 
   2. Make a copy of the en.json file in the same folder and rename the copied en.json file as the new language that you want to add. For example, rename the en.json file as fr.json. Localize the content of the new file.
   3. Open the cmaApp.war file located in the installationDirectory\truesightpserver\modules\tomcat\webapps\ folder with any extractor utility and navigate to the \WEB-INF\classes\ folder. Move the new <language-code>.json file to this folder.

   4. Repeat steps from a to d for the following war files located at installationDirectory\truesightpserver\modules\tomcat\webapps\<WarFileName>.war\WEB-INF\classes\ folder:

      • ROOT
      • perfAnalysis
      • itda
      • infraApp-dashlets
      • infraApp
      • dashlets-default
      • dashboard
      • commonAdminApp
      • app-visibility
      • appcontext

      For example, installationDirectory\truesightpserver\modules\tomcat\webapps\ROOT.war\WEB-INF\classes\

7. (Applicable for BMC Service Resolution integration only)
   1. Navigate to the installationDirectory\truesightpserver\conf\resources\i18nData folder and create a folder for the new language. For example, create fr_FR for French. 
   2. In the new language folder, create the jsp folder.

   3. Copy the ibrsdConfig.properties file from the installationDirectory\truesightpserver\conf\resources\i18nData\en_US\jsp folder and paste it in the new language jsp folder.

      Note

      In the ibrsdConfig.properties file, ensure to add the details to perform the localization in the Unicode format.

8. Add the entry for the new language in the i18nConf.conf file located in the installationDirectory\truesightpserver\conf\ folder:
   1. Edit the i18nConf.conf file. 
   2. Look for the supportedLocales property name and add the entry for the new language to the list of existing languages. 
      For example, supportedLocales=en_US,zh_CN,de_DE,fr_FR
9. Restart the Presentation Server.

Validating a new language in the TrueSight console

Perform the following steps to validate the newly added language in the TrueSight console:

1. Log in to the TrueSight console and select User Preferences from the actions menu.
2. Edit the User Preferences options.
3. In the Language drop-down list, select the newly added language.
4. Click Save.