If you have any questions or comments about this topic or the online help, please contact us.

agent_manager/public_agents.htm

Public Automation Agents

Order Base | Order Base Line Item | Order Base Ship Unit | Shipments | Shipment Group | Invoice | Bill | Location | SKU

Public automation agents can be used as delivered. You can turn them on or off (although some are delivered on by default) or, with Database Administrator access, modify them to meet the needs of your system. You can also use them as examples for constructing your own agents.

The following tables list public automation agents for each business object:

Order Base

Agent Name

Active Default

Agent Description

Order Base - Insert

On

This agent controls how OTM processes new orders that are received through integration. It listens for the Order Base - Created event for order bases created via integration only and performs the following action:

Order Base Mode Sample

Off

This agent is similar to the Order Base - Modify agent; however, it includes a saved condition that accounts for orders that have order releases and associated order movements. You should use or copy this modification agent if you are using order movements and further configure it with the appropriate Replan order release actions.

Order Base - Modify (activate either this agent or the Order Base - Modify-Incremental Release agent.)

 

This agent controls how OTM processes modifications to existing order bases received either through integration or via changes made through the user interface. It controls the processing of related records such as order releases and shipments that were created from the order base.

This agent listens to the Order Base Modified event. Depending on the conditions of order releases/shipments that were created from the order, the agent takes one of the following order modification actions:

If OTM has not released the order:

If OTM has released the order but not created a shipment yet :

If OTM has created a shipment for the order but that shipment's resources is not secured:

If OTM has created a shipment for the order and the shipment has secured resources (SECURE RESOURCES is TENDERED, ACCEPTED, BOOKED, or PICKUP NOTIFICATION) but the shipment is not in transit (status ENROUTE_NOT_STARTED):

If OTM has created a shipment for the order and the shipment has secured resources and is now in transit (ENROUTE status anything except ENROUTE_NOT_STARTED) :

Use this action when you want a modification to an order to cause a modification to a shipment. The following conditions qualify whether an order release is on an editable shipment:

  • Changes on order release will be limited to quantities and date changes, not location change. If its location change, agent will execute Full Impact action.

  • Order ship unit cannot be split into multiple shipment ship unit. One order ship unit  <-> one shipment ship unit.

  • Order release cannot be split into multiple pieces of equipments.

  • Edit Shipment action will handle multi-stop shipments, multi-leg shipments, x-dock and distributor route. However, it will not handle splitting order release.  The related shipments must be in a linear graph.  

Order Base - Modify-Incremental Release (activate either this agent or the Order Base - Modify agent.)

 

This agent controls how OTM processes modifications to existing order bases received either through integration or via changes made through the user interface.  It controls the processing of related records such as order releases and shipments that were created from the order base.

This agent listens to the Order Base Modified event. Depending on the conditions of order releases/shipments that were created from the order, the agent takes one of the following order modification actions:

 

If your TransOrderLine transaction has IsShippable set to N:

If your TransOrderLine transaction has IsShippable set to Y and OTM has not released the order:

If your TransOrderLine transaction has IsShippable set to Y and OTM has released the order but not created a shipment yet :

If your TransOrderLine transaction has IsShippable set to Y and OTM has created a shipment for the order but that shipment's resources is not secured:

If your TransOrderLine transaction has IsShippable set to Y and OTM has created a shipment for the order and the shipment has secured resources (SECURE RESOURCES is TENDERED, ACCEPTED, BOOKED, or PICKUP NOTIFICATION) but the shipment is not in transit (status ENROUTE_NOT_STARTED):

If your TransOrderLine transaction has IsShippable set to Y and OTM has created a shipment for the order and the shipment has secured resources and is now in transit (ENROUTE status anything except ENROUTE_NOT_STARTED) :

Order Base - Delete

On

This agent controls how OTM processes order base deletions that are received through integration or the user interface. The agent listens to the Order Base Remove event via integration only and performs the following action:

Credit Release

Off

This agent listens for the custom event Order Base - Credit Release  that is triggered from the Location - Status Changed event. For example:

  • If the external status of an order base is CREDIT APPROVAL_APPROVED, and the status of the Location Bill To Involved Party for the order is changed to CREDIT LEVEL_HELD, then the status of any affected order is changed to CREDIT APPROVAL_HELD.

  • If the external status of an order base is CREDIT APPROVAL_HELD, and the status of the Location Bill To Involved Party for the order is changed to CREDIT LEVEL_APPROVED, then the status of any affected order is changed to CREDIT APPROVAL_APPROVED.

Credit Update

Off

This agent listens for the Order Base - Created or Order Base - Modified  events on any order base using an external status for credit check and initiates status update actions accordingly.

