Skip to main content
Omnitracs Knowledge Base

Get System Configuration Data -OMGCFG

  1. Last updated
  2. Save as PDF

Get System Configuration Data (OMGCFG) RI

Required Parameter Group:

1 Format Name Input Char(6)
2 Return Status Output Char(1)
3 Return Block Output Char(256)

API Overview:
The Get System Configuration Data API (OMGCFG) is used to return the contents of the QTRACS Configuration Database. This API may be used by external applications when it is necessary to determine the current settings of various system-wide QTRACS settings.

Required Parameter Group Details:
(1) Format Name
INPUT; CHAR(6)
The format of the information to be returned. Valid values are:

CFG100 Audit, customer and miscellaneous information
CFG150 Company information
CFG200 Time configuration
CFG300 Statistics
CFG400 Batch message transmission schedule
CFG500 Purge parameters (return block prior to QTRACS v5.0)
CFG501 Purge parameters (return block replacing CFG500 for QTRACS v5.0)
CFG600 Work with vehicles external API function keys and options
CFG700 Vehicle detail external API function keys
CFG800 Work with messages external API function keys and options
CFG900 Message detail external API function keys

(2) Return Status
OUTPUT; CHAR(1)
Status value returned to the caller will be set as follows:

0 Success, valid configuration record found and information returned
1 Failure, configuration record not found and no information is returned
2 Failure, requested configuration data block is invalid
A Failure, API failed when called remotely

(3) Return Block
OUTPUT; CHAR(256)
Variable format data structure that returns information to the calling program based on the 'format name' parameter. If the 'return status' parameter is not '0', the contents of this return block are not reliable.
The supported data formats are shown in the shaded tables below.
CFG100 Data Format (Audit, customer and miscellaneous information)

1-7 Last Modified Date Packed(13,0)
8-17 Last Modified User Char(10)
18-27 Customer Group ID Char(10)
28-28 Account Type (as defined by NMC) Char(1)
29-29 DTTS Enabled (0=no, 1=yes) Char(1)
30-32 Bad MCT Count Packed(5,0)
33-33 Send Autofill Warning to NMC(0=no, 1=yes) Char(1)
34-34 Allow Autofill Type Fields (0=no, 1=yes) Char(1)
35-35 Autofill In Use (0=no, 1=yes) Char(1)
36-45 Place Alias Label Char(10)
46-55 Customer Account Number Char(10)
56-56 QMASS Enabled Char(1)
57-66 Auxiliary Account Number Char(10)
67-67 Allow Arrival Macro Field Types (0=no, 1=yes) Char(1)
68-68 Allow TMCT Configuration (0=no, 1=yes) Char(1)
69-70 Size of Fleet-Wide Phone Book ** *OBSOLETE **** Packed(3,0)
71-73 TMCT MIPR High Range (secs) Packed(5,0)
74-76 TMCT MIPR Low Range (secs) Packed(5,0)
77-79 MCT MIPR High Range (mins) Packed(5,0)
80-82 MCT MIPR High Range (mins) Packed(5,0)
83-83 Global Login Enabled (0=no, 1=yes) Char(1)
84-86 TMCT Min Position Archiving Interval Packed(5,0)
87-88 TMCT Max Position Archiving Percent Packed(3,0)
89-91 MCT Min Position Archiving Interval Packed(5,0)
92-93 MCT Max Position Archiving Percent Packed(3,0)
94-97 Group Address Request Status Char(4)
98-104 Last Group Address Request Timestamp Packed(13,0)
105-109 NMC's IP Port Number Char(5)
110-209 NMC's IP Address Char(100)
210-210 Auto Copy Forward Messages Char(1)
211-212 Coverage Address List Membership Limit Packed(3,0)
213-215 Forward Message Addressees Limit Packed(5,0)
216-219 MCP MIPR High Range (secs) Packed(7,0)
220-223 MCP MIPR Low Range (secs) Packed(7,0)

CFG150 Data Format (Company information)

