oracle itm partner specs

Upload: satendra-bhati

Post on 03-Apr-2018

226 views

Category:

Documents


0 download

TRANSCRIPT

  • 7/28/2019 Oracle ITM Partner Specs

    1/61

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

    Copyright 2005 Oracle CorporationAll Rights Reserved

    Oracle International TradeManagement (ITM) PartnerIntegration: Specifications

    Version : Draft

    Prepared By : Product Management, Oracle Shipping Execution

    Control Ref : intlptnrint.rtf

    Last Updated : 18-Oct-05

  • 7/28/2019 Oracle ITM Partner Specs

    2/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only ii

    Contents

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

    Major Features ..........................................................................................................................................................3Interfaces with Partner Application.........................................................................................................................3Item Synchronization...............................................................................................................................................4Party Synchronization .............................................................................................................................................4Export Compliance Screening.................................................................................................................................4Transaction Documents ...........................................................................................................................................6Messaging................................................................................................................................................................7Service Request Grouping.....................................................................................................................................10Print Queues ..........................................................................................................................................................10Transaction Delivery .............................................................................................................................................10

    User Interface ........................................................................................................................................................10Message Formats...................................................................................................................................................17Scalability Features ...............................................................................................................................................17Phasing ..................................................................................................................................................................18

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

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

    Process Flows ...........................................................................................................................................................22Item Synchronization.............................................................................................................................................22Party Synchronization ...........................................................................................................................................23Order 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.......................................................................................................................................52HTML Acknowledgement.....................................................................................................................................52

    Appendix G Oracle XML Gateway Setup..........................................................................................................54Define Transactions...............................................................................................................................................54Define Trading Partners.........................................................................................................................................54

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

  • 7/28/2019 Oracle ITM Partner Specs

    3/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only iii

    Figures & Tables

    Fig 1: International Trade Management Process Flow Diagram......................................................................... 2Fig 2: Oracle ITM Partner Integration - Flow Diagram .........................................................................................3Fig 3: Integration Flow Diagram along with Overview Messaging ....................................................................... 6Fig 4: Item Synchronization Overview Messaging ............................................................................................. 7Fig 5: Party Synchronization Overview Messaging ............................................................................................ 7Fig 6: Export Compliance for Sales Orders Overview Messaging......................................................................8Fig 7: Export Compliance for Deliveries Overview Messaging..........................................................................9Table 1: International Trade Service Request by DTDs.........................................................................................9Table 2: International Trade Service Response by DTDs ......................................................................................9

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

  • 7/28/2019 Oracle ITM Partner Specs

    4/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 1

    Overview

    International trade requires dealing with the rules, regulation and duties applicable forthe products between the countries of trade. The international trade management

    solutions provide latest information on the country specific rules and regulationsalong with several other value added tools to manage the international tradeeffectively.

    Oracle International Trade Management (ITM) adapter is an open interface, whichenables international trade management functionality in Oracle Applications. It is theinterfaces gateway to third party ITM applications. It acts as a unified transactionchannel for all of the international trade compliance requests originating from OracleApplications and response originating from the ITM Application.

    This document is intended to provide an overall understanding of the ITM PartnerIntegration for the purpose of integrating with the partner ITM application. For anydetailed 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 andimporting countries regulation, the type of goods being traded, the intended end useof the goods, and the quantity and value of the goods. An international trademanagement 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 andscreening orders, determining and applying for required licenses with appropriate

    Government or regulatory bodies, generating and submitting extensivedocumentation, managing and minimizing country-specific tariffs and duties, andtracking and tracing shipments across the entire global trading community. Businessprocesses 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

  • 7/28/2019 Oracle ITM Partner Specs

    5/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 2

    classifications, i.e. an export from a sellers country is an import to the buyerscountry and compliance to both is mandatory for a successful business transaction. Aneffective trade compliance system need to provide a flexible way of performing thecompliance 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 exportcompliance functions accessible. In case of a compliance issue, the quotes, the ordersand 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 beperformed at several different points in the process.

    Enter/Edit

    Customer

    Enter/Edit

    Supplier

    Order

    Quote

    Sales

    Order

    Customs

    Clearance

    Embargo Country Screening

    Restricted Party Screening

    Landed Cost Estimation

    International Trade Management: Process Flow

    Exports Flow: Sell Side

    Requisition/

    Requirement

    Source

    Selection

    Customs

    Clearance

    Freight

    Forwarder/

    Consolidator

    Notification

    of

    Shipment

    RFQ

    Delivery/

    Receipt

    Embargo Country Screening

    Restricted Party Screening

    Landed Cost

    Export License

    Document Generation

    Embargo Country Screening

    Restricted Party Screening

    Landed Cost

    Export License

    Document Generation

    Embargo Country Screening

    Restricted Party Screening

    Landed Cost

    Import License

    Embargo Country Screening

    Restricted Party Screening

    Landed Cost

    Import License

    Document GenerationEmbargo Country Screening

    Restricted Party Screening

    Embargo Country Screening

    Restricted Party Screening

    Embargo Country ScreeningRestricted Party Screening

    Imports Flow: Buy Side

    Pick Pack Ship

    Purchase

    Order

    Enter/Edit

    Item

    Item

    Classification

    Enter/Edit

    Item

    Item

    Classification

    Fig 1: International Trade Management Process Flow Diagram

  • 7/28/2019 Oracle ITM Partner Specs

    6/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 3

    Major Features

    Oracle International Trade Management adapter is an open interface, which enablesinternational trade management (ITM) functionality in Oracle Applications. It is the

    interfaces gateway to third party ITM solutions and acts as a unified transactionchannel for all of the international trade compliance requests originating from OracleApplications and response from the ITM Application. The international trademanagement adapter not only provides a standard mechanism to access tradeapplication but also performs several other value added functions in the process. TheITM adapter is deployable over LAN, WAN or Internet and hence presents a uniformarchitecture for integration with the partner ITM applications.

    Interfaces with Partner Application

    Oracle International Trade Management adapter is the interface gateway to partnerITM application from Oracle Applications. A trade management service request may

    initiate from several functional modules within the Oracle Applications i.e. OracleOrder Management, Oracle Purchasing etc., but all of the module would access theinternational trade compliance functionality through the adapter. The response fromthe partner application is communicated back to the functional application.

    Fig 2: Oracle ITM Partner Integration - Flow Diagram

    Oracle Order Mana ement

    OracleITM

    Partner

    Integration

    ITM

    Application

    Internet/LAN/WAN

    Oracle Quoting and other Apps

    Oracle Shipping Execution

    Oracle TCA

    Oracle BOM

    Oracle Purchasin /iProcurement

    Oracle Pa ables

    ITM

    Application

  • 7/28/2019 Oracle ITM Partner Specs

    7/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 4

    Item Synchronization

    `Items are classified in the partner ITM application. Oracle ITM Adapter provides theclassification service request XML for facilitating the item definition in the partnerapplication. The Item Synchronization request XML contains all the necessary dataelements 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 forcommunicating to partner ITM application. The ITM adapter also provides a flexiblemechanism for indicating the filtering criteria for items. This allows you to easilyspecify which items need to be transmitted to the partner ITM application for exportclassification. The adapter enables the integration with the item master by providing aconcurrent program with several user-friendly parameters.

    Party Synchronization

    Oracle ITM Adapter supports a XML service request to communicate theinternational trade entities to the partner ITM application. The Party SynchronizationXML Request contains all the necessary data elements required for performing exportscreenings like Restricted Party Screening, Embargo Country Screening etc. Theparties 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 screeningsis maintained in the partner ITM application.

    Integrated with Customer Master

    Oracle ITM Adapter leverages the party definition in Oracle Trading CommunityArchitecture for screening the parties for exports. The ITM adapter also provides aflexible mechanism for indicating the filtering criteria for parties. This allows you toeasily specify which parties need to be transmitted to the partner ITM application forexport screening. The adapter enables the integration with the customer master byproviding a concurrent program with several user friendly parameters.

    Export Compliance Screening

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

  • 7/28/2019 Oracle ITM Partner Specs

    8/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 5

    Integrated with Oracle Order Management

    Oracle Order Management (OM) features export compliance check at any point afterscheduling in the order line flow. A workflow activity enables flexible integrationwith the ITM adapter. The ITM Adapters Order Compliance Request XML is utilizedto communicate key order line attributes to the ITM application. The ITM applicationresponds with overall compliance Pass or Fail result in the Export ComplianceResponse XML asynchronously.

    The ITM adapter and OM integration also highlights automated action based on theoverall 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 fordeliveries. The ITM Adapters Delivery Compliance Request XML is utilized tocommunicate key delivery attributes to the ITM application. The ITM applicationresponds with overall compliance Pass or Fail result in the Export ComplianceResponse XML asynchronously.

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

  • 7/28/2019 Oracle ITM Partner Specs

    9/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 6

    Transaction Documents

    Oracles adapter supports communication with partner applications via XML. Thefollowing diagram reflects the service requests (and direction) the Oracle adapter isdesigned to support in this phase:

    6

    (Oracle Order Mgt.) (Oracle Shipping Execution)

    Compliant?

    Delivery

    (Oracle BOM) (Oracle TCA)

    ITM Application XML Adapter

    Create /Update

    Product

    Yes

    Create /Update Partner

    ProductClassification

    ExportCompliance

    Determination

    ComplianceUser Review

    No

    Trade PartyScreening

    OracleApp

    lications

    PartnerITMAp

    plication

    Compliant?

    Send XMLResponse

    Compliance=Pass/Fail

    No

    Sales OrderCustomer MasterItem Master

    Compliant? Yes

    ExportCompliance

    Determination

    ComplianceUser Review

    No

    Compliant?

    Send XML ResponseCompliance=Pass/Fail

    Yes

    No

    GenerateDocuments?Yes

    LAN/WAN/Internet

    Oracle XML Gateway

    1 A1 2

    Legend1 - Item Synchronization Request XML2 - Party Synchornization Request XML3 - Order Compliance Request XML5 - Delivery Compliance Request XML4,6 - Export Compliance Response XMLA1 - Acknowledgment from ITM ApplicationA2 - Acknowledgement from Oracle Applications

    Oracle ITM Adapter

    4 A2 A2A1 A1 A13 5

    Fig 3: Integration Flow Diagram along with Overview Messaging

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

  • 7/28/2019 Oracle ITM Partner Specs

    10/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 7

    Messaging

    The ITM adapter supports XML based synchronous and asynchronouscommunication capabilities with the partner ITM application. The partners trademanagement application must be able to provide a web-based listener that accepts anXML request message from the adapter and provides synchronous acknowledgement.

    Item Synchronization

    The purpose of the Item Synchronization service request is to communicate keytransaction and setup entities required for Item Synchronization in the partner ITMapplication. A synchronous XML acknowledgement in the specified format isexpected from the partner application. The request DTD, its structure and elementdescription is provided in Appendix A. The acknowledgment XML details areprovided in Appendix F.

    Fig 4: Item Synchronization Overview Messaging

    Party Synchronization

    The purpose party synchronization service request is to communicate key transactionand setup entities required for party based screenings in the partner ITM application.OAGs 007_sync_customer_005.dtd (Revision 7.2.1) DTD is used for the requestXML. A synchronous XML acknowledgement in the specified format is also expectedfrom the partner application. The request DTD, its structure and element description isprovided in Appendix B. The acknowledgment XML details are provided inAppendix F.

    Fig 5: Party Synchronization Overview Messaging

    Item Synchronization Request XML

    Internet/LAN/WAN

    Partner ITMApplication

    OracleITM Adapter

    Oracle

    Bill ofMaterial Synchronous Acknowledgement

    Party Synchronization Request XML

    Internet/LAN/WAN

    Partner ITM

    ApplicationOracle

    ITM Adapter

    Oracle

    TCASynchronous Acknowledgement

  • 7/28/2019 Oracle ITM Partner Specs

    11/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 8

    Order Compliance Screening

    The purpose of order compliance request is to communicate key transaction and setupentities required for export compliance screenings in the partner ITM application forsales orders. The request is designed to support all the relevant attributes to performall the export compliance checks. The request DTD, its structure and elementdescription is provided in Appendix C. A synchronous acknowledgement is expectedfor the request XML. The acknowledgment XML details are provided in Appendix F.

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

    Fig 6: Export Compliance for Sales Orders Overview Messaging

    Delivery Compliance Screening

    The purpose of delivery compliance request is to communicate key transaction andsetup entities required for export compliance screenings in the partner ITMapplication for delivery. The request is designed to support all the relevant attributesto perform all the export compliance checks. The request DTD, its structure andelement description is provided in Appendix E. A synchronous acknowledgement is

    expected for the request XML. The acknowledgment XML details are provided inAppendix F.

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

    Generic Export ComplianceOrder Compliance Request XML

    Internet/LAN/WAN

    Partner ITM

    Application

    Oracle

    ITM Adapter

    Oracle

    Order

    Management

    Asynchronous Exp. Comp. Response XML

    Synchronous Acknowledgement

    Synchronous HTML AcknowledgementOracle

    XML GatewayOptional Asynchronous XML Acknowledgement

  • 7/28/2019 Oracle ITM Partner Specs

    12/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 9

    Fig 7: Export Compliance for Deliveries Overview Messaging

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

    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

    Request DTDs Supported

    International Trade Service Request DTD DTD Details

    Item Synchronization Item Synchronization Request XML Appendix AParty 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

    Generic Export Compliance

    Delivery Compliance Request XML

    Internet/LAN/WAN

    Partner ITM

    Application

    Oracle

    ITM Adapter

    Oracle

    Shipping

    Execution

    Asynchronous Exp. Comp. Response XML

    Synchronous Acknowledgement

    Synchronous HTML AcknowledgementOracle

    XML GatewayOptional Asynchronous XML Acknowledgement

  • 7/28/2019 Oracle ITM Partner Specs

    13/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 10

    Service Request Grouping

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

    several individual responses in a single XML message with individual responses foreach transaction reference.

    Print Queues

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

    Transaction Delivery

    Both secured and unsecured transaction delivery methods are supported. OraclesAdapter supports standard http as well as secure (SSL) connections over https to thepartners trade management server.

    User Interface

    Oracles Adapter can be configured for the outbound messages forwarded to thepartner application. The ITM Adapter provides user interface for defining thenecessary and optional attributes. The attributes can be defined at several levelsincluding ITM Application, Service etc. A service request XML includes the relevantattributes 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 andsupported 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 multipleparameters e.g. Request Version, Request Language)

  • 7/28/2019 Oracle ITM Partner Specs

    14/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 11

    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 parameterse.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 trademanagement application login information. Oracle Applications customers or OracleExchange operators will be able to store their third party trade application user ID and

  • 7/28/2019 Oracle ITM Partner Specs

    15/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 12

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

    Fig 9: ITM Partner Application User Setup Form

    ITM Adapter Middle Tier Parameters

    Each partner application that communicates with Oracles Adapter must pass theappropriate content to the adapter. The following list includes all of the mandatoryand 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

  • 7/28/2019 Oracle ITM Partner Specs

    16/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 13

    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 fromthe partner application. The feature provides the ability for user configurable actionswhen the errors are encountered. The errors may be classified into system error, dataerror and successful. The following fields are provided in the ITM Error Classificationform:

    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

  • 7/28/2019 Oracle ITM Partner Specs

    17/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 14

    Oracle Applications. This enables all the administration tasks for the adapter to becompleted from within the Oracle Applications. The following adapter administrativetasks 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 areset and processes have been started.

    Adapter Status Report

    This program verifies the status of the adapters processing engine and also providesother 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. Theseservice requests may be submitted by the calling applications and are either waiting inthe queue, or might have encountered errors in getting a response from the tradeapplication. The program can be submitted with several parameters including ErrorType, 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 topartner ITM application for export classification. Additionally the filtering criteria canbe defined in a custom PL/SQL package.

  • 7/28/2019 Oracle ITM Partner Specs

    18/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 15

    Fig 11: Item Synchronization Program Parameters

    Party Synchronization

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

  • 7/28/2019 Oracle ITM Partner Specs

    19/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 16

    Fig 12: Party Synchronization Program Parameters

    Submit Delivery for Export Screening

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

  • 7/28/2019 Oracle ITM Partner Specs

    20/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 17

    Fig 13: Submit Deliveries for Screening Program Parameters

    Message Formats

    Oracles Adapter supports XML-based communication with the partners trademanagement application. Oracle XSU and XSLT are used for XML requestgeneration and maintenance.

    Scalability Features

    Oracles Adapter leverages a multi-threaded Java based middle-tier. It supportsinterface scanning, polling request batch mechanism, task queuing and a thread poolwith configurable worker threads. All the components of the middle-tier areconfigurable to suit the throughput requirements and hardware constraints of theinstallation site. The adapter also features

    Database Connection Pool for efficient management of database resources.

  • 7/28/2019 Oracle ITM Partner Specs

    21/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 18

    Middle-tier Configuration Screen.

    Phasing

    Supporting the international trade services in key business flows involve developingthe generic integration capabilities for individual ITM services as well as embeddingthe ITM services in the core transaction application. The ITM adapter plans to supportaccess to several international trade services individually as well as combined togetherin a single request. These services can be embedded seamlessly into multiple OracleApplications. Oracle Applications development has taken a phased approach inproviding these capabilities and export requirements are targeted for the currentphase. The figure 3 below represents some of the key applications targeted for theinitial phase along with the services planned to be supported from the respectiveapplication:

    Fig 14: ITM Services, Integrating Oracle Applications

    Oracle Applications development has taken a phased approach in supporting ITM

    Import Compliance Screening

    Export Compliance Screening

    ITM

    Application

    ITM

    Application

    Internet/LAN/WAN

    Party Synchronization

    Oracle BOM

    Sales/Quotes/Contracts

    and other Applications

    Oracle Order

    Management

    Oracle Shipping

    Execution

    Oracle Purchasing/

    iProcurement

    Oracle Payables

    Item Synchronization

    Export Compliance Screening

    Import Compliance Screening

    Oracle

    ITM

    Partner

    Integration

    Oracle TCA

    Export Compliance Screening

    Phase I

    Phase II

  • 7/28/2019 Oracle ITM Partner Specs

    22/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 19

    integration with specific Applications. Exports controls are targeted for the currentphase. 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 aboveITM 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

  • 7/28/2019 Oracle ITM Partner Specs

    23/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 20

    Partner Requirements

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

    Web based Listener

    Asynchronous/Synchronous XML Response

    Ability to process inbound request XML in Oracles published DTD

    Ability to produce a valid response XML in Oracles published DTD

  • 7/28/2019 Oracle ITM Partner Specs

    24/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 21

    Assumptions

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

    The ITM application supports XML based integration.

    Oracle ITM Adapter manages all the communication with the partners ITMapplication.

    Though the adapter provides an extensible data element support for aspecific ITM service, any alterations to the element data size have to beresolved by the partner ITM application.

    The time to respond to an XML request depends on the performance of theITM application/service provider. The ITM application would adhere toperformance standards thereby facilitating the overall response time for theintegration.

  • 7/28/2019 Oracle ITM Partner Specs

    25/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 22

    Process Flows

    Item Synchronization

    The ITM adapter generates and transmits the Item Synchronization Service RequestXML to the partner application. A synchronous handshake is expected from the ITMapplication for the sake of acknowledgement. The Item Synchronization request XMLcontains all the necessary data elements required for export classification. There is noresponse back from the ITM application after the items are classified. The diagrambelow represents the Item Synchronization process flow between Oracle Applicationsand partner ITM application:

  • 7/28/2019 Oracle ITM Partner Specs

    26/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 23

    Itemcreated/

    updated inITM

    Application

    NotifyCompliance

    User

    HS andECCN

    needed?

    Interface TablesPopulated

    (Oracle ITMAdapter)

    XML Generation(Oracle ITM

    Adapter)

    XML Transmission toITM Application and

    ReceiveAcknowledgement

    (Oracle ITM Adapter)

    Yes

    No

    Oracle Applications

    Receive XMLMessage andAcknowledge

    Partner ITM

    App licat ion

    Ack.Received?

    Yes

    No

    Export Item?(based on

    filter criteria)

    No

    Yes

    Submit Itemsfor Export

    ClassificationProgram

    Any more itemsin the range

    Yes

    No

    Fig 15: Item Synchronization Integration Flow Diagram

    Party Synchronization

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

  • 7/28/2019 Oracle ITM Partner Specs

    27/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 24

    ExportScreening in

    ITMApplication

    NotifyCompliance

    User

    RestrictedParty?

    InterfaceTables

    Populated(Oracle ITM

    Adapter)

    XMLGeneration(Oracle ITM

    Adapter)

    Yes

    No

    Oracle

    Appl icat ions

    RestrictedParty ?

    No

    Flag Partyas NOT arestricted

    Party

    Yes

    Receive XMLMessage andAcknowledge

    Partner ITM

    App lication

    XML Transmission toITM Application and

    ReceiveAcknowledgement

    (Oracle ITM Adapter)

    Ack.Received?

    Yes

    No

    ExportCompliance

    UserReview

    Flag Partyas a

    restrictedParty

    ManuallyInactivate

    the Partyin Oracle

    ExportParty?(based

    on filtercriteria)

    No

    Yes

    Submit Partiesfor Party

    SynchronizationProgram

    Any more partyin the range

    Yes

    No

    Partycreated/

    updated inITM

    Application

    Fig 16: Party Synchronization Integration Flow Diagram

    Order Compliance Screening

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

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

  • 7/28/2019 Oracle ITM Partner Specs

    28/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 25

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

    The XML gateway passes the response information to the ITM adapter, which in turnremoves 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 businessprocesses. In case, the ITM application is unable to evaluate the compliance of theorder line programmatically, the ITM application notifies the compliance users for amanual compliance review. A response is not communicated back to OracleApplication until a final compliance determination is made by the compliance user.

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

  • 7/28/2019 Oracle ITM Partner Specs

    29/61

    Oracle International Trade Management Partner Integration

    Intlptnrint.doc OracleConfidential - For internal use only

    Export ComplianceActivity

    (Oracle Order Mgt.)

    Run all exportrules for theorder line

    ExpComp

    Pa

    Block Order LineWorkflow Activity

    Interface TablesPopulated

    (Oracle ITMAdapter)

    Sales Order LineScheduled

    (Oracle Order Mgt.)

    XML Generation(Oracle ITM

    Adapter)

    Receive XMLMessage andAcknowledge

    Async. XML Responseto

    Oracle(Compliance=Pass)

    and ReceiveAcknowledgement

    Receive XMLMessage andAcknowledge

    (XML Gateway)

    Receive XMLMessage andAcknowledge

    (XML Gateway)

    Remove theOrder Line

    Workflow block

    Place the OrderLine on Hold

    Oracle ApplicationsPartner ITM

    App licat ion

    XML Transmission toITM Application and

    ReceiveAcknowledgement

    (Oracle ITM Adapter)

    Ack.Received?

    Yes

    No

    Yes

    Ack.Received

    No

    Async. XML Responseto

    Oracle(Compliance=Fail)

    and ReceiveAcknowledgement

    Ack.Received

    No

    Fig 17: Order Export Compliance - Integration Flow Diagram

  • 7/28/2019 Oracle ITM Partner Specs

    30/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 27

    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 ITMs interface tables. The pre-processing API can alsobe used to populate additional attributes i.e. the Name and Value pairs provided in theUSERAREA of the message. These could be any other attributes, which you may need for exportscreening 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 forany post-processing and massaging of data once its interfaced in ITMs 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 submittedto the ITM adapters interface tables. The ITM adapter generates and transmits the exportcompliance service request XML to the partner application. A synchronous acknowledgement isexpected from the ITM application. The export compliance request XML contains all thenecessary 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 OracleApplications with the overall compliance pass or fail status for the delivery. The exportcompliance is evaluated for delivery as a whole. If a delivery is found to be compliant by thepartner application, it responds back to Oracle Application with compliant (compliance=Pass)status. The asynchronous response is received by Oracle XML gateway and a synchronous HTMLacknowledgement is provided to the partner application. Oracle XML Gateway can also be setupto provide an asynchronous XML acknowledgement.

    The XML gateway passes the response information to the ITM adapter, which in turn handles theexception, originally logged against the delivery to prevent ship confirmation. If a delivery isdetermined 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 upontheir business processes. In case, the ITM application is unable to evaluate the compliance of adelivery programmatically, the ITM application notifies the compliance users for a manualcompliance review. A response is not communicated back to Oracle Application until a finalcompliance determination is made by the compliance user.

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

  • 7/28/2019 Oracle ITM Partner Specs

    31/61

    Oracle International Trade Management Partner Integration

    Intlptnrint.doc OracleConfidential - For internal use only

    Run all exportrules fordelivery

    Interface TablesPopulated

    XMLGeneration

    Receive XMLMessage andAcknowledge

    Ship H

    Receive XML Messageand Acknowledge(XML Gateway)

    Receive XML Messageand Acknowledge(XML Gateway)

    Handle Submittedfor ExportScreening

    Exception for thedelivery

    Log Not Compliantfor Export

    Exception for thedelivery

    Oracle ApplicationsPartner ITM

    Appl ication

    XML Transmission toITM Application and

    ReceiveAcknowledgement

    Ack.Received?

    No

    Async. XML Response toOracle

    (Compliance=Pass)and Receive Acknowledgement

    Ack.Received?

    No

    Async. XML Response toOracle

    (Compliance=Fail)and Receive Acknowledgement

    Ack.Received

    No

    All the deliveries withRequire Export

    Screening exceptionselected

    Log Submitted forExport ScreeningException for the

    delivery

    User Submits SRSprogram SubmitDeliveries for

    Export Screening

    Any moredeliveries?

    No

    Yes

    Handle RequireExport Screening

    exception

    Yes

    Handle Submittedfor ExportScreening

    Exception for thedelivery

    Fig 18: Export Compliance for Deliveries Integration Flow Diagram

  • 7/28/2019 Oracle ITM Partner Specs

    32/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 27

    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. ThisAPI can be used by for any pre-processing and massaging of data in ITMsinterface tables. The pre-processing API can also be used to populate additionalattributes i.e. the Name and Value pairs provided in the USERAREA of themessage. These could be any other attributes, which you may need for exportscreening 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. ThisAPI can be used by for any post-processing and massaging of data once itsinterfaced in ITMs interface tables. This call out is made inWSH_ITM_CUSTOM_PROCESS package.

    API Name:

    WSH_ITM_CUSTOM_PROCESS.POST_PROCESS_WSH_REQUEST

  • 7/28/2019 Oracle ITM Partner Specs

    33/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 28

    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 isdepicted 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. Thisindicates that when that (parent) element is present, its required attributesand/or children must also be present

    Repetition of elements.

    Two types of relationships are illustrated in this diagram: one-to-one andone-to-many. One-to-one relationships are represented by a single box.One-to-many relationships are represented by multiple boxes.

    Fig 19: Item Synchronization Request Message Structure

    ITEM_SYNC

    CNTROLAREA

    RequestDATAAREA

    ITEM_ID

    RequestITEM

    .

    USERAREA

  • 7/28/2019 Oracle ITM Partner Specs

    34/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 29

    Element/Attribute Description Oracle Applications Table.Column_name

    1 ITEM

    1.1 ITEM_ID Unique Identifier of an Item(Inventory_item_id)

    MTL_SYSTEM_ITEMS_B.inventory_item_id

    1.2 ITEM_CODE Product Code. Concatenated segments of

    the Item Flexfield.

    MTL_SYSTEM_ITEMS_B.segment1..segment15

    1.3 DESCRIPTION Description of the item MTL_SYSTEM_ITEMS_TL.Description

    1.4 HAZARD_CLASS Hazard Class Classification PO_HAZARD_CLASSES_TL.(ForPO_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_ID

    Master Organization of the item. MTL_SYSTEM_ITEMS_B.src_organization_id

    1.7 ITEM_TYPE User Defined Item Type FND_COMMON_LOOKUPS.meaning (forLookup_type =ITEM_TYPE andFND_COMMON_LOOKUPS.lookup_code =MTL_SYSTEM_ITEMS_B.item_type

    1.8 UNIT_OF_MEASURE Unit of Measure MTL_SYSTEM_ITEMS_B.PRIMARY_UOM_CODE

    1.9 ITEM_VALUE Value of the Item MTL_SYSTEM_ITEMS_B.LIST_PRICE_PER_

    UNIT1.10 CURRENCY Currency

    1.11 COUNTRY Country of the organization to which theitem is assigned in Oracle Application.

    HR_LOCATIONS_ALL.Country(Select hl.country from hr_all_organization_unitshu, hr_locations hl where hulocation_id =hl.location_id and hu.organization_id =MTL_SYSTEM_ITEM_B.Organization_id)

    1.12 USERAREA

    1.12.1LONG_DESCRIPTION

    Long Description of the item MTL_SYSTEM_ITEMS_TL.Long_Description

    1.12.2 OPERATING_UNIT Operating Unit of the Organization to which

    the Item is attached.

    ORG_ORGANIZATION_DEFINITIONS.Operati

    ng Unit

    1.12.3 PARAMETERS This element bounds any additionalparameters to be sent. This element has aattribute named TYPE which can have anyof the following values VENDOR or

    SERVICE or DATA.VENDOR ---- Vendor ParametersSERVICE ---- Service ParametersDATA ---- Additional Data

    Information / FlexfieldAll the 15 Descriptive Flexfield

    attributes(attribute1..atrribute15) of the Itemcan be passed as Parameters of Type Data.

    PARAMETER Every Parameter has three attributes Index, Name and Value

    Parameters of type VENDORWSH_ITM_VENDOR_PARAMETERS.Parmeter

    _name,WSH_ITM_VENDOR_PARAMETERS.Parmeter

    _valueParameters of type SERVICE

    WSH_ITM_SERVICE_PARAMETERS.Prameter

    _name,WSH_ITM_SERVICE_PARAMETERS.Prameter_valueParameters of type DATAMTL_SYSTEM_ITEMS_B.attribute1..attribute15

    Table 4: Element Description of Item Synchronization Request Message

  • 7/28/2019 Oracle ITM Partner Specs

    35/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 30

    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 ofthe installation.

    CODEPAGE Character set

    AUTHID User Name-Password

    Table 5: Element description of Control Area Elements of ItemSynchronization Request

  • 7/28/2019 Oracle ITM Partner Specs

    36/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 31

    Appendix B - Party Synchronization Request XML

    OAGs 007_sync_customer_005.dtd (Revision 7.2.1) DTD is leveraged for theparty synchronization request. Userarea has been extended to include theadditional elements. For a description of these elements refer to the table 5.

    oracle_sync_customer_005.dtd contains the userarea extensions. The structureof the party synchronization request message is illustrated in the followingdiagram:

    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 isdepicted 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. Thisindicates that when that (parent) element is present, its required attributesand/or children must also be present

    Repetition of elements.

    Two types of relationships are illustrated in this diagram: one-to-one andone-to-many. One-to-one relationships are represented by a single box.One-to-many relationships are represented by multiple boxes.

    Note:Required =Solid boxesOptional =Dashed boxes

    PARTNER

    ADDRESS

    CONTACT

    ATTCHREF

    SYNC_CUSTOMER_005

    CNTROLAREA

    USERAREA

    DATAAREA

    SYNC_CUSTOMER

    USERAREA

    USERAREA

  • 7/28/2019 Oracle ITM Partner Specs

    37/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 32

    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 thePARTNER 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 thePARTNRTYPE defines. (Site Use Id in Oracle Applications)

    HZ_CUST_SITE_USES_ALL.Site_use_id

    1.3 PARTNRTYPE PARTNRTYPE indicates the type of partner entity or the

    site use code.

    Valid values are: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 thegoods or services.Drawee - A customer drawee is a customer account siteresponsible for paying bills.Dunning The location where the customers dunningletters are sent.InvoicesLegal : This address acts as the customer accounts legal site.A legal site is responsible for all government reportingrequirements.Marketing - Marketing collateral is sent to this address.Self Service UserStatements The Customer location where the customersstatements are sent.

    Bills of Lading

    Credit MemosCredit ContactDeliver ToAcknowledgments

    FND_LOOKUPS.meaning (For

    FND_LOOKUPS.code =HZ_CUST_SITE_USES.Site_Use_Code= fnd_lookups.lookup_code)

    1.4 NAME Account Name and Alternate Name HZ_CUST_ACCOUNTS.Account_name,

    1.5 PARTNRIDX PARTNRIDX is the identifier of the partner that thereceiving application may use to identify the PARTNER.

    SynonymsCustomer NumberSupplier NumberCustomer IDSupplier IDThe Customer Number will be sent here.

    HZ_CUST_ACCOUNTS.Account_Number

    1.6 TAXID TAXID is the tax identifier of the business partner.

    Synonyms

    VAT IDFederal Tax IDState Tax ID

    Hz_parties.tax_reference

    1.7 USERAREA PARTNER LEVEL

    1.7.1SITE_NUMBER

    Site Number HZ_PARTY_SITES.Party_Site_Number

    1.7.2 OPERATING_UNIT

    Operating Unit HZ_Cust_Acct_sites_all.OrgID

    1.7.3PARAMETERS

    This element bounds any additional parameters to be sent.This element has an attribute named TYPE which can have

  • 7/28/2019 Oracle ITM Partner Specs

    38/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 33

    Element/Attribute Description Oracle Applications

    Table.Column_name

    any of the following values VENDOR or SERVICE orDATA.

    VENDOR ---- Vendor ParametersSERVICE ---- Service ParametersDATA ---- Additional Data Information /

    Descriptive Flexfield InformationAll 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 VENDORWSH_ITM_VENDOR_PARAMETERS.Parmeter_name,WSH_ITM_VENDOR_PARAMETERS.Parmeter_valueParameters of type SERVICEWSH_ITM_SERVICE_PARAMETERS.Prameter_name,WSH_ITM_SERVICE_PARAMETERS.Prameter_valueParameters of type DATAHZ_CUST_ACCOUNTS.Attribute1..15

    1.8 ADDRESS The Data Type ADDRESS represents the data concerningthe location of the business partner.

    1.8.1 ADDRLINE ADDRLINE represents the lines needed to describe streetaddress or post office box information.

    HZ_LOCATIONS.ADDRESS1..ADDRESS4

    1.8.2 ADDRTYPE ADDRTYPE represents a qualification of the address of thebusiness partner

    HZ_CUST_SITE_USES_ALL.Primary_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. Thelist of valid codes can be found in ISO Standard number3166.

    HZ_LOCATIONS.COUNTRY

    1.8.5 POSTALCODE POSTALCODE is the postal code within a mailing address.

    SynonymsZip code

    HZ_LOCATIONS.POSTAL_CODE

    1.8.6 STATEPROVN STATEPROVN is the state or province within the mailingaddress.

    HZ_LOCATIONS.STATE

    1.8.7 USERAREA ADDRESS LEVEL

    1.8.7.1PARAMETERS

    This element bounds any additional parameters to be sent.This element has an attribute named TYPE which hasvalue

    DATA ---- Additional Data Information /Descriptive Flexfield InformationAll the Descriptive Flexfield

    attributes(attribute1..attribute15) of the Customer Site Levelcan be passed in this region.

    1.8.7.1.1

    PARAMETER Every Parameter has attributes Index, Name and Value HZ_CUST_ACCT_SITES_ALL.attribute1..15

    1.9 CONTACT The Data Type CONTACT represents people associatedwith the PARTNER and various ways to contact them, suchas telephone or fax.

    1.9.1 NAME First Name and the Last Name HZ_PARTIES.Party_name (Having arecord in

    HZ_PARTY_RELATIONSHIPS withrelationship_type = CONTACT_OF

    1.9.2CONTCTTYPE

    CONTCTTYPE describes the contact personsresponsibilities.

    SynonymsJob 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_NUMBER(With Phone_Line_Type = FAX)

    1.9.5 TELEPHONE HZ_CONTACT_POINTS.PHONE_NUMBER

  • 7/28/2019 Oracle ITM Partner Specs

    39/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 34

    Element/Attribute Description Oracle Applications

    Table.Column_name

    (With Phone_Line_Type = PHONE)

    1.9.6 USERAREA CONTACT LEVEL

    1.9.6.1PARAMETERS

    This element bounds any additional parameters to be sent.This element has an attribute named TYPE which has

    valueDATA ---- Additional Data Information /

    Descriptive Flexfield InformationAll the Descriptive Flexfield

    attributes(attribute1..attribute15) of the Customer Contact orSite Contact can be passed in this region.

    1.9.6.1.1

    PARAMETER Every Parameter has attributes Index, Name and Value HZ_PARTIES.attribute1..15 (Having arecord inHZ_PARTY_RELATIONSHIPS withrelationship_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 performedon(CUSTOMER)

    REVISION

    SENDER

    LOGICALID logical location of the server and application from which the messageoriginated. (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 thebase language of the installa tion.

    CODEPAGE Character set

    AUTHID User Name-Password

    Table 7: Element description of Control Area Elements of Party

    Synchronization request

  • 7/28/2019 Oracle ITM Partner Specs

    40/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 35

    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 isdepicted 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. Thisindicates that when that (parent) element is present, its required attributesand/or children must also be present

    Repetition of elements.

    Two types of relationships are illustrated in this diagram: one-to-one andone-to-many. One-to-one relationships are represented by a single box.One-to-many relationships are represented by multiple boxes.

    REQUEST

    ADDL_INFO

    PARTY

    MESSAGE_ID

    ADMIN

    PARAMETERS

    ORDER_LINE

    TRANSACTION_KEY

    ORDER_LINE

    ITEM_ID

    ORDER_NUMBER

    CONTROL AREA

    DATA AREA

  • 7/28/2019 Oracle ITM Partner Specs

    41/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 36

    Fig 21: Order Compliance Request Message Structure

    XML Fields Tables Note Mand

    atoryOrder Represents the Order line information. Every Order line would

    map to one Order Tag and multiple Order Tags would bepresent in a message for same Order Number.

    Contains the Order HeaderInformation.

    Y

    OE_ORDER_HEADERS_ALL.ORDER_NUMBER Order Number YOE_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_CODE

    Currency N

    OE_ORDER_HEADERS_ALL.CONVERSION_TYPE_CODE

    Conversion N

    OE_ORDER_HEADERS_ALL.CONVERSION_RATE Conversion Rate N

    OE_ORDER_HEADERS_ALL.ORDERED_DATE Date of Order N

    From OE_ORDER_LINES_ALL concatenation of(LINE_NUMBER.SHIPMENT_NUMBER.OPTION_NUMBER.COMPONENT_NUMBER.SERVICE_NUMBER)

    Order Line Number

    OE_ORDER_LINES_ALL.TOP_MODEL_LINE_ID Top Model Line ID

    OE_ORDER_LINES_ALL.SPLIT_FROM_LINE_ID Split From Line ID

    OE_ORDER_LINES_ALL.LINK_TO_LINE_ID Link to Line ID

    OE_ORDER_LINES_ALL.ATO_LINE_ID ATO Line ID

    OE_ORDER_LINES_ALL.ITEM_TYPE_CODE Item Type Code

    MTL_SYSTEM_ITEMS_B.SEGMENT1..SSEGMENT15 forINVENTORY_ITEM_ID in OE_ORDER_LINES_ALL

    Item Number

    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 NITEM_ID Item ID, which 3rd Party

    Partner application canrecognize as a primary key.

    Y

    PARTY Same as currently used Party for Denied Party Y

    WSH_ITM_REQUEST_CONTROL.ATTRIBUTE1-15 Order Line DescriptiveFlexfield

    HZ_CUST_ACCOUNTS.ACCOUNT_NUMBER Customer Number

    Identification From Adapter Y

    Type like SHIP_FROM, PTNR_SHIP_TO, DELIVER To,Sold To, intermediate Ship ToThe party type is just an informatory field, which doesnt haveany functional significance for provider. Adapter can send anything, which is populated by application. So application canmaintain any codes/lookups for this.

    N

    HZ_CUST_SITE_USES_ALL.SITE_USE_ID Site Use IDHZ_CUST_SITE_USES_ALL. LOCATION Site Use Code

    Party Name N

    Address 1 N

    Address 2 N

    Address 3 N

    Address 4 N

    Address 5 N

    City N

    State N

    Country N

    Country Code N

  • 7/28/2019 Oracle ITM Partner Specs

    42/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 37

    Country Name N

    Postal Code N

    Contact Name N

    e-mail N

    Phone N

    Fax N

    www URL N

    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 performedon(CUSTOMER)

    REVISION

    SENDER

    LOGICALID logical location of the server and application from which the messageoriginated. (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 thebase language of the installa tion.

    CODEPAGE Character setAUTHID User Name-Password

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

    XML

  • 7/28/2019 Oracle ITM Partner Specs

    43/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 38

    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 ITMapplication. The response DTD, its element description and a sample of therequest is provided in Appendix 5. The same message is used from OrderManagement as well as Shipping. The structure of the message is illustrated inthe 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 isdepicted 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. Thisindicates that when that (parent) element is present, its required attributesand/or children must also be present

    Repetition of elements.

    Two types of relationships are illustrated in this diagram: one-to-one andone-to-many. One-to-one relationships are represented by a single box.One-to-many relationships are represented by multiple boxes.

    Fig 22: Export Compliance Response Message Structure

    EXPORT COMPL RESPONSE

    MESSAGE

    EXPORT_COMP_RESULT

    TRANSACTION_KEY

    CNTROLAREA

    DATAAREA

    ERROR

    TRIGERRING_POINT

  • 7/28/2019 Oracle ITM Partner Specs

    44/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 39

    Element/Attribute Description

    TRANSACTION_KEY Key referencing the Line of transaction. For Order Screening it could besomething like --.

    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 complianceconducted.

    ERROR

    CODE

    TYPE Type can be All Export Compliance Checks or Denied Party Screening orEmbargo Screening etc. Error Type is also included in case its an error.

    DESCRIPTION Description of the Error.

    Table 10: Element description of Export Compliance Response Message

  • 7/28/2019 Oracle ITM Partner Specs

    45/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 40

    Appendix E Delivery Compliance Request XML

    The OAGs SHOW SHIPMENT DTD is used as a basis for this transaction. Thepurpose of delivery compliance request XML is to communicate all thecompliance relevant delivery attributes to the partner application.

    Reqd Element/Attribute Source (Table.Column Name )

    X SHIPMENT.DATETTIME (Document)(required)

    Sys date time

    X SHIPMENT.DOCUMENTID (Shipment)(required)

    WSH_TRANSACTIONS_HISTORY.DOCUMENT_ID

    X SHIPMENT.SHIPPERID (required) WSH_NEW_DELIVERIES.INITIAL_PICKUP_LOCATION_ID converted tocode

    X SHIPMENT.SYNCID (required) XML: A = Add, D = DeleteC = ChangeEDI: 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 940SHIPMENT ADVICE for 945

    SHIPMENT.DOCUMENTRV 001 for ADD002 for DELETE003 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_WEIGHTWSH_NEW_DELIVERIES.WEIGHT_UOM

  • 7/28/2019 Oracle ITM Partner Specs

    46/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 41

    Reqd Element/Attribute Source (Table.Column Name )

    SHIPMENT.QUANTITY (LOADINGWT) Calculate usingWSH_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_WEIGHTWSH_NEW_DELIVERIES.WEIGHT_UOM

    SHIPMENT.QUANTITY (VOLUME) WSH_NEW_DELIVERIES.VOLUMEWSH_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 convertedto 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_NAMEWSH_NEW_DELIVERIES.LOADING_SEQUENCEWSH_NEW_DELIVERY descriptive flex fieldsWSH_TRIPS.VEHICLE_NUM_PREFIXWSH_TRIPS.VEHICLE_NUMBERWSH_TRIPS.ROUTE_IDWSH_TRIPS.ROUTING_INSTRUCTIONSWSH_TRIP_STOPS.DEPARTURE_SEAL_CODEWSH_NEW_DELIVERIES.SHIP_METHOD_CODE

    NVL(WSH_TRIPS.SHIP_METHOD_CODE,

    WSH_NEW_DELIVERIES.SHIP_METHOD_CODE)WSH_NEW_DELIVERIES.WAYBILLWSH_ITM_REQUEST_CONTROL.ATTRIBUTEn_NAME/ATTRIBUTEn_VA

    LUEWhere n=1 to 20WSH_ITM_REQUEST_CONTROL.TRIGGERING_POINT

    PARTNER.

    X PARTNER.NAME1 - If this partner segment is the Ship To segment, get the HZ_PARTIES.NAMEfor the WSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_ID- If this partner segment is the Ship from segment, get the HZ_PARTIES.NAMEfor the WSH_NEW_DELIVERIES.ORGANIZATION_ID- If this partner segment is the Customer segment, get the HZ_PARTIES.NAMEfor the WSH_NEW_DELIVERIES.CUSTOMER_ID- If this partner segment is the Supplier segment, get the HZ_PARTIES.NAMEfor the WSH_NEW_DELIVERIES.ORGANIZATION_ID

    X PARTNER.ONETIME

    X PARTNER.PARTNRID (required) WSH_NEW_DELIVERIES.ULTIMATE_DROPOFF_LOCATION_IDconverted to external value, orWSH_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.

  • 7/28/2019 Oracle ITM Partner Specs

    47/61

    Oracle International Trade Management Partner Integration Specifications

    Intlptnrint.doc OracleConfidential - For internal use only 42

    Reqd Element/Attribute Source (Table.Column Name )

    ShipFrom - The shipping location of the partner who is responsible forproviding the goods or services. Ship from can be at multiple organizationallevels.Intmd_ShipTo Intermeidate Ship for the deliveryFOB- FOB for the delivery

    PARTNER.ACTIVE

    PARTNER.CURRENCY WSH_NEW_DELIVERIES.CURRENCY_CODE for the supplier and ship frompartner 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_IDthat 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_IDWSH_ NEW_DELIVERIES.POOLED_SHIP_TO_LOCATION_IDHZ_CUST_SITE_USES_ALL.SITE_USE_IDHZ_CUST_SITE_USES_ALL.LOCATION

    PARTNER ADDRESS.

    PARTNER ADDRESS.ADDRLINE1-ADDRLINE9

    Extracted from the HZ_LOCATIONS using the party id that matches the ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_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 ShipFrom, 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 ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.

    PARTNER ADDRESS.COUNTY Extracted from the HZ_LOCATIONS using the party id that matches the ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_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, andCONTACT_POINT_TYPE = FAX

    PARTNER ADDRESS.POSTALCODE Extracted from the HZ_LOCATIONS using the party id that matches the ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.

    PARTNER ADDRESS.REGION Extracted from the HZ_LOCATIONS using the party id that matches the ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.

    PARTNER ADDRESS.STATEPROVN Extracted from the HZ_LOCATIONS using the party id that matches the ShipFrom, Ship TO, Customer and Supplier from the WSH_NEW_DELIVERIES orWSH_DELIVERY_DETAILS table, via the HZ_PARTY_SITES table.

    PARTNER ADDRESS.TAXJRSDCTN

    PARTNER ADDRESS.TELEPHONE1-TELEPHONE9

    HZ_CONTACT_POINTS.RAW_PHONE_NUMBER for the PARTY_ID, andCONTACT_POINT_TYPE = GEN

    PARTNER ADDRESS.URL HZ_CONTACT_POINTS.URL for the PARTY_ID andCONTACT_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

  • 7/2