Order Base Agent Actions

Add Transactional Interest

This is a utility agent action. See Add Transactional Interest.

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.

Copy Flexfields To

This is a utility agent action. See Copy Flexfields To.

Copy Involved Parties from Order Base

This is a utility agent action. See Copy Involved Parties from <object>.

Copy Involved Parties to Order Base

This is a utility agent action. See Copy Involved Parties to <object>.

Copy Refnums from Order Base

This is a utility agent action. See Copy Refnums from <object>.

Copy Refnums to Order Base

This is a utility agent action. See Copy Refnums to <object>.

Copy Remarks from Order Base

This is a utility agent action. See Copy Remarks from <object>.

Copy Remarks to Order Base

This is a utility agent action. See Copy Remarks to <object>.

Determine Order Release Quantity Validation

This agent action determines and sets the quantity validation status on an order base's ship units.

Parameters:

Quality Validation Type: Source or Destination

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.

Endlock

This is a utility agent action. See Endlock.

Estimate Distance

This is a utility agent action. See Estimate Distance.

For

This is a utility agent action. See For.

For Each

This is a utility agent action. See For Each.

Generate Bills From Base

See Generate Bill or Generate Bills for Base.

Generate Refnum

This is a utility agent action. See Generate Refnum.

If

This is a utility agent action. See If.

If on Editable Shipment

For a given order base, this agent action checks the following to determine if the shipment is editable. Only if ALL conditions are true will this agent action also return a true (which means the shipment is editable). If any of these conditions return a false, then the shipment is not editable:

• Is the order base modification only a modification of quantities? If yes, return true. If no, return false.
• Does the order base only have one order release? If yes, return true. If no, return false.
• Is the order base auto-releasable? If no, return false. If yes, return true.
• Has the order been split? If yes, return false. If no, return true.
• Is the multi-stop shipment in any multi-leg or cross-dock/distribution scenario? If yes, return false. If no, return true.
• Is the order is split onto multiple pieces of equipment? If yes, return false. If no, return true.

Parameters:

The agent action parameters classify what changes are considered when determining if a shipment is editable.

• Allow Quantity Changes: Indicates that quantity changes are permissible to qualify shipments as editable. This option is selected by default.
• Allow Date Changes
• Allow Location Changes
• Allow All Other Changes

Note: Since the ORDER BASE - MOD - EDIT SHIPMENT agent action can only run if the shipment is editable, you should precede it with this agent action. Refer to the PUBLIC automation agent ORDER BASE - MODIFY for an example.

If Release Instruction Change Only

This agent action can only be used in conjunction with agent event ORDER BASE - MODIFIED. It will return true if the data changes triggering event ORDER BASE - MODIFIED are from the order base line item release instruction and the order base ship unit release instruction.

Link Order Base to Shipment

This agent action links an order base with a shipment (typically a shipment as work that was not planned from the original order) based on a specific ship unit line item reference number/qualifier.

This agent action should be used in conjunction with shipment and/or order creation/modification events that come into to Oracle Transportation Management via integration.

This agent action searches for shipment ship unit line item reference number qualifier defined in the Qualifier ID parameters. If Oracle Transportation Management finds a match, it uses the reference number and searches for a valid order base ID with the same value. If a matching order base ID is found, Oracle Transportation Management assigns the order base ID to the ship unit line item and populates the Order Base ID field on the Shipment Ship Unit Line Item Detail page.

The assumption based on which the search is conducted are:

• The order base contains potentially one or many order base line item records.
• The order base is released only once.
• When the order base is released, there are potentially many order release lines in equal number to the corresponding order base lines.
• One shipment will equate to one order base and conversely, one order base will equate to one shipment.
• These order release lines will match the ship unit lines of a shipment whose shipment ship unit line reference number value equals the order base ID and where the shipment ship unit line reference number qualifier  equals a  user-defined qualifier value.
• The values in order base line have been copied to the order release in the order release process.

Qualifier ID for order base link

Qualifier ID for order release line link

Copy quantity from order base to shipment unit line (updating existing ship unit line)

