How to add new locale to the Identity Applications on a Tomcat Server (Part 1)

How to add new locale to the Identity Applications on a Tomcat Server (Part 1)

One of the features IDM 4.5 documentation is missing are the instructions on how to add new locales to Home and Provisioning Dashboard (HPD) including the One SSO Provider (OSP) login page and the "old" UserApplication (UA) interface.

After several support tickets, talking to NetIQ representatives and browsing through support forums I (hope, I) finally found the answer after trial and error. So this guide is intended for users who want to translate the Identity Manager HPD and UA into a language that is not part of the standard language support set.

The solution works also if you want to modify already supported locales strings to your needs.

Add new locale


 

First we need to add new locale to supported locales. For some reason, we are going to add Finnish (fi).

User Application strings are stored in the User Application driver and in the User Application WAR file. To get started we need to modify both of them.

Prerequisites


  • Java JDK (jar program)

  • IDM 4.5 Identity Applications Deployed

  • UserAppStrings_en.jar - file (from /opt/netiq/idm/apps/UserApplication/l10n-resources/userapp)

  • a lot on patience to go through all the properties files


 

Localization

1. Create UserAppStrings_fi.jar

  • Unpack UserAppStrings_en.jar

  • You get a whole bunch of properties files.

  • Translate the strings to Finnish and remember to rename the translated files to *_fi.properties.

  • Pack the translated files to UserAppStrings_fi.jar


WARNING: 
Remember to keep the folder/file structures and naming conventions.

 

2. Add new locale to User Application Driver

Right-click the User Application driver in the Provisioning view, select Configure/Locales.

Click  on the green + - sign, then select the Language "Finnish" click OK.
Type in the Locale value "fi" for Finnish.

The language is now displayed in the Locales section.

locales1

Click on to Localization Resource Groups

Select the Localization Resource Group, where you want the new locale to be supported, example "Common".

locales2

Click on the green + - sign in the Locales area, then in the Add Locales - window, move the Finnish - locale from the Available Locales: to the Selected Locales: - list.

locales4

Click OK.

Repeat these steps on all the Localization Resource Groups. Click OK in the end.

3. Deploy changes to the User Application driver.

Right-click the User Application driver in the Provisioning view, select Live/Deploy.

4. Extra settings (not mandatory)

You can export/translate/import User Application driver data such as display labels for entities, provisioning request definitions and teams, also E-mail notification templates. But these are not mandatory to get the new locale working, you can add new locale strings for those through Designer later.

 

Installation of the localization strings


 

Stop idmapps.
/etc/init.d/idmapps_tomcat_init stop

Create temp directories.
mkdir -p /tmp/IDMProv/WEB-INF/lib

Copy IDMProv.war to tmp for update.
cd /tmp/IDMProv
cp /opt/netiq/idm/apps/tomcat/webapps/IDMProv.war .

Put your localized jar file UserAppStrings_fi.jar in /tmp/IDMProv/WEB-INF/lib - folder and add the file to war package.
jar -uf IDMProv.war WEB-INF/lib/UserAppStrings_fi.jar

Remember to backup your original IDMProv.war before next step.

Replace the original IDMProv.war with your modified IDMProv.war
cd /opt/netiq/idm/apps/tomcat/webapps
cp /tmp/IDMProv/IDMProv.war .

Delete the following files and folders:

  • IDMProv - folder from the tomcat/webapps -folder

  • All files and folders from the tomcat/temp -folder

  • All files and folders from the tomcat/work -folder


 

Start idmapps
/etc/init.d/idmapps_tomcat_init start

Your added Finnish localization string are now deployed to
/opt/netiq/idm/apps/tomcat/webapps/IDMProv/WEB-INF/lib/UserAppStrings_fi.jar
And the strings are visible in the /IDMProv/ - urls when your user account has attribute srvprvPreferredLocale set to "fi".

In the next part of this series I will be covering the HPD and OSP localization. Stay tuned.

DISCLAIMER:

Some content on Community Tips & Information pages is not officially supported by Micro Focus. Please refer to our Terms of Use for more detail.
Comments
Thanks for the helpful summary, great reading!

You might want to add, though, that after copying the new IDMProv.war, you should not only delete the tomcat/temp & tomcat/work folders, but also the tomcat/webapps/IDMProv folder.

Wolfgang
Top Contributors
Version history
Revision #:
1 of 1
Last update:
‎2015-06-29 19:32
Updated by:
 
The opinions expressed above are the personal opinions of the authors, not of Micro Focus. By using this site, you accept the Terms of Use and Rules of Participation. Certain versions of content ("Material") accessible here may contain branding from Hewlett-Packard Company (now HP Inc.) and Hewlett Packard Enterprise Company. As of September 1, 2017, the Material is now offered by Micro Focus, a separately owned and operated company. Any reference to the HP and Hewlett Packard Enterprise/HPE marks is historical in nature, and the HP and Hewlett Packard Enterprise/HPE marks are the property of their respective owners.