For example, if an order base status is changed to CREDIT APPROVAL_HELD with a Location Involved Party Bill To status of CREDIT LEVEL_APPROVED, then the order base status is set to CREDIT APPROVAL_APPROVED. Conversely, if an order base status is changed to CREDIT APPROVAL_APPROVED with a Location Involved Party Bill To status of CREDIT LEVEL_HELD, then the order base status is set to CREDIT APPROVAL_HELD. The credit check status of the Location Bill To Involved Party overrides the status of any order bases associated with that location (except when the order base is assigned a status of CREDIT APPROVAL - DECLINED, meaning the order won't release).

Order Base Line Item

Agent Name

Default Active State

Agent Description

Line Releasing Status

On

This agent listens for the Order Base Line Item Modified event and then sets the appropriate status based on the comparison of the ordered and released quantity of the line item.

 

Order Base Ship Unit

Agent Name

Active Default

Agent Description

Ship Unit Releasing Status

On

This agent listens for the Order Base Ship Unit Modified event and then sets the appropriate status based on the comparison of the ordered and released quantity of the ship unit.

 

Order Release

Agent Name

Active Default

Agent Description

Order Release - Insert

On

This agent controls how OTM processes new orders that are received through integration. It listens for the Order Base - Created event for order bases created via integration only and performs the following action:

Order Release Mod Sample

Off

This agent is similar to the Order Release - Modify agent; however, it includes a saved condition that accounts for order releases that associated order movements. You should use or copy this modification agent if you are using order movements and further configure it with the appropriate Replan order release actions.

Order Release  - Modify

On

This agent controls how OTM processes modifications to existing order releases received through integration or the user interface. It controls the processing of related records such as shipment.

This agent listens to the Order Release Modified event. Depending on the conditions of order releases/shipments that were created from the order, the agent takes one of the following order modification actions:

 

If OTM has not released the order:

If OTM has released the order but not created a shipment yet :

If OTM has created a shipment for the order but that shipment's resources is not secured:

If OTM has created a shipment for the order and the shipment has secured resources (SECURE RESOURCES is TENDERED, ACCEPTED, BOOKED, or PICKUP NOTIFICATION) but the shipment is not in transit (status ENROUTE_NOT_STARTED):

If OTM has created a shipment for the order and the shipment has secured resources and is now in transit (ENROUTE status anything except ENROUTE_NOT_STARTED) :

Use this action when you want a modification to an order to cause a modification to a shipment:

Order Base - Delete

On

This agent controls how OTM processes order release deletions that are received through integration or the user interface. The agent listens to the Order Release Remove event via integration only and performs the following action:

Shipment

Agent Name

 Active Default

Agent Description

Shipment as Work

Off

This agent listens for SHIPMENT - CREATED and SHIPMENT - MODIFIED events and looks for new shipments that have the condition where the Shipment as Work flag is set. If any shipment satisfies these events and conditions, OTM performs the following actions on the shipment:

  • The Shipment - Created event is sourced via integration or the user interface whereas the Shipment - Modified event is strictly for shipments entering OTM through XML integration.

Shipment as Work Creation

Off

This agent listens for Shipment Created event and looks for new shipments that have the condition where the Shipment as Work flag is set. If a shipment as work is detected, OTM performs the following actions on the shipment:

If you decide to use this agent as is, you need to configure external systems and Involved Party's if you want the last action to function properly.

  • By default, this agent is configured to function for both the User and Integration sources.

Shipment as Work Modification

Off

This agent listens for the Shipment Modified event via integration (only) and looks for new shipments that have the condition where the Shipment as Work flag is set. If shipment modifications are detected, OTM performs the following actions on the modified shipment:

BOL Shipment Mod by Integration

On

This agent controls how OTM processes shipment actuals that are received through integration for shipments with SECURE RESOURCES_ACCEPTED, SECURE RESOURCES_BOL, SECURE RESOURCES_PICKUP NOTIFICATION status.

BOL Shipment Mod by User

On

This agent controls how OTM processes shipment actuals recorded using the Shipment Manager for shipments with SECURE RESOURCES_ACCEPTED, SECURE RESOURCES_BOL, SECURE RESOURCES_PICKUP NOTIFICATION status.

BOL Accept Planned Estimate

On

This agent controls how OTM sets the status of a shipment when you accept the planned shipping data for a bill of lading.  For example, to prepare a bill of lading for any shipment, you must enter shipment actual data that represents exactly what is loaded for transportation. When you choose the Shipment Actuals menu option (in Shipment Manager) and find the shipment that you want, OTM presents the planned line item or ship unit data. If you accept the information as is, OTM triggers this agent which assigns the BOL_ACTUALS_PLANNED_ESTIMATES and BOL_PRINT_IS_PRINTABLE statuses to the shipment.

Shipment - Recalc Secondary Charge

On

This agent listens for the Shipment - Actual Modified, Shipment - Location Modified), and Shipment - Quantities Modified events, for shipments with one or more secondary charges, and recalculates all secondary charges associated with the shipment.

Rail SAW BOL Status

On

This agent changes the status of rail shipments as work (SAWs) to indicate that their shipment actuals have been entered, enabling the shipments to be tendered. Shipment actuals are assumed to be entered when rail SAWs are created.

