Copyright © Cloud Software Group, Inc. All Rights Reserved

Localizing the iProcess Workspace (Browser)

This chapter describes how to manually localize your TIBCO iProcess Workspace (Browser) client application.

Note that TIBCO has language packs available for selected languages, that when installed, localize your client application to the language for that language pack. For information about the available language packs, contact your TIBCO representative.

If the desired language is not available in a language pack, you can use the procedure described in this chapter to manually localize your client application.

Localizing the TIBCO iProcess Workspace (Browser) involves the following steps:

•	Create a new localized language resource file. The resource file contains a collection of application text strings that have been translated to a specific language and may be localized for language variations used by individual countries.

•	Configure the new localized language in the iProcess Workspace (Browser).

•	Modify an existing, or create a new, TIBCO® General Interface system locale file. These files contain localized resources utilized by the TIBCO® General Interface framework.

•	Translate user access profile descriptions.

•	Set the new default language for the iProcess Workspace (Browser).

•	Create a new folder to hold localized help files.

These steps are described in detail in the following subsections, using Spanish as an example of the new language being added to the iProcess Workspace (Browser).

Note that each localized language is represented by a two-letter code, in the format:

−

ll

where ll is a lowercase, two-letter ISO 639 language code. For a list of language codes, visit the following web site:

http://www.loc.gov/standards/iso639-2/langhome.html

Each country is represented by a two-letter code, in the format:

−

CC

where CC is an uppercase, two-letter ISO 3166 country code. For a list of country codes, visit the following web site:

http://www.iso.ch/iso/en/prods-services/iso3166ma/02iso-3166-code-lists/index.html

A locale key is a string representation of a locale that includes a language and a country code in the following format:

−

ll_CC

Create a New Localized Language Resource File

You must create a resource file that contains a collection of application text strings that have been translated to a specific language and may be localized for language variations used by individual countries.

Perform the following steps to create a new language resource file:

1.	Determine whether the new language file will contain translations that are:

a.	Generic for all locales - for instance, Spanish is sufficient without regard to variations for the specific dialects or alphabets of Spain or Mexico.

b.	Language defaults, with variations for specific locales - for instance, Spanish is the default, however, some words or phrases are defined specifically for the dialects or alphabets of Mexico and Spain.

c.	Locale specific - for instance, if the Spanish of Mexico did not have any words or phrases in common with the Spanish of Spain, you would create a separate language resource file for each country.

2.	Open a new XML file and insert the following XML elements, using the proper language code (if of type a or b above), or locale key containing both language and country codes (if of type c), as the value for the key attribute:

---

---

 

3.	Open the default (English) locale file:

ClientInstallDir\JSXAPPS\ipc\locale\locale.xml

4.	Copy all record elements that are direct children of the <locale> element in locale.xml.

Note - Only copy children of the <locale> elements that do not have a key attribute.

5.	Paste all copied record elements into the newly created file as direct children of the <locale key=”es”> element.

---

---

 

6.	Translate the value of every jsxtext attribute in the newly created file to language-specific values.

Note - Any record elements that are deleted from the new language resource file will cause the iProcess Workspace (Browser) to “fallback” to the record that is defined in the default (English) locale file.

7.

Optionally, localize the new language resource for specific countries. The purpose of localizing for specific countries is to provide a mechanism for overriding default language text values (translated in Step 6) with text values that are specific for a country and that differ from the default (type b above).

For each country-specific locale, create a <locale> element (within the root <data> element) and specify the locale key as the value of the key attribute. Insert record elements into each new <locale> element, that are to “override” default language records, with matching jsxid attribute values.

---

---

 

In the example above, the default Spanish language text of “Abierto” will be replaced with country-specific values when either the Spanish (Spain) or Spanish (Mexico) locales have been selected by the user as the language for the iProcess Workspace (Browser).

Any records not explicitly overridden in country-specific locales will “fallback” to the default language definition (e.g., “Cierre” in the example above).

8.	Save the newly created locale resource file as follows:

   ClientInstallDir\JSXAPPS\ipc\locale\locale.ll.xml

or (if of type c in step 1):

   ClientInstallDir\JSXAPPS\ipc\locale\locale.ll_CC.xml

where ll in the filename is the language code, and CC is the country code (e.g., locale.es.xml - for Spanish; locale.es_MX.xml - for a Mexico-only translation) and ClientInstallDir is the path to the directory in which the iProcess Workspace (Browser) is installed.

Configure the New Localized Language in the iProcess Workspace (Browser)

Perform the following steps to configure the new localized language in the iProcess Workspace (Browser):

1.	Add the new language code to the default language resource file.

a.	Open ClientInstallDir\JSXAPPS\ipc\locale\locale.xml and edit the value of the locales attribute of the root <data> element.

b.	Insert the two-letter language code of the new language into the comma-separated value of the locales attribute, as shown in the following example:

