This chapter describes how to configure Waveset to use multiple languages or to display a language other than English.
File |
Description |
---|---|
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 Waveset installation to behave otherwise. |
|
Located in $WSHOME/config. To enable support for multiple languages, you must set Internationalization.enabled to true. (Default is true.) |
|
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. |
If you loaded a new catalog in /config that uses the same name as the default catalog, the new catalog takes precedence over the default.
If you have more than one message file, you can specify the catalog from which a message key is derived by specifying catalogname:keyname.
The following catalog entries control how the product name is displayed:
PRODUCT_NAME=Waveset LIGHTHOUSE_DISPLAY_NAME=[PRODUCT_NAME] LIGHTHOUSE_TYPE_DISPLAY_NAME=[PRODUCT_NAME] LIGHTHOUSE_DEFAULT_POLICY=Default [PRODUCT_NAME] Account Policy
Messages are contained in key/text pairs and contain three parts:
A text string, or key, that is an identifier used by the code to retrieve data. Do not translate this required component. This component is used in the product configuration, and acts as a placeholder for the translation.
An equals (“=”) sign separating the key and text. This entry is required.
A string containing data that is displayed when running the application. This entry 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 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.
Use the instructions described in this section to enable multiple language support for Waveset.
Perform the following tasks”
Perform the following tasks before you install localized files:
Install Waveset. See Installation Guide 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.
The Waveset 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 13–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.
Every extracted ZIP file contains the following:
A JAR file containing localized message catalogs, help files, and other essential files. The JAR file is named IDM_8_1_l10n_Locale.jar.
Waveset Localization README
Additional translated publications might also be available.
Copy the JAR file from the temporary location to the IdentityManagerInstallation/WEB-INF/lib directory.
To edit the Waveset.properties file,
Open the InstallDir/config/Waveset.properties file with your editor of choice.
Change the Internationalization.enabled property to true.
Save your changes and close the file.
Either restart Waveset or click Reload Properties on the Debug pages available at the following location:
http://host:port/idm/debug.url
By default, Waveset’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 Waveset 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:
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 |
Edit EndUserAnonEnrollmentCompletionForm to remove the firstName and lastName arguments from calls to the getAccountId and getEmailAddress rules.