Changing system labels and messages
Common
OpenIAM provides the feature to customize the labels shown at the User Interface. To customize labels you should place your text to corresponding *.properties file. OpenIAM by default supports the following languages.
File Name | The Language |
---|---|
messages_de_DE.properties | German |
messages_dk_DK.properties | Dutch |
messages_en.properties | English |
messages_es_ES.properties | Spanish |
messages_fr_FR.properties | French |
messages_ja_JP.properties | Japanese |
messages_ms_MY.properties | Malaysian |
messages_no_NO.properties | Norwegian |
messages_pt_BR.properties | Brazilian |
messages_pt_PT.properties | Portugal |
messages_ru_RU.properties | Russian |
messages_zh_CN.properties | Chinese |
This is not necessary to include in the customization file full list of labels, you should just add only what you would like to override.
RPM installation
in message file properties find label that should be changed, copy its name. To change label for english language:
1 create file with name messages_en.properties in conf (usually path is /usr/local/openiam/conf )folder. add label name and new value for it, save file.
2 restart openiam-ui service to apply new labels.
example: if you want to customize label on logout popup window, you should find original message in message file properties 'Are you sure you want to exit?'. Label name is openiam.ui.shared.logout.warning.message, then in new file you will override it:
openiam.ui.shared.logout.warning.message=Do you want to exit?
after restart of ui component 'Do you want to exit?' will appear on pop of exit screen.
Docker installation
in message file properties find label that should be changed, copy its name.
To change label for english language: 1 create file with name messages_en.properties on host machine.
2 add label name and new value for it, save file
3 add volume for it in 3.2/ui/docker-compose.yaml. in section volumes, add
- "/path_to_file/messages_en.properties:/data/openiam/conf/messages_en.properties"
4 restart docker ui service to apply new labels. Remove ui from stack by running command "docker stack rm ui". Then run startup.sh to bring up ui service.
example: if you want to customize label on logout popup window, you should find original message in message file properties 'Are you sure you want to exit?'. Label name is openiam.ui.shared.logout.warning.message, then in new file you will override it
openiam.ui.shared.logout.warning.message=Do you want to exit?
after restart of ui component 'Do you want to exit?' will appear on pop of exit screen.
k8 installation
1 create file with name messages_en.properties on host machine.
2 add label name and new value for it, save file
3 copy the properties file to somewhere where you have access to kubectl
4 create a k8 configmap from the properties file. See https://kubernetes.io/docs/tasks/configure-pod-container/configure-pod-configmap/
5 map the file in the ui statefulset in the configmap section (create if not exists in the file).
Other languages localization
for other languages procedure will be same, only file name in conf will be different: messages_xx_yy.properties where xx_yy is the locale name of needed language. you can find it in webconsole->administration->language->select one you need->field locale. for example for Japanese filename will be: messages_ja_JP.properties
Menu names
Menu localization data can be changed in Webconsole-Access control-Menus. Select root menu and find Menu that should be changed, right click on it and in Window 'Edit menu' fill new values and save menu and tree. restart esb (container or service) and in about 5 min you will see new label applied.