oracle apps order management open interfaces, api, & electronic messaging guide

1170
Oracle® Order Management Open Interfaces, API, & Electronic Messaging Guide Release 11i Part No. B14446-01 September 2004

Upload: ssg

Post on 18-Nov-2014

6.620 views

Category:

Documents


7 download

DESCRIPTION

APPS E-Business Suite Order Management - ONT

TRANSCRIPT

Oracle Order ManagementOpen Interfaces, API, & Electronic Messaging Guide Release 11iPart No. B14446-01

September 2004

Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 11i Part No. B14446-01 Copyright 1996, 2004 Oracle Corporation. All rights reserved. Contributing Authors: Rajeev Bellamkonda, Charlene Chandonia, Kathleen Gahan, Aswin Kurella, Bernard Ladent, Nithya Lakshmanan, Jerome Mcfarland, Prakash Ojha, Gayatri Pendse, Sameer Phatarpekar, Alok Singh, Sumeet Rijhsinghani, Krishna Venkatesan, Anil Verma, Jessica Zhang, Manisha Nair, William Nelson, Alok Singh, Kannan Tarakad Contributors: John Brazier, Elizabeth Looney, Jennifer Mosinski, Tom Myers, David Reitan, John Salvini The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent and other intellectual and industrial property laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

ContentsSend Us Your Comments .................................................................................................................. xv Preface......................................................................................................................................................... xviiAudience for This Guide................................................................................................................... xvii How To Use This Guide .................................................................................................................... xvii Conventions................................................................................................................................... xviii Documentation Accessibility ...................................................................................................... xviii Other Information Sources ................................................................................................................ xix Online Documentation.................................................................................................................. xix Related Users Guides.................................................................................................................... xx Guides Related to All Products .................................................................................................... xx User Guides Related to This Product .......................................................................................... xx Installation and System Administration .................................................................................. xxiv Other Implementation Documentation..................................................................................... xxv Training and Support.................................................................................................................. xxvi Do Not Use Database Tools to Modify Oracle Applications Data.......................................... xxvii About Oracle...................................................................................................................................... xxviii Your Feedback ................................................................................................................................... xxviii

1

Integrating Your SystemsOverview of Oracle Order Management APIs and Open Interfaces........................................ Basic Business Needs ................................................................................................................... Oracle Order Management Interfaces ....................................................................................... Inbound Open Interface Model .................................................................................................. 1-2 1-2 1-2 1-8

iii

Components of an Open Interface ........................................................................................... 1-10

2 Oracle Order Management Open Interfaces and APIsIntegrating Oracle Order Management Using Order Import..................................................... 2-4 Process Order Application Open Interface.................................................................................. 2-69 Process Order API Features ...................................................................................................... 2-70 Functional Overview.................................................................................................................. 2-80 Processing the Sales Order business object............................................................................. 2-80 Setting Up the Process Order Procedure................................................................................. 2-84 Setting Up the Get_Order Procedure....................................................................................... 2-93 Setting Up the Lock_Order Procedure .................................................................................... 2-97 PL/SQL Record Structures...................................................................................................... 2-103 Process Order Usage ................................................................................................................ 2-148 Integrating Oracle Order Management with Oracle Receivables and Invoicing............... 2-159 Basic Needs ................................................................................................................................ 2-159 Major Features........................................................................................................................... 2-159 Invoicing of ATO Configurations........................................................................................... 2-165 Understanding the Receivables Interface Tables ................................................................. 2-166

3 Release Management Open InterfaceUnderstanding the Interface Tables ................................................................................................ 3-2 RLM_INTERFACE_HEADERS_ALL.............................................................................................. 3-2 RLM_INTERFACE_LINES_ALL.................................................................................................... 3-22

4 Oracle Shipping Execution Public APIsOverview of API Information .......................................................................................................... Shipment Processing Using APIs .................................................................................................... Shipping Transaction Form/Public API Correlation .............................................................. Sample Flow Scenarios................................................................................................................. API Package and Procedures Example.......................................................................................... Package......................................................................................................................................... Procedures ................................................................................................................................... Script ............................................................................................................................................. Actions, APIs, and Parameters ....................................................................................................... 4-2 4-3 4-3 4-9 4-15 4-15 4-15 4-24 4-26

iv

Application Parameter Initialization ............................................................................................ Trip Public Application Program Interface ................................................................................. Create_Update_Trip API Features........................................................................................... Functional Overview.................................................................................................................. Trip_Action API Features.......................................................................................................... Functional Overview.................................................................................................................. Stop Public Application Program Interface................................................................................. Create_Update_Stop API Features .......................................................................................... Functional Overview.................................................................................................................. Stop_Action API Features ......................................................................................................... Functional Overview.................................................................................................................. Deliveries Public Application Program Interface ...................................................................... Create_Update_Delivery API Features ................................................................................... Functional Overview.................................................................................................................. Delivery_Action API Features .................................................................................................. Functional Overview.................................................................................................................. Generate_Documents API Features ......................................................................................... Functional Overview.................................................................................................................. Setting Up the Generate_Documents API............................................................................... Exceptions Application Program Interface .................................................................................. Exception_Action API Features................................................................................................ Functional Overview.................................................................................................................. Setting Up the Exception_Actions API.................................................................................... Get_Exceptions API Features.................................................................................................... Functional Overview.................................................................................................................. Setting Up the Get_Exceptions API ......................................................................................... Delivery Details Public Application Program Interface........................................................... Detail_To_Delivery API Features............................................................................................. Functional Overview.................................................................................................................. Split_Line API Features ............................................................................................................. Functional Overview.................................................................................................................. Update_Shipping_Attributes API Features............................................................................ Functional Overview.................................................................................................................. Autocreate_Deliveries API Features...................................................................................... Autocreate_Del_Trip API Features........................................................................................

4-39 4-40 4-40 4-40 4-46 4-46 4-49 4-49 4-49 4-56 4-56 4-59 4-59 4-59 4-70 4-70 4-76 4-76 4-77 4-79 4-79 4-79 4-79 4-87 4-87 4-87 4-90 4-90 4-90 4-94 4-94 4-97 4-97 4-110 4-113

