Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Dictionaries are created via CO > Configuration > Dictionaries. Dictionaries can operate in several Modes:

  • Department: The Dictionary is automatically constructed from the Department Registry, using the object id and name as entries in the Dictionary.
  • Organization: The Dictionary is automatically constructed from the Organization Registry, using the object id and name as entries in the Dictionary.
  • Standard: Standard Dictionaries use Dictionary Entries, described below.

Dictionary Entries

Entries can be added manually, using a pre-defined list, or by uploading a file of entries.

...

  • Value: The entry, as a human readable text string. The only required field.
  • Code: A code representing the entry. The use is context specific, but may (for example) be used in constructing IDs for HTML Select lists.
  • Order: An integer representing the order of the entry within the Dictionary. The use is context specific, but may (for example) be used to bubble specific entries to the top of the Dictionary list.

Pre-Defined Standard Dictionaries

Some Pre-Defined Standard Dictionaries are available out of the box:

...

(Pre-Defined Dictionaries are distributed in the Lib/Dictionary directory, and use the Dictionary File Format defined below.)

Standard Dictionary File Format

Registry Dictionary Files are JSON documents, consisting of an object with the following members:

...