Skip to main content
Omnitracs Knowledge Base

Dictionary Entry

DictionaryEntry is implemented as the DictionaryEntry class. A DictionaryEntry object provides components of the composition of a dictionary entry on QTRACS/Portal used in macro messaging. The attributes of DictionaryEntry are:

 

Attribute

 

 

Description

 

description

A string of maximum length 1000 containing a description of the entry.

dictionaryType

A single characeter string that specifies the type of the dictionary entry.
"S" - Standard dictionary entry
"C" - Custom dictionary entry

direction

A single character string that specifies the direction of the macro which the dictionary entry is allowed to be used in.
"F" - Forward macros only
"R" - Return macros only
"A" - Allowed in all directions

entryType

A single character string that specifies the type of the dictionary entry.
"F" - Dictionary field entry
"G" - Dictionary group entry

enumerations

A comma delimited string of up to 100 values,each with a maximum length 38, that contains enumerations for applicable dictionary entries.

inUse

A boolean value indicating if the dictionary entry is currently in use in a macro.

mobileDataType

An integer value stating the data type of the dictionary entry on the mobile unit.
A list of valid mobile data types can be found on the Macro Field Types page.

mobileLength

An integer value stating the display length of the dictionary entry on the mobile unit.  When creating a macro, this item may be set to 999 to indicate a variable length instead of a fixed length.

name

A string of maximum length 25 the identifies the dictionary entry.

xmlTag

A string of maximum length 25 that identifies the dictionary entry for integration purposes. The string must begin with a lowercase letter.

  • Was this article helpful?