v

Container Public Application Program Interface ..................................................................... Create_Containers API Features ............................................................................................ Functional Overview................................................................................................................ Update Container API Features.............................................................................................. Functional Overview................................................................................................................ Auto_Pack API Features .......................................................................................................... Functional Overview................................................................................................................ Container_Actions API Features ............................................................................................ Functional Overview................................................................................................................ Freight Costs Public Application Program Interface ............................................................... Create_Update_Freight_Costs API Features ........................................................................ Functional Overview................................................................................................................ Validate_Freight_Cost_Type API Features........................................................................... Delete_Freight_Costs API Features........................................................................................ Functional Overview................................................................................................................ Pick Release Application Program Interface ............................................................................. Create_Batch API Features ...................................................................................................... Functional Overview................................................................................................................ Release_Batch API Features .................................................................................................... Functional Overview................................................................................................................ Migration from Open Interfaces to Public APIs.......................................................................

4-116 4-116 4-116 4-120 4-120 4-128 4-128 4-131 4-131 4-134 4-134 4-134 4-141 4-142 4-142 4-148 4-148 4-149 4-160 4-160 4-163

5 Oracle Advanced Pricing Open InterfacesAgreements Public Application Program Interface ..................................................................... Functional Overview.................................................................................................................... Setting Up and Parameter Descriptions .................................................................................... Validation of Agreements Public API...................................................................................... Example of Agreements Public API......................................................................................... Attribute Mapping Application Program Interface ................................................................... Functional Overview.................................................................................................................. Setting Up and Parameter Descriptions .................................................................................. Business Object for Modifier Setup Application Program Interface ..................................... Functional Overview.................................................................................................................. Setting Up and Parameter Descriptions .................................................................................. Validation of Business Object for Modifier Setup API.......................................................... 5-3 5-3 5-3 5-22 5-22 5-49 5-49 5-50 5-60 5-60 5-61 5-94

vi

Example of Modifier Setup Application Program Interface ................................................ Business Object for Pricing Formulas Application Program Interface................................ Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Business Object for Pricing Formulas API.................................................... Example of Pricing Formulas API.......................................................................................... Business Object for Pricing Limits Application Program Interface ..................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Limits Public API.............................................................................................. Example of Limits Public API................................................................................................. Get Currency Application Program Interface ........................................................................... Get Currency API Features ..................................................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Get_Currency API ............................................................................................ Get Custom Price Application Program Interface.................................................................... Get Custom Price API Features .............................................................................................. Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Get Custom Price API ...................................................................................... Get Price List Application Program Interface ........................................................................... Get Price List API Features ..................................................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Get_Price_List API ........................................................................................... Multi-Currency Conversion Setup Application Program Interface ..................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Multi-Currency Conversion API.................................................................... Example of Multi-Currency Conversion API....................................................................... Price List Setup Application Program Interface ....................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Price List Setup API .........................................................................................

5-94 5-133 5-133 5-134 5-144 5-144 5-157 5-157 5-158 5-168 5-169 5-177 5-177 5-177 5-177 5-178 5-179 5-179 5-179 5-179 5-181 5-185 5-185 5-185 5-185 5-186 5-187 5-187 5-188 5-194 5-194 5-199 5-199 5-200 5-213

vii

Example of Price List Setup API............................................................................................. Price List Setup Group Application Program Interface .......................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Price List Group API ........................................................................................ Price Request Application Program Interface ........................................................................... Price Request API Features ..................................................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Price Request API ............................................................................................. Example of Price Request Application Program Interface ................................................. Pricing Object Security - Check Function API.......................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Pricing Object Security API ................................................................................. Standard Validation ................................................................................................................. QP_ATTRIBUTES_PUB Application Program Interface ........................................................ Functional Overview................................................................................................................ QP_ATTR_MAPPING_PUB Application Program Interface................................................. Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Attribute Mapping API.................................................................................... Qualifiers Application Program Interface ................................................................................. Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Qualifiers API.................................................................................................... Example of Qualifiers API....................................................................................................... Reverse Limits Application Program Interface......................................................................... Reverse Limits API Features ................................................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Reverse Limits API ........................................................................................... Round Price Application Program Interface ............................................................................. Round Price API Features ....................................................................................................... Functional Overview................................................................................................................

5-213 5-240 5-240 5-241 5-254 5-255 5-255 5-256 5-257 5-286 5-286 5-290 5-290 5-291 5-292 5-292 5-293 5-293 5-303 5-303 5-303 5-307 5-308 5-308 5-308 5-324 5-324 5-328 5-328 5-328 5-328 5-330 5-333 5-333 5-333

viii

Setting Up and Parameter Descriptions ................................................................................ Validation of Round Price API ............................................................................................... Validate_Price_list_Curr_code Application Program Interface............................................. Validate_Price_list_Curr_code API Features ....................................................................... Functional Overview................................................................................................................ Setting Up and Parameter Descriptions ................................................................................ Validation of Validate_Price_list_Curr_code API ...............................................................

5-334 5-334 5-336 5-336 5-336 5-336 5-336

6

Oracle Order Management EDI TransactionsOracle Order Management ............................................................................................................. Inbound Purchase Order (POI/850/ORDERS) .............................................................................. Trading Partner Link to Oracle e-Commerce Gateway .......................................................... Oracle e-Commerce Gateway Required Fields ........................................................................ TP_TRANSLATOR_CODE, TP_LOCATION_CODE (EDI Location Code)....................... Review Oracle e-Commerce Gateway Exceptions................................................................... Resolve Oracle e-Commerce Gateway Exceptions .................................................................. Relevant Oracle Order Management Profiles and Setup Steps ............................................. Oracle Order Management Defaulting Functionality ............................................................. Order Import Open Interface Data Levels ................................................................................ Line and Shipment Records ...................................................................................................... Original System Reference Data in all Order Import Tables................................................ ORIG_SYS_DOCUMENT_REF ................................................................................................ ORIG_SYS_LINE_REF ............................................................................................................. ORIG_SYS_SHIPMENT_REF ................................................................................................... Alternative Original System Shipment Reference ................................................................. Comment Text.................................................................................................................................... Flags.............................................................................................................................................. Validate Mode Parameter in Concurrent Manager ............................................................... Order Import Open Interface Data ......................................................................................... OE_HEADERS_INTERFACE Table......................................................................................... Update Columns:........................................................................................................................ OE_LINES_INTERFACE Table ............................................................................................... Update Columns:........................................................................................................................ Original System Reference Data:.............................................................................................. Update Columns:........................................................................................................................ 6-2 6-4 6-4 6-4 6-6 6-6 6-6 6-6 6-7 6-7 6-11 6-13 6-15 6-16 6-17 6-18 6-22 6-22 6-23 6-24 6-32 6-35 6-36 6-38 6-39 6-39

