QTRACS Displays Utility - OMQTDSP
QTRACS Displays Utility (OMQTDSP)
Required Parameter Group:
| 1 | Display Mnemonic | Input | Char(8) |
| 2 | Input Block | Input | Char(256) |
| 3 | Return Status | Output | Char(2) |
API Overview:
The QTRACS Displays Utility API (OMQTDSP) invokes the appropriate QTRACS screen when a valid display mnemonic is input. This program acts as a shell to lower level programs in order to protect the programmer from any future changes to their calling interface.
The variable input block varies depending on the display mnemonic used. All detail displays share the same parameter list, however, 'Work with' directories vary. See the shaded data structures below for a list of each display mnemonic's appropriate parameter list.
Required Parameter Group Details:
(1) Display Mnemonic
INPUT; CHAR(8)
This parameter must be one of the following predefined mnemonics. It instructs the API which QTRACS screen to present the user.
| C%WWMSGS | Message Directory |
| C%VEHDIR | Vehicle Directory |
| C%WWUSER | Work with Users |
| C%WWVEHL | Work with Vehicles |
| C%WWCVRG | Work with Coverages |
| C%WWGRPS | Work with Message Groups |
| C%WWVPH | Work with Position History |
| C%WWDRVR | Work with Drivers |
| C%DDMSG | Message Detail Display |
| C%DDVEHL | Vehicle Detail Display |
| C%DDUSER | User Detail Display |
| C%DDGRP | Group Detail Display |
| C%DDDRVR | Driver Detail Display |
(2) Input Block
INPUT; CHAR(256)
This parameter is a variable format data structure that contains a different parameter list for each display mnemonic mentioned above.
C%WWMSGS Data Format (Message Directory)
| 1-10 | Message Mailbox ID to Show *CURRENT Current user's mailbox Entity ID Another entity's mailbox Blanks Blanks, current user's mailbox |
Char(10) |
| 11-21 | Message Mailbox Sender/Receiver Filter *ALL All messages to/from anybody Entity ID Only messages to/from this entity Blanks Blanks, all messages to/from anybody |
Char(11) |
| 22-43 | Begin Date (initial position-to) | Char(22) |
| 44-44 | Unseen First Y Unseen view first, N All messages view first |
Char(1) |
C%VEHDIR Data Format (Vehicle Directory)
| 1-10 | Initial Subset Entity (optional) *MCT *TMCT *OMNIONE *MCP Coverage Group Auxiliary Account Identifier |
Char(10) |
C%WWUSER Data Format (Work with Users)
| 1-256 | Set to Blanks | Char(256) |
C%WWVEHL Data Format (Work with Vehicles)
| 1-10 | Initial Subset Entity (optional) *MCT *TMCT *OMNIONE *MCP Coverage Group Auxiliary Account Identifier |
Char(10) |
C%WWCVRG Data Format (Work with Coverages)
| 1-256 | Set to Blanks | Char(256) |
C%WWGRPS Data Format (Work with Message Groups)
| 1-256 | Set to Blanks | Char(256) |
C%WWVPH Data Format (Work with Position History)
| 1-10 | Initial Subset Entity (optional) Vehicle, Auxiliary Vehicle |
Char(10) |
| 11-17 | Proximity Reference Subset *AUTO Proximity references default to user preferences Place ID Proximity references based on given place id Blanks Proximity references default to user preferences |
Char(7) |
C%WWDRVR Data Format (Work with Drivers)
| 1-1 | Driver Initial View D View by driver identifier V View by vehicle identifier |
Char(1) |
C%DDMSG Data Format (Message Detail Display)
| 1-5 | GMH of Message to Display | Packed(9,0) |
C%DDVEHL Data Format (Vehicle Detail Display)
| 1-1 | Function Code C Create vehicle 2 Edit vehicle 4 Delete vehicle 5 Display vehicle |
Char(1) |
| 2-11 | Owned Vehicle Identifier | Char(10) |
C%DDUSER Data Format (User Detail Display)
| 1-1 | Function Code C Create user 2 Edit user 4 Delete user 5 Display user |
Char(1) |
| 2-11 | User Identifier | Char(10) |
C%DDGRP Data Format (Group Detail Display)
| 1-1 | Function Code C Create group 2 Edit group 4 Delete group 5 Display group |
Char(1) |
| 2-11 | Group Identifier | Char(10) |
C%DDDRV Data Format (Driver Detail Display)
| 1-1 | Function Code C Create driver 2 Edit driver 4 Delete driver 5 Display driver |
Char(1) |
| 2-11 | Driver Identifier | Char(10) |
(3) Return Status
OUTPUT; CHAR(2)
Status value returned to the caller will be set as follows:
| 0 | Success, no changes to the record |
| 1 | Success, record added |
| 2 | Success, record changed |
| 3 | Success, record deleted |
| 4 | Success, F3 (exit) pressed |
| 5 | Success, F12 (cancel) pressed |
| 6 | Failure, insufficient user capabilities |
| 7 | Failure, call to lower level API rejected |
| 8 | Failure, invalid display mnemonic |