Creating of a new lexicon module for distribution

This procedure shows how to bundle two edited lexicon files (alarm, control) in a module for easy distribution.
Prerequisites:
 NOTE: This method can be used to bundle legacy lexicon files for distribution or to compile custom lexicon files for use in a installation. 

To create the new lexicon module:

  1. From the Tools menu, select Lexicon Tool.
    The Lexicon Report view displays all lexicons currently installed.
  2. Click the View dropdown menu and select Lexicon Module Builder. The Lexicon Module Builder view displays populating the selection table with any subfolders and files currently located under your !lexicon folder.
  3. Define the new module information by filling in the text fields as shown here:
    • Module Name: abcLex
    • Preferred Symbol: abc
    • Module Description: Modified En alarm and control
    • Vendor Name: abc Company
    • Version: 1.1
  4. Click the check box to select the following Source files in the “En” lexicon:
    • alarm.lexicon
    • control.lexicon
  5. Click the check box to Delete lexicon files after build to remove these source files from the !lexicon/en folder.
  6. Click the Build Module button.
    This creates the new abcLex.jar module under your !modules folder.
  7. Restart Workbench.

Navigate to the !modules folder and scroll to confirm the new module was created. You can install this new lexicon module on remote controller platforms (using platform Software Manager), such that stations running on them serve up the same changed descriptions to browser clients.

 NOTE: If working on a Supervisor (hosting a station), note that following a station restart, such lexicon changes become effective defaults to web browser clients connecting to the station. Note also that any “display name” changes for slots on a component override any lexicon values, including any modified in this manner. For example, if a BooleanWritable has the Display Name of its “active” action slot edited to “Start Pump”, that command text will always appear when issuing this action, whether from client browser access or from Workbench access.