ix

OE_PRICE_ADJS_INTERFACE Table..................................................................................... Original System Reference Data: .............................................................................................. Update Columns: ........................................................................................................................ Update Columns: ........................................................................................................................ OE_RESERVTNS_INTERFACE Table ..................................................................................... Update Columns: ........................................................................................................................ OE_ACTIONS_INTERFACE Table.......................................................................................... Update Columns: ........................................................................................................................ Review Order Management Open Interface Exceptions........................................................... Resolve Order Management Open Interface Exceptions ...................................................... Order Import Item Cross-Referencing.......................................................................................... Inventory Tables ......................................................................................................................... Cross Reference Types for the Customer Item Cross Reference Table ............................... Cross Reference Types for the Inventory Item Cross Reference Table ............................... Data in the e-Commerce Gateway Transaction ........................................................................... Table Searches ............................................................................................................................. Miscellaneous Item Data............................................................................................................ Inbound Purchase Order Change (POCI/860/ORDCHG) .................................................. Outbound Purchase Order Acknowledgment (POAO/855/ORDRSP) (POCAO/865/ORDRSP) 6-59 Order Management Transaction Summaries............................................................................... Inbound Purchase Order (POI/850/ORDERS).................................................................... Inbound Purchase Order (POI/850/ORDERS).................................................................... Inbound Purchase Order (POI/850/ORDERS).................................................................... Inbound Purchase Order (POI/850/ORDERS).................................................................... Inbound Purchase Order Change (POCI/860/ORDCHG) ................................................. Inbound Purchase Order Change (POCI/860/ORDCHG) .................................................. Inbound Purchase Order Change (POCI/860/ORDCHG) ................................................. Inbound Purchase Order Change (POCI/860/ORDCHG) ................................................. Outbound Purchase OrderAcknowledgment (POAO/855/ORDRSP)(POCAO/865/ORDRSP) 6-85 Outbound Purchase Order Acknowledgement (POAO/855/ORDRSP) (POCAO/865/ORDRSP) 6-86 Outbound Purchase Order Acknowledgement (POAO/855/ORDRSP) (POCAO/865/ORDRSP) 6-88 User Guide Update for Order Management Transactions .......................................................

6-40 6-40 6-40 6-41 6-42 6-43 6-43 6-44 6-45 6-45 6-46 6-46 6-47 6-48 6-49 6-51 6-57 6-58

6-60 6-61 6-62 6-62 6-65 6-73 6-74 6-74 6-77

6-92

x

Purchase Order Inbound (POI) Program ................................................................................ Prerequisites ................................................................................................................................ Purchase Order Inbound Program........................................................................................... Purchase Order Change Inbound (POCI) Program.................................................................... Prerequisite Setup in Oracle Order Management................................................................. Prerequisites ................................................................................................................................ Purchase Order Change Inbound ............................................................................................ Purchase Order Acknowledgment Outbound (POAO) Program ....................................... Prerequisites ................................................................................................................................ Purchase Order Acknowledgement Outbound Program..................................................... Purchase Order Change Acknowledgment Outbound (POCAO) Program...................... Prerequisites ................................................................................................................................ ReadMe for November, 2000 Patch.............................................................................................. Purchase Order Inbound (POI) Patch Readme .................................................................... Additional Information for the March 2001 Patch ................................................................... PATCH: ...................................................................................................................................... IMPORTANT: ........................................................................................................................... RECORDS 4000: (Shipment level data) .................................................................................

6-92 6-92 6-93 6-95 6-95 6-95 6-95 6-97 6-97 6-97 6-99 6-99 6-102 6-102 6-104 6-104 6-104 6-106

7 Electronic Messaging Techincal InformationWhat is RosettaNet? ........................................................................................................................... Process_PO ........................................................................................................................................... Major Features............................................................................................................................... CONFIRM BOD ............................................................................................................................ Message Details............................................................................................................................. Extension Tags ............................................................................................................................ Acknowledge_PO ............................................................................................................................. Overview...................................................................................................................................... Major Features............................................................................................................................. Message Map............................................................................................................................... Seeded Workflow ....................................................................................................................... Show_SalesOrder ............................................................................................................................. Show_salesorder Overview ...................................................................................................... Major Features............................................................................................................................. Business Scenarios and Process Flow ...................................................................................... 7-2 7-4 7-4 7-6 7-7 7-28 7-34 7-34 7-34 7-35 7-49 7-50 7-50 7-50 7-51

xi

Message Map............................................................................................................................... Message Map............................................................................................................................... Message Set Up ........................................................................................................................... Seeded Workflow........................................................................................................................ Change_salesorder............................................................................................................................ Overview...................................................................................................................................... Major Features............................................................................................................................. Message Map ..................................................................................................................................... Load/Delete Maps, Load/Delete DTDs ................................................................................ Message Details........................................................................................................................... Workflow Event Setup............................................................................................................... Workflow (oexwfoa.wft)............................................................................................................ Lookups........................................................................................................................................ Inbound Change PO Request......................................................................................................... Overview...................................................................................................................................... Major Features ................................................................................................................................. Message Map ..................................................................................................................................... Seeded Workflow for Inbound XML Messages ................................................................... Message Details......................................................................................................................... Extension Tags .......................................................................................................................... Cancel Purchase Order................................................................................................................... Overview.................................................................................................................................... Major Features........................................................................................................................... Business and Process Flow ...................................................................................................... CONFIRM BOD ........................................................................................................................ Message Map............................................................................................................................. Seeded Workflow for Inbound XML Messages ................................................................... Message Details......................................................................................................................... Extension Tags .......................................................................................................................... Open Interface Tracking ................................................................................................................ Overview.................................................................................................................................... Major Features ................................................................................................................................. Business Scenarios and Process Flow ......................................................................................... Messages ........................................................................................................................................... Event/Event Subscription .......................................................................................................

