Business Process Automation
Order Release Public Automation Agents
Oracle Transportation Management provides sample automation agents in the PUBLIC domain. It is recommended that all PUBLIC automation agents be deactivated upon installation. You can make copies of these PUBLIC automation agents in non-public domains. In these non-public domains, you can make changes to the sample automation agents so that they fit your business process.
Note: PUBLIC automation agents should never be deleted.
The following PUBLIC automation agents are available for the agent type of ORDER RELEASE.
Auto Sync Order to Trade Transaction
This agent synchronizes data from an order release to a trade transaction.
This automation agent is inactive by default.
Triggering Event & Event Restrictions
ORDER - LINE ADDED or REMOVED: INTEGRATION, INTERNAL or USER
ORDER - MODIFIED: INTEGRATION, INTERNAL or USER, ORDER LOCATION MODIFIED
ORDER - REMOVED: INTEGRATION, INTERNAL or USER
Saved Conditions
None
Actions
SYNC TRADE TRANSACTION
Fleet Order - Modify
This automation agent is similar to the Order Release - Modify automation agent but it can be used for Fleet multi-stop orders.
This automation agent is not active by default.
Triggering Event
ORDER - MODIFIED
Event Restriction: Source of the modification can only be INTEGRATION.
Saved Conditions
None
Actions
Agent actions depend on conditions of order releases and shipments. See next section for details.
Flow of the Automation Agent
Depending on the conditions of order releases/shipments that were created from the order, the automation agent takes one of the following order modification actions:
- If the order release is not on a shipment, then complete the following agent action:
- If the order release is on a shipment and the shipment is in transit (ENROUTE status anything except ENROUTE_NOT_STARTED), then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED) and the work invoice is undeletable (IF SHIPMENT HAS UNDELETEABLE WORK INVOICE), then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the work invoice is deletable (IF SHIPMENT HAS UNDELETEABLE WORK INVOICE) and the shipment has secured resources (SECURE RESOURCES is TENDERED, ACCEPTED, BOOKED, or PICKUP NOTIFICATION), then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the work invoice is deletable, the shipment does not have secured resources, and a driver is assigned to the shipment, then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the work invoice is deletable, the shipment does not have secured resources, a driver is NOT assigned to the shipment, and the order release is on an editable shipment, then complete the following agent action:
- Order Release - Mod - Edit Shipment
- When a special service is added or removed from the order release, order stop, ship unit, or order release line, the agent will modify the shipment accordingly, re-rate it, re-drive it, and re-validate the shipment.
- When a non-freight related (NFR) order stop is added or removed from the order, the change will be reflected on the shipment's stop list.
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the work invoice is deletable, the shipment does not have secured resources, a driver is NOT assigned to the shipment, and the order release is NOT on an editable shipment, then complete the following agent action:
Error Handler Actions
Raise internal event: ORDER - INTEGRATION UNSUCCESSFUL and don't persist (save) changes to the database.
Load Order Release to HD
This automation agent prepares an order release to be loaded to the Oracle Transportation Intelligence (TI) historical database (HD). This automation agent updates the order release status type of OR_HD_LOAD_STATUS with the value OR_READY_TO_LOAD whenever a shipment with an order release is tendered.
This automation agent is not active by default.
Triggering Event
ORDER ON SHIPMENT - TENDERED
Event Restrictions: None
Saved Conditions
None
Actions
SET INTERNAL STATUS: OR_READY_TO_LOAD
Order Release - Delete
This automation agent controls how Oracle Transportation Management processes order release deletions that are received through integration only.
This automation agent is not active by default.
Triggering Event
ORDER - REMOVED
Event Restrictions:
- Data source is INTEGRATION only.
- Before Persist check box is selected. This indicates that this automation agent will verify the order changes before saving the order release to the database.
Saved Conditions
None
Actions
Error Handler Actions
Raise internal event of ORDER - INTEGRATION UNSUCCESSFUL and don't persist (save) changes to the database.
Order Release - Insert
The ORDER RELEASE – INSERT automation agent defines the processes for inserting a new order release into Oracle Transportation Management via integration. It triggers as soon as a new order release is sent into Oracle Transportation Management via XML. The Release XML is used to send order release data into Oracle Transportation Management.
This automation agent is not active by default.
Triggering Event
ORDER - CREATED
Event Restrictions:
- Data source is INTEGRATION only.
- Before Persist check box is selected. This indicates that this agent will verify the order changes before saving the order release to the database.
Saved Conditions
None
Actions
Error Handler Actions
Don't persist (save) changes to the database.
Order Release - Modify
The ORDER RELEASE – MODIFY automation agent defines the processes for modifying an order release coming in to Oracle Transportation Management via integration. This automation agent deletes existing order releases and creates new ones as needed. t controls the processing of related records such as shipments.
If activated, it runs as soon as a request to modify an order release is sent to Oracle Transportation Management via the Release XML interface.
This automation agent is not active by default.
Triggering Event
ORDER - MODIFIED
Event Restrictions:
- Data source is INTEGRATION only.
- Before Persist check box is selected. This indicates that this agent will verify the order changes before saving the order release to the database.
Saved Conditions
None
Actions
Actions depend on conditions of order releases and shipments. See next section for details.
Flow of the Automation Agent
Depending on the conditions of order releases/shipments that were created from the order, the automation agent takes one of the following order modification actions:
- If the order release is not on a shipment, then complete the following agent action:
- If the order release is on a shipment and the shipment is in transit (ENROUTE status anything except ENROUTE_NOT_STARTED), then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED) and the order release is on an editable shipment, then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the order release is NOT on an editable shipment and the shipment has secured resources (SECURE RESOURCES is TENDERED, ACCEPTED, BOOKED, or PICKUP NOTIFICATION), then complete the following agent action:
- If the order release is on a shipment, the shipment is NOT in transit (ENROUTE status ENROUTE_NOT_STARTED), the order release is NOT on an editable shipment and the shipment does not have secured resources, then complete the following agent action:
Error Handler Actions
Raise internal event: ORDER - INTEGRATION UNSUCCESSFUL and don't persist (save) changes to the database.