ESS Transactions
The following table summarizes the supported transaction types and provides links to their respective XML structures (schemas):
• Return Messages From Owned Vehicles
Transaction Type
|
Name
|
Description
|
---|---|---|
Text Return Freeform Messages |
Generated whenever a freeform return message is received from an owned vehicle. Vehicles are said to be "owned" when the mobile device in the vehicle is associated with the Omnitracs NMC account of the company that is connecting to the NMC. A "foreign" vehicle is a vehicle whose information is being copied to the connected NMC account from a different account through the QMASS feature. |
|
Text Return Macro Messages (01 - 63) |
Generated whenever a macro return message is received from an owned vehicle. Sixty-three separate return transactions are published and available for independent subscription |
|
Binary Return Messages |
Conveys binary return messages sent from owned vehicles by "third-party applications" (not Trailer Tracks and not Performance Monitoring). |
• Forward Message Dispositions
Note that these messages are published via ESS only when the prior/referenced forward message:
- was sent to a vehicle, and
- was not sent via a broadcast message group, and
- originated from integration
Transaction Type
|
Name
|
Description
|
---|---|---|
All Forward Message Dispositions |
Generated whenever a prior forward text or binary message is received successfully or failed to be received by the mobile unit. |
|
Negative-only Forward Message Dispositions |
Generated whenever a prior forward text or binary message fails to be delivered for any reason. |
|
Forward Message Read Notifications |
Generated whenever a prior forward text messages is read by the driver (if return receipt was requested). |
• Message Copies to/from Auxiliary Vehicles
Transaction Type
|
Name
|
Description
|
---|---|---|
Routed Text Messages |
Generated whenever a routed (Q/BluMASS) text forward or return message is sent from/to a vehicle from another Omni account. Macro messages are expanded to freeform by the Omnitracs network operations center |
|
Routed Binary Messages |
Conveys binary message copies to/from auxiliary vehicles. They are published whenever a routed (QMASS/BluMASS) binary forward or return message is exchanged between an auxiliary vehicle its owner's account |
• Position Feeds
Transaction Type
|
Name
|
Description
|
---|---|---|
Vehicle Position Reports |
Generated whenever an updated position is received from a vehicle |
|
High Frequency Vehicle Position Reports |
Generated whenever an enhanced position (GIPR) is received from an MCP-equipped or IVG-equipped vehicle |
|
Trailer Position Reports |
Generated whenever an updated position is received from a trailer, or from the vehicle to which it is connected |
|
High Frequency Trailer Position Reports |
Generated whenever a high-volume position is received from an MCP/IVG-equipped vehicle connected to a trailer |
• Entity Definition Synchronization Notifications
Transaction Type
|
Name
|
Description
|
---|---|---|
Vehicle Definition Notifications |
Generated whenever a vehicle is created, deleted, renamed or has its UA changed |
|
Driver Definition Notifications |
Generated whenever a driver is created, deleted or renamed |
|
Trailer Definition Notifications |
Generated whenever a trailer is created, deleted, renamed or has its UA changed |
|
Macro Template Definition Notifications |
Generated whenever a macro message template definition initiated from any source has been acknowledged by the Omnitracs network operations center. |
• Trailer Tracking Events
Transaction Type
|
Name
|
Applies to TT100-equipped trailers
|
Applies to TTID-equipped trailers
|
Applies to TT150-equipped trailers
|
Applies to TT2x0-equipped trailers
|
Description
|
---|---|---|---|---|---|---|
Connect/Disconnect Notifications |
|
Generated whenever a Connect or Disconnect event, to or from an Omni-equipped vehicle, is received for a UTT-equipped or tethered trailer |
||||
Door Event Notifications |
|
|
|
Generated whenever a Door Open or Door Close event is received from a UTT-equipped trailer |
||
Auxiliary Sensor Event Notifications |
|
|
|
Generated whenever a Auxiliary (Sensor 4) Open or Auxiliary Close event is received from a UTT-equipped trailer |
||
Cargo Event Notifications |
|
|
|
Generated whenever a Cargo Loaded or Cargo Empty event is received from a UTT-equipped trailer |
||
Battery Event Notifications |
|
|
Generated whenever a Battery Needs Charged or Battery Needs Replaced event is received from a UTT-equipped trailer |
|||
Geofence Event Notifications |
|
|
|
Generated whenever a Geofence entry or exist event is received from a UTT-equipped trailer |
||
Status Reports |
|
|
Generated whenever a Status Report is received from a UTT-equipped trailer |
|||
Mobile Health Status Reports |
Generated whenever a "mobile unit error" for a UTT-equipped or tethered trailer is detected, or an error that was previously detected is cleared. |
|||||
Trailer Trip Reporting Events |
|
|
Generated whenever a trailer trip event is detected and received from a UTT-equipped trailer. |
|||
Trailer External Power Events |
|
|
Generated whenever an external power event is detected and received from a UTT-equipped trailer. |
|||
Reefer Trailer OEM Alarm Events |
|
|
|
Generated when a new OEM alarm condition is detected on properly equipped reefer trailers. |
||
Reefer Trailer Temperature Events |
|
|
|
Generated when a temperature out-of-range condition is detected and when the temperature out-of-range condition is cleared on properly equipped reefer trailers. |
||
Reefer Trailer Set Point Events |
|
|
|
Generated when a wrong temperature set point condition is detected and when the wrong temperature set point condition is cleared on properly equipped reefer trailers. |
||
Reefer Trailer Low Fuel Events |
|
|
|
Generated when a low fuel condition has been detected and when the low fuel condition is cleared on properly equipped reefer trailers. |
||
Tethered Reefer Status Reports |
|
|
Generated when a tethered reefer-equipped trailer returns its Reefer Status Report. |
|||
Data Sharing Disposition Notification |
|
|
Generated when a Data Sharing relationship is enabled/disabled. |
|||
Mileage Counter Exceeded Notification |
|
|
Generated when a TT210 device's mileage counter exceeds the configured threshold. The TT210 device must have supporting firmware. |
• Driver Events
Transaction Type
|
Name
|
Description
|
---|---|---|
Driver Login Event Notification |
Generated whenever a login event is received from a mobile device. It provides a mechanism to notify of driver logins, logouts, and security breach events. Notifications are only generated when the Global Login feature is enabled. |
• Mobile (On-Board) Events
Transaction Type
|
Name
|
Description
|
---|---|---|
Vehicle Control Event Notifications |
Generated whenever a vehicle command and control event subject to notification is detected on the vehicle. |
|
Critical Event Reporting Incident Notifications |
Generated whenever a critical event subject to notification is detected on the vehicle. |
|
Vehicle Diagnostics Event Notifications |
Generated whenever an on-board device reports monitoring or fault event information. |
|
Vehicle Diagnostics Parameter Information |
Generated whenever monitored on-board sensor and device parameter information is being reported. |
|
Vehicle Diagnostics Status Reports |
Generated whenever a vehicle reports status information through the Vehicle Maintenance application. |
|
Trailer ABS-Detected Connect / Disconnect Events |
Generated whenever a vehicle detects a connect/disconnect as reported from the attached trailer's Antilock Brake System. |
|
Exact Fuel Events |
Generated whenever a fuel-related event is returned from the vehicle. |
|
Trip Manager Return Data Messages |
Generated whenever the Trip Manager application publishes a workflow-like message in response to an event received from the vehicle. |
|
Terrestrial Browsing Alert |
Generated whenever a data volume cap threshold is exceeded. |
|
Trailer Tire Inflation Alert |
Generated whenever a TTIA-configured MCP has determined that a trailer tire airing alert should be returned to the host. |
|
Tire Pressure Monitoring Event |
Generated whenever a TPM-configured MCP has determined that a tire pressure monitoring event should be returned to the host. |
|
Critical Event Reporting Incident Update Notifications |
Generated whenever there is an update to an existing critical event. |
|
Critical Event Reporting Coaching Notification |
Generated whenever any changes to Driver Coaching information are made at the CER UI. |
• Performance Monitoring Events
Transaction Type
|
Name
|
Description
|
---|---|---|
Performance Data Extract Events |
Conveys driver performance extract information from the given vehicle enabled for Performance Monitoring. |
|
Fault Events |
Conveys J1708-based fault conditions detected for the given vehicle equipped for Performance Monitoring. |
• GeoServices Events
Transaction Type
|
Name
|
Description
|
---|---|---|
Geo-Spatial Events |
Generated whenever GeoServices detects that a geo-spatial event (e.g. arrival, departure) has occurred for a given asset. |
• Workflow Events
Transaction Type
|
Name
|
Description
|
---|---|---|
Workflow forward message disposition |
This transaction type is published whenever a workflow forward message is submitted for over the air transmission to a mobile unit. The transaction will indicate the success or failure disposition of the forward message submittal. |
|
Workflow message delivery notification |
This transaction type is published whenever a previously transmitted workflow forward message is received by a mobile unit. |
|
Workflow data message |
This transaction type is published whenever a return workflow data message is received from a mobile unit. |
|
Workflow unit change notification |
This transaction type is published whenever a Workflow unit change notification is generated as a result of a configuration change on a mobile unit. |
• Vehicle Inspection Report Events
Transaction Type
|
Name
|
Description
|
---|---|---|
VIR defect message |
This transaction type is published whenever a return VIR defect message is received from a mobile unit. |
|
VIR forward message disposition |
This transaction type is published whenever a VIR forward message is submitted for over the air transmission to a mobile unit. The transaction will indicate the success or failure disposition of the forward message submittal. |
|
VIR message delivery notification |
This transaction type is published whenever a previously transmitted VIR forward message is received by a mobile unit. |
• Media Manager Events
Transaction Type
|
Name
|
Description
|
---|---|---|
MMS File Disposition Notification |
This transaction is published by Media Manager to indicate the disposition of a prior file delivery request. These notifications are published on a per-vehicle basis whenever files are delivered, consumed, or deleted at the mobile. |