7-52 7-59 7-60 7-67 7-68 7-68 7-68 7-71 7-71 7-79 7-80 7-81 7-81 7-83 7-83 7-83 7-87 7-105 7-108 7-111 7-117 7-117 7-117 7-120 7-120 7-121 7-128 7-132 7-135 7-140 7-140 7-140 7-141 7-142 7-144

xii

Seeded workflow OEEM/Open Interface Tracking............................................................ 7-144 Event Parameters & Population ............................................................................................. 7-144

8 Electronic Messaging Implementation ConsiderationsProcess_PO ........................................................................................................................................... Setup ............................................................................................................................................... Customer Setup ............................................................................................................................ Installation ..................................................................................................................................... Message Map................................................................................................................................. Seeded Workflow for Inbound XML Messages ....................................................................... Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO ................................... Acknowledge_PO ............................................................................................................................. Setup ............................................................................................................................................. Customer Setup .......................................................................................................................... Oracle XML Gateway Details ................................................................................................... Show_SalesOrder ............................................................................................................................. Setup ............................................................................................................................................. Customer Setup .......................................................................................................................... Additional User Setup to Enable.............................................................................................. User Procedures.......................................................................................................................... Change_SalesOrder.......................................................................................................................... Setup ............................................................................................................................................. Customer Setup .......................................................................................................................... Data Archive and Purge Procedures ....................................................................................... Change_PO......................................................................................................................................... Setup ............................................................................................................................................. Customer Setup .......................................................................................................................... Implementation Considerations............................................................................................... Message Map............................................................................................................................... Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO ................................... Cancel_PO .......................................................................................................................................... Setup ............................................................................................................................................. Customer Setup .......................................................................................................................... Implementation Considerations............................................................................................... Open Interface Tracking.................................................................................................................. 8-2 8-2 8-2 8-8 8-9 8-9 8-14 8-23 8-24 8-24 8-27 8-29 8-29 8-29 8-33 8-34 8-43 8-43 8-43 8-47 8-48 8-48 8-48 8-51 8-51 8-53 8-63 8-63 8-63 8-68 8-68

xiii

Setup ............................................................................................................................................. Customer Setup........................................................................................................................... Integration Event oracle.apps.ont.oi.xml_int.status................................................................ User Procedures ..........................................................................................................................

8-68 8-68 8-69 8-76

9 Order Management Suite ProductsRelease Management ......................................................................................................................... Planning Schedule ........................................................................................................................ Shipping Schedule ........................................................................................................................ Shipping ............................................................................................................................................... Purpose Codes............................................................................................................................... Planning/Shipping Inbound....................................................................................................... Transportation Execution................................................................................................................... Tracking Message ......................................................................................................................... DSNO .................................................................................................................................................. 9-2 9-2 9-2 9-3 9-3 9-5 9-7 9-8 9-12

A

Electronic Messaging MessagesProcess_PO and Acknowledge_PO ................................................................................................. Show_SalesOrder................................................................................................................................ Cancel_PO ............................................................................................................................................ Change SO............................................................................................................................................ Inbound Change PO Request........................................................................................................... A-2 A-3 A-4 A-6 A-7

Index

xiv

Send Us Your CommentsOracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 11iPart No. B14446-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision.

Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most?

If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways: Electronic mail: [email protected] FAX: 650-506-7294 Attn: Oracle Order Management Open Interfaces, API, & Electronic Messaging If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address.

If you have problems with the software, please contact your local Oracle Support Services.

xv

xvi

PrefaceAudience for This GuideWelcome to Release 11i of the Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide. This guide assumes you have a working knowledge of the following:

The principles and customary practices of your business area. Oracle Order Management If you have never used Oracle Order Management, Oracle suggests you attend one or more of the Oracle Order Management training classes available through Oracle University.

The Oracle Applications graphical user interface. To learn more about the Oracle Applications graphical user interface, read the Oracle Applications Users Guide.

See Other Information Sources for more information about Oracle Applications product information.

How To Use This GuideThis guide contains the information you need to understand and use Oracle Order Management.

Chapter 1 gives you an overview of Order Management integration tools and explains how to use these tools to integrate Oracle Manufacturing products with one another and with non-Oracle systems. Chapter 2 contains information about Oracle Order Management. Chapter 3 contains information about Oracle Pricing. Chapter 4 contains information about Oracle Release Management. Chapter 5 contains information about Oracle Shipping. Chapter 6 contains information about Oracle EDI. Chapter 7 contains information about Electronic Messaging Technical details.

xvii

Chapter 8 contains information about Electronic Messaging Implementation details. Chapter 9 contains information about other Order Management Suite products, Electronic Messaging details. Appendix A contains information about Electronic Messaging messages.

ConventionsThe following conventions are used in this manual:Convention . . . ... Meaning Vertical ellipsis points in an example mean that information not directly related to the example has been omitted. Horizontal ellipsis points in statements or commands mean that parts of the statement or command not directly related to the example have been omitted Boldface type in text indicates a term defined in the text, the glossary, or in both locations. Angle brackets enclose user-supplied names. Brackets enclose optional clauses from which you can choose one or none.

boldface text

[]

Documentation AccessibilityOur goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle Corporation is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/.

xviii

Accessibility of Code Examples in DocumentationJAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace.

Accessibility of Links to External Web Sites in DocumentationThis documentation may contain links to Web sites of other companies or organizations that Oracle Corporation does not own or control. Oracle Corporation neither evaluates nor makes any representations regarding the accessibility of these Web sites.

