Translating Static Labels or Text

This topic involves translating static labels or text (Page Titles, Header, Footer, Tabs, Descriptions) using local files or the Conga Platform. It includes a table showing translation availability effects and steps for setting locales and updating translations.


File on Local Translation Folder	Translation details on the Conga Platform	Description
Available	Not Available	The application checks the user's locale and translates static labels or text based on the local translation file. Refer to step 2 below.
Not Available	Available	The application checks the user's locale and translates static labels or text based on the translations added to the Conga Platform. Refer to step 3 below.
Available	Available	The application first checks the user's locale and applies Conga Platform translations. If a translation key is missing, it uses the local file. If the key is still not found, it defaults to English.
Not Available	Not Available	If the user's language is not available, the application defaults to English.

Set the user-level locale. For translation, the application uses the user-level locale. You can set the user's locale using the Update a user API.
Sample request body to set the user's locale to the Spanish (es_ES) language.
```
{
  "LocaleName": "es_ES"
}
```
Note:
To list supported locales, use the following API:
GET https://<URL_of_the_Instance>/api/user-management/v1/locales
Add local translation file(s):
1. Go to the assets/i18n folder. The application checks this folder first for translation JSON files.
2. Copy any sample file from the assets/i18n folder, rename it, and update the translations for your preferred language.
Add translation details on the Conga Platform:
1. Add a translation module using the Admin User Interface or with Add translation module API.
2. Update the environment.ts file for translationModule parameter with the module name added in the step 3a.
  Note:
  You must update the translationModule parameter in the environment.ts file while configuring templates. For more information, see Configuring Templates.
3. Add a translation value for the given locale and module using the Admin User Interface or Add translation value API.
  Tip:
  You must use the CustomLabels in the parameter as a key and the stringified value of your translation JSON file as a value.
  
  For example:
```
{
  "Key": "<LABEL_KEY>",
  "Value": "<Label Value>"
}
```
  Refer to the example below for French translation:
  { "Key": "COMMON.ORDER_TOTAL", "Value": "Montant total commandé" }

Conga Product Documentation

Welcome to the new doc site. Some of your old bookmarks will no longer work. Please use the search bar to find your desired topic.

Translating Static Labels or Text

Footer Section

Explore