Oracle Shipping Execution

Overview of Oracle Transportation Management Integration with Oracle Shipping Execution

The integration of Oracle Transportation Management with Oracle Shipping Execution includes reference data synchronization, release transactions, planned shipment transactions, and actual shipment transactions. All of these transactions enable Oracle E-Business Suite to send and receive information to and from Oracle Transportation Management.

The following figures display the integration of Oracle Transportation Management with Oracle Shipping Execution, including trip creation, ship confirm, order interface, and inventory interface. You can integrate Oracle Shipping Execution with Oracle Transportation Management using either delivery based integration or batch based integration.

Transaction Cycle Between Oracle Shipping Execution and Oracle Transportation Management (Delivery Based Integration)

the picture is described in the document text

The figure displays the following steps to illustrate how deliveries are marked for internal processing:

  1. Delivery creation: When a delivery with contents is created as Include for Planning, it is marked as Creation Required.

  2. Shipping-Transportation Outbound Interface concurrent request runs with the appropriate interface action parameter (Create or All Except Actual Shipment) and the interface basis parameter of delivery. The concurrent request selects the creation-required deliveries and sends them to Oracle Transportation Management using the OTM XML release transaction. Order Releases are updated in Oracle Transportation Management based on these transactions.

  3. Transportation planning activities then take place in Oracle Transportation Management for the new order releases, including carrier selection, rating, tendering, and so on, which results in the creation of shipments (equivalent to trips in Oracle Shipping Execution) to which the order releases are assigned.

  4. After the shipment is created, and the tender is accepted, an automation agent can be activated in Oracle Transportation Management to trigger the PlannedShipment interface to an external system (BPEL) and sets its status in Oracle Transportation Management to SENT TO EBS_SENT. Default automation agents are delivered inactive in the E-Business Suite (EBS) domain and must be reviewed and copied into the operational domain. An external system must also be defined for each outbound flow from Oracle Transportation Management. (Step by step instructions for this setup are available in OTM > Help > How To > EBS to OTM). This interface is used to transmit the shipments from Oracle Transportation Management to Oracle Shipping Execution to create the corresponding trips and trip stops and to assign the deliveries to them.

  5. If the delivery is updated with changes that are relevant to transportation planning decisions (for example, change in delivery details weight), then the delivery is marked as Update Required.

  6. The next run of the Shipping-Transportation Outbound Interface concurrent request with the appropriate interface action parameter (Update or All Except ActualShipment) selects the update-required deliveries and sends them to Oracle Transportation Management using the OTM XML release transaction. Order Releases are updated in Oracle Transportation Management based on theses transactions.

  7. Update to order releases might provoke changes in the routing decision and therefore change in the shipments configuration. Based on Oracle Transportation Management Automation agents, these changes trigger the PlannedShipment interface to update the corresponding trips in Oracle Shipping Execution.

  8. Eventually, once deliveries of a trip are ship confirmed and all pick up stops of this trip are closed in Shipping Execution, the last pick up stop is marked as ActualShipment Required.

  9. The next run of the Shipping-Transportation Outbound Interface concurrent request with the appropriate interface action parameter (ActualShipment) selects the ActualShipment Required stops and sends their corresponding details to Oracle Transportation Management using the OTM XML ActualShipment transaction. Shipments and order releases are updated in Oracle Transportation Management based on these transactions (actual shipped quantities, vehicle information, and so on).

Transaction Cycle Between Oracle Shipping Execution and Oracle Transportation Management (Batch Based Integration)

the picture is described in the document text

The figure displays the following steps to illustrate how deliveries are marked for internal processing:

  1. Delivery line is created. When a delivery line is created it is marked as Include for Planning,

  2. Delivery creation: During batch integration, deliveries can be created before the batch is created or deliveries can be created by the Planned Shipment Interface concurrent program after the batch is created and has been sent to Oracle Transportation Management.

  3. Batch creation: When a batch with contents is created by the Create Batches for Transportation Planning concurrent program, it is marked as Creation Required.

  4. Shipping-Transportation Outbound Interface concurrent request runs with the appropriate interface action parameter (Create or All Except Actual Shipment) and the interface basis parameter of batch. The concurrent request selects the delivery lines associated to the creation-required batch and sends them to Oracle Transportation Management using the OTM XML release transaction. Order Releases are updated in Oracle Transportation Management based on these transactions.

  5. Transportation planning activities then take place in Oracle Transportation Management for the new order releases, including carrier selection, rating, tendering, and so on, which results in the creation of shipments (equivalent to trips in Oracle Shipping Execution) to which the order releases are assigned.

  6. After the shipment is created, and the tender is accepted, an automation agent can be activated in Oracle Transportation Management to trigger the PlannedShipment interface to an external system (BPEL) and sets its status in Oracle Transportation Management to SENT TO EBS_SENT. Default automation agents are delivered inactive in the E-Business Suite (EBS) domain and must be reviewed and copied into the operational domain. An external system must also be defined for each outbound flow from Oracle Transportation Management. (Step by step instructions for this setup are available in OTM > Help > How To > EBS to OTM). This interface is used to transmit the shipments from Oracle Transportation Management to Oracle Shipping Execution to create the corresponding trips and trip stops and to assign or create the deliveries to them.

  7. If the delivery is updated with changes that are relevant to transportation planning decisions (for example, change in delivery details weight), then the batch is marked as Update Required.

  8. The next run of the Shipping-Transportation Outbound Interface concurrent request with the appropriate interface action parameter (Update or All Except ActualShipment) selects the update-required batches and sends them to Oracle Transportation Management using the OTM XML release transaction. Order Releases are updated in Oracle Transportation Management based on theses transactions.

  9. Update to order releases might provoke changes in the routing decision and therefore change in the shipments configuration. Based on Oracle Transportation Management Automation agents, these changes trigger the PlannedShipment interface to update the corresponding trips and update the delivery if required in Oracle Shipping Execution.

  10. Eventually, once deliveries of a trip are ship confirmed and all pick up stops of this trip are closed in Shipping Execution, the last pick up stop is marked as ActualShipment Required.

  11. The next run of the Shipping-Transportation Outbound Interface concurrent request with the appropriate interface action parameter (ActualShipment) selects the ActualShipment Required stops and sends their corresponding details to Oracle Transportation Management using the OTM XML ActualShipment transaction. Shipments and order releases are updated in Oracle Transportation Management based on these transactions (actual shipped quantities, vehicle information, and so on).