Other Information SourcesYou can choose from many sources of information, including online documentation, training, and support services, to increase your knowledge and understanding of Oracle Order Management. If this guide refers you to other Oracle Applications documentation, use only the Release 11i versions of those guides.

Online DocumentationAll Oracle Applications documentation is available online (HTML or PDF).

Online Help - The new features section in the HTML help describes new features in 11i. This information is updated for each new release of Oracle Order Management. The new features section also includes information about any features that were not yet available when this guide was printed. For example, if your administrator has installed software from a mini-packs an upgrade, this document describes the new features. Online help patches are available on MetaLink. About Documentation - The Oracle Order Management About Documentation contains new and changed features, software updates, upgrade considerations, new and changed setup steps, new and changed windows, and new and changed public APIs for the latest release of Oracle Order Management. The About document is available on Oracle MetaLink. Readme File - Refer to the readme file for patches that you have installed to learn about new documentation or documentation patches that you can download.

xix

Related Users GuidesOracle Order Management shares business and setup information with other Oracle Applications products. Therefore, you may want to refer to other users guides when you set up and use Oracle Order Management. You can read the guides online by choosing Library from the expandable menu on your HTML help window, by reading from the Oracle Applications Document Library CD included in your media pack, or by using a Web browser with a URL that your system administrator provides. If you require printed guides, you can purchase them from the Oracle Store at http://oraclestore.oracle.com.

Guides Related to All ProductsOracle Applications Users GuideThis guide explains how to enter data, query, run reports, and navigate using the graphical user interface (GUI) available with this release of Oracle Order Management (and any other Oracle Applications products). This guide also includes information on setting user profiles, as well as running and reviewing reports and concurrent processes. You can access this users guide online by choosing Getting Started with Oracle Applications from any Oracle Applications help file.

User Guides Related to This ProductOracle Applications Users Guide This guide explains how to enter data, query, run reports, and navigate using the graphical user interface (GUI) available with this release of Oracle Applications products. This guide also includes information on setting user profiles, as well as running and reviewing reports and concurrent processes. You can access this users guide online by choosing Getting Started with Oracle Applications from any Oracle Applications help file. Oracle Applications Demonstration Users Guide This guide documents the functional storyline and product flows for Global Computers, a fictional manufacturer of personal computers products and services. As well as including product overviews, the book contains detailed discussions and examples across each of the major

xx

product flows. Tables, illustrations, and charts summarize key flows and data elements.

Reference ManualsOracle Automotive Implementation Manual This manual describes the setup and implementation of the Oracle Applications used for the Oracle Automotive solution. Oracle Applications Message Reference Manual This manual describes all Oracle Applications messages. This manual is available in HTML format on the documentation CD-ROM for Release 11i. Oracle Project Manufacturing Implementation Manual This manual describes the setup steps and implementation for Oracle Project Manufacturing. Oracle Self-Service Web Applications Implementation Manual This manual describes the setup steps for Oracle Self-Service Web Applications and the Web Applications dictionary.

Installation and System AdministrationOracle Alert Users Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency, use this manual before implementing the Oracle Applications product. This manual details additional steps and setup considerations for implementation. Multiple Organizations in Oracle Applications If you use the Oracle Applications Multiple Organization Support feature to use multiple sets of books for one product installation, this guide describes all you need to know about setting up and using the product with this feature. Oracle Applications Implementation Wizard Users Guide If you are implementing more than one Oracle product, you can use the Oracle Applications Implementation Wizard to coordinate your setup activities. This guide describes how to use the wizard.

xxi

Oracle Applications Developers Guide This guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards. It also provides information to help you build your custom Developer/2000 forms so that they integrate with Oracle Applications. Oracle Applications Flexfields Guide This guide provides flexfields planning, setup and reference information for the implementation team, as well as for users responsible for the ongoing maintenance of Oracle Applications product data. This manual also provides information on creating custom reports on flexfields data. Oracle Applications Installation Manual for Windows Clients This guide provides information you need to successfully install Oracle Financials, Oracle Public Sector Financials, Oracle Manufacturing, or Oracle Human Resources in your specific hardware and operating system software environment. Oracle Applications Upgrade Preparation Manual This guide explains how to prepare your Oracle Applications products for an upgrade. It also contains information on completing the upgrade procedure for each product. Refer to this manual and the Oracle Applications Installation Manual when you plan to upgrade your products. Oracle Applications System Administrators Guide This manual provides planning and reference information for the System Administrator.

Oracle Applications ConceptsThis guide provides an introduction to the concepts, features, technology stack, architecture, and terminology for Oracle Applications Release 11i. It provides a useful first book to read before an installation of Oracle Applications. This guide also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS), languages and character sets, and Self-Service Web Applications.

Installing Oracle ApplicationsThis guide provides instructions for managing the installation of Oracle Applications products. In Release 11i, much of the installation process is handled using Oracle Rapid Install, which minimizes the time to install Oracle Applications, the Oracle8 technology stack, and the Oracle8i Server technology stack by automating many of the required steps. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your

xxii

installation. You should use this guide in conjunction with individual product users guides and implementation guides.

Upgrading Oracle ApplicationsRefer to this guide if you are upgrading your Oracle Applications Release 10.7 or Release 11.0 products to Release 11i. This guide describes the upgrade process and lists database and product-specific upgrade tasks. You must be either at Release 10.7 (NCA, SmartClient, or character mode) or Release 11.0, to upgrade to Release 11i. You cannot upgrade to Release 11i directly from releases prior to 10.7.

Maintaining Oracle ApplicationsUse this guide to help you run the various AD utilities, such as AutoUpgrade, AutoPatch, AD Administration, AD Controller, AD Relink, License Manager, and others. It contains how-to steps, screenshots, and other information that you need to run the AD utilities. This guide also provides information on maintaining the Oracle applications file system and database.

Oracle Applications System Administrators GuideThis guide provides planning and reference information for the Oracle Applications System Administrator. It contains information on how to define security, customize menus and online help, and manage concurrent processing.

Oracle Alert Users GuideThis guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data.

Oracle Applications Developers GuideThis guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards for Forms-Based Products. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications.

