Global Captions and Application Captions can be translated and published to the data model to provide localized content.

This functionality can be used—for example, in conjunction with the language pack(s) available in IRM Web Client to provide full localization of that client.

For more information about localizing elements of IRM Web Client using language packs, refer to the Settings and Customization section in IRM Web Client Installation Guide.

• Overview of procedure

• Procedure for localizing captions and publishing them to the data model

Overview of procedure

Each additional language is added to the languages.xml file to create a placeholder for that language in the Application Designer. With Application Designer in Draft mode, the set of captions corresponding to that language can be translated and published to the data model. The captions for that language are then available to be provided as localized content to clients. For detailed steps about how to perform this procedure, refer to the subsection below.

Procedure for localizing captions and publishing them to the data model 

The following procedure details for adding one additional language to Application Designer, for localizing, and for publishing corresponding captions to the data model for use in client applications. For additional languages, repeat the procedure as required. By default, Application Designer is configured for US English (en-US) only.

1. Create a placeholder in Application Designer for the new language:

   1. Browse to <installation path>\iManage\Records Manager\Application Designer and open the languages.xml file with a suitable editor.

   2. Under <Languages> add a new element for the new language—for example, for German (Austria) as follows:

      <Languages>

      <Language Value="en-US" Default="True" />

      <Language Value="de-AT" />

      </Languages>

      The Language Value you enter depends on whether you require or wish to specify regional variants for the language.
      NOTE: For IRM Web Client, when a language is specified in (the data model, as published from) Application Designer (for example—German, "de"), but its regional variants aren't, IRM Web Client still displays the content corresponding to the "de" data model when a regional variant of that language (for example—Austrian German, "de-AT") is selected in the browser. If there's no corresponding language or regional variant available, IRM Web Client displays content from the default "en-US" data model.

      In either case, the Language Value entered in the languages.xml file must comply with the following syntax:

      1. If you don't require or wish to specify regional variants for the language, enter Language Value per the ISO 639-1 designation of the country—for example, for German:

         • de

      2. If you require or wish to specify regional variants for the language, enter the Language Value per the ISO 639-1 designation of the country and the Alpha-2 ISO-3166 designation of the region, separated by a hyphen—for example, for German (Austrian German, Swiss German):

         • de-AT

         • de-CH

         In this case, when a regional variety of German is selected in the web browser, IRM Web Client selects the corresponding data model if it's available. However, if an unavailable regional variant is selected, IRM Web Client defaults back to the "en-US" data model, unless a non-regionally-designated data model (for example, "de") is available. You may therefore wish to consider such non-regionally-designated data model as a fallback in the case of unavailable regional variant data models, when other regional variant data models are specified.

   3. Save the languages.xml file.

2. Access Application Designer, or if Application Designer is already open, relaunch Application Designer.

3. You can now access the placeholder captions for the additional language or languages that you wish to add, and localize them.

   1. To do so for Application Captions:

      1. Select Draft on the toolbar.

      2. Select Configuration.

      3. In the Configuration pane, select the Captions node.

      4. Select Application Captions.

      5. Select Language. A drop-down list displays with the language or regional variant corresponding to that (or those) you added to the languages.xml file in Step 1 above. Select the language that you wish to localize the captions for.

      6. For each caption, there's an ID field and a Caption field. Enter the translations, as required, in the Caption field.

      7. When all of the desired Application Captions translations are added, select Publish to save the new captions to the IRM data model on the server.

   2. To do so for Global Captions:

      1. Select the Draft button on the toolbar.

      2. Select Configuration.

      3. In the Configuration pane, select the Captions node.

      4. Select Global Captions.

      5. Select Language. A drop-down list displays with the language or regional variant corresponding to that (or those) you added to the languages.xml file in Step 1 above. Select the language that you wish to localize the captions for.

      6. For each caption, there's an ID field and a Caption field. Enter the translations, as required, in the Caption field.

      7. When all of the desired Global Captions translations are added, select the Publish button to save the new captions to the IRM data model on the server.

4. The localized items for the languages added, (that is, the translated captions now reflected in the data model) are now available for IRM Desktop Client (when restarted, and typically corresponding to the Windows language settings for that user, or alternatively by selecting Tools > Options > Languages > Custom language and then selecting the newly added language from the drop-down list), and for IRM Web Client, as specified by browser language selection.