Download as pdf or txt
Download as pdf or txt
You are on page 1of 61

Oracle International Trade

Management (ITM) Partner


Integration: Specifications

Version : Draft
Prepared By : Product Management, Oracle Shipping Execution
Control Ref : intlptnrint.rtf
Last Updated : 18-Oct-05

Disclaimer: The following is intended to outline our general product direction and is intended for information
purposes. The development, release, and timing of any features or functionality described for Oracle's products
remains at the sole discretion of Oracle.

Copyright © 2005 Oracle Corporation


All Rights Reserved
Oracle International Trade Management Partner Integration Specifications

Contents

Overview.....................................................................................................................................................................1
ITM Process Flow ...................................................................................................................................................1

Major Features ..........................................................................................................................................................3


Interfaces with Partner Application .........................................................................................................................3
Item Synchronization...............................................................................................................................................4
Party Synchronization .............................................................................................................................................4
Export Compliance Screening .................................................................................................................................4
Transaction Documents ...........................................................................................................................................6
Messaging................................................................................................................................................................7
Service Request Grouping .....................................................................................................................................10
Print Queues ..........................................................................................................................................................10
Transaction Delivery .............................................................................................................................................10
User Interface ........................................................................................................................................................10
Message Formats ...................................................................................................................................................17
Scalability Features ...............................................................................................................................................17
Phasing ..................................................................................................................................................................18

Partner Requirements.............................................................................................................................................20

Assumptions .............................................................................................................................................................21

Process Flows ...........................................................................................................................................................22


Item Synchronization.............................................................................................................................................22
Party Synchronization ...........................................................................................................................................23
Order Compliance Screening.................................................................................................................................24
Delivery Compliance Screening ............................................................................................................................27

Appendix A - Item Synchronization Request XML..............................................................................................28

Appendix B - Party Synchronization Request XML ............................................................................................31

Appendix C – Order Compliance Request XML..................................................................................................35

Appendix D – Export Compliance Response XML ..............................................................................................38

Appendix E – Delivery Compliance Request XML ..............................................................................................40

Appendix F –Acknowledgements ...........................................................................................................................52


XML Acknowledgement .......................................................................................................................................52
HTML Acknowledgement.....................................................................................................................................52

Appendix G – Oracle XML Gateway Setup..........................................................................................................54


Define Transactions...............................................................................................................................................54
Define Trading Partners.........................................................................................................................................54

Appendix H – Additional Resources ......................................................................................................................56

Intlptnrint.doc Oracle Confidential - For internal use only ii


Oracle International Trade Management Partner Integration Specifications

Figures & Tables

Fig 1: International Trade Management – Process Flow Diagram .........................................................................2


Fig 2: Oracle ITM Partner Integration - Flow Diagram .........................................................................................3
Fig 3: Integration Flow Diagram along with Overview Messaging .......................................................................6
Fig 4: Item Synchronization – Overview Messaging .............................................................................................7
Fig 5: Party Synchronization – Overview Messaging ............................................................................................7
Fig 6: Export Compliance for Sales Orders – Overview Messaging......................................................................8
Fig 7: Export Compliance for Deliveries – Overview Messaging..........................................................................9
Table 1: International Trade Service Request by DTDs.........................................................................................9
Table 2: International Trade Service Response by DTDs ......................................................................................9
Fig 8: ITM Partner Setup Form ............................................................................................................................11
Fig 9: ITM Partner Application User Setup Form................................................................................................12
Fig 10: ITM Adapter Parameter Setup Form........................................................................................................13
Fig 11: Item Synchronization Program Parameters ..............................................................................................15
Fig 12: Party Synchronization Program Parameters.............................................................................................16
Fig 13: Submit Deliveries for Screening Program Parameters .............................................................................17
Fig 14: ITM Services, Integrating Oracle Applications........................................................................................18
Table 3: Summary of ITM Services and Integrating Oracle Applications ...........................................................19
Fig 15: Item Synchronization Integration Flow Diagram.....................................................................................23
Fig 16: Party Synchronization Integration Flow Diagram....................................................................................24
Fig 17: Order Export Compliance - Integration Flow Diagram ...........................................................................26
Fig 18: Export Compliance for Deliveries – Integration Flow Diagram ..............................................................28
Fig 19: Item Synchronization Request Message Structure ...................................................................................28
Table 4: Element Description of Item Synchronization Request Message..........................................................29
Table 5: Element description of Control Area Elements of Item Synchronization Request................................30
Fig 20: Party Synchronization Request Message Structure..................................................................................32
Table 6: Element description of Party Synchronization Request Message...........................................................34
Table 7: Element description of Control Area Elements of Party Synchronization request.................................34
Fig 21: Order Compliance Request Message Structure........................................................................................36
Table 8: Element description of Order Compliance Request Message.................................................................37
Table 9: Element description of Control Area Elements of Order Request XML................................................37
Fig 22: Export Compliance Response Message Structure....................................................................................38
Table 10: Element description of Export Compliance Response Message...........................................................39
Table 11: Element description of Delivery Compliance Request Message..........................................................51
Fig 23: Acknowledgement Message Structure (Confirm_BOD_004)..................................................................52

Intlptnrint.doc Oracle Confidential - For internal use only iii


Oracle International Trade Management Partner Integration Specifications

Overview

International trade requires dealing with the rules, regulation and duties applicable for
the products between the countries of trade. The international trade management
solutions provide latest information on the country specific rules and regulations
along with several other value added tools to manage the international trade
effectively.

Oracle International Trade Management (ITM) adapter is an open interface, which


enables international trade management functionality in Oracle Applications. It is the
interfaces gateway to third party ITM applications. It acts as a unified transaction
channel for all of the international trade compliance requests originating from Oracle
Applications and response originating from the ITM Application.

This document is intended to provide an overall understanding of the ITM Partner


Integration for the purpose of integrating with the partner ITM application. For any
detailed information on setting up the integration in Oracle Applications, please refer
to the Oracle Shipping Execution product documentation on metalink
(metalink.oracle.com).

ITM Process Flow


The international trade compliance process varies depending upon the exporting and
importing countries’ regulation, the type of goods being traded, the intended end use
of the goods, and the quantity and value of the goods. An international trade
management solution helps you answers the following questions:

Is it legal to sell to/buy from this entity?

Is a license required for exporting/importing this product?

Are there any special government documents needed for the export/import?

How can the customs delays be prevented?

What is the total cost for buying/selling the products?

The international trade management processes include classifying products and


screening orders, determining and applying for required licenses with appropriate
Government or regulatory bodies, generating and submitting extensive
documentation, managing and minimizing country-specific tariffs and duties, and
tracking and tracing shipments across the entire global trading community. Business
processes for international trade can be divided into two major categories:

1. Export related

2. Import related

It is important to point out that an international trade involves both of these


Intlptnrint.doc Oracle Confidential - For internal use only 1
Oracle International Trade Management Partner Integration Specifications

classifications, i.e. an export from a seller’s country is an import to the buyer’s


country and compliance to both is mandatory for a successful business transaction. An
effective trade compliance system need to provide a flexible way of performing the
compliance functions at several points in the buy and sell process. On the sell side,
Sales Orders, Picking and Shipping processes need to have most of the export
compliance functions accessible. In case of a compliance issue, the quotes, the orders
and the shipments are to be re-evaluated by the compliance users and appropriate
decisions to be made in accordance with the compliance policy of the organization.
Similarly on the buy side, several different compliance checks are required to be
performed at several different points in the process.

International Trade Management: Process Flow

Embargo Country Screening Embargo Country Screening


Restricted Party Screening Restricted Party Screening
Embargo Country Screening Landed Cost Landed Cost
Restricted Party Screening Export License Export License
Landed Cost Estimation Document Generation Document Generation

Freight
Order Sales Customs
Pick Pack Ship Forwarder/
Quote Order Clearance
Consolidator

Enter/Edit Enter/Edit
Item Customer

Exports Flow: Sell Side

Item Embargo Country Screening Delivery/


Classification Restricted Party Screening Receipt

Notification
Requisition/ Source Purchase Customs
RFQ of
Requirement Selection Order Clearance
Shipment

Enter/Edit Enter/Edit
Item Supplier

Embargo Country Screening Embargo Country Screening Embargo Country Screening


Restricted Party Screening Restricted Party Screening Restricted Party Screening
Landed Cost Landed Cost
Import License Import License
Item Embargo Country Screening Document Generation
Classification Restricted Party Screening
Imports Flow: Buy Side

Fig 1: International Trade Management – Process Flow Diagram

Intlptnrint.doc Oracle Confidential - For internal use only 2


Oracle International Trade Management Partner Integration Specifications

Major Features

Oracle International Trade Management adapter is an open interface, which enables


international trade management (ITM) functionality in Oracle Applications. It is the
interfaces gateway to third party ITM solutions and acts as a unified transaction
channel for all of the international trade compliance requests originating from Oracle
Applications and response from the ITM Application. The international trade
management adapter not only provides a standard mechanism to access trade
application but also performs several other value added functions in the process. The
ITM adapter is deployable over LAN, WAN or Internet and hence presents a uniform
architecture for integration with the partner ITM applications.

Interfaces with Partner Application


Oracle International Trade Management adapter is the interface gateway to partner
ITM application from Oracle Applications. A trade management service request may
initiate from several functional modules within the Oracle Applications i.e. Oracle
Order Management, Oracle Purchasing etc., but all of the module would access the
international trade compliance functionality through the adapter. The response from
the partner application is communicated back to the functional application.

Internet/LAN/WAN
Oracle TCA

ITM
Application
Oracle BOM

Oracle Quoting and other Apps


Oracle
ITM
Oracle Order Management
Partner
Oracle Shipping Execution
Integration

Oracle Purchasing/iProcurement

Oracle Payables
ITM
Application

Fig 2: Oracle ITM Partner Integration - Flow Diagram

Intlptnrint.doc Oracle Confidential - For internal use only 3


Oracle International Trade Management Partner Integration Specifications

