Business Process Automation
Equipment Agent Actions
This page is accessed via Business Process Automation > Agents and Milestones > Automation Agent.
If you select EQUIPMENT 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 - Equipment |
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 |
|
Elseif |
|
Endfor |
|
Endif |
|
Endlock |
|
Estimate Distance |
This is a utility agent action. See Estimate Distance. |
For |
|
For Each |
|
If |
|
Increment Bucket - Equipment |
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 - Equipment or Link Equipment 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. |
Link Equipment to Bucket |
Links an asset to a bucket. That is, it places a particular piece of equipment 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) |
Lock |
|
Log |
|
Log to Transmission Report |
This is a utility agent action. See Log to Transmission Report. |
Move Equipment to Location |
See the Move Asset to Location help topic. Parameters: From Location ID: Same as Source Location on the action. To Location ID: Same as Destination Location on the action. This field is required. From Bucket Type: Same as Source Bucket Name on the action. To Bucket Type: Same as Destination Bucket Name on the action. This field is required. |
Notify Contact |
This is a utility agent action. See Notify Contact. |
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. |
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 - Equipment |
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 |
|
Unlink Equipment from Bucket |
Unlinks an asset from a bucket. That is, it removes a particular piece of equipment from the specified bucket. It does not update any bucket counts. Only instance buckets are available. Parameters: Bucket Type (required) Location ID (required) |
Update from Event |
Updates the interchange receive location and date with the location and date on the tracking event. Copies the chassis initial/number from the event to the equipment. Sets the last out gate time/location to the date and location on the tracking event. Parameters: Set Interchange Receive Location: Updates the interchange receive location and date with the location and date on the tracking event. Copy Chassis Initial Number: Copies the chassis initial/number from the event to the equipment. Set Last Outgate Location: Sets the last out gate time/location to the date and location on the tracking event. |
Copies the values of the sighting location, railroad reporting SCAC, sighting event status code and the date to the previous sighting location, previous railroad reporting SCAC, previous sighting event status code and date fields. Then, it updates the sighting location, railroad reporting SCAC, sighting event status, loaded or empty, date, car destination location, and car destination ETA date with the information available on the tracking event. |
|
Wait |