Enabling the Diagnostic Lexicon feature

This section describes how to make the Diagnostic Lexicon feature active. When enabled and configured, this can help to ensure that a lexicon is properly translated and it can also reveal the proper lexicon module and lexicon key for lexicon's displayed on the page.

The lexicons for different languages are part of your installation and are present in the!modules folder. For example, the German lexicon module name is: NiagaraLexiconDe-rt.jar.

To enable the Diagnostic Lexicon feature, you need to add a system property, as described in the following steps.

Perform the following steps:
  1. In the NavTree, expand My Host > My File System > Sys Home, and open the defaults folder.
  2. Scroll to locate the system.properties file and double-click to open it in the Text Editor view.
  3. In the Text Editor, scroll to locate the section beginning with: # This system property is used to override the default locale.”.
  4. At the end of this section, type this entry on a separate line (as shown in the blue box): niagara.lexicon.diagnostics=true.
    Image
  5. Save this change and restart Workbench.
After restarting, the Diagnostic Lexicon feature is active.

Once the Diagnostic Lexicon feature is active you can configure the feature with different entries to help you find and fix lexicon issues. Examples of lexicon issues and the recommended system property entries are as follows:

  • For a simple visual indicator that values come from a lexicon, you can add a single-character prefix such as "~" (example: "~January"). To add this prefix to all lexicon values, add this entry: niagara.lexicon.diagnostics.prefix=~
  • To identify a lexicon key and module you can use a longer prefix: "lexiconModule-lexiconLang-lexiconKey=" (example: "baja-en-january=January". To add this longer prefix to all lexicon values, add this entry: niagara.lexicon.diagnostics.prefix=lexiconModule.lexiconLang.lexiconKey=
  • To add a suffix to all lexicon values using the character, “~”, add this entry: niagara.lexicon.diagnostics.suffix=~
  • To fix missing lexicons for the java lexicon, add this entry: niagara.lexicon.diagnostics.addMissing=true
  • To modify only missing lexicons for the java lexicon, add this entry: niagara.lexicon.diagnostics.onlyMissing=true
 NOTE: : Following the Workbench restart, the changes in the lexicon are visible.