How to translate product and configuration labels

Hazem Taouai
Mon, 11 Aug 2025 14:22:06 +0000
Show & Tell

Introduction

This how-to details the procedure to translate Identity Manager.
The same procedure can be used to overwrite existing labels.

Two types of translations are possible:

Configuration translation:

Allows to translate all labels defined by the XML/UI configuration.
This includes Core IGA predefined configuration.

Product translation

Allows to translate all default labels defined in the product such as bottons, messages, sections, etc.

Configuration Translation

Exporting the configuration translation files

Open a PowerShell console and run the following command:

On-Premises:

Set-Location <RuntimeFolder>
.\Usercube-Export-Configuration.exe -s <ConnectionString> -d <OutPutFolder> --export-translation

SaaS:

Set-Location <RuntimeFolder>
.\Usercube-Export-Configuration.exe --api-url <UrlNIM> -d <OutPutFolder> --export-translation

Example:

Set-Location C:\UsercubeDemo\Runtime
.\Usercube-Export-Configuration.exe -s 'data source=.;Database=UsercubeDemo;Integrated Security=SSPI;Min Pool Size=10;MultipleActiveResultSets=True;Encrypt=False' -d 'C:\UsercubeDemo\TranslationFiles' --export-translation

Editing the translation files

Edit the values for each key in the file: translations.configuration.xx-yy.json

Example:

"EntityType.Directory_Site.DisplayName": "Site",
"EntityType.Directory_Subsidiary.DisplayName": "Subsidiary",
"EntityType.Directory_Title.DisplayName": "Title",
"EntityType.Directory_User.DisplayName": "Employee",
...

Loading the translations

Place the modified file in the Conf folder (root of the XML configuration).

Open a PowerShell console and run the following command:

On-Premises:

Set-Location <RuntimeFolder>
.\Usercube-Deploy-Configuration.exe -s <ConnectionString> -d <ConfigurationFolder>

SaaS:

Set-Location <RuntimeFolder>
.\Usercube-Deploy-Configuration.exe --api-url <UrlNIM> -d <ConfigurationFolder> --deployment-slot <Environment>

Example:

Set-Location C:\UsercubeDemo\Runtime
.\Usercube-Deploy-Configuration.exe --api-url 'https://demo.usercube.com' -d 'C:\UsercubeDemo\Conf' --deployment-slot Staging

Product Translation

Getting the configuration translation files

The product translation files can be found in the SDK folder of Identity Manager.

usercube-sdk-6.2.7.zip\SDK\Translations

Editing the translation files

Edit the values for each key in the file: xx-YY.json

Example:

  "app.scenes.universeData.index.columnsOrderModal.title": "Columns options",
  "app.scenes.universeData.index.filtersModal.number": "Number",
  "app.scenes.universeData.index.label.allResults": "All results",
  "app.scenes.universeData.index.label.areYouSure": "Are you sure you want to reset query?",
  "app.scenes.universeData.index.label.asOfDate": "As of Date",
  "app.scenes.universeData.index.label.deleteAll": "Delete all",
  "app.scenes.universeData.index.label.fields": "Fields to Display",
...

Loading the translations

Rename the file to: translation.xx-YY.json

Place the modified file in the Conf folder (root of the XML configuration).

Update the file 101.xml. Add the path to the translation file in the language declaration tag.

<Language Code="xx-YY" IndicatorNumber="1" JsonPath="translation.xx-YY.json"/>

Open a PowerShell console and run the following command:

On-Premises:

Set-Location <RuntimeFolder>
.\Usercube-Deploy-Configuration.exe -s <ConnectionString> -d <ConfigurationFolder> --product-translation

SaaS:

Set-Location <RuntimeFolder>
.\Usercube-Deploy-Configuration.exe --api-url <UrlNIM> -d <ConfigurationFolder> --deployment-slot <Environment> --product-translation

Example:

Set-Location C:\UsercubeDemo\Runtime
.\Usercube-Deploy-Configuration.exe --api-url 'https://demo.usercube.com' -d 'C:\UsercubeDemo\Conf' --deployment-slot Staging --product-translation