This agent works as follows: when a new SAW with a Transport Mode of RAIL arrives and the Shipment - Created event occurs, this agent updates the BOL_ACTUALS status value of the shipment to BOL_ACTUALS_ENTERED_TRANSMISSION. The agent then publishes a Shipment - Status Changed event to trigger the Rail Tender agent (see below).

Rail Tender

On

This agent tenders rail shipments. The agent first checks that the Transport Mode of the shipment is RAIL and that the shipment is tenderable (that is, it is not the second leg of a Rule 11 shipment). Then the agent listens for the Shipment - Status Changed event. When the BOL_ACTUALS status changes to BOL_ACTUALS_ENTERED_TRANSMISSION, BOL_ACTUALS_ENTERED_MANUAL, or BOL_ACTUALS_PLANNED_ESTIMATES, the agent tenders the shipment.

  • The second legs of Rule 11 rail shipments cannot be tendered, even if shipment actuals have been entered for them. Nontenderable Rule 11 shipments are specified by selecting SETTLEMENT ONLY, NO TENDER as the Rule 11 Instruction in the itinerary or shipment.

Raise Order On Shipment Events

On

This agent initiates the action for order releases on a shipment that are affected by a delay. For example, if a delayed event is received for stop 2, then involved parties for stop 2, 3, 4,...  are notified that their orders have been delayed. It also listens for a number of SHIPMENT STATUS - xxx OTM events. In a way, it just forwards the event from the shipment side to the order release side.

Shipment Event Tracker

On

This agent tracks shipment events in the same way as was previously hard-coded. This agent is activated by shipment event groups and shipment events with matching shipment status codes. The agent only considers attributes in a shipment event group with the attribute IS_TRACKING = Y.

The agent  is responsible for:

  • Setting appropriate internal statuses for the shipment

  • Raising appropriate Shipment Status - Received events. Examples of Shipment Status - Received events are Shipment Status - Completed and Shipment Status - Enroute.

Potential customizations to this agent are: defining the shipment as completed when shipments arrive at their last stop instead of when they depart their last stop, set your own custom events and statuses and trigger separate agents for specific status codes.

Update Capacity Allocation

Off

This agent listens for SHIPMENT BILL BACK and performs the Agent Action UPDATE ACTUAL COMMITMENT AND ALLOCATION. When the SHIPMENT-BILL BACK event is raised, OTM performs the Agent Action UPDATE ACTUAL COMMITMENT AND ALLOCATION.

Copy Master Booking Data

Off

This agent detects changes in the master booking data for a buy shipment and copies the changed data to its related sell shipment. There is a corresponding agent for sell shipments. A saved condition also filters only Primary shipments since the action will only copy between primary shipments.

Shipment Group

Agent Name

 Active Default

Agent Description

Shipment Group - Recalc Secondary Charge

On

This agent listens for the Shipment Group - Shipment List Modified event on shipment groups with one or more secondary charges and recreates all secondary charges associated with the shipment group.

Shipment Group Event Tracker

Off

Activate this agent if you want to track shipment group events.

This agent listens for the Shipment Group Status - Received event. The agent only considers attributes in a shipment event group with the attribute IS_TRACKING = Y.

Compare this agent to the agent.

This agent replaces the now obsolete Shipment Group Status Router agent. The Shipment Group Event Tracker agent raises the same events as the Shipment Group Status Router agent did.

Invoice

Agent Name

Active Default

Agent Description

Invoice - Post Insert

On

This agent listens for the Invoice - Created event for any invoice that is imported via integration and proceeds to automatically match the invoice to a shipment as well as approve it.

Invoice - Post Approval  

On

This agent listens for an invoice status change of approved, and then raises the SHIPMENT BILL BACK event for each shipment. When the invoice status changes to APPROVED_AUTO or APPROVED_MANUAL, the event SHIPMENT-BILL BACK is raised.

 

Bill

Agent Name

Active Default

Agent Description

Issue Parent Bill

On

This agent listens for a status change to ISSUED_ISSUED in a parent bill, and then triggers the CHILD BILL EVENT for each of its child bills.

This agent should include a saved condition that specifies the financial consolidation type of PARENT or STANDARD.

Issue Child Bill

On

This agent listens for the CHILD BILL EVENT in a child bill, and then changes the child bill's status to ISSUED_ISSUED.

 

Location

Agent Name

Active Default

Agent Description

Credit Check - Location Status Changed

Off

This agent listens for the Location - Status Changed event on any location that has an external status of CREDIT LEVEL_HELD or CREDIT LEVEL_APPROVED assigned to it. If the location status is changed, any order bases using the Bill To Involved Party for that location are affected, raising the Order Base - Credit Release custom event and activating the Credit Release agent.

SKU

Agent Name

Active Default

Agent Description

SKU- Quantity OnHand Monitor

On

This agent triggers any time a SKU is created or the quantity on hand is changed (via integration). It then uses saved conditions to determine whether the status is above max level or below minimum level or OK and sets the SKU level status accordingly. It also checks if the quantity is below reorder level or not and again sets the SKU reorder status accordingly.