Skip to main content
Omnitracs Knowledge Base

Forward Text Message - Type 601

Submitting a Forward Text Message (Type 601)

This transaction is used to request the transmission of a displayable message (a message containing text) to one or more vehicles and/or users. Both freeform text and macro messages are submitted using this transaction. The receipt of this transaction will cause QTRACS to place a call to OMCRTMSG. The parameter list will be constructed using values supplied in the transaction. Refer to the OMCRTMSG section of this document for additional information.

Forward text message transaction format

From To Size Type Field Name
1 5 9 Packed Local GMH
6 8 3 Character Transaction Type = 601
9 18 10 Character Sender
19 19 1 Character Reserved - set to blanks
20 21 3 Packed Reserved - set to zero
22 241 220 Character Destination List
242 243 3 Packed Times to Transmit
244 244 1 Character Priority
245 245 1 Character Schedule
246 246 1 Character Return Receipt
247 247 1 Character Word Wrap
248 257 10 Character Response Indicator
258 259 3 Packed Macro Number
260 261 3 Packed Macro Version Number
262 271 10 Character Application ID
272 278 7 Character Reserved - set to blanks
279 279 1 Character Body Type Indicator
280 282 5 Packed Message Body Length
283 4182 3900 Character Message Body


Forward text message transaction fields

Field Name Description
Local GMH This packed decimal field contains the Local GMH as assigned by the application requesting that this message be sent. Upon receipt of this transaction, QTRACS will assign a Global Message Handle. If requested, QTRACS will return that GMH to the external application defined in the Application ID field. QTRACS discards the Local GMH upon receipt.
Transaction Type This field must be set to 601.
Sender Source entity identifier. Denotes the source (sender) of the message. The source must be a simple entity: user, application or vehicle.
Destination List List of up to 20 destination entity identifiers (addressees). Each entry must be an ID of a valid user, vehicle, address list, vehicle group, or wildcard. Each entry is 11 characters long to allow for indirection (@) to be specified. The list is terminated by first blank entry. Note that to send to all users, all vehicles, or to the NMC there must be only one destination: *ALLVEH, *ALLUSR, or *NMC.
Times to Transmit Times to transmit. This field is passed through to the NMC. It is only used for components of the message that are transmitted over the OmniTRACS link. A zero value in this field will cause the NMC to transmit the message based on its internal defaults. This field should be set to zero unless there are very specific transmission requirements. Setting this field to a value other than zero may adversely affect the characteristics of the transmission priority.
Priority Message transmission priority. Valid values are:
  • 0 normal priority
  • 1 important priority
  • 2 sleepy priority
  • 3 sleepy plus priority
  • 4 low priority
  • 9 emergency priority
Schedule Schedule for off-peak (batch) transmission where:
  • 0 disable
  • 1 enable
Return Receipt Request a return receipt where:
  • 0 disable
  • 1 enable
Word Wrap Request text word wrapping where:
  • 0 disable
  • 1 enable (will wrap text on 38-character boundaries)
Response Indicator Determines how replies to this message will be routed. If the message is text (not binary), and the source of the message is a user or an application, and the destination includes one or more vehicles, then this field must be set to one of the following:
  • Entity Name replies routed to this 'U' or 'L' type entity
  • *PERSONAL replies routed to sender
  • *DISPATCH replies routed to coverage Otherwise, this field must be set to *NONE (or blanks). Also, *PERSONAL is only valid if the 'Sender' field is a user.
Macro Number If the message being submitted is a macro message, then this field must contain the macro number of the macro template for this message. Otherwise, the message is considered to be a freeform message, and this field should be set to zero.
Macro Version Number If the message being submitted is a macro message, then this field must contain the macro version number of the macro template for this message. Otherwise, the message is considered to be a freeform message, and this field should be set to zero.
Application ID If the calling application would like QTRACS to return the GMH for this message, then this field should contain the registered QTRACS external application ID to which the 692 transaction will be sent. See an explanation of the 692 transaction for more details. This is only necessary in a RI (remote integration) environment.
Body Type Indicator This field must be set to 'T' (text).
Message Length This is the length (in characters) of the message as it is stored in the Message Body field. The maximum length is 3900.
Message Body This variable-length field contains the body of the message in external (full field) format. External format is the same format that is expected by external applications when receiving messages through the transactional interface. The list of characters that may be included in a message body is contained in Appendix A. Also, see Appendix C for information regarding the expected external format of each type of field.
  • Was this article helpful?