Oracle Applications User Interface Standards for Forms-Based ProductsThis guide contains the user interface (UI) standards followed by the Oracle Applications development staff. It describes the UI for the Oracle Applications

xxiii

products and how to apply this UI to the design of an application built by using Oracle Forms.

Installation and System AdministrationOracle Applications ConceptsThis guide provides an introduction to the concepts, features, technology stack, architecture, and terminology for Oracle Applications Release 11i. It provides a useful first book to read before an installation of Oracle Applications. This guide also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS), languages and character sets, and Self-Service Web Applications.

Installing Oracle ApplicationsThis guide provides instructions for managing the installation of Oracle Applications products. In Release 11i, much of the installation process is handled using Oracle Rapid Install, which minimizes the time to install Oracle Applications, the Oracle8 technology stack, and the Oracle8i Server technology stack by automating many of the required steps. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your installation. You should use this guide in conjunction with individual product users guides and implementation guides.

Upgrading Oracle ApplicationsRefer to this guide if you are upgrading your Oracle Applications Release 10.7 or Release 11.0 products to Release 11i. This guide describes the upgrade process and lists database and product-specific upgrade tasks. You must be either at Release 10.7 (NCA, SmartClient, or character mode) or Release 11.0, to upgrade to Release 11i. You cannot upgrade to Release 11i directly from releases prior to 10.7.

Maintaining Oracle ApplicationsUse this guide to help you run the various AD utilities, such as AutoUpgrade, AutoPatch, AD Administration, AD Controller, AD Relink, License Manager, and others. It contains how-to steps, screenshots, and other information that you need to run the AD utilities. This guide also provides information on maintaining the Oracle applications file system and database.

xxiv

Oracle Applications System Administrators GuideThis guide provides planning and reference information for the Oracle Applications System Administrator. It contains information on how to define security, customize menus and online help, and manage concurrent processing.

Oracle Alert Users GuideThis guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data.

Oracle Applications Developers GuideThis guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards for Forms-Based Products. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications.

Oracle Applications User Interface Standards for Forms-Based ProductsThis guide contains the user interface (UI) standards followed by the Oracle Applications development staff. It describes the UI for the Oracle Applications products and how to apply this UI to the design of an application built by using Oracle Forms.

Other Implementation DocumentationMultiple Reporting Currencies in Oracle ApplicationsIf you use the Multiple Reporting Currencies feature to record transactions in more than one currency, use this manual before implementing Oracle Order Management. This manual details additional steps and setup considerations for implementing Oracle Order Management with this feature.

Multiple Organizations in Oracle ApplicationsThis guide describes how to set up and use Oracle Order Management with Oracle Applications' Multiple Organization support feature, so you can define and support different organization structures when running a single installation of Oracle Order Management.

xxv

Oracle Workflow GuideThis guide explains how to define new workflow business processes as well as customize existing Oracle Applications-embedded workflow processes.You also use this guide to complete the setup steps necessary for any Oracle Applications product that includes workflow-enabled processes.

Oracle Applications Flexfields GuideThis guide provides flexfields planning, setup and reference information for the Oracle Order Management implementation team, as well as for users responsible for the ongoing maintenance of Oracle Applications product data. This manual also provides information on creating custom reports on flexfields data.

Oracle eTechnical Reference ManualsEach eTechnical Reference Manual (eTRM) contains database diagrams and a detailed description of database tables, forms, reports, and programs for a specific Oracle Applications product. This information helps you convert data from your existing applications, integrate Oracle Applications data with non-Oracle applications, and write custom reports for Oracle Applications products. Oracle eTRM is available on Metalink

Oracle Manufacturing APIs and Open Interfaces ManualThis manual contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems. This documentation includes APIs and open interfaces found in Oracle Manufacturing.

Oracle Applications Message Reference ManualThis manual describes all Oracle Applications messages. This manual is available in HTML format on the documentation CD-ROM for Release 11i.

Training and SupportTrainingOracle offers a complete set of training courses to help you and your staff master Oracle Order Management and reach full productivity quickly. These courses are organized into functional learning paths, so you take only those courses appropriate to your job or area of responsibility.

xxvi

You have a choice of educational environments. You can attend courses offered by Oracle University at any one of our many Education Centers, you can arrange for our trainers to teach at your facility, or you can use Oracle Learning Network (OLN), Oracle University's online education utility. In addition, Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. For example, you may want to use your organization structure, terminology, and data as examples in a customized training session delivered at your own facility.

SupportFrom on-site support to central support, our team of experienced professionals provides the help and information you need to keep Oracle Order Management working for you. This team includes your Technical Representative, Account Manager, and Oracles large staff of consultants and support specialists with expertise in your business area, managing an Oracle8i server, and your hardware and software environment.

Do Not Use Database Tools to Modify Oracle Applications DataOracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data Browser, database triggers, or any other tool to modify Oracle Applications data unless otherwise instructed. Oracle provides powerful tools you can use to create, store, change, retrieve, and maintain information in an Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your data and you lose the ability to audit changes to your data. Because Oracle Applications tables are interrelated, any change you make using Oracle Applications can update many tables at once. But when you modify Oracle Applications data using anything other than Oracle Applications, you may change a row in one table without making corresponding changes in related tables. If your tables get out of synchronization with each other, you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Applications. When you use Oracle Applications to modify your data, Oracle Applications automatically checks that your changes are valid. Oracle Applications also keeps track of who changes information. If you enter information into database tables using database tools, you may store invalid information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes.

xxvii

About OracleOracle Corporation develops and markets an integrated line of software products for database management, applications development, decision support, and office automation, as well as Oracle Applications, an integrated suite of more than 160 software modules for financial management, supply chain management, manufacturing, project systems, human resources and customer relationship management. Oracle products are available for mainframes, minicomputers, personal computers, network computers and personal digital assistants, allowing organizations to integrate different computers, different operating systems, different networks, and even different database management systems, into a single, unified computing and information resource. Oracle is the worlds leading supplier of software for information management, and the worlds second largest software company. Oracle offers its database, tools, and applications products, along with related consulting, education, and support services, in over 145 countries around the world.