Ignore for Planning Trips and Deliveries

To allow “out of the cycle” expedited shipments, you create a delivery and set the status to Ignore for Planning, or set the status of an existing delivery to Ignore for Planning (for example, by unassigning the delivery from the Oracle Transportation Management issued trip).

Deliveries set to Ignore for Planning are not sent to Oracle Transportation Management for planning activities.

You can then create Ignore for Planning trips, assign deliveries to them, and ship confirm. After the pickup stops are closed, the deliveries are marked as Actual Shipment Required and are sent to Oracle Transportation Management through the next run of the Shipping-Transportation Outbound Interface concurrent program.

Visibility on Interface Activities Through Shipping Exceptions

For each interface operations (required or executed) shipping exceptions are logged against the delivery or the batch. For example, when a delivery is created in Shipping Execution, WSH_OTM_DEL_CREATE_REQ is logged, indicating that creation is required in Oracle Transportation Management. After the Shipping-Transportation Outbound Interface concurrent process has processed this delivery, the WSH_OTM_DEL_AWAITING_TRIP is logged against the delivery, indicating that the transaction has been transmitted and the delivery is now awaiting a planned trip from Oracle Transportation Management; however, interface processes are driven by delivery level and stops level interface flags, which are not visible to the user. Equivalent batch exception messages are logged when performing the same process above using the batch basis integration with Oracle Transportation Management.

Changes for Allowed Actions and Updates to Shipping Entities

Delivery Splitting

Oracle Transportation Management includes algorithms that split large deliveries across multiple parallel shipments or assign multiple equipments to the same trip. To avoid this, the integration avoids sending large deliveries to Oracle Transportation Management. Instead, integration:

  1. Splits delivery lines with a net weight exceeding a defined net weight limit, ensuring that once packed, the delivery does not exceed the gross weight limit. This split is performed at delivery line import from Order Management or other sources.

  2. Splits deliveries that exceed a defined gross weight limit. This split is performed during the Shipping-Transportation Outbound interface concurrent request on deliveries sent to the interface for creation or update.

Both weight limits are part of the shipping parameter setup.

Note: Delivery splitting functionality is not supported when integrating with Oracle Transportation Managements using the batch based integration functionality (WSH: Delivery Based OTM Integration profile option is set to No).

Enabling Organizations

Oracle Transportation Management integration can be enabled at the organization level by selecting the Transportation enabled check box on the Shipping Parameters window. Note the following behavior differences:

Reference Data Integration

Certain data must be synchronized between the two systems using one of the following three methods:

Note: You must define item weights and volumes as well as item container weights, volumes, and dimensions in the Oracle E-Business Suite. The accuracy of Oracle Transportation Management planning is decreased if these attributes are not properly defined.

XML Messages

The following XML messages are used to pass order information to and from Oracle Transportation Management:

Related Topics

Oracle Shipping Execution XML Mapping

Functional Changes with Oracle Transportation Management Installed

Delivery Splitting

Delivery splitting occurs after a delivery has been created in Oracle Shipping Execution and before the delivery information is sent to Oracle Transportation Management, whenever a delivery gross weight exceeds the Gross Weight Limit.

Note: Delivery splitting functionality is not supported when integrating with Oracle Transportation Managements using the batch based integration functionality (WSH: Delivery Based OTM Integration profile option is set to No).

Delivery Splitting does not occur when delivery lines are packed, even if the packed line exceeds the weight limit. You must manually unpack and split these lines before sending to Oracle Transportation Management.

Delivery Splitting Example Max Gross Weight limit is set at 20 LBS:
Delivery Name (Before Split) Weight (Before Split)
DL4451 35 LBS
Delivery Name (After Split) Weight (After Split)
DL4451 20
(DL4460) 15

Two shipping parameters (located on the Delivery tab) are used to determine when a delivery or delivery line must be split to accommodate a carrier's capacity. See Shipping Parameters

Delivery Splitting Rules

Only Include for Planning deliveries are considered for splitting. LPNs are not split, instead, LPNs are added to child deliveries after the split takes place. Splitting cannot take place if:

Note: Delivery splitting functionality is not supported when integrating with Oracle Transportation Managements using the batch based integration functionality (WSH: Delivery Based OTM Integration profile option is set to No).

Delivery Line Splitting Rules

Delivery lines are split when the net weight of a line exceeds the Net Weight field on the Shipping Parameters window. The line is split to be equal to the Net Weight limit. If the split fails (due to an indivisible quantity), then the WSH_OTM_DET_SPLIT_FAILED exception is logged.

Note: The Gross Weight must exceed the Net Weight, otherwise the split will fail.

Note: Delivery line splitting functionality is not supported when integrating with Oracle Transportation Managements using the batch based integration functionality (WSH: Delivery Based OTM Integration profile option is set to No).

Packing

Any packing operation involving non-null weights in an enabled organization requires an update to Oracle Transportation Management and changes the delivery status or batch status to Update Required (UR). Overpick and underpick, in a pick-pack-ship flow, also requires an updated plan from Oracle Transportation Management, changing the status to UR.

Shipping Transactions Window Actions

When Oracle Transportation Management is implemented, some actions available on the Shipping Transactions window function differently than they do without Oracle Transportation Management installed for Include for Planning deliveries and trips. Certain delivery actions, however, are disabled, prevented, or will function differently.

