Lexicon overview

Standard lexicons are distributed as modules (niagaraLexiconXx.jar) that are included in the Workbench installation. Each lexicon module contains one or more lexicon files (moduleName.lexicon). Lexicon files are simple text files that map various entity “keys” (such as interface names or error and status values) to localized language character values. Often, mapped characters use special encoding.

Niagara provides non-English language support with the use of lexicons. Lexicons are identified by Java locale codes, such as “fr” (French) or “de” (German). When installing Niagara on your PC, the full complement of lexicon modules are installed in the !modules folder.

NOTE: In some cases, lexicon editing provides utility even in English language scenarios. For more details, see About English (en) lexicon usage.

For example, the following 3 lines are a “snippet” from the alarm.lexicon file in a French (fr) lexicon set:

commands.reset.label=Remettent \u00E0 l'\u00E9tat initial messages.connectionError=N'a pas pu se relier \u00E0\:  {0} portal.wizard.title=Ajoutez La Console D'Alarme

NOTE: The factory supplied language lexicons typically require review and editing before they can be used on an actual job. Text file based customizations of the standard lexicons are saved under a “!lexicon” folder in your installation directory.

To edit lexicons, you typically use the Workbench Lexicon Tool (Tools > Lexicon Tool). The Lexicon Editor view not only provides edit features, but also shows the default (English) value for each line entry. Any changes you make to a lexicon using the Lexicon Editor are saved as lexicon files, under the appropriate !lexicon subfolder for the target locale. For example, changes to the French lexicon are saved in the !lexicon/fr subfolder.

NOTE: The !lexicon folder does not exist in a new installation. The folder is created the first time you edit a lexicon and save it.

The lexicon tool also provides a Lexicon Report view, useful to see various details about a lexicon and its contained files. Additionally, the Lexicon Report view lists all lexicons installed on your Workbench PC. The Lexicon Module Builder view, facilitates collecting multiple lexicons in a module for ease of distribution.

The Lexicon Module Migrator, allows you to migrate AX-3.8 lexicon modules to a more recent installation.

Once reviewed and edited, you typically install any needed lexicon into all controller platforms. For more details, see the Lexicon Installer and Software Manager sections in the Niagara Platform Guide.

Lexicon overview

Related Links