Item Synchronization
`Items are classified in the partner ITM application. Oracle ITM Adapter provides the
classification service request XML for facilitating the item definition in the partner
application. The Item Synchronization request XML contains all the necessary data
elements required for classifying items. The partner ITM application provides country
specific rules and regulations to help you assign the right classification (e.g. HS code,
ECCN for exports from US) for your items.

Integrated with Item Master


Oracle ITM adapter leverages the item definition in Oracle Bill of Materials for
communicating to partner ITM application. The ITM adapter also provides a flexible
mechanism for indicating the filtering criteria for items. This allows you to easily
specify which items need to be transmitted to the partner ITM application for export
classification. The adapter enables the integration with the item master by providing a
concurrent program with several user-friendly parameters.

Party Synchronization
Oracle ITM Adapter supports a XML service request to communicate the
international trade entities to the partner ITM application. The Party Synchronization
XML Request contains all the necessary data elements required for performing export
screenings like Restricted Party Screening, Embargo Country Screening etc. The
parties may also be stored in the partner ITM application so that they can be re-
screened as and when there are updates to these lists. The audit trail of the screenings
is maintained in the partner ITM application.

Integrated with Customer Master


Oracle ITM Adapter leverages the party definition in Oracle Trading Community
Architecture for screening the parties for exports. The ITM adapter also provides a
flexible mechanism for indicating the filtering criteria for parties. This allows you to
easily specify which parties need to be transmitted to the partner ITM application for
export screening. The adapter enables the integration with the customer master by
providing a concurrent program with several user friendly parameters.

Export Compliance Screening


The ITM adapter supports one combined request i.e. Order Compliance Request XML
for all the export related compliance checks for the sales order. These include
Restricted Party Screening, Embargo Country Screening, License Determination,
Document Generation and other partner supported screening like EPCI etc. The
combined request XML contains all the necessary data elements required for all of the
export compliance services. The partner ITM application evaluates the transaction
(sales order or delivery) for export compliance and responds to Oracle Applications
with the overall compliance pass or fail status for each of the order line. The audit trail
of the compliance checks is maintained in the partner ITM application.

Intlptnrint.doc Oracle Confidential - For internal use only 4


Oracle International Trade Management Partner Integration Specifications

Integrated with Oracle Order Management


Oracle Order Management (OM) features export compliance check at any point after
scheduling in the order line flow. A workflow activity enables flexible integration
with the ITM adapter. The ITM Adapter’s Order Compliance Request XML is utilized
to communicate key order line attributes to the ITM application. The ITM application
responds with overall compliance Pass or Fail result in the Export Compliance
Response XML asynchronously.

The ITM adapter and OM integration also highlights automated action based on the
overall compliance status. A sales order line is placed on hold if it is identified as non-
compliant by the partner application.

Integrated with Oracle Shipping


Oracle Shipping Execution (WSH) features export compliance screening for
deliveries. The ITM Adapter’s Delivery Compliance Request XML is utilized to
communicate key delivery attributes to the ITM application. The ITM application
responds with overall compliance Pass or Fail result in the Export Compliance
Response XML asynchronously.

The ITM adapter and WSH integration also highlights automated action based on the
overall compliance status. When compliance is requested for a delivery through the
ITM adapter, an exception preventing ship confirmation is logged automatically. A
compliance pass response removes the exception and enables the delivery for ship
confirmation. Deliveries can be submitted for export compliance screening once prior
to ship confirmation and again at ship confirm. The shipping integration also provides
flexibility for users to designate the severity on the seeded exception.

Intlptnrint.doc Oracle Confidential - For internal use only 5


Oracle International Trade Management Partner Integration Specifications

Transaction Documents
Oracle’s adapter supports communication with partner applications via XML. The
following diagram reflects the service requests (and direction) the Oracle adapter is
designed to support in this phase:
Legend
1 - Item Synchronization Request XML
2 - Party Synchornization Request XML
3 - Order Compliance Request XML
5 - Delivery Compliance Request XML
4,6 - Export Compliance Response XML
A1 - Acknowledgment from ITM Application
A2 - Acknowledgement from Oracle Applications

Item Master Customer Master Sales Order Delivery


Oracle Applications

(Oracle BOM) (Oracle TCA) (Oracle Order Mgt.) (Oracle Shipping Execution)
Oracle ITM Adapter

Oracle XML Gateway

1 A1 2 A1 3 A1 4 A2 5 A1 6 A2

LAN/WAN/Internet

ITM Application XML Adapter


Partner ITM Application

Create / Export Send XML Export


Create / Send XML Response
Update Compliance Response Compliance
Update Partner Compliance=Pass/Fail
Product Determination Compliance=Pass/Fail Determination
Product Trade Party
Classification Screening
Compliant? Yes Compliant? Yes
No
No
Generate
Yes Yes Documents?
Compliance
Compliance User Review
Compliant?
User Review Compliant?
No
No

Fig 3: Integration Flow Diagram along with Overview Messaging

Each service request maps to an XML message that the Oracle Adapter supports. For
example, a request for export screening for sales orders is supported by the Order
Compliance Request message. The XML response to the Order Compliance Service
Request is termed as Export Compliance Response message. A separate DTD is
provided for the response message.

Intlptnrint.doc Oracle Confidential - For internal use only 6


Oracle International Trade Management Partner Integration Specifications

Messaging
The ITM adapter supports XML based synchronous and asynchronous
communication capabilities with the partner ITM application. The partner’s trade
management application must be able to provide a web-based listener that accepts an
XML request message from the adapter and provides synchronous acknowledgement.

Item Synchronization
The purpose of the Item Synchronization service request is to communicate key
transaction and setup entities required for Item Synchronization in the partner ITM
application. A synchronous XML acknowledgement in the specified format is
expected from the partner application. The request DTD, its structure and element
description is provided in Appendix A. The acknowledgment XML details are
provided in Appendix F.

Internet/LAN/WAN
Item Synchronization Request XML
Oracle
Bill of Oracle Partner ITM
Material ITM Adapter Synchronous Acknowledgement Application

Fig 4: Item Synchronization – Overview Messaging

Party Synchronization
The purpose party synchronization service request is to communicate key transaction
and setup entities required for party based screenings in the partner ITM application.
OAG’s 007_sync_customer_005.dtd (Revision 7.2.1) DTD is used for the request
XML. A synchronous XML acknowledgement in the specified format is also expected
from the partner application. The request DTD, its structure and element description is
provided in Appendix B. The acknowledgment XML details are provided in
Appendix F.

Internet/LAN/WAN

Party Synchronization Request XML


Oracle Oracle Partner ITM
Synchronous Acknowledgement Application
TCA ITM Adapter

Fig 5: Party Synchronization – Overview Messaging

Intlptnrint.doc Oracle Confidential - For internal use only 7


Oracle International Trade Management Partner Integration Specifications

Order Compliance Screening


The purpose of order compliance request is to communicate key transaction and setup
entities required for export compliance screenings in the partner ITM application for
sales orders. The request is designed to support all the relevant attributes to perform
all the export compliance checks. The request DTD, its structure and element
description is provided in Appendix C. A synchronous acknowledgement is expected
for the request XML. The acknowledgment XML details are provided in Appendix F.

The partner ITM application responds with an overall export compliance status for the
order line via Export Compliance Response XML asynchronously. A synchronous
HTML acknowledgment is provided by the Oracle XML gateway on receiving the
response XML. Additionally, Oracle XML Gateway can be setup to provide an XML
based asynchronous acknowledgement. The response DTD, its structure and element
description is provided in Appendix D.

Internet/LAN/WAN

Order Compliance Request XML


Generic Export Compliance Oracle
Synchronous Acknowledgement
ITM Adapter
Oracle
Partner ITM
Order
Application
Management
Asynchronous Exp. Comp. Response XML

Synchronous HTML Acknowledgement


Oracle
XML Gateway Optional Asynchronous XML Acknowledgement

Fig 6: Export Compliance for Sales Orders – Overview Messaging

Delivery Compliance Screening


The purpose of delivery compliance request is to communicate key transaction and
setup entities required for export compliance screenings in the partner ITM
application for delivery. The request is designed to support all the relevant attributes
to perform all the export compliance checks. The request DTD, its structure and
element description is provided in Appendix E. A synchronous acknowledgement is
expected for the request XML. The acknowledgment XML details are provided in
Appendix F.

The partner ITM application responds with an overall export compliance status for the
order line via Export Compliance Response XML asynchronously. A synchronous
HTML acknowledgment is provided by the Oracle XML gateway on receiving the
response XML. Additionally Oracle XML Gateway can be setup to provide an XML
based asynchronous acknowledgement. The response DTD, its structure and element
description is provided in Appendix D.

Intlptnrint.doc Oracle Confidential - For internal use only 8


Oracle International Trade Management Partner Integration Specifications

Internet/LAN/WAN

Delivery Compliance Request XML


Generic Export Compliance Oracle
Synchronous Acknowledgement
ITM Adapter
Oracle
Partner ITM
Shipping
Application
Execution
Asynchronous Exp. Comp. Response XML

Synchronous HTML Acknowledgement


Oracle
XML Gateway
Optional Asynchronous XML Acknowledgement

Fig 7: Export Compliance for Deliveries – Overview Messaging

Table 1 and Table 2 below summarizes each the ITM service request and its
corresponding request and response XML messages:

Request DTDs Supported

International Trade Service Request DTD DTD Details


Item Synchronization Item Synchronization Request XML Appendix A
Party Synchronization Party Synchronization Request XML Appendix B
Order Export Compliance Order Compliance Request XML Appendix C
Delivery Export Compliance Delivery Compliance Request XML Appendix D

Table 1: International Trade Service Request by DTDs

Response DTDs Supported

International Trade Service Response DTD DTD Details


Export Compliance Response Export Compliance Response XML Appendix E

Table 2: International Trade Service Response by DTDs

Intlptnrint.doc Oracle Confidential - For internal use only 9


Oracle International Trade Management Partner Integration Specifications

Service Request Grouping


The ITM partner integration provides a user configurable parameter for bundling a
group of request together in a single XML message. In the case of sales order
integration, a response is expected for each of the order line. For shipments, a
response is expected for each delivery. The partner ITM application may also group
several individual responses in a single XML message with individual responses for
each transaction reference.

Print Queues
The trade documents are generated, printed and delivered in the partner ITM
application. All the printing related tasks including printer/format determination are
managed by the partner application. The document audit trail is also maintained in the
partner application.

Transaction Delivery

Both secured and unsecured transaction delivery methods are supported. Oracle’s
Adapter supports standard http as well as secure (SSL) connections over https to the
partner’s trade management server.

User Interface

Oracle’s Adapter can be configured for the outbound messages forwarded to the
partner application. The ITM Adapter provides user interface for defining the
necessary and optional attributes. The attributes can be defined at several levels
including ITM Application, Service etc. A service request XML includes the relevant
attributes for the ITM service. The following forms are provided:

ITM Partner Setup Form


The form provides for setting up the preferences for the partner ITM application and
supported services. The ITM application level setup include:

• ITM Application Vendor/Service Provider Name

• Contact Name

• Contact Email

• Vendor URL

• Name-Value pairs of parameters (Each ITM application may have multiple


parameters e.g. Request Version, Request Language)

Intlptnrint.doc Oracle Confidential - For internal use only 10


Oracle International Trade Management Partner Integration Specifications

The following fields are provided for a service in the ITM application:

• Service Type

• URL

• Port

• Protocol (HTTP/HTTPS)

• Certificate (for Secure HTTS)

• Certificate Store

• Certificate Password

• Service Priority

• Name-Value pair of parameters (Each service will have multiple parameters


e.g. Service Handler, Service Version, Threshold)

Fig 8: ITM Partner Setup Form

Partner ITM Application User Preferences


A set up form is provided for users of Oracle Applications to store their trade
management application login information. Oracle Applications customers or Oracle
Exchange operators will be able to store their third party trade application user ID and

Intlptnrint.doc Oracle Confidential - For internal use only 11


Oracle International Trade Management Partner Integration Specifications

password using this form. An Oracle Application User/Organization may have a User
ID/password for the entire company/operation, at a organization level or at a
application user level.

Fig 9: ITM Partner Application User Setup Form

ITM Adapter Middle Tier Parameters


Each partner application that communicates with Oracle’s Adapter must pass the
appropriate content to the adapter. The following list includes all of the mandatory
and optional parameters:

• Output Directory

• Log file Directory

• Set Proxy

• Proxy Host

• Proxy Port

• Polling Frequency

• Task Size

• Maximum DB Connections

• Minimum DB Connections

• DB Connection Timeout

• DB Connection Idle Time

• Minimum Threads

Intlptnrint.doc Oracle Confidential - For internal use only 12


Oracle International Trade Management Partner Integration Specifications

• Maximum Threads

• Maximum Resubmits on Error

• Thread Maximum Idle Time

• Queue Polling Interval

Fig 10: ITM Adapter Parameter Setup Form

ITM Error Classification Form


The adapter provides the Oracle Application users to classify the error responses from
the partner application. The feature provides the ability for user configurable actions
when the errors are encountered. The errors may be classified into system error, data
error and successful. The following fields are provided in the ITM Error Classification
form:

• ITM Application/Service Provider Name

• Error Type

• Error Code

• Classification

Adapter Administration User Interface


The adapter administration functions are implemented as a standard concurrent request in

Intlptnrint.doc Oracle Confidential - For internal use only 13


Oracle International Trade Management Partner Integration Specifications

Oracle Applications. This enables all the administration tasks for the adapter to be
completed from within the Oracle Applications. The following adapter administrative
tasks are implemented:

Adapter Startup

The processing engine in the adapter need to be active before any trade service
request can be fulfilled. The program ensures that proper environment variables are
set and processes have been started.

Adapter Status Report

This program verifies the status of the adapter’s processing engine and also provides
other valuable information about the pending requests, errors encountered etc.

Skip/Resubmit Service Request

The program allows skipping of service requests in the adapter request queue. These
service requests may be submitted by the calling applications and are either waiting in
the queue, or might have encountered errors in getting a response from the trade
application. The program can be submitted with several parameters including Error
Type, Error Code, Customer, Ship From, Ship-To etc.

Adapter Shut Down

Similar to Adapter Startup, the program is used to shut down the adapter engine.

Batch Programs
The following batch programs are provided to support the partner integration:
Items Synchronization

Item Synchronization program lets you select and send inventory item definitions to
partner ITM application for export classification. Additionally the filtering criteria can
be defined in a custom PL/SQL package.

Intlptnrint.doc Oracle Confidential - For internal use only 14


Oracle International Trade Management Partner Integration Specifications

Fig 11: Item Synchronization Program Parameters

Party Synchronization

Party Synchronization lets you select and send party definitions to partner ITM
application. Additionally the filtering criteria can be defined in a custom PL/SQL
package.

Intlptnrint.doc Oracle Confidential - For internal use only 15


Oracle International Trade Management Partner Integration Specifications

Fig 12: Party Synchronization Program Parameters

Submit Delivery for Export Screening

Submit deliveries for export screening lets you submit deliveries for compliance
screening to partner ITM application. The program offers a range of parameters to
select the appropriate deliveries for screening. Additionally, a filter criterion can also
be defined in a custom PL/SQL package.

Intlptnrint.doc Oracle Confidential - For internal use only 16


Oracle International Trade Management Partner Integration Specifications

Fig 13: Submit Deliveries for Screening Program Parameters

Message Formats
Oracle’s Adapter supports XML-based communication with the partner’s trade
management application. Oracle XSU and XSLT are used for XML request
generation and maintenance.

Scalability Features

Oracle’s Adapter leverages a multi-threaded Java based middle-tier. It supports


interface scanning, polling request batch mechanism, task queuing and a thread pool
with configurable worker threads. All the components of the middle-tier are
configurable to suit the throughput requirements and hardware constraints of the
installation site. The adapter also features

• Database Connection Pool for efficient management of database resources.

Intlptnrint.doc Oracle Confidential - For internal use only 17


Oracle International Trade Management Partner Integration Specifications

• Middle-tier Configuration Screen.

Phasing
Supporting the international trade services in key business flows involve developing
the generic integration capabilities for individual ITM services as well as embedding
the ITM services in the core transaction application. The ITM adapter plans to support
access to several international trade services individually as well as combined together
in a single request. These services can be embedded seamlessly into multiple Oracle
Applications. Oracle Applications development has taken a phased approach in
providing these capabilities and export requirements are targeted for the current
phase. The figure 3 below represents some of the key applications targeted for the
initial phase along with the services planned to be supported from the respective
application:

Internet/LAN/WAN
Oracle TCA
Oracle BOM
Party Synchronization
Item Synchronization
ITM
Application
Sales/Quotes/Contracts Export Compliance Screening
and other Applications

Oracle Order Oracle


Export Compliance Screening ITM
Management
Partner
Integration

Oracle Shipping Export Compliance Screening


Execution

ITM
Oracle Purchasing/ Import Compliance Screening Application
iProcurement

Import Compliance Screening

Oracle Payables

Phase I

Phase II

Fig 14: ITM Services, Integrating Oracle Applications

Oracle Applications development has taken a phased approach in supporting ITM

Intlptnrint.doc Oracle Confidential - For internal use only 18


Oracle International Trade Management Partner Integration Specifications

integration with specific Applications. Exports controls are targeted for the current
phase. The following ITM services are planned for this phase:
• Item Synchronization
• Party Synchronization
• Export Compliance Screening

The table below lists down the integrating Oracle Applications for each of the above
ITM services and the business processes they are:

ITM Service/Integrating Oracle Applications Business Processes

Item Synchronization
Oracle Bill of Material (BOM) Entry/Update of Items using batch process
Party Synchronization
Oracle Trading Community Architecture (TCA) Entry/Update of Parties using batch process
Export Compliance Screening
Oracle Order Management (OM) Sales Orders Booking
Oracle Shipping (WSH) Pick and Ship Processes

Table 3: Summary of ITM Services and Integrating Oracle Applications

Intlptnrint.doc Oracle Confidential - For internal use only 19


Oracle International Trade Management Partner Integration Specifications

Partner Requirements

The following are some of the key requirements for the partner ITM application to be
able to integrate with Oracle ITM adapter.

• Web based Listener

• Asynchronous/Synchronous XML Response

• Ability to process inbound request XML in Oracle’s published DTD

• Ability to produce a valid response XML in Oracle’s published DTD

Intlptnrint.doc Oracle Confidential - For internal use only 20


Oracle International Trade Management Partner Integration Specifications

Assumptions

The proposed generic integration with the ITM application is based on the following
assumptions:

• The ITM application supports XML based integration.

• Oracle ITM Adapter manages all the communication with the partner’s ITM
application.

• Though the adapter provides an extensible data element support for a


specific ITM service, any alterations to the element data size have to be
resolved by the partner ITM application.

• The time to respond to an XML request depends on the performance of the


ITM application/service provider. The ITM application would adhere to
performance standards thereby facilitating the overall response time for the
integration.

Intlptnrint.doc Oracle Confidential - For internal use only 21


Oracle International Trade Management Partner Integration Specifications

Process Flows

Item Synchronization
The ITM adapter generates and transmits the Item Synchronization Service Request
XML to the partner application. A synchronous handshake is expected from the ITM
application for the sake of acknowledgement. The Item Synchronization request XML
contains all the necessary data elements required for export classification. There is no
response back from the ITM application after the items are classified. The diagram
below represents the Item Synchronization process flow between Oracle Applications
and partner ITM application:

Intlptnrint.doc Oracle Confidential - For internal use only 22


Oracle International Trade Management Partner Integration Specifications

Submit Items
for Export
Classification
Program

Any more items


No
in the range

Yes

Export Item?
(based on No
filter criteria)

Yes
XML Transmission to
Interface Tables
XML Generation ITM Application and Receive XML
Populated
(Oracle ITM Receive Message and
(Oracle ITM
Adapter) Acknowledgement Acknowledge
Adapter)
(Oracle ITM Adapter)

No Item
Ack. created/ HS and Notify
Received? updated in ECCN Yes Compliance
ITM needed? User
Application

Yes
No

Partner ITM
Oracle Applications
Application

Fig 15: Item Synchronization Integration Flow Diagram

Party Synchronization
The ITM adapter generates and transmits the party synchronization request XML to
the partner application. A synchronous acknowledgement is expected from the ITM
application. The party synchronization request XML contains all the necessary data
elements required for all party based export screenings. There is no response back
from the ITM application. If any of the party is determined to be a restricted party in
the ITM application, it needs to be handled manually in Oracle Application. All the
existing transactions i.e. orders and shipments may need to be canceled manually
along with customer de-activation. The diagram below represents party
synchronization process flow between Oracle Applications and partner ITM
application:

Intlptnrint.doc Oracle Confidential - For internal use only 23


Oracle International Trade Management Partner Integration Specifications

Submit Parties
for Party
Synchronization
Program

Any more party


No
in the range

Yes

Export
Party?(based
on filter No
criteria)

Yes Export
Screening in
Interface XML Transmission to ITM
XML
Tables ITM Application and Receive XML Application
Generation
Populated Receive Message and
(Oracle ITM
(Oracle ITM Acknowledgement Acknowledge
Adapter)
Adapter) (Oracle ITM Adapter)
Notify
Restricted
Yes Compliance
Party?
No User
Party
Ack.
created/
Received? No
updated in
ITM Export
Application Compliance
Yes User
Review

Flag Party
as NOT a Restricted
No
restricted Party ?
Party
Yes

Manually Flag Party


Inactivate as a
the Party restricted
in Oracle Party

Oracle Partner ITM


Applications Application

Fig 16: Party Synchronization Integration Flow Diagram

Order Compliance Screening


Booking of a new export order submits an export compliance request to the ITM
adapter. The ITM adapter generates and transmits the export compliance service
request XML to the partner application. A synchronous acknowledgement is expected
from the ITM application. The export compliance request XML contains all the
necessary data elements required for all export related compliance checks.

The partner ITM application evaluates the sales order lines for export compliance and
responds to Oracle Applications with the overall compliance pass or fail status for
each of the order line. The export compliance is evaluated individually for each order
line. If an order line is found to be compliant by the partner application, it responds

Intlptnrint.doc Oracle Confidential - For internal use only 24


Oracle International Trade Management Partner Integration Specifications

back to Oracle Application with compliant (compliance=Pass) status for the order
line. The asynchronous response is received by Oracle XML gateway and a
synchronous HTML acknowledgement is provided to the partner application. Oracle
XML Gateway can also be setup to provide an asynchronous XML acknowledgement.

The XML gateway passes the response information to the ITM adapter, which in turn
removes the order line block. If any of the order line is determined to be non
compliant (compliance=Fail), the ITM adapter places the sales order line on hold.
Users will need to manually cancel these order lines depending upon their business
processes. In case, the ITM application is unable to evaluate the compliance of the
order line programmatically, the ITM application notifies the compliance users for a
manual compliance review. A response is not communicated back to Oracle
Application until a final compliance determination is made by the compliance user.

The diagram below represents the export compliance process flow between Oracle
Applications and partner ITM application:

Intlptnrint.doc Oracle Confidential - For internal use only 25


Oracle International Trade Management Partner Integration Specifications

Sales Order Line


Scheduled
(Oracle Order Mgt.) Partner ITM
Oracle Applications
Application
Export Compliance
Activity
(Oracle Order Mgt.)

XML Transmission to
Export
XML Generation ITM Application and Receive XML Run all export Export Notify
Block Order Line Compliance
(Oracle ITM Receive Message and rules for the Compliance No Compliance User
Workflow Activity
Adapter) Acknowledgement Acknowledge order line Pass? User
Review
(Oracle ITM Adapter)

No
Ack.
Interface Tables Received?
Populated Export
(Oracle ITM Yes Yes No Compliance
Adapter) Fail?
No

Async. XML Response


Receive XML to
Remove the
Message and Oracle Ack.
Order Line Yes
Acknowledge (Compliance=Pass) Received?
Workflow block
(XML Gateway) and Receive
Acknowledgement

Yes
No
Async. XML Response
Receive XML to
Place the Order Message and Oracle Ack.
Yes
Line on Hold Acknowledge (Compliance=Fail) Received?
(XML Gateway) and Receive
Acknowledgement

Fig 17: Order Export Compliance - Integration Flow Diagram

Intlptnrint.doc Oracle Confidential - For internal use only 26


Oracle International Trade Management Partner Integration Specifications

Custom API Callout for Order Screening


The following custom APIs are supported for order screening:

Pre-processing Custom API

A pre-process custom API is provided for order export screening. This API can be used by for any
pre-processing and massaging of data in ITM’s interface tables. The pre-processing API can also
be used to populate additional attributes i.e. the Name and Value pairs provided in the
USERAREA of the message. These could be any other attributes, which you may need for export
screening and are not provided in the seeded message.

API Name:

WSH_ITM_CUSTOM_PROCESS.PRE_PROCESS_ONT_REQUEST

Post-Processing Custom API

A post-process custom API is provided for Order export screening. This API can be used by for
any post-processing and massaging of data once it’s interfaced in ITM’s interface tables. This call
out is made in WSH_ITM_CUSTOM_PROCESS package.

WSH_ITM_CUSTOM_PROCESS.POST_PROCESS_ONT_REQUEST

Delivery Compliance Screening


Export compliance screening may be performed at delivery creation and at Ship Confirmation.
When the export compliance is requested for a delivery, an export compliance request is submitted
to the ITM adapter’s interface tables. The ITM adapter generates and transmits the export
compliance service request XML to the partner application. A synchronous acknowledgement is
expected from the ITM application. The export compliance request XML contains all the
necessary data elements required for all export related compliance checks for the delivery.

The partner ITM application evaluates the delivery for export compliance and responds to Oracle
Applications with the overall compliance pass or fail status for the delivery. The export
compliance is evaluated for delivery as a whole. If a delivery is found to be compliant by the
partner application, it responds back to Oracle Application with compliant (compliance=Pass)
status. The asynchronous response is received by Oracle XML gateway and a synchronous HTML
acknowledgement is provided to the partner application. Oracle XML Gateway can also be setup
to provide an asynchronous XML acknowledgement.

The XML gateway passes the response information to the ITM adapter, which in turn handles the
exception, originally logged against the delivery to prevent ship confirmation. If a delivery is
determined to be non compliant (compliance=Fail), the ITM adapter logs compliance failure
exception against the delivery. Users will need to manually cancel these deliveries depending upon
their business processes. In case, the ITM application is unable to evaluate the compliance of a
delivery programmatically, the ITM application notifies the compliance users for a manual
compliance review. A response is not communicated back to Oracle Application until a final
compliance determination is made by the compliance user.

The diagram below represents the export compliance process flow between Oracle Applications
and partner ITM application:

Intlptnrint.doc Oracle Confidential - For internal use only 27


Oracle International Trade Management Partner Integration Specifications

User Submits SRS


program Submit
Deliveries for
Export Screening

All the deliveries with


Partner ITM
Oracle Applications
‘Require Export Application
Screening’ exception
selected

Any more
No
deliveries?

Yes

Log ‘Submitted for XML Transmission to


Receive XML Run all export Export Notify
Export Screening’ XML ITM Application and
Message and rules for Compliance No Compliance
Exception for the Generation Receive
Acknowledge delivery Pass? User
delivery Acknowledgement

No Yes
Handle ‘Require Ack. Export
Export Screening’ Received? Yes Compliance
exception User Review
Ship Hold Release

Interface Tables No
Export
Populated
No Compliance
Fail?
Handle ‘Submitted
Async. XML Response to
for Export Receive XML Message
Oracle Ack.
Screening’ and Acknowledge Yes
(Compliance=Pass) Received?
Exception for the (XML Gateway) Generate
and Receive Acknowledgement Yes
delivery Documents?

No

Yes
No
Handle ‘Submitted
Log ‘Not Compliant Async. XML Response to
for Export Receive XML Message
for Export’ Oracle Ack.
Screening’ and Acknowledge Yes
Exception for the (Compliance=Fail) Received?
Exception for the (XML Gateway)
delivery and Receive Acknowledgement
delivery

Fig 18: Export Compliance for Deliveries – Integration Flow Diagram

Intlptnrint.doc Oracle Confidential - For internal use only 28


Oracle International Trade Management Partner Integration Specifications

Custom API Callout for Delivery Screening


The following custom APIs are supported for order screening:

Pre-processing Custom API

A pre-process custom API is provided for Delivery Export compliance. This


API can be used by for any pre-processing and massaging of data in ITM’s
interface tables. The pre-processing API can also be used to populate additional
attributes i.e. the Name and Value pairs provided in the USERAREA of the
message. These could be any other attributes, which you may need for export
screening and are not provided in the seeded message.

API Name:

WSH_ITM_CUSTOM_PROCESS.PRE_PROCESS_WSH_REQUEST

Post-Processing Custom API

A post-process custom API is provided for Delivery Export compliance. This


API can be used by for any post-processing and massaging of data once it’s
interfaced in ITM’s interface tables. This call out is made in
WSH_ITM_CUSTOM_PROCESS package.

API Name:

WSH_ITM_CUSTOM_PROCESS.POST_PROCESS_WSH_REQUEST

Intlptnrint.doc Oracle Confidential - For internal use only 27


Oracle International Trade Management Partner Integration Specifications

Appendix A - Item Synchronization Request XML

The structure of the Item Synchronization request message is illustrated in the


following diagram:

This diagram illustrates the following attributes of the request message:

• Hierarchy of Elements
Each element is shown as a box in the diagram. Top-to-bottom; left-to-
right. "Parent" elements are shown with "child" elements below them.
Required/Optional elements.
A required element is depicted via solid boxes. An optional element is
depicted via a dashed line.
When an element has attributes or children, it is possible for the (parent)
element to be optional, while the child or attribute is required. This
indicates that when that (parent) element is present, its required attributes
and/or children must also be present
• Repetition of elements.
Two types of relationships are illustrated in this diagram: one-to-one and
one-to-many. One-to-one relationships are represented by a single box.
One-to-many relationships are represented by multiple boxes.

ITEM_SYNC

CNTROLAREA

DATAAREA
Request

ITEM
Request

ITEM_ID

….

USERAREA

Fig 19: Item Synchronization Request Message Structure

Intlptnrint.doc Oracle Confidential - For internal use only 28


Oracle International Trade Management Partner Integration Specifications

Element/Attribute Description Oracle Applications Table.Column_name

1 ITEM
1.1 ITEM_ID Unique Identifier of an Item MTL_SYSTEM_ITEMS_B.inventory_item_id
(Inventory_item_id)
1.2 ITEM_CODE Product Code. Concatenated segments of MTL_SYSTEM_ITEMS_B.segment1..segment15
the Item Flexfield.
1.3 DESCRIPTION Description of the item MTL_SYSTEM_ITEMS_TL.Description
1.4 HAZARD_CLASS Hazard Class Classification PO_HAZARD_CLASSES_TL.
(For
PO_HAZARD_CLASSES_TL.hazard_class_id =
MTL_SYSTEM_ITEMS_B.hazard_class_id)
1.5 ORGANIZATION_ID Organization to which this item is assigned. MTL_SYSTEM_ITEMS_B.Organization_id
1.6 SRC_ORGANIZATION Master Organization of the item. MTL_SYSTEM_ITEMS_B.src_organization_id
_ID
1.7 ITEM_TYPE User Defined Item Type FND_COMMON_LOOKUPS.meaning (for
Lookup_type =’ITEM_TYPE and
FND_COMMON_LOOKUPS.lookup_code =
MTL_SYSTEM_ITEMS_B.item_type
1.8 UNIT_OF_MEASURE Unit of Measure MTL_SYSTEM_ITEMS_B.PRIMARY_UOM_C
ODE
1.9 ITEM_VALUE Value of the Item MTL_SYSTEM_ITEMS_B.LIST_PRICE_PER_
UNIT
1.10 CURRENCY Currency
1.11 COUNTRY Country of the organization to which the HR_LOCATIONS_ALL.Country
item is assigned in Oracle Application. (Select hl.country from hr_all_organization_units
hu, hr_locations hl where hulocation_id =
hl.location_id and hu.organization_id =
MTL_SYSTEM_ITEM_B.Organization_id)
1.12 USERAREA
1.12.1 Long Description of the item MTL_SYSTEM_ITEMS_TL.Long_Description
LONG_DESCRIPTION
1.12.2 OPERATING_UNIT Operating Unit of the Organization to which ORG_ORGANIZATION_DEFINITIONS.Operati
the Item is attached. ng Unit
1.12.3 PARAMETERS This element bounds any additional
parameters to be sent. This element has a
attribute named ‘TYPE’ which can have any
of the following values ‘VENDOR’ or
‘SERVICE’ or ‘DATA’.
VENDOR ---- Vendor Parameters
SERVICE ---- Service Parameters
DATA ---- Additional Data
Information / Flexfield
All the 15 Descriptive Flexfield
attributes(attribute1..atrribute15) of the Item
can be passed as Parameters of Type ‘Data’.
PARAMETER Every Parameter has three attributes ‘Index’ Parameters of type ‘VENDOR’
, ‘Name’ and ‘Value’ WSH_ITM_VENDOR_PARAMETERS.Parmeter
_name,
WSH_ITM_VENDOR_PARAMETERS.Parmeter
_value
Parameters of type ‘SERVICE’

WSH_ITM_SERVICE_PARAMETERS.Prameter
_name,
WSH_ITM_SERVICE_PARAMETERS.Prameter
_value
Parameters of type ‘DATA’
MTL_SYSTEM_ITEMS_B.attribute1..attribute15

Table 4: Element Description of Item Synchronization Request Message

Intlptnrint.doc Oracle Confidential - For internal use only 29


Oracle International Trade Management Partner Integration Specifications

Element/Attribute Description

CONTRLAREA
BSR
VERB The Verb is the actual service to be performed. (SYNC)
NOUN The Noun indicates the object the service is to be performed on(ITEM)
REVISION
SENDER
LOGICALID logical location of the server and application from which the message originated.
(ORACLE)
COMPONENT business application that issued the message (ITM Application))
TASK Event that initiated this message (Item Synchronization)
REFERENCEID Reference Identifier (Message Id)
CONFIRMATION Whether Confirmation is required or not
LANGUAGE Language code. The entire message is sent in this language. Basically the base language of
the installation.
CODEPAGE Character set
AUTHID User Name-Password

Table 5: Element description of Control Area Elements of Item


Synchronization Request

Intlptnrint.doc Oracle Confidential - For internal use only 30


Oracle International Trade Management Partner Integration Specifications

Appendix B - Party Synchronization Request XML


OAG’s 007_sync_customer_005.dtd (Revision 7.2.1) DTD is leveraged for the
party synchronization request. Userarea has been extended to include the
additional elements. For a description of these elements refer to the table 5.
oracle_sync_customer_005.dtd contains the userarea extensions. The structure
of the party synchronization request message is illustrated in the following
diagram:

This diagram illustrates the following attributes of the request message:

• Hierarchy of Elements
Each element is shown as a box in the diagram. Top-to-bottom; left-to-
right. "Parent" elements are shown with "child" elements below them.
Required/Optional elements.
A required element is depicted via solid boxes. An optional element is
depicted via a dashed line.
When an element has attributes or children, it is possible for the (parent)
element to be optional, while the child or attribute is required. This
indicates that when that (parent) element is present, its required attributes
and/or children must also be present
• Repetition of elements.
Two types of relationships are illustrated in this diagram: one-to-one and
one-to-many. One-to-one relationships are represented by a single box.
One-to-many relationships are represented by multiple boxes.

SYNC_CUSTOMER_005

CNTROLAREA

DATAAREA

SYNC_CUSTOMER

PARTNER

ADDRESS

USERAREA
CONTACT

USERAREA

ATTCHREF

USERAREA Note:
Required = Solid boxes
Optional = Dashed boxes

Intlptnrint.doc Oracle Confidential - For internal use only 31


Oracle International Trade Management Partner Integration Specifications

Fig 20: Party Synchronization Request Message Structure

(The element ATTCHREF in the above figure is not sent.)

The following table describes all the elements which would be sent under the
PARTNER element of the party synchronization request
Element/Attribute Description Oracle Applications
Table.Column_name

1.1 NAME Name of the partner HZ_PARTIES.party_name


1.2 PARTNRID PARTNRID is the identifier of the partner that the HZ_CUST_SITE_USES_ALL.Site_use_
PARTNRTYPE defines. (Site Use Id in Oracle Applications) id
1.3 PARTNRTYPE PARTNRTYPE indicates the type of partner entity or the FND_LOOKUPS.meaning (For
site use code. FND_LOOKUPS.code =
HZ_CUST_SITE_USES.Site_Use_Code
Valid values are: = fnd_lookups.lookup_code)
Bill To - The customer location where the invoice goes to.
Ship To - Location of the customer where goods are sent.
Sold To - The customer who is responsible for ordering the
goods or services.
Drawee - A customer drawee is a customer account site
responsible for paying bills.
Dunning – The location where the customer’s dunning
letters are sent.
Invoices
Legal : This address acts as the customer account’s legal site.
A legal site is responsible for all government reporting
requirements.
Marketing - Marketing collateral is sent to this address.
Self Service User
Statements – The Customer location where the customers
statements are sent.
Bills of Lading
Credit Memos
Credit Contact
Deliver To
Acknowledgments

1.4 NAME Account Name and Alternate Name HZ_CUST_ACCOUNTS.Account_name


,
1.5 PARTNRIDX PARTNRIDX is the identifier of the partner that the HZ_CUST_ACCOUNTS.Account_Num
receiving application may use to identify the PARTNER. ber

Synonyms
Customer Number
Supplier Number
Customer ID
Supplier ID
The Customer Number will be sent here.
1.6 TAXID TAXID is the tax identifier of the business partner. Hz_parties.tax_reference

Synonyms
VAT ID
Federal Tax ID
State Tax ID
1.7 USERAREA PARTNER LEVEL
1.7.1 Site Number HZ_PARTY_SITES.Party_Site_Number
SITE_NUMBER
1.7.2 OPERATING_UNI Operating Unit HZ_Cust_Acct_sites_all.OrgID
T
1.7.3 This element bounds any additional parameters to be sent.
PARAMETERS This element has an attribute named ‘TYPE’ which can have

Intlptnrint.doc Oracle Confidential - For internal use only 32


Oracle International Trade Management Partner Integration Specifications

Element/Attribute Description Oracle Applications


Table.Column_name

any of the following values ‘VENDOR’ or ‘SERVICE’ or


‘DATA’.
VENDOR ---- Vendor Parameters
SERVICE ---- Service Parameters
DATA ---- Additional Data Information /
Descriptive Flexfield Information
All the Descriptive Flexfield
attributes(attribute1..attribute15) of the Customer, Contact
(Open Issue 29)can be passed as Parameters of Type ‘Data’.
1.7.3.1 PARAMETER Every Parameter has attributes ‘Index’, ‘Name’ and ‘Value’ Parameters of type ‘VENDOR’
WSH_ITM_VENDOR_PARAMETERS.
Parmeter_name,
WSH_ITM_VENDOR_PARAMETERS.
Parmeter_value
Parameters of type ‘SERVICE’
WSH_ITM_SERVICE_PARAMETERS.
Prameter_name,
WSH_ITM_SERVICE_PARAMETERS.
Prameter_value
Parameters of type ‘DATA’
HZ_CUST_ACCOUNTS.Attribute1..15

1.8 ADDRESS The Data Type “ADDRESS” represents the data concerning
the location of the business partner.
1.8.1 ADDRLINE ADDRLINE represents the lines needed to describe street HZ_LOCATIONS.ADDRESS1..ADDRE
address or post office box information. SS4
1.8.2 ADDRTYPE ADDRTYPE represents a qualification of the address of the HZ_CUST_SITE_USES_ALL.Primary_
business partner Flag
1.8.3 CITY CITY is the city or town of the business partner. HZ_LOCATIONS.CITY
1.8.4 COUNTRY COUNTRY represents the country within an address. The HZ_LOCATIONS.COUNTRY
list of valid codes can be found in ISO Standard number
3166.
1.8.5 POSTALCODE POSTALCODE is the postal code within a mailing address. HZ_LOCATIONS.POSTAL_CODE

Synonyms
Zip code
1.8.6 STATEPROVN STATEPROVN is the state or province within the mailing HZ_LOCATIONS.STATE
address.
1.8.7 USERAREA ADDRESS LEVEL
1.8.7.1 This element bounds any additional parameters to be sent.
PARAMETERS This element has an attribute named ‘TYPE’ which has
value
DATA ---- Additional Data Information /
Descriptive Flexfield Information
All the Descriptive Flexfield
attributes(attribute1..attribute15) of the Customer Site Level
can be passed in this region.
1.8.7.1. PARAMETER Every Parameter has attributes ‘Index’, ‘Name’ and ‘Value’ HZ_CUST_ACCT_SITES_ALL.attribute
1 1..15
1.9 CONTACT The Data Type “CONTACT” represents people associated
with the PARTNER and various ways to contact them, such
as telephone or fax.
1.9.1 NAME First Name and the Last Name HZ_PARTIES.Party_name (Having a
record in
HZ_PARTY_RELATIONSHIPS with
relationship_type = ‘CONTACT_OF’
1.9.2 CONTCTTYPE describes the contact person’s
CONTCTTYPE responsibilities.
Synonyms
Job Title
1.9.3 EMAIL EMAIL is the electronic mail address for the CONTACT. HZ_CONTACT_POINTS.Email
1.9.4 FAX FAX is the facsimile telephone number. HZ_CONTACT_POINTS.PHONE_NU
MBER
(With Phone_Line_Type = ‘FAX’)
1.9.5 TELEPHONE HZ_CONTACT_POINTS.PHONE_NU
MBER

Intlptnrint.doc Oracle Confidential - For internal use only 33


Oracle International Trade Management Partner Integration Specifications

Element/Attribute Description Oracle Applications


Table.Column_name

(With Phone_Line_Type = ‘PHONE’)

1.9.6 USERAREA CONTACT LEVEL


1.9.6.1 This element bounds any additional parameters to be sent.
PARAMETERS This element has an attribute named ‘TYPE’ which has
value
DATA ---- Additional Data Information /
Descriptive Flexfield Information
All the Descriptive Flexfield
attributes(attribute1..attribute15) of the Customer Contact or
Site Contact can be passed in this region.
1.9.6.1. PARAMETER Every Parameter has attributes ‘Index’, ‘Name’ and ‘Value’ HZ_PARTIES.attribute1..15 (Having a
1 record in
HZ_PARTY_RELATIONSHIPS with
relationship_type = ‘CONTACT_OF’

Table 6: Element description of Party Synchronization Request Message

Element/Attribute Description

CONTRLAREA
BSR
VERB The Verb is the actual service to be performed. (SYNC)
NOUN The Noun indicates the object the service is to be performed
on(CUSTOMER)
REVISION
SENDER
LOGICALID logical location of the server and application from which the message
originated. (ORACLE)
COMPONENT business application that issued the message (ITM Application))
TASK Event that initiated this message (Party Synchronization)
REFERENCEID Reference Identifier (Message Id)
CONFIRMATION Whether Confirmation is required or not
LANGUAGE Language code. The entire message is sent in this language. Basically the
base language of the installation.
CODEPAGE Character set
AUTHID User Name-Password

Table 7: Element description of Control Area Elements of Party


Synchronization request

Intlptnrint.doc Oracle Confidential - For internal use only 34


Oracle International Trade Management Partner Integration Specifications

Appendix C – Order Compliance Request XML

The following message is leveraged for order compliance request XML. This
diagram illustrates the following attributes of the request message:

• Hierarchy of Elements
Each element is shown as a box in the diagram. Top-to-bottom; left-to-
right. "Parent" elements are shown with "child" elements below them.
Required/Optional elements.
A required element is depicted via solid boxes. An optional element is
depicted via a dashed line.
When an element has attributes or children, it is possible for the (parent)
element to be optional, while the child or attribute is required. This
indicates that when that (parent) element is present, its required attributes
and/or children must also be present
• Repetition of elements.
Two types of relationships are illustrated in this diagram: one-to-one and
one-to-many. One-to-one relationships are represented by a single box.
One-to-many relationships are represented by multiple boxes.
REQUEST

CONTROL AREA

DATA AREA

MESSAGE_ID

ADMIN

PARAMETERS

ADDL_INFO

ORDER_LINE

TRANSACTION_KEY

ORDER_NUMBER

ORDER_LINE

ITEM_ID

PARTY

Intlptnrint.doc Oracle Confidential - For internal use only 35


Oracle International Trade Management Partner Integration Specifications

Fig 21: Order Compliance Request Message Structure

XML Fields Tables Note Mand


atory
Order Represents the Order line information. Every Order line would Contains the Order Header Y
map to one Order Tag and multiple Order Tags would be Information.
present in a message for same Order Number.
OE_ORDER_HEADERS_ALL.ORDER_NUMBER Order Number Y
OE_ORDER_HEADERS_ALL.ORDER_TYPE Order Type Y
OE_ORDER_HEADERS_ALL.ORG_ID Operating Unit Y
OE_ORDER_HEADERS_ALL.CUST_PO_NUM Purchase Order Number N
OE_ORDER_HEADERS_ALL.TRANSACTIONAL_CURR_ Currency N
CODE
OE_ORDER_HEADERS_ALL.CONVERSION_TYPE_COD Conversion N
E
OE_ORDER_HEADERS_ALL.CONVERSION_RATE Conversion Rate N
OE_ORDER_HEADERS_ALL.ORDERED_DATE Date of Order N
<order_line_number> From OE_ORDER_LINES_ALL concatenation of Order Line Number
(LINE_NUMBER.SHIPMENT_NUMBER.OPTION_NUMBE
R.COMPONENT_NUMBER.SERVICE_NUMBER)
<top_model_line_id> OE_ORDER_LINES_ALL.TOP_MODEL_LINE_ID Top Model Line ID
<split_from_line_id> OE_ORDER_LINES_ALL.SPLIT_FROM_LINE_ID Split From Line ID
<link_to_line_id> OE_ORDER_LINES_ALL.LINK_TO_LINE_ID Link to Line ID
<ato_line_id> OE_ORDER_LINES_ALL.ATO_LINE_ID ATO Line ID
<item_type> OE_ORDER_LINES_ALL.ITEM_TYPE_CODE Item Type Code
<item_code> MTL_SYSTEM_ITEMS_B.SEGMENT1..SSEGMENT15 for Item Number
INVENTORY_ITEM_ID in OE_ORDER_LINES_ALL
<ship_from_org_code> Ship From Organization Code

OE_ORDER_LINES_ALL.SHIPPING_METHOD_CODE Ship Method N


OE_ORDER_LINES_ALL.REQUEST_DATE Request Date N
OE_ORDER_LINES_ALL.FREIGHT_TERMS_CODE Freight Terms N
RA_TERMS_TL.NAME (Name of the payment terms) N
OE_ORDER_HEADERS_ALL.PAYMENT_TERM_ID Payment Terms N
OE_ORDER_LINES.ORDERED_QUANTITY * Quantity Ordered N
OE_ORDER_LINES_ALL.UNIT_SELLING_PRICE Selling Price N
OE_ORDER_LINES_ALL.LINE_NUMBER Line Number Y
OE_ORDER_LINES_ALL.UNIT_LIST_PRICE N
OE_ORDER_LINES_ALL.UNIT_SELLING_PRICE N
ITEM_ID Item ID, which 3rd Party Y
Partner application can
recognize as a primary key.
PARTY Same as currently used Party for Denied Party Y
<descriptive_flexfield> WSH_ITM_REQUEST_CONTROL.ATTRIBUTE1-15 Order Line Descriptive
<attribute1 to 15> Flexfield
HZ_CUST_ACCOUNTS.ACCOUNT_NUMBER Customer Number
<party_id> Identification From Adapter Y
<type> Type – like SHIP_FROM, PTNR_SHIP_TO, DELIVER To, N
Sold To, intermediate Ship To
The party type is just an informatory field, which doesn’t have
any functional significance for provider. Adapter can send any
thing, which is populated by application. So application can
maintain any codes/lookups for this.

HZ_CUST_SITE_USES_ALL.SITE_USE_ID Site Use ID


HZ_CUST_SITE_USES_ALL. LOCATION Site Use Code
<name> Party Name N
<address1> Address 1 N
<address2> Address 2 N
<address3> Address 3 N
<address4> Address 4 N
<address5> Address 5 N
<city> City N
<state_or_province> State N
<country> Country N
<code> Country Code N

Intlptnrint.doc Oracle Confidential - For internal use only 36


Oracle International Trade Management Partner Integration Specifications

<name> Country Name N


<postal_code> Postal Code N
<contact_name> Contact Name N
<email> e-mail N
<phone> Phone N
<fax> Fax N
<web> www URL N
<addl_info> Additional Info to include DFFs and other extra parameters N

Table 8: Element description of Order Compliance Request Message

Element/Attribute Description

CONTRLAREA
BSR
VERB The Verb is the actual service to be performed. (SYNC)
NOUN The Noun indicates the object the service is to be performed
on(CUSTOMER)
REVISION
SENDER
LOGICALID logical location of the server and application from which the message
originated. (ORACLE)
COMPONENT business application that issued the message (ITM Application))
TASK Event that initiated this message (Party Synchronization)
REFERENCEID Reference Identifier (Message Id)
CONFIRMATION Whether Confirmation is required or not
LANGUAGE Language code. The entire message is sent in this language. Basically the
base language of the installation.
CODEPAGE Character set
AUTHID User Name-Password

Table 9: Element description of Control Area Elements of Order Request


XML

Intlptnrint.doc Oracle Confidential - For internal use only 37


Oracle International Trade Management Partner Integration Specifications

Appendix D – Export Compliance Response XML

The purpose Export Compliance response XML is to receive the overall export
compliance status of a transaction (order line/delivery) from the partner ITM
application. The response DTD, its element description and a sample of the
request is provided in Appendix 5. The same message is used from Order
Management as well as Shipping. The structure of the message is illustrated in
the following diagram:

This diagram illustrates the following attributes of the request message:

• Hierarchy of Elements
Each element is shown as a box in the diagram. Top-to-bottom; left-to-
right. "Parent" elements are shown with "child" elements below them.
Required/Optional elements.
A required element is depicted via solid boxes. An optional element is
depicted via a dashed line.
When an element has attributes or children, it is possible for the (parent)
element to be optional, while the child or attribute is required. This
indicates that when that (parent) element is present, its required attributes
and/or children must also be present
• Repetition of elements.

Two types of relationships are illustrated in this diagram: one-to-one and


one-to-many. One-to-one relationships are represented by a single box.
One-to-many relationships are represented by multiple boxes.

EXPORT COMPL RESPONSE

CNTROLAREA

DATAAREA
MESSAGE TRANSACTION_KEY

TRIGERRING_POINT

EXPORT_COMP_RESULT

ERROR

Fig 22: Export Compliance Response Message Structure

Intlptnrint.doc Oracle Confidential - For internal use only 38


Oracle International Trade Management Partner Integration Specifications

Element/Attribute Description

TRANSACTION_KEY Key referencing the Line of transaction. For Order Screening it could be
something like <order_number>-<order_type>-<line_number>.
TRIGGERING_POINT Point of request for the Export Complaince – OM-Booking, Pick Release(?),
Ship Confirm..etc could be used as possible values.
EXPORT_COMP_RESULT
SUCCESS Y/N (Y- Yes, N- Failure)
TYPE Type of Export Compliance Done
DESCRIPTION Free flow text as reason/message for success/failure of the compliance
conducted.
ERROR
CODE
TYPE Type can be All Export Compliance Checks or Denied Party Screening or
Embargo Screening etc. Error Type is also included in case it’s an error.
DESCRIPTION Description of the Error.

Table 10: Element description of Export Compliance Response Message

Intlptnrint.doc Oracle Confidential - For internal use only 39


Oracle International Trade Management Partner Integration Specifications

Appendix E – Delivery Compliance Request XML


The OAG’s SHOW SHIPMENT DTD is used as a basis for this transaction. The
purpose of delivery compliance request XML is to communicate all the
compliance relevant delivery attributes to the partner application.

Reqd Element/Attribute Source (Table.Column Name )

X SHIPMENT.DATETTIME (Document) Sys date time


(required)
X SHIPMENT.DOCUMENTID (Shipment) WSH_TRANSACTIONS_HISTORY.DOCUMENT_ID
(required)
X SHIPMENT.SHIPPERID (required) WSH_NEW_DELIVERIES.INITIAL_PICKUP_LOCATION_ID converted to
code
X SHIPMENT.SYNCID (required) XML: “A” = Add, “D” = Delete
“C” = Change
EDI: “N” for Add, “F” for Delete
SHIPMENT.AMOUNT (DECLAREVAL)
SHIPMENT.AMOUNT (DOCUMENT) (T)
SHIPMENT.AMOUNT (ESTFREIGHT)
SHIPMENT.AMOUNT (FREIGHT) (T) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
SHIPMENT.AMOUNT (ITEM) (T)
SHIPMENT.CARRIER WSH_NEW_DELIVERIES.CARRIER_ID, converted to external value
SHIPMENT.CARRIERSRVLVL WSH_NEW_DELIVERIES.SERVICE_LEVEL, converted to external value
SHIPMENT.COUNTRYDST For wsh_new_deliveries. Ultimate_dropoff_location_id,
Get the country from hz_locations
SHIPMENT.COUNTRYORG
SHIPMENT.DATETIME (CREATION) WSH_NEW_DELIVERIES.CREATION_DATE
SHIPMENT.DATETIME (DELIVACT) WSH_TRIP_STOPS.ACTUAL_ARRIVAL_DATE
SHIPMENT.DATETIME (DELIVSCHED) WSH_NEW_DELIVERIES. .ULTIMATE_DROPOFF_DATE
SHIPMENT.DATETIME (EARLSTSHIP)
SHIPMENT.DATETIME (LOADING)
SHIPMENT.DATETIME (NEEDDELV) WSH_NEW_DELIVERIES. .ULTIMATE_DROPOFF_DATE
SHIPMENT.DATETIME (PROMDELV)
SHIPMENT.DATETIME (PROMSHIP)
SHIPMENT.DATETIME (SHIP) WSH_TRIP_STOPS.ACTUAL_DEPARTURE_DATE
SHIPMENT.DATETIME (SHIPSCHED) WSH_NEW_DELIVERIES.INITIAL_PICKUP_DATE
SHIPMENT.DESCRIPTN WSH_NEW_DELIVERIES.DESCRIPTION
SHIPMENT.DISTCENTER
SHIPMENT.DOCKID
SHIPMENT.DOCTYPE “SHIPMENT REQUEST” for 940
“SHIPMENT ADVICE” for 945

SHIPMENT.DOCUMENTRV “001” for ADD


“002” for DELETE
“003” for CHANGE
SHIPMENT.DROPSHIP
SHIPMENT.EXPORTLIC
SHIPMENT.FRGHTCLS
SHIPMENT.FRGHTTERMS WSH_NEW_DELIVERIES.FREIGHT_TERMS_CODE
SHIPMENT.HAZRDMATL
SHIPMENT.HDRSTATUS
SHIPMENT.IMPORTLIC
SHIPMENT.LOADPOINT
SHIPMENT.NOTES1 – NOTES9
SHIPMENT.OPERAMT (FREIGHT) (T)
SHIPMENT.PARTIALSHP
SHIPMENT.PRIORITY
SHIPMENT.QUANTITY (ESTWEIGHT) WSH_NEW_DELIVERIES.GROSS_WEIGHT
WSH_NEW_DELIVERIES.WEIGHT_UOM

Intlptnrint.doc Oracle Confidential - For internal use only 40


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

SHIPMENT.QUANTITY (LOADINGWT) Calculate using


WSH_NEW_DELIVERIES.GROSS WEIGHT –
WSH_NEW_DELIVERIES.NET WEIGHT
SHIPMENT.QUANTITY (NETWEIGHT) WSH_NEW_DELIVERIES.NET_WEIGHT
WSH_NEW_DELIVERIES.WEIGHT_UOM
SHIPMENT.QUANTITY (SHIPUNIT) WSH_NEW_DELIVERIES.NUMBER_OF_LPN
SHIPMENT.QUANTITY (TOTWEIGHT) WSH_NEW_DELIVERIES.GROSS_WEIGHT
WSH_NEW_DELIVERIES.WEIGHT_UOM
SHIPMENT.QUANTITY (VOLUME) WSH_NEW_DELIVERIES.VOLUME
WSH_NEW_DELIVERIES.VOLUME_UOM
SHIPMENT.ROUTEID
SHIPMENT.RELEASENUM
SHIPMENT.RELEASENUMTOT
SHIPMENT.ROUTETYPE Type of routing.
SHIPMENT.SHIPNOTES WSH_NEW_DELIVERIES.SHIPPING_MARKS
SHIPMENT.SHIPPOINT WSH_NEW_DELIVERIES.ULTIATE_DROPOFF_LOCATION_ID converted
to code
SHIPMENT.SHIPPRIOR
SHIPMENT.SHIPSRVLVL WSH_NEW_DELIVERIES.SERVICE_LEVEL
SHIPMENT.SPECIALHND
SHIPMENT.STAGEPOINT
SHIPMENT.TEMPRATURE (ACTUAL)
SHIPMENT.TEMPRATURE (DELIVERY)
SHIPMENT.TEMPRATURE (LOADING)
SHIPMENT.TRANSMETHD WSH_NEW_DELIVERIES.MODE_OF_TRANSPORT
SHIPMENT.TRANSTERMS WSH_NEW_DELIVERIES.FOB_CODE
SHIPMENT.WAREHOUSE WSH_NEW_DELIVERIES.ORGANIZATION_ID converted to code
SHIPMENT.USERAREA WSH_NEW_DELIVERIES.DELIVERY_NAME
WSH_NEW_DELIVERIES.LOADING_SEQUENCE
WSH_NEW_DELIVERY descriptive flex fields
WSH_TRIPS.VEHICLE_NUM_PREFIX
WSH_TRIPS.VEHICLE_NUMBER
WSH_TRIPS.ROUTE_ID
WSH_TRIPS.ROUTING_INSTRUCTIONS
WSH_TRIP_STOPS.DEPARTURE_SEAL_CODE
WSH_NEW_DELIVERIES.SHIP_METHOD_CODE
NVL(WSH_TRIPS.SHIP_METHOD_CODE,
WSH_NEW_DELIVERIES.SHIP_METHOD_CODE)
WSH_NEW_DELIVERIES.WAYBILL
WSH_ITM_REQUEST_CONTROL.ATTRIBUTEn_NAME/ATTRIBUTEn_VA
LUE
Where n=1 to 20
WSH_ITM_REQUEST_CONTROL.TRIGGERING_POINT
PARTNER.
X PARTNER.NAME1 - If this partner segment is the Ship To segment, get the HZ_PARTIES.NAME
for the WSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_ID
- If this partner segment is the Ship from segment, get the HZ_PARTIES.NAME
for the WSH_NEW_DELIVERIES.ORGANIZATION_ID
- If this partner segment is the Customer segment, get the HZ_PARTIES.NAME
for the WSH_NEW_DELIVERIES.CUSTOMER_ID
- If this partner segment is the Supplier segment, get the HZ_PARTIES.NAME
for the WSH_NEW_DELIVERIES.ORGANIZATION_ID
X PARTNER.ONETIME
X PARTNER.PARTNRID (required) WSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_ID
converted to external value, or
WSH_NEW_DELIVERIES.ORGANIZATION_ID converted to external value.
X PARTNER.PARTNRTYPE (required) PARTNRTYPE indicates the type of partner entity.

Valid values are:


“ShipTo” - The delivery location of the customer.
“BillTo” - The customer location the bill goes to.
“SoldTo” - The customer who is responsible for ordering the goods or services.
Could be at multiple organizational levels.
“Supplier” - The partner who is responsible for providing the goods or services.
Supplier can be at multiple organizational levels.
“Carrier” - The partner responsible for delivering the goods or services.

Intlptnrint.doc Oracle Confidential - For internal use only 41


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

“ShipFrom” - The shipping location of the partner who is responsible for


providing the goods or services. Ship from can be at multiple organizational
levels.
“Intmd_ShipTo” – Intermeidate Ship for the delivery
“FOB”- FOB for the delivery
PARTNER.ACTIVE
PARTNER.CURRENCY WSH_NEW_DELIVERIES.CURRENCY_CODE for the supplier and ship from
partner segments
PARTNER.DESCRIPTN
PARTNER.DUNSNUMBER HZ_PARTIES.DUNS_NUMBER for all partner types
PARTNER.GLENTITYS
PARTNER.NAME2-NAME9
PARTNER.PARENTID
PARTNER.PARTNIDX Could use HZ_PARTIES.DUNS_NUMBER for the HZ_PARITES.PARTY_ID
that matches the Ship From, Ship To, Customer and Supplier segments
PARTNER.PARTNRRATG
PARTNER.PARTNRROLE
PARTNER.PAYMETHOD
PARTNER.TAXEXEMPT
PARTNER.TAXID
PARTNER.TERMID
PARTNER.USERAREA WSH_NEW_DELIVERIES.INTMED_SHIP_TO_LOCATION_ID
WSH_ NEW_DELIVERIES.POOLED_SHIP_TO_LOCATION_ID
HZ_CUST_SITE_USES_ALL.SITE_USE_ID
HZ_CUST_SITE_USES_ALL.LOCATION

PARTNER – ADDRESS.
PARTNER – ADDRESS.ADDRLINE1- Extracted from the HZ_LOCATIONS using the party id that matches the Ship
ADDRLINE9 From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.ADDRTYPE
PARTNER – ADDRESS.CITY Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.COUNTRY Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.COUNTY Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.DESCRIPTN
PARTNER – ADDRESS.FAX1-FAX9 HZ_CONTACT_POINTS.RAW_PHONE_NUMBER for the PARTY_ID, and
CONTACT_POINT_TYPE = “FAX”
PARTNER – ADDRESS.POSTALCODE Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.REGION Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.STATEPROVN Extracted from the HZ_LOCATIONS using the party id that matches the Ship
From, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES or
WSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.
PARTNER – ADDRESS.TAXJRSDCTN
PARTNER – ADDRESS.TELEPHONE1- HZ_CONTACT_POINTS.RAW_PHONE_NUMBER for the PARTY_ID, and
TELEPHONE9 CONTACT_POINT_TYPE = “GEN”
PARTNER – ADDRESS.URL HZ_CONTACT_POINTS.URL for the PARTY_ID and
CONTACT_POINT_TYPE = “GEN”
PARTNER – ADDRESS.USERAREA

PARTNER – CONTACT.
X PARTNER – CONTACT.NAME1 (Required)
PARTNER – CONTACT.CONTCTTYPE
PARTNER – CONTACT.DESCRIPTN
PARTNER – CONTACT.EMAIL
PARTNER – CONTACT.FAX1 - FAX9

Intlptnrint.doc Oracle Confidential - For internal use only 42


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

PARTNER – CONTACT.NAME2 - NAME9 Extracted from the HR_LOCATIONS_ALL using the WSH………ID
PARTNER – CONTACT.TELEPHONE1 -
TELEPHONE9
PARTNER – CONTACT.USERAREA

DOCUMNTREF. We need to send this segment twice – once to represent the ship from delivery
name, and for each ship to purchase order number
X DOCUMNTREF.DOCTYPE (required) “SHIPMENT REQUEST”
X DOCUMNTREF.DOCUMENTID (required) WSH_TRANSACTIONS_HISTORY.Orig_Document_ID

X DOCUMNTREF.PARTNRID (required) WSH_NEW_DELIVERIES.ORGANIZATION_ID converted to code


X DOCUMNTREF.PARTNRTYPE (required) “ShipFrom” - The shipping location of the partner who is responsible for
providing the goods or services. Ship from can be at multiple organizational
levels
DOCUMNTREF.DESCRIPTN
DOCUMNTREF.DOCUMENTRV
DOCUMNTREF.LINENUM
DOCUMNTREF.NOTES1 – NOTES9
DOCUMNTREF.SCHLINENUM
DOCUMNTREF.SUBLINENUM
DOCUMNTREF.USERAREA

SHIPITEM.
X SHIPITEM.ITEM (REQUIRED) WSH_DELIVERY_DETAILS.INVENTORY_ITEM_ID (foreign key to
MTL_SYSTEM_ITEMS)

Derive Item_Number from MTL_SYSTEM_ITEMS


X SHIPITEM.QUANTITY (ITEM) WSH_DELIVERY_DETAILS.REQUESTED_QUANTITY
SHIPITEM.AMOUNT (EXTENDED) (T)
SHIPITEM.AMOUNT (ITEM) (T)
SHIPITEM.COUNTRYORG WSH_DELIVERY_DETAILS.COUNTRY_OF_ORIGIN
SHIPITEM.DISPOSITN
SHIPITEM.EXPORTLIC
SHIPITEM.FRGHTCLS WSH_DELIVERY_DETAILS.FREIGHT_CLASS_CAT_ID converted to
external value
SHIPITEM.FRGHTITEM
SHIPITEM.HAZRDMATL WSH_DELIVERY_DETAILS.HAZARD_CLASS_ID converted to external
value.

Pass it, but may not be used in the inbound side. Extract the data from tables.
This value will be passed in the outbound transaction.
SHIPITEM.IMPORTLIC
SHIPITEM.ITEMDESC WSH_DELIVERY_DETAILS.ITEM_DESCRIPTION
SHIPITEM.ITEMRV WSH_DELIVERY_DETAILS.REVISION
SHIPITEM.ITEM_ID MTL_SYSTEM_ITEMS_B.INVENTORY_ITEM_ID
SHIPITEM.ITEMRVX
SHIPITEM.ITEMX WSH_DELIVERY_DETAILS.CUSTOMER_ITEM_ID
Converted to Item_number by joining to mtl_customer_items
SHIPITEM.LINENUM
SHIPITEM.LOTLEVEL1 – LOTLEVEL2 Moved the mapping to INVDETAIL section.
SHIPITEM.NOTES1 – NOTES9 Notes 1 WSH_DELIVERY_DETAILS.PACKING_INSTRUCTIONS

SHIPITEM.OWNRSHPCDE WSH_DELIVERY_DETAILS.FOB_CODE
SHIPITEM.PACKING
SHIPITEM.PACKINGDESC
SHIPITEM.PARTIALSHIP “0” – means partial shipment not allowed (i.e when ship_set_id is not null)
“1” – means partial shipment is allowed(i.e when ship_set_id is null)
SHIPITEM.QUANTITY (BACKORDERD) Calculate WSH_DELIVERY_DETAILS.REQUESTED_QUANTITY -
WSH_DELIVERY_DETAILS.SHIPPED_QUANTITY for 945 inbound only.
SHIPITEM.QUANTITY (OPEN)
SHIPITEM.QUANTITY (ORDERED) WSH_DELIVERY_DETAILS.SRC_REQUESTED_QUANTITY
SHIPITEM.QUANTITY (SHIPPED) WSH_DELIVERY_DETAILS.SHIPPED_QUANTITY
SHIPITEM.QUANTITY (VOLUME) WSH_DELIVERY_DETAILS.VOLUME
SHIPITEM.QUANTITY (WEIGHT) WSH_DELIVERY_DETAILS.NET_WEIGHT

Intlptnrint.doc Oracle Confidential - For internal use only 43


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

SHIPITEM.SHIPMATLID
SHIPITEM.SHIPNOTES WSH_DELIVERY_DETAILS.SHIPPING_INSTRUCTIONS
SHIPITEM.SHIPPRIOR
SHIPITEM.SHIPMTLDESC

SHIPITEM.UPC
SHIPITEM.USERAREA Use this to store:
WSH_DELIVERY_DETAILS.DELIVERY_DETAIL_ID
(Use ITEMCATID for commodity code – this is WSH_DELIVERY_ASSIGNMENTS.PARENT_DELIVERY_DETAIL_ID
a valid OAG field, but just not on this message). WSH_DELIVERY_DETAILS.SHIP_TOLERANCE_ABOVE
WSH_DELIVERY_DETAILS.SHIP_TOLERANCE_BELOW
WSH_DELIVERY_DETAILS.LOAD_SEQUENCE_NUMBER
WSH_DELIVERY_DETAILS descriptive flexfields
WSH_DELIVERY_DETAILS.SHIP_SET_ID
WSH_DELIVERY_DETAILS.SUBINVENTORY
WSH_DELIVERY_DETAILS.TOP_MODEL_LINE_ID
WSH_DELIVERY_DETAILS.SHIP_MODEL_COMPLETE_FLAG
WSH_DELIVERY_DETAILS.COMMODITY_CODE_CAT_ID converted to
code
WSH_DELIVERY_DETAILS.SHIPMENT_PRIORITY_CODE converted to
“01”, “02”, or “03” for XML,.
WSH_DELIVERY_DETAILS.DELIVER_TO_LOCATION_ID
WSH_DELIVERY_DETAILS.SOURCE_LINE_NUMBER
WSH_DELIVERY_DETAILS.SOURCE_LINE_ID
DOCUMNTREF. We need to send this segment for each customer purchase order number for all the
delivery details on this delivery.
X DOCUMNTREF.DOCTYPE “PURCHASEORDER”We need to send this segment for each customer purchase
(required)DOCUMNTREF. order number for all the delivery details on this delivery.
XX DOCUMNTREF.DOCUMENTID WSH_DELIVERY_DETAILS.CUST_PO_NUMBER “PURCHASEORDER”
(required)DOCUMNTREF.DOCTYPE
(required)
XX DOCUMNTREF.PARTNRID WSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_ID
(required)DOCUMNTREF.DOCUMENTID converted to external value for for Customer
(required) POWSH_DELIVERY_DETAILS.CUST_PO_NUMBER
XX DOCUMNTREF.PARTNRTYPE “ShipTo” - The delivery location of the
(required)DOCUMNTREF.PARTNRID customerWSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_ID
(required) converted to external value for for Customer PO
X DOCUMNTREF.DESCRIPTNDOCUMNTRE “ShipTo” - The delivery location of the customer
F.PARTNRTYPE (required)
DOCUMNTREF.DOCUMENTRVDOCUMNT
REF.DESCRIPTN
DOCUMNTREF.LINENUMDOCUMNTREF.
DOCUMENTRV
DOCUMNTREF.NOTES1 –
NOTES9DOCUMNTREF.LINENUM
DOCUMNTREF.SCHLINENUMDOCUMNT
REF.NOTES1 – NOTES9
DOCUMNTREF.SUBLINENUMDOCUMNT
REF.SCHLINENUM
DOCUMNTREF.USERAREADOCUMNTRE
F.SUBLINENUM
DOCUMNTREF.USERAREA
CHARGE.
X CHARGE.CHARGEID WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to external
(REQUIRED)CHARGE. value
XX CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(REQUIRED)CHARGE.CHARGEID WSH_FREIGHT_COSTS.CURRENCY_CODEWSH_FREIGHT_COSTS.FREI
(REQUIRED) GHT_COST_TYPE_ID converted to external value
X CHARGE.AMOUNT (EXTENDED) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(T)CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.CURRENCY_CODE
(REQUIRED)
CHARGE.CHARGETYPECHARGE.AMOUN WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
T (EXTENDED) (T) FREIGHT_COST_TYPE
CHARGE.CHGLINENUMCHARGE.CHARG WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
ETYPE FREIGHT_COST_TYPE
CHARGE.DESCRIPTNCHARGE.CHGLINEN

Intlptnrint.doc Oracle Confidential - For internal use only 44


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

UM
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields
CHARGE.DESCRIPTN
INVDETAIL. WSH_FREIGHT_COSTS descriptive flexfields
CHARGE.USERAREA
INVDETAIL.DESCRIPTNINVDETAIL. WSH_DELIVERY_DETAILS.ITEM_DESCRIPTION

INVDETAIL.DISPOSITNINVDETAIL.DESC WSH_DELIVERY_DETAILS.ITEM_DESCRIPTION
RIPTN
INVDETAIL.LOTLEVEL1 – WSH_DELIVERY_DETAILS.LOT_NUMBER
LOTLEVEL2INVDETAIL.DISPOSITN
WSH_DELIVERY_DETAILS.SUBLOT_NUMBER

INVDETAIL.NOTES1 - WSH_DELIVERY_DETAILS.LOT_NUMBER
NOTES9INVDETAIL.LOTLEVEL1 –
LOTLEVEL2 WSH_DELIVERY_DETAILS.SUBLOT_NUMBER

INVDETAIL.QUANTITY WSH_DELIVERY_DETAILS.REQUESTED
(ITEM)INVDETAIL.NOTES1 - NOTES9 QUANTITY/WSH_DELIVERY_DETAILS.REQUESTED_QUANTITY_UOM
INVDETAIL.SERIALNUMINVDETAIL.QUA WSH_DELIVERY_DETAILS.SERIAL_NUMBERWSH_DELIVERY_DETAIL
NTITY (ITEM) S.REQUESTED
QUANTITY/WSH_DELIVERY_DETAILS.REQUESTED_QUANTITY_UOM
INVDETAIL.USERAREAINVDETAIL.SERIA WSH_DELIVERY_DETAILS.TO_SERIAL_NUMBER
LNUM WSH_DELIVERY_DETAILS.PREFERRED_GRADE
WSH_DELIVERY_DETAILS.SERIAL_NUMBER
INVDETAIL.USERAREA WSH_DELIVERY_DETAILS.TO_SERIAL_NUMBER
WSH_DELIVERY_DETAILS.PREFERRED_GRADE

CHARGE.
X CHARGE.CHARGEID WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to external
(REQUIRED)CHARGE. value
XX CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(REQUIRED)CHARGE.CHARGEID WSH_FREIGHT_COSTS.CURRENCY_CODEWSH_FREIGHT_COSTS.FREI
(REQUIRED) GHT_COST_TYPE_ID converted to external value
X CHARGE.AMOUNT (EXTENDED) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(T)CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.CURRENCY_CODE
(REQUIRED)
CHARGE.CHARGETYPECHARGE.AMOUN WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
T (EXTENDED) (T) FREIGHT_COST_TYPE
CHARGE.CHGLINENUMCHARGE.CHARG WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
ETYPE FREIGHT_COST_TYPE
CHARGE.DESCRIPTNCHARGE.CHGLINEN
UM
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields
CHARGE.DESCRIPTN
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields
DISTRIBUTION.
DISTRIBUTION.BUSNAREADISTRIBUTIO
N.
DISTRIBUTION.COSTCENTERDISTRIBUTI
ON.BUSNAREA
DISTRIBUTION.DEPARTMENTDISTRIBUT
ION.COSTCENTER
DISTRIBUTION.DIVISIONDISTRIBUTION.
DEPARTMENT
DISTRIBUTION.ELEMENT1 - ELEMENT
999DISTRIBUTION.DIVISION
DISTRIBUTION.FUNDDISTRIBUTION.ELE
MENT1 - ELEMENT 999
DISTRIBUTION.GEOGRAPHYDISTRIBUTI
ON.FUND
DISTRIBUTION.GLENTITYSDISTRIBUTIO
N.GEOGRAPHY
DISTRIBUTION.GLNOMACCTDISTRIBUTI
ON.GLENTITYS
DISTRIBUTION.OPERAMT (EXTENDED)

Intlptnrint.doc Oracle Confidential - For internal use only 45


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

(T)DISTRIBUTION.GLNOMACCT
DISTRIBUTION.PROFITCTRDISTRIBUTIO
N.OPERAMT (EXTENDED) (T)
DISTRIBUTION.PROJECTDISTRIBUTION.
PROFITCTR
DISTRIBUTION.UNITDISTRIBUTION.PROJ
ECT
DISTRIBUTION.WAREHOUSEDISTRIBUTI
ON.UNIT
DISTRIBUTION.USERAREADISTRIBUTIO
N.WAREHOUSE
DISTRIBUTION.USERAREA
SHIPUNIT.
X SHIPUNIT.CARRIER WSH_DELIVERY_DETAILS.CARRIER_ID converted to external value
(REQUIRED)SHIPUNIT.
XX SHIPUNIT.SHIPPERID WSH_DELIVERY_DETAILS.SHIP_FROM_LOCATION_ID converted to
(REQUIRED)SHIPUNIT.CARRIER external value.WSH_DELIVERY_DETAILS.CARRIER_ID converted to
(REQUIRED) external value
XX SHIPUNIT.TRACKINGID WSH_DELIVERY_DETAILS.TRACKING_NUMBERWSH_DELIVERY_DET
(REQUIRED)SHIPUNIT.SHIPPERID AILS.SHIP_FROM_LOCATION_ID converted to external value.
(REQUIRED)
X SHIPUNIT.AMOUNT WSH_DELIVERY_DETAILS.TRACKING_NUMBER
(DECLAREVAL)SHIPUNIT.TRACKINGID
(REQUIRED)
SHIPUNIT.AMOUNT (FREIGHT(
(T)SHIPUNIT.AMOUNT (DECLAREVAL)
SHIPUNIT.AMOUNT (ITEM)
(T)SHIPUNIT.AMOUNT (FREIGHT( (T)
SHIPUNIT.AMOUNT (TOTAL)
(T)SHIPUNIT.AMOUNT (ITEM) (T)
SHIPUNIT.CARRSRVLVLSHIPUNIT.AMOU
NT (TOTAL) (T)
SHIPUNIT.CONTAINRIDSHIPUNIT.CARRS WSH_DELIVERY_DETAILS.DELIVERY_DETAIL_ID
RVLVL
SHIPUNIT.CONTNRGRPIDSHIPUNIT.CONT WSH_DELIVERY_DETAILS.MASTER_CONTAINER_ITEM_ID converted to
AINRID external valueWSH_DELIVERY_DETAILS.DELIVERY_DETAIL_ID
SHIPUNIT.CONTNRSEALSHIPUNIT.CONT WSH_DELIVERY_DETAILS.SEAL_CODEWSH_DELIVERY_DETAILS.MA
NRGRPID STER_CONTAINER_ITEM_ID converted to external value
SHIPUNIT.CONTRTYPESHIPUNIT.CONTN WSH_DELIVERY_DETAILS.CONTAINER_TYPE_CODE
RSEAL WSH_DELIVERY_DETAILS.SEAL_CODE
SHIPUNIT.COUNTRYDSTSHIPUNIT.CONT WSH_DELIVERY_DETAILS.CONTAINER_TYPE_CODE
RTYPE
SHIPUNIT.COUNTRYORGSHIPUNIT.COUN WSH_DELIVERY_DETAILS.COUNTRY_OF_ORIGIN
TRYDST
SHIPUNIT.DATETIME WSH_TRIP_STOPS.ACTUAL_ARRIVAL_DATEWSH_DELIVERY_DETAIL
(DELIVACT)SHIPUNIT.COUNTRYORG S.COUNTRY_OF_ORIGIN
SHIPUNIT.DATETIME WSH_DELIVERY_DETAILS.DATE_SCHEDULEDWSH_TRIP_STOPS.ACT
(DELIVSCHED)SHIPUNIT.DATETIME UAL_ARRIVAL_DATE
(DELIVACT)
SHIPUNIT.DATETIME WSH_DELIVERY_DETAILS.DATE_SCHEDULED
(LOADING)SHIPUNIT.DATETIME
(DELIVSCHED)
SHIPUNIT.DATETIME WSH_TRIP_STOPS.ACTUAL_DEPARTURE_DATE
(SHIP)SHIPUNIT.DATETIME (LOADING)
SHIPUNIT.DESCRIPTNSHIPUNIT.DATETI WSH_TRIP_STOPS.ACTUAL_DEPARTURE_DATE
ME (SHIP)
SHIPUNIT.EXPORTLICSHIPUNIT.DESCRIP
TN
SHIPUNIT.FRGHTCLSSHIPUNIT.EXPORTL WSH_DELIVERY_DETAILS.FREIGHT_CLASS_CAT_ID converted to
IC external value
SHIPUNIT.FRCHTITEMSHIPUNIT.FRGHTC WSH_DELIVERY_DETAILS.FREIGHT_CLASS_CAT_ID converted to
LS external value
SHIPUNIT.FRGTHTERMSSHIPUNIT.FRCHT WSH_DELIVERY_DETAILS.FREIGHT_TERMS_CODE converted to external
ITEM value
SHIPUNIT.HAZRDMATLSHIPUNIT.FRGTH WSH_DELIVERY_DETAILS.HAZARD_CLASS_ID converted to external
TERMS valueWSH_DELIVERY_DETAILS.FREIGHT_TERMS_CODE converted to

Intlptnrint.doc Oracle Confidential - For internal use only 46


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

external value
SHIPUNIT.IMPORTLICSHIPUNIT.HAZRDM WSH_DELIVERY_DETAILS.HAZARD_CLASS_ID converted to external
ATL value
SHIPUNIT.LOADPOINTSHIPUNIT.IMPORT
LIC
SHIPUNIT.NOTES1 - WSH_DELIVERY_DETAILS.PACKING_INSTRUCTIONS
NOTES9SHIPUNIT.LOADPOINT
SHIPUNIT.OPERAMT (FREIGHT) WSH_DELIVERY_DETAILS.PACKING_INSTRUCTIONS
(T)SHIPUNIT.NOTES1 - NOTES9
SHIPUNIT.PACKINGSHIPUNIT.OPERAMT
(FREIGHT) (T)
SHIPUNIT.PACKINGDESCSHIPUNIT.PACK
ING
SHIPUNIT.QUANTITY
(ESTWEIGHT)SHIPUNIT.PACKINGDESC
SHIPUNIT.QUANTITY Populate from MTL_SYSTEM_ITEMS
(HEIGHT)SHIPUNIT.QUANTITY
(ESTWEIGHT)
SHIPUNIT.QUANTITY Populate from MTL_SYSTEM_ITEMSPopulate from MTL_SYSTEM_ITEMS
(LENGTH)SHIPUNIT.QUANTITY (HEIGHT)
SHIPUNIT.QUANITTY Calculate
(LOADINGWT)SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.GROSS WEIGHT -
(LENGTH) WSH_DELIVERY_DETAILS.NET WEIGHTPopulate from
MTL_SYSTEM_ITEMS
SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.NET_WEIGHT +
(NETWEIGHT)SHIPUNIT.QUANITTY WSH_DELIVERY_DETAILS.WEIGHT_UOM_CODE for delivery lines =
(LOADINGWT) container itemCalculate
WSH_DELIVERY_DETAILS.GROSS WEIGHT -
WSH_DELIVERY_DETAILS.NET WEIGHT
SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.GROSS_WEIGHT +
(TOTWEIGHT)SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.WEIGHT_UOM_CODEWSH_DELIVERY_DET
(NETWEIGHT) AILS.NET_WEIGHT +
WSH_DELIVERY_DETAILS.WEIGHT_UOM_CODE for delivery lines =
container item
SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.VOLUME +
(VOLUME)SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.VOLUME_UOM_CODE for delivery lines =
(TOTWEIGHT) container itemWSH_DELIVERY_DETAILS.GROSS_WEIGHT +
WSH_DELIVERY_DETAILS.WEIGHT_UOM_CODE
SHIPUNIT.QUANTITY WSH_DELIVERY_DETAILS.VOLUME +
(WIDTH)SHIPUNIT.QUANTITY (VOLUME) WSH_DELIVERY_DETAILS.VOLUME_UOM_CODE for delivery lines =
container item
SHIPUNIT.SHIPMATLIDSHIPUNIT.QUANT WSH_DELIVERY_DETAILS.INVENTORY_ITEM_ID converted to Item
ITY (WIDTH) Number by joining to mtl_system_items ( this delivery detail id is the delivery
detail id of the container record)
SHIPUNIT.SHIPNOTESSHIPUNIT.SHIPMAT WSH_DELIVERY_DETAILS.SHIPPING_INSTRUCTIONSWSH_DELIVERY
LID _DETAILS.INVENTORY_ITEM_ID converted to Item Number by joining to
mtl_system_items ( this delivery detail id is the delivery detail id of the container
record)
SHIPUNIT.SHIPPOINTSHIPUNIT.SHIPNOT WSH_DELIVERY_DETAILS.DELIVER_TO_LOCATION_IDWSH_DELIVER
ES Y_DETAILS.SHIPPING_INSTRUCTIONS
SHIPUNIT.SHIPSRVLVLSHIPUNIT.SHIPPOI WSH_DELIVERY_DETAILS.SHIP_METHOD_CODEWSH_DELIVERY_DE
NT TAILS.DELIVER_TO_LOCATION_ID
SHIPUNIT.SHPMTLDESCSHIPUNIT.SHIPS WSH_DELIVERY_DETALS.ITEM_DESCRIPTIONWSH_DELIVERY_DETA
RVLVL ILS.SHIP_METHOD_CODE
SHIPUNIT.SHPUNITSEQSHIPUNIT.SHPMT WSH_DELIVERY_DETALS.ITEM_DESCRIPTION
LDESC
SHIPUNIT.SHPUNITSTSSHIPUNIT.SHPUNI
TSEQ
SHIPUNIT.SHPUNITTOTSHIPUNIT.SHPUNI
TSTS
SHIPUNIT.SPECIALHNDSHIPUNIT.SHPUNI
TTOT
SHIPUNIT.STAGEPOINTSHIPUNIT.SPECIA
LHND
SHIPUNIT.TEMPRATURE
(ACTUAL)SHIPUNIT.STAGEPOINT

Intlptnrint.doc Oracle Confidential - For internal use only 47


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

SHIPUNIT.TEMPRATURE
(DELIVERY)SHIPUNIT.TEMPRATURE
(ACTUAL)
SHIPUNIT.TEMPRATURE
(LOADING)SHIPUNIT.TEMPRATURE
(DELIVERY)
SHIPUNIT.TRACKINGIDTYPESHIPUNIT.T Write Procedure to Populate this column.
EMPRATURE (LOADING)
SHIPUNIT.TRANSMETHDSHIPUNIT.TRAC WSH_DELIVERY_DETAILS.SHIP_METHOD_CODEWrite Procedure to
KINGIDTYPE Populate this column.
SHIPUNIT.TRANSTERMSSHIPUNIT.TRAN WSH_NEW_DELIVERIES.FOB_CODEWSH_DELIVERY_DETAILS.SHIP_M
SMETHD ETHOD_CODE
SHIPUNIT.USERAREASHIPUNIT.TRANSTE WSH_DELIVERY_DETAILS.DELIVERY_DETAIL_ID
RMS (To be called as DELIVERY_DETAIL_NUMBER)

WSH_DELIVERY_DETAILS.PACKING_INSTRUCTIONS
WSH_DELIVERY_DETAILS.DESCRIPTIVE_FLEXFIELDS
WSH_DELIVERY_DETAILS.LOT_NUMBER
WSH_DELIVERY_DETAILS.SUBLOT_NUMBER
WSH_DELIVERY_DETAILS.REVISION
WSH_DELIVERY_DETAILS.SERIAL NUMBER
WSH_DELIVERY_DETAILS.TO_SERIAL NUMBER
WSH_NEW_DELIVERIES.FOB_CODE
SHIPUNIT.USERAREA WSH_DELIVERY_DETAILS.DELIVERY_DETAIL_ID
(To be called as DELIVERY_DETAIL_NUMBER)
WSH_DELIVERY_DETAILS.PACKING_INSTRUCTIONS
WSH_DELIVERY_DETAILS.DESCRIPTIVE_FLEXFIELDS
WSH_DELIVERY_DETAILS.LOT_NUMBER
WSH_DELIVERY_DETAILS.SUBLOT_NUMBER
WSH_DELIVERY_DETAILS.REVISION
WSH_DELIVERY_DETAILS.SERIAL NUMBER
WSH_DELIVERY_DETAILS.TO_SERIAL NUMBER
INVITEM. If the Ship Unit is a container, these are the details about the item(s) in the
container.
X INVITEM.ITEM (REQUIRED)INVITEM. If the Ship Unit is a container, these are the details about the item(s) in the
container.
XX INVITEM.QUANTITY (ITEM)
(REQUIRED)INVITEM.ITEM (REQUIRED)
X INVITEM.AMOUNT (EXTENDED)
(T)INVITEM.QUANTITY (ITEM)
(REQUIRED)
INVITEM.AMOUNT (ITEM)
(T)INVITEM.AMOUNT (EXTENDED) (T)
INVITEM.COUNTRY
ORGINVITEM.AMOUNT (ITEM) (T)
INVITEM.FRGHTCLSINVITEM.COUNTRY
ORG
INVITEM.FRGHTITEMINVITEM.FRGHTCL
S
INVITEM.HAZRDMATLINVITEM.FRGHTIT
EM
INVITEM.ITEMDESCINVITEM.HAZRDMA
TL
INVITEM.ITEMRVINVITEM.ITEMDESC
INVITEM.ITEMRVXINVITEM.ITEMRV
INVITEM.LOTLEVEL1 -
LOTLEVEL2INVITEM.ITEMRVX
INVITEM.NOTES 1 - NOTES
9INVITEM.LOTLEVEL1 - LOTLEVEL2
INVITEM.OWNRSHPCDEINVITEM.NOTES
1 - NOTES 9
INVITEM.QUANTITY
(VOLUME)INVITEM.OWNRSHPCDE
INVITEM.QUANTITY
(WEIGHT)INVITEM.QUANTITY (VOLUME)
INVITEM.SHIPNOTESINVITEM.QUANTIT

Intlptnrint.doc Oracle Confidential - For internal use only 48


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

Y (WEIGHT)
INVITEM.UPCINVITEM.SHIPNOTES
INVITEM.USERAREAINVITEM.UPC
INVITEM.USERAREA

CONTAINER. This is used to send intermediate packaging info. We do not have the ability to
send intermediate packaging within the shipping unit, so we will not use this
segment.
CONTAINER.CONTAINRIDCONTAINER. WSH_DELIVERY_DETAILS.CONTAINER_NAMEThis is used to send
intermediate packaging info. We do not have the ability to send intermediate
packaging within the shipping unit, so we will not use this segment.
CONTAINER.CONTNRSEALCONTAINER.C WSH_DELIVERY_DETAILS.SEAL_CODEWSH_DELIVERY_DETAILS.CO
ONTAINRID NTAINER_NAME
CONTAINER.CONTNRTYPECONTAINER.C WSH_DELIVERY_DETAILS.CONTAINER_TYPE_CODE
ONTNRSEAL WSH_DELIVERY_DETAILS.SEAL_CODE
CONTAINER.DESCRIPTNCONTAINER.CO WSH_DELIVERY_DETAILS.CONTAINER_TYPE_CODE
NTNRTYPE
CONTAINER.NOTES 1 - NOTES
9CONTAINER.DESCRIPTN
CONTAINER.PACKINGCONTAINER.NOTE
S 1 - NOTES 9
CONTAINER.PACKINGDESCCONTAINER.
PACKING
CONTAINER.PARCNTNRIDCONTAINER.P
ACKINGDESC
CONTAINER.SHIPMATLIDCONTAINER.P WSH_DELIVERY_DETAILS.INVENTORY_ITEM_ID converted to ITEM
ARCNTNRID NUMBER by joining to mtl_system_items
CONTAINER.SHPMTLDESCCONTAINER.S WSH_DELIVERY_DETAILS.ITEM_DESCRIPTION
HIPMATLID WSH_DELIVERY_DETAILS.INVENTORY_ITEM_ID converted to ITEM
NUMBER by joining to mtl_system_items
CONTAINER.USERAREACONTAINER.SHP WSH_DELIVERY_ASSIGNMENTS.DELIVERY_DETAIL_ID
MTLDESC (To be called as DELIVERY_DETAIL_NUMBER)
WSH_DELIVERY_ASSIGNMENTS.PARENT_DELIVERY_DETAIL_ID
(To be called as PARENT_DELIVERY_DETAIL_NUMBER)
HEIGHT – From mtl_system_items
LENGTH - From mtl_system_items
WEIGHT-
WSH_DELIVERY_DETAILS. GROSS_WEIGHT
WSH_DELIVERY_DETAILS. NET_WEIGHT
VOLUME – WSH_DELIVERY_DETAILS. VOLUME
WIDTH- From mtl_system_items
LOT- WSH_DELIVERY_DETAILS. LOT_NUMBER
SUBLOT-
WSH_DELIVERY_DETAILS. SUBLOT_NUMBER
WSH_DELIVERY_DETAILS. REVISION
WSH_DELIVERY_DETAILS. SERIAL NUMBER
WSH_DELIVERY_DETAILS. TO_SERIAL NUMBER
WSH_DELIVERY_DETAILS. SHIP_FROM_LOCATION_ID converted to code
(To be called as SHIP_FROM_LOCATION LOCATION)
WSH_DELIVERY_DETAILS. DELIVER_TO_LOCATION_ID
converted to code
(To be called as
DELIVER_TO_LOCATION)
WSH_DELIVERY_DETAILS. TRACKING_NUMBER
WSH_DELIVERY_DETAILS. COUNTRY_OF_ORIGIN
WSH_TRIP_STOPS.ACTUAL_ ARRIVAL_DATE
WSH_DELIVERY_DETAILS. DATE_SCHEDULED
WSH_TRIP_STOPS.ACTUAL_ DEPARTURE_DATE
WSH_DELIVERY_DETAILS. SHIP_METHOD_CODE
WSH_DELIVERY_DETAILS. FREIGHT_CLASS_CAT_ID converted to
external value
(To be called as FREIGHT_CLASS_CATEGORY)
WSH_DELIVERY_DETAILS. FREIGHT_TERMS_CODE converted to external
value
WSH_DELIVERY_DETAILS. HAZARD_CLASS_ID converted to external
value

Intlptnrint.doc Oracle Confidential - For internal use only 49


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

(To be called as HAZARD_CLASS or as HAZARD_CLASS_CODE)


WSH_DELIVERY_DETAILS. FOB_CODE
WSH_DELIVERY_DETAILS. SHIPPING_INSTRUCTIONS
WSH_DELIVERY_DETAILS. PACKING_INSTRUCTIONS
WSH_DELIVERY_DETAILS. Descriptive Flexfields
WSH_DELIVERY_DETAILS.ITEM_DESCRIPTION

CONTAINER.USERAREA WSH_DELIVERY_ASSIGNMENTS.DELIVERY_DETAIL_ID
(To be called as DELIVERY_DETAIL_NUMBER)
WSH_DELIVERY_ASSIGNMENTS.PARENT_DELIVERY_DETAIL_ID
(To be called as PARENT_DELIVERY_DETAIL_NUMBER)
HEIGHT – From mtl_system_items
LENGTH - From mtl_system_items
WEIGHT-
WSH_DELIVERY_DETAILS. GROSS_WEIGHT
WSH_DELIVERY_DETAILS. NET_WEIGHT
VOLUME – WSH_DELIVERY_DETAILS. VOLUME
WIDTH- From mtl_system_items
LOT- WSH_DELIVERY_DETAILS. LOT_NUMBER
SUBLOT-
WSH_DELIVERY_DETAILS. SUBLOT_NUMBER
WSH_DELIVERY_DETAILS. REVISION
WSH_DELIVERY_DETAILS. SERIAL NUMBER
WSH_DELIVERY_DETAILS. TO_SERIAL NUMBER
WSH_DELIVERY_DETAILS. SHIP_FROM_LOCATION_ID converted to code
(To be called as SHIP_FROM_LOCATION LOCATION)
WSH_DELIVERY_DETAILS. DELIVER_TO_LOCATION_ID
converted to code
(To be called as
DELIVER_TO_LOCATION)
WSH_DELIVERY_DETAILS. TRACKING_NUMBER
WSH_DELIVERY_DETAILS. COUNTRY_OF_ORIGIN
WSH_TRIP_STOPS.ACTUAL_ ARRIVAL_DATE
WSH_DELIVERY_DETAILS. DATE_SCHEDULED
WSH_TRIP_STOPS.ACTUAL_ DEPARTURE_DATE
WSH_DELIVERY_DETAILS. SHIP_METHOD_CODE
WSH_DELIVERY_DETAILS. FREIGHT_CLASS_CAT_ID converted to
external value
(To be called as FREIGHT_CLASS_CATEGORY)
WSH_DELIVERY_DETAILS. FREIGHT_TERMS_CODE converted to external
value
WSH_DELIVERY_DETAILS. HAZARD_CLASS_ID converted to external
value
(To be called as HAZARD_CLASS or as HAZARD_CLASS_CODE)
WSH_DELIVERY_DETAILS. FOB_CODE
WSH_DELIVERY_DETAILS. SHIPPING_INSTRUCTIONS
WSH_DELIVERY_DETAILS. PACKING_INSTRUCTIONS
WSH_DELIVERY_DETAILS. Descriptive Flexfields

CHARGE. This CHARGE section is for a CONTAINER.


X CHARGE.CHARGEID WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to external
(REQUIRED)CHARGE. valueThis CHARGE section is for a CONTAINER.
XX CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(REQUIRED)CHARGE.CHARGEID WSH_FREIGHT_COSTS.CURRENCY_CODEWSH_FREIGHT_COSTS.FREI
(REQUIRED) GHT_COST_TYPE_ID converted to external value
X CHARGE.AMOUNT (EXTENDED) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(T)CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.CURRENCY_CODE
(REQUIRED)
CHARGE.CHARGETYPECHARGE.AMOUN WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
T (EXTENDED) (T) FREIGHT_COST_TYPE
CHARGE.CHGLINENUMCHARGE.CHARG WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
ETYPE FREIGHT_COST_TYPE
CHARGE.DESCRIPTNCHARGE.CHGLINEN
UM
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields
CHARGE.DESCRIPTN
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields

Intlptnrint.doc Oracle Confidential - For internal use only 50


Oracle International Trade Management Partner Integration Specifications

Reqd Element/Attribute Source (Table.Column Name )

INVITEM.
X INVITEM.ITEM (REQUIRED)INVITEM.
XX INVITEM.QUANTITY (ITEM)
(REQUIRED)INVITEM.ITEM (REQUIRED)
X INVITEM.AMOUNT (EXTENDED)
(T)INVITEM.QUANTITY (ITEM)
(REQUIRED)
INVITEM.AMOUNT (ITEM)
(T)INVITEM.AMOUNT (EXTENDED) (T)
INVITEM.COUNTRY
ORGINVITEM.AMOUNT (ITEM) (T)
INVITEM.FRGHTCLSINVITEM.COUNTRY
ORG
INVITEM.FRGHTITEMINVITEM.FRGHTCL
S
INVITEM.HAZRDMATLINVITEM.FRGHTIT
EM
INVITEM.ITEMDESCINVITEM.HAZRDMA
TL
INVITEM.ITEMRVINVITEM.ITEMDESC
INVITEM.ITEMRVXINVITEM.ITEMRV
INVITEM.LOTLEVEL1 -
LOTLEVEL2INVITEM.ITEMRVX
INVITEM.NOTES 1 - NOTES
9INVITEM.LOTLEVEL1 - LOTLEVEL2
INVITEM.OWNRSHPCDEINVITEM.NOTES
1 - NOTES 9
INVITEM.QUANTITY
(VOLUME)INVITEM.OWNRSHPCDE
INVITEM.QUANTITY
(WEIGHT)INVITEM.QUANTITY (VOLUME)
INVITEM.SHIPNOTESINVITEM.QUANTIT
Y (WEIGHT)
INVITEM.UPCINVITEM.SHIPNOTES
INVITEM.USERAREAINVITEM.UPC
INVITEM.USERAREA
CHARGE. This CHARGE section is for SHIPUNIT.
X CHARGE.CHARGEID WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to external
(REQUIRED)CHARGE. valueThis CHARGE section is for SHIPUNIT.
XX CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(REQUIRED)CHARGE.CHARGEID WSH_FREIGHT_COSTS.CURRENCY_CODEWSH_FREIGHT_COSTS.FREI
(REQUIRED) GHT_COST_TYPE_ID converted to external value
X CHARGE.AMOUNT (EXTENDED) WSH_FREIGHT_COSTS.TOTAL_AMOUNT
(T)CHARGE.OPERAMT (EXTENDED) (T) WSH_FREIGHT_COSTS.CURRENCY_CODE
(REQUIRED)
CHARGE.CHARGETYPECHARGE.AMOUN WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
T (EXTENDED) (T) FREIGHT_COST_TYPE
CHARGE.CHGLINENUMCHARGE.CHARG WSH_FREIGHT_COSTS.FREIGHT_COST_TYPE_ID converted to
ETYPE FREIGHT_COST_TYPE
CHARGE.DESCRIPTNCHARGE.CHGLINEN
UM
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields
CHARGE.DESCRIPTN
CHARGE.USERAREA WSH_FREIGHT_COSTS descriptive flexfields

Table 11: Element description of Delivery Compliance Request Message

Intlptnrint.doc Oracle Confidential - For internal use only 51


Oracle International Trade Management Partner Integration Specifications

Appendix F –Acknowledgements

XML Acknowledgement

Oracle ITM adapter requires a synchronous acknowledgment from the partner


ITM application. This ensures that a proper connection has been established and
the request is received successfully. The ITM adapter supports Open
Application Group (OAG) Confirmation Business Object Document (Revision
7.2.1) for inbound acknowledgements. Additionally, Oracle XML Gateway can
also be setup to provide asynchronous XML acknowledgements for the response
messages from partner application.

The structure of the XML acknowledgment message is illustrated below. For


additional details about the XML acknowledgment message please review
Oracle XML Gateway documentation.

Diagram Note:
CONFIRM Required = Solid boxes
Optional = Dashed boxes

CONFIRMMSG

Fig 23: Acknowledgement Message Structure (Confirm_BOD_004)

HTML Acknowledgement
The transport layer in Oracle XML Gateway provides a HTML based messaging
acknowledgement upon receiving a response from the partner ITM application.
The details of the HTML acknowledgment message are given below. For
additional information about the XML acknowledgment message please review
Oracle XML Gateway documentation.

Intlptnrint.doc Oracle Confidential - For internal use only 52


Oracle International Trade Management Partner Integration Specifications

<HTML><BODY><TABLE>
<TR>
<TD>STATUS_CODE</TD>
<TD>2001</TD>
</TR>
<TR>
<TD>STATUS_DESCRIPTION</TD>
<TD></TD>
</TR>
<TR>
<TD>MESSAGE_RECEIPT_ID</TD>
<TD></TD>
</TR>
</TABLE></BODY></HTML>

Intlptnrint.doc Oracle Confidential - For internal use only 53


Oracle International Trade Management Partner Integration Specifications

Appendix G – Oracle XML Gateway Setup

Oracle ITM adapter leverages many of the messaging and interface capabilities
of Oracle XML Gateway. This makes it imperative that all the setup of XML
Gateway are complete before the ITM adapter can be utilized for a successful
end to end communication. The setups described in this section are the
additional setup needed in XML Gateway for ITM adapter. For a complete list
of setup in Oracle XML Gateway please refer to Oracle XML Gateway
documentation available on Metalink (metalink.oracle.com).

Define Transactions

Resp: XML Gateway


Navigate: XML GatewayÆ Define Transactions

Header:

Party Type: Customer


Transaction Type: ITM
Transaction Sub Type: EXPORT_COMPLIANCE

External Transactions (Lines):

Standard Code: OAG


External Transaction Type: ITM
External Transaction Sub Type: EXPORT_COMPLAINCE
Queue: APPS.ECX_IN_OAG_Q

Save & Close the form.

Define Trading Partners

Resp: XML Gateway


Navigate: XML GatewayÆ Define Trading Partners

Header:

Trading Partner Type: Customer


Trading Partner Name: ITM Application
Trading Partner Site: Will automatically display the customer address on
enabling the LOV
Company Admin Email: john.Doe@abc.com

Intlptnrint.doc Oracle Confidential - For internal use only 54


Oracle International Trade Management Partner Integration Specifications

Trading Partner Details:

Transaction Type: ITM


Map: WSHITEIN
Source Trading Partner Location Code: ITM Application (should be the value
defined in EDI Location for customer)

Save & Close the form.

Intlptnrint.doc Oracle Confidential - For internal use only 55


Oracle International Trade Management Partner Integration Specifications

Appendix H – Additional Resources

The following are some of the additional documentation, which will help setup
various Oracle Applications including Oracle XML Gateway. These are
available on metalink (metalink.oracle.com) under the product documentation
section.

• Oracle Shipping Execution User Guide.

• Oracle Order Management Implementation Guide.

• Oracle XML Gateway User Guide.

• Understanding the Oracle Transport Agent Messaging Protocol, White


Paper.

• XML Gateway Setup Testing and Diagnostics, White Paper.

• Configuring the Oracle XML Transport Agent (OXTA) With Oracle


Applications 11i, White Paper.

Intlptnrint.doc Oracle Confidential - For internal use only 56

You might also like