All Include for Planning deliveries that have been interfaced to Oracle Transportation Management, in the case of delivery based integration, are controlled by Oracle E-Business Suite; you can update them until ship confirmation.

All Include for Planning trips are controlled by Oracle Transportation Management until ship confirmation is run. All delivery assignments to trips are performed in Oracle Transportation Management; therefore, restrictions to what modifications you can make to trips within Oracle E-Business Suite will occur. These restrictions include the following:

The following tables describe (by trip, trip stop, delivery, and delivery details) how the Actions function with Oracle Transportation Management implemented. (OTM = Oracle Transportation Management. EBS = Oracle E-Business Suite).

Note: The following tables include: Allowed (controlled by exception), which indicates that the ability to ship confirm is driven by the setup of OTM exceptions. For example, for delivery based integration, a delivery assigned to an OTM Trip Not Current might have the WSH_OTM_UPDATE_REQ or WSH_OTM_DEL_AWAIT_TRIP exception logged, therefore ship confirm is possible if the setup is Information Only or Warning for theses exceptions. For batch based integration, a delivery assigned to an OTM Trip Not Current might have the WSH_OTM_BATCH_UPDATE_REQ or WSH_OTM_BATCH_AWAIT_TRIP exception logged, therefore ship confirm is possible if the setup is Information Only or Warning for theses exceptions.

Include for Planning Trips Changed Actions
Action Delivery Created Not Assigned to Trip (Sent to OTM or Not) Delivery Assigned to Trip, Not Current Delivery Assigned to Trip, Current
Firm Routing NA Not Allowed Not Allowed
Firm Routing and Contents NA Not Allowed Not Allowed
Ignore for Planning NA Not Allowed Not Allowed
Ship Confirm NA Allowed (controlled by exception) Allowed (controlled by exception)
Unfirm NA Not Allowed Not Allowed
Include for Planning Trips Allowed for Maintenance Attributes
Attribute
Trip Name
Seal Code
Routing instruction, operator
Vehicle information (organization code, item name, prefix, vehicle number)
Flex Fields
Include for Planning Trip Stops Changed Actions
Action Delivery Created Not Assigned to Trip (Sent to OTM or Not) Delivery Assigned to Trip, Not Current Delivery Assigned to Trip, Current
Delete NA Not Allowed Not Allowed
Insert New Stops NA Not Allowed Not Allowed
Include for Planning Trip Stops Allowed for Maintenance Attributes
Attribute
Weight / Volume
Actual arrival / departure date
Departure fill %
Departure seal code
Unloading start end time
Flex fields
Include for Planning Deliveries Changed Actions
Action Delivery Created Not Assigned to Trip (Sent to OTM or Not) Delivery Assigned to Non-Current Trip (Waiting for OTM Re-Planning) Delivery Assigned to Current Trip (Trip from OTM Up to Date)
Assign to Trip Not Allowed Not Allowed Not Allowed
Auto-create Trip Not Allowed Not Allowed Not Allowed
Cancel Ship Method Disabled
(Not available in role definition when OTM is installed).		 Disabled Disabled
Get Freight Costs Disabled
(Not available in role definition when OTM is installed).		 Disabled Disabled
Ignore for Planning Allowed Allowed Delivery will be Ignore for Planning if unassigned from the OTM trip.
Pick Release Form Allowed Allowed Allowed
Pick and Ship Allowed (controlled by exception) Allowed (controlled by exception) Allowed
Pick, Pack, and Ship Allowed (controlled by exception, delivery will be ignored for planning in the process) Allowed (controlled by exception) Allowed
Packing will update tms_interface_flag of the delivery. Based on the exception setting, the delivery may or may not be ship confirmed.
Select Carrier Disabled (Action is not available in role definition when OTM is installed). Disabled Disabled
Send Outbound Message Allowed for Third Party Warehouse. Disabled for Carrier Manifesting Allowed for Third Party Warehouse. Disabled for Carrier Manifesting Allowed for Third Party Warehouse. Disabled for Carrier Manifesting
Ship Confirm Allowed (controlled by exception, delivery will be ignored for planning in the process) Allowed (controlled by exception) Allowed (controlled by exception)
Unassign from Trip NA Allowed. Will set the delivery to Ignore for Planning Allowed. Will set the delivery to Ignore for Planning
UPS Address Validation Disabled.
(Action is not available in role definition when OTM is installed).		 Disabled Disabled
UPS Rate and Service Disabled.
(Action is not available in role definition when OTM is installed).		 Disabled Disabled
UPS Time in Transit Disabled.
(Action is not available in role definition when OTM is installed).		 Disabled Disabled
Include for Planning Deliveries Allowed for Maintenance Attributes
Attribute Allowed / Disallowed
Delivery name Allowed
Freight term code Allowed
Weights / volume Allowed
Reason of transport Allowed
Description Allowed
Ship method Allowed if delivery is not assigned to a trip. Disabled if assigned to a trip.
Carrier ID Allowed if delivery is not assigned to a trip. Disabled if assigned to a trip.
Service level Allowed if delivery is not assigned to a trip. Disabled if assigned to a trip.
Mode of transport Allowed
Number of LPNs Allowed
Earliest / latest pickup dates Allowed
Earliest / latest drop off dates Allowed
Flex field update Allowed
Include for Planning Delivery Lines (Details) Changed Actions
Action Delivery Detail Not Assigned to Delivery Delivery Created Not Assigned to Trip (Sent to OTM or Not) Delivery Assigned to Trip, Not Current Delivery Assigned to Trip, Current
Auto-create Trip Not Allowed Not Allowed Not Allowed Not Allowed
Pick and Ship Allowed
(Delivery details will be changed to Ignore for Planning).		 Not Allowed Not Allowed Not Allowed
Pick, Pack, and Ship Allowed
(Delivery details will be changed to Ignore for Planning).		 Not Allowed Not Allowed Not Allowed
UPS Address Validation Disabled
(Action is not available in role definition when OTM is installed).		 Disabled Disabled Disabled
UPS Rate and Service Disabled
(Action is not available in role definition when OTM is installed).		 Disabled Disabled Disabled
UPS Time in Transit Disabled
(Action is not available in role definition when OTM is installed).		 Disabled Disabled Disabled
Include for Planning Delivery Details Allowed for Maintenance Attributes
Attribute Allowed / Disallowed
Requested Quantity Allowed from Order Management
Cancelled Quantity Allowed from Order Management
Shipped Quantity Allowed
Secondary Quantities Allowed from Order Management
Lot Number Allowed
Serial Number / to Serial Number Allowed
Weights and Volumes Allowed
Requested / Schedule Ship Date Allowed from Order Management
Customer PO Allowed from Order Management

