Localization in CA Identity Manager

Document ID : KB000009545
Last Modified Date : 14/02/2018
Show Technical Document Details
Introduction:

Localization is available to configure the following elements in the CA Identity Manager User Console to a particular language:

  • Prompts, buttons, text, tabs, and titles that appear in the User Console
  • Validation, status, and error messages and instructions that are displayed to CA Identity Manager users
  • Email notifications
  • Graphics
  • Custom features created with the CA Identity Manager APIs

This guide will help put the language desired in the CA Identity Manager and additional languages. The following languages are supported:

  • French
  • German
  • Italian
  • Japanese
  • Korean
  • Polish
  • Portuguese
  • Nordic
  • Simplified Chinese
  • Spanish
Instructions:

Follow the provided steps to successfully configure localization in your environment:

1) Configure Your Environment

In order to run the commands described in this document, you will need ant 1.7 or later and Java JDK 1.5 or later. Both ant and Java JDK must be on your path.  These can be added with the following WINDOWS commands:

PATH %JAVA_HOME%\bin;%PATH%

PATH %ANT_HOME%\bin;%PATH%

 

2) Enable Language Switching

Navigate to your Management Console (…/iam/immanage). Then navigate here: Environments -> <environment-name> -> Advanced Settings -> User Console -> Check the “Enable Language Switching” checkbox

 

ewnablelangue.png

 

3a) Single Language Environment:

To translate your Roledefinitions.xml into a different language, there are ones available in the samples folder included with the product. These are located here: ...\Identity Manager\IAM Suite\Identity Manager\tools\samples\Localization. Each folder is labelled with their respective language. Select the RoleDefinition.xml and import it using the management console:

r&amp;tiamge.png

3b) Multi-language Environment:

Note: If you are going to support multiple languages in your Identity Manager environment, you develop roles in English, export the roles into a role definitions file, tokenize the role definitions file, add the additional resources to a resource bundle and then translate the resulting resource bundle to multiple languages.

 

These steps need to be followed in this order:
       1.Export Roles and Tasks XML from the Identity Manager Management Console (As seen above)
       2.Tokenize the RolesDefinition.xml
       3.Translate the tokenized RolesDefinition.xml
       4.Follow the Translating Resource Bundle steps
       5.Restart the application server
       6.Upload the tokenized RolesDefintion.xml into your environment

Notes are located below if encountering any issues.

 

4) Tokenizing Role Definitions

To tokenize the resource file and generate the additional resources, navigate to the Localization directory, and then run the following command:

ant tokenizeroledef -Dinputfile=RoleDefinitions.xml

 

This will produce RoleDefinitions_Tokenized.xml and  RoleDefinitions_Tokenized.properties.

 

5) Translating Role Definitions

Note: When using multi-language environment, be sure to use the tokenized rolesdefinition.xml file. It should look something like this: "RolesDefinition_Tokenized.xml"

Translate role definitions using the dictionary included in the Localization directory.  Run the following command in the Localization directory.

Ex. ant translateroledef -Dinputfile=RoleDefinitions.xml (Note: Your RoleDefinitions.xml name may be different)

 

This will produce a RoleDefinitions_languagecode.xml for each supported language. Append the properties to your English resources. Strings that could not be translated with the dictionaries will remain in English.

 

6) Translating Resource Bundles

Translate resource bundles using the dictionary included in the Localization directory.  Write missing dictionary entries to a file.  Run the following command in the Localization directory.

ant translateresourcebundle -Dinputfile=bundlename.properties

 

This will produce a bundlename_languagecode.properties for each supported language and add any strings that could not be translated to a bundlename_languagecode.missing file.

 

Wildfly Version:

These files should be placed here: <Wildfly_Home>\standalone\deployments\iam_im.ear\custom\resourceBundles

 

JBoss Version:

 

<Jboss_directory>\server\default\deploy\iam_im.ear\custom\provisioning\resourceBundles

 

7) Uploading RolesDefinitions.xml

Navigate to the Identity Manager Management Console and upload the tokenized English Rolesdefinition.xml first and then any other language that you would require into your environment.

 r&amp;tiamge.png

 

Reference: Additional information can be located here ...\Identity Manager\IAM Suite\Identity Manager\tools\samples\Localization\readme.htm

Additional Information:

Errors you might encounter when adding localization

 Missing Roles: Reattached the System Manager user in the Identity Manager Management console and then restart the environment

Languages not changing: Please upload both tokenized languages including the English version into the environment