F Internationalization and Localization

This appendix describes how Application Configuration Console supports internationalization and what has to be done to localize the product for a given locale.

F.1 I18N Implementation in Application Configuration Console

Application Configuration Console provides internationalization support by externalizing message and UI elements in resource bundles so that the text content can be translated into the local language.

The resource bundles are contained in the following properties files:

  • plugin.properties–contains values that appear in the About dialog, including View names and other Eclipse-related items.

  • MessagesBundle.properties–contains text strings (informational and error messages; UI controls and labels) for all Application Configuration Console components, including the Core Server and Client, the three automation modules, and Web Reports.

Note:

A third properties file, HelpBundle.properties, contains strings that link to context-sensitive help topics. These strings are not help content and are therefore not candidates for translation.

The Application Configuration Console Client now includes controls that allow you to select an encoded character set to interpret file and directory names on the target system. You also select the encoded character set to interpret the contents of configuration files that you load into Application Configuration Console as assets.

All Application Configuration Console Server and Client files (.log,.xml,.txt, and so forth) are in UTF-8 format so that they are interpretable in any locale. Likewise, all server-generated e-mails are in UTF-8 format. Thus, the mail server must be able to forward e-mail correctly; that is, any problems with displaying/interpreting e-mail sent from Application Configuration Console stem from the mail server. Note, however, that the Core Server and Client installer panels remain in English, as assistance can be provided for those who need it.

F.2 Localize the Database

The first step to localization is to create a new database in the appropriate encoded character set. For multibyte support, the only deviation from a standard default installation is to make the following selection on the Character Sets tab:

Use Unicode (AL32UTF8)

If you want to preserve your data, do a full export/import to properly convert all data to the new character set.

F.3 Text Translation

After you localize the database, have the files translated into the language of the locale. Minimally, you will want to translate the resource bundles. You may also want to translate the Application Configuration Console Online Help.

If the translated properties file is encoded in a non-Latin-1 character set, convert the file using the Java native2ascii utility prior to placing it in the installation directory. Be sure to remove the BOM (byte order mark) character before or after the conversion.

With the translated text properly in place in the application, you can configure the system to support the local language.

F.4 Localize Application Configuration Console

Application Configuration Console localization involvesa number of aspects as covered in this section.

F.4.1 Preparing the Client Machine for Localization

The machine hosting the Client must be configured appropriately to support the local language, as follows:

  • The requisite language packs and the fonts to support them must be installed on the host machine; otherwise, translated text will not display properly.

  • Control Panel > Regional and Language Options settings must be configured to support the language and customs of the locale.

  • For Web Reports, set the browser to display the appropriate language.

Note:

Problems of interpretation or display can be attributable either to font availability or encoding support. Open (transparent) squares denote a font issue; question marks (????) indicate an encoding issue.

F.4.2 Starting a Localized Client

To run a locale-specific version of the Client, you have to edit the startup.bat file.

  1. On the Client machine, navigate to the following directory:

    $CLIENT_HOME/runtime
    
  2. Open the startup.bat file in a text editor.

  3. Add an argument similar to the following to the start eclipse.exe command.

    -nl locale
    
    
    

    where locale is the ISO language code of the local language, fr_FR, for example.

  4. Save the file.

Upon startup, the Client checks for a matching MessagesBundle_isocode.properties file in the appropriate location. The Client retrieves from the original (English) version of MessagesBundle.properties any string that it does not find in the translated version.

F.4.3 Localizing for Configurations

Application Configuration Console manages configurations on target systems. A localized version of the product needs to encode configuration file contents and the directory structure in which the files exist. This section describes how to configure the Client accordingly.

F.4.3.1 Localizing the Target System Directory Structure

If a target system's file and directory names are in a different encoding from that of Application Configuration Console, the names will be corrupted. To circumvent the problem, set the encoding to match the target system when you create the host/endpoint in Application Configuration Console.

See the Application Configuration Console Online Help for instructions on how to set the encoding for the target host.

F.4.3.2 Localizing Configuration Contents

To load asset configurations in Application Configuration Console in the encoding of the locale, you have to set the encoding for each resource definition as part of the process of creating a file resource specification.

See the Application Configuration Console Online Help for instructions on how to set the encoding for resource definitions.

F.4.4 Localizing Custom Web Reports

You can integrate custom reports developed by Professional Services into Web Reports and make them accessible from the menu bar. The process is described in the Web Reports Online Help. For purposes of translation, you can edit the appropriate string values in Messages.Bundle.properties, specifically:


report.name.customreport=Custom Report
report.menu.custommenu=Custom Menu

These names correspond to the report definitions and menu items you add to the Web Reports Registry (webreports_registry.xml) to integrate the custom reports.

Remember that if the translated property file is encoded in a non-Latin-1 character set, you must convert the file using the Java native2ascii utility; for example:

native2ascii -encoding utf-8 MessagesBundle.fr MessagesBundle_fr.properties

And then place the property file appropriately on the Client and the Core Server, as follows:

$CLIENT_HOME/runtime/plugins/com.mvalent.integrity_5.3.2/config/MessagesBundle_fr.properties
$SERVER_HOME/appserver/tomcat/shared/classes/MessagesBundle_fr.properties

Note that the translated version has a suffix appropriate to the local language.

F.5 Localization Checklist

Use this checklist as a guideline to ensure proper localization setup.

  • Have you localized the Oracle database?

  • Does the local Windows environment support the proposed character encoding?

  • What is the character encoding of the files and directories on the target host, that is, the host whose resources you want to manage?

  • What is the character encoding of the configuration file contents that you want to manage?

  • If your translated properties file is encoded in a non-Latin-1 character set, did you convert it using the Java native2ascii utility?

  • Have you created a host/endpoint in Application Configuration Console that specifies the character encoding of the target host?

  • Have you created a resource specification of resource definitions that specify the character encoding of the configuration files you want to manage?

  • Were there any parsing problems during the resource specification creation process?

    • Ensure that you selected the correct character encoding for the resource definition.

    • Check that the default transform parameters are right for the configuration file. For example, you may need to change the comment character or end-of-line character.

    If you cannot resolve the problem, select No Mapping. This will allow you to load assets using the resource specification, which you can then track, compare, provision, and so forth.