Appendix B Enabling Internationalization

This document provides information on configuring Identity Manager to use multiple languages or display a language other than English.

Architectural Overview

Table B-1 Components of Identity Manager Internationalization
File	Description
WPMessages.properties	Default message file. Located in $WSHOME/idm/web/WEB-INF/classes/com/waveset/msgcat. Shipped as part of the idmcommon.jar file. Displays message text in English and loads by default unless you’ve customized your IDM installation to behave otherwise.
Waveset.properties	Located in $WSHOME/config. Edit to enable support for multiple languages. (Set Internationalization.enabled to true.)
System Configuration Object	Specify custom message catalog.
additional message file for each supported language	Additional supported languages each require its own message file.WPMessages_xx_XX.properties, where xx represents the language and XX represents the country. For example, WPMessages_en_US.properties contains messages in American English. Each international catalog has its own .jar.

If you have loaded a new catalog in /config, the new catalog takes precedence over the default. This applies only to catalogs of the same name.

If you have more than one message file, you can specify the catalog from which a message key is derived by specifying catalogname:keyname.

Typical Entry

A text string, or key, that is an identifier used by the code to retrieve data. This required component should not be translated. It is used in the product configuration, and acts as a placeholder for the translation.

A equals ("=") sign separating the key and text. This is required.

A string containing data that will be displayed when running the application. This is the translation, used in place of the key whenever the page is rendered in the browser.

Each line in the resource array contains two strings. Translate the second quoted string on each line.

Certain strings to be translated contain special codes for data that will be inserted into the string when it is displayed. For example, if you have the following string to translate:

Translations typically appear inside a browser, so it is appropriate to add HTML tags to format the string, as shown below:

_FM_ACCOUNT_ID_HELP=<b>Account ID</b><br>Enter a name for this user. This field is required.

Enabling Support for Multiple Languages

To enable support for multiple language catalogs, follow these steps, which are described in created detail below:

Download localized files.

Edit the Waveset.properties file by setting Internationalization.enabled to true.

Import, edit and load the .\sample\i18n.xml file

Restart Identity Manager

Choose a language at the login screen. Additionally, the default language should match the language selected in the user's browser.

Step One: Download and Install Localized Files

Before You Install

Install Identity Manager. See Identity Manager Installation for detailed installation procedures.

Make sure the following locales on the application server have been set to UTF-8.

Application server instance

Database

Java Virtual Machine (JVM)

Refer to the documentation for these products for information about setting the locale.

Download Message Catalog Files

Download the appropriate msgcat jar and place it in WEB-INF/lib. The Identity Manager Image Server website provides the following ZIP files that contain localized product files and documentation.

Table B-2 Message Catalog Files
File Name (.zip)	Language	Locale
IDM__5_0_l10n_de	German	de_DE
IDM__5_0_l10n_es	Spanish	es_ES
IDM__5_0_l10n_fr	French (France and Canada)	fr_FR
IDM__5_0_l10n_it	Italian	it_IT
IDM__5_0_l10n_ja	Japanese	ja_JP
IDM__5_0_l10n_ko	Korean	ko_KR
IDM__5_0_l10n_pt	Brazilian Portuguese	pt_BR
IDM__5_0_l10n_zh	Simplified Chinese	zh_CN
IDM__5_0_l10n_zh_TW	Traditional Chinese	zh_TW

Download the ZIP file to a temporary location. By default, the contents of the ZIP file are extracted to the FileName\IDM_5_0_l10n directory, where FileName matches the name of the downloaded file, minus the ZIP extension.

Zip File Contents

A JAR file containing localized message catalogs, help files, and other essential files. The JAR file is named IDM_5_0_l10n_Locale.jar.

Identity Manager Localization README

A translated version of the Identity Manager 7.0 release notes

A translated version of Identity Manager Administration

Install Localized Files

Copy the JAR file from the temporary location to the IdentityManagerInstallation/WEB-INF/lib directory.

Step Two: Edit the Waveset.Properties File

Open the IdentityManagerInstallation/config/
Waveset.properties file with a text editor.

Change the Internationalization.enabled property to true.

Save your changes and close the file.

Either restart Identity Manager or select Debug > Reload Properties for this change to take effect.

Creating Links for Multiple Languages on the Login Page

To display links for multiple languages on the login page, first confirm the following:

The internationalization.enabled property in the waveset.properties file is set to true.

The relevant language packs are available in web-inf/lib. If necessary, load these libraries.

Using the Identity Manager IDE, open the System Configuration object and update the LoadedLanguages attribute with the names of the relevant language packages.

Log out of Identity Manager and restart the application server.

Code Example B-1 Updating the LoadedLanguages Attribute


<?xml version='1.0' encoding='UTF-8'?>

<!DOCTYPE Waveset PUBLIC 'waveset.dtd' 'waveset.dtd'>
<Waveset>
<ImportCommand class='com.waveset.session.SystemConfigurationUpdater'>
<Object>
<Attribute name='LoadedLanguages'>
<List>
<Object name='en_US'>
<Attribute name='lang' value='en'/>
<Attribute name='cntry' value='US'/>
</Object>
<Object name='fr_CA'>
<Attribute name='lang' value='fr'/>
<Attribute name='cntry' value='CA'/>
</Object>
</List>
</Attribute>
</Object>
</ImportCommand>
</Waveset>

Previous Contents Index Next
Sun Java[TM] System Identity Manager 7.0 Deployment Overview