Related Topics

Shipping Exceptions

Delivery Interface Statuses

The following interface statuses are used by Oracle Shipping Execution to track the required actions for Oracle Transportation Management integration. These interface statuses are internal and not visible through the user interface.

Delivery Interface Statuses

Trip Stops Interface Statuses

Planned Shipment Interface Message Corrections

Using the Shipment Message Corrections window in Oracle Shipping Execution you can view interface messages and transactions and correct interface errors. In addition, any Oracle Transportation Management interface error corrections can be viewed and corrected using the Shipment Message Corrections window. The integration of Oracle Transportation Management PlannedShipment included changes to the Shipment Message Corrections window. The Trip tab includes the following new fields:

The Trip Stops tab includes the new field Time Zone Code.

To View and Correct Interface Errors:

  1. Navigate to the Shipment Message Corrections window.

    The Find Shipment Message window appears.

  2. Enter the following information:

    Field Description
    Creation Date Range (From and To) (Optional) Select the creation date range for the shipping interface messages.
    Organization (Optional) Select the organization associated to the shipping interface messages.
    Source Type Shipping appears by default and cannot be changed.
    Action Code (Optional) Select an action code. Action codes are:

    • 94X_INBOUND

    • TMS_RELEASE

    • 94X_STANDALONE

    • YARD_DOCUMENT

      After you select YARD_DOCUMENT, the Yard Document Name field becomes available.


    To search for Oracle Transportation Management related messages, select TMS_RELEASE.
    Entity Name (Optional) Select the entity associated with the shipping interface messages. When searching for Oracle Transportation Management interface messages, select an entity name associated with an entity type of delivery or transportation sub batch.
    Yard Document Name Select a yard document name.
    This field is only available if you have selected YARD_DOCUMENT as the Action Code.
    Transactions check box (Optional) Select these check box view the shipping interface transactions.
    Transaction Type (Optional) Select the transaction type.
    Transaction Number (Optional) Select the transaction number.
    Trading Partner (Optional) Select the trading partner associated with the transaction.

    Find Shipment Messages window

    the picture is described in the document text

  3. Click Find.

    The system displays a message asking if you want to find all of the records in this folder?

  4. Click Yes.

    Shipment Message Corrections window

    the picture is described in the document text

    The Shipment Messages Correction window appears displaying all of the information related to the search criteria that you entered.

  5. View the delivery or transportation sub batch information errors:

    1. Select the Delivery/Transportation Sub Batch tab.

    2. Select the Interface ID.

    3. Click Error.

  6. Process the delivery or transportation sub batch information errors:

    1. Select the Delivery/Transportation Sub Batch tab.

    2. Select the Interface ID.

    3. Click Process.

  7. View the trip interface errors:

    1. Select the Trip tab.

    2. Select the Trip Interface ID.

    3. Click Error.

  8. Process the trip interface errors:

    1. Select the Trip tab.

    2. Select the Trip Interface ID.

    3. Click Process.

  9. View the message history:

    1. Select the Messages History tab.

    2. Select the Transaction ID.

    3. Click Error.

  10. Process the message history:

    1. Select the Messages History tab.

    2. Select the Transaction ID.

    3. Click Process.

Viewing Oracle Transportation Applied Freight Costs

Oracle Transportation Execution applied freight costs are viewed on the Freight Costs window within Oracle Shipping Execution. (From the Shipping Transactions window, find your delivery and invoke the Action Assign Freight Costs). After the PlannedShipment message has been received, the freight costs are viewable at the delivery level as OTM Freight Cost.

Applied freight costs are allocated to order lines through the use of the Order Management interface.

When integrating with Oracle Transportation Management using the batch basis, Oracle Transportation Management creates freight costs at the order release shipment level. In Oracle E-Business Suite there can be multiple deliveries for a order release, so the freight costs from the order release level are prorated to the delivery detail level using the basis (weight/volume/quantity). If all three of these attributes (weight, volume, and quantity) are available on the delivery details interface, then the system gives precedence to weight, then volume, then quantity. If only one attribute is available then the system uses that attribute.

Carrier Manifesting

When Oracle Transportation Management is integrated, all Oracle E-Business Suite enabled carrier manifest features are disabled. All carrier manifest deliveries are sent to Oracle Transportation Management as non-carrier manifesting deliveries. Oracle Transportation Management manages the carrier manifest system outside of the Oracle E-Business Suite.

Carrier Manifesting with Oracle Transportation Management

the picture is described in the document text

Third Party Warehousing

Third party warehousing functionality remains the same in Oracle E-Business Suite with or without Oracle Transportation Management integrated. Oracle Transportation Execution is not required to use Third Party Warehousing.

Note: Deliveries created by the third party warehouse instance, when Oracle E-Business Suite is used to manage the third party warehouse are communicated to Oracle Transportation Management for planning.

See Oracle Transportation Execution User's Guide.

Oracle Warehouse Management