Your FeedbackThank you for using Oracle Order Management and this users manual. Oracle values your comments and feedback. At the end of this guide is a Readers Comment Form you can use to explain what you like or dislike about Oracle Order Management or this users manual. Send electronic mail to mfgdoccomments_ [email protected].

xxviii

1Integrating Your SystemsThis chapter gives you an overview of the Order Management Suite use of Oracle Applications integration tools and explains how to use these tools to integrate Order Management products with one another and with your existing nonOracle systems. Oracle Applications integration tools are powerful, flexible tools that enable you to capture data from other Oracle and non-Oracle applications, define necessary format conversions, and direct data to your Oracle Order Management products. Topics covered in this chapter are:

Overview of Oracle Order Management APIs and Open Interfaces on page 1-2

Integrating Your Systems 1-1

Overview of Oracle Order Management APIs and Open Interfaces

Overview of Oracle Order Management APIs and Open InterfacesOracle Order Management products provide a number of open interfaces so you can link them with non-Oracle applications, applications you build, applications on other computers, and even the applications of your suppliers and customers. The purpose of this chapter is to help you understand the general model Oracle Order Management products use for open application interfaces. Other chapters in this book provide specific information on how to use each of the open interfaces. Additional functional information on these interfaces is available in each products users guide. Additional technical information on these interfaces is available in each products Technical Reference Manual.

Basic Business NeedsThe Oracle Order Management Suites product APIs and open interfaces provide you with the features you need to support the following basic business needs:

Connect to data collection devices. This lets you collect material movement transactions such as receipts, issues, quality data, movements, completions, and shipments. This speeds data entry and improves transaction accuracy. Connect to other systems such as finite scheduling packages, computer-aided design systems, custom and legacy manufacturing systems to create integrated enterprise wide systems. Connect to external systems such as the customers purchasing system and the suppliers order entry system to better integrate the supply chain via electronic commerce. Control processing of inbound data imported from outside Oracle applications. Validate imported data to ensure integrity of Oracle Order Management products. Review, update, and resubmit imported data that failed validation. Export data from Oracle Order Management products

Oracle Order Management InterfacesOpen Interface ArchitecturesOracle Order Management products have three different methods to import and export data:

1-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide

Overview of Oracle Order Management APIs and Open Interfaces

Interface Tables Interface Views (Business Views) Function Calls or Programmatic Interfaces (Processes)

Interface TablesInterface tables in Oracle Order Management applications provide a temporary storage area for loading information from an external source. After the information is loaded, concurrent programs are executed to validate the information and then to apply the information to the base product tables. The benefit of an interface table is that it provides a repository where records can be processed and if errors are found it can be edited and resubmitted. In the Oracle Order Management family of applications you should never write directly to the product's tables. An Oracle Applications validation step is always required. You may achieve this either by loading information into the interface tables and submitting a provided concurrent program to validate and process the information or by using a function call to a programmatic interface.

Interface Views (Business Views)Views simplify the data relationships for easier processing, whether for reporting or data export. Oracle Order Management products have defined business views that identify certain areas of key business interest. You can access this data using your tool of choice. The OE_ORDER_HEADERS_BV is an example of a key business view. Product views are defined in the Technical Reference Manuals. The view definitions also briefly describe how they are used.

Function Calls or Programmatic Interfaces (Processes)As an alternative to the two step process of writing to an interface table and executing a program to process the table data, many Oracle Order Management interfaces support direct function calls. A calling application can pass appropriate parameters and execute a public function to invoke the application logic. The benefit of a function call is that the integration is real time, as opposed to interface tables where the integration is batch.

Summary: Beyond Published InterfacesThe Oracle Cooperative Applications Initiative references many third party products which provide import and export capabilities and allow loose to tight

Integrating Your Systems 1-3

Overview of Oracle Order Management APIs and Open Interfaces

integration with legacy systems, other supplier systems, and so on. Contact your Oracle consultant for more information about system integration.

Current Documentation For Open InterfacesBelow are the actual names of the tables, views, and modules:Table 11 Table Key Key Data Flow Direction Iface Man TRM Key Inbound means into Oracle Order Management; Outbound means out from Oracle Order Management The interface is documented in detail in the Oracle Order Management APIs and Open Interfaces Manual The tables, views, or modules are described in the products Technical Reference Manual

Table 12 Oracle Order Management APIs/Open Interfaces Table, View, Process, or Procedure ONTTable

Interface/API Name ONTOrder Import

Data Flow Direction ONTInbound

Iface Man ONTYes

TRM ONTYes

Table, View, Module Name, or Procedure Name ONT OE_HEADERS_IFACE_ALL OE_LINES_IFACE_ALL OE_RESERVTNS_IFACE_ALL OE_CREDITS_IFACE_ALL OE_PRICE_ADJS_IFACE_ALL OE_LOTSERIALS_IFACE_ALL OE_ACTIONS_IFACE_ALL

Process Order

Inbound

Process

No

Yes

OE_ORDER_PUB.PROCESS_ORDER QP

QP

QP

QP

QP

QP

1-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide

Overview of Oracle Order Management APIs and Open Interfaces

Table 12 Oracle Order Management APIs/Open Interfaces Table, View, Process, or Procedure Procedure

Interface/API Name Agreement Public Application Program Interface

Data Flow Direction Inbound/Out bound

Iface Man Yes

TRM Yes

Table, View, Module Name, or Procedure Name OE_PRICING_CONT_ PUB.PROCESS_AGREEMENT OE_PRICING_CONT_PUB.GET_ AGREEMENT OE_PRICING_CONT_PUB.LOCK_ AGREEMENT

Attribute Mapping Application Program Interface Business Object for Modifier Setup Application Program Interface

Inbound/Out bound Inbound/Out bound

Procedure

Yes

Yes

QP_ATTR_MAPPING_ PUB.BUILD_CONTEXTSQP_MODIFIERS_PUB.PROCESS_ MODIFIERS QP_MODIFIERS_PUB.GET_ MODIFIERS QP_MODIFIERS_PUB.LOCK_ MODIFIERS

Procedure

Yes

Yes

