Oracle Order Management Suite APIs and Open Interfaces Manual

Oracle Order Management Suite APIs and Open Interfaces Manual

Volume 1 Release 11i

March 2001 Part No. A88868-01

Oracle? Order Management Suite APIs and Open Interfaces Manual, Release 11i

Part No. A88868-01

Copyright ? 1999, 2001 Oracle Corporation. All rights reserved.

Contributing Authors: Elizabeth Looney, Tom Myers, John Salvini, James Siri,

Contributors: David Reitan

The programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be licensee's responsibility to take all appropriate fail-safe, back up, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle disclaims liability for any damages caused by such use of the Programs.

This Program contains proprietary information of Oracle Corporation; it is provided under a license agreement containing restrictions on use and disclosure and is also protected by copyright, patent and other intellectual property law. Reverse engineering of the software is prohibited.

Program Documentation is licensed for use solely to support the deployment of the Programs and not for any other purpose.

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. No part of this document 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 this Program is delivered to a U.S. Government Agency of the Department of Defense, then it is delivered with Restricted Rights and the following legend is applicable:

Restricted Rights Legend Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication and disclosure of the Programs 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-14, Rights in Data -- General, including Alternate III (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065.

Oracle is a registered trademark, and Oracle Applications, Oracle Inventory, Oracle EDI Gateway, Oracle Payables, Oracle Purchasing, Oracle Self-Service Purchasing, Oracle Self-Service Web Applications, Context, Financial Analyzer, Oracle7, Oracle8, Oracle Alert, Oracle Applications, Oracle Discoverer, Oracle Financials, Object Library, Oracle Work in Process, Oracle Workflow, SmartClient, PL/SQL, SQL*Calc, SQL*Forms, SQL*Loader, SQL*Menu, SQL*Net, SQL*Plus, SQL*Report, SQL*ReportWriter, Oracle Web Employees, and SQL*QMX are trademarks or registered trademarks of Oracle Corporation. Windows NT is a registered trademark of Microsoft Corporation. All other company or product names mentioned are used for identification purposes only and may be trademarks of their respective owners.

Contents

Send Us Your Comments ................................................................................................................... ix

Preface............................................................................................................................................................ xi

About This Manual.......................................................................................................................... xi Audience for This Manual............................................................................................................. xii Do Not Use Database Tools to Modify Oracle Applications Data .......................................... xii Other Information Sources............................................................................................................ xii

1 Integrating Your Systems

Overview of Oracle Order Management APIs and Open Interfaces........................................ 1-2 Basic Business Needs ................................................................................................................... 1-2 Oracle Manufacturing Interfaces................................................................................................ 1-2 Inbound Open Interface Model ................................................................................................ 1-10 Components of an Open Interface ........................................................................................... 1-12

2 Oracle Order Management Open Interface

HEADERS INTERFACE .................................................................................................................... 2-2 LINES INTERFACE.......................................................................................................................... 2-21 PRICE ADJUSTMENT INTERFACE ............................................................................................ 2-46 SALES CREDITS INTERFACE...................................................................................................... 2-53 RESERVATION INTERFACE ......................................................................................................... 2-57 ACTIONS INTERFACE................................................................................................................... 2-59

iii

LOTSERIAL INTERFACE............................................................................................................... 2-63 Calling The Sales Order Form From Other Modules ................................................................ 2-66

Overview...................................................................................................................................... 2-66 Integrating Oracle Order Management Using Order Import................................................... 2-68 Integrating Oracle Order Management with Oracle Receivables for Invoicing ................ 2-124

Basic Needs ................................................................................................................................ 2-124 Major Features........................................................................................................................... 2-124 Invoicing of ATO Configurations........................................................................................... 2-131 Understanding the Interface Tables ....................................................................................... 2-132 RA_INTERFACE_SALESCREDITS ....................................................................................... 2-148 Oracle Order Management Process Order API ......................................................................... 2-151 Process Order API Features ................................................................................................... 2-151 Functional Overview................................................................................................................ 2-162 Processing the Sales Order business object........................................................................... 2-162 ............................................................................. Setting Up the Process_Order Procedure 2-166 Setting Up the Get_Order Procedure..................................................................................... 2-175 Setting Up the Lock_Order Procedure .................................................................................. 2-179 PL/SQL Record Structures...................................................................................................... 2-185 Usage .......................................................................................................................................... 2-224

3 Oracle Pricing Open Interfaces

Formula Calculation Application Program Interface .................................................................. 3-2 Formula Calculation API Features ............................................................................................. 3-2 Functional Overview.................................................................................................................... 3-2 Setting Up the Formula Calculation API................................................................................... 3-2 Validation of Formula Calculation API..................................................................................... 3-4

Update Formula Prices Application Program Interface .............................................................. 3-6 Update Formula Prices API Features......................................................................................... 3-6 Functional Overview.................................................................................................................... 3-6 Setting Up the Update Formula Prices API .............................................................................. 3-6 Validation of Update Formula Prices API ................................................................................ 3-7

Copy Price List Application Program Interface ............................................................................ 3-8 Copy Price List API Features ...................................................................................................... 3-8 Functional Overview.................................................................................................................... 3-8

iv

Setting Up the Copy Price List API............................................................................................ 3-9 Validation of Copy Price List API ............................................................................................ 3-11 Adjust Price List Application Program Interface ....................................................................... 3-13 Adjust Price List API Features.................................................................................................. 3-13 Functional Overview.................................................................................................................. 3-13 Setting Up the Adjust Price List API ....................................................................................... 3-13 Validation of Adjust Price List API.......................................................................................... 3-14 Business Object for Pricing Formulas Application Program Interface.................................. 3-16 Business Object for Pricing Formulas API Features .............................................................. 3-16 Functional Overview.................................................................................................................. 3-16 Setting Up the Business Object for Pricing Formulas API.................................................... 3-17 Validation of Business Object for Pricing Formulas API...................................................... 3-27 Price Request Application Program Interface............................................................................. 3-29 Price Request API Features ....................................................................................................... 3-29 Functional Overview.................................................................................................................. 3-29 Setting Up the Price Request API............................................................................................. 3-30 Validation of Price Request API ............................................................................................... 3-47 Business Object for Modifier Setup Application Program Interface..................................... 3-49 Business Object for Modifier Setup API Features.................................................................. 3-49 Functional Overview.................................................................................................................. 3-49 Setting Up the Business Object for Modifier Setup API ....................................................... 3-50 Validation of Business Object for Modifier Setup API.......................................................... 3-82 Qualifiers Application Program Interface ................................................................................... 3-83 Qualifiers API Features.............................................................................................................. 3-83 Functional Overview.................................................................................................................. 3-83 Setting Up the Qualifiers API ................................................................................................... 3-84 Validation of Qualifiers API ..................................................................................................... 3-97 Attribute Mapping Application Program Interface ................................................................... 3-98 Attribute Mapping API Features.............................................................................................. 3-98 Functional Overview.................................................................................................................. 3-98 Setting Up the Attribute Mapping API ................................................................................... 3-98 Validation of Attribute Mapping API ................................................................................... 3-107 Price List Setup Application Program Interface ....................................................................... 3-109 Price List Setup API Features.................................................................................................. 3-109 Functional Overview................................................................................................................ 3-109

v

 ................
................

In order to avoid copyright disputes, this page is only a partial summary.

Google Online Preview   Download