Oracle Warehouse Management supports several methods to ship, also called mobile ship confirm, the deliveries using radio frequency (RF) devices. The methods include the following:

If the delivery lines and deliveries are created with Include for Planning, but are not yet sent to Oracle Transportation Management for planning, then Oracle Warehouse Management will allow ship confirmation using any of the above methods after changing the deliveries and delivery lines to Ignore for Planning.

If the associated delivery is Include for Planning and the delivery is not yet planned, then either a Warning (proceed and complete the transaction) or Error (cannot proceed) message is issued depending on the severity of the TMS_Flag status for the delivery or batch. The following delivery or batch based exceptions determine the severity:

Note: For example, a delivery assigned to an OTM Trip Not Current might have the WSH_OTM_UPDATE_REQ or the WSH_OTM_DEL_AWAIT_TRIP exception logged, therefore ship confirm is possible if the setup is Information Only or Warning for theses exceptions. Equivalent batch exception messages are logged when performing the same process using the batch basis integration with Oracle Transportation Management.

For more information, see Shipping Exceptions.

Automated Shipping (Oracle Shipping Execution)

Oracle Shipping Execution enables automated shipping flows to speed the various shipping processes. The automated flows are available through actions on the Shipping Transactions window. See the Oracle Shipping Execution User's Guide for information on One Step Shipping.

The automated flows are enabled with the integration of Oracle Transportation Management; however, in some cases the functionality of the flows changes with the integration of Oracle Transportation Management, including the following:

Action Delivery – Ignore for Planning Delivery not on a Trip Waiting for OTM Planning Delivery on a Trip Waiting for OTM Re-Planning Delivery on a Trip Planned by OTM Delivery Details
Auto Ship Confirm Allowed Allowed (controlled by exception, delivery will be ignored for planning in the process) Allowed (controlled by exception) Allowed (controlled by exception) NA
Process Deliveries SRS Allowed and creates Ignore for Planning Trip Not Allowed Not Allowed Not Allowed Allowed

Implementing Oracle Transportation Management with Oracle Shipping Execution

System Configuration and Setup Changes (Oracle Transportation Management)

The following section describes the system configuration and setup changes required in Oracle Transportation Management.

Setting Up an External System

An external system is required for each flow coming out of Oracle Transportation Management, for example, the Voucher Interface. The following steps outline how to set up an external system in Oracle Transportation Management.

To create external systems in Oracle Transportation Management to receive the outbound messages (Planned Shipment and Voucher)

  1. Retrieve the WSDL for the BPEL flow and save the WSDL locally to your hard drive. Note that the endpoint location will be used as the Service Endpoint when setting up the external system.

  2. Create the external system in Oracle Transportation Management with Web Services defined.

    1. Enter the External System ID.

    2. Navigate to the Web Services region and click N to create a new web service.

    3. Within the Web Service Manager page, click N to create a new WSDL document.

    4. Click Document Detail.

    5. Within the ID field, enter an ID, for example WSHRECEIVEPSHIPMENTFROMOTM or OTMVOUCHERTOORACLEAPINVOICE.

    6. Within the Storage field, select Text.

    7. Click Upload to upload the WSDL file you retrieved from the BPEL server.

      Mime Type is automatically populated after the WSDL file is uploaded.

    8. Click Finished.

    9. Click Service Details.

    10. Within the Web Service Details page, click Service Details.

    11. Enter a Service ID, for example WSHRECEIVEPSHIPMENTFROMOTM or OTMVOUCHERTOORACLEAPINVOICE.

    12. Review the Operations section. The process operation should, by default, be designated as For Integration.

      At least one operation must have For Integration enabled.

  3. Enter the Service Endpoint and click Save and Finished.

    The Service Endpoint is the URL from the BPEL WSDL endpoint location.

  4. On the External System, enable the Trans Ack Expected check box.

    Enabling the Trans Ack Expected check box indicates that a TransmissionAck XML is expected to be returned by the BPEL flow. WshReceivePShipmentFromOtm and OtmVoucherToOracleApInvoice both return the TransmissionAck.

  5. Enable the Use Ack Status check box (for Voucher External System only).

    Enabling the Use Ack Status check box indicates that the status in the TransmissionAck should be used as the status of the transmission, for example PROCESSED or ERROR.

  6. Click Finished to save your work.

    Note: When sending transmissions to these external systems, you must use the Notify Type of SERVICE.

Setting Up Profile Options

During implementation, you set a value for each user profile option to specify how Oracle Transportation Management controls access to and processes data. Generally, the system administrator sets and updates profile values. See Oracle E-Business Suite Setup Guide.

The following table indicates whether you (the user) can view or update profile options and at which System Administrator level that profile option can be updated. The System Administrator level includes User, Responsibility, Application, and Site levels. Profile options are considered either optional or required:

The following terms are used in the table to identify if you can view or update profile option information:

Profile Option User Resp App Site Required? Default Value
OTM: Integration Enabled -- -- -- Updatable Yes Neither
OTM: Domain Name -- -- -- Updatable Yes Blank/Empty
OTM: Domain User -- -- -- Updatable Yes Blank/Empty
OTM: Proxy Server -- -- -- Updatable Yes Blank/Empty
OTM: Proxy Port -- -- -- Updatable Yes Blank/Empty
OTM: Servlet URI -- -- -- Updatable Yes Blank/Empty
OTM: Corporation Country Code -- -- -- Updatable Yes Blank/Empty
Profile Option Used By
OTM: Integration Enabled All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data) and Purchasing Integration
OTM: Domain Name All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data) and Purchasing Integration
OTM: Domain User All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data) and Purchasing Integration
OTM: Domain Password This profile option is not used. The password for the Oracle Transportation Management domain user name is in the FND Vault.
OTM: Proxy Server All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data)
OTM: Proxy Port All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data)
OTM: Servlet URI Outbound (Sales Order Integration)
OTM: Corporation Country Code Outbound (Ref Data)

