Shipment 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 SHIPMENT.

Auto Sync Shipment to Trade Transaction

This agent synchronizes data from a shipment to a trade transaction.

This automation agent is inactive by default.

Triggering Event & Event Restrictions

• SHIPMENT - MODIFIED: INTEGRATION, INTERNAL or USER, SHIPMENT LOCATION MODIFIED
• SHIPMENT - REMOVED: INTEGRATION, INTERNAL or USER
• SHIPMENT - SHIP UNIT LINE ADDED or REMOVED: INTEGRATION, INTERNAL or USER

Saved Conditions

None

Actions

SYNC TRADE TRANSACTION

Copy Master Booking Data

Sample agent for copying master booking data fields from the primary leg buy shipment to the primary leg sell shipment when one of the master booking data fields is modified. By default, these fields include:

• END_TIME
• PORT_OF_DIS_LOCATION_GID
• PORT_OF_DIS_OVERRIDE_LOC_GID
• PORT_OF_LOAD_LOCATION_GID
• PORT_OF_LOAD_OVERRIDE_LOC_GID
• START_TIME
• SAIL_DATE
• RAIL_DATE
• SAIL_CUTOFF_DATE
• PORT_DISCHARGE_ETA
• PORT_OF_EXIT_DATE
• PORT_EXIT_LOC_GID
• CONTAINER_PICKUP_LOC_GID
• CONTAINER_DELIVERY_LOC_GID
• VESSEL_GID
• VOYAGE_GID
• SOURCE_PIER_LOCATION_GID
• DEST_PIER_LOCATION_GID

This automation agent is not active by default.

Triggering Event

SHIPMENT - MASTER BOOKING CHANGED

Event Restrictions: Data source can be INTEGRATION or INTERNAL or USER.

Saved Conditions

This agent only runs if the SHIPMENT IS PRIMARY saved condition is true. The shipment must have the Primary check box selected.

Actions

COPY MASTER BOOKING DATA

Load Shipment to HD

This agent prepares a shipment to be loaded to the Oracle Transportation Intelligence (TI) historical database (HD). This agent updates the shipment status type of SHIPMENT_HD_LOAD_STATUS with the value SHIPMENT_READY_TO_LOAD whenever a shipment tender is sent.

This automation agent is not active by default.

Triggering Event

SHIPMENT TENDER - TENDERED

Event Restrictions: None

Saved Conditions

None

Actions

SET INTERNAL STATUS: SHIPMENT_READY_TO_LOAD

Raise Order on Shipment Events

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 Oracle Transportation Management events. In a way, it just forwards the event from the shipment side to the order release side.

This automation agent IS active by default.

Triggering Events

• SHIPMENT STATUS - BLOCKED
• SHIPMENT STATUS - COMPLETED
• SHIPMENT STATUS - DELAYED
• SHIPMENT STATUS - ENROUTE
• SHIPMENT STATUS - INFEASIBLE
• SHIPMENT STATUS - LATE
• SHIPMENT STATUS - LOADED
• SHIPMENT STATUS - RECEIVED

Event Restrictions: None

Saved Conditions

None

Actions

RAISE ORDER ON SHIPMENT EVENTS

Shipment Appointment Tracker

This automation agent updates appointment times on a shipment stop.

This automation agent is not active by default.

Triggering Event

SHIPMENT - APPOINTMENT SCHEDULED

Saved Conditions

None

Actions

RECALC STOP APPOINTMENT TIMES

Shipment as Work Creation

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, Oracle Transportation Management performs the following actions on the shipment:

• Assign Service Provider
• Secure Resources
• Generate Invoice
• Send Shipment Interface

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

This automation agent is not active by default.

Triggering Event

SHIPMENT - CREATED

Event Restrictions: Data source is only INTEGRATION.

Saved Conditions

This agent runs if the SHIPMENT AS WORK CONDITION saved condition is true. This condition is true if shipment_as_work is equal to 'Y' and the shipment perspective is 'B' for buy shipment.

Actions

1. ASSIGN SERVICE PROVIDER
2. SECURE RESOURCES
3. GENERATE INVOICE
4. SEND SHIPMENT INTERFACE: SHIPPER (to contacts with Involved Party Qualifier of SHIPPER)

Shipment as Work Modification

This automation 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.

This automation agent is not active by default.

Triggering Event

SHIPMENT - MODIFIED

Event Restrictions: Data source is only INTEGRATION.

Saved Conditions

This agent runs if the SHIPMENT AS WORK CONDITION saved condition is true. This condition is true if shipment_as_work is equal to 'Y' and the shipment perspective is 'B' for buy shipment.

Actions

1. ASSIGN RATE
2. SEND SHIPMENT INTERFACE: SHIPPER (to contacts with Involved Party Qualifier of SHIPPER)

Shipment Conditional Booking - Rerate and Redrive