1-25 Company Name Char(25)
26-29 SCAC Char(4)
30-54 Company Contact Char(25)
55-79 Address Line One Char(25)
80-104 Address Line Two Char(25)
105-129 City Char(25)
130-131 State Char(2)
132-133 Country Char(2)
134-142 Postal Code Char(9)

CFG200 Data Format (Time configuration)

1-3 System Time Zone Code Char(3)
4-4 Recognize Daylight Savings(N=no, Y=yes) Char(1)
5-5 Now in Daylight Savings(N=no, Y=yes) Char(1)
6-9 MCT Macro Field Date Format Char(4)

Update (Carrier Function)

This function updates a single Carrier record.

Note: Release 5.2 changes are highlighted in red.

XML Request

Definitions

  • null fields are the fields that are either omitted or initialized to a special value - string "NULL".
    • E.g., <Street>NULL<Street/> will be interpreted as a null field.
  • Empty string fields are, e.g., <Street /> or <Street></Street>

The Update function takes the following request parameters:

Parameter Type Optional Description
Name String Yes Carrier name, required in both old and new. New carrier name must be at least 4 characters.
Street String Yes Street segment of Carrier address
Street2 String Yes Street segment of Carrier address - line 2
City String Yes City segment of Carrier address
State String Yes State segment of Carrier address
Postal String Yes Postal code segment of Carrier address
MiscInfo String Yes Additional information. This can be used to match the corresponding company's office information field
USDotNumber String Yes Identifying number issued by DOT
  • oldCarrier record is found based on Name specified in oldCarrier and on NMCAccount derived from the user login credentials.
  • Only oldCarrier/Name field is used. Any other oldCarrier fields are ignored.
  • Name is a required filed in both oldCarrier and newCarrier. It may not be either an empty string or null.
  • Name must be unique for a given customer. If this constraint is violated, SOAP fault "System.Web.Services.Protocols.SoapException: Record already exists." will result.
    
<?xml version="1.0" encoding="utf-8"?>    
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    
  <soap:Body>    
    <Update xmlns="http://www.omnitracs.com">    
      <oldCarrier>    
        <Name>string</Name>    
        <Street>string</Street>    
        <Street2>string</Street2>    
        <City>string</City>    
        <State>string</State>    
        <Postal>string</Postal>    
        <MiscInfo>string</MiscInfo>    
        <USDotNumber>string</USDotNumber>    
      </oldCarrier>    
      <newCarrier>    
        <Name>string</Name>    
        <Street>string</Street>    
        <Street2>string</Street2>    
        <City>string</City>    
        <State>string</State>    
        <Postal>string</Postal>    
        <MiscInfo>string</MiscInfo>    
        <USDotNumber>string</USDotNumber>    
      </newCarrier>    
    </Update>    
  </soap:Body>    
</soap:Envelope>

XML Response

The return result indicates success or failure via SOAP exceptions.

    
<?xml version="1.0" encoding="utf-8"?>    
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">    
  <soap:Body>    
    <UpdateResponse xmlns="http://www.omnitracs.com" />    
  </soap:Body>    
</soap:Envelope>

CFG300 Data Format (Statistics)

1-3 Total Vehicles Packed(5,0)
4-6 Total Users Packed(5,0)
7-9 Total Address Lists Packed(5,0)
10-12 Total Message Groups Packed(5,0)
13-15 Total Applications Packed(5,0)
16-16 Archive Deleted Messages (0=no, 1=yes) Char(1)
17-17 Display in Kilometers (0=no, 1=yes) Char(1)
18-18 Display in Liters (0=no, 1=yes) Char(1)
19-19 Display in Celsius (0=no, 1=yes) Char(1)
20-22 Total Auxiliary Vehicles Packed(5,0)
23-25 Total Auxiliary Accounts Packed(5,0)

CFG400 Data Format (Batch message transmission schedule)

1-168 Hourly Schedule for One Week
7 days/week x 24 hours/day = 168 hours/week
'X' = indicates a batch period (hour) 		Char(168)
169-169 Release Scheduled Messages
1 Use batch message schedule
2 When vehicle is "awake" 		Char(1)

CFG500 Data Format (Purge parameters) OBSOLETE