OTM: Corporation Country Code

This profile is used by Oracle Shipping Execution for customer and carrier synchronization. The code in this profile identifies the default country code of the headquarters' carriers and customers.

OTM: Domain Name

Oracle Shipping Execution and Oracle Purchasing use this profile. It is communicated on the outbound messages from Oracle E-Business Suite Applications and used by Oracle Transportation Management to identify an instance of Oracle E-Business Suite. The profile must be a valid domain name defined in Oracle Transportation Management.

OTM: Domain User

Oracle Shipping Execution and Oracle Purchasing use this profile. It must be a valid user in Oracle Transportation Management and is not case sensitive.

OTM: Domain Password

The OTM domain password is now stored in FND Vault rather than in a profile option. During OTM integration, if the OTM domain password is not present in FND Vault, it is obtained from this FND profile option and moved to FND Vault.

To set the OTM domain password in FND Vault:

  1. Connect to the apps schema.

  2. Run the SQL script patch/115/sql/wshotmfndvlt.sql to place the OTM password in FND Vault. For example, @/u01/R122_EBS/fs2/EBSapps/appl/wsh/12.0.0/patch/115/sql/wshotmfndvlt.sql

  3. Enter an OTM password for the user that is specified in the profile option OTM: Domain User.

    Important: You can also use these steps to change the password.

To view the OTM domain password in FND Vault, execute the following code:

SET SERVEROUTPUT ON;

DECLARE OTM_PWD VARCHAR2(200);

BEGIN OTM_PWD:=FND_VAULT.GET('OTM_INTEGRATION','OTM_PASSWORD');

DBMS_OUTPUT.PUT_LINE('Password from FND Vault : '||OTM_PWD);

END;

/

OTM: Integration Enabled

Oracle Shipping Execution and Oracle Purchasing use this profile to determine which components of the Oracle Transportation Management integration are enabled.

Values are:

OTM: Proxy Port

This profile is used to store the port number for the HTTP proxy server on Oracle E-Business Suite instance. Oracle Shipping Execution uses this profile to make a connection to an Oracle Transportation Management instance.

OTM: Proxy Server

This profile is used to store the HTTP proxy server on the Oracle E-Business Suite instance. Oracle Shipping Execution uses this profile to make a connection to an Oracle Transportation Management instance.

OTM: Servlet URI

This profile is used to store Oracle Transportation Management Servlet URI for the Oracle E-Business Suite instance to connect to Oracle Transportation Management. This is used for freight estimation at sales order integration only.

Shipping Configuration and Setup Changes (Oracle E-Business Suite)

Setting Up Profile Options and Parameters

During implementation, set a value for each user profile option to specify how Oracle Shipping Execution controls access to and processes data. Generally, the system administrator sets and updates profile values. See Oracle E-Business Suite Setup Guide.

The following table indicates whether you (the user) can view or update profile options and at which System Administrator level that profile option can be updated. The System Administrator level includes User, Responsibility, Application, and Site levels. Profile options are considered either optional or required:

Note: If you are using a multi-organization structure, your system administrator must change the OM Item Validation Organization profile option to be visible and updatable at the responsibility level. This change enables Shipping Execution to apply the default tax code and revenue account information correctly. See Oracle E-Business Suite Multiple Organizations Implementation Manual.

The following terms are used in the table to identify if you can view or update profile option information:

Profile Option User Resp App Site Required? Default Value
WSH: BPEL Domain Name -- -- -- Updatable Yes Blank/Empty
WSH: BPEL Webservice URI for OTM -- -- -- Updatable Yes Blank/Empty
WSH: Currency Conversion Type for OTM -- -- -- Updateable No Corporate
WSH: Default Shipping User for OTM -- -- -- Updatable Yes Blank/Empty
WSH: Default Shipping Responsibility for OTM -- -- -- Updatable Yes Blank/Empty
WSH: Delivery Based OTM Integration -- -- -- Updatable No Blank/Empty
WSH: Enable Multi-Leg Shipment for Delivery-Based OTM Integration -- -- -- Updatable No Blank/Empty
Server Timezone -- -- -- Updatable Yes Blank/Empty
Client Timezone Updatable -- -- -- Yes Blank/Empty
Enable Timezone Conversions -- -- -- Updatable Yes Blank Empty
Profile Option Used By
WSH: BPEL Domain Name All outbound from WSH to OTM integration
WSH: BPEL Webservice URI for OTM All outbound (Sales Order Integration, Outbound Deliveries Integration, and Ref Data)
WSH: Currency Conversion Type for OTM Planned Shipment Request to process the inbound requests coming from OTM and in RIQ
WSH: Default Shipping User for OTM Only for inbound from OTM to WSH integration
WSH: Default Shipping Responsibility for OTM Only for inbound from OTM to WSH integration
WSH: Delivery Based OTM Integration All inbound and outbound between WSH and OTM
WSH: Enable Multi-Leg Shipment for Delivery-Based OTM Integration All inbound and outbound between WSH and OTM
Server Timezone Only for inbound from OTM to WSH integration
Client Timezone All
Enable Timezone Conversions All

WSH: BPEL Domain Name

This profile option stores the BPEL domain information, which is used by the outbound and carrier synchronization concurrent programs to enable the system to invoke corresponding programs. The default value is Default.

WSH: BPEL Web Service URI for OTM

This profile option is used by freight estimation at sales order, outbound orders, and reference data integration. It stores the HTTP location of the BPEL Process Manager and tells the concurrent request where the BPEL outbound processes are located.

WSH: Currency Conversion Type for OTM

This profile is used for currency conversion type in RIQ and Planned Shipment. The profile provides a list of values containing all conversion types defined in the system.

WSH: Default Shipping User for OTM

This profile determines the default user that receives the inbound messages from Oracle Transportation Management. The BPEL process sends the inbound message to the Oracle E-Business Suite user identified by this profile. This profile option is required and there is no default value.

