Driver Agent Actions

This page is accessed via Business Process Automation > Agents and Milestones > Automation Agent.

If you select DRIVER in the Agent Type field and do not select anything in the Data Type Association field, the agent actions listed here are available.

To use agent actions from other agent types (business objects), select the appropriate data type association. By selecting a data type association, an automation agent of one agent type (business object) can run related agent actions of a different agent type (business object). For example, an automation agent with a shipment agent type can run agent actions available for the order release agent type. To do this, select a data type association of SHIPMENT TO ORDER RELEASE. See the actions topic for more details.

Action	Description
Ad Hoc Notify Contact	This is a utility agent action. See Ad Hoc Notify Contact.
Assign Variable	This is a utility agent action. See Assign Variable.
Call Service	This is a utility agent action. See Call Service.
Decrement Bucket - Driver	Decrements the bucket count. Only instance buckets are available. If the Auto Link check box on the Bucket Type is selected, the asset is also disassociated from the bucket, in addition to decrementing the bucket count. Parameters: Bucket Type (required) Location ID (required) Update Inventory at Parent Location Decrement By
Direct SQL Update	This is a utility agent action. See Direct SQL Update.
Dont Persist	This is a utility agent action. See Dont Persist.
Else	This is a utility agent action. See Else.
Elseif	This is a utility agent action. See Elseif.
Endfor	This is a utility agent action. See Endfor.
Endif	This is a utility agent action. See Endif.
Estimate Distance	This is a utility agent action. See Estimate Distance.
Endlock	This is a utility agent action. See Endlock.
For	This is a utility agent action. See For.
For Each	This is a utility agent action. See For Each.
Generate Refnum	This is a utility agent action. See Generate Refnum.
If	This is a utility agent action. See If.
Increment Bucket - Driver	Increments the bucket count. Only instance buckets are available. If the Auto Link check box on the Bucket Type is selected, the asset is also associated to the bucket, in addition to incrementing the bucket count. Parameters: Bucket Type (required) Location ID (required) Update Inventory at Parent Location Increment By (required) Association Date Agent Variable: Accepts any agent variable that returns a local date. For example you could have an Assign Variable as the first agent action; it has a saved query that returns last sighting date (or any other date for that matter) on the asset. The next action could be Increment Bucket - Driver or Link Driver to Bucket and it can use the agent variable defined above in the association date agent variable field. If this field is provided, the value returned will be used as association date. If not, and the agent event on which the agent is listening to happens to be a tracking event, the value of this event_date will be used. Otherwise if the agent is not a tracking event, the current local date is used.
Just Get the Driver Home	See the Just Get the Driver Home action. Can be performed against a single driver.
Link Driver to Bucket	Links an asset to a bucket. That is, it places a particular driver into the specified bucket. It does not update any bucket counts. If the bucket does not exist, it creates a new bucket. Only instance buckets are available. Parameters: Bucket Type (required) Location ID (required) Association Date Agent Variable
Lock	This is a utility agent action. See Lock.
Log	This is a utility agent action. See Log.
Log to Transmission Report	This is a utility agent action. See Log to Transmission Report.
Move Driver to Location	See the Move Asset to Location help topic. Parameters: From Location ID: Same as Source Location on the user interface action. To Location ID: Same as Destination Location on the user interface action. This field is required. From Bucket Type: Same as Source Bucket Name on the user interface action. To Bucket Type: Same as Destination Bucket Name on the user interface action. This field is required. Association Date Agent Variable
Notify Contact	This is a utility agent action. See Notify Contact.
Notify Involved Party	This is a utility agent action. See Notify Involved Party.
Persist	This is a utility agent action. See Persist.
Prepare Document	This is a utility agent action. See Prepare Document.
Prepare Report	This is a utility agent action. See Prepare Report.
Print Document	This is a utility agent action. See Print Document.
Process Pending Messages	Initiates processing the messages that are associated with the driver and have a status of PENDING. Also used to initiate processing pending messages when a device is associated with a driver.
Queue Event	This is a utility agent action. See Queue Event.
Raise Error	This is a utility agent action. See Raise Error.
Raise Event	This is a utility agent action. See Raise Event.
Raise Internal Event	This is a utility agent action. See Raise Internal Event.
Roll Back Sighting	See the Roll Back Sighting action.
Schedule Event	This is a utility agent action. See Schedule Event.
Send Integration	This is a utility agent action. See Send Integration.
Set Bucket Count - Driver	Overwrites the bucket's current count and set its value as indicated by the Bucket Count parameter. Parameters: Bucket Type (required) Location ID (required) Bucket Count: See details above. This field is required.
Set Indicator	This is a utility agent action. See Set Indicator.
Set Internal Status	This is a utility agent action. See Set Internal Status.
Set Status	This is a utility agent action. See Set Status.
Set User Defined Image	This is a utility agent action. See Set User Defined Image.
Stop	This is a utility agent action. See Stop.
Unlink Driver from Bucket	Unlinks an asset from a bucket. That is, it removes a particular driver from the specified bucket. It does not update any bucket counts. Only instance buckets are available. Parameters: Bucket Type (required) Location ID (required)
Update Calendar Event	Updates the calendar event table if the calendar event sequence number is provided as part of the driver event. If one is not provided or if a calendar event with that sequence number does not exist in the database a new record is inserted into the driver calendar event table. Parameters: Calendar Event Type ID Delete Calendar Event
Update Hours of Service State	Updates the hours of service state in the driver assignment tables. The associated UI action is NAT/NAL Override. The following information used by this agent action is obtained from a tracking event: NAL: obtained from the location GID, location reference number qualifier or the stop information. Ideally the NAL is the last stop of the shipment unless it needs to be overridden. NAT: Tracking Event time. Driver and the Driver intent can be provided in the Driver section of the tracking event. Driver Intent: Both on the UI action and the Tracking Event the You can choose to modify the Rule Begin Time and the Time Remaining against each rule. If you supply the shipment GID in the tracking event, the transaction is considered to be a Last Assigned Shipment NAT/NAL override, as per the NAT/NAL Override UI action. The shipment must be the latest shipment assigned to the driver. If it is not the latest shipment then an error is generated. If the shipment GID is not specified then it is considered a Manual NAT/NAL override.
Update Hours of Service Summary	Updates the hours of service summary for the driver.
Update Sighting	Copies the values of the sighting location and the date to the previous sighting and date fields. Then it updated the sighting location and date with the location and date on the tracking event.
Wait	This is a utility agent action. See Wait.

Driver Agent Actions

Related Topics