Sun Identity Manager Deployment Guide

Chapter 11 Enabling Internationalization

This chapter describes how to configure Identity Manager to use multiple languages or to display a language other than English.

Architectural Overview

Table 11–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 Identity Manager installation to behave otherwise. 

Waveset.properties

Located in $WSHOME/config.

To enable support for multiple languages, you must set Internationalization.enabled to true. (Default is true.)

System Configuration Object

Specify a custom message catalog 

Additional message file for each supported language 

Additional supported languages each require their 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.


Note –

The following catalog entries control how the product name is displayed:

PRODUCT_NAME=Identity Manager
LIGHTHOUSE_DISPLAY_NAME=[PRODUCT_NAME]
LIGHTHOUSE_TYPE_DISPLAY_NAME=[PRODUCT_NAME]
LIGHTHOUSE_DEFAULT_POLICY=Default [PRODUCT_NAME] Account Policy

Typical Entry

Messages are contained in key/text pairs and contain three parts:

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 is inserted into the string when it is displayed. For example, if you have the following string to translate:

UI_USER_CONNECT={0}, connected at 100 mbs

the rendered version could appear as jfaux, connected at 100 mb

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

Use the instructions described in this section to enable multiple language support for Identity Manager.

Step One: Download and Install Localized Files

Perform the following tasks”

Before You Install

Perform the following tasks before you install localized files:

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

  2. 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

The Identity Manager software download website provides the following localized message catalogs. Download the appropriate message catalog jar file and place that file in the WEB-INF/lib directory.

Table 11–2 Message Catalog Files

File Name (.zip)  

Language  

Locale 

IDM__8_1_l10n_de 

German 

de_DE 

IDM__8_1_l10n_es 

Spanish 

es_ES 

IDM__8_1_l10n_fr 

French (France and Canada) 

fr_FR 

IDM__8_1_l10n_it 

Italian 

it_IT 

IDM__8_1_l10n_ja 

Japanese 

ja_JP 

IDM__8_1_l10n_ko 

Korean 

ko_KR 

IDM__8_1_l10n_pt 

Brazilian Portuguese 

pt_BR 

IDM__8_1_l10n_zh 

Simplified Chinese 

zh_CN 

IDM__8_1_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_8_0_l10n directory, where FileName matches the name of the downloaded file, minus the ZIP extension.

Zip File Contents

Every extracted ZIP file contains the following:

Additional translated publications might also be available.

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

To edit the Waveset.properties file,

ProcedureTo Edit the File

  1. Open the IdentityManagerInstallation/config/Waveset.properties file with your editor of choice.

  2. Change the Internationalization.enabled property to true.

  3. Save your changes and close the file.

  4. Either restart Identity Manager or click Reload Properties on the Debug pages available at the following location:

    http://host:port/idm/debug.url

Maintaining ASCII Account IDs and Email Addresses During Anonymous Enrollment Processing

By default, Identity Manager’s anonymous enrollment processing generates values for accountId and emailAddress by using user-supplied first (firstName) and last names (lastName) as well as employeeId. Because anonymous enrollment processing can result in the inclusion of non-ASCII characters in email addresses and account IDs, international users must modify EndUserRuleLibrary rules so that Identity Manager maintains ASCII account IDs and email addresses during anonymous enrollment processing.

To maintain account ID and email address values in ASCII during anonymous enrollment processing, follow these two steps:

ProcedureTo Maintain Account ID and Email Address Values

  1. Edit the following rules in the EndUserRuleLibrary as indicated in the following table:

    Edit this rule 

    To make this change...  

    getAccountId

    To use employeeId only (and remove firstName and lastName)

    getEmailAddress

    To use employeeId only (remove firstName, lastName, and “.”)

    verifyFirstname

    To change length check from 2 to 1 to allow for single character Asian first names 

  2. Edit EndUserAnonEnrollmentCompletionForm to remove the firstName and lastName arguments from calls to the getAccountId and getEmailAddress rules.