WSH: Default Shipping Responsibility for OTM

This profile determines the user responsibility required to receive inbound messages from Oracle Transportation Management. The BPEL process sends the inbound message to the default Oracle E-Business Suite user with the responsibility defined by this profile. This profile option is required and there is no default value.

WSH: Delivery Based OTM Integration

This profile option determines the basis for the integration between Oracle Shipping Execution and Oracle Transportation Management (OTM). If the profile is set to Yes or Null, then the integration is delivery based. If set to No, then the integration is batch based. You create the batches that are sent to OTM by running the Create Batches for Transportation Planning concurrent program in Oracle Shipping Execution. The default for the profile option is Null (means Yes).

WSH: Enable Multi-Leg Shipment for Delivery-Based OTM Integration

This profile option enables adding multiple trips to a delivery for delivery-based integration between Oracle Shipping Execution and Oracle Transportation Management. This profile is set at the site level and the default value is blank. If the profile option is set to Yes, then the integration supports the multi-leg feature for delivery-based integration. If the profile is set to No, then the integration supports the multi-leg feature for batch-based integration.

Server Timezone

This profile determines the time zone in which the server has been set to run, or the standard corporate time zone. This profile should be set at the site level and should not be changed once set, as existing data will not be updated.

Client Timezone ID

This profile specifies the user preferred time zone. This profile is used when your corporate time zone differs from your local time zone. This profile is set at the user level and is available from the self service Preferences window and from the forms-based Profiles window.

Enable Timezone Conversions

This profile enables the automatic conversion of all date and time fields to the preferred user time zone. If set to No, then the date and time fields default to the corporate time zone.

This profile option must be set when integrating your applications with Oracle Transportation Management. If it is not set, then the BPEL process will fail in Purchasing because of the lack of time zone conversions.

Changes to the Shipping Windows

The following changes occur to the shipping windows when Oracle Transportation Management is installed.

Shipping Parameters Window

When Oracle Transportation Management is installed, the following changes occur in the Shipping Parameters window:

Global Shipping Parameters Window

When Oracle Transportation Management is installed, the following changes occur in the Global Parameters window:

The Defer Planned Shipment Interface parameter on this window gives you the option to defer to the Planned Shipment Interface concurrent request. If you select this parameter, the concurrent request must be run manually or you can schedule it. If you do not select this parameter, the system runs the concurrent request automatically every time the planned shipment is received from Oracle Transportation Management.

Shipping Transactions Window

When Oracle Transportation Management is installed, the following changes occur in the Shipping Transactions window:

Shipping Exceptions

During the shipping and transportation of goods, unforeseen shipping exceptions can occur that conflict with the actual requirements of the shipper, transportation carrier, or customer. Tracking exceptions can also be helpful to identify and correct defects in the business process. Seeded exceptions are logged automatically against delivery lines, LPNs, batches, deliveries, and trip stops when specific events occur. The following exceptions are seeded with the integration of Oracle Transportation Management:

Note: Oracle Transportation Management exceptions cannot be logged manually.

Concurrent Programs

Oracle Shipping Execution provides the following concurrent programs:

Note: If an order release is not deleted in Oracle Transportation Management after running the Shipping-Transportation outbound Delete interface, ensure that the delete transaction is processed before the other delivery related transactions. For example, you could create a concurrent request set that includes the different interface actions in the following order:

  1. Delete

  2. Update

  3. Create

or, alternatively:

  1. Delete

  2. All except actual shipment

Shipping-Transportation Carriers Synchronization

Carriers and carrier sites are defined in Oracle Shipping Execution; however the implementation of Oracle Transportation Management includes changes to the Carrier form. The following changes are part of the integration of Oracle Transportation Management:

The Shipping - Transportation Carriers Synchronization concurrent program enables Oracle E-Business Suite to communicate carrier and carrier site information to Oracle Transportation Management through the use of the Location XML transaction. The carrier and carrier site information from the Oracle E-Business Suite tables/columns is interfaced to Oracle Transportation Management tables/columns through the concurrent program.

During the implementation of Oracle Transportation Management, the Shipping - Transportation Carriers Synchronization concurrent program is executed to move all carrier and carrier site data from the Oracle E-Business Suite tables / columns to the Oracle Transportation Management tables/columns. After the implementation is complete, the concurrent program can be run whenever a Carrier/Carrier Site is updated or new Carriers and Carrier Sites are created.

BPEL is used to control the flow of data sent by the concurrent program.

Interface Parameters

The Shipping-Transportation Carriers Synchronization is executed from the Interfaces menu. The program includes the following parameters:

Transferred Carrier Data

The following table details all carrier data, whether Oracle E-Business Suite or Oracle Transportation Management owns the data, and details how (if at all) the data is transferred from one to the other. (OTM = Oracle Transportation Management. EBS = Oracle E-Business Suite.)

Transferred Carrier Data
EBS Entity OTM Entity Owner Transfer Data Method
Vehicle Types Equipment Types / Groups OTM None
Carrier Commitments Carrier Commitments OTM None
Vehicle Availability Carrier Capacity OTM None
Carriers Corporation ID EBS From EBS to OTM
Carrier Sites Location ID EBS From EBS to OTM
Service Levels Rate Service EBS Manual
Modes Mode EBS Manual
Calendars (Shipping, Receiving, and Carrier) Calendars OTM None

Shipping-Transportation Locations Synchronization

The Shipping-Transportation Locations Synchronization concurrent program synchronizes the locations between EBS and OTM. You must create the location in EBS and then use this concurrent program to synchronize the EBS locations with OTM. After you run this concurrent program, OTM can use the new locations for itineraries and setup data.

Interface Parameters

The Shipping-Transportation Locations Synchronization concurrent program is submitted from the Interfaces menu. The program includes the following parameters:

Create Batches for Transportation Planning