1-1 Auto Purge Switch (N=no, Y=yes) Char(1)
2-3 Days of Position History to Retain Packed(3,0)
4-5 Days of Messages to Retain Packed(3,0)
6-7 Purge Cycle Days Packed(3,0)
8-11 Purge Submit Time Packed(7,0)
12-13 Record Deletion% Goal Packed(3,0)

CFG501 Data Format (Purge parameters)

1-2 Days of Position History to Retain Packed(3,0)
3-4 Days of Driver Event History to Retain Packed(3,0)
5-6 Days of Messages to Retain Packed(3,0)
7-7 Archive Deleted Messages(0=no, 1=yes) Char(1)
8-15 Purge Days (0=disable, 1=enable)
7 days/week + 1 byte for 'end of month' 		Char(8)
16-19 Purge Submit Time Packed(7,0)
20-26 Last Purge Date Packed(13,0)
27-28 Days of State Miles Extract History to Retain (added v7.0) Packed(3,0)

CFG600 Data Format (Work with Vehicles external API function keys and options)

1-10 Work with Vehicles F15 Name Char(10)
11-20 Work with Vehicles F15 Module Char(10)
21-30 Work with Vehicles F16 Name Char(10)
31-40 Work with Vehicles F16 Module Char(10)
41-50 Work with Vehicles F19 Name Char(10)
51-60 Work with Vehicles F19 Module Char(10)
61-70 Work with Vehicles F20 Name Char(10)
71-80 Work with Vehicles F20 Module Char(10)
81-90 Work with Vehicles Option 10 Name Char(10)
91-100 Work with Vehicles Option 10 Module Char(10)
101-110 Work with Vehicles Option 11 Name Char(10)
111-120 Work with Vehicles Option 11 Module Char(10)
121-130 Work with Vehicles Option 12 Name Char(10)
131-140 Work with Vehicles Option 12 Module Char(10)
141-150 Work with Vehicles Option 13 Name Char(10)
151-160 Work with Vehicles Option 13 Module Char(10)

CFG700 Data Format (Vehicle detail external API function keys)

1-10 Vehicle Detail F15 Name Char(10)
11-20 Vehicle Detail F15 Module Char(10)
21-30 Vehicle Detail F16 Name Char(10)
31-40 Vehicle Detail F16 Module Char(10)
41-50 Vehicle Detail F19 Name Char(10)
51-60 Vehicle Detail F19 Module Char(10)
61-70 Vehicle Detail F20 Name Char(10)
71-80 Vehicle Detail F20 Module Char(10)

CFG800 Data Format (Work with Messages external API function keys and options)

1-10 Work with Messages F15 Name Char(10)
11-20 Work with Messages F15 Module Char(10)
21-30 Work with Messages F16 Name Char(10)
31-40 Work with Messages F16 Module Char(10)
41-50 Work with Messages F19 Name Char(10)
51-60 Work with Messages F19 Module Char(10)
61-70 Work with Messages F20 Name Char(10)
71-80 Work with Messages F20 Module Char(10)
81-90 Work with Messages Option 10 Name Char(10)
91-100 Work with Messages Option 10 Module Char(10)
101-110 Work with Messages Option 11 Name Char(10)
111-120 Work with Messages Option 11 Module Char(10)
121-130 Work with Messages Option 12 Name Char(10)
131-140 Work with Messages Option 12 Module Char(10)
141-150 Work with Messages Option 13 Name Char(10)
151-160 Work with Messages Option 13 Module Char(10)

CFG900 Data Format (Message detail external API function keys)

1-10 Message Detail F15 Name Char(10)
11-20 Message Detail F15 Module Char(10)
21-30 Message Detail F16 Name Char(10)
31-40 Message Detail F16 Module Char(10)
41-50 Message Detail F19 Name Char(10)
51-60 Message Detail F19 Module Char(10)
61-70 Message Detail F20 Name Char(10)
71-80 Message Detail F20 Module Char(10)
  1. Back to top
  • Was this article helpful?

Recommended articles

  1. Classifications
    This page has no classifications.
  2. Tags
    This page has no tags.