Business Object for Pricing Formulas Application Program Interface

Inbound/Out bound

Procedure

Yes

Yes

QP_PRICE_FORMULA_PUB.LOCK_ PRICE_FORMULA QP_PRICE_FORMULA_ PUB.PROCESS_PRICE_FORMULA QP_PRICE_FORMULA_PUB.GET_ PRICE_FORMULA

Business Object for Pricing Limits Application Program Interface Get Currency Application Program Interface Custom Runtime Sourcing Application Program Interface Get_Attribute_Text Application Program Interface

Inbound/Out bound

Procedure

Yes

Yes

QP_LIMITS_PUB.PROCESS_LIMITS QP_LIMITS_PUB.GET_LIMITS QP_LIMITS_PUB.LOCK_LIMITS

Inbound/Out bound Inbound/Out bound Inbound/Out bound

Procedure

Yes

Yes

QP_GET_CURRENCY

Procedure

Yes

Yes

QP_RUNTIME_SOURCE

Procedure

Yes

Yes

QP_UTIL_PUB

Integrating Your Systems 1-5

Overview of Oracle Order Management APIs and Open Interfaces

Table 12 Oracle Order Management APIs/Open Interfaces Table, View, Process, or Procedure Procedure

Interface/API Name Get Custom Price (Used in Formulas Setup) Application Program Interface Get_Price_For_Line Application Program Interface Get Price List Currency Application Program Interface Get Price List Application Program Interface Multi-Currency Conversion Setup Application Program Interface Price List Setup

Data Flow Direction Inbound/Out bound

Iface Man Yes

TRM Yes

Table, View, Module Name, or Procedure Name QP_CUSTOM.GET_CUSTOM_PRICE

Inbound/Out bound Inbound/Out bound Inbound/Out bound Inbound/Out bound

Procedure

Yes

Yes

QP_PREQ_PUB

Procedure

Yes

Yes

QP_UTIL_PUB

Procedure

Yes

Yes

QP_GET_PRICE_LIST

Procedure

Yes

Yes

QP_CURRENCY_PUB. PROCESS_ CURRENCY

Inbound/Out bound

Procedure

Yes

Yes

QP_PRICE_LIST_PUB.PROCESS_ PRICE_LIST

QP_PRICE_LIST_PUB.GET_PRICE_LIST

QP_PRICE_LIST_PUB.LOCK_PRICE_LIST Price List Setup Group Application Program Interface Price Request Application Program Interface Pricing Data Bulk Loader API Pricing Object Security CHECK_FUNCTION Inbound/Out bound Inbound/Out bound Inbound/Out bound Inbound/Out bound Procedure Yes Yes QP_PRICE_LIST_GRP.PROCESS_ PRICE_LIST QP_PREQ_GRP.PRICE_REQUEST

Procedure

Yes

Yes

Procedure Procedure

Yes Yes

Yes Yes

QP_BULK_LOADER_PUB.LOAD_ PRICING_DATA QP_SECU_VIEW QP_SECU_UPDATE

1-6 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide

Overview of Oracle Order Management APIs and Open Interfaces

Table 12 Oracle Order Management APIs/Open Interfaces Table, View, Process, or Procedure Procedure

Interface/API Name Qualifiers Application Program Interface

Data Flow Direction Inbound/Out bound

Iface Man Yes

TRM Yes

Table, View, Module Name, or Procedure Name QP_QUALIFIER_RULES_ PUB.PROCESS_QUALIFIER_RULES QP_QUALIFIER_RULES_ PUB.LOCK_QUALIFIER_RULES QP_QUALIFIER_RULES_PUB.GET_ QUALIFIER_RULES QP_QUALIFIER_RULES_ PUB.COPY_QUALIFIER_RULES

Reverse Limits Application Program Interface Round Price Application Program Interface Validate_Price_list_ Curr_code Application Program Interface RLM RLM_INTERFACE_ HEADERS

Inbound/Out bound Inbound/Out bound Inbound/Out bound RLM Inbound Inbound WSH Inbound Inbound Inbound Inbound Inbound

Procedure

Yes

Yes

QP_UTIL_PUB

Procedure

Yes

Yes

QP_ROUND_PRICE

Procedure

Yes

Yes

QP_VALIDATE_PRICE_LIST_CURR_ CODE RLM RLM_INTERFACE_HEADERS RLM_INTERFACE_LINES WSH WSH_TRIPS_PUB (Procedure package) WSH_TRIP_STOPS_PUB (Procedure package) WSH_DELIVERIES_PUB (Procedure package) WSH_EXCEPTIONS_PUB (Procedure package) WSH_DELIVERY_DETAILS_PUB (Procedure package)

RLM Table Table WSH Procedure Procedure Procedure Procedure Procedure

RLM Yes Yes WSH Yes Yes Yes Yes Yes

RLM Yes Yes WSH No No No No No

RLM_INTERFACE_ LINESWSH Trip Public API Stop Public API Deliveries Public API Exceptions Public API Delivery Details Public API

Integrating Your Systems 1-7

Overview of Oracle Order Management APIs and Open Interfaces

Table 12 Oracle Order Management APIs/Open Interfaces Table, View, Process, or Procedure Procedure Procedure Procedure

Interface/API Name Container Public API Freight Costs Public API

Data Flow Direction Inbound Inbound Inbound

Iface Man Yes Yes Yes

TRM No No No

Table, View, Module Name, or Procedure Name WSH_CONTAINER_PUB (Procedure package) WSH_FREIGHT_COSTS_PUB (Procedure package)

Pick Release Application Program Interface API

WSH_PICKING_BATCHES_PUB (Procedure package)

Inbound Open Interface ModelOracle Order Management products provide both inbound and outbound interfaces. For inbound interfaces, where these products are the destination, interface tables as well as supporting validation, processing, and maintenance programs are provided. For outbound interfaces, where these products are the source, database views are provided and the destination application should provide the validation, processing, and maintenance programs.

Discussion of Inbound Interfaces OnlyIn this manual, we discuss only inbound interfaces in detail. You can find information about the tables, views, and processes involved in outbound interfaces in the products Technical Referen