The Create Batches for Transportation Planning concurrent program groups delivery details for the selected parameters into a transportation batch and subbatches. A transportation batch can contain delivery details from multiple sales orders or from a Oracle Warehouse Management wave. The subbatches are created based on the Ship-From and Ship-To locations of the sales order lines. If you select Cancel Unshipped Lines check box in the sales order header, then different subbatches are created for each sales order.

The following batch group attributes are mandatory:

The following batch group attributes are optional:

Transportation sub batches are sent to Oracle Transportation Management (OTM) for transportation planning. Transportation sub batch name is equivalent to an order release in OTM. OTM using the order release can plan and create single or multiple shipments that are then sent back to Oracle Shipping Execution to create trips.

When entering the parameters for the Create Batches for Transportation Planning concurrent program, you can select whether you want the concurrent program to send the transportation batch immediately to OTM after the batch is created or if you want to send the batch at a later date. If you select Yes in the Submit Outbound Request parameter, the system automatically runs the Shipping-Transportation Outbound Interface concurrent program after the transportation batch is created. If you select No in the Submit Outbound Request parameter, you would have to manually run or have the system periodically run the Shipping-Transportation Outbound Interface concurrent program.

Submission

  1. Navigate to the Shipping Interfaces window.

  2. Select Create Batches for Transportation Planning in the Name field.

  3. Enter the parameters and click OK.

  4. Click Submit.

Parameters

Enter values in the following parameters:

  1. Source System: Select a source system.

  2. Organization: Optionally, select the organization.

  3. Wave: Optionally, select the Oracle Warehouse Management wave.

    After you select a wave, the other parameters become unavailable for entry.

  4. Consignee/Customer: Optionally, select a customer or supplier. For an ISO return delivery line, select a ship-to organization.

  5. Ship To Location: Optionally, select a consignee's or customer's ship to address.

  6. Source Header Type: Optionally, select the source header type.

  7. Source Header Number (Low/High): Optionally, select the range of source header numbers.

  8. Request Date (Low/High): Optionally, select the range of request dates.

  9. Schedule Date (Low/High): Optionally, select the range of schedule dates.

  10. Shipment Priority: Optionally, select the shipment priority.

  11. Line Status: Optionally, select the line status.

  12. Submit Outbound Request: Select Yes to have the system automatically run the Shipping-Transportation Outbound Interface concurrent program after the batch is successfully created. Select No if you do not want the system to run the Shipping-Transportation Outbound Interface concurrent program. Yes is the default.

  13. Log Level: Select 1 to turn debugging on and 0 to turn debugging off.

Output File

After the concurrent program completes successfully, you can view the transportation batch number and sub batches created through the output file.

To view the output file:

  1. Navigate to the Requests window.

  2. Select the Request ID associated with the Create Batches for Transportation Planning concurrent program.

  3. Click View Output.

Shipping-Transportation Outbound Interface

The Shipping-Transportation Outbound Interface concurrent program passes Oracle Shipping Execution information to Oracle Transportation Management (OTM). The interface passes the information to BPEL using XML. The setting for the profile option WSH: Delivery Based OTM Integration determines whether the information that is passed from Oracle Shipping Execution to OTM is delivery based or batch based.

If you set the WSH: Delivery Based OTM Integration profile option to Yes or Null, the integration is delivery based. If you set the profile option to No, the integration is batch based. Depending on the type of integration you are using, the system parameters enabled to run the Shipping-Transportation Outbound Interface concurrent are different.

Shipping-Transportation Outbound Interface concurrent program includes the following parameters:

Shipping-Transportation Outbound Interface Parameters

When scheduling the Shipping-Transportation Outbound Interface, it is recommended that you ensure that the Delete action is processed with the highest priority. For example, by scheduling the action with a higher frequency, or by creating a concurrent request set that performs the action ahead of other interface actions. This lowers the risk of double assignment of ship units or order release lines in Oracle Transportation Management, which might prevent proper deletion of the order release.

Reference Data and Mapping

Item, Customer/Customer Site, and Organizations/Ship From Locations are included as reference data that is sent as part of the Shipping-Transportation Outbound Interface concurrent request.

Planned Shipment Interface

The Planned Shipment Interface concurrent program picks up the shipments that were created in Oracle Transportation Management and places them in Oracle Shipping Execution. You can automatically run the Planned Shipment Interface request every time a planned shipment is received from Oracle Transportation Management. However, for situations that may result in too many Planned Shipment Interface concurrent requests being run simultaneously, you may want to run this request either manually or on a scheduled interval. Several concurrent requests running at the same time may reduce system performance.

The Defer Planned Shipment Interface checkbox on the Global Parameters window (General tab) controls the default setting for running the Planned Shipment Interface concurrent program. Select this checkbox if you want to run the program manually (or to schedule it), or clear this checkbox if you want to run the request automatically every time the planned shipment is received from Oracle Transportation Management.

To provide additional information in the descriptive flexfields (DFF) for trips and trip stops, set the attribute values in the following custom APIs:

These APIs are called when data is inserted into the shipping interface table. The DFF values entered in the interface tables are processed by the Planned Shipment Interface and are visible in the Shipping Transactions window after enabling the standard DFFs for trips and trip stops.

For multi-leg shipments, the Planned Shipment Interface concurrent program does the following:

  1. Creates multi-leg trips in EBS

  2. Creates or assigns delivery to multi-leg trips

  3. Assigns freight cost information at the trip level

  4. Processes trip updates that are already received in EBS

Submission

  1. Navigate to the Shipping Interfaces window.

  2. Select Planned Shipment Interface in the Name field.

  3. Enter the parameters and click OK.

  4. Click Submit.

Parameters

Related Topics

Item XML Mapping

Customer XML Mapping

Customer Site XML Mapping

Organization XML Mapping

Carrier XML Mapping

Carrier Site XML Mapping