Integrating Services Portal Data with Third-Party Applications

The Event Subscription Service (ESS) allows Transport + Deliver to use data from Omnitracs.

Create a Subscriber

Transport + Deliver, when set up to receive transactions, is a "subscriber."

To create a subscriber, specify an identifier that Transport + Deliver must supply to communicate with the ESS queue.

1. From any Services Portal page, click Administration, then click the Integration tab. The Subscribers page opens.
2. Click Create Subscriber.
3. Type a unique name to identify this subscriber. In most cases, choose the application name.
4. Under Subscriptions, select the checkbox next to each transaction type to which you want this application to subscribe.
5. Additional transaction types may appear under Cross Company Subscriptions. Select the checkbox next to each transaction type to which you want to subscribe.
6. Click Save.

Edit a Subscriber

You can change a subscriber's name and/or which transactions it subscribes to by following the steps below.

1. From any Services Portal page, click Administration, then click the Integration tab.
2. Click Transaction Subscriptions.
3. In the table, locate the subscriber to change and click its subscriber name.
4. Click Edit Subscriber.
5. Enter a new name, if desired.
6. Under Subscriptions, indicate which transactions to subscribe:
   • To subscribe to a transaction, select the corresponding checkbox.
   • To unsubscribe, clear the corresponding checkbox.
7. Click Save.

Check the ESS Queue Status

Omnitracs continuously publishes transactions to the ESS server. On the server, these transactions remain queued until Transport + Deliver has retrieved them.

If Transport + Deliver has not queried the ESS server for a long time, so many messages may accumulate that the queue is in danger of filling up. If this happens, ESS notifies an emergency contact you specify. If you receive this notification or have another reason to be concerned, you can check the queue status.

The Subscribers page lists the capacity of the queue, how full the queue is, and when a transaction was last dequeued.

1. From any Services Portal page, click Administration, then click the Integration tab. The Transaction Subscribers page opens.
2. In the table, locate the row for the subscriber whose queue you want to check.
   • Queue Depth displays the number of messages on the queue, its maximum size, and the percentage in use.
   • The Last Dequeue column lists the time Transport + Deliver last queried the queue for transactions.
   • The Feed Status column displays whether Transport + Deliver is enabled to receive transactions.
3. Click the link in Queue Depth to view more statistics. 

Create Macros

Macros are electronic forms that dispatchers and drivers can fill out. These “templates” save time and reduce errors.

You can create and edit macros that you will subscribe to; these are the transactions that Transport + Deliver will pull when connected.

See the Omnitracs guide for more information on creating macros. You can also watch a video.