1. Oracle Order ManagementOpen Interfaces, API, & Electronic Messaging GuideRelease 12.1Part No. E18000-01August 2010

2. Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12.1Part No. E18000-01Copyright 1996, 2010, Oracle and/or its affiliates. All rights reserved.Primary Author: John Brazier, Pratima Mahtani, John SalviniContributing Author: Alok Singh, Pravin Nair, Rakesh Moharana, Sasi Erla, Anjana RamachandranOracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarksof their respective owners.This software and related documentation are provided under a license agreement containing restrictions onuse and disclosure and are protected by intellectual property laws. Except as expressly permitted in yourlicense agreement or allowed by law, you may not use, copy, reproduce, translate, broadcast, modify, license,transmit, distribute, exhibit, perform, publish or display any part, in any form, or by any means. Reverseengineering, disassembly, or decompilation of this software, unless required by law for interoperability, isprohibited.The information contained herein is subject to change without notice and is not warranted to be error-free. Ifyou find any errors, please report them to us in writing.If this software or related documentation is delivered to the U.S. Government or anyone licensing it on behalfof the U.S. Government, the following notice is applicable:U.S. GOVERNMENT RIGHTSPrograms, software, databases, and related documentation and technical data delivered to U.S. Governmentcustomers are "commercial computer software" or "commercial technical data" pursuant to the applicableFederal Acquisition Regulation and agency-specific supplemental regulations. As such, the use, duplication,disclosure, modification, and adaptation shall be subject to the restrictions and license terms set forth in theapplicable Government contract, and, to the extent applicable by the terms of the Government contract, theadditional rights set forth in FAR 52.227-19, Commercial Computer Software License (December 2007). OracleUSA, Inc., 500 Oracle Parkway, Redwood City, CA 94065.This software is developed for general use in a variety of information management applications. It is notdeveloped or intended for use in any inherently dangerous applications, including applications which maycreate a risk of personal injury. If you use this software in dangerous applications, then you shall beresponsible to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use ofthis software. Oracle Corporation and its affiliates disclaim any liability for any damages caused by use of thissoftware in dangerous applications.This software and documentation may provide access to or information on content, products and servicesfrom third parties. Oracle Corporation and its affiliates are not responsible for and expressly disclaim allwarranties of any kind with respect to third party content, products and services. Oracle Corporation and itsaffiliates will not be responsible for any loss, costs, or damages incurred due to your access to or use of thirdparty content, products or services. 3. ContentsSend Us Your CommentsPreface1 Integrating Your SystemsOverview of Oracle Order Management APIs and Open Interfaces....................................... 1-1Basic Business Needs................................................................................................................ 1-1Oracle Order Management Interfaces.......................................................................................1-2Inbound Open Interface Model.............................................................................................. 1-11Components of an Open Interface.......................................................................................... 1-132 Oracle Advanced Pricing Open Interfaces and APIsKey of Short Names................................................................................................................... 2-2Agreements Public Application Program Interface................................................................. 2-2 Functional Overview........................................................................................................... 2-2 Setting Up and Using Parameter Descriptions.....................................................................2-2 Validation of Agreements Public API................................................................................ 2-26 Example of Agreements Public API................................................................................... 2-26Attribute Mapping Application Program Interface............................................................... 2-26 Functional Overview......................................................................................................... 2-27 Setting Up and Parameter Descriptions............................................................................. 2-28Business Object for Modifier Setup Application Program Interface.................................... 2-48 Functional Overview......................................................................................................... 2-48 Setting Up and Parameter Descriptions............................................................................. 2-50 Validation of Business Object for Modifier Setup API....................................................... 2-86 Example of Modifier Setup Application Program Interface...............................................2-86 iii 4. Business Object for Pricing Formulas Application Program Interface..................................2-87Functional Overview......................................................................................................... 2-87Setting Up and Parameter Descriptions............................................................................. 2-88Validation of Business Object for Pricing Formulas API....................................................2-99Example of Pricing Formulas API...................................................................................... 2-99 Business Object for Pricing Limits Application Program Interface.................................... 2-100Functional Overview....................................................................................................... 2-100Setting Up and Parameter Descriptions........................................................................... 2-101Validation of Limits Public API....................................................................................... 2-118Example of Limits Public API.......................................................................................... 2-119 Create Publish Price Book Application Program Interface.................................................. 2-119Functional Overview....................................................................................................... 2-119Setting Up and Parameter Descriptions........................................................................... 2-120Validation of Create Publish Price Book API................................................................... 2-123Examples of Create_Publish_Price_Book API.................................................................. 2-126 Get Currency Application Program Interface....................................................................... 2-126Functional Overview....................................................................................................... 2-126Setting Up and Parameter Descriptions........................................................................... 2-126Validation of Get_Currency API...................................................................................... 2-127 Get Custom Price Application Program Interface................................................................ 2-128Functional Overview....................................................................................................... 2-128Setting Up and Parameter Descriptions........................................................................... 2-128Validation of Get Custom Price API................................................................................ 2-130 Get Price Book Application Program Interface ................................................................... 2-133Functional Overview....................................................................................................... 2-133Setting Up and Parameter Descriptions .......................................................................... 2-134Validation of Get Price Book API..................................................................................... 2-144Examples of Get_Price_Book API.................................................................................... 2-145 Get Price List Application Program Interface.......................................................................2-145Functional Overview....................................................................................................... 2-145Setting Up and Parameter Descriptions........................................................................... 2-146Validation of Get_Price_List API..................................................................................... 2-147 Multi-Currency Conversion Setup Application Program Interface.....................................2-147Functional Overview....................................................................................................... 2-147Setting Up and Parameter Descriptions........................................................................... 2-148Validation of Multi-Currency Conversion API................................................................ 2-156Example of Multi-Currency Conversion API................................................................... 2-157 Price List Setup Application Program Interface................................................................... 2-157Functional Overview....................................................................................................... 2-157Setting Up and Parameter Descriptions........................................................................... 2-159Validation of Price List Setup API....................................................................................2-178iv 5. Example of Price List Setup API...................................................................................... 2-178Price List Setup Group Application Program Interface....................................................... 2-179 Functional Overview....................................................................................................... 2-179 Setting Up and Parameter Descriptions........................................................................... 2-180 Validation of Price List Group API.................................................................................. 2-199Price Request Application Program Interface...................................................................... 2-200 Functional Overview....................................................................................................... 2-201 Setting Up and Parameter Descriptions........................................................................... 2-202 Validation of Price Request API....................................................................................... 2-260 Example of Price Request Application Program Interface............................................... 2-260Pricing Data Bulk Loader API............................................................................................... 2-263 Functional Overview .......................................................................................................2-263 Setting Up and Parameter Descriptions........................................................................... 2-264 Validation of Pricing Data Bulk Loader .......................................................................... 2-265 Examples of Pricing Data Bulk Loader API..................................................................... 2-267Pricing Object Security - Check Function API..................................................................... 2-275 Functional Overview....................................................................................................... 2-276 Setting Up and Parameter Descriptions........................................................................... 2-276 Validation of Pricing Object Security API........................................................................ 2-278Pricing Attributes Application Program Interface............................................................... 2-278 Functional Overview....................................................................................................... 2-278Attribute Mapping Application Program Interface............................................................. 2-291 Functional Overview....................................................................................................... 2-291 Setting Up and Parameter Descriptions........................................................................... 2-291 Validation of Attribute Mapping API.............................................................................. 2-297Qualifiers Application Program Interface............................................................................ 2-297 Functional Overview....................................................................................................... 2-297 Setting Up and Parameter Descriptions .......................................................................... 2-298 Validation of Qualifiers API.............................................................................................2-315 Example of Qualifiers API............................................................................................... 2-315Reverse Limits Application Program Interface.................................................................... 2-315 Functional Overview....................................................................................................... 2-316 Setting Up and Parameter Descriptions........................................................................... 2-316 Validation of Reverse Limits API..................................................................................... 2-321 Example of Reverse Limits API........................................................................................2-322Round Price Application Program Interface........................................................................ 2-323 Functional Overview....................................................................................................... 2-323 Setting Up and Parameter Descriptions........................................................................... 2-324 Validation of Round Price API......................................................................................... 2-325Validate Price List with Currency Code Application Program Interface............................ 2-325 Functional Overview....................................................................................................... 2-326 v 6. Setting Up and Parameter Descriptions........................................................................... 2-326 Validation of Validate Price List with Currency Code API.............................................. 2-3263Oracle Advanced Pricing XML Transactions Get Catalog Transaction............................................................................................................ 3-1 Setting up and Parameter Descriptions................................................................................3-2 Validation of Get Catalog Transaction............................................................................... 3-12 Examples of the Get Catalog Transaction ......................................................................... 3-13 Sync Catalog Transaction........................................................................................................ 3-17 Setting Up and Parameter Descriptions............................................................................. 3-18 Validation of Sync Catalog Transaction............................................................................. 3-29 Examples of Sync Catalog Transaction.............................................................................. 3-294Oracle Order Management XML Transactions: Implementation Considerations Process_PO................................................................................................................................ 4-1 Setup: Customer Setup.........................................................................................................4-1 Installation..................................................................................................................... 4-6 Message Map: Seeded Workflow for Inbound XML Messages............................................4-7 Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO............................... 4-9 Acknowledge_PO.................................................................................................................... 4-22 Message Map..................................................................................................................... 4-22 Setup: Customer Setup.......................................................................................................4-22 Oracle XML Gateway Details............................................................................................. 4-26 Show_SalesOrder.................................................................................................................... 4-27 Setup.................................................................................................................................. 4-27 Additional User Setup................................................................................................. 4-31 Change_SalesOrder................................................................................................................. 4-39 Setup.................................................................................................................................. 4-39 Data Archive and Purge Procedures........................................................................... 4-43 Change_PO.............................................................................................................................. 4-44 Setup: Customer Setup.......................................................................................................4-44 Implementation Considerations.........................................................................................4-47 Message Map..................................................................................................................... 4-47 Sample Business Flow for 3A4 Process PO/3A4 Acknowledge PO....................................4-76 Cancel_PO............................................................................................................................... 4-86 Setup: Customer Setup ...................................................................................................... 4-86 Implementation Considerations.........................................................................................4-90 Open Interface Tracking ........................................................................................................ 4-90 Setup: Customer Setup.......................................................................................................4-90 Integration Event oracle.apps.ont.oi.xml_int.status............................................................ 4-91vi 7. User Procedures............................................................................................................... 4-1005 Oracle Order Management XML TransactionsWhat is RosettaNet?.................................................................................................................. 5-1Process_PO ................................................................................................................................ 5-4Acknowledge_PO.................................................................................................................... 5-41Show_SalesOrder ................................................................................................................... 5-62Change_salesorder.................................................................................................................. 5-78Inbound Change PO Request ................................................................................................ 5-96Cancel Purchase Order ......................................................................................................... 5-136CONFIRM BOD.................................................................................................................... 5-139Message Map................................................................................................................... 5-139Seeded Workflow for Inbound XML Messages................................................................... 5-148Message Details .................................................................................................................... 5-150Extension Tags....................................................................................................................... 5-153Open Interface Tracking ...................................................................................................... 5-156Overview......................................................................................................................... 5-156Major Features................................................................................................................. 5-157Business Scenarios and Process Flow............................................................................... 5-158Messages.......................................................................................................................... 5-158Event/Event Subscription...................................................................................................... 5-161Seeded workflow OEEM/Open Interface Tracking............................................................. 5-161Event Parameters & Population............................................................................................ 5-1616 Oracle Order Management EDI TransactionsOracle Order Management........................................................................................................ 6-1Inbound Purchase Order (POI/850/ORDERS).......................................................................... 6-2Order Import ............................................................................................................................. 6-5Review and Resolve Order Management Open Interface Exceptions..................................... 6-57 Oracle Order Management Open Interfaces and APIsIntegrating Oracle Order Management Using Order Import...................................................7-1Process Order Application Open Interface........................................................................... 7-1108 Oracle Order Management: Integration with Other ProductsIntegrating Oracle Order Management with Oracle Receivables and Invoicing.................... 8-1Telecommunications Services Orders (MACD) Interfaces.................................................... 8-52 vii 8. 9Oracle Release Management XML Transactions Overview of Oracle Release Management XML...................................................................... 9-1 Planning Schedule Transaction................................................................................................ 9-3Sample Document Type Definition (DTD) and XML for Planning Schedule.......................9-4Planning Schedule XML to Database Mapping................................................................... 9-9 Shipping Schedule Transaction.............................................................................................. 9-18Sample Document Type Definition (DTD) and XML for Shipment Schedule....................9-20Shipping Schedule XML to Database Mapping................................................................. 9-2310Oracle Release Management EDI Transactions Production Sequence EDI....................................................................................................... 10-1 Shipping Schedule EDI........................................................................................................... 10-1 Planning Schedule EDI........................................................................................................... 10-2 Purpose Codes......................................................................................................................... 10-2 Transaction Descriptions........................................................................................................ 10-411Oracle Release Management Open Interfaces and APIs Understanding the Demand Processor Interface Tables........................................................ 11-1Release Management Schedule Headers RLM_INTERFACE_HEADERS_ALL................ 11-1Release Management Schedule Lines RLM_INTERFACE_LINES_ALL.......................... 11-2312Oracle Shipping Execution Open Interfaces and APIs Overview of API Information................................................................................................. 12-1 Shipment Processing Using APIs........................................................................................... 12-3 Actions, APIs, and Parameters.............................................................................................. 12-16 Application Parameter Initialization.................................................................................... 12-34 Trip Public Application Program Interface.......................................................................... 12-35Create_Update_Trip API Features................................................................................... 12-35Functional Overview................................................................................................. 12-35Trip_Action API Features................................................................................................ 12-41Functional Overview................................................................................................. 12-41Trip_Action (overloaded version) API features............................................................... 12-43Functional Overview................................................................................................. 12-44 Stop Public Application Program Interface.......................................................................... 12-49Create_Update_Stop API Features...................................................................................12-49Functional Overview................................................................................................. 12-49Stop_Action API Features................................................................................................ 12-56Functional Overview................................................................................................. 12-56viii 9. Deliveries Public Application Program Interface................................................................ 12-59 Create_Update_Delivery API Features............................................................................ 12-59Functional Overview................................................................................................. 12-59 Delivery_Action API Features......................................................................................... 12-70Functional Overview................................................................................................. 12-70 Generate_Documents API Features................................................................................. 12-76Functional Overview................................................................................................. 12-76 Setting Up the Generate_Documents API........................................................................ 12-77Exceptions Application Program Interface........................................................................... 12-78 Exception_Action API Features....................................................................................... 12-78Functional Overview................................................................................................. 12-78 Setting Up the Exception_Actions API............................................................................ 12-79 Get_Exceptions API Features........................................................................................... 12-87Functional Overview................................................................................................. 12-87 Setting Up the Get_Exceptions API..................................................................................12-87Delivery Details Public Application Program Interface...................................................... 12-89 Detail_To_Delivery API Features.................................................................................... 12-90Functional Overview................................................................................................. 12-90 Split_Line API Features................................................................................................... 12-92Functional Overview................................................................................................. 12-92 Update_Shipping_Attributes API Features..................................................................... 12-95Functional Overview................................................................................................. 12-95 Autocreate_Deliveries API Features.............................................................................. 12-107 Autocreate_Del_Trip API Features................................................................................ 12-109 Get_Detail_Status API Features..................................................................................... 12-111Functional Overview............................................................................................... 12-111 Update_Shipping_Attributes (overloaded version) API................................................ 12-113Functional Overview............................................................................................... 12-113 Init_Changed_Attribute_Rec API Features.................................................................... 12-125Functional Overview............................................................................................... 12-125 AUTOCREATE_DEL_TRIP (overloaded version) API Features.................................... 12-136Functional Overview............................................................................................... 12-136Container Public Application Program Interface............................................................... 12-138 Create_Containers API Features.................................................................................... 12-139Functional Overview............................................................................................... 12-139 Update Container API Features..................................................................................... 12-142Functional Overview............................................................................................... 12-142 Auto_Pack API Features................................................................................................ 12-149Functional Overview............................................................................................... 12-149 Container_Actions API Features.................................................................................... 12-152Functional Overview............................................................................................... 12-152 ix 10. Freight Costs Public Application Program Interface..........................................................12-155Create_Update_Freight_Costs API Features.................................................................. 12-155Functional Overview............................................................................................... 12-155Validate_Freight_Cost_Type API Features.................................................................... 12-161Delete_Freight_Costs API Features................................................................................ 12-162Functional Overview............................................................................................... 12-162 Pick Release Application Program Interface...................................................................... 12-167Create_Batch API Features.............................................................................................12-168Functional Overview............................................................................................... 12-168Release_Batch API Features........................................................................................... 12-179Functional Overview............................................................................................... 12-179Get_Batch_Record API Features.................................................................................... 12-181Functional Overview............................................................................................... 12-181 Document Public Application Program Interface.............................................................. 12-193Functional Overview..................................................................................................... 12-193 Custom Public Application Program Interface.................................................................. 12-199UI_Location_Code API Features.................................................................................... 12-199Functional Overview............................................................................................... 12-199Calculate_TP_Dates API Features.................................................................................. 12-203Functional Overview............................................................................................... 12-203 Example of API Packages and Procedures.......................................................................... 12-20413 Oracle Shipping Execution XML Transactions XML Overview........................................................................................................................ 13-1 Oracle XML Gateway Setup.................................................................................................... 13-2Trading Partners................................................................................................................ 13-3Code Conversions.............................................................................................................. 13-3 Using XML Messaging with Carrier Manifesting.................................................................. 13-4ShowShipment Request Transaction for Carrier Manifesting............................................ 13-5ShowShipment Advice Transaction for Carrier Manifesting............................................. 13-6Defining Trading Partners for Carrier Manifesting........................................................... 13-7Overview of XML and DTD for Carrier Manifesting....................................................... 13-10Document Type Definition (DTD) for Carrier Manifesting..............................................13-10Sample XML Transaction for Carrier Manifesting........................................................... 13-13 Using XML Messaging with Third Party Warehousing....................................................... 13-88ShowShipment Request Transaction for Third Party Warehousing................................ 13-89ShowShipment Advice Transaction for Third Party Warehousing..................................13-90Defining Trading Partners for Third Party Warehousing................................................ 13-90Overview of XML and DTD for Third Party Warehousing..............................................13-95Sample Document Type Definitions (DTD) for Third Party Warehousing...................... 13-95x 11. Sample XML Transactions for Third Party Warehousing................................................ 13-98 Using XML Messaging with International Trade Management........................................ 13-176 ItemSynchronization Request Transaction for ITM....................................................... 13-176 PartySynchronization Request Transaction for ITM...................................................... 13-177 OrderCompliance Request for ITM................................................................................13-177 DeliveryCompliance Request Transaction for ITM........................................................ 13-177 ExportCompliance Response Transaction for ITM........................................................ 13-178 Overview of XML and DTD for ITM............................................................................. 13-179 ITM DTDs...................................................................................................................... 13-179 Sample ITM XML Transactions......................................................................................13-18714 Oracle Shipping Execution EDI Transactions DSNO...................................................................................................................................... 14-1AOracle Order Management Error and Information Messages Process_PO and Acknowledge_PO.......................................................................................... A-1 Show_SalesOrder...................................................................................................................... A-2 Cancel_PO................................................................................................................................. A-2 Change SO................................................................................................................................. A-3 Inbound Change PO Request................................................................................................... A-4 xi 12. Send Us Your CommentsOracle Order Management Open Interfaces, API, & Electronic Messaging Guide, Release 12.1Part No. E18000-01Oracle welcomes customers comments and suggestions on the quality and usefulness of this document.Your feedback is important, and helps us to best meet your needs as a user of our products. For example: Are the implementation steps correct and complete? Did you understand the context of the procedures? Did you find any errors in the information? Does the structure of the information help you with your tasks? Do you need different information or graphics? If so, where, and in what format? Are the examples correct? Do you need more examples?If you find any errors or have any other suggestions for improvement, then please tell us your name, thename of the company who has licensed our products, the title and part number of the documentation andthe chapter, section, and page number (if available).Note: Before sending us your comments, you might like to check that you have the latest version of thedocument and if any concerns are already addressed. To do this, access the new Oracle E-Business SuiteRelease Online Documentation CD available on My Oracle Support and www.oracle.com. It contains themost current Documentation Library plus all documents revised or released recently.Send your comments to us using the electronic mail address: appsdoc_us@oracle.comPlease give your name, address, electronic mail address, and telephone number (optional).If you need assistance with Oracle software, then please contact your support representative or OracleSupport Services.If you require training or instruction in using Oracle software, then please contact your Oracle local officeand inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site atwww.oracle.com. xiii 13. PrefaceIntended Audience Welcome to Release 12.1 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. 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. See Related Information Sources on page xvi for more Oracle E-Business Suite product information.Deaf/Hard of Hearing Access to Oracle Support Services To reach Oracle Support Services, use a telecommunications relay service (TRS) to call Oracle Support at 1.800.223.1711. An Oracle Support Services engineer will handle technical issues and provide customer support according to the Oracle service request process. Information about TRS is available at http://www.fcc.gov/cgb/consumerfacts/trs.html, and a list of phone numbers is available at http://www.fcc.gov/cgb/dro/trsphonebk.html.Documentation Accessibility Our goal is to make Oracle products, services, and supporting documentation accessible to all users, including users that are disabled. To that end, our documentation includes features that make information available to users of assistive technology. This xv 14. documentation is available in HTML format, and contains markup to facilitate access bythe disabled community. Accessibility standards will continue to evolve over time, andOracle is actively engaged with other market-leading technology vendors to addresstechnical obstacles so that our documentation can be accessible to all of our customers.For more information, visit the Oracle Accessibility Program Web site athttp://www.oracle.com/accessibility/.Accessibility of Code Examples in DocumentationScreen readers may not always correctly read the code examples in this document. Theconventions for writing code require that closing braces should appear on an otherwiseempty line; however, some screen readers may not always read a line of text thatconsists 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 organizationsthat Oracle does not own or control. Oracle neither evaluates nor makes anyrepresentations regarding the accessibility of these Web sites.Structure1 Integrating Your Systems2 Oracle Advanced Pricing Open Interfaces and APIs3 Oracle Advanced Pricing XML Transactions4 Oracle Order Management XML Transactions: Implementation Considerations5 Oracle Order Management XML Transactions6 Oracle Order Management EDI Transactions7 Oracle Order Management Open Interfaces and APIs8 Oracle Order Management: Integration with Other Products9 Oracle Release Management XML Transactions10 Oracle Release Management EDI Transactions11 Oracle Release Management Open Interfaces and APIs12 Oracle Shipping Execution Open Interfaces and APIs13 Oracle Shipping Execution XML Transactions14 Oracle Shipping Execution EDI TransactionsA Oracle Order Management Error and Information MessagesRelated Information SourcesOracle Order Management Users GuideOracle Order Management Implementation ManualUsing Oracle Workflow in Oracle Order ManagementOracle e-Commerce Gateway Implementation ManualOracle e-Commerce Gateway Users Guidexvi 15. Oracle XML Gateway Users GuideOracle Integration Repository Users GuideOracle Configure to Order Process GuideOracle Shipping Execution Users GuideOracle Advanced Pricing Implementation ManualOracle Advanced Pricing Users GuideOracle Release Management Implementation ManualOracle Release Management Users GuideOracle Applications Multiple Organizations Implementation GuideIntegration RepositoryThe Oracle Integration Repository is a compilation of information about the serviceendpoints exposed by the Oracle E-Business Suite of applications. It provides acomplete catalog of Oracle E-Business Suites business service interfaces. The tool letsusers easily discover and deploy the appropriate business service interface forintegration with any system, application, or business partner.The Oracle Integration Repository is shipped as part of the E-Business Suite. As yourinstance is patched, the repository is automatically updated with content appropriatefor the precise revisions of interfaces in your environment.Do Not Use Database Tools to Modify Oracle E-Business Suite DataOracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle DataBrowser, database triggers, or any other tool to modify Oracle E-Business Suite dataunless otherwise instructed.Oracle provides powerful tools you can use to create, store, change, retrieve, andmaintain information in an Oracle database. But if you use Oracle tools such asSQL*Plus to modify Oracle E-Business Suite data, you risk destroying the integrity ofyour data and you lose the ability to audit changes to your data.Because Oracle E-Business Suite tables are interrelated, any change you make using anOracle E-Business Suite form can update many tables at once. But when you modifyOracle E-Business Suite data using anything other than Oracle E-Business Suite, youmay 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 erroneousinformation and you risk unpredictable results throughout Oracle E-Business Suite.When you use Oracle E-Business Suite to modify your data, Oracle E-Business Suiteautomatically checks that your changes are valid. Oracle E-Business Suite also keepstrack of who changes information. If you enter information into database tables usingdatabase tools, you may store invalid information. You also lose the ability to track who xvii 16. has changed your information because SQL*Plus and other database tools do not keep arecord of changes.xviii 17. 1 Integrating Your Systems This chapter covers the following topics: Overview of Oracle Order Management APIs and Open Interfaces Basic Business Needs Oracle Order Management Interfaces Inbound Open Interface Model Components of an Open InterfaceOverview of Oracle Order Management APIs and Open Interfaces Oracle Order Management products provide a number of open interfaces that you can link to, and exchange data with, other Oracle applications and non-Oracle applications like legacy systems. This chapter will help you understand the general model that Oracle Order Management products use for open interfaces. Other chapters in this book provide information about how to use specific open interfaces. Additional functional information about the interfaces is available in the user or implementation guide for each product. Additional technical information on these interfaces is available in the product-specific e-Technical Reference Manuals.Basic Business Needs APIs and open interfaces of the Oracle Order Management Suite provide you with the features you need to support the following basic business needs: Connect to data collection devices. You can collect material movement transactions such as receipts, issues, quality data, movements, completions, and shipments. This improves data entry speed and transaction accuracy. Connect to other systems such as finite scheduling packages, computer-aidedIntegrating Your Systems 1-1 18. design systems, and custom and legacy manufacturing systems to create integratedenterprise wide systems. Connect to external systems such as the customers purchasing system and thesuppliers order entry system to better integrate the supply chain via electroniccommerce. Control processing of inbound data imported from outside Oracle applications. Validate imported data to maintain data integrity within the application. Review, update, and resubmit imported data that failed validation. Export data from Oracle Order Management products to external systems.Oracle Order Management InterfacesOpen Interface ArchitecturesOracle Order Management products use three different methods for importing andexporting data: Interface Tables Interface Views (Business Views) Function Calls or Programmatic Interfaces (Processes)Interface TablesInterface tables in Oracle Order Management applications provide a temporary storagearea for loading information from an external source. After the information is loaded,concurrent programs are executed to validate the information and then apply theinformation to the base product tables.The benefit of an interface table is that it provides a repository where records can beprocessed and if errors are found, you can edit the records and resubmit them.In the Oracle Order Management family of applications you should never write directlyto the product tables. An Oracle Applications validation step is always required. Youmay achieve this either by loading information into the interface tables and submittinga provided concurrent program to validate and process the information or by using afunction call to a programmatic interface.1-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 19. Interface Views (Business Views)Views simplify the data relationships for easier processing, whether for reporting ordata export. Oracle Order Management products have defined business views thatidentify areas of key business interest. You can access this data using a tool of yourchoice. The OE_ORDER_HEADERS_BV is an example of a key business view.Function Calls or Programmatic Interfaces (Processes)As an alternative to the two step process of writing to an interface table and executing aprogram to process the table data, many Oracle Order Management interfaces supportdirect function calls. A calling application can pass appropriate parameters and executea public function to invoke the application logic.The benefit of a function call is that the integration is real time, as opposed to interfacetables where the integration is batch.Summary: Beyond Published InterfacesThe Oracle Cooperative Applications Initiative references many third party productsthat provide import and export capabilities and allow varying degrees of integrationwith legacy systems, supplier systems, and so on. Contact your Oracle consultant formore information about system integration.Some Key Terms and TablesThe lists below provide information on the database tables, views, procedures, andmodules used in data integration.Table KeyKeyDescriptionData Flow DirectionInbound means into Oracle Order Management; Outbound means out from Oracle Order ManagementIface ManThe interface is documented in detail in the Oracle Order Management Open Interfaces, API, & Electronic Messaging Guidee-TRMThe tables, views, or modules are described in the products e-Technical Reference ManualIntegrating Your Systems 1-3 20. Oracle Order Management APIs/Open Interfaces Interface/API Data FlowTable, View, Iface ManTRM Table, View, NameDirectionProcess, or ModuleProcedure Name, orProcedureName ONT ONTONTONTONT ONT Order ImportInboundTableYesYes OE_HEADERS_IFACE_ALLOE_LINES_IFACE_ALLOE_RESERVTNS_IFACE_ALLOE_CREDITS_IFACE_ALLOE_PRICE_ADJS_IFACE_ALLOE_LOTSERIALS_IFACE_ALLOE_ACTIONS_IFACE_ALL Process InboundProcessNo Yes OE_ORDER_ OrderPUB.PROCESS_ORDER QPQP QP QP QPQP1-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 21. Interface/API Data Flow Table, View, Iface Man TRMTable, View,NameDirection Process, or ModuleProcedure Name, orProcedureNameAgreement Inbound/Out ProcedureYes YesOE_PRICINGPublicbound _CONT_PUB.Application PROCESS_AProgram GREEMENTInterfaceOE_PRICING_CONT_PUB.GET_AGREEMENTOE_PRICING_CONT_PUB.LOCK_AGREEMENTAttribute Inbound/Out ProcedureYes YesQP_ATTR_MMapping bound APPING_PUApplication B.BUILD_COProgram NTEXTSInterfaceBusinessInbound/Out ProcedureYes YesQP_MODIFIObject forbound ERS_PUB.PRModifierOCESS_MODSetup IFIERSApplicationProgram QP_MODIFIInterface ERS_PUB.GET_MODIFIERSQP_MODIFIERS_PUB.LOCK_MODIFIERS Integrating Your Systems 1-5 22. Interface/API Data FlowTable, View, Iface ManTRM Table, View, NameDirectionProcess, or ModuleProcedure Name, orProcedureName BusinessInbound/OutProcedureYesYes QP_PRICE_F Object forboundORMULA_P PricingUB.LOCK_P Formulas RICE_FORM ApplicationULA Program InterfaceQP_PRICE_FORMULA_PUB.PROCESS_PRICE_FORMULAQP_PRICE_FORMULA_PUB.GET_PRICE_FORMULA Business ProcedureYesYes QP_LIMITS_ Object for PUB.PROCES PricingS_LIMITS Limits ApplicationQP_LIMITS_ ProgramPUB.GET_LI InterfaceMITSQP_LIMITS_PUB.LOCK_LIMITS CreateInbound/OutProcedureYesYes QP_PRICE_B Publish Price boundOOK_PUB.C Book REATE_PUB ApplicationLISH_PRICE Program_BOOK Interface1-6 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 23. Interface/APIData Flow Table, View, Iface Man TRMTable, View,Name Direction Process, or Module Procedure Name, or Procedure NameCustom Inbound/Out ProcedureYes YesQP_RUNTIMRuntimebound E_SOURCE.GSourcing ET_NUMERIApplicationC_ATTRIBUTProgramE_VALUEInterfaceGet Currency Inbound/Out ProcedureYes YesQP_CURRENApplicationbound CY_PUB.GETProgram_CURRENCYInterfaceGet_AttributeInbound/Out ProcedureYes YesQP_UTIL_PU_Textbound B.GET_ATTRApplicationIBUTE_TEXTProgramInterfaceGet Custom Inbound/Out ProcedureYes YesQP_CUSTOPrice (Used in bound M.GET_CUSFormulas TOM_PRICESetup)ApplicationProgramInterfaceGet PriceInbound/Out ProcedureYes YesQP_PRICE_BBook bound OOK.GET_PApplicationRICE_BOOKProgramInterfaceGet Price ForInbound/Out ProcedureYes YesQP_PREQ_PLine bound UB.PRICE_RApplicationEQUESTProgramInterfaceIntegrating Your Systems 1-7 24. Interface/APIData Flow Table, View, Iface ManTRM Table, View, Name Direction Process, or ModuleProcedure Name, orProcedureName Get Price List Inbound/Out ProcedureYesYes QP_UTIL_PU Currency bound B.GET_CURR ApplicationENCY Program Interface Get Price List Inbound/Out ProcedureYesYes QP_UTIL_PU Applicationbound B.GET_PRIC ProgramE_LIST Interface Multi-Curren Inbound/Out ProcedureYesYes QP_CURREN cy bound CY_PUB. Conversion PROCESS_C SetupURRENCY Application Program Interface Price List Inbound/Out ProcedureYesYes QP_PRICE_L Setupbound IST_PUB.PROCESS_PRICE_LISTQP_PRICE_LIST_PUB.GET_PRICE_LISTQP_PRICE_LIST_PUB.LOCK_PRICE_LIST Price List Inbound/Out ProcedureYesYes QP_PRICE_L Setup Groupbound IST_GRP.PR ApplicationOCESS_PRIC ProgramE_LIST Interface1-8 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 25. Interface/API Data Flow Table, View, Iface Man TRMTable, View,NameDirection Process, or ModuleProcedure Name, orProcedureNamePrice Request Inbound/Out ProcedureYes YesQP_PREQ_GApplication bound RP.PRICE_RProgram EQUESTInterfacePricing DataInbound/Out ProcedureYes YesQP_BULK_LBulk Loader bound OADER_PUBAPI .LOAD_PRICING_DATAPricing Inbound/Out ProcedureYes YesQP_SECURITObjectbound Y.CHECK_FSecurityUNCTIONCHECK_FUNCTIONQualifiersInbound/Out ProcedureYes YesQP_QUALIFIApplication bound ER_RULES_PProgram UB.PROCESSInterface _QUALIFIER_RULESQP_QUALIFIER_RULES_PUB.LOCK_QUALIFIER_RULESQP_QUALIFIER_RULES_PUB.GET_QUALIFIER_RULESQP_QUALIFIER_RULES_PUB.COPY_QUALIFIER_RULES Integrating Your Systems 1-9 26. Interface/API Data Flow Table, View,Iface ManTRM Table, View, NameDirection Process, orModule ProcedureName, orProcedureName Reverse Inbound/Out Procedure YesYes QP_UTIL_PU LimitsboundB.REVERSE_ ApplicationLIMITS Program Interface Round Price Inbound/Out Procedure YesYes QP_UTIL_PU Application boundB.ROUND_P ProgramRICE Interface Validate_Pric Inbound/Out Procedure YesYes QP_UTIL_PU e_list_Curr_c boundB.VALIDATE ode_PRICE_LIST Application_CURR_COD ProgramE Interface RLM RLM RLM RLMRLM RLM RLM_INTER Inbound Table YesYes RLM_INTER FACE_HEADFACE_HEAD ERSERS RLM_INTER Inbound Table YesYes RLM_INTER FACE_LINES FACE_LINES WSH WSH WSH WSHWSH WSH Trip Public Inbound Procedure YesNoWSH_TRIPS_ APIPUB(Procedurepackage) Stop Public Inbound Procedure YesNoWSH_TRIP_S APITOPS_PUB(Procedurepackage)1-10 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 27. Interface/APIData Flow Table, View, Iface Man TRM Table, View,Name Direction Process, orModule ProcedureName, orProcedureNameDeliveries Inbound ProcedureYes NoWSH_DELIVPublic APIERIES_PUB(Procedurepackage)Exceptions Inbound ProcedureYes NoWSH_EXCEPPublic APITIONS_PUB(Procedurepackage)Delivery Inbound ProcedureYes NoWSH_DELIVDetails PublicERY_DETAILAPI S_PUB(Procedurepackage)ContainerInbound ProcedureYes NoWSH_CONTPublic APIAINER_PUB(Procedurepackage)Freight CostsInbound ProcedureYes NoWSH_FREIGPublic APIHT_COSTS_PUB(Procedurepackage)Pick Release Inbound ProcedureYes NoWSH_PICKIApplication NG_BATCHProgram ES_PUBInterface API (Procedurepackage)Inbound Open Interface Model Oracle Order Management products use both inbound and outbound interfaces. For inbound transactions and data import, interface tables as well as supporting validation, processing, and maintenance programs are available. For outbound transactions and data export to external systems, database views are available and the destination application provides the validation, processing, and maintenance programs.Integrating Your Systems 1-11 28. Discussion of Inbound InterfacesIn this manual, we discuss only inbound interfaces in detail. You can find informationabout the tables, views, and processes related to outbound interfaces in the e-TRM foreach product. Note that the e-TRMs do not contain detailed, narrative descriptionsabout the outbound interfaces.Open Interface DiagramThis diagram shows the general model for open application interfaces:Open API DiagramThis diagram illustrates the model used by APIs such as the Service Request interfaces(Oracle Service):1-12 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 29. Components of an Open InterfaceThe components described below are common to most open interfaces. Please note thatthe component may be implemented slightly differently than described below.Source ApplicationA source application may be an external system or another module in the e-BusinessSuite. Data may be processed and stored in a source application.Destination ApplicationA destination application may be an external system or another module in thee-Business Suite. You send data to a destination application so that the application canperform further processing and storage.Interface TableFor inbound interfaces, the interface table is the intermediary table where the data fromIntegrating Your Systems 1-13 30. the source application temporarily resides until it is validated and processed into anOracle Order Management product. The various types of interface columns, are listedbelow:Identifier ColumnsIdentifier columns uniquely identify rows in the interface table and provide foreign keyreference to both the source and destination applications. For example, typical identifiercolumns for a move transaction would identify: The source application The rows unique identifier in the source application The destination applications unique identifier.Control ColumnsControl columns track the status of each row in the interface table as it is inserted,validated, processed with or without errors, and ultimately deleted. Additional controlcolumns identify who last updated the row and the last update date.Data ColumnsData columns store the specific attributes that the source application is sending to theOracle Order Management products.Required ColumnsRequired columns store the minimum information needed by the Oracle OrderManagement products to successfully process the interface row.Some columns are conditionally required based on the specifics of the interface.Derived ColumnsDerived columns are created by the destination application from information in therequired columns. Derived columns are usually required columns that need to contain avalue so that processing may continue.Optional ColumnsThe data in optional columns is not mandatory for transaction processing to take place,however the optional columns may be useful for storing additional information.Errors TableFor inbound interfaces, the errors table stores all errors generated by the validation andprocessing functions. You can either handle multiple error rows or single rows toresolve the errors.Database ViewDatabase views are database objects that enable users of destination applications to look1-14 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 31. at source application data.Oracle Order Management products provide predefined views of key data that is likelyto be used by destination applications.For example, Oracle Cost Management provides work in process valuation andtransaction distribution database views for use by other cost reporting destinationproducts.Load FunctionFor inbound interfaces, the load function is the set of programs that selects andaccumulates data from the source application and inserts it into Oracle OrderManagement interface tables. The programming languages and tools used in the loadfunction are highly dependent on the hardware and system software of the sourceapplication.For example, if you are passing data between an Oracle based source application and anOracle destination application, you would likely use a tool such as Pro*C or PL/SQLsince these tools work in both environments. If you are bringing data from a non-Oraclebased application into a product interface table, you would likely use a procedurallanguage available on the source application to select the data and convert it into anASCII file. Then you could use SQL*Loader to insert that file into the destinationproducts interface table.For outbound interfaces, the load function is the SQL that creates the database view.Validate FunctionThe validate function is the set of programs that Oracle Applications destinationproducts use to ensure the integrity of inbound data. In the source application, you cantypically validate data upon entry using techniques such as forms triggers, not nullcolumns, data types, and so on. However, since Oracle Applications products may notbe the source of this data, validation programs ensure data integrity.In addition, the validate function can derive additional columns based on the requiredcolumns and foreign key relationships with data elsewhere in the Oracle destinationapplication.The validation programs check the interface table for rows requiring validation, and theprograms validate and update each row indicating whether validation is complete or iferrors were found. If errors were found, validation programs need to write errors to theerror table of the destination application.When the source application is a product in the e-Business Suite, the destinationapplication should provide the validate function.Process FunctionThe process function is a set of programs that processes the data from the interface tableIntegrating Your Systems 1-15 32. into the Oracle destination product. The specific processing performed varies byapplication. For open transaction interfaces, the processing generally includes recordingthe transaction history, updating the inventory and order balances, and charging forcosts.Interfaces typically let you control both the frequency and the number of validated rowsthat the processing programs attempt to process. Upon successful completion ofprocessing, the process function should delete the processed row from the interfacetable.Occasionally, the process function may need to insert rows into the errors table.When the source application is a product in the e-Business Suite, the destinationapplication should provide the process function.Maintain FunctionThe maintain function is generally accomplished from a window within an Oracleapplication. Most of these windows allow you to query, update, and resubmit interfacerecords that have failed validation. In general you can use these windows to queryunprocessed or unvalidated rows to check their current status.When the maintain function is not called explicitly, you can use SQL*Plus to query andupdate the interface table rows that are in error.When the source application is a product in the e-Business Suite, the destinationapplication should provide the maintain function.1-16 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 33. 2Oracle Advanced Pricing Open Interfaces and APIsThis chapter covers the following topics: Key of Short Names Agreements Public Application Program Interface Attribute Mapping Application Program Interface Business Object for Modifier Setup Application Program Interface Business Object for Pricing Formulas Application Program Interface Business Object for Pricing Limits Application Program Interface Create Publish Price Book Application Program Interface Get Currency Application Program Interface Get Custom Price Application Program Interface Get Price Book Application Program Interface Get Price List Application Program Interface Multi-Currency Conversion Setup Application Program Interface Price List Setup Application Program Interface Price List Setup Group Application Program Interface Price Request Application Program Interface Pricing Data Bulk Loader API Pricing Object Security - Check Function API Pricing Attributes Application Program Interface Attribute Mapping Application Program Interface Qualifiers Application Program Interface Oracle Advanced Pricing Open Interfaces and APIs 2-1 34. Reverse Limits Application Program Interface Round Price Application Program Interface Validate Price List with Currency Code Application Program InterfaceKey of Short NamesA key of the short names and definitions used in the API tables are provided in thefollowing table:Key of Short Names Short name Definition DrvDerived ReqRequired Yes: This is a required parameter. No: This is an optional parameter. N/A (no entry) No value/not applicableAgreements Public Application Program InterfaceThis section explains how to use the Agreements Public API and how it functions inOracle Advanced Pricing. The Agreements Public package consists of entities tosupport creating and maintaining agreements.Functional OverviewProcess_Agreement processes inserts, updates, and deletes records related toagreements.Setting Up and Using Parameter DescriptionsThe following tables describe all parameters used by the public Agreements Public API.All of the inbound and outbound parameters are listed. Additional information onthese parameters follows.2-2 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 35. PROCESS_AGREEMENT The following table shows the parameters for this structure. PROCESS_AGREEMENT ParametersParameter UsageType ReqDrvp_api_version_n IN Number No Noumberp_init_msg_list IN Varchar2 No Nop_return_values IN Varchar2 No Nop_commitIN Varchar2 No Nox_return_status OUTVarchar2 No Nox_msg_count OUTNumber No Nox_msg_dataOUTVarchar2 No Nop_Agreement_reIN Agreement_Rec_ No NocTypep_Agreement_vaIN Agreement_Val_ No Nolue_recRec_Typep_Price_LHeadeIN QP_Price_List_PNo Nor_recUB.Price_List_Re c_Typep_Price_LHeadeIN QP_Price_List_PNo Nor_val_recUB.Price_List_V al_Rec_Typep_Price_LLine_t IN QP_Price_List_PNo Nobl UB.Price_List_Li ne_Tbl_Typep_Price_LLine_v IN QP_Price_List_PNo Noal_tbl UB.Price_List_V al_Tbl_Type Oracle Advanced Pricing Open Interfaces and APIs 2-3 36. ParameterUsage Type ReqDrv p_Pricing_Attr_t INQP_Price_List_PNo No bl UB.Pricing_Attr_Tbl_Type p_Pricing_Attr_v INQP_Price_List_PNo No al_tbl UB.Pricing_Attr_Val_Tbl_Type x_Agreement_re OUT Agreement_Rec_ No No cType x_Agreement_va OUT Agreement_Val_ No No l_recRec_Type x_Price_LHeaderOUT QP_Price_List_PNo No _rec UB.Price_List_Rec_Type x_Price_LHeaderOUT QP_Price_List_PNo No _val_rec UB.Price_List_Val_Rec_Type x_Price_LLine_tOUT QP_Price_List_PNo No bl UB.Price_List_Line_Tbl_Type x_Price_LLine_vOUT QP_Price_List_PNo No al_tbl UB.Price_List_Line_Val_Tbl_Type x_Pricing_Attr_t OUT QP_Price_List_PNo No bl UB.Pricing_Attr_Tbl_Type x_Pricing_Attr_v OUT QP_Price_List_PNo No al_tbl UB.Pricing_Attr_Val_Tbl_TypeAGREEMENT_REC_TYPEThe following table shows the parameters for this structure.2-4 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 37. REC_TYPEParameterUsage TypeReq Drvaccounting_rule_ NullNumberNoNoidagreement_contaNullNumberNoNoct_idagreement_id NullNumberYes1Noagreement_numNullVarchar2(50)NoNoagreement_sourcNullVarchar2(30)NoNoe_codeagreement_type_NullVarchar2(30)NoNocodeattribute1 NullVarchar2(150) NoNoattribute2 NullVarchar2(150) NoNoattribute3 NullVarchar2(150) NoNoattribute4 NullVarchar2(150) NoNoattribute5 NullVarchar2(150) NoNoattribute6 NullVarchar2(150) NoNoattribute7 NullVarchar2(150) NoNoattribute8 NullVarchar2(150) NoNoattribute9 NullVarchar2(150) NoNoattribute10NullVarchar2(150) NoNoattribute11NullVarchar2(150) NoNo Oracle Advanced Pricing Open Interfaces and APIs 2-5 38. Parameter UsageTypeReq Drv attribute12 Null Varchar2(150) NoNo attribute13 Null Varchar2(150) NoNo attribute14 Null Varchar2(150) NoNo attribute15 Null Varchar2(150) NoNo commentsNull Varchar2(30)NoNo context Null Varchar2(30)NoNo created_byNull NumberYes No creation_date Null DateYes No sold_to_org_idNull NumberNoNo end_date_active Null DateNoNo freight_terms_coNull Varchar2(30)NoNo de invoice_contact_i Null NumberNoNo d invoice_to_org_iNull NumberNoNo d invoicing_rule_iNull NumberNoNo d last_updated_by Null NumberYes No last_update_dateNull DateYes No last_update_logiNull NumberNoNo n nameNull Varchar2(30)Yes No2-6 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 39. Parameter Usage TypeReq Drvorig_system_agr NullNumberNoNo_idoverride_arule_fl NullVarchar2(1) Yes Noagoverride_irule_fl NullVarchar2(1) Yes Noagprice_list_id NullNumberYes2Nopricing_contractNullNumberNoNo_idpurchase_order_ NullVarchar2(50)NoNonumrevisionNullVarchar2(50)Yes Norevision_date NullDateYes Norevision_reason_NullVarchar2(30)NoNocodesalesrep_id NullNumberNoNoship_method_coNullVarchar2(30)NoNodesignature_dateNullDateNoNostart_date_active NullDateNoNoterm_id NullNumberYes Noreturn_status NullVarchar2(1) NoNodb_flag NullVarchar2(1) NoNooperation NullVarchar2(30)Yes NoOracle Advanced Pricing Open Interfaces and APIs 2-7 40. Parameter UsageTypeReqDrv tp_attribute1 Null Varchar2(240) No No tp_attribute2 Null Varchar2(240) No No tp_attribute3 Null Varchar2(240) No No tp_attribute4 Null Varchar2(240) No No tp_attribute5 Null Varchar2(240) No No tp_attribute6 Null Varchar2(240) No No tp_attribute7 Null Varchar2(240) No No tp_attribute8 Null Varchar2(240) No No tp_attribute9 Null Varchar2(240) No No tp_attribute10Null Varchar2(240) No No tp_attribute11Null Varchar2(240) No No tp_attribute12Null Varchar2(240) No No tp_attribute13Null Varchar2(240) No No tp_attribute14Null Varchar2(240) No No tp_attribute15Null Varchar2(240) No No tp_attribute_cate Null Varchar2(30)No No goryorig_system_agr_idThe following table describes notations listed in the preceding table:2-8 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 41. NotationsNote Description1For update and delete2If you are not passing a price list recordAGREEMENT_TBL_TYPEThe following table shows the parameters for this structure.AGREEMENT_TBL_TYPE ParametersParameter Usage Type ReqDrvAgreement_Rec_NullRecord No NoTypeAGREEMENT_VAL_REC_TYPEThe following table shows the parameters for this structure.AGREEMENT_VAL_REC_TYPE ParametersParameter Usage Type ReqDrvaccounting_rule NullVarchar2(240)Null Nullagreement_conta NullVarchar2(240)Null Nullctagreement NullVarchar2(240)Null Nullagreement_typeNullVarchar2(240)Null NullcustomerNullVarchar2(240)Null Nullfreight_terms NullVarchar2(240)Null Nullinvoice_contact NullVarchar2(240)Null NullOracle Advanced Pricing Open Interfaces and APIs 2-9 42. ParameterUsage TypeReqDrv invoice_to_site_ NullVarchar2(240) Null Null use invoicing_rule NullVarchar2(240) Null Null override_arule NullVarchar2(240) Null Null override_irule NullVarchar2(240) Null Null price_list NullVarchar2(240) Null Null revision_reasonNullVarchar2(240) Null Null salesrep NullVarchar2(240) Null Null ship_methodNullVarchar2(240) Null Null term NullVarchar2(240) Null NullAGREEMENT_VAL_TBL_TYPEThe following table shows the parameters for this structure.AGREEMENT_VAL_TBL_TYPE Parameters ParameterUsage TypeReqDrv Agreement_Val_ NullRecordNo No Rec_TypePRICE_LIST_REC_TYPEThe following table shows the parameters for this structure.PRICE_LIST_REC_TYPE Parameters ParameterUsage TypeReqDrv attribute1 NullVarchar2No No2-10 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 43. ParameterUsage Type Req Drvattribute2 NullVarchar2 NoNoattribute3 NullVarchar2 NoNoattribute4 NullVarchar2 NoNoattribute5 NullVarchar2 NoNoattribute6 NullVarchar2 NoNoattribute7 NullVarchar2 NoNoattribute8 NullVarchar2 NoNoattribute9 NullVarchar2 NoNoattribute10NullVarchar2 NoNoattribute11NullVarchar2 NoNoattribute12NullVarchar2 NoNoattribute13NullVarchar2 NoNoattribute14NullVarchar2 NoNoattribute15NullVarchar2 NoNoautomatic_flag NullVarchar2 NoNocomments NullVarchar2 NoNocontextNullVarchar2 NoNocreated_by NullNumber NoNocreation_dateNullDate NoNocurrency_codeNullVarchar2 Yes No Oracle Advanced Pricing Open Interfaces and APIs 2-11 44. Parameter UsageTypeReqDrv discount_lines_fl Null Varchar2No No ag end_active_date Null DateNo No freight_terms_coNull Varchar2No No de gsa_indicator Null Varchar2No No last_updated_by Null NumberNo No last_update_dateNull DateNo No last_update_logiNull NumberNo No n list_header_idNull NumberNo No list_type_codeNull Varchar2No No program_applica Null NumberNo No tion_id program_idNull NumberNo No program_updateNull DateNo No _date prorate_flagNull Varchar2No No request_idNull NumberNo No rounding_factor Null NumberNo No ship_method_coNull Varchar2No No de start_date_active Null DateNo No terms_idNull NumberNo No2-12 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 45. Parameter UsageTypeReqDrvreturn_status Null Varchar2No Nodb_flag Null Varchar2No Nooperation Null Varchar2YesNonameNull Varchar2YesNodescription Null Varchar2No Noversion_noNull Varchar2No Noactive_flag Null Varchar2No Nomobile_downloaNull Varchar2No Nodcurrency_header Null NumberNo No_idpte_codeNull Varchar2No Yeslist_source_codeNull Varchar2No Noorig_system_hea Null Varchar2No Noder_refglobal_flag Null Varchar2No Noorg_idNull NumberNo YesNote: This API will initialize MOAC if it is not initialized prior. On theprice_list_rec, if the global_flag is passed as FND_API.G_MISS_CHAR,the API will default the global_flag as Y. If global_flag is passed as Nand if org_id is not null, the API will create the modifier list for thatoperating unit (OU). If global_flag is passed as "N" and if org_id is notpassed, the API will derive the org_id from the org context if set; if notset, use the default OU for that responsibility. The API validates theOrg_id to verify if the Org_Id corresponds to one of the OUs for thatresponsibility and raises an error if the org_id is not valid.Oracle Advanced Pricing Open Interfaces and APIs 2-13 46. PRICE_LIST_TBL_TYPEThe following table shows the parameters for this structure.PRICE_LIST_TBL_TYPE Parameters ParameterUsage TypeReqDrv Price_List_Rec_T NullRecordNo No ypePRICE_LIST_VAL_REC_TYPEThe following table shows the parameters for this structure.PRICE_LIST_VAL_REC_TYPE Parameters ParameterUsage TypeReqDrv automaticNullVarchar2No No currency NullVarchar2No No discount_lines NullVarchar2No No freight_termsNullVarchar2No No list_headerNullVarchar2No No list_typeNullVarchar2No No prorateNullVarchar2No No ship_methodNullVarchar2No No termsNullVarchar2No No currency_headerNullVarchar2No No pteNullVarchar2No NoPRICE_LIST_VAL_TBL_TYPEThe following table shows the parameters for this structure.2-14 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 47. PRICE_LIST_VAL_TBL_TYPE ParametersParameterUsageTypeReq DrvPrice_List_Val_R Null RecordNoNoec_TypePRICE_LIST_LINE_REC_TYPEThe following table shows the parameters for this structure:PRICE_LIST_LINE_REC_TYPE ParametersParameterUsageTypeReq Drvaccrual_qtyNull NumberNoNoaccrual_uom_co Null Varchar2NoNodearithmetic_opera Null Varchar2NoNotorattribute1 Null Varchar2NoNoattribute2 Null Varchar2NoNoattribute3 Null Varchar2NoNoattribute4 Null Varchar2NoNoattribute5 Null Varchar2NoNoattribute6 Null Varchar2NoNoattribute7 Null Varchar2NoNoattribute8 Null Varchar2NoNoattribute9 Null Varchar2NoNoattribute10Null Varchar2NoNo Oracle Advanced Pricing Open Interfaces and APIs 2-15 48. Parameter UsageTypeReqDrv attribute11 Null Varchar2No No attribute12 Null Varchar2No No attribute13 Null Varchar2No No attribute14 Null Varchar2No No attribute15 Null Varchar2No No automatic_flagNull Varchar2No No base_qtyNull NumberNo No base_uom_code Null Varchar2No No commentsNull Varchar2No No context Null Varchar2No No created_byNull NumberNo No creation_date Null DateNo No effective_period_ Null Varchar2No No uom end_date_active Null DateNo No estim_accrual_raNull NumberNo No te generate_using_fNull NumberNo No ormula_id inventory_item_iNull NumberNo No d last_updated_by Null NumberNo No2-16 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 49. Parameter Usage Type Req Drvlast_update_dateNullDate NoNolast_update_logiNullNumber NoNonlist_header_idNullNumber NoNolist_line_idNullNumber NoNolist_line_type_co NullVarchar2 NoNodelist_priceNullNumber NoNomodifier_level_cNullVarchar2 NoNoodenumber_effectiv NullNumber NoNoe_periodsoperand NullNumber NoNoorganization_id NullNumber NoNooverride_flag NullVarchar2 NoNopercent_price NullNumber NoNoprice_break_typeNullVarchar2 NoNo_codeprice_by_formul NullNumber NoNoa_idprimary_uom_flNullVarchar2 NoNoagprint_on_invoiceNullVarchar2 NoNo_flagOracle Advanced Pricing Open Interfaces and APIs 2-17 50. ParameterUsage TypeReqDrv program_applicaNullNumberNo No tion_id program_id NullNumberNo No program_update NullDateNo No _date rebate_trxn_type NullVarchar2No No _code related_item_idNullNumberNo No relationship_typ NullNumberNo No e_id reprice_flag NullVarchar2No No request_id NullNumberNo No revision NullVarchar2No No revision_dateNullDateNo No revision_reason_ NullVarchar2No No code start_date_activeNullDateNo No substitution_attri NullVarchar2No No bute substitution_con NullVarchar2No No text substitution_val NullVarchar2No No ue return_statusNullVarchar2No No db_flagNull Varchar2No No2-18 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 51. Parameter Usage TypeReq Drvoperation NullVarchar2NoNofrom_rltd_modif NullNumberNoNoier_idrltd_modifier_grNullNumberNoNooup_norltd_modifier_grNullVarchar2NoNop_typeproduct_precede NullNumberNoNonceCustomer_Item_NullNumberYes NoIdprice_break_hea NullNumberNoNoder_indexlist_line_noNullNumberNoYesqualification_ind NullNumberNoYesPRICE_LIST_LINE_TBL_TYPEThe following table shows the parameters for this structure.PRICE_LIST_LINE_TBL_TYPE ParametersParameter Usage TypeReq DrvPrice_List_Line_NullRecordNoNoRec_TypePRICE_LIST_LINE_VAL_REC_TYPEThe following table shows the parameters for this structure. Oracle Advanced Pricing Open Interfaces and APIs 2-19 52. PRICE_LIST_LINE_VAL_REC_TYPE Parameters Parameter UsageTypeReqDrv accrual_uom Null Varchar2No No automatic Null Varchar2No No base_uomNull Varchar2No No generate_using_fNull Varchar2No No ormula inventory_itemNull Varchar2No No list_header Null Varchar2No No list_line Null Varchar2No No list_line_typeNull Varchar2No No modifier_levelNull Varchar2No No organizationNull Varchar2No No overrideNull Varchar2No No price_break_typeNull Varchar2No No price_by_formul Null Varchar2No No a primary_uom Null Varchar2No No print_on_invoiceNull Varchar2No No rebate_transactio Null Varchar2No No n_type related_itemNull Varchar2No Null2-20 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 53. ParameterUsageTypeReq Drvrelationship_typ Null Varchar2NoNullerepriceNull Varchar2NoNullrevision_reasonNull Varchar2NoNullPRICE_LIST_VAL_TBL_TYPEThe following table shows the parameters for this structure.PRICE_LIST_VAL_TBL_TYPE ParametersParameterUsageTypeReq DrvPrice_List_Line_ Null RecordNoNoVal_Rec_TypePRICING_ATTR_REC_TYPEThe following table shows the parameters for this structure.PRICING_ATTR_REC_TYPE ParametersParameterUsageTypeReq Drvaccumulate_flagNull Varchar2NoNoattribute1 Null Varchar2NoNoattribute2 Null Varchar2NoNoattribute3 Null Varchar2NoNoattribute4 Null Varchar2NoNoattribute5 Null Varchar2NoNoattribute6 Null Varchar2NoNo Oracle Advanced Pricing Open Interfaces and APIs 2-21 54. Parameter UsageTypeReqDrv attribute7Null Varchar2No No attribute8Null Varchar2No No attribute9Null Varchar2No No attribute10 Null Varchar2No No attribute11 Null Varchar2No No attribute12 Null Varchar2No No attribute13 Null Varchar2No No attribute14 Null Varchar2No No attribute15 Null Varchar2No No attribute_groupiNull NumberNo No ng_number context Null Varchar2No No created_byNull NumberNo No creation_date Null DateNo No excluder_flag Null Varchar2No No last_updated_by Null NumberNo No last_update_dateNull DateNo No last_update_logiNull NumberNo No n list_line_idNull NumberNo No pricing_attribute Null Varchar2No No2-22 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 55. Parameter Usage Type Req Drvpricing_attribute NullVarchar2 NoNo_contextpricig_attribute_ NullNumber NoNoidpricing_attr_valu NullVarchar2 NoNoe_frompricing_attr_valu NullVarchar2 NoNoe_toproduct_attributNullVarchar2 Yes Noeproduct_attributNullVarchar2 Yes Noe_contextproduct_attr_valNullVarchar2 Yes Noueproduct_uom_coNullVarchar2 Yes Nodeprogram_applica NullNumber NoNotion_idprogram_idNullNumber NoNoprogram_updateNullDate NoNo_daterequest_idNullNumber NoNopricing_attr_valu NullNumber NoYese_from_numberpricing_attr_valu NullNumber NoYese_to_numberqualification_ind NullNumber NoYesOracle Advanced Pricing Open Interfaces and APIs 2-23 56. ParameterUsage TypeReqDrv return_statusNullVarchar2No No db_flagNullVarchar2No No operationNullVarchar2YesNo PRICE_LIST_LINullNumberNo No NE_index from_rltd_modifNullNumberNo No ier_id comparison_ope NullVarchar2YesNo rator_code product_attribut NullVarchar2No Yes e_datatype pricing_attrubut NullVarchar2No Yes e_datatype list_header_id NullNumberNo Yes pricing_phase_id NullNumberNo YesPRICING_ATTR_TBL_TYPEThe following table shows the parameters for this structure.PRICING_ATTR_TBL_TYPE Parameters ParameterUsage TypeReqDrv Pricing_Attr_Rec NullRecordNo No _TypePRICING_ATTR_VAL_REC_TYPEThe following table shows the parameters for this structure.2-24 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 57. PRICING_ATTR_VAL_REC_TYPE ParametersParameter Usage Type Req DrvaccumulateNullVarchar2 NoNoexcluderNullVarchar2 NoNolist_line NullVarchar2 NoNopricing_attribute NullVarchar2 NoNoproduct_uom NullVarchar2 NoNopricing_attribute NullVarchar2 NoNo_descpricing_attr_valu NullVarchar2 NoNoe_from_descpricing_attr_valu NullVarchar2 NoNoe_to_descPRICE_LIST_VAL_TBL_TYPEThe following table shows the parameters for this structure.PRICE_LIST_VAL_TBL_TYPE ParametersParameter Usage Type Req DrvPricing_Attr_ValNullRecord NoNo_Rec_TypeNote: This API will initialize MOAC if it has not been initialized prior.For more information, see the Oracle Multi-Organization ReferenceManual.Oracle Advanced Pricing Open Interfaces and APIs 2-25 58. Validation of Agreements Public APIStandard ValidationOracle Advanced Pricing validates all required columns in the Agreements Public API.Other ValidationNoneError HandlingIf any validation fails, the API will return error status to the calling module. TheAgreements Public API processes the rows and reports the values in the following tablefor every record.Error Handling Condition PROCESS_STATUS ERROR_MESSAGE Success 5null Failure 4actual error messageExample of Agreements Public APIThe following example scripts are located in the directory $qp/patch/115/sql: QPAGXMP1.sql: Insert an agreement and a price list header. QPAGXMP2.sql: Insert an agreement, a price list header, and lines. QPAGXMP3.sql: Create an agreement with a standard price list. QPAGXMP4.sql: Update an agreement which has a standard price list. QPAGXMP5.sql: Update agreement record and create agreement price list. QPAGXMP6.sql: Update an agreement record and update an agreement price listheader. QPAGXMP7.sql: Delete an agreement.Attribute Mapping Application Program InterfaceThis section explains how to use the Attribute Mapping APIs and how it functions inOracle Advanced Pricing. Currently, in the new model, there are three AttributeMapping packages. They are :2-26 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 59. QP_ATTR_MAP_PUB QP_ATTRIBUTES_PUB QP_ATTR_MAPPING_PUBFunctional Overview The Public package QP_ATTR_MAP_PUB is a Business Object API, based on the following tables: QP_LOOKUPS (Type : QP_PTE_TYPE) QP_PTE_SOURCE_SYSTEMS QP_PTE_REQUEST_TYPES_B/TL QP_PTE_SEGMENTS QP_ATTRIBUTE_SOURCING QP_SOURCESYSTEM_FNAREA_MAP The QP_ATTR_MAP_PUB model and its object name is Attr_Map and the relationship of the tables is shown below. The package QP_ATTR_MAP_PUB contains the following APIs and record type definitions:Note: The API processes one record with each call. The callingapplication must populate the global records that referenced in theattribute mapping rules. The output of the API is a PL/SQL table witheach record having the context name, attribute name, and attributevalue. Pte_Val_Rec_Type Pte_Val_Rec_Type Rqt_Rec_Type Rqt_Tbl_Type Rqt_Val_Rec_Type Ssc_Rec_Type Ssc_Tbl_Type Oracle Advanced Pricing Open Interfaces and APIs 2-27 60. Ssc_Val_Rec_Type Psg_Rec_Type Psg_Val_Rec_Type Sou_Rec_Type Sou_Val_Rec_Type Fna_Rec_Type Fna_ValRec_Type PROCEDURE Process_Attr_Mapping PROCEDURE Lock_Attr_Mapping PROCEDURE Get_Attr_MappingSetting Up and Parameter DescriptionsThe following chart describes all parameters used by the public Attribute Mapping APIQP_ATTR_MAP_PUB. All of the inbound and outbound parameters are listed.Additional information on these parameters may follow.Procedure PROCESS_ATTR_MAPPINGThe following table shows the parameters for this structure. This API will add, updateor delete a Source System, Request type, PTE-Attribute link, Attribute Mapping rulesdepending on the input parameter.PROCESS_ATTR_MAPPING Parameters Parameter UsageTypeReqDrv p_api_version_n In NumberYesNo umber p_init_msg_list In Varchar2No No p_return_values In Varchar2No No p_commitIn Varchar2No No2-28 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 61. Parameter Usage Type Req Drvx_return_status Out Number NoNox_msg_count Out Varchar2 NoNox_msg_dataOut Pte_Rec_Type NoNop_PTE_rec InPte_Val_Rec_Ty NoNopep_PTE_val_rec InPte_Val_Rec_Ty NoNopep_RQT_tbl InRqt_Tbl_Type NoNop_RQT_val_tbl InRqt_Val_Tbl_Ty NoNopep_SSC_tbl InSsc_Tbl_Type NoNop_SSC_val_tbl InSsc_Val_Tbl_TypNoNoep_PSG_tbl InPsg_Tbl_Type NoNop_PSG_val_tbl InPsg_Val_Tbl_Ty NoNopep_SOU_tbl InSou_Tbl_Type NoNop_SOU_val_tbl InSou_Val_Tbl_Ty NoNopep_FNA_tbl InFna_Tbl_Type NoNop_FNA_val_tbl InFna_Val_Tbl_Ty NoNopex_PTE_rec Out Pte_Rec_Type NoNox_PTE_val_rec Out Pte_Val_Rec_Ty NoNopeOracle Advanced Pricing Open Interfaces and APIs 2-29 62. Parameter UsageTypeReqDrv x_RQT_tbl OutRqt_Tbl_TypeNo No x_RQT_val_tbl OutRqt_Val_Tbl_TyNo Nope x_SSC_tbl OutSsc_Tbl_TypeNo No x_SSC_val_tbl OutSsc_Val_Tbl_Typ No Noe x_PSG_tbl OutPsg_Tbl_TypeNo No x_PSG_val_tbl OutPsg_Val_Tbl_TyNo Nope x_SOU_tbl OutSou_Tbl_TypeNo No x_SOU_val_tbl OutSou_Val_Tbl_TyNo Nope x_FNA_tbl OutFna_Tbl_TypeNo No x_FNA_val_tbl OutFna_Val_Tbl_TyNo Nopep_api_version_numberThis the version number of the API.P_PTE_RECThe following table shows the parameters for this structure.P_PTE_REC Parameters Parameter UsageTypeReqDrv Description Null Varchar2No No Enabled_flagNull Varchar2No No2-30 Oracle Order Management Open Interfaces, API, & Electronic Messaging Guide 63. Parameter UsageType Req DrvEnd_date_active Null Date NoNoLookup_code Null Varchar2 NoNoLookup_type Null Varchar2 NoNomeaning Null Varchar2 NoNoStart_date_active Null Date NoNoP_PTE_VAL_RECThe following table shows the parameters for this structure.P_PTE_VAL_REC ParametersParameter UsageType Req Drvenabled Null Varchar2 NoNolookupNull Varchar2 NoNoThe following table shows the parameters for the tables and their structures.Tables and StructuresTable NameUsage TypeP_RQT_TBL NullTABLE OF Rqt_Rec_TypeP_RQT