Oracle Manufacturing APIs and Open InterfacesManual Release 11iPart No. A95953-04

January 2005

Oracle Manufacturing APIs and Open Interfaces Manual, Release 11i Part No. A95953-04 Copyright 1996, 2005 Oracle. All rights reserved. Primary Authors: Jill Arehart, John Brazier, Kevin Brown, Laurel Dale, Tyra Crockett, Rachel Haas, Elizabeth Looney, Swati Mohanti, Tom Myers, Susan Saperstein, Amy Sonczalla, Leanne Vakoc The Programs (which include both the software and documentation) contain proprietary information; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent, and other intellectual and industrial property laws. Reverse engineering, disassembly, or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. This document is not warranted to be error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose. If the Programs are delivered to the United States Government or anyone licensing or using the Programs on behalf of the United States Government, the following notice is applicable: U.S. GOVERNMENT RIGHTS Programs, software, databases, and related documentation and technical data delivered to U.S. Government customers are "commercial computer software" or "commercial technical data" pursuant to the applicable Federal Acquisition Regulation and agency-specific supplemental regulations. As such, use, duplication, disclosure, modification, and adaptation of the Programs, including documentation and technical data, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement, and, to the extent applicable, the additional rights set forth in FAR 52.227-19, Commercial Computer Software--Restricted Rights (June 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and we disclaim liability for any damages caused by such use of the Programs. The Programs may provide links to Web sites and access to content, products, and services from third parties. Oracle is not responsible for the availability of, or any content provided on, third-party Web sites. You bear all risks associated with the use of such content. If you choose to purchase any products or services from a third party, the relationship is directly between you and the third party. Oracle is not responsible for: (a) the quality of third-party products or services; or (b) fulfilling any of the terms of the agreement with the third party, including delivery of products or services and warranty obligations related to purchased products or services. Oracle is not responsible for any loss or damage of any sort that you may incur from dealing with any third party. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of their respective owners.

ContentsSend Us Your Comments ................................................................................................................ xxv Preface....................................................................................................................................................... xxviiHow To Use This Guide .................................................................................................................. xxviii Other Information Sources ................................................................................................................ xxx Installation and System Administration ....................................................................................... xxxv Training and Support..................................................................................................................... xxxviii Do Not Use Database Tools to Modify Oracle Applications Data ........................................... xxxix About Oracle .................................................................................................................................... xxxix Your Feedback........................................................................................................................................ xl

Integrating Your SystemsOverview .............................................................................................................................................. Overview of Oracle Manufacturing APIs and Open Interfaces ................................................ Basic Business Needs ................................................................................................................... Oracle Manufacturing Interfaces................................................................................................ Inbound Open Interface Model .................................................................................................. Components of an Open Interface ........................................................................................... 1-1 1-2 1-2 1-2 1-9 1-12

Oracle ASCP and Oracle Global ATP Server Open InterfacesODS Load API Features..................................................................................................................... Functional Overview.......................................................................................................................... Setting Up the ODS Load API.......................................................................................................... Parameter Descriptions................................................................................................................ 2-2 2-7 2-7 2-8

v

MSC_ST_ASSIGNMENT_SETS.................................................................................................. MSC_ST_ATP_RULES ............................................................................................................... MSC_ST_BILL_OF_RESOURCES ............................................................................................ MSC_ST_BIS_BUSINESS_PLANS............................................................................................ MSC_ST_BIS_PERIODS ............................................................................................................. MSC_ST_BIS_PFMC_MEASURES ........................................................................................... MSC_ST_BIS_TARGETS............................................................................................................

2-8 2-10 2-16 2-18 2-21 2-24 2-27

Bills of Material Business Object InterfaceBill of Materials API Overview....................................................................................................... Features .......................................................................................................................................... Bills of Material Entity Diagram...................................................................................................... Bills of Material Business Object Architecture ......................................................................... Bills of Material Header ............................................................................................................... Revisions ........................................................................................................................................ Components................................................................................................................................... Substitute Component ................................................................................................................. Reference Designator ................................................................................................................... Production Tables ......................................................................................................................... Business Logic and Business Object Rules................................................................................ Bill of Material Import Description ................................................................................................ Bill of Material Parameter Descriptions....................................................................................... Bills of Material Exposed Columns .......................................................................................... Bills of Material Components Exposed Columns .................................................................. Item Revision Exposed Columns ............................................................................................. Substitute Component Exposed Columns .............................................................................. Launching the Import ................................................................................................................ Bill of Material Package Interaction.............................................................................................. Bill of Material Import Error Handling and Messaging ........................................................... Error Handling Concepts .......................................................................................................... Error Severity Levels .................................................................................................................. Error States................................................................................................................................... Error Scope................................................................................................................................... Child Error States........................................................................................................................ Unexpected errors....................................................................................................................... 3-1 3-2 3-2 3-3 3-3 3-4 3-4 3-4 3-4 3-4 3-5 3-5 3-10 3-10 3-12 3-18 3-20 3-23 3-28 3-30 3-30 3-30 3-30 3-31 3-31 3-32

vi

Child record:................................................................................................................................ Sibling record .............................................................................................................................. Business Object Error Status ..................................................................................................... Record Error Status .................................................................................................................... API Messaging ............................................................................................................................ Message formats ......................................................................................................................... Other message............................................................................................................................. Error Handler .............................................................................................................................. Bill of Material Export API ............................................................................................................. Launching the Export................................................................................................................. INPUT Parameters ..................................................................................................................... OUTPUT Parameters ................................................................................................................. Export Error Handling and Messaging ................................................................................... Routing API Overview .................................................................................................................... Routing API Features................................................................................................................ Routing Entity Diagram ............................................................................................................ Routing Architecture.................................................................................................................. Routing Header........................................................................................................................... Routing Revisions....................................................................................................................... Operation Sequence ................................................................................................................... Operation Resource .................................................................................................................... Substitute Operation Resource ................................................................................................. Operation Network .................................................................................................................... The Routing API as it exists in the database........................................................................... API Traversal Strategy ............................................................................................................... Routing Import Description ........................................................................................................... Routing Parameter Descriptions.................................................................................................... Routing Revision Exposed Columns ....................................................................................... Operation Sequence Exposed Columns .................................................................................. Operation Resources Exposed Columns ................................................................................. Substitute Operation Resources Exposed Columns .............................................................. Operation Networks Exposed Columns ................................................................................. Launching the Routing Import ...................................................................................................... Three Step Rule ........................................................................................................................... Resetting Messages:....................................................................................................................

3-33 3-33 3-33 3-33 3-34 3-35 3-36 3-36 3-39 3-39 3-39 3-40 3-40 3-43 3-43 3-44 3-45 3-45 3-46 3-46 3-46 3-46 3-46 3-46 3-47 3-48 3-53 3-56 3-58 3-64 3-70 3-74 3-76 3-76 3-80

vii

Retrieving Messages:.................................................................................................................. Deleting Messages: ..................................................................................................................... Routing Package Interaction........................................................................................................... The Public Package - BOM_Rtg_PUB ...................................................................................... Unexpected Error Other Messages........................................................................................... Routing Import Error Handling and Messaging ........................................................................ Error Handling Concepts .......................................................................................................... Error Classes ................................................................................................................................ API Messaging................................................................................................................................... API Message Table ..................................................................................................................... Message formats ......................................................................................................................... Unexpected errors:...................................................................................................................... Other message: ............................................................................................................................ Error Handler .............................................................................................................................. Message and Token List Records .............................................................................................

3-80 3-81 3-81 3-81 3-82 3-83 3-83 3-84 3-88 3-88 3-89 3-90 3-90 3-90 3-91

Oracle Cost Management Open InterfacesPeriodic Cost Open Interface............................................................................................................ Functional Overview.................................................................................................................... Setting Up the Interface..................................................................................................................... Create Indexes for Performance ................................................................................................. Periodic Cost Open Interface Runtime Options........................................................................... Inserting into the Periodic Cost Interface Tables ......................................................................... Periodic Costs Interface Table Description ............................................................................... Periodic Cost Detail Interface Table Description ..................................................................... Required Data................................................................................................................................ Validation ............................................................................................................................................. Importing Additional Periodic Cost Details ........................................................................... Reviewing Failed Rows ................................................................................................................... Log File Messages ....................................................................................................................... Cost Import Interface ....................................................................................................................... Parameters and Descriptions .................................................................................................... Setting Up the Cost Import Interface ............................................................................................ CST_RESOURCE_COSTS_INTERFACE ................................................................................. Column Descriptions.................................................................................................................. 4-2 4-2 4-3 4-3 4-4 4-4 4-4 4-7 4-8 4-9 4-12 4-12 4-12 4-14 4-14 4-16 4-17 4-18

viii

CST_RESOURCE_COSTS_INTERFACE Table Validations................................................. CST_RES_OVERHEADS_INTERFACE .................................................................................. Column Descriptions ................................................................................................................. CST_RES_OVERHEADS_INTERFACE Table Validations .................................................. CST_DEPT_OVERHEADS_INTERFACE ............................................................................... Column Descriptions ................................................................................................................. CST_DEPT_OVERHEADS_INTERFACE Table Validations ............................................... CST_ITEM_CST_DTLS_INTERFACE ..................................................................................... Column Descriptions ................................................................................................................. CST_ITEM_CST_DTLS_INTERFACE Table Validations ..................................................... Common Validations .................................................................................................................

4-19 4-20 4-21 4-22 4-22 4-24 4-25 4-26 4-28 4-30 4-31

eAM Open Interfaces and APIseAM Interfaces and APIs .................................................................................................................. eAM Item Open Interface............................................................................................................ eAM Asset Number Open Interface .......................................................................................... eAM Asset Genealogy Open Interface .................................................................................... eAM Meter Reading Open Interface........................................................................................ Asset Number API...................................................................................................................... Asset Attribute Values API ....................................................................................................... Asset Attribute Groups API...................................................................................................... Asset Routes API ........................................................................................................................ Asset Areas API .......................................................................................................................... Department Approvers API...................................................................................................... EAM Parameters API ................................................................................................................. EAM Meters API......................................................................................................................... EAM Meter Association API..................................................................................................... Meter Reading API ..................................................................................................................... EAM PM Schedules API (includes PM Rules as children records)..................................... Activity Creation API................................................................................................................. EAM Activity Association API ................................................................................................. EAM Activity Suppression API................................................................................................ EAM Set Name API.................................................................................................................... Maintenance Object Instantiation API..................................................................................... Work Order Business Object API ............................................................................................. 5-3 5-4 5-9 5-16 5-18 5-22 5-26 5-31 5-33 5-36 5-38 5-40 5-44 5-48 5-49 5-51 5-58 5-70 5-75 5-78 5-81 5-82

ix

Work Request API .................................................................................................................... 5-100

Engineering Change Order Business Object InterfaceOverview .............................................................................................................................................. Features ................................................................................................................................................. ECO Business Object .................................................................................................................... ECO Entity Diagram .................................................................................................................... The Business Object in the Database.......................................................................................... Business Object Interface Design................................................................................................ ECO Business Object Architecture ............................................................................................. Business Object APIs ......................................................................................................................... Business Object API Framework ................................................................................................ Process Flow .................................................................................................................................. Entity Process Flows ......................................................................................................................... Exposed Columns and Un-exposed columns......................................................................... Data Entry Rules ......................................................................................................................... ECO Headers...................................................................................................................................... Columns Exposed to the User................................................................................................... ECO Revisions................................................................................................................................... Columns Exposed to the User................................................................................................... Revised Items..................................................................................................................................... Columns Exposed to the User................................................................................................... Revised Components ....................................................................................................................... Columns Exposed to the User................................................................................................... Reference Designators ..................................................................................................................... Columns Exposed to the User................................................................................................... Substitute Components ................................................................................................................... Columns Exposed to the User................................................................................................... New API Packages ............................................................................................................................ Main Packages............................................................................................................................. Shared Packages.......................................................................................................................... Entity Packages ........................................................................................................................... Commits and Rollbacks ............................................................................................................. Launching the Import ...................................................................................................................... Package Interaction........................................................................................................................... 6-1 6-2 6-3 6-4 6-4 6-5 6-5 6-7 6-7 6-8 6-12 6-12 6-12 6-13 6-13 6-15 6-15 6-16 6-16 6-18 6-18 6-21 6-21 6-23 6-23 6-24 6-24 6-24 6-25 6-26 6-26 6-32

x

The Public Package - ENG_ECO_PUB .................................................................................... The Private Package - ENG_BO_PVT...................................................................................... Sample Launch Package ............................................................................................................ Import Error Handling and Messaging ........................................................................................ Error Handler Flow Diagram ................................................................................................... Error Handling Concepts .......................................................................................................... Error Severity Levels.................................................................................................................. Error States .................................................................................................................................. Error Scope .................................................................................................................................. Child Error States ....................................................................................................................... How it all works ......................................................................................................................... API Messaging .................................................................................................................................. API Message Table ..................................................................................................................... Message Formats ........................................................................................................................ Unexpected errors: ..................................................................................................................... Other message:............................................................................................................................ Error Handler..................................................................................................................................... Message and Token List Records .............................................................................................

6-32 6-33 6-34 6-45 6-45 6-46 6-46 6-46 6-47 6-47 6-50 6-54 6-54 6-55 6-55 6-55 6-56 6-57

Oracle Inventory Open Interfaces and APIsOpen Transaction Interface............................................................................................................... Setting Up the Transaction Interface ......................................................................................... Inserting into the Transaction Interface Tables ........................................................................ MTL_TRANSACTION_LOTS_INTERFACE.......................................................................... MTL_SERIAL_NUMBERS_INTERFACE................................................................................ CST_COMP_SNAP_INTERFACE.......................................................................................... Validation .................................................................................................................................... Resolving Failed Transaction Interface Rows ........................................................................ Transaction Flow Application Program Interface....................................................................... Open Replenishment Interface...................................................................................................... Functional Overview.................................................................................................................. Setting Up the Replenishment Interface.................................................................................. Inserting into the Replenishment Interface Tables ................................................................ Replenishment Headers Interface Tables................................................................................ Validation .................................................................................................................................... 7-2 7-5 7-6 7-21 7-23 7-24 7-25 7-26 7-27 7-37 7-37 7-38 7-38 7-38 7-44

xi

Viewing Failed Transactions..................................................................................................... Fixing Failed Transactions......................................................................................................... Open Item Interface.......................................................................................................................... Functional Overview.................................................................................................................. Setting Up the Item Interface .................................................................................................... Item Interface Runtime Options ............................................................................................... Inserting into the Item Interface Table..................................................................................... Validation..................................................................................................................................... Importing Additional Item Details .......................................................................................... Importing Item Category Assignments................................................................................... Item Category Assignment Interface Runtime Options........................................................ Inserting into the Item Categories Interface Table................................................................. Update Existing Items ................................................................................................................ Determining Batch Size.............................................................................................................. Resolving Failed Interface Rows .............................................................................................. Multi-Thread Capability (Parallel Runs of the Item Interface) ............................................ Customer Item and Customer Item Cross-Reference Open Interfaces .................................. Functional Overview - Customer Item Interface ................................................................... Functional Overview - Customer Item Cross-Reference Interface...................................... Workflow - Customer Item Interface and Customer Item Cross-Reference Interface ..... Interface Runtime Options ........................................................................................................ Customer Item Interface Table ................................................................................................. Customer Item Interface - Defining a Unique Customer Item............................................. Customer Item Interface - Other fields .................................................................................... Customer Item Cross-Reference Interface Table.................................................................... Cycle Count Entries Interface......................................................................................................... Interface Runtime Options ........................................................................................................ Cycle Count Entries Interface Table......................................................................................... Cycle Count Interface Errors Table .......................................................................................... Table Administration and Audit Trail..................................................................................... Cycle Count Application Program Interface ............................................................................... Setting Up the Cycle Count API ............................................................................................... Validation of Cycle Count API ................................................................................................. Kanban Application Program Interface ....................................................................................... Setting Up the Kanban API .......................................................................................................

7-45 7-46 7-47 7-47 7-48 7-50 7-52 7-61 7-62 7-66 7-66 7-67 7-68 7-69 7-70 7-72 7-76 7-76 7-76 7-77 7-77 7-79 7-81 7-83 7-87 7-91 7-91 7-91 7-93 7-94 7-96 7-96 7-98 7-99 7-99

xii

Validation of Kanban API ....................................................................................................... Lot Application Program Interface.............................................................................................. Setting Up the Lot API............................................................................................................. Validation of Lot API ............................................................................................................... Material Reservation Application Program Interface ............................................................. Functional Overview................................................................................................................ Setting Up the Material Reservation API.............................................................................. Validation of Material Reservation API ................................................................................ Reservations Manager Application Program Interface ........................................................... Setting Up the Reservations Manager API ........................................................................... Validation of Reservations Manager API ............................................................................. Sales Order Application Program Interface .............................................................................. Functional Overview................................................................................................................ Setting Up the Sales Order API .............................................................................................. Validation of Sales Order API................................................................................................. Move Order Application Program Interface ............................................................................. Functional Overview................................................................................................................ Setting Up the Move Order API ............................................................................................. Validation of Move Order API ............................................................................................... Line_Details_pub...................................................................................................................... Pick Release Application Program Interface............................................................................. Setting Up the Pick Release API ............................................................................................. Validation of Pick Release API ............................................................................................... Pick Confirm Application Program Interface ........................................................................... Functional Overview................................................................................................................ Setting Up the Pick Confirm API ........................................................................................... Validation of Pick Confirm API.............................................................................................. Pick Release Interface .................................................................................................................... Quantity Tree Program Interface ................................................................................................. Procedure Name: UPDATE_QUANTITIES.......................................................................... Procedure Name: DO_CHECK .............................................................................................. Validation of Quantity Tree API ............................................................................................ Transaction Processing Program Interface................................................................................. Setting Up Transaction Processing API.................................................................................

7-101 7-102 7-102 7-103 7-104 7-104 7-104 7-115 7-117 7-117 7-118 7-120 7-120 7-120 7-124 7-125 7-125 7-125 7-139 7-140 7-144 7-144 7-147 7-148 7-148 7-148 7-150 7-151 7-153 7-158 7-163 7-165 7-165 7-165

xiii

Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIsOpen Forecast Interface ..................................................................................................................... Functional Overview.................................................................................................................... Setting Up the Open Forecast Interface..................................................................................... Inserting into the Open Forecast Interface Table ..................................................................... Validation....................................................................................................................................... Resolving Failed Open Forecast Interface Rows ...................................................................... Viewing Failed Transactions....................................................................................................... Fixing Failed Transactions Options ........................................................................................... Open Master Schedule Interface ..................................................................................................... Functional Overview.................................................................................................................... Setting Up the Open Master Schedule Interface ...................................................................... Inserting into the Open Master Schedule Interface Table ...................................................... Validation..................................................................................................................................... Standard Validation ................................................................................................................... Other Validation ......................................................................................................................... Resolving Failed Open Master Schedule Interface Rows ..................................................... Viewing Failed Transactions..................................................................................................... Fixing Failed Transactions Options ......................................................................................... Open Forecast Entries Application Program Interface .............................................................. Functional Overview.................................................................................................................. Setting Up the Open Forecast Entries API .............................................................................. Inserting into the Open Forecast Entries API Tables............................................................. Open Forecast Interface Designator Table Description ........................................................ Validation..................................................................................................................................... Using the Open Forecast Entries API............................................................................................ Creating New Forecast Entries ................................................................................................. Replacing Forecast Entries......................................................................................................... Deleting All Forecast Entries in Multiple Forecast Designators .......................................... Error Handling ............................................................................................................................ Sourcing Rule Application Program Interface............................................................................ Sourcing Rule/Bill of Distribution API Features ................................................................... Functional Overview.................................................................................................................. Setting Up the Sourcing Rule/Bill of Distribution API......................................................... 8-2 8-2 8-2 8-2 8-5 8-6 8-7 8-7 8-8 8-8 8-8 8-8 8-11 8-11 8-11 8-12 8-13 8-13 8-14 8-14 8-14 8-14 8-16 8-18 8-19 8-19 8-19 8-20 8-20 8-21 8-21 8-22 8-23

xiv

Record Parameter Descriptions ................................................................................................ Validation of Sourcing Rule /Bill of Distribution API.......................................................... Sourcing Rule Assignment API Features ................................................................................ Functional Overview.................................................................................................................. Setting Up the Sourcing Rule Assignment API...................................................................... Record Parameter Descriptions ................................................................................................ Validation of Sourcing Rule Assignment API.......................................................................

8-27 8-40 8-43 8-44 8-44 8-48 8-56

Oracle Shop Floor Management Open InterfacesImport Lot Jobs Concurrent Program ............................................................................................. 9-2 Import Lot Jobs Concurrent Program Features........................................................................ 9-4 Functional Overview................................................................................................................... 9-5 Calling the Import Lot Based Jobs Concurrent Program........................................................ 9-6 Validation of Import Lot Based Jobs.......................................................................................... 9-6 WSM_LOT_JOB_ INTERFACE Table........................................................................................ 9-7 WSM_LOT_JOB_ DTL_INTERFACE Table............................................................................ 9-14 Validation For WSM_LOT_JOB_DTL_INTERFACE............................................................. 9-22 Mode-2 Job Creation through Interface................................................................................... 9-34 Lot Move Transactions Concurrent Program............................................................................... 9-36 Lot Move Transactions Concurrent Program Features......................................................... 9-37 Functional Overview.................................................................................................................. 9-37 Validation of Import Lot Based Move Transactions ............................................................. 9-39 Setting Up the Move Transaction Interface ............................................................................ 9-40 Inserting Records into the WSM_LOT_MOVE_TXN_INTERFACE Table ........................ 9-42 Import WIP Lot Transactions Concurrent Program.................................................................... 9-55 Functional Overview.................................................................................................................. 9-57 Setting Up the Import WIP Lot Transactions Concurrent Program ................................... 9-58 Validation of Import WIP Lot Transactions Program........................................................... 9-61 Important Columns in WSM_SPLIT_MERGE_TXN_INTERFACE, WSM_STARTING_JOBS_ INTERFACE, and WSM_RESULTING_JOBS_INTERFACE Tables 9-63 Inserting Records into the WSM_SPLIT_MERGE_TXN_INTERFACE, WSM_STARTING_ JOBS_INTERFACE, and WSM_RESULTING_JOBS_INTERFACE Tables 9-65 Upgrade to Patchset I............................................................................................................... 9-108 Inventory Lot Transactions Interface Concurrent Program .................................................... 9-112 Calling the Import Inventory Lot Transactions Interface Program .................................. 9-114

xv

WSM_LOT_SPLIT_MERGES_ INTERFACE Table............................................................. WSM_STARTING_LOTS_INTERFACE Table ..................................................................... WSM_RESULTING_LOTS_INTERFACE Table................................................................... Validation of Inventory Lot Transactions ............................................................................. Functional Overview................................................................................................................ Lot Attributes................................................................................................................................... Processing Lot Attributes ........................................................................................................

9-115 9-117 9-119 9-121 9-122 9-123 9-123

Oracle Purchasing Open InterfacesRequisitions Open Interface........................................................................................................... Functional Overview.................................................................................................................. See Also ........................................................................................................................................ Setting Up the Requisitions Interface ...................................................................................... See Also ........................................................................................................................................ Inserting into the Requisitions Interface Tables ..................................................................... Requisitions Interface Table Description ................................................................................ Requisition Distributions Interface Table Description........................................................ Required Data............................................................................................................................ Derived Data.............................................................................................................................. Optional Data ............................................................................................................................ Validation................................................................................................................................... Standard Validation ................................................................................................................. Other Validation ....................................................................................................................... Resolving Failed Requisitions Interface Rows ..................................................................... Error Messages .......................................................................................................................... Viewing Failed Transactions................................................................................................... Rescheduling Requisitions ...................................................................................................... Reschedule Interface Table...................................................................................................... Understanding the PO_RESCHEDULE_INTERFACE Table ............................................ Columns Reserved for Requisition Import ........................................................................... Purchasing Documents Open Interface...................................................................................... Functional Overview................................................................................................................ Record and Error Processing................................................................................................... Original, Replace, and Update Submissions......................................................................... Original....................................................................................................................................... 10-2 10-2 10-5 10-5 10-5 10-5 10-6 10-17 10-22 10-24 10-27 10-27 10-27 10-27 10-28 10-28 10-28 10-29 10-29 10-29 10-30 10-31 10-32 10-34 10-35 10-35

xvi

Replace ....................................................................................................................................... Update Blankets and Quotes .................................................................................................. Update Flow .............................................................................................................................. Update Standard Purchase Order .......................................................................................... Sourcing ..................................................................................................................................... Price Breaks ............................................................................................................................... For Original or Replace Submissions..................................................................................... For the Update Submission..................................................................................................... Adding or Deleting Lines in an Update Submission .......................................................... Revision Numbering and Archiving ..................................................................................... See Also ...................................................................................................................................... Setting Up the Purchasing Documents Open Interface ...................................................... Purchasing Setup ...................................................................................................................... Importing the Documents ....................................................................................................... Purging the Open Interface Tables after Importing the Data ............................................ See Also ...................................................................................................................................... Monitoring Price Increases...................................................................................................... Importing Account Information............................................................................................. Purchasing Documents Open Interface Table Descriptions .................................................. See Also ...................................................................................................................................... Purchasing Documents Headers Table Description............................................................ Purchasing Documents Lines Table Description ................................................................. Purchasing Documents Distributions Table Description ................................................... Purchasing Documents Price Differential Table Description ............................................ Derivation......................................................................................................................................... Defaulting ........................................................................................................................................ Validation ......................................................................................................................................... Standard Validation ................................................................................................................. Other Validation ....................................................................................................................... Resolving Failed Purchasing Interface Rows............................................................................ Error Messages.......................................................................................................................... A Note about Debugging ........................................................................................................ Viewing Failed Transactions................................................................................................... Fixing Failed Transactions ...................................................................................................... See Also ......................................................................................................................................

10-36 10-36 10-38 10-40 10-40 10-41 10-41 10-42 10-43 10-43 10-44 10-45 10-45 10-47 10-49 10-49 10-50 10-52 10-53 10-54 10-54 10-61 10-71 10-78 10-80 10-81 10-82 10-82 10-82 10-83 10-83 10-83 10-83 10-95 10-96

xvii

Receiving Open Interface.............................................................................................................. 10-97 Functional Overview................................................................................................................ 10-99 EDI Transaction Types ............................................................................................................. 10-99 Validation and Overview ...................................................................................................... 10-100 Pre-processor Header-Level Validation .............................................................................. 10-100 Pre-processor Line-Level Validation ................................................................................... 10-101 Errors ........................................................................................................................................ 10-101 Receiving Transaction Processor Activities ........................................................................ 10-101 Quantity Updates.................................................................................................................... 10-102 Cascading Transaction Quantities........................................................................................ 10-102 Setting Up the Receiving Open Interface ............................................................................ 10-103 Inserting into the Receiving Open Interface Table ............................................................ 10-104 Receiving Headers Interface Table Description ................................................................. 10-105 Receiving Transactions Interface Table Description ......................................................... 10-110 Required Data for RCV_HEADERS_INTERFACE ............................................................ 10-121 Conditionally Required Data for RCV_HEADERS_INTERFACE................................... 10-122 Required Data for RCV_TRANSACTIONS_INTERFACE ............................................... 10-124 Conditionally Required Data for RCV_TRANSACTIONS_INTERFACE...................... 10-126 Derived Data............................................................................................................................ 10-130 Optional Data .......................................................................................................................... 10-131 Validation................................................................................................................................. 10-131 Standard Validation ............................................................................................................... 10-131 Other Validation ..................................................................................................................... 10-132 Debugging ............................................................................................................................... 10-132 See Also .................................................................................................................................... 10-133 Resolving Failed Receiving Open Interface Rows................................................................. 10-133 Error Messages ........................................................................................................................ 10-133 Viewing Failed Transactions................................................................................................. 10-133 See Also .................................................................................................................................... 10-134 Purchase Order Change APIs ..................................................................................................... 10-135 Functional Overview.............................................................................................................. 10-135 Setting Up the Record Acceptance/Rejection API............................................................. 10-135 Validation of Purchase Order Change APIs ....................................................................... 10-139 Record Acceptance Validation.............................................................................................. 10-139 Update Purchase Order (PO) Validation ............................................................................ 10-139

xviii

Error Handling........................................................................................................................ Usage Example........................................................................................................................ See Also .................................................................................................................................... Cancel PO API ............................................................................................................................... Functional Overview.............................................................................................................. Setting Context........................................................................................................................ Retrieve Messages .................................................................................................................. API Parameters: ...................................................................................................................... Usage Example:....................................................................................................................... See Also .................................................................................................................................... Custom Pricing API...................................................................................................................... Functional Overview.............................................................................................................. Custom Pricing Date API ...................................................................................................... Custom Pricing Date API Parameters: ................................................................................ Usage Example:....................................................................................................................... Custom Requisition Pricing API ............................................................................................... Custom Requisition Pricing API Parameters: .................................................................... Usage Example:....................................................................................................................... Custom PO/Release Pricing API................................................................................................ Custom PO/Release Pricing API Parameters: ................................................................... Usage Example:.......................................................................................................................

10-141 10-141 10-142 10-143 10-143 10-143 10-143 10-144 10-147 10-148 10-149 10-149 10-149 10-150 10-151 10-151 10-152 10-152 10-153 10-154 10-154

Oracle Quality Open Interfaces and APIsCollection Import Interface............................................................................................................. Functional Overview.................................................................................................................. Collection Import Interface Table ............................................................................................ Derived Data ............................................................................................................................... Optional Data ............................................................................................................................ Collection Import Results Database Views........................................................................... Example: Collection Import SQL Script ................................................................................ Collection Import Manager..................................................................................................... Collection Plan Views.................................................................................................................... Example...................................................................................................................................... Overview of the Oracle Quality Application Program Interfaces ........................................ Specification APIs ..................................................................................................................... 11-2 11-2 11-3 11-7 11-10 11-10 11-11 11-14 11-16 11-16 11-18 11-18

xix

Collection Plan APIs................................................................................................................. Create Specification Application Program Interface ............................................................... Setting Up the Create Specification API................................................................................ Validation of Create Specification API .................................................................................. Add Specification Element Application Program Interface................................................... Setting Up the Add Specification Element API.................................................................... Validation of Add Specification Element API ...................................................................... Complete Specification Application Program Interface ......................................................... Setting Up the Complete Specification API .......................................................................... Validation of Complete Specification API ............................................................................ Delete Specification Application Program Interface ............................................................... Setting Up the Delete Specification API ................................................................................ Validation of Delete Specification API .................................................................................. Delete Specification Element Application Program Interface............................................... Setting Up the Delete Specification Element API ................................................................ Validation of Delete Specification Element API................................................................... Copy Specification Application Program Interface ................................................................. Setting Up the Copy Specification API.................................................................................. Validation of Copy Specification API .................................................................................... Using the Specification APIs ........................................................................................................ Specification APIs Example..................................................................................................... Create Collection Plan Application Program Interface ........................................................... Setting Up the Create Collection Plan API............................................................................ Validation of Create Collection Plan API.............................................................................. Add Collection Plan Element Application Program Interface............................................... Setting Up the Add Collection Plan Element API ............................................................... Validation of Add Collection Plan Element API.................................................................. Complete Collection Plan Processing Application Program Interface................................. Setting Up the Complete Collection Plan Processing API.................................................. Validation of Complete Collection Plan Processing API .................................................... Delete Collection Plan Application Program Interface........................................................... Setting Up the Delete Collection Plan API............................................................................ Validation of Delete Collection Plan API .............................................................................. Delete Collection Plan Element Application Program Interface........................................... Setting Up the Delete Collection Plan Element API ............................................................

11-20 11-22 11-23 11-27 11-28 11-28 11-32 11-32 11-33 11-35 11-35 11-36 11-38 11-38 11-39 11-41 11-41 11-42 11-44 11-45 11-46 11-49 11-50 11-53 11-53 11-54 11-58 11-58 11-59 11-61 11-61 11-62 11-64 11-64 11-65

xx

Validation of Delete Collection Plan Element API .............................................................. Copy Collection Plan Application Program Interface............................................................. Setting Up the Copy Collection Plan API ............................................................................. Validation of Copy Collection Plan API ............................................................................... Using the Collection Plan APIs.................................................................................................... Collection Plan APIs Example ................................................................................................

11-67 11-68 11-68 11-71 11-72 11-72

Oracle Work in Process Open InterfacesOpen Move Transaction Interface ................................................................................................. Functional Overview.................................................................................................................. Setting Up the Move Transaction Interface ............................................................................ Launching the Move Transaction Manager............................................................................ Inserting Records into the WIP_MOVE_TXN_INTERFACE Table .................................... Validating Move Transactions................................................................................................ Resolving Failed Rows............................................................................................................. Open Resource Transaction Interface ......................................................................................... Functional Overview................................................................................................................ Setting Up the Resource Transaction Interface .................................................................... Launching the Cost Manager.................................................................................................. Inserting Records into the WIP_COST_TXN_INTERFACE Table .................................... Validating Resource Transactions.......................................................................................... Resolving Failed Rows............................................................................................................. Work Order Interface ..................................................................................................................... Functional Overview................................................................................................................ Setting Up the Work Order Interface..................................................................................... Inserting Records Into the Work Order Interface ................................................................ WIP_JOB_SCHEDULE_INTERFACE Table ......................................................................... WIP_JOB_DTLS_INTERFACE Table..................................................................................... Primary and Alternate Resources .......................................................................................... Validating Work Order Interface Records ............................................................................ Resolving Failed Rows............................................................................................................. 12-2 12-2 12-4 12-5 12-5 12-15 12-16 12-17 12-17 12-18 12-18 12-18 12-24 12-24 12-25 12-27 12-29 12-30 12-31 12-47 12-55 12-56 12-57

Oracle Warehouse Management Open Interfaces and APIsCompliance Label Application Program Interface..................................................................... 13-2 Functional Overview.................................................................................................................. 13-2

xxi

Detailed Discussion of Parameters Required for Each Label Type..................................... Device Integration Application Program Interface.................................................................... WMS Device Integration PVT Application Program Interface............................................ WMS Device Integration Application Program Interface................................................... Locator Maintenance Application Program Interface.............................................................. Create Locator Application Program Interface .................................................................... Update Locator Application Program Interface................................................................... Create Locator Item Tie Application Program Interface..................................................... Delete Locator Application Program Interface .................................................................... Container Application Program Interface.................................................................................. Generate LPN Concurrent Program Application Program Interface ............................... Create LPN Application Program Interface.......................................................................... WMS Installation Application Program Interface ................................................................... Check Install Application Program Interface ....................................................................... RFID related APIs ........................................................................................................................... WMS_RFID_DEVICE_PUB.wms_read_event...................................................................... WMS_SHIPPING_TRANSACTION_PUB.close_truck .......................................................

13-5 13-7 13-7 13-10 13-12 13-13 13-17 13-21 13-22 13-25 13-25 13-28 13-31 13-31 13-32 13-33 13-35

Oracle Flow Manufacturing Open Interfaces and APIsCustom Kanban Quantity Calculation API ................................................................................. Functional Overview.................................................................................................................. Custom Schedule API ...................................................................................................................... Functional Overview.................................................................................................................. Flow Schedule API ........................................................................................................................... Functional Overview.................................................................................................................. Flow Sequencing Customization and Extension API .............................................................. Functional Overview................................................................................................................ Flow Execution Workstation Customization and Extension API .......................................... Functional Overview................................................................................................................ 14-2 14-2 14-3 14-3 14-7 14-7 14-16 14-16 14-19 14-19

Oracle Complex Maintenance Repair and Overhaul Open InterfacesComplex Maintenance Repair and Overhaul API Overview................................................... IN Parameters.............................................................................................................................. OUT Parameters.......................................................................................................................... Commit and Rollback................................................................................................................. 15-2 15-2 15-2 15-3

xxii

Document Index ......................................................................................................................... Master Configuration................................................................................................................. Outside Processing ..................................................................................................................... Product Classification ................................................................................................................ Unit Configuration ..................................................................................................................... Unit Maintenance Plan ............................................................................................................

15-3 15-5 15-7 15-8 15-8 15-13

Index

xxiii

xxiv

Send Us Your CommentsOracle iReceivables Implementation Guide, Release 11iPart No. A97625-03

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

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

If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways:

Electronic mail: appsdoc_us@oracle.com FAX: (650) 506-7200 Attn: Oracle Applications Documentation Manager Postal service: Oracle Corporation Oracle Applications Documentation Manager 500 Oracle Parkway Redwood Shores, CA 94065 USA

If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services.

xxv

xxvi

PrefaceWelcome to the Oracle iReceivables Implementation Guide, Release 11i. This guide assumes you have a working knowledge of the following:

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

Oracle Self-Service Web Applications. To learn more about Oracle Self-Service Web Applications, read the Oracle Self-Service Web Applications Implementation Manual.

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.

xxvii

How To Use This GuideThe Oracle iReceivables Implementation Guide contains the information you need to understand and use Oracle iReceivables. This guide contains four chapters:

Chapter 1 provides an overview of Manufacturing integration tools, and describes how to use these tools to integrate Oracle Manufacturing products with one another and with non-Oracle systems. Chapter 2 provides information about Oracle ASCP and Oracle Global ATP Server. Chapter 3 provides information about Oracle Bills of Material open interfaces. Chapter 4 provides information about Oracle Cost Management open interfaces. Chapter 5 provides information about Oracle Enterprise Asset Management open interfaces. Chapter 6 provides information about Oracle Engineering open interfaces. Chapter 7 provides information about Oracle Inventory open interfaces. Chapter 8 provides information about Oracle Master Scheduling/MRP and Oracle Supply Chain Planning open interfaces. Chapter 9 provides information about Oracle Shop Floor Management open interfaces. Chapter 10 provides information about Oracle Purchasing or Oracle Public Sector Purchasing open interfaces. Chapter 11 provides information about Oracle Quality open interfaces. Chapter 12 provides information about Oracle Work in Process open interfaces. Chapter 13 provides information about Oracle Warehouse Management Systems open interfaces and APIs. Chapter 14 provides information about Oracle Flow Manufacturing open interfaces and APIs. Chapter 15 provides information about Oracle Complex Maintenance Repair and Overhaul open interfaces.

xxviii

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

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

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

xxix

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

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

PDF Documentation- See the Online Documentation CD for current PDF documentation for your product with each release. This Documentation CD is also available on OracleMetaLink and is updated frequently. Online Help - You can refer to Oracle Applications Help for current HTML online help for your product. Oracle provides patchable online help, which you can apply to your system for updated implementation and end user documentation. No system downtime is required to apply online help. Release Content Document - See the Release Content Document for descriptions of new features available by release. The Release Content Document is available on OracleMetaLink. About document - Refer to the About document for information about your release, including feature updates, installation information, and new documentation or documentation patches that you can download. The About document is available on OracleMetaLink.

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

xxx

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