Adding custom locales

Adding custom locales tailors language, formatting, and terminology to your region or preferences, which helps the application to feel more natural and intuitive to use. It creates a more intuitive, relevant and comfortable experience by aligning with how you communicate day to day.

1. Translate the Shell user interface.
   1. Create the shell-ui/assets directory in the orderhub-code folder.
   2. Create an app-bootstrap-config.json file in the shell-ui/assets directory.
   3. Specify the values for the supportedLanguages and defaultLanguage attributes for each product as shown in the following example.

      {
          "productsData": {
              "products": [
                  {
                      "id": "omsi",
                      "supportedLanguages": "de,en,es,fr,it,ja,ko,pl,pt_BR,ru,tr,zh_TW,zh,da,et,fi,pa,<new_language_code>"
                      "defaultLanguage": "en"
                  }
              ]
          }
      }
      
      Note: If the language code is not a part of the

      Note: If the language code is not part of the supported Languages attribute, the shell considers the browser language as the default language. Add all languages that are supported by the application.
   4. In the shell-ui/assets directory, create the i18n directory.
   5. In the developer tools, select the Network tab. Then, refresh the page and copy the static content of the <locale_code>.json file from the following request to a single <new_language_code>.json file.

      <ORDERHUB_DOMAIN>/order-management/assets/i18n/<language_code>.json

   6. Replace the content and place the custom locale translation file in the shell-ui/assets/i18n directory.
   7. To provide translations for the name of the custom language, either create or add the <locale_code>.json file to the shell-ui/assets/i18n directory as shown in the following example.

      {
          "loginPage":{
              "Label_language_custom": "Custom language"
          }
      }

2. Translate the modules.
   1. Click the Network tab in developer tools, refresh the page, and navigate to the desired Order Hub module.
   2. On the Network tab, navigate to and copy the content of the <language_code>.json file.

      <ORDERHUB_DOMAIN>/buc-app-<module>/assets/i18n/<language_code>.json

   3. Create a <new_locale_code>.json locale file for your translations and paste the content there that you copied from the <language_code>.json file.
   4. Translate the values in the JSON file to the custom supported language.
   5. Repeat all steps for each module, since translations are retrieved per module.