About lexicons

NiagaraAX provides non-English language support by use of lexicons. Lexicons are identified by Java locale codes, such as “fr” (French) or “de” (German). Starting in Workbench 3.7, all of the lexicons are distributed as modules (niagaraLexiconXx.jar) 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.

NoteAlthough module-based lexicons are introduced in Workbench 3.7, file-based lexicons continue to be supported. If you have used file-based custom lexicons in a prior release, you can continue to use those. In Workbench 3.7, you can deploy custom lexicons in any file-based/module-based combination.

To edit lexicons, you typically use the Workbench lexicon tool (Tools->Lexicon Tool). “Lexicon Report”, the default view, lists all lexicons installed on your Workbench PC and specifies details about a selected lexicon and its contained files. The “Lexicon Editor” view provides edit features and shows the default (English) value for each line entry. The “Lexicon Module Builder” view lets you bundle multiple lexicon files in a module for ease of distribution.

NoteIn some cases, lexicon editing provides utility even in English language scenarios. For more details, see the Lexicon Guide section on “Notes on English (en) lexicon usage”.

After editing a lexicon file, you can then install the file in a remote JACE using the platform Lexicon Installer view. An alternative is to create (or update) a lexicon module with the edited lexicon file, using the new Lexicon Module Builder view. Install the new (or updated) module in a remote JACE using the platform Software Manager view.

For detailed information on using the Lexicon Tool, see the NiagaraAX Lexicon Guide.