Professional Documents
Culture Documents
Oracle Itm Partner Specs PDF
Oracle Itm Partner Specs PDF
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.
Contents
Overview.....................................................................................................................................................................1
ITM Process Flow ...................................................................................................................................................1
Partner Requirements.............................................................................................................................................20
Assumptions .............................................................................................................................................................21
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.
Are there any special government documents needed for the export/import?
1. Export related
2. Import related
Freight
Order Sales Customs
Pick Pack Ship Forwarder/
Quote Order Clearance
Consolidator
Enter/Edit Enter/Edit
Item Customer
Notification
Requisition/ Source Purchase Customs
RFQ of
Requirement Selection Order Clearance
Shipment
Enter/Edit Enter/Edit
Item Supplier
Major Features
Internet/LAN/WAN
Oracle TCA
ITM
Application
Oracle BOM
Oracle Purchasing/iProcurement
Oracle Payables
ITM
Application
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.
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.
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.
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.
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
(Oracle BOM) (Oracle TCA) (Oracle Order Mgt.) (Oracle Shipping Execution)
Oracle ITM Adapter
1 A1 2 A1 3 A1 4 A2 5 A1 6 A2
LAN/WAN/Internet
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.
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
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
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
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
Table 1 and Table 2 below summarizes each the ITM service request and its
corresponding request and response XML messages:
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:
• Contact Name
• Contact Email
• Vendor URL
The following fields are provided for a service in the ITM application:
• Service Type
• URL
• Port
• Protocol (HTTP/HTTPS)
• Certificate Store
• Certificate Password
• Service Priority
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.
• Output Directory
• Set Proxy
• Proxy Host
• Proxy Port
• Polling Frequency
• Task Size
• Maximum DB Connections
• Minimum DB Connections
• DB Connection Timeout
• Minimum Threads
• Maximum Threads
• Error Type
• Error Code
• Classification
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.
This program verifies the status of the adapter’s processing engine and also provides
other valuable information about the pending requests, errors encountered etc.
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.
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.
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.
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.
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
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
ITM
Oracle Purchasing/ Import Compliance Screening Application
iProcurement
Oracle Payables
Phase I
Phase II
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:
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
Partner Requirements
The following are some of the key requirements for the partner ITM application to be
able to integrate with Oracle ITM adapter.
Assumptions
The proposed generic integration with the ITM application is based on the following
assumptions:
• Oracle ITM Adapter manages all the communication with the partner’s ITM
application.
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:
Submit Items
for Export
Classification
Program
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
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:
Submit Parties
for Party
Synchronization
Program
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
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
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:
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
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
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
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
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:
Any more
No
deliveries?
Yes
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
API Name:
WSH_ITM_CUSTOM_PROCESS.PRE_PROCESS_WSH_REQUEST
API Name:
WSH_ITM_CUSTOM_PROCESS.POST_PROCESS_WSH_REQUEST
• 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
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
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
• 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
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
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
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
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
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
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
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:
• 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.
CNTROLAREA
DATAAREA
MESSAGE TRANSACTION_KEY
TRIGERRING_POINT
EXPORT_COMP_RESULT
ERROR
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.
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
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
SHIPITEM.
X SHIPITEM.ITEM (REQUIRED) WSH_DELIVERY_DETAILS.INVENTORY_ITEM_ID (foreign key to
MTL_SYSTEM_ITEMS)
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
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
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)
(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
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
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
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
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
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
Appendix F –Acknowledgements
XML Acknowledgement
Diagram Note:
CONFIRM Required = Solid boxes
Optional = Dashed boxes
CONFIRMMSG
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.
<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>
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
Header:
Header:
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.