Localizing an Application with the Multi-Language Localization Method

Prerequisites

Address the following items prior to performing this procedure:

Determine the supported languages for the application and obtain the language names and locale names to match. For a complete list of locale names, see Language Identifier Constants and Strings.
Create or obtain the localization override files to use for each of the supported languages.
Determine the proper location to store the localization override files accessed by the server. The default location is the localizations sub-folder in the server’s installation location, though you can override this default location.
If the single language localization method is used to provide default override values, perform that procedure first.
Review the settings of the configuration options in the [Configuration] section of the Agentry.ini file, specifically the ClientStringFile, ApplicationStringsFile, and the ApplicationGlobalsFile.
Before making any changes to the Agentry.ini file, always make a backup copy of the current file, so you can revert any changes if necessary.

Context

This procedure describes how to localize an application using the multi-language method. Use this procedure when translating an application’s client UI into one or more different languages from the one in which it was developed. You can combine this procedure with the single language localization method if needed. However, that process is not discussed here, with the focus on the multi-language method of localization.

Procedure

Open the Agentry.ini configuration file in your preferred text editor.
Locate the section [Configuration] in this file. Set the value of the localizations option to contain a semicolon-delimited list of the locale names for the languages to support. If the localizations option is not listed, you can add it.

Here is an example of adding a localizations options list, set to provide support for two dialects of Spanish (Mexico and Span) and provide a default Spanish set of overrides: localizations=es-ES;es-MX;es.
If you are placing the localization files in a location other than the localizations sub-folder, set the configuration option localizationsPath to this location. If this option is not present, you can add it. If it is not necessary to override the default location, skip this step.
Verify the settings changed are accurate, close and save the Agentry.ini file.
Copy the localization override files to the localizations folder, or to the location specified in the localizationsPath configuration option, and verify that the names of these files match both the file name settings and the supported languages listed in the localizations option. Following is an example of the files needed based on support for Spanish as spoken in Spain, Mexico, and to provide a general Spanish set of overrides for other locales:
```
ApplicationText.es-ES.ini
ClientText.es-ES.ini
Globals.es-ES.ini
ApplicationText.es-MX.ini
ClientText.es-MX.ini
Globals.es-MX.ini
ApplicationText.es.ini
ClientText.es.ini
Globals.es.ini
```
Once this procedure is complete, restart the server.

The new override values are read in during the restart.

Results

Once this procedure is complete, the server uses the locale information provided by the clients to determine the proper override values, if any, to use. Those clients with a locale not set to one of those listed in the localizations option receive the overrides in the single language localization files; or, if these are not in use, the values as defined in the published application project are sent to clients by the server.