This agent listens for conditional booking modified events and rerates and/or redrives the shipment and conditionally redrives downstream shipments and upstream shipments depending on location profile and shipment status. SHIPMENT - CONDITIONAL BOOKING MODIFIED is a parent event of SHIPMENT - CB VOYAGE MODIFIED and SHIPMENT - CB STOPS MODIFIED. The parent event can be raised separately or along with the child. This only gets triggered when changes are made by the conditional booking, not by shipment edits.

SHIPMENT - CONDITIONAL BOOKING MODIFIED is raised when any of a variety of fields are modified on Conditional Booking UI including location and date fields.

This agent action can change the voyage even if the Voyage Fixed check box on the shipment is selected. To avoid overriding a fixed voyage with an agent, you can add an IF statement: "If fixedVoyageFlagOnShipment is false Assign Voyage".

This automation agent is not active by default.

Triggering Event

SHIPMENT - CONDITIONAL BOOKING MODIFIED

Event Restrictions: Integration, Internal or User

Saved Conditions

None

Actions

See the topic Rerate and Redrive Action.

Shipment Conditional Spot Bid - Rerate and Redrive

This agent listens for conditional spot bid booking modified events and rerates and/or redrives the shipment and conditionally redrives downstream shipments and upstream shipments depending on location profile and shipment status. CONDITIONAL SPOT BID MODIFIED is a parent event of SHIPMENT - CONDITIONAL SPOT BID PICKUP MODIFIED, SHIPMENT - CONDITIONAL SPOT BID SRC LOC MODIFIED, SHIPMENT - CONDITIONAL SPOT BID DEST LOC MODIFIED, SHIPMENT - CONDITIONAL SPOT BID MODE MODIFIED, SHIPMENT - CONDITIONAL SPOT BID TRANSIT MODIFIED, and SHIPMENT - CONDITIONAL SPOT BID DROPOFF MODIFIED. The parent event can be raised separately or along with the child. This only gets triggered when changes are made by the conditional spot bid, not by shipment edits.

CONDITIONAL SPOT BID MODIFIED is raised when planner accepts the spot bid with conditional changes.

This automation agent is not active by default.

Triggering Event

CONDITIONAL SPOT BID MODIFIED

Event Restrictions: Integration, Internal or User

Saved Conditions

None

Actions

See the topic Rerate and Redrive Action.

Shipment Event Tracker

This automation agent is activated by shipment event groups and shipment events with matching shipment status codes. The automation agent only considers attributes in a shipment event group with the attribute IS_TRACKING = Y.

The automation 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 changes 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.

This automation agent is not active by default.

Note: If this agent needs to be triggered when a tracking event is entered, the tracking event agent action "Legacy Shipment Matching" needs to be used as it will publish the event "SHIPMENT STATUS - TRACKING" when a tracking event is successfully matched to a shipment.

Triggering Event

SHIPMENT STATUS - TRACKING

Saved Conditions

None

Shipment Modified Persist

Beginning in 6.3, this agent is used to enable shipment modifications via integration, even though it is set to inactive. You should either activate this agent or copy it to any domains where shipments will be modified via integration and activate it there.

Triggering Event

SHIPMENT - MODIFIED

Event Restrictions

Data source is INTEGRATION. "Before Persist" is checked.

Saved Conditions

None

Action

PERSIST

Shipment - Recalc Secondary Charge

This agent listens for the Shipment - Actual Modified event for shipments with one or more secondary charges and recalculates all secondary charges associated with the shipment.

This automation agent is not active by default.

Triggering Event

SHIPMENT - ACTUAL MODIFIED

Event Restrictions: Data source is INTEGRATION or INTERNAL or USER.

Saved Conditions

The SHIPMENT HAS SECONDARY CHARGE must be true. This is true if the original shipment ID is not null.

Actions

SHIPMENT - RECALC SECONDARY CHARGE

Update Capacity Allocation

The accounting of commitment usage for planned number of shipments will occur when shipment is created, deleted or modified due to the change of service provider and/or shipment start time. When a shipment is created, all contributing commitment usages (planned-num-of-shipment) will be increased; when a shipment is deleted, the existing contributing commitment usage (planned-num-of-shipment) will be decreased; when shipment is assigned to a new service provider, the new commitment usage will be increased, the old existing commitment usage will be decreased, except for one caseTender Decline. Agent action Update Actual Commitment and Allocation is the accounting of the final count for final commitment usages (such as final_num_of_shipment, final_weight, final_volume, final_mileage, etc). These fields are empty during the shipment planning status; When a shipment reaches certain status (configurable by the client) so that modifications to the shipment is not allowed any more, this agent action is triggered and thus the final usages are accounted.

This automation agent is not active by default.

Triggering Event

SHIPMENT - BILL BACK

Saved Conditions

None

Actions

UPDATE ACTUAL COMMITMENT AND ALLOCATION