---

---

 

Adding the language code to locale.xml provides the necessary configuration to support the “override” and “fallback” relationship between the new file and the default language resource file.

Modify or Create a TIBCO® General Interface System Locale File

Some of the text that is displayed in the iProcess Workspace (Browser) application originates from the TIBCO® General Interface (GI) system locale files. Although several formats and text strings are defined in these GI locale files, only a few text items will ever display in the iProcess Workspace (Browser).

By default, GI is already localized for many languages and countries, however, some of the text displayed in the iProcess Workspace (Browser) is only defined in the default GI system locale file (English), and must be inserted and translated into other locale files as required.

For this version of the iProcess Workspace (Browser), TIBCO® General Interface supports the following languages and countries:

 

Language	ISO 639-1 Code	ISO 639-1 Code + ISO 3166 Code	Country
Arabic	ar	N/A
Chinese	zh	zh_CN zh_HK zh_TW	China Hong Kong Taiwan
Danish	da	da_DK	Denmark
English	en	en_AU en_CA en_GB en_NZ en_US	Australia Canada Great Britain (UK) New Zealand United States
French	fr	fr_CA fr_FR	Canada France
German	de	de_DE	Germany
Greek	el	el_GR	Greece
Italian	it	it_IT	Italy
Japanese	ja	ja_JP	Japan
Korean	ko	ko_KR	Korea
Portuguese	pt	pt_BR pt_PT	Brazil Portugal
Russian	ru	ru_RU	Russian Federation
Spanish	es	es_ES es_MX es_US	Spain Mexico United States
Swedish	sv	sv_SE	Sweden

The language resource files for these locales are stored at the following path:

ClientInstallDir\JSX\locale\

where ClientInstallDir is the path to the directory in which the iProcess Workspace (Browser) is installed. For example:

As with the iProcess Workspace (Browser), the default GI language resource file is locale.xml (English). If the locale resource files already defined by TIBCO® General Interface do not support the desired localization being created for the iProcess Workspace (Browser), a new GI system locale file must be created using the following steps:

1.	Create a new localized GI system language file using the same instructions as in Create a New Localized Language Resource File of this document, substituting ClientInstallDir\JSX\locale\ as the file path.

2.	Perform Step 1 of the section, Configure the New Localized Language in the iProcess Workspace (Browser) of this document, substituting ClientInstallDir\JSX\locale\ as the file path.

If TIBCO® General Interface already provides a locale resource file for the desired localization, perform the following steps to add text resources, utilized by the iProcess Workspace, into the locale file:

1.	Open the XML file corresponding to the language of the new localization (e.g., ClientInstallDir\JSX\locale\locale.es.xml) and open the default GI system locale file: ClientInstallDir\JSX\locale\locale.xml.

2.	Copy the following record elements from locale.xml into the locale file of the new localization (under the <locale> element whose key attribute value matches the locale key of the new localization):

---

---

 

3.	Translate the value of the jsxtext attributes to the desired language.

4.	Save the locale file (e.g., ClientInstallDir\JSX\locale\locale.es.xml).

Translate User Access Profiles Descriptions

User access profiles define the functionality available to various types of iProcess Workspace (Browser) users. The description of the profile defined for the logged-in user is displayed in the upper-right part of the application:

In the example above, “Access Level: Admin” is defined as the user access profile description for Admin-level users.

To localize user access profile descriptions, locate the <Profile> elements in the ClientInstallDir\JSXAPPS\ipc\userAccessProfiles.xml file (where ClientInstallDir is the path to the directory in which the iProcess Workspace (Browser) is installed), and change the description attributes to the desired language.

Set the New Default Language for the iProcess Workspace (Browser)

Set the new default language using one of the following methods:

•	Modify the config.xml file to specify the default localeKey, as follows:

---

---

•	Or, specify the language on the Options dialog in the application. For information about setting options in the application, see the TIBCO iProcess Workspace (Browser) User's Guide.

Create a New Folder to Hold Localized Help Files

If you have help files that have been localized, they need to be copied to the appropriate folder so that the iProcess Workspace (Browser) can find them based on the locale under which the application is running.

Perform the following steps to create the folders necessary to hold the localized help files for the iProcess Workspace (Browser).

1.	Create a new folder at the following path:

ClientInstallDir\Help\language\ll

where ClientInstallDir is the path to the directory in which the iProcess Workspace (Browser) is installed, and ll is the two-letter language code for the help files.

If the help files are not country-specific and will be applicable for all locales of this particular language, proceed to Step 2 to store the files in this new language folder.

If your help files are localized for specific countries, create another folder beneath this new language folder, using the two-letter country code for the folder name (e.g. ClientInstallDir\Help\language\ll\CC). Proceed to Step 2 to store the files in this new country folder.

2.	Copy the localized help files into the new folder.

Copyright © Cloud Software Group, Inc. All Rights Reserved