T2 Return Messages - Type 618
T2 Return Messages (Type 618)
T2 return messages are obtained by QTRACS as a result of periodic polling of the NMC by the Communications Manager process. Each of them is delivered to the appropriate external application via this T2 Return Message transaction. This transaction is used to propagate the data from a T2 Return Message (115/611) that has been received by QTRACS from the NMC.
T2 Return Message transactions are routed to the same application that is defined to receive the TrailerTRACS binary data type (007). If TrailerTRACS is not defined, then these transactions are not delivered to any external application.
T2 Return Message transaction format
From | To | Size | Type | Field Description |
1 | 5 | 9 | Packed | Global Message Handle |
6 | 8 | 3 | Character | Transaction Type = 618 |
9 | 18 | 10 | Numeric | Unified Address |
19 | 24 | 11 | Packed | GMN |
25 | 25 | 1 | Character | Message Priority |
26 | 29 | 5 | Character | Completion Reason Code (CRC) |
30 | 32 | 3 | Character | Extended Message Priority |
33 | 33 | 1 | Character | T2 Positioning Type |
34 | 37 | 8 | Packed | T2 Position Latitude |
38 | 41 | 8 | Packed | T2 Position Longitude |
42 | 48 | 13 | Packed | T2 Position Time |
49 | 49 | 1 | Character | Is this a copy? |
50 | 59 | 10 | Numeric | Auxiliary Owner ID |
60 | 90 | 31 | Character | Auxiliary Owner ID String |
91 | 97 | 13 | Packed | Message Creation Time |
98 | 104 | 13 | Packed | Message Transmission Time |
105 | 111 | 13 | Packed | Message Received Time |
112 | 114 | 3 | Character | Message Source |
115 | 134 | 20 | Character | Customer Equipment ID |
135 | 139 | 5 | Character | SCAC |
140 | 142 | 3 | Character | Message Sub-Subtype |
143 | 145 | 5 | Packed | Message Length |
146 | 2045 | 1900 | Variable | Message Text |
T2 Return Message transaction field descriptions
Field | Description |
Global Message Handle | Unique GMH for this return message that was assigned by QTRACS. |
Transaction Type | Always 618. |
Unified Address | Identifies the T2 associated with the data in this message. |
GMN | Contains the Global Message Number of the 115/611 packet that was assigned by the NMC. Future notifications made in reference to this message shall be linked using this number. |
Message Priority | Indicates the priority at which the message was sent. Possible values are: 0---Normal service 1-9---Reserved |
Completion Reason Code (CRC) | Contains the QTRACS CRC indicating the preliminary completion status of the operation. |
Extended Message Priority | An extension to the priority field. Possible values are: 0---Local message delivery 1---Send message with next scheduled message 2---Send message immediately 3---Send message immediately and stay awake (misuse indication) 4-255---ReservedFor alert messages, the extended message priority agrees with the parameter governing the alert generation (parameter 1055, Geofence Entry Alarm, and parameter 1056, Geofence Exit Alarm). For all other over-the-air return messages, the priority is 2 (sent immediately).For all local messages (e.g., local queries), the priority is 0. |
T2 Positioning Type | Indicates the type of positioning system used. Possible values are: 0-2---Reserved 3---GPS 4-9---Reserved |
T2 Position Latitude | T2 position latitude at the time of the event (if available). If the position at the time of the event is not available, the most recent T2 position available is used. This is the latitude after it has been converted by QTRACS into total signed seconds. |
T2 Position Longitude | T2 position longitude at the time of the event (if available). If the position at the time of the event is not available, the most recent T2 position available is used. This is the longitude after it has been converted by QTRACS into total signed seconds. |
T2 Position Time | Time of T2 position. Returned in GMT seconds. |
Is this a copy? | Indicates whether this is an original message sent from the T2 or a copy of the message. Possible values are: 0---Original 1---Copy |
Auxiliary Owner ID | Contains the Auxiliary ID of the customer account that owns the T2. |
Auxiliary Owner ID String | Contains the text included in routed return messages from the T2 to the auxiliary account. |
Message Creation Time | Time this message was generated. For return messages, this is the time that the message was generated at the mobile terminal (if available, otherwise the time of receipt over the air is used). For forward message responses (set/query), this is the time of the message request. When multiple forward requests are included in this response, the time reported is the time of the most recent forward message request. Returned in GMT seconds. |
Message Transmission Time | Time this message was transmitted. For return messages, this is the time that the over-the-air message was received by the NMC. For forward messages, this is the time that the message was acknowledged over the air. Returned in GMT seconds. |
Message Received Time | Time that QTRACS received the T2 return message. |
Message Source | Indicates the source of the message. Possible values are: 000---Unknown 001---Reserved 002---NMC 003---Reserved 004---T2 005-999---Reserved |
Customer Equipment ID | The Equipment ID (Trailer ID) as specified by the customer. This field contains the current or pending value of parameter 1019 so that QMASS recipients can identify the equipment by name. |
SCAC | The SCAC of the equipment (trailer). This field contains the current or pending value of parameter TBD so that QMASS recipients can identify the equipment by name. |
Message Sub-Subtype | Identifies the contents of the message text field. Possible values are: 000---T2 Report 001-999---Reserved for future expansionNote: If a T2 Return Message packet with a reserved number for Message Sub-subtype is received, the message should be acknowledged by the customer and its contents should be ignored. |
Message Length | Specifies the length of the Message Text field in characters. |
Message Text | Variable-length field that contains the text of the T2 return message field. It contains the 'Sub-subtype' data structure of information as defined by the CI specification. QTRACS/400 does not alter this data structure from the format defined in the CI specification. This data structure may contain fields that are not in QTRACS normal form (e.g. Timestamps will be in 'NMC format' as opposed to GMT seconds.) |
QTRACS Completion Reason Codes.
Message Reason |
Completion Reason Code | Return Message Description |
000 | 6920 | Scheduled T2 status report received |
001 | 6921 | T2 status report received due to on-board alert |
002 | 6922 | Solicited T2 status (ping) response received (currently no FWD GMN provided) |
003 | 6923 | T2 status report received due to terminal power state change |
004 | 6924 | T2 status report received due to (non-OTA) parameter change |
005 | 6925 | T2 status report received due to parameter change via field service tool (FST) |
006 | 6926 | T2 status report received due to required terminal initialization |
007 | 6927 | Received response to a T2 parameter query |
008 | 6928 | Received response to a T2 parameter change request |
009 | 6929 | Received a T2 report due to a superseded parameter query |
010 | 6930 | Received a T2 report due to a superseded parameter change request |