If this parameter is marked, Oracle Transportation Management copies the packaged item ID, item packaged count, weight (UOM) and volume (UOM) from the order release line to the shipment ship unit line based on the assumption that the values in order base line have been copied to order release during the releasing process. Order release lines are to be added to the corresponding matched shipment additively; i.e.,  a shipment ship unit line has been matched to an order release ID, then all lines on that order release are to be copied as additional lines to the shipment. This process does not overwrite or change the line that matched to the order base and order release in the first place.  

Create sibling shipment unit line

If the linked order release has additional lines that were not on the shipment, you can mark this check box to have Oracle Transportation Management copy those lines as new shipment ship unit lines.

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.

Notify Contact

This is a utility agent action. See Notify Contact.

Notify Involved Party

This is a utility agent action. See Notify Involved Party.

Order Base - Delete

This agent action deletes the order base if there are no order releases.

If order releases exist, this agent action does the following:

• Removes tender offers from shipments that were created from the order releases.
• Unassigns order releases.
• Deletes all order movements related to order releases that are released from this order base.
• Deletes the order release.
• Then, deletes order base.

Order Base - Insert

First, this agent action determines if the order base lines or order base ship units are auto-releaseable. If they are auto-releaseable, this agent action does the following:

• If the Shippable check box is selected, creates either order base line or ship unit release instructions for the full amount. Then, de-selects the Shippable check box.
• Updates the released count on the order base line or ship unit each time a release instruction is processed.

Note:  If the Shippable check box is selected, Oracle Transportation Management creates release instructions. If you are sending in release instructions, do not select the Shippable check box.

Parameters:

Build Buy Side Shipment: In order to build a buy side shipment, the order base must have a Processing Code of "PLN".

Build Sell Side Shipment: In order to build a sell side shipment, the order base must have a Processing Code of "PLN".

Order Base - Mod - Edit Shipment

This agent action updates the order base, re-releases, and updates existing shipments.

Note: Since this agent action can only run if the shipment is editable, you should precede this action with the IF ON EDITABLE SHIPMENT agent action. Refer to the PUBLIC automation agent ORDER BASE - MODIFY for an example.

If the shipment is editable, the agent action completes the following:

• Updates the order base and sets the status to ORDER BASE MODIFIED_MODIFIED.
• Re-releases the order release and sets the status to ORDER MODIFIED_MODIFIED.
• Replaces corresponding ship units.
• Re-calculates the shipment cost.  Note the equipment, rate offering, and the rate record remain the same for the shipment. If the Re-calculate Service Time parameter for this action is checked, then Oracle Transportation Management re-drives the shipment.
• If any checks fail during the re-drive, the shipment status is set to FEASIBILITY_INFEASIBLE, and one of the following infeasibility codes on the shipment is set based on what failed first: EQUIPMENT-INFEASIBLE, RATE_INFEASIBLE, or TIME_INFEASIBLE.
• Sets the status value for the impacted shipments: to SHIPMENT MODIFIED_MODIFIED.
• For buy shipments, sends out tender modified message to notify interested parties if the parameter is checked.
• For buy shipments, deletes all invoices that are auto-generated for the modified shipments and then re-generates them.  
• For sell shipments, deletes all the bills associated with the modified shipments, and then re-generates them. An invoice can be deleted if there are no other shipments matched to the invoice or if the voucher associated with the invoice has not been issued.

Parameters:

Recalculate Service Time: If checked, Oracle Transportation Management re-drives the shipment.

Modify Tender: If unchecked do not send out a modify tender for the shipments associated with the order base.

Releasing Types:

     Release Unprocessed Release Instructions: OTM will process the existing, unprocessed release instructions currently on the order base. If the Aggregate Lines check box is selected on your order configuration, the agent action will stop.

     Release Total Amount: To release the total ordered amount of the ship unit or line item. When the Aggregate Lines check box on the order configuration is selected, the agent action will only process if no lines are already released. If any lines are already released, the agent action stops.

Order Base - Mod - Full Impact

For all order releases and shipments related to the order base, the agent action perform the following:

• For sell shipment, deletes bills.
• For buy shipment, deletes or un-matches any shipment invoices. If the invoice is auto-generated, the agent deletes the invoice. If the agent fails to delete the invoice, it sets the invoice modification status to INVOICE MODIFIED_DENIED, and then un-matches the invoice. If the invoice is from integration, the agent un-matches the invoice from the shipment and sets the invoice status to MATCH_NOT_MATCHED.
• Withdraws tenders on all related shipments.
• Re-releases the order base and sets order base status to ORDER BASE MODIFIED_MODIFIED.
• Re-plans the order release and sets order release status to ORDER MODIFIED_MODIFIED.
• Optionally, builds either buy or sell shipments.

Parameters:

Build Buy Side Shipment: In order to build a buy side shipment, the order base must have a Processing Code of "PLN".

Build Sell Side Shipment: In order to build a sell side shipment, the order base must have a Processing Code of "PLN".

Exclude Orders In Executed State

Releasing Types:

     Release Unprocessed Release Instructions: OTM will process the existing, unprocessed release instructions currently on the order base. If the Aggregate Lines check box is selected on your order configuration, the agent action will stop.

     Release Total Amount: To release the total ordered amount of the ship unit or line item. When the Aggregate Lines check box on the order configuration is selected, the agent action will only process if no lines are already released. If any lines are already released, the agent action stops.

Parameter Set: To select a planning parameter.

Order Base - Mod - Future Processing

This agent action does the following:

1. Update the order base.
2. Set ORDER BASE MODIFIED status value to ORDER BASE MODIFIED_MODIFIED.
3. For the order releases, set ORDER MODIFIED status value to ORDER MODIFIED_BASE_MODIFIED.

Order Base - Mod - Incremental Release

For order bases with the is shippable flag set to N which means the order base has no shippable lines, the ORDER BASE – MOD – INCREMENTAL agent action does the following:

• Keeps existing order releases.
• Creates a new order release for the amount specified in the release instruction of the Transorder XML.

Note: All TransOrderLines in one TransOrder must have IsShippable set to the same value.

Note: The IsShippable flag for a particular TransOrderLine cannot differ from one update to another.

These restrictions exist because the ORDER BASE - MOD - INCREMENTAL RELEASE automation agent uses the IsShippable value in the database (previous TransOrder) and not the value in the new, modified TransOrder.

Order Base - Mod - No Processing

This agent action does the following:

• Discards order base modifications in the Transorder XML.
• Does not persist order base modifications to the database.
• Raises the OTM event ORDER BASE – INTEGRATION UNSUCCESSFUL.
• Sets the order release’s ORDER BASE MODIFIED status to ORDER BASE MODIFIED_DENIED.

Order Base - Mod - Re Release

For order bases with no order releases on shipments, this agent action completes the following:

• Delete the existing order releases.
• Update the order base.
• Set order base status of ORDER BASE MODIFIED to status value ORDER BASE MODIFIED_MODIFIED.
• Re-release the order.
• Set order release status of ORDER MODIFIED to status value ORDER MODIFIED_MODIFIED.

Parameters:

Build Buy Side Shipment

Build Sell Side Shipment

Releasing Types:

     Release Unprocessed Release Instructions: OTM will process the existing, unprocessed release instructions currently on the order base. If the Aggregate Lines check box is selected on your order configuration, the agent action will stop.

     Release Total Amount: To release the total ordered amount of the ship unit or line item. When the Aggregate Lines check box on the order configuration is selected, the agent action will only process if no lines are already released. If any lines are already released, the agent action stops.

Order Base - Mod - ReRoute

You can use this agent action for order modifications that will change the shipment routing while it is in transit. This agent action can re-build multi-leg shipments already in execution with an alternative itinerary.

This agent action does the following:

• Updates the order base with the Plan from Location ID and the Fixed Itinerary ID from the updated TransOrder.
• Updates the fields on the order base records.
• Keeps the existing order release record.
• Updates the itinerary and the Plan from Location fields.
• Selects all shipments built by that order base.
• Keeps all shipments before the Plan from Location.
• Deletes all of the shipments after the Plan from Location.
• Deletes any Shipment Event child records or Milestone Monitor records.
• Keeps the shipments with other types of child records.
• Builds shipments with the new itinerary, ignoring all legs that are before the Plan from Location.
• Ensure that all related shipments are linked.

If the Plan From location is at a handling shipment, Oracle Transportation Management needs to know whether to start at or after the handling shipment. You decide whether Oracle Transportation Management should remove the handling shipment or not with a property located in the Oracle Transportation Management properties file:

glog.planning.action.orderbase.rerouteShipments.startReplanAfterHandlingShipment =true

This agent action has the following limitations:

• One order release per order base.
• Shipments created from the order base do not have split/merge points.
• A fixed itinerary must be provided in the order base.
• The action does not create a new release; it only updates the source/destination locations in the release.

Order Priority Modify

This agent action takes in the mandatory value in the Order Priority field and sets the priority to that value for the object on which the agent got fired. An example may be as follows: you run an automated data query daily that polls for order releases/order movements whose early/late pickup date is past due. The output of this data query can then be applied thereby escalating the priority.

Parameter:

Order Priority

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.

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.

Reevaluate Auto Assign

This is a utility agent action.

Release Order Base

This agent action processes release instructions. Select one parameter to control how the release instructions are processed.

Parameters

Release Remaining Amount: The agent action will create additional release instructions to release whatever remains for the order base. (Remaining means the difference between the amount on the order base and the amount on its order releases). If the Aggregate Lines check box is selected on your order configuration, the agent action will stop.

Release Unprocessed Release Instructions: OTM will process the existing, unprocessed release instructions currently on the order base. If the Aggregate Lines check box is selected on your order configuration, the agent action will stop.

Release Total Amount: To release the total ordered amount of the ship unit or line item. When the Aggregate Lines check box on the order configuration is selected, the agent action will only process if no lines are already released. If any lines are already released, the agent action stops.

Remove Transactional Interest

This is a utility agent action. See Remove Transactional Interest.

Schedule Event

This is a utility agent action. See Schedule Event.

Send Integration

This is a utility agent action. See Send Integration.

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.

Un-Link Order Base to Shipment

The agent action removes the link and copied values (mentioned above) from the shipment ship unit line. The shipment ship unit line record itself is not removed.

To include the agent action into an agent, the automation agent should listen to the ORDER BASE - REMOVED agent event with the following restrictions set: Source of INTEGRATION and Before Persist check box selected.

Parameters:

Qualifier ID for order base link

Remove shipment unit lines

Unload Order Base from HD

This allows you to unload (soft delete) data from HD for data query type Order Base. This agent action is intended for use with Transportation Intelligence. This is similar to the Unload Object from HD available via power data.

This agent action inserts a record into the DEL_OBJ_FROM_HD table with the following values:

OBJ_GID = <OB GID>

OBJ_TYPE = 'OB'

This agent action must be configured with the Order Base - Removed agent event.

Update Link from Order Base to Shipment

Use this agent action in place of the order base modification actions to unlink an order base from a shipment so TransOrder modifications can be processed.

Parameters:

Qualifier ID for order base link

Qualifier ID for order release line link

Copy quantity from order base to shipment unit line

Create sibling shipment unit lines

Remove shipment unit lines

If an unlink was performed via the Unlink Order Base to Shipment agent action, mark this check box to remove sibling shipment ship unit lines that may have been added using the parameter mentioned above.

Update SKU Quantity - Order Base

Update SKU quantity record using the quantities in the order base. The default behavior of this agent action is to increment quantities for inbound transactions and decrement for outbound transactions. However for certain quantity types such as In Transit the opposite makes more sense. The Decrement Quantity for Inbound Transaction check box enables such reverse behavior.

Parameters:

Quantity Type (required)

Link Criteria (required)

Decrement Quantity for Inbound Transaction

Update Status for External Event

This is a utility agent action. See Update Status for External Event.

Wait

This is a utility agent action. See Wait.