Oracle Manufacturing

APIs and Open Interfaces Manual
Release 11i Part No. A95955-03

January 2004

Oracle Manufacturing APIs and Open Interfaces Manual, Release 11i Part No. A95955-03 Copyright © 2002, 2004, Oracle. All rights reserved. Primary Authors: David Reitan, Joe Dam

Contributors: Jill Arehart, John Brazier, Tyra Crockett, Rachel Haas, Elizabeth Looney, Tom Myers, April Nelson, 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 Oracle Corporation disclaims 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.

Contents

Send Us Your Comments ................................................................................................................ xvii Preface.......................................................................................................................................................... xix
How To Use This Guide ...................................................................................................................... xx Documentation Accessibility ............................................................................................................. xxi Other Information Sources ................................................................................................................ xxii Installation and System Administration ......................................................................................... xxv Other Implementation Documentation................................................................................... xxvii Training and Support......................................................................................................................... xxx Do Not Use Database Tools to Modify Oracle Applications Data .............................................. xxx About Oracle....................................................................................................................................... xxxi Your Feedback................................................................................................................................... xxxii

1

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

2 Oracle ASCP and Oracle Global ATP Server Open Interfaces
ODS Load API Features..................................................................................................................... 2-2

iii

Functional Overview .......................................................................................................................... 2-7 Setting Up the ODS Load API.......................................................................................................... 2-7 Parameter Descriptions................................................................................................................ 2-8

3

Bills of Material Business Object Interface
Bill of Materials API Overview....................................................................................................... 3-2 Bills of Material Entity Diagram...................................................................................................... 3-3 Bill of Material Import Description ................................................................................................ 3-6 Bill of Material Parameter Descriptions....................................................................................... 3-11 Bills of Material Exposed Columns .......................................................................................... 3-11 Bills of Material Components Exposed Columns .................................................................. 3-13 Item Revision Exposed Columns ............................................................................................. 3-21 Substitute Component Exposed Columns .............................................................................. 3-23 Launching the Import ................................................................................................................ 3-26 Bill of Material Package Interaction.............................................................................................. 3-33 Bill of Material Import Error Handling and Messaging ........................................................... 3-35 Error Handling Concepts .......................................................................................................... 3-35 Bill of Material Export API ............................................................................................................. 3-45 Launching the Export................................................................................................................. 3-45 INPUT Parameters...................................................................................................................... 3-45 OUTPUT Parameters.................................................................................................................. 3-46 Export Error Handling and Messaging ................................................................................... 3-46 Routing API Overview .................................................................................................................... 3-50 Routing Entity Diagram............................................................................................................. 3-50 Routing Import Description ........................................................................................................... 3-55 Routing Parameter Descriptions.................................................................................................... 3-60 Routing Revision Exposed Columns ....................................................................................... 3-64 Operation Sequence Exposed Columns .................................................................................. 3-67 Operation Resources Exposed Columns ................................................................................. 3-73 Substitute Operation Resources Exposed Columns .............................................................. 3-80 Operation Networks Exposed Columns ................................................................................. 3-85 Launching the Routing Import....................................................................................................... 3-89 Routing Package Interaction........................................................................................................... 3-94 Routing Import Error Handling and Messaging ........................................................................ 3-96 API Messaging .......................................................................................................................... 3-101

iv

Error Handler ............................................................................................................................ 3-103

4

Oracle Cost Management Open Interfaces
Periodic 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 ................................................................................................................. 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-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 4-19 4-19 4-20 4-21 4-22 4-23 4-24 4-25 4-27 4-29 4-31

5

eAM Open Interfaces and APIs
eAM Interfaces and APIs .................................................................................................................. 5-1

v

eAM Item Open Interface ............................................................................................................ eAM Asset Number Open Interface .......................................................................................... eAM Asset Genealogy Open Interface .................................................................................... eAM Meter Reading Open Interface ........................................................................................ Meter Reading API ........................................................................................................................... Preventive Maintenance Definition API...................................................................................... Activity Creation API ....................................................................................................................... Maintenance Object Instantiation API......................................................................................... Work Order Business API ...............................................................................................................

5-2 5-9 5-12 5-15 5-18 5-21 5-27 5-40 5-41

6

Engineering Change Order Business Object Interface
Features ................................................................................................................................................. ECO Business Object .................................................................................................................... Business Object APIs ......................................................................................................................... Process Flow .................................................................................................................................. Entity Process Flows ......................................................................................................................... ECO Headers ............................................................................................................................... ECO Revisions............................................................................................................................. Revised Items .............................................................................................................................. Revised Components.................................................................................................................. Reference Designators................................................................................................................ Substitute Components.............................................................................................................. New API Packages...................................................................................................................... Launching the Import ................................................................................................................ Package Interaction .................................................................................................................... Sample Launch Package ............................................................................................................ Import Error Handling and Messaging................................................................................... Error Handling Concepts .......................................................................................................... API Messaging ............................................................................................................................ Error Handler .............................................................................................................................. 6-2 6-3 6-7 6-8 6-13 6-14 6-16 6-17 6-19 6-22 6-24 6-25 6-28 6-33 6-36 6-46 6-47 6-55 6-57

7

Oracle Inventory Open Interfaces and APIs
Open Transaction Interface ............................................................................................................... 7-2 Setting Up the Transaction Interface.......................................................................................... 7-5 Inserting into the Transaction Interface Tables ........................................................................ 7-6

vi

MTL_TRANSACTION_LOTS_INTERFACE.......................................................................... MTL_SERIAL_NUMBERS_INTERFACE................................................................................ CST_COMP_SNAP_INTERFACE.......................................................................................... Validation .................................................................................................................................... Resolving Failed Transaction Interface Rows ........................................................................ Open Replenishment Interface...................................................................................................... Functional Overview.................................................................................................................. Setting Up the Replenishment Interface.................................................................................. Inserting into the Replenishment Interface Tables ................................................................ Replenishment Headers Interface Tables................................................................................ Validation .................................................................................................................................... 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....................................................................................

7-22 7-23 7-25 7-26 7-27 7-28 7-28 7-29 7-29 7-29 7-35 7-36 7-37 7-38 7-38 7-39 7-41 7-43 7-52 7-53 7-57 7-58 7-59 7-60 7-61 7-61 7-63 7-68 7-68 7-68 7-69 7-69 7-71 7-73 7-75

vii

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 ....................................................................................................... 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 ............................................................................................... Pick Release Application Program Interface ............................................................................. Setting Up the Pick Release API ............................................................................................. Validation of Pick Release API ............................................................................................... Pick Confirm Application Program Interface ........................................................................... Functional Overview................................................................................................................

7-79 7-83 7-83 7-83 7-86 7-87 7-89 7-89 7-91 7-92 7-92 7-94 7-95 7-95 7-96 7-97 7-97 7-97 7-108 7-110 7-110 7-111 7-113 7-113 7-113 7-117 7-118 7-118 7-118 7-133 7-134 7-134 7-137 7-138 7-138

viii

Setting Up the Pick Confirm API ........................................................................................... Validation of Pick Confirm API.............................................................................................. Quantity Tree Program Interface ................................................................................................. Validation of Quantity Tree API ............................................................................................ Transaction Processing Program Interface................................................................................. Setting Up Transaction Processing API.................................................................................

7-138 7-141 7-142 7-153 7-154 7-154

8 Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs
Open Forecast Interface ..................................................................................................................... Functional Overview.................................................................................................................... Setting Up the Open Forecast Interface..................................................................................... Inserting into the Open Forecast Interface Table ..................................................................... Validation ...................................................................................................................................... Resolving Failed Open Forecast Interface Rows .......................................................................... Open Master Schedule Interface ..................................................................................................... Functional Overview.................................................................................................................... Setting Up the Open Master Schedule Interface ...................................................................... Inserting into the Open Master Schedule Interface Table ...................................................... Validation .................................................................................................................................... Resolving Failed Open Master Schedule Interface Rows ..................................................... 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 ...................................................................................... Sourcing Rule Application Program Interface............................................................................ Sourcing Rule/Bill of Distribution API Features................................................................... Functional Overview.................................................................................................................. Setting Up the Sourcing Rule/Bill of Distribution API ........................................................ Validation of Sourcing Rule /Bill of Distribution API.......................................................... Sourcing Rule Assignment API Features ................................................................................ Functional Overview.................................................................................................................. 8-2 8-2 8-2 8-2 8-5 8-7 8-8 8-8 8-8 8-8 8-11 8-12 8-14 8-14 8-14 8-14 8-16 8-18 8-19 8-21 8-21 8-22 8-23 8-40 8-43 8-44

ix

Setting Up the Sourcing Rule Assignment API...................................................................... 8-44 Validation of Sourcing Rule Assignment API ....................................................................... 8-56

9

Oracle Shop Floor Management Open Interfaces
Import 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-8 Mode-2 Job Creation through Interface................................................................................... 9-15 Lot Move Transactions Concurrent Program ............................................................................... 9-17 Lot Move Transactions Concurrent Program Features ......................................................... 9-18 Functional Overview.................................................................................................................. 9-18 Validation of Import Lot Based Move Transactions.............................................................. 9-20 Setting Up the Move Transaction Interface ............................................................................ 9-23 Inserting Records into the WSM_LOT_MOVE_TXN_INTERFACE Table ........................ 9-24 Import WIP Lot Transactions Concurrent Program.................................................................... 9-37 Functional Overview.................................................................................................................. 9-39 Setting Up the Import WIP Lot Transactions Concurrent Program.................................... 9-40 Validation of Import WIP Lot Transactions Program ........................................................... 9-41 Important Columns in WSM_SPLIT_MERGE_TXN_INTERFACE, WSM_STARTING_JOBS_ INTERFACE, and WSM_RESULTING_JOBS_INTERFACE Tables 9-43 Inserting Records into the WSM_SPLIT_MERGE_TXN_INTERFACE, WSM_STARTING_ JOBS_INTERFACE, and WSM_RESULTING_JOBS_INTERFACE Tables 9-45 Upgrade to Patchset I ................................................................................................................. 9-87 Inventory Lot Transactions Interface Concurrent Program ...................................................... 9-91 Calling the Import Inventory Lot Transactions Interface Program..................................... 9-93 WSM_LOT_SPLIT_MERGES_ INTERFACE Table............................................................... 9-94 WSM_STARTING_LOTS_INTERFACE Table ....................................................................... 9-96 WSM_RESULTING_LOTS_INTERFACE Table..................................................................... 9-98 Validation of Inventory Lot Transactions ............................................................................. 9-100 Functional Overview................................................................................................................ 9-101

x

10

Oracle Purchasing Open Interfaces
Requisitions Open Interface........................................................................................................... Functional Overview.................................................................................................................. Setting Up the Requisitions Interface ...................................................................................... Inserting into the Requisitions Interface Tables..................................................................... Validation .................................................................................................................................. Resolving Failed Requisitions Interface Rows ..................................................................... Rescheduling Requisitions ...................................................................................................... Purchasing Documents Open Interface...................................................................................... Functional Overview................................................................................................................ Record and Error Processing .................................................................................................. Original, Replace, and Update Submissions ........................................................................ Sourcing ..................................................................................................................................... Price Breaks ............................................................................................................................... Adding or Deleting Lines in an Update Submission .......................................................... Revision Numbering and Archiving ..................................................................................... Setting Up the Purchasing Documents Open Interface ...................................................... Monitoring Price Increases...................................................................................................... Importing Account Information............................................................................................. Purchasing Documents Open Interface Table Descriptions .................................................. Purchasing Documents Headers Table Description............................................................ Purchasing Documents Lines Table Description ................................................................. Purchasing Documents Distributions Table Description ................................................... Derivation......................................................................................................................................... Defaulting ........................................................................................................................................ Validation ......................................................................................................................................... Resolving Failed Purchasing Interface Rows............................................................................ Receiving Open Interface.............................................................................................................. Functional Overview................................................................................................................ EDI Transaction Types............................................................................................................. Validation and Overview ........................................................................................................ Quantity Updates ..................................................................................................................... Cascading Transaction Quantities ......................................................................................... Setting Up the Receiving Open Interface .............................................................................. Inserting into the Receiving Open Interface Table .............................................................. 10-2 10-2 10-5 10-5 10-27 10-28 10-29 10-31 10-32 10-34 10-35 10-40 10-41 10-42 10-43 10-44 10-49 10-51 10-52 10-53 10-59 10-70 10-77 10-78 10-79 10-80 10-87 10-88 10-88 10-89 10-91 10-91 10-92 10-93

xi

Receiving Headers Interface Table Description ................................................................... 10-94 Receiving Transactions Interface Table Description ........................................................... 10-99 Required Data for RCV_HEADERS_INTERFACE ............................................................ 10-109 Conditionally Required Data for RCV_HEADERS_INTERFACE................................... 10-110 Required Data for RCV_TRANSACTIONS_INTERFACE ............................................... 10-112 Conditionally Required Data for RCV_TRANSACTIONS_INTERFACE...................... 10-116 Derived Data............................................................................................................................ 10-118 Optional Data .......................................................................................................................... 10-119 Validation................................................................................................................................. 10-119 Standard Validation ............................................................................................................... 10-119 Other Validation ..................................................................................................................... 10-120 Debugging ............................................................................................................................... 10-120 Resolving Failed Receiving Open Interface Rows ............................................................. 10-121 Purchase Order Change APIs ..................................................................................................... 10-123 Functional Overview.............................................................................................................. 10-123 Setting Up the Record Acceptance/Rejection API............................................................. 10-123 Validation of Purchase Order Change APIs ....................................................................... 10-127 Cancel PO API ............................................................................................................................... 10-131

11

Oracle Quality Open Interfaces
Collection 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...................................................................................................................................... 11-2 11-2 11-3 11-7 11-10 11-11 11-11 11-14 11-16 11-16

12

Oracle Work in Process Open Interfaces
Open Move Transaction Interface ................................................................................................. 12-2 Functional Overview.................................................................................................................. 12-2 Setting Up the Move Transaction Interface ............................................................................ 12-4

xii

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..................................................................................... Validating Work Order Interface Records ............................................................................ Resolving Failed Rows.............................................................................................................

12-5 12-5 12-15 12-16 12-17 12-17 12-18 12-18 12-18 12-24 12-25 12-25 12-28 12-29 12-30 12-31 12-47 12-56 12-57

13

Oracle Warehouse Management Open Interfaces and APIs
Compliance Label Application Program Interface..................................................................... Functional Overview.................................................................................................................. Print Label Application Program Interface............................................................................. Print Label Application Program Interface............................................................................. 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.................................................................................. 13-2 13-2 13-5 13-7 13-8 13-10 13-10 13-13 13-15 13-16 13-20 13-23 13-25 13-27

xiii

Generate LPN Concurrent Program Application Program Interface ............................... Generate LPN Application Program Interface ..................................................................... Associate LPN Application Program Interface .................................................................... Create LPN Application Program Interface.......................................................................... Modify LPN and Modify LPN Wrapper Application Program Interface ........................ PackUnpack Container Application Program Interface ..................................................... Validate Update Weight Volume Application Program Interface .................................... Purge LPN Application Program Interface........................................................................... Explode LPN Application Program Interface ...................................................................... Transfer LPN Contents Application Program Interface ..................................................... Container Required Quantity Application Program Interface .......................................... Get Outermost LPN Application Program Interface........................................................... Get LPN List Application Program Interface ....................................................................... Prepack LPN Concurrent Program Application Program Interface ................................. Prepack LPN Application Program Interface....................................................................... Print Content Report Application Program Interface ......................................................... LPN Pack Complete Application Program Interface .......................................................... WMS Installation Application Program Interface ................................................................... Check Install Application Program Interface .......................................................................

13-27 13-29 13-33 13-36 13-39 13-43 13-49 13-52 13-53 13-55 13-56 13-58 13-60 13-62 13-66 13-69 13-69 13-70 13-70

14

Oracle Flow Manufacturing Open Interfaces and APIs
Custom Kanban Quantity Calculation API ................................................................................. Functional Overview.................................................................................................................. Custom Schedule API ...................................................................................................................... Functional Overview.................................................................................................................. Flow Schedule API ........................................................................................................................... Functional Overview.................................................................................................................. 14-2 14-2 14-3 14-3 14-7 14-7

15

Oracle Complex Maintenance, Repair, and Overhaul Open Interfaces
Complex Maintenance, Repair, and Overhaul API Overview ................................................. IN Parameters.............................................................................................................................. OUT Parameters.......................................................................................................................... Document Index.......................................................................................................................... ....................................................................................................................................................... Master Configuration ................................................................................................................. 15-2 15-2 15-2 15-3 15-4 15-5

xiv

Outside Processing ..................................................................................................................... ....................................................................................................................................................... Product Classification ................................................................................................................ Unit Configuration ..................................................................................................................... Unit Maintenance Plan ..............................................................................................................

15-5 15-7 15-7 15-8 15-8

Index

xv

xvi

Send Us Your Comments
Oracle Manufacturing APIs and Open Interfaces Manual, Release 11i,
Part No. A95955-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.
s s s s s

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:
s s s

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.

xvii

xviii

Preface
Welcome to the Oracle Manufacturing APIs and Open Interfaces Manual, Release 11i. This guide assumes you have a working knowledge of the following:
s

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

s

s

The Oracle Applications graphical user interface. To learn more about the Oracle Applications graphical user interface, read the Oracle Applications User’s Guide.

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

xix

How To Use This Guide
The Oracle Manufacturing APIs and Open Interfaces Manual contains the information you need to understand and use Oracle Manufacturing APIs and Open Interfaces. This guide contains fifteen chapters:
s

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

s

s

s

s

s

s

s

s

s

s

s

s

s

s

xx

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

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

xxi

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

Online Documentation
All Oracle Applications documentation is available online (HTML or PDF).
s

PDF Documentation - See the Documentation CD provided with each release for current PDF documentation for your product. This Documentation CD is also available on OracleMetaLink and is updated frequently. Online Help - Oracle Manufacturing APIs and Open Interfaces is part of the suite of Oracle Self-Service applications, which has an intuitive interface designed to guide users without end user documentation. Oracle iReceivables does not have an end user guide, or separate online HTML help. 11i Release Content Document - Refer to the Release Content Document for new features listed release. The Release Content Document is available on OracleMetaLink. About document - Refer to the About document for patches that you have installed to learn about new documentation or documentation patches that you can download. The new About document is available on OracleMetaLink.

s

s

s

Related Guides
Oracle Manufacturing APIs and Open Interfaces 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 Manufacturing APIs and Open Interfaces. 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.

xxii

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

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

Reference Manuals
Oracle Automotive Implementation Manual This manual describes the setup and implementation of the Oracle Applications used for the Oracle Automotive solution. Oracle Applications Message Reference Manual This manual describes all Oracle Applications messages. This manual is available in HTML format on the documentation CD-ROM for Release 11i.

xxiii

Oracle Self-Service Web Applications Implementation Manual This manual describes the setup steps for Oracle Self-Service Web Applications and the Web Applications dictionary.Oracle Project Manufacturing Implementation Manual This manual describes the setup steps and implementation for Oracle Project Manufacturing. xxiv .

profile options and seed data added for each new release. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards. Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency. you can use the Oracle Applications Implementation Wizard to coordinate your setup activities.Installation and System Administration Oracle Alert User’s Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. use this manual before implementing the Oracle Applications product. This manual details additional steps and setup considerations for implementation. Oracle Manufacturing. as well as for users responsible for the ongoing maintenance of Oracle Applications product data. refer to the product update notes appropriate to your update and product(s) to see summaries of new features as well as changes to database objects. or Oracle Human Resources in your specific hardware and operating system software environment. This manual also provides information on creating custom reports on flexfields data. this guide describes all you need to know about setting up and using the product with this feature. Oracle Applications Implementation Wizard User’s Guide If you are implementing more than one Oracle product. Oracle Applications Flexfields Guide This guide provides flexfields planning. setup and reference information for the implementation team. Oracle Applications Product Update Notes If you are upgrading your Oracle Applications. Oracle Applications Installation Manual for Windows Clients This guide provides information you need to successfully install Oracle Financials. This guide describes how to use the wizard. Oracle Applications Developer’s Guide This guide contains the coding standards followed by the Oracle Applications development staff. xxv . Oracle Public Sector Financials. Multiple Organizations in Oracle Applications If you use the Oracle Applications Multiple Organization Support feature to use multiple sets of books for one product installation. It also provides information to help you build your custom Developer/2000 forms so that they integrate with Oracle Applications.

or character mode) or Release 11. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your installation. Refer to this manual and the Oracle Applications Installation Manual when you plan to upgrade your products. Maintaining Oracle Applications Use this guide to help you run the various AD utilities. technology stack. It contains how-to steps. AD Administration. This guide describes the upgrade process and lists database and product-specific upgrade tasks. much of the installation process is handled using Oracle Rapid Install.7. and the Oracle8i Server technology stack by automating many of the required steps. Upgrading Oracle Applications Refer to this guide if you are upgrading your Oracle Applications Release 10. such as AutoUpgrade.0 products to Release 11i. You must be either at Release 10.7 (NCA. You cannot upgrade to Release 11i directly from releases prior to 10.7 or Release 11. You should use this guide in conjunction with individual product user’s guides and implementation guides. xxvi . and other information that you need to run the AD utilities. to upgrade to Release 11i. SmartClient. the Oracle8 technology stack. and others. It also contains information on completing the upgrade procedure for each product. architecture.0. languages and character sets. Installing Oracle Applications This guide provides instructions for managing the installation of Oracle Applications products. and terminology for Oracle Applications Release 11i. This guide also provides information on maintaining the Oracle applications file system and database. screenshots. AD Controller. This guide also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS). features. License Manager.Oracle Applications Upgrade Preparation Manual This guide explains how to prepare your Oracle Applications products for an upgrade. Oracle Applications System Administrator’s Guide This manual provides planning and reference information for the System Administrator. Oracle Applications Concepts This guide provides an introduction to the concepts. AD Relink. In Release 11i. AutoPatch. It provides a useful first book to read before an installation of Oracle Applications. which minimizes the time to install Oracle Applications. and Self-Service Web Applications.

and manage concurrent processing. It contains information on how to define security. It includes new features. Oracle Alert User’s Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. profile options. and changes made to database objects. enhancements. This manual details additional steps and setup considerations for implementing Oracle Manufacturing with this feature. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications. It provides a history of the changes to individual Oracle Applications products between Release 11. customize menus and online help. xxvii . Oracle Applications User Interface Standards for Forms-Based Products This guide contains the user interface (UI) standards followed by the Oracle Applications development staff. Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency. and seed data for this interval. Oracle Applications Developer’s Guide This guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards for Forms-Based Products.Oracle Applications System Administrator’s Guide This guide provides planning and reference information for the Oracle Applications System Administrator.0 and Release 11i. Other Implementation Documentation Oracle Applications Product Update Notes Use this guide as a reference for upgrading an installation of Oracle Applications. use this manual before implementing Oracle Manufacturing. It describes the UI for the Oracle Applications products and how to apply this UI to the design of an application built by using Oracle Forms.

You also use this guide to complete the setup steps necessary for any Oracle Applications product that includes workflow-enabled processes. forms. Oracle eTechnical Reference Manuals Each eTechnical Reference Manual (eTRM) contains database diagrams and a detailed description of database tables. so you can define and support different organization structures when running a single installation of Oracle Manufacturing. integrate Oracle Applications data with non-Oracle applications. Oracle Applications Flexfields Guide This guide provides flexfields planning. This manual also provides information on creating custom reports on flexfields data. This documentation includes API’s and open interfaces found in Oracle Manufacturing. This documentation includes API’s and open interfaces found in Oracle Order Management Suite. setup and reference information for the Oracle Manufacturing implementation team. Oracle Order Management Suite APIs and Open Interfaces Manual This manual contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems. Oracle eTRM is available on Metalink Oracle Manufacturing APIs and Open Interfaces Manual This manual contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems.Multiple Organizations in Oracle Applications This guide describes how to set up and use Oracle Manufacturing with Oracle Applications’ Multiple Organization support feature. as well as for users responsible for the ongoing maintenance of Oracle Applications product data. xxviii . and write custom reports for Oracle Applications products. and programs for a specific Oracle Applications product. reports. This information helps you convert data from your existing applications. Oracle Workflow Guide This guide explains how to define new workflow business processes as well as customize existing Oracle Applications-embedded workflow processes.

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

Because Oracle Applications tables are interrelated. database triggers. Oracle provides powerful tools you can use to create. For example. But when you modify Oracle Applications data using anything other than Oracle Applications. you can arrange for our trainers to teach at your facility. and Oracle’s large staff of consultants and support specialists with expertise in your business area. managing an Oracle8i server. store. retrieve. any change you make using Oracle Applications can update many tables at once. you may change a row in one table without making corresponding changes in related tables. terminology.Training and Support Training Oracle offers a complete set of training courses to help you and your staff master Oracle Manufacturing and reach full productivity quickly. But if you use Oracle tools such as SQL*Plus to modify Oracle Applications data. or you can use Oracle Learning Network (OLN). our team of experienced professionals provides the help and information you need to keep Oracle Manufacturing working for you. you risk destroying the integrity of your data and you lose the ability to audit changes to your data. Oracle Data Browser. and maintain information in an Oracle database. You can attend courses offered by Oracle University at any one of our many Education Centers. so you take only those courses appropriate to your job or area of responsibility. Do Not Use Database Tools to Modify Oracle Applications Data Oracle STRONGLY RECOMMENDS that you never use SQL*Plus. Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. you may want to use your organization structure. or any other tool to modify Oracle Applications data unless otherwise instructed. Support From on-site support to central support. and data as examples in a customized training session delivered at your own facility. You have a choice of educational environments. change. and your hardware and software environment. In addition. Account Manager. These courses are organized into functional learning paths. Oracle University’s online education utility. If your xxx . This team includes your Technical Representative.

When you use Oracle Applications to modify your data. in over 145 countries around the world. If you enter information into database tables using database tools. supply chain management. minicomputers. you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Applications.tables get out of synchronization with each other. Oracle is the world’s leading supplier of software for information management. decision support. About Oracle Oracle Corporation develops and markets an integrated line of software products for database management. and applications products. and the world’s second largest software company. manufacturing. allowing organizations to integrate different computers. different networks. different operating systems. Oracle Applications automatically checks that your changes are valid. into a single. an integrated suite of more than 160 software modules for financial management. Oracle Applications also keeps track of who changes information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes. as well as Oracle Applications. you may store invalid information. and office automation. personal computers. education. Oracle products are available for mainframes. network computers and personal digital assistants. xxxi . applications development. and even different database management systems. tools. and support services. Oracle offers its database. project systems. along with related consulting. human resources and customer relationship management. unified computing and information resource.

Your Feedback Thank you for using Oracle Manufacturing APIs and Open Interfaces and this user guide.A.com. Oracle Applications Documentation Manager Oracle Corporation 500 Oracle Parkway Redwood Shores.S. CA 94065 U. In this guide is a reader’s comment form that you can use to explain what you like or dislike about Oracle Manufacturing APIs and Open Interfaces or this user guide. Oracle values your comments and feedback. Or. Mail your comments to the following address or call us directly at (650) 506-7200. send electronic mail to appsdoc_us@oracle. xxxii .

define necessary format conversions.1 Integrating Your Systems This chapter gives you an overview of Manufacturing integration tools and explains how to use these tools to integrate Oracle Manufacturing products with one another and with your existing non–Oracle systems. Oracle Manufacturing integration tools are powerful. Topics covered here include: s Overview of Oracle Manufacturing APIs and Open Interfaces on page 1-2 Integrating Your Systems 1-1 . flexible tools that enable you to capture data from other Oracle applications or your own applications. and direct data to your Oracle Manufacturing products.

movements. Connect to external systems — such as the customer’s purchasing system and the supplier’s order entry system — to better integrate the supply chain via electronic commerce. Control processing of inbound data imported from outside Oracle applications. quality data. computer-aided design systems. applications on other computers. completions. Review. Export data from Oracle Manufacturing products s s s s s s Oracle Manufacturing Interfaces Open Interface Architectures Oracle Manufacturing products have three different methods to import and export data: s Interface Tables 1-2 Oracle Manufacturing APIs and Open Interfaces Manual . Basic Business Needs Oracle Manufacturing product APIs and open interfaces provide you with the features you need to support the following basic business needs: s Connect to data collection devices. Connect to other systems — such as finite scheduling packages. custom. The purpose of this essay is to help you understand the general model Oracle Manufacturing products use for open application interfaces. and legacy manufacturing systems — to create integrated enterprise wide systems. Other essays in this chapter provide specific information on how to use each of the open interfaces. issues. and even the applications of your suppliers and customers.Overview of Oracle Manufacturing APIs and Open Interfaces Overview of Oracle Manufacturing APIs and Open Interfaces Oracle Manufacturing products provide a number of open interfaces so you can link them with non-Oracle applications. and shipments. and resubmit imported data that failed validation. This lets you collect material movement transactions such as receipts. applications you build. Validate imported data to ensure integrity of Oracle Manufacturing products. This speeds data entry and improves transaction accuracy. Additional technical information on these interfaces is available in each product’s Technical Reference Manual. Additional functional information on these interfaces is available in each product’s User’s Guide. update.

This provides tight integration without adding a batch process to move data. In several instances. both inbound and outbound. Function Calls or Programmatic Interfaces (Processes) Some open interfaces are more fundamental to the architecture of Oracle Manufacturing products. The view definitions also briefly describe how they are used. Oracle Manufacturing and Distribution products have defined business views that identify certain areas of key business interest. Another example is modifying open stored procedures.Overview of Oracle Manufacturing APIs and Open Interfaces s Interface Views (Business Views) Function Calls or Programmatic Interfaces (Processes) s Interface Tables Interface tables. note flexfield validation by table/view. whether for reporting or data export. normally require some validation through a concurrent program. Product views are defined in the Technical Reference Manuals. Dynamic Views are views that are dynamically created and re-created as you create and modify collection plans in Oracle Quality. The MTL_ITEM_QUANTITIES_VIEW is an example of a key business view. These tables are fully documented in the essays that follow this chapter. Interface Views (Business Views) Views simplify the data relationships for easier processing. In this class of inbound interfaces. Many views. Integrating Your Systems 1-3 . You can access this data using your tool of choice. you can add business specific logic to match configurations (check for duplicate configurations) by modifying the stored procedures provided for this purpose. Dynamic Views have also been added in Oracle Quality. such as shortage reporting views in Oracle Work in Process. the addition of views automatically imports data into an existing function. have been added specifically for easier reporting. For example. They are not interfaces as much as open integration. In the Oracle Bills of Material concurrent program AutoCreate Configuration. interfaces do not require an intermediate validation step — you can write directly to the product’s tables after you consult the product’s Technical Reference Manual.

or Procedure Name INV MTL_TRANSACTIONS_INTERFACE MTL_SERIAL_NUMBERS_ INTERFACE MTL_TRANSACTION_LOTS_ INTERFACE MTL_DEMAND_INTERFACE MTL_ITEM_QUANTITIES_VIEW MTL_USER_SUPPLY MTL_USER_DEMAND MTL_REPLENISH_HEADERS_INT MTL_REPLENISH_LINES_INT Interface/API Name INV Transactions Iface Man INV Yes TRM INV Yes Demand Interface On-Hand Balances User-Defined Supply User-Defined Demand Replenishment Inbound Outbound Inbound Inbound Inbound Table View Table Table Table Yes Yes Yes Yes Yes Yes Yes 1-4 Oracle Manufacturing APIs and Open Interfaces Manual . or Procedure INV Table Table. Process. and so on.Overview of Oracle Manufacturing APIs and Open Interfaces Summary: Beyond Published Interfaces The Oracle Cooperative Applications Initiative references many third party products which provide import and export capabilities and allow loose to tight integration with legacy systems. views. View. and modules: Table 1–1 Key Key Data Flow Direction Iface Man TRM Inbound means into Oracle Manufacturing. Outbound means out from Oracle Manufacturing The interface is documented in detail in the Oracle Manufacturing and Distribution Open Interfaces Manual The tables. or modules are described in the product’s Technical Reference Manual Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction INV Inbound Table. Contact your Oracle consultant for more information about system integration. View. views. Current Documentation For Open Interfaces Below are the actual names of the tables. Module Name. other supplier systems.

or Procedure Table Table. Module Name. View. Process.Overview of Oracle Manufacturing APIs and Open Interfaces Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Table. View. or Procedure Name MTL_SYSTEM_ITEMS_INTERFACE MTL_ITEMS_REVISIONS_ INTERFACE MTL_CI_INTERFACE MTL_CI_XREFS_INTERFACE MTL_TRANSACTIONS_INTERFACE MTL_SERIAL_NUMBERS_ INTERFACE MTL_TRANSACTION_LOTS_ INTERFACE ENG/BOM BOM_CALENDAR_MONTHS_VIEW BOM_BILL_OF_MTLS_INTERFACE BOM_INVENTORY_COMPS_ INTERFACE BOM_REF_DESGS_INTERFACE BOM_SUB_COMPS_INTERFACE MTL_ITEMS_REVISIONS_ INTERFACE BOM_EXPORT_TAB BOM_SMALL_EXPL_TEMP Interface/API Name Item Iface Man Yes TRM Yes Customer Item Customer Item Cross-References Material Inbound Inbound Inbound Table Table Table Yes Yes Yes Yes Yes Yes ENG/BOM MFG Calendar Bill of Material ENG/BOM Outbound Inbound ENG/BOM View Table ENG/BO M ENG/ BOM Yes Yes Yes Routings Inbound Table Yes Yes BOM_OP_ROUTINGS_INTERFACE BOM_OP_SEQUENCES_INTERFACE BOM_OP_RESOURCES_INTERFACE MTL_RTG_ITEM_REVS_INTERFACE ENG_ENG_CHANGES_INTERFACE ENG_ECO_REVISIONS_INTERFACE ENG_REVISED_ITEMS_INTERFACE BOM_INVENTORY_COMPS_ INTERFACE BOM_REF_DESGS_INTERFACE BOM_SUB_COMPS_INTERFACE eAM ECO Inbound Table Yes Yes eAM eAM eAM eAM eAM Integrating Your Systems 1-5 .

or Procedure Name MTL_SYSTEM_ITEMS_INTERFACE MTL_ITEM_REVISIONS_ INTERFACE MTL_ITEM_CATEGORIES_ INTERFACE MTL_INTERFACE_ERRORS Interface/API Name eAM Item Open Interface Iface Man Yes TRM Yes eAM Asset Number Open Interface Inbound Table Yes Yes MTL_EAM_ASSET_NUM_ INTERFACE MTL_EAM_ATTR_VAL_INTERFACE MTL_EAM_ATTR_VAL_INTERFACE eAM Asset Genealogy Open Interface eAM Work Order Open Interface eAM Meter Reading Open Interface Oracle Cost Management (see Oracle Bills of Material Technical Reference Manual) Item Cost Inquiry MFG Cost Reporting MRP/SCP Forecast Interface Forecast Entries API Inbound Table Yes Yes MTL_OBJECT_GENEALOGY_ INTERFACE WIP_JOB_SCHEDULE_INTERFACE WIP_DISCRETE_JOBS Inbound Table Yes Yes Inbound Table Yes Yes EAM_METER_READING_ INTERFACE - - - - - Outbound Outbound MRP/SCP Inbound Inbound View View MRP/SCP Table Process PL/SQL Table MRP/SCP Yes Yes Yes Yes MRP/ SCP Yes Yes CST_INQUIRY_TYPES CSTFQVIC (View Item Cost Information) CST_REPORT_TYPES CSTRFICR (Inventory Valuation Report) MRP/SCP MRP_FORECAST_INTERFACE T_FORECAST_INTERFACE T_FORECAST_DESIGNATOR 1-6 Oracle Manufacturing APIs and Open Interfaces Manual . View. or Procedure Table Table. Process.Overview of Oracle Manufacturing APIs and Open Interfaces Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Table. Module Name. View.

Overview of Oracle Manufacturing APIs and Open Interfaces Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Inbound Outbound Table. or WIP_JOB_SCHEDULE_INTERFACE PO_REQUISITIONS_INTERFACE PO_RESCHEDULE_INTERFACE MRP_RECOMMENDATIONS Interface/API Name Master Schedule Interface Master Schedule Relief Interface Planner Workbench Interface Projected Requirements Interface Projected Supply Interface Sourcing Rule API Iface Man Yes TRM Yes Yes Yes Outbound Table Yes Outbound Outbound Table Procedure Yes Yes Yes MRP_GROSS_REQUIREMENTS MRP_SOURCING_RULE_ PUB.PROCESS_SOURCING_RULE MRP_SRC_ASSIGNMENT_ PUB. View. Process.PROCESS_ASSIGNMENT PO Requisitions Requisition Reschedule Purchasing Documents Receiving PO Inbound Inbound Inbound PO Table Table Table PO Yes Yes Yes PO Yes Yes Yes PO PO_REQUISITIONS_INTERFACE PO_REQ_DIST_INTERFACE PO_RESCHEDULE_INTERFACE PO_HEADERS_INTERFACE PO_LINES_INTERFACE PO_DISTRIBUTIONS_INTERFACE RCV_HEADERS_INTERFACE RCV_TRANSACTIONS_INTERFACE Inbound Table Yes Yes QA Collection Import Dynamic Collection Plan View Dynamic Collection Import View QA Inbound Outbound QA Table View QA Yes Yes QA Yes Yes QA QA_RESULTS_INTERFACE Q_COLLECTION_PLAN_NAME_V Inbound View Yes Yes Q_COLLECTION_PLAN_NAME_IV Integrating Your Systems 1-7 . Module Name. View. or Procedure Table Table Process Table. or Procedure Name MRP_SCHEDULE_INTERFACE MRP_RELIEF_INTERFACE Stored Procedure MRPPL06.

or Procedure WSM Table Table Table Table. View. Process.SYNC_DEVICE_REQUEST 1-8 Oracle Manufacturing APIs and Open Interfaces Manual . or Procedure Name WSM WSM_LOT_JOB_INTERFACE WSM_LOT_MOVE_TXN_ INTERFACE WSM_SPLIT_MERGE_TXN_ INTERFACE WSM_STARTING_JOBS_INTERFACE WSM_RESULTING_JOBS_ INTERFACE Interface/API Name WSM Import Lot Jobs Lot Move Transactions WIP Lot Transactions Iface Man WSM Yes Yes Yes TRM WSM Yes Yes Yes Inventory Lot Transactions Inbound Table Yes Yes WSM_LOT_SPLIT_MERGES_ INTERFACE WSM_STARTING_LOTS_ INTERFACE WSM_RESULTING_LOTS_ INTERFACE WIP Move Transaction WIP Inbound WIP Table WIP Yes WIP Yes WIP WIP_MOVE_TXN_INTERFACE CST_COMP_SNAP_INTERFACE (if organization uses average costing) Resource Transaction Work Order Interface WMS Compliance Label Inbound Inbound Table Table Yes Yes Yes Yes WIP_COST_TXN_INTERFACE WIP_JOB_SCHEDULE_INTERFACE WIP_JOB_DTLS_INTERFACE WMS Inbound WMS Procedure WMS Yes WMS Yes WMS PRINT_LABEL_MANUAL_WRAP PRINT_LABEL PRINT_LABEL_WRAP Device Integration Inbound Procedure Yes Yes WMS_DEVICE_INTEGRATION_ PVT. View.Overview of Oracle Manufacturing APIs and Open Interfaces Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction WSM Inbound Inbound Inbound Table. Module Name.DEVICE_REQUEST WMS_DEVICE_INTEGRATION_ PUB.

interface tables as well as supporting validation. and maintenance programs are provided. View. Module Name. or Procedure Name CREATE_LOCATOR UPDATE_LOCATOR CREATE_LOC_ITEM_TIE DELETE_LOCATOR Interface/API Name Locator Maintenance Iface Man Yes TRM Yes Container Inbound Procedure Yes Yes GENERATE_LPN_CP GENERATE_LPN ASSOCIATE_LPN CREATE_LPN MODIFY_LPN MODIFY_LPN_WRAPPER PACKUNPACK_CONTAINER PACK_PREPACK_CONTAINER VALIDATE_UPDATE_WT_VOLUME PURGE_LPN EXPLODE_LPN TRANSFER_LPN_CONTENTS CONTAINER_REQUIRED_QTY GET_OUTERMOST_LPN GET_LPN_LIST PREPACK_LPN_CP PREPACK_LPN PRINT_CONTENT_REPORT LPN_PACK_COMPLETE WMS Installation Inbound Procedure Yes Yes CHECK_INSTALL Inbound Open Interface Model Oracle Manufacturing products provide both inbound and outbound interfaces. processing. View. For inbound interfaces.Overview of Oracle Manufacturing APIs and Open Interfaces Table 1–2 Oracle Manufacturing Interfaces/APIs Data Flow Direction Inbound Table. Process. where these products are the destination. or Procedure Procedure Table. where these products are the source. For outbound interfaces. database views are Integrating Your Systems 1-9 .

You can find information about the tables.Overview of Oracle Manufacturing APIs and Open Interfaces provided and the destination application should provide the validation. processing. Open Interface Diagram The general model for open application interfaces is as follows: 1-10 Oracle Manufacturing APIs and Open Interfaces Manual . and maintenance programs. Note that the Technical Reference Manuals do not contain detailed. views. Discussion of Inbound Interfaces Only This overview and the rest of the documents in this chapter discuss only inbound interfaces in detail. and processes involved in outbound interfaces in the product’s Technical Reference Manual. narrative discussions about the outbound interfaces.

Overview of Oracle Manufacturing APIs and Open Interfaces Figure 1–1 Open Interface Diagram Open Application Programmatic Interface (API) Diagram The model used by APIs such as the Service Request interfaces (Oracle Service) is as follows: Integrating Your Systems 1-11 .

These components are described below. and in some cases the component may be implemented slightly differently than described below.Overview of Oracle Manufacturing APIs and Open Interfaces Figure 1–2 Open Application Programmatic Interface (API) Diagram Components of an Open Interface There are a number of components that are generally common to all open interfaces. 1-12 Oracle Manufacturing APIs and Open Interfaces Manual . all open interfaces do not include every component. However.

Oracle Manufacturing products are the source for outbound interfaces. The various types of interface columns. Oracle Inventory is the source for the On-Hand Balances Interface. For example. the interface table is the intermediary table where the data from the source application temporarily resides until it is validated and processed into an Oracle Manufacturing product. errored. Additional control columns identify who last updated the row and the last update date. For example. Oracle Purchasing is the destination for receiving transactions imported using the Receiving Open Interface. Oracle Manufacturing products are the destinations for inbound interfaces.Overview of Oracle Manufacturing APIs and Open Interfaces Source Application You obtain data from a source application to pass on to a destination application for further processing and/or storage. typical identifier columns for a move transaction would identify: s The source application. Integrating Your Systems 1-13 . such as the bar code device identifier The row’s unique identifier in the source application. Typically the data has completed processing in the source application before being passed. Destination Application You send data to a destination application so that the application can perform further processing and/or storage. s s Control Columns Control columns track the status of each row in the interface table as it is inserted. such as the job name The destination application’s unique identifier. This interface is used to export on-hand balances from Oracle Inventory for use by other planning and distribution destination applications. For example. with examples from the Oracle Work in Process Move Transaction Interface. such as the Work in Process entity ID. and ultimately deleted. and creates and stores the receiving transaction history. processed. are listed below: Identifier Columns Identifier columns uniquely identify rows in the interface table and provide foreign key reference to both the source and destination applications. Oracle Purchasing updates purchase orders for each receiving transaction. validated. Interface Table For inbound interfaces.

whereas discrete move transactions do not. organization code is required for all move transactions. In some cases. In other cases. on a move transaction. For example.Overview of Oracle Manufacturing APIs and Open Interfaces Data Columns Data columns store the specific attributes that the source application is sending to the Oracle Manufacturing product. Required Columns Required columns store the minimum information needed by the Oracle Manufacturing product to successfully process the interface row. For example. transaction quantity is one attribute of a move transaction. Oracle Manufacturing products provide predefined views of key data that is likely to be used by destination applications. the validation program inserts an error into an errors table when resource transaction records fail validation because of a missing piece of required data. in the Oracle Work in Process Open Resource Transaction Interface. For example. the errors table is a child of the interface table. For example. Optional Columns Optional columns are not necessarily required by Oracle Manufacturing products but can be used for additional value-added functionality. Oracle Quality also provides non-predefined. Some columns are conditionally required based on the specifics of the interface. For example. repetitive move transactions require production line information. For example. such as the resource transaction quantity. the errors table stores all errors found by the validation and processing functions. the errors are stored in a column within the interface table. In addition to the predefined views that these products use. In contrast. This allows each row in the interface table to have many errors. but can optionally be used to collect additional transaction information. which requires you to fix each error independently. for move transactions the reason code is not required. 1-14 Oracle Manufacturing APIs and Open Interfaces Manual . Derived Columns Derived columns are created by the destination product from information in the required columns. so that you can manage multiple errors at once. the primary unit of measure is derived from the assembly being moved. Errors Table For inbound interfaces. Order Import in Oracle Order Management/Shipping inserts errors into a single errors column in the interface table when rows fail validation. dynamic views. Database View Database views are database objects that make data from the Oracle Manufacturing source products available for selection and use by destination applications.

Integrating Your Systems 1-15 . The programming languages and tools used in the load function are highly dependent on the hardware and system software of the source application. you can typically validate data upon entry using techniques such as forms triggers. For example. validation programs need to write errors to the destination application’s errors table or to the interface table’s error column. For example. Then you could use SQL*Loader to insert that file into the destination product’s interface table. If errors are found. not null columns. the Item Cost Interface in Oracle Cost Management uses SQL to create several database views of the item cost information for use by other budgeting and cost analysis destination applications. In the source application. the validate function can derive additional columns based on the required columns and foreign key relationships with other data elsewhere in the Oracle Manufacturing destination application. and so on. For outbound interfaces.Overview of Oracle Manufacturing APIs and Open Interfaces These views join related tables within source products so that the data can be selected by the destination application. you would likely use a procedural language available on the source application to select the data and convert it into an ASCII file. The validation programs check the interface table for rows requiring validation. if you are passing data between an Oracle based source application and an Oracle Manufacturing product. Oracle Cost Management provides work in process valuation and transaction distribution database views for use by other cost reporting destination products. If you are bringing data from a non-Oracle based application into a product’s interface table. In addition. you would likely use a tool such as Pro*C or PL/SQL since these tools work in both environments. then validates and updates each row indicating either validation complete or errors found. Validate Function The validate function is the set of programs that Oracle Manufacturing destination products use to insure the integrity of inbound data. However. Load Function For inbound interfaces. data types. since Oracle Manufacturing products are not the source of this data. For example. the load function is the SQL that creates the database view. validation programs ensure data integrity. the load function is the set of programs that selects and accumulates data from the source application and inserts it into Oracle Manufacturing interface tables.

These tasks include: s checking the accuracy of specific columns such as the job or schedule name checking the completeness of each row such as the transaction unit of measure and transaction quantity checking the relationship between columns in the same row such as the from and to operation sequence numbers s s 1-16 Oracle Manufacturing APIs and Open Interfaces Manual . several validation tasks are performed by the move transaction validation program within the Oracle Work in Process Open Move Transaction Interface.Overview of Oracle Manufacturing APIs and Open Interfaces For example.

2 Oracle ASCP and Oracle Global ATP Server Open Interfaces This section explains how to use the ODS Load API and how it functions in Oracle ASCP and Oracle Global ATP Server. Topics included are: s ODS Load API Features on page 2-2 Functional Overview on page 2-7 Setting Up the ODS Load API on page 2-7 s s Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-1 .

In incremental refresh mode. MSC_ST_SOURCING_HISTORY s ATP Rules In complete refresh mode. and update information for existing items. you can renew all entries using the table. you can create new entries. MSC_ST_ATP_RULES s Bill of Resources In complete refresh mode. you can update the sourcing history information using the table. The following tables are used: s MSC_ST_BILL_OF_RESOURCES MSC_ST_BOR_REQUIREMENTS s 2-2 Oracle Manufacturing APIs and Open Interfaces Manual . you can renew all entries. you can renew all entries. and update existing sourcing information.ODS Load API Features ODS Load API Features The ODS API consists of the following entities (staging tables): s Inventory Items information In complete refresh mode. you can create new entries. you can renew all entries. The following staging tables are used: s MSC_ST_SYSTEM_ITEMS MSC_ST_SAFETY_STOCKS s s Sourcing Rules In complete refresh mode. you can renew all entries using the table. MSC_ST_INTERORG_SHIP_METHODS In both complete and refresh mode. The following tables are used: s MSC_ST_ASSIGNMENT_SETS MSC_ST_SOURCING_RULES MSC_ST_SR_ASSIGNMENTS MSC_ST_SR_RECEIPT_ORG MSC_ST_SR_SOURCE_ORG s s s s In complete refresh mode. In incremental refresh mode.

you can renew all entries. The following tables are used: s MSC_ST_PROCESS_EFFECTIVITY MSC_ST_BOMS MSC_ST_BOM_COMPONENTS MSC_ST_COMPONENT_SUBSTITUTES MSC_ST_ROUTINGS MSC_ST_ROUTING_OPERATIONS MSC_ST_OPERATION_RESOURCE_SEQS MSC_ST_OPERATION_RESOURCES MSC_ST_OPERATION_COMPONENTS s s s s s s s s s Calendar system In complete refresh mode. The following tables are used: s MSC_ST_CALENDAR_DATES MSC_ST_CAL_YEAR_START_DATES MSC_ST_CAL_WEEK_START_DATES MSC_ST_PERIOD_START_DATES MSC_ST_CALENDAR_SHIFTS MSC_ST_SHIFT_DATES MSC_ST_SHIFT_TIMES MSC_ST_SHIFT_EXCEPTIONS MSC_ST_SIMULATION_SETS MSC_ST_RESOURCE_SHIFTS s s s s s s s s s s Categories In complete refresh mode. In incremental refresh mode. Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-3 . you can renew all entries. you can renew all entries. and update existing BOM/Routing data. and update existing categories information.ODS Load API Features s BOMs/Routings In complete refresh mode. you can create new entries. In incremental refresh mode. you can create new entries.

In incremental refresh mode. and update existing designators information. you can create new entries. you can renew all entries. you can renew all entries. These operations use the table. The following tables are used: s MSC_ST_RESOURCE_GROUPS MSC_ST_DEPARTMENT_RESOURCES s In complete refresh mode. These operations use the table. The following tables are used: s MSC_ST_DEMANDS MSC_ST_RESERVATIONS MSC_ST_SALES_ORDERS s s s Supplies In complete refresh mode. you can renew all entries. MSC_ST_SUPPLIES s Resources In complete refresh mode. you can create new entries. In incremental refresh mode. you can renew all entries. you can renew all entries. The following tables are used: s MSC_ST_NET_RESOURCE_AVAIL MSC_ST_RESOURCE_REQUIREMENTS MSC_ST_RESOURCE_CHANGES s s 2-4 Oracle Manufacturing APIs and Open Interfaces Manual . you can create new entries. you can create new entries.ODS Load API Features The following tables are used: s MSC_ST_CATEGORY_SETS MSC_ST_ITEM_CATEGORIES s s MDS/MPS designators In complete refresh mode. MSC_ST_DESIGNATORS s Demands and Sales Orders In complete refresh mode. In incremental refresh mode. and update existing demands and sales orders information. In incremental refresh mode. and update existing supplies information. and update existing resources information.

you can create new entries. The following tables are used: Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-5 . you can renew all entries. MSC_ST_PLANNERS s Units Of Measure In complete refresh mode. The following tables are used: s MSC_ST_TRADING_PARTNERS MSC_ST_TRADING_PARTNER_SITES MSC_ST_LOCATION_ASSOCIATIONS MSC_ST_PARAMETERS MSC_ST_SUB_INVENTORIES MSC_ST_PARTNER_CONTACTS s s s s s s Planner Information In complete refresh mode. you can renew all entries. and update existing supplier capacities information. The following tables are used: s MSC_ST_UNITS_OF_MEASURE MSC_ST_UOM_CONVERSIONS MSC_ST_UOM_CLASS_CONVERSIONS s s s Unit Number. These operations use the table. you can renew all entries. and Tasks Information In complete refresh mode. Projects. MSC_ST_SUPPLIER_CAPACITIES s Trading Partners Information In complete refresh mode. you can renew all entries. In incremental refresh mode.ODS Load API Features s Approved Suppliers Information In complete refresh mode. The following tables are used: s MSC_ST_ITEM_SUPPLIERS MSC_ST_SUPPLIER_FLEX_FENCES s In complete refresh mode. you can renew all entries. you can renew all entries using the table.

MSC_ST_DEMAND_CLASSES See Also The Oracle ASCP and Oracle Global ATP Server Technical Reference Manual. you can renew all entries using the table. s MSC_ST_BIS_BUSINESS_PLANS MSC_ST_BIS_PERIODS MSC_ST_BIS_PFMC_MEASURES MSC_ST_BIS_TARGET_LEVELS MSC_ST_BIS_TARGETS s s s s s Demand Classes In complete refresh mode. you can renew all entries.ODS Load API Features s MSC_ST_UNIT_NUMBERS MSC_ST_PROJECTS MSC_ST_PROJECT_TASKS s s s BIS Objects In complete refresh mode. 2-6 Oracle Manufacturing APIs and Open Interfaces Manual .

customer. and customer site. You need to define certain data before you create or update ODS data. Purge the data in the staging tables. category set. Update. Before using the API. Launch the ODS Load Workers to perform Create. Recalculate the sourcing history based on the latest sourcing information and the data from the transaction systems. shifts. for loading the data into the ODS tables. set up and/or activate the following parameters: s Instance Code Number of Workers Recalculate Net Resource Availability (Yes/No) Recalculate Sourcing History (Yes/No) s s s Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-7 . vendor site. vendor. The Launch_Monitor procedure performs the following major processes: s Generate new local ID for the global attributes such as item. and department resources information.Setting Up the ODS Load API Functional Overview The ODS Load API provides a public procedure. and Delete Operation for each entity in ODS. Launch_Monitor. Recalculate the net resource availability based on the calendars. s s s s Setting Up the ODS Load API The ODS Load API is a stored PL/SQL function.

Setting Up the ODS Load API Parameter Descriptions The following charts describe all staging tables used by the ODS Load API. . Additional information on these parameters follows each chart. All of the inbound and outbound parameters are listed for these table. Table 2–1 MSC_ASSIGNMENT_SETS Parameter SR_ASSIGNMENT_SET_ID ASSIGNMENT_SET_NAME DESCRIPTION DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(34) VARCHAR2(80) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x Derived Optional SR_ASSIGNMENT_SET_ID Assignment set identifier from source application instance ASSIGNMENT_SET_NAME Assignment set name 2-8 Oracle Manufacturing APIs and Open Interfaces Manual . MSC_ST_ASSIGNMENT_SETS The staging table used by the collection program to valid and process data for table MSC_ASSIGNMENT_SETS.

Setting Up the ODS Load API DESCRIPTION Description DELETED_FLAG Flag to indicate whether the row is no longer valid. SYS_YES means the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-9 .

. Table 2–2 MSC_ATP_RULES Parameter RULE_ID SR_INSTANCE_ID RULE_NAME DESCRIPTION ACCUMULATE_AVAILABLE_FLAG BACKWARD_CONSUMPTION_FLAG FORWARD_CONSUMPTION_FLAG PAST_DUE_DEMAND_CUTOFF_FENCE PAST_DUE_SUPPLY_CUTOFF_FENCE INFINITE_SUPPLY_FENCE_CODE INFINITE_SUPPLY_TIME_FENCE ACCEPTABLE_EARLY_FENCE ACCEPTABLE_LATE_FENCE DEFAULT_ATP_SOURCES INCLUDE_SALES_ORDERS INCLUDE_DISCRETE_WIP_DEMAND INCLUDE_REP_WIP_DEMAND INCLUDE_NONSTD_WIP_DEMAND INCLUDE_DISCRETE_MPS INCLUDE_USER_DEFINED_DEMAND INCLUDE_PURCHASE_ORDERS INCLUDE_DISCRETE_WIP_RECEIPTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(80) VARCHAR2(240) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional 2-10 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API REFRESH_ID Refresh identifier MSC_ST_ATP_RULES The staging table used by the collection program to validate and process data for table MSC_ATP_RULES.

Setting Up the ODS Load API Table 2–2 MSC_ATP_RULES Parameter INCLUDE_REP_WIP_RECEIPTS INCLUDE_NONSTD_WIP_RECEIPTS INCLUDE_INTERORG_TRANSFERS INCLUDE_ONHAND_AVAILABLE INCLUDE_USER_DEFINED_SUPPLY ACCUMULATION_WINDOW INCLUDE_REP_MPS INCLUDE_INTERNAL_REQS INCLUDE_SUPPLIER_REQS INCLUDE_INTERNAL_ORDERS INCLUDE_FLOW_SCHEDULE_DEMAND USER_ATP_SUPPLY_TABLE_NAME USER_ATP_DEMAND_TABLE_NAME MPS_DESIGNATOR LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID DEMAND_CLASS_ATP_FLAG INCLUDE_FLOW_SCHEDULE_RECEIPTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(10) DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x Required x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-11 .

Setting Up the ODS Load API RULE_ID ATP rule identifier SR_INSTANCE_ID Instance id RULE_NAME Name of ATP rule DESCRIPTION Description for ATP rule ACCUMULATE_AVAILABLE_FLAG Flag for ATP computation to accumulate quantity availability BACKWARD_CONSUMPTION_FLAG Flag for ATP computation to backwardly consume shortage FORWARD_CONSUMPTION_FLAG Flag for ATP computation to forwardly consume shortage PAST_DUE_DEMAND_CUTOFF_FENCE Demand before the specified number of days are not to be considered in ATP computation PAST_DUE_SUPPLY_CUTOFF_FENCE Supplies before the specified number of days are not to be considered in ATP computation INFINITE_SUPPLY_FENCE_CODE Source code for infinite supply time fence INFINITE_SUPPLY_TIME_FENCE Infinite supply time fence days only when user-defined is specified in the time fence code 2-12 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ACCEPTABLE_EARLY_FENCE Acceptable early fence ACCEPTABLE_LATE_FENCE Acceptable late fence DEFAULT_ATP_SOURCES Indicate which subinventories to use for on-hand quantities INCLUDE_SALES_ORDERS Yes/No flag for ATP computation to include demand from sales orders INCLUDE_DISCRETE_WIP_DEMAND Yes/No flag for ATP computation to include demand from WIP discrete jobs INCLUDE_REP_WIP_DEMAND Yes/No flag for ATP computation to include demand from WIP repetitive discrete jobs INCLUDE_NONSTD_WIP_DEMAND Yes/No flag for ATP computation to include demand from WIP non-standard jobs’ INCLUDE_DISCRETE_MPS Yes/No flag for ATP computation to include supply from discrete MPS schedule INCLUDE_USER_DEFINED_DEMAND Yes/No flag for ATP computation to include user defined demand INCLUDE_PURCHASE_ORDERS Yes/No flag for ATP computation to include supply from purchase orders INCLUDE_DISCRETE_WIP_RECEIPTS Yes/No flag for ATP computation to include supply from WIP discrete jobs INCLUDE_REP_WIP_RECEIPTS Yes/No flag for ATP computation to include supply from WIP repetitive schedule jobs Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-13 .

Setting Up the ODS Load API INCLUDE_NONSTD_WIP_RECEIPTS Yes/No flag for ATP computation to include supply from WIP non-standard jobs INCLUDE_INTERORG_TRA SFERS Yes/No flag for ATP computation to include supply from inter-organization transfers INCLUDE_ONHAND_AVAILABLE Yes/No flag for ATP computation to include supply from on-hand inventory INCLUDE_USER_DEFINED_SUPPLY Yes/No flag for ATP computation to include supply from user defined source ACCUMULATION_WINDOW Maximum number of days that available supply should be accumulated INCLUDE_REP_MPS Yes/No flag for ATP computation to include supply from repetitive MPS schedules INCLUDE_INTERNAL_REQS Yes/No flag for ATP computation include from internal requisitions INCLUDE_SUPPLIER_REQS Yes/No flag for ATP computation include from internal orders INCLUDE_INTERNAL_ORDERS Yes/No flag for ATP computation to include demand from internal orders INCLUDE_FLOW_SCHEDULE_DEMAND Yes/No flag for ATP computation to include demand from flow schedule USER_ATP_SUPPLY_TABLE_NAME Not currently used USER_ATP_DEMAND_TABLE_NAME Not currently used 2-14 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API MPS_DESIGNATOR Not currently used LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column REFRESH_ID Refresh identifier DEMAND_CLASS_ATP_FLAG Yes/No flag for ATP computation to consider Demand Class when selecting supply and demand Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-15 .

Table 2–3 MSC_BILL_OF_RESOURCES Parameter ORGANIZATION_ID BILL_OF_RESOURCES DESCRIPTION DISABLE_DATE ROLLUP_START_DATE ROLLUP_COMPLETION_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(10) VARCHAR2(50) DATE DATE DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x x x x Derived Optional ORGANIZATION_ID Organization identifier 2-16 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API INCLUDE_FLOW_SCHEDULE_RECEIPTS Yes/No flag for ATP computation to include supply from repetitive MPS schedules MSC_ST_BILL_OF_RESOURCES The staging table used by the collection program to validate and process data for table MSC_BILL_OF_RESOURCES. .

Setting Up the ODS Load API BILL_OF_RESOURCES Source application bill of resource identifier DESCRIPTION Bill of resource description DISABLE_DATE Bill of resource disable date ROLLUP_START_DATE Bill of resources load start date ROLLUP_COMPLETION_DATE Bill of resources load completion date DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID NULL Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-17 .

.Setting Up the ODS Load API PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_BIS_BUSINESS_PLANS The staging table used by the collection program to validate and process data for table MSC_BIS_BUSINESS_PLANS. Table 2–4 MSC_BIS_BUSINESS_PLANS Parameter BUSINESS_PLAN_ID SHORT_NAME NAME DESCRIPTION VERSION_NO CURRENT_PLAN_FLAG DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN Usage IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(30) VARCHAR2(80) VARCHAR2(240) NUMBER VARCHAR2(1) NUMBER DATE NUMBER DATE NUMBER NUMBER x x x x x x x x Required x x x x Derived Optional 2-18 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–4 MSC_BIS_BUSINESS_PLANS Parameter REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID Usage IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required Derived x x x x x Optional BUSINESS_PLAN_ID Business plan identifier SHORT_NAME Business plan short name NAME Business plan name DESCRIPTION Describe the business plan VERSION_NO Version number CURRENT_PLAN_FLAG Yes/No flag indicating whether the business plan is current DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-19 .

.Setting Up the ODS Load API CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_BIS_PERIODS The staging table used by the collection program to validate and process data for table MSC_BIS_PERIODS. Table 2–5 MSC_BIS_PERIODS Parameter ORGANIZATION_ID PERIOD_SET_NAME PERIOD_NAME Usage IN IN IN Type NUMBER VARCHAR2(15) VARCHAR2(15) Required x x x Derived Optional 2-20 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–5 MSC_BIS_PERIODS Parameter START_DATE END_DATE PERIOD_TYPE PERIOD_YEAR PERIOD_NUM QUARTER_NUM ENTERED_PERIOD_NAME ADJUSTMENT_PERIOD_FLAG DESCRIPTION CONTEXT YEAR_START_DATE QUARTER_START_DATE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type DATE DATE VARCHAR2(15) NUMBER(15) NUMBER(15) NUMBER(15) VARCHAR2(15) VARCHAR2(1) VARCHAR2(240) VARCHAR2(150) DATE DATE DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x Required x x x x x x x x x x x x Derived Optional ORGANIZATION_ID Organization identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-21 .

Setting Up the ODS Load API PERIOD_SET_NAME Accounting calendar name PERIOD_NAME Accounting calendar name START_DATE Date on which accounting period begins END_DATE Date on which accounting period ends PERIOD_TYPE Accounting period type PERIOD_YEAR Accounting period year PERIOD_NUM Accounting period number QUARTER_NUM Accounting period number ENTERED_PERIOD_NAME User entered accounting period name ADJUSTMENT_PERIOD_FLAG Calendar period adjustment status DESCRIPTION Accounting period description CONTEXT Descriptive flexfield segment 2-22 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API YEAR_START_DATE Date on which the year containing this accounting period starts QUARTER_START_DATE Date on which the quarter containing this accounting period starts LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column REFRESH_ID Refresh identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-23 .

Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier MSC_ST_BIS_PFMC_MEASURES The staging table used by the collection program to validate and process data for table MSC_BIS_PFMC_MEASURES. Table 2–6 MSC_BIS_PFMC_MEASURES Parameter MEASURE_ID MEASURE_SHORT_NAME MEASURE_NAME DESCRIPTION ORG_DIMENSION_ID TIME_DIMENSION_ID DIMENSION1_ID DIMENSION2_ID DIMENSION3_ID DIMENSION4_ID DIMENSION5_ID UNIT_OF_MEASURE_CLASS DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(30) VARCHAR2(80) VARCHAR2 (240) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x Required x x x x x x x x x x x x Derived Optional 2-24 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–6 MSC_BIS_PFMC_MEASURES Parameter PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID Usage IN IN IN Type DATE NUMBER NUMBER x Required Derived x x Optional MEASURE_ID Measure identifier MEASURE_SHORT_NAME Source application instance identifier MEASURE_NAME Measure short name DESCRIPTION Describe the performance measure ORG_DIMENSION_ID Organization dimension identifier TIME_DIMENSION_ID Time dimension identifier DIMENSION1_ID First dimension identifier DIMENSION2_ID Second dimension identifier DIMENSION3_ID Third dimension identifier DIMENSION4_ID Forth dimension identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-25 .

Setting Up the ODS Load API DIMENSION5_ID Fifth dimension identifier UNIT_OF_MEASURE_CLASS Unit of measure class DELETED_FLAG Yes/No flag indicates whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column 2-26 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_BIS_TARGETS The staging table used by the collection program to validate and process data for table MSC_BIS_TARGETS. Table 2–7 MSC_BIS_TARGETS Parameter TARGET_ID TARGET_LEVEL_ID BUSINESS_PLAN_ID ORG_LEVEL_VALUE_ID TIME_LEVEL_VALUE_ID DIM1_LEVEL_VALUE_ID DIM2_LEVEL_VALUE_ID DIM3_LEVEL_VALUE_ID DIM4_LEVEL_VALUE_ID DIM5_LEVEL_VALUE_ID TARGET RANGE1_LOW RANGE1_HIGH RANGE2_LOW RANGE2_HIGH RANGE3_LOW RANGE3_HIGH NOTIFY_RESP1_ID NOTIFY_RESP1_SHORT_NAME Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) VARCHAR2(80) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(100) Required x x x x x x x x x x x x x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-27 .

Setting Up the ODS Load API Table 2–7 MSC_BIS_TARGETS Parameter NOTIFY_RESP2_ID NOTIFY_RESP2_SHORT_NAME NOTIFY_RESP3_ID NOTIFY_RESP3_SHORT_NAME DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(100) NUMBER VARCHAR2(100) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required Derived Optional x x x x TARGET_ID Target identifier TARGET_LEVEL_ID Target level identifier BUSINESS_PLAN_ID Business plan identifier ORG_LEVEL_VALUE_ID Org level value identifier 2-28 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API TIME_LEVEL_VALUE_ID Time level value identifier DIM1_LEVEL_VALUE_ID First dimension level value identifier DIM2_LEVEL_VALUE_ID Second dimension level value identifier DIM3_LEVEL_VALUE_ID Third dimension level value identifier DIM4_LEVEL_VALUE_ID Forth dimension level value identifier DIM5_LEVEL_VALUE_ID Fifth dimension level value identifier TARGET Target number RANGE1_LOW Low number of the first range RANGE1_HIGH High number of the first range RANGE2_LOW Low number of the second range RANGE2_HIGH High number of the second range RANGE3_LOW Low number of the third range Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-29 .

Setting Up the ODS Load API RANGE3_HIGH High number of the third range NOTIFY_RESP1_ID First notify identifier NOTIFY_RESP1_SHORT_NAME Short name of the first notify NOTIFY_RESP2_ID Second notify identifier NOTIFY_RESP2_SHORT_NAME Short name of the second notify NOTIFY_RESP3_ID Third notify identifier NOTIFY_RESP3_SHORT_NAME Short name of the third notify DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column 2-30 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–8 MSC_BIS_TARGET_LEVELS Parameter TARGET_LEVEL_ID TARGET_LEVEL_SHORT_NAME TARGET_LEVEL_NAME DESCRIPTION MEASURE_ID ORG_LEVEL_ID TIME_LEVEL_ID Usage IN IN IN IN IN IN IN Type NUMBER VARCHAR2(30) VARCHAR2(80) VARCHAR2(240) NUMBER NUMBER NUMBER Required x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-31 .Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_BIS_TARGET_LEVELS The staging table used by the collection program to validate and process data for table MSC_BIS_TARGET_LEVELS.

Setting Up the ODS Load API Table 2–8 MSC_BIS_TARGET_LEVELS Parameter DIMENSION1_LEVEL_ID DIMENSION2_LEVEL_ID DIMENSION3_LEVEL_ID DIMENSION4_LEVEL_ID DIMENSION5_LEVEL_ID WORKFLOW_ITEM_TYPE WORKFLOW_PROCESS_SHORT_NAME DEFAULT_NOTIFY_RESP_ID DEFAULT_NOTIFY_RESP_SHORT_ NAME COMPUTING_FUNCTION_ID REPORT_FUNCTION_ID UNIT_OF_MEASURE SYSTEM_FLAG DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(8) VARCHAR2(30) NUMBER VARCHAR2(100) NUMBER NUMBER VARCHAR2(25) VARCHAR2(1) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required Derived Optional x x x x x x x x x x x x x 2-32 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API TARGET_LEVEL_ID Target level identifier TARGET_LEVEL_SHORT_NAME Short name identifying the target level TARGET_LEVEL_NAME Target level name DESCRIPTION Describe the target level MEASURE_ID Performance measure identifier ORG_LEVEL_ID Organization level identifier TIME_LEVEL_ID Time level identifier DIMENSION1_LEVEL_ID First dimension level identifier DIMENSION2_LEVEL_ID Second dimension level identifier DIMENSION3_LEVEL_ID Third dimension level identifier DIMENSION4_LEVEL_ID Forth dimension level identifier DIMENSION5_LEVEL_ID Fifth dimension level identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-33 .

Setting Up the ODS Load API WORKFLOW_ITEM_TYPE Workflow item type WORKFLOW_PROCESS_SHORT_NAME Workflow process short name DEFAULT_NOTIFY_RESP_ID Default notify identifier DEFAULT_NOTIFY_RESP_SHORT_NAME Name of the default notify COMPUTING_FUNCTION_ID Computing function identifier REPORT_FUNCTION_ID Report function identifier UNIT_OF_MEASURE Unit of measure SYSTEM_FLAG System flag DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column 2-34 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–9 MSC_BOMS Parameter BILL_SEQUENCE_ID ORGANIZATION_ID ASSEMBLY_ITEM_ID ASSEMBLY_TYPE ALTERNATE_BOM_DESIGNATOR Usage IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-35 .Setting Up the ODS Load API CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_BOMS The staging table used by the collection program to valid and process data for table MSC_BOMS.

Setting Up the ODS Load API Table 2–9 MSC_BOMS Parameter SPECIFIC_ASSEMBLY_COMMENT PENDING_FROM_ECN COMMON_BILL_SEQUENCE_ID SCALING_TYPE BOM_SCALING_TYPE ASSEMBLY_QUANTITY UOM DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(240) VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required Derived Optional x x x x x x x BILL_SEQUENCE_ID Bill sequence identifier in the source application instance ORGANIZATION_ID Organization identifier of the item ASSEMBLY_ITEM_ID Identifier of the item being assembled 2-36 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ASSEMBLY_TYPE Manufacturing Bill(1). ALTERNATE_BOM_DESIGNATOR Name of the bill for alternate bills (null for the primary bill) SPECIFIC_ASSEMBLY_COMMENT Comments for specific assembly PENDING_FROM_ECN Change notice that created this bill of material COMMON_BILL_SEQUENCE_ID Common bill sequence identifier SCALING_TYPE Controls scaling behavior BOM_SCALING_TYPE BOM scaling type ASSEMBLY_QUANTITY Assembly quantity UOM Unit of measure code DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-37 . Used for UI and reports. or Engineering(2).

Setting Up the ODS Load API CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_BOM_COMPONENTS The staging table used by the collection program to valid and process data for table MSC_BOM_COMPONENTS. Table 2–10 Parameter COMPONENT_SEQUENCE_ID ORGANIZATION_ID INVENTORY_ITEM_ID MSC_BOM_COMPONENTS Usage IN IN IN Type NUMBER NUMBER NUMBER Required x x x Derived Optional 2-38 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–10 Parameter USING_ASSEMBLY_ID BILL_SEQUENCE_ID COMPONENT_TYPE SCALING_TYPE CHANGE_NOTICE REVISION UOM_CODE USAGE_QUANTITY EFFECTIVITY_DATE DISABLE_DATE FROM_UNIT_NUMBER TO_UNIT_NUMBER USE_UP_CODE MSC_BOM_COMPONENTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(3) VARCHAR2(3) NUMBER DATE DATE VARCHAR2(30) VARCHAR2(30) NUMBER DATE NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER x x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x SUGGESTED_EFFECTIVITY_DATE DRIVING_ITEM_ID OPERATION_OFFSET_PERCENT OPTIONAL_COMPONENT OLD_EFFECTIVITY_DATE WIP_SUPPLY_TYPE PLANNING_FACTOR ATP_FLAG COMPONENT_YIELD_FACTOR REVISED_ITEM_SEQUENCE_ID STATUS_TYPE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-39 .

Setting Up the ODS Load API Table 2–10 Parameter CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_BOM_COMPONENTS Usage IN IN IN IN IN IN IN IN IN Type DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x x x x x Optional COMPONENT_SEQUENCE_ID Component identifier on the source application instance ORGANIZATION_ID Organization identifier INVENTORY_ITEM_ID Identifier of the component item USING_ASSEMBLY_ID Identifier of the item being assembled BILL_SEQUENCE_ID Identifier of the BOM COMPONENT_TYPE Component (1). Ingredient component (–1). by–product (2) SCALING_TYPE Scaling type 2-40 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API CHANGE_NOTICE Code for ECO. Use for UI and reporting REVISION Inventory item revision code UOM_CODE Unit of measure code USAGE_QUANTITY Quantity of the component to build one unit of item EFFECTIVITY_DATE Date of effectivity for this component DISABLE_DATE End of effectivity FROM_UNIT_NUMBER Effective from this unit number TO_UNIT_NUMBER Effective up to this unit number USE_UP_CODE Yes/No flag indicating whether the component is effective SUGGESTED_EFFECTIVITY_DATE Calculated use–up–date (if Use–up–code is yes) DRIVING_ITEM_ID Item which consumption determine the switch to this component OPERATION_OFFSET_PERCENT Operation offset percent Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-41 .

Setting Up the ODS Load API OPTIONAL_COMPONENT Yes/No flag – if optional use planning factor to determine demand OLD_EFFECTIVITY_DATE Old effectivity date WIP_SUPPLY_TYPE Used mainly for phantoms PLANNING_FACTOR Planning factor for this component (percent) ATP_FLAG Yes/No flag used for ATP COMPONENT_YIELD_FACTOR Factor used to multiply component quantity with to obtain component quantity REVISED_ITEM_SEQUENCE_ID Revised item sequence identifier STATUS_TYPE Status type DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column 2-42 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–11 MSC_BOR_REQUIREMENTS Parameter BILL_OF_RESOURCES ORGANIZATION_ID ASSEMBLY_ITEM_ID SR_TRANSACTION_ID SOURCE_ITEM_ID Usage IN IN IN IN IN Type VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER x Required x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-43 .Setting Up the ODS Load API CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_BOR_REQUIREMENTS The staging table used by the collection program to valid and process data for table MSC_BOR_REQUIREMENTS.

Setting Up the ODS Load API Table 2–11 MSC_BOR_REQUIREMENTS Parameter RESOURCE_ID RESOURCE_DEPARTMENT_ HOURS OPERATION_SEQUENCE_ID OPERATION_SEQ_NUM RESOURCE_SEQ_NUM SETBACK_DAYS DEPARTMENT_ID LINE_ID ASSEMBLY_USAGE ORIGINATION_TYPE RESOURCE_UNITS BASIS DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required Derived Optional x x x x x x x x x x x x BILL_OF_RESOURCES Bill of resources name 2-44 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ORGANIZATION_ID Organization identifier ASSEMBLY_ITEM_ID Assembly item identifier SR_TRANSACTION_ID Source application transaction identifier SOURCE_ITEM_ID Source item identifier RESOURCE_ID Resource identifier RESOURCE_DEPARTMENT_HOURS Require resource hours OPERATION_SEQUENCE_ID Operation sequence identifier OPERATION_SEQ_NUM Operation sequence number RESOURCE_SEQ_NUM Resource sequence number SETBACK_DAYS Resource set back days from assembly due date DEPARTMENT_ID Department identifier LINE_ID Line identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-45 .

Manual update(2). Item(1). Total value(5). Resource Units(3).Setting Up the ODS Load API ASSEMBLY_USAGE Resource hours multiplier for assembly usage ORIGINATION_TYPE Load(1). Resource value(4). Activity units(6) DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column 2-46 Oracle Manufacturing APIs and Open Interfaces Manual . Lot(2). Manual addition(3) RESOURCE_UNITS Operation resource units BASIS Operation Basis.

Table 2–12 Parameter CALENDAR_DATE CALENDAR_CODE EXCEPTION_SET_ID SEQ_NUM NEXT_SEQ_NUM PRIOR_SEQ_NUM NEXT_DATE PRIOR_DATE CALENDAR_START_DATE CALENDAR_END_DATE DESCRIPTION DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY MSC_CALENDAR_DATES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type DATE VARCHAR2(14) NUMBER NUMBER NUMBER NUMBER DATE DATE DATE DATE VARCHAR2(240) NUMBER DATE NUMBER x x x Required x x x x x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-47 .Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_CALENDAR_DATES The staging table used by the collection program to valid and process data for table MSC_CALENDAR_DATES.

Setting Up the ODS Load API Table 2–12 Parameter CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_CALENDAR_DATES Usage IN IN IN IN IN IN IN IN IN Type DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x x x x x Optional CALENDAR_DATE Calendar date CALENDAR_CODE Calendar code EXCEPTION_SET_ID Exception set identifier SEQ_NUM Sequence number (for working days only) NEXT_SEQ_NUM Next sequence number PRIOR_SEQ_NUM Prior sequence number NEXT_DATE Date corresponding to next sequence number 2-48 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PRIOR_DATE Date corresponding to prior sequence number CALENDAR_START_DATE Beginning date for the calendar CALENDAR_END_DATE Ending date for the calendar DESCRIPTION Calendar description DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-49 .

Table 2–13 Parameter CALENDAR_CODE SHIFT_NUM DAYS_ON DAYS_OFF DESCRIPTION DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_CALENDAR_SHIFTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x Required x x x x x Derived Optional 2-50 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_CALENDAR_SHIFTS The staging table used by the collection program to validate and process data for table MSC_CALENDAR_SHIFTS.

Setting Up the ODS Load API Table 2–13 Parameter PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_CALENDAR_SHIFTS Usage IN IN IN Type DATE NUMBER NUMBER x Required Derived x x Optional CALENDAR_CODE Calendar code SHIFT_NUM Shift number DAYS_ON Number of consecutive working days DAYS_OFF Number of consecutive non–working days DESCRIPTION Description DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-51 .

Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_CAL_WEEK_START_DATES The staging table used by the collection program to validate and process data for table MSC_CAL_WEEK_START_DATES. Table 2–14 Parameter CALENDAR_CODE EXCEPTION_SET_ID WEEK_START_DATE NEXT_DATE PRIOR_DATE SEQ_NUM DELETED_FLAG LAST_UPDATE_DATE MSC_CAL_WEEK_START_DATES Usage IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER DATE DATE DATE NUMBER NUMBER DATE Required x x x x x x x x Derived Optional 2-52 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–14 Parameter LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_CAL_WEEK_START_DATES Usage IN IN IN IN IN IN IN IN IN IN Type NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required Derived x x x x x x x x x Optional CALENDAR_CODE Workday calendar identifier EXCEPTION_SET_ID Exception set identifier WEEK_START_DATE Week start date NEXT_DATE Date corresponding to the next working date PRIOR_DATE Date corresponding to the prior working date SEQ_NUM Sequence number (for working days) DELETED_FLAG Yes/No flag indicating whether the row will be deleted Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-53 .

2-54 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_CAL_YEAR_START_DATES The staging table used by the collection program to validate and process data for table MSC_YEAR_START_DATES.

Setting Up the ODS Load API Table 2–15 Parameter CALENDAR_CODE EXCEPTION_SET_ID YEAR_START_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_YEAR_START_DATES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required x x x x x x x x x x x x x x Derived Optional CALENDAR_CODE Workday calendar identifier EXCEPTION_SET_ID Exception set unique identifier YEAR_START_DATE Year start date DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-55 .

2-56 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_CATEGORY_SETS The staging table used by the collection program to validate and process data for table MSC_CATEGORY_SETS.

Setting Up the ODS Load API Table 2–16 Parameter CATEGORY_SET_ID SR_CATEGORY_SET_ID CATEGORY_SET_NAME DESCRIPTION CONTROL_LEVEL DEFAULT_FLAG DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_CATEGORY_SETS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(30) VARCHAR2(240) NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x Required Derived Optional x CATEGORY_SET_ID Category set identifier SR_CATEGORY_SET_ID Category set identifier from source application instance CATEGORY_SET_NAME Category set name Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-57 .

Setting Up the ODS Load API DESCRIPTION Category set description CONTROL_LEVEL Control level DEFAULT_FLAG Default flag DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column 2-58 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh Identifier MSC_ST_COMPONENT_SUBSTITUTES The staging table used by the collection program to validate and process data for table MSC_COMPONENT_SUBSTITUTES. Table 2–17 Parameter COMPONENT_SEQUENCE_ID SUBSTITUTE_ITEM_ID USAGE_QUANTITY ORGANIZATION_ID PRIORITY DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE MSC_COMPONENT_SUBSTITUTES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE Required x x x x x x x x x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-59 .

Setting Up the ODS Load API Table 2–17 Parameter SR_INSTANCE_ID REFRESH_ID BILL_SEQUENCE_ID MSC_COMPONENT_SUBSTITUTES Usage IN IN IN Type NUMBER NUMBER NUMBER x Required x x Derived Optional COMPONENT_SEQUENCE_ID Component sequence identifier SUBSTITUTE_ITEM_ID Substitute item identifier USAGE_QUANTITY Usage quantity for the substitute component ORGANIZATION_ID Organization identifier PRIORITY Priority code DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column 2-60 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier BILL_SEQUENCE_ID Bill sequence identifier MSC_ST_DEMANDS The staging table used by the collection program to validate and process data for table MSC_DEMANDS. Table 2–18 Parameter ORDER_PRIORITY DEMAND_ID INVENTORY_ITEM_ID ORGANIZATION_ID USING_ASSEMBLY_ITEM_ID MSC_DEMANDS Usage IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER x x x Required Derived Optional x x Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-61 .

Setting Up the ODS Load API Table 2–18 Parameter MSC_DEMANDS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER(15) NUMBER(15) VARCHAR2(30) VARCHAR2(30) DATE NUMBER NUMBER VARCHAR2(34) VARCHAR2(122) NUMBER NUMBER DATE VARCHAR2(62) VARCHAR2(240) NUMBER DATE NUMBER x x x x x x x x x x x x x x x x x x x x x x x x Required x x Derived Optional USING_ASSEMBLY_DEMAND_DATE USING_REQUIREMENT_QUANTITY ASSEMBLY_DEMAND_COMP_DATE DEMAND_TYPE DAILY_DEMAND_RATE ORIGINATION_TYPE SOURCE_ORGANIZATION_ID DISPOSITION_ID RESERVATION_ID DEMAND_SCHEDULE_NAME PROJECT_ID TASK_ID PLANNING_GROUP END_ITEM_UNIT_NUMBER SCHEDULE_DATE OPERATION_SEQ_NUM QUANTITY_ISSUED DEMAND_CLASS SALES_ORDER_NUMBER SALES_ORDER_PRIORITY FORECAST_PRIORITY MPS_DATE_REQUIRED PO_NUMBER WIP_ENTITY_NAME DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY 2-62 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–18 Parameter CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID REPETITIVE_SCHEDULE_ID WIP_ENTITY_ID SELLING_PRICE DMD_LATENESS_COST DMD_SATISFIED_DATE DMD_SPLIT_FLAG REQUEST_DATE ORDER_NUMBER WIP_STATUS_CODE WIP_SUPPLY_TYPE ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 MSC_DEMANDS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE VARCHAR2(240) NUMBER NUMBER VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) x x x x x x x x x x x x x x x x x x x x Required Derived x x x x x x x Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-63 .

Setting Up the ODS Load API Table 2–18 Parameter ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 SALES_ORDER_LINE_ID CONFIDENCE_PERCENTAGE BUCKET_TYPE BILL_ID MSC_DEMANDS Usage IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER NUMBER Required Derived Optional x x x x x x x x x x x ORDER_PRIORITY Order priority DEMAND_ID Demand identifier INVENTORY_ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier USING_ASSEMBLY_ITEM_ID Using assembly item identifier (item generates demand for dependent demands) USING_ASSEMBLY_DEMAND_DATE Demand date (due date) USING_REQUIREMENT_QUANTITY Required quantity 2-64 Oracle Manufacturing APIs and Open Interfaces Manual .

Rate–based demand(2) DAILY_DEMAND_RATE Repetitive demand rate ORIGINATION_TYPE Origin of the demand: Planned order.. SOURCE_ORGANIZATION_ID Source organization identifier DISPOSITION_ID Identifier reference to the supply generating the demand RESERVATION_ID Reservation identifier DEMAND_SCHEDULE_NAME Demand schedule name PROJECT_ID Project identifier to which the demand applies TASK_ID Task identifier to which the demand applies PLANNING_GROUP Planning group END_ITEM_UNIT_NUMBER End item unit number Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-65 . etc. hard reversation.Setting Up the ODS Load API ASSEMBLY_DEMAND_COMP_DATE Using assembly completion date DEMAND_TYPE Discrete Demand(1)..

Setting Up the ODS Load API SCHEDULE_DATE Schedule date OPERATION_SEQ_NUM Operation sequence number QUANTITY_ISSUED Quantity issued DEMAND_CLASS Demand class code SALES_ORDER_NUMBER Sales order number SALES_ORDER_PRIORITY Sales order priority FORECAST_PRIORITY Forecast priority MPS_DATE_REQUIRED MPS date required PO_NUMBER Purchase order number WIP_ENTITY_NAME Wip job name DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column 2-66 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier populated by the collection program REPETITIVE_SCHEDULE_ID Repetitive schedule identifier WIP_ENTITY_ID WIP job identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-67 .

Setting Up the ODS Load API SELLING_PRICE Selling price DMD_LATENESS_COST Demand lateness cost for independent demands DMD_SATISFIED_DATE Date demand is satisfied DMD_SPLIT_FLAG Demand split flag REQUEST_DATE Request date ORDER_NUMBER WIP entity name WIP_STATUS_CODE WIP job status code WIP_SUPPLY_TYPE WIP supply type ATTRIBUTE1 Descriptive flexfield segment ATTRIBUTE2 Descriptive flexfield segment ATTRIBUTE3 Descriptive flexfield segment ATTRIBUTE4 Descriptive flexfield segment 2-68 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ATTRIBUTE5 Descriptive flexfield segment ATTRIBUTE6 Descriptive flexfield segment ATTRIBUTE7 Descriptive flexfield segment ATTRIBUTE8 Descriptive flexfield segment ATTRIBUTE9 Descriptive flexfield segment ATTRIBUTE10 Descriptive flexfield segment ATTRIBUTE11 Descriptive flexfield segment ATTRIBUTE12 Descriptive flexfield segment ATTRIBUTE13 Descriptive flexfield segment ATTRIBUTE14 Descriptive flexfield segment ATTRIBUTE15 Descriptive flexfield segment SALES_ORDER_LINE_ID Sales order line identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-69 .

Table 2–19 Parameter DEMAND_CLASS MEANING DESCRIPTION FROM_DATE TO_DATE ENABLED_FLAG SR_INSTANCE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE ATTRIBUTE_CATEGORY Staging Table Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(30) VARCHAR2(80) VARCHAR2(250) DATE DATE NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(30) x x x x x x x x x x x x Required x x x x x Derived Optional 2-70 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API CONFIDENCE_PERCENTAGE Forecast confidence percentage BUCKET_TYPE Bucket type BILL_ID Forecast billing address identifier MSC_ST_DEMAND_CLASSES The staging table used by the collection program to validate and process data for demand classes.

Setting Up the ODS Load API Table 2–19 Parameter ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 DELETED_FLAG REFRESH_ID Staging Table Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER x x Required Derived Optional x x x x x x x x x x x x x x x DEMAND_CLASS NOT Demand class code MEANING NOT Demand class meaning DESCRIPTION Describe the demand class FROM_DATE Start date Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-71 .

Setting Up the ODS Load API TO_DATE End date ENABLED_FLAG Enabled flag SR_INSTANCE_ID NOT Source application instance identifier LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column 2-72 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ATTRIBUTE_CATEGORY Descriptive flexfield structure defining column ATTRIBUTE1 Descriptive flexfield segment ATTRIBUTE2 Descriptive flexfield segment ATTRIBUTE3 Descriptive flexfield segment ATTRIBUTE4 Descriptive flexfield segment ATTRIBUTE5 Descriptive flexfield segment ATTRIBUTE6 Descriptive flexfield segment ATTRIBUTE7 Descriptive flexfield segment ATTRIBUTE8 Descriptive flexfield segment ATTRIBUTE9 Descriptive flexfield segment ATTRIBUTE10 Descriptive flexfield segment ATTRIBUTE11 Descriptive flexfield segment Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-73 .

Setting Up the ODS Load API ATTRIBUTE12 Descriptive flexfield segment ATTRIBUTE13 Descriptive flexfield segment ATTRIBUTE14 Descriptive flexfield segment ATTRIBUTE15 Descriptive flexfield segment DELETED_FLAG Deleted flag REFRESH_ID Refresh identifier MSC_ST_DEPARTMENT_RESOURCES The staging table used by the collection program to validate and process data for table MSC_DEPARTMENT_RESOURCES. Table 2–20 Parameter ORGANIZATION_ID RESOURCE_ID RESOURCE_CODE DEPARTMENT_ID DEPARTMENT_CODE DEPARTMENT_CLASS LINE_FLAG OWNING_DEPARTMENT_ID CAPACITY_UNITS MAX_RATE MSC_DEPARTMENT_RESOURCES Usage IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(10) NUMBER VARCHAR2(10) VARCHAR2(10) VARCHAR2(1) NUMBER NUMBER NUMBER x x x x x x x Required x x x Derived Optional 2-74 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–20 Parameter MIN_RATE MSC_DEPARTMENT_RESOURCES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) VARCHAR2(240) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER NUMBER DATE x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x AGGREGATED_RESOURCE_ID AGGREGATED_RESOURCE_FLAG RESOURCE_GROUP_NAME RESOURCE_GROUP_CODE RESOURCE_BALANCE_FLAG BOTTLENECK_FLAG START_TIME STOP_TIME DEPARTMENT_DESCRIPTION RESOURCE_DESCRIPTION OVER_UTILIZED_PERCENT UNDER_UTILIZED_PERCENT RESOURCE_SHORTAGE_TYPE RESOURCE_EXCESS_TYPE USER_TIME_FENCE UTILIZATION EFFICIENCY RESOURCE_INCLUDE_FLAG CRITICAL_RESOURCE_FLAG RESOURCE_TYPE DISABLE_DATE LINE_DISABLE_DATE AVAILABLE_24_HOURS_FLAG CTP_FLAG DELETED_FLAG LAST_UPDATE_DATE Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-75 .

also holds line code DEPARTMENT_CLASS Department class 2-76 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API Table 2–20 Parameter LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID DEPT_OVERHEAD_COST RESOURCE_COST MSC_DEPARTMENT_RESOURCES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x Required Derived x x x x x x x x Optional RESOURCE_OVER_UTIL_COST ORGANIZATION_ID Organization identifier RESOURCE_ID Source application resource identifier RESOURCE_CODE Resource code DEPARTMENT_ID Source application department identifier or line identifier DEPARTMENT_CODE Department code.

Setting Up the ODS Load API LINE_FLAG Flag to indicate whether or not this resource is a line OWNING_DEPARTMENT_ID Owning department identifier CAPACITY_UNITS Resource capacity MAX_RATE Hourly minimum rate of production line MIN_RATE Hourly maximum rate of production line AGGREGATED_RESOURCE_ID Reference to aggregate resource. if aggregated AGGREGATED_RESOURCE_FLAG Yes/No flag to indicate whether this is an aggregated resource RESOURCE_GROUP_NAME Resource group name RESOURCE_GROUP_CODE Resource group code RESOURCE_BALANCE_FLAG Flag to indicate if the resource needs to load balanced BOTTLENECK_FLAG Flag to indicate if the resource is a known bottleneck START_TIME Start time of the line Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-77 .

Setting Up the ODS Load API STOP_TIME Stop time of the line DEPARTMENT_DESCRIPTION Describes of the line or department RESOURCE_DESCRIPTION Describes the resource OVER_UTILIZED_PERCENT Overutilization tolerance UNDER_UTILIZED_PERCENT Underutilization tolerance RESOURCE_SHORTAGE_TYPE Resource shortage type RESOURCE_EXCESS_TYPE Resource excess type USER_TIME_FENCE User time fence UTILIZATION Utilization EFFICIENCY Efficiency RESOURCE_INCLUDE_FLAG Resource include flag CRITICAL_RESOURCE_FLAG Critical resource flag 2-78 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API RESOURCE_TYPE Resource type DISABLE_DATE Disable date LINE_DISABLE_DATE Line disable date AVAILABLE_24_HOURS_FLAG Resource is available 24 hours or by shifts CTP_FLAG Flag indicating whether the department resource is used for ATP or not DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-79 .

Setting Up the ODS Load API PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier populated by the collection program DEPT_OVERHEAD_COST Department overhead cost RESOURCE_COST Resource cost RESOURCE_OVER_UTIL_COST Resource overutilization cost MSC_ST_DESIGNATORS The staging table used by the collection program to validate and process data for table MSC_DESIGNATORS. Table 2–21 Parameter DESIGNATOR_ID DESIGNATOR SR_DESIGNATOR ORGANIZATION_ID SR_ORGANIZATION_ID MSC_DESIGNATORS Usage IN IN IN IN IN Type NUMBER VARCHAR2(10) VARCHAR2(10) NUMBER NUMBER x x Required x x x Derived Optional 2-80 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–21 Parameter MPS_RELIEF INVENTORY_ATP_FLAG DESCRIPTION DISABLE_DATE DEMAND_CLASS ORGANIZATION_SELECTION PRODUCTION MSC_DESIGNATORS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(50) DATE VARCHAR2(34) NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) x x x x x x x x x x x x x x x x x x x Required x x x x x x x x Derived Optional RECOMMENDATION_RELEASE DESIGNATOR_TYPE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID CONSUME_FORECAST UPDATE_TYPE FORWARD_UPDATE_TIME_FENCE BACKWARD_UPDATE_TIME_FENCE OUTLIER_UPDATE_PERCENTAGE FORECAST_SET_ID Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-81 .

Setting Up the ODS Load API Table 2–21 Parameter CUSTOMER_ID SHIP_ID BILL_ID BUCKET_TYPE MSC_DESIGNATORS Usage IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER Required Derived Optional x x x x DESIGNATOR_ID Designator identifier DESIGNATOR Source application schedule name SR_DESIGNATOR Source designator identifier ORGANIZATION_ID Organization identifier SR_ORGANIZATION_ID Source organization identifier MPS_RELIEF Flag to indicate whether MPS relief performed against this designator INVENTORY_ATP_FLAG ATP supply flag DESCRIPTION Description of the this designator DISABLE_DATE Designator disable date 2-82 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API DEMAND_CLASS Demand class code ORGANIZATION_SELECTION Single/Multiple organizations PRODUCTION Production flag RECOMMENDATION_RELEASE Planned order release flag DESIGNATOR_TYPE Schedule type DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-83 .

Setting Up the ODS Load API PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh number populated by the collection program CONSUME_FORECAST Consume forecast flag UPDATE_TYPE Forecast update type code FORWARD_UPDATE_TIME_FENCE Forward consumption days BACKWARD_UPDATE_TIME_FENCE Backward consumption days OUTLIER_UPDATE_PERCENTAGE Forecast outlier update percentage FORECAST_SET_ID Forecast set identifier CUSTOMER_ID Customer identifier 2-84 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API SHIP_ID Forecast ship code identifier BILL_ID Forecast billing address identifier BUCKET_TYPE Forecast bucket type – days. Table 2–22 Parameter FROM_ORGANIZATION_ID TO_ORGANIZATION_ID SHIP_METHOD TIME_UOM_CODE INSTRANSIT_TIME DEFAULT_FLAG FROM_LOCATION_ID TO_LOCATION_ID AVAILABILITY_DATE WEIGHT_CAPACITY WEIGHT_UOM VOLUME_CAPACITY VOLUME_UOM COST_PER_WEIGHT_UNIT COST_PER_VOLUME_UNIT INTRANSIT_TIME DELETED_FLAG MSC_INTERORG_SHIP_METHODS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(30) VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(3) NUMBER VARCHAR2(3) NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-85 . weeks or periods MSC_ST_INTERORG_SHIP_METHODS The staging table used by the collection program to validate and process data for table MSC_INTERORG_SHIP_METHODS.

Setting Up the ODS Load API Table 2–22 Parameter LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_INTERORG_SHIP_METHODS Usage IN IN IN Type DATE NUMBER DATE NUMBER IN IN IN IN IN IN IN IN IN NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER x x x Required Derived x x x x x x x x x x Optional TRANSPORT_CAP_OVER_UTIL_COST SR_INSTANCE_ID2 FROM_ORGANIZATION_ID Organization identifier for the origin organization TO_ORGANIZATION_ID Organization identifier for the destination organization’ SHIP_METHOD Ship method TIME_UOM_CODE Unit of measure used to specify the intransit lead time INSTRANSIT_TIME Instransit time DEFAULT_FLAG Flag to indicate if this is a default ship method 2-86 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API FROM_LOCATION_ID Location identifier of the origin location TO_LOCATION_ID Location identifier of the destination location AVAILABILITY_DATE Availability date WEIGHT_CAPACITY Weight capacity of this ship method WEIGHT_UOM Weight unit of measure VOLUME_CAPACITY Weight capacity VOLUME_UOM Volume unit of measure COST_PER_WEIGHT_UNIT Cost per weight unit COST_PER_VOLUME_UNIT Cost per volume unit INTRANSIT_TIME Intransit time DELETED_FLAG Deleted flag LAST_UPDATE_DATE Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-87 .

Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier of the source org TRANSPORT_CAP_OVER_UTIL_COST Transport cap over utilized cost SR_INSTANCE_ID2 Source application instance identifier of the destination org 2-88 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–23 Parameter INVENTORY_ITEM_ID ORGANIZATION_ID SR_CATEGORY_SET_ID SR_CATEGORY_ID CATEGORY_NAME DESCRIPTION DISABLE_DATE SUMMARY_FLAG ENABLED_FLAG START_DATE_ACTIVE END_DATE_ACTIVE CATEGORY_SET_NAME DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_ITEM_CATEGORIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER VARCHAR2(163) VARCHAR2(240) DATE VARCHAR2(1) VARCHAR2(1) DATE DATE VARCHAR2(30) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-89 .Setting Up the ODS Load API MSC_ST_ITEM_CATEGORIES The staging table used by the collection program to validate and process data for table MSC_ITEM_CATEGORIES.

Setting Up the ODS Load API INVENTORY_ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier SR_CATEGORY_SET_ID Category set identifier from source application SR_CATEGORY_ID Category identifier from source application CATEGORY_NAME Category name DESCRIPTION Description DISABLE_DATE Disable date SUMMARY_FLAG Summary flag ENABLED_FLAG Enabled flag START_DATE_ACTIVE Start date END_DATE_ACTIVE End date CATEGORY_SET_NAME Category set name 2-90 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API DELETED_FLAG Deleted flag LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-91 .

Table 2–24 Parameter INVENTORY_ITEM_ID ORGANIZATION_ID SUPPLIER_ID SUPPLIER_SITE_ID USING_ORGANIZATION_ID ASL_ID PROCESSING_LEAD_TIME MINIMUM_ORDER_QUANTITY FIXED_LOT_MULTIPLE DELIVERY_CALENDAR_CODE VENDOR_NAME VENDOR_SITE_CODE SUPPLIER_CAP_OVER_UTIL_COST DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID MSC_ITEM_SUPPLIERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(14) VARCHAR2(80) VARCHAR2(15) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER x x x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional 2-92 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API MSC_ST_ITEM_SUPPLIERS The staging table used by the collection program to validate and process data for table MSC_ITEM_SUPPLIERS.

Setting Up the ODS Load API Table 2–24 Parameter SR_INSTANCE_ID2 REFRESH_ID MSC_ITEM_SUPPLIERS Usage IN IN IN Type NUMBER NUMBER VARCHAR2(25) Required x x x Derived Optional PURCHASING_UNIT_OF_MEASURE INVENTORY_ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier SUPPLIER_ID Supplier identifier SUPPLIER_SITE_ID Supplier site identifier USING_ORGANIZATION_ID Using organization identifier ASL_ID ASL identifier PROCESSING_LEAD_TIME Processing lead time MINIMUM_ORDER_QUANTITY Minimum order quantity FIXED_LOT_MULTIPLE Fixed lot multiple DELIVERY_CALENDAR_CODE Delivery calendar code Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-93 .

Setting Up the ODS Load API VENDOR_NAME Supplier name VENDOR_SITE_CODE Supplier site code SUPPLIER_CAP_OVER_UTIL_COST Supplier cap over util cost DELETED_FLAG Deleted flag LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column 2-94 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier SR_INSTANCE_ID2 Source application instance identifier of using organization REFRESH_ID Refresh identifier PURCHASING_UNIT_OF_MEASURE Purchasing unit of measure MSC_ST_LOCATION_ASSOCIATIONS The staging table used by the collection program to validate and process data for table MSC_LOCATION_ASSOCIATIONS. Table 2–25 Parameter LOCATION_ID SR_INSTANCE_ID LOCATION_CODE ORGANIZATION_ID PARTNER_ID PARTNER_SITE_ID SR_TP_ID SR_TP_SITE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY MSC_LOCATION_ASSOCIATIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(20) NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER x x x x x x Required x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-95 .

Setting Up the ODS Load API Table 2–25 Parameter LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE ORGANIZATION_ID REFRESH_ID PARTNER_TYPE MSC_LOCATION_ASSOCIATIONS Usage IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER x Required Derived x x x x x x x Optional LOCATION_ID Location identifier SR_INSTANCE_ID Source application instance identifier LOCATION_CODE Location code ORGANIZATION_ID Organization identifier PARTNER_ID Partner identifier PARTNER_SITE_ID Partner site identifier SR_TP_ID Trading partner identifier from source application SR_TP_SITE_ID Trading partner site identifier from source application 2-96 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column ORGANIZATION_ID Organization identifier REFRESH_ID Refresh identifier PARTNER_TYPE Partner type Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-97 .

Table 2–26 Parameter ORGANIZATION_ID DEPARTMENT_ID RESOURCE_ID SHIFT_NUM SHIFT_DATE FROM_TIME TO_TIME CAPACITY_UNITS SIMULATION_SET AGGREGATE_RESOURCE_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_NET_RESOURCE_AVAIL Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional DEPARTMENT_ID Department identifier (–1 for lines) 2-98 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API MSC_ST_NET_RESOURCE_AVAIL The staging table used by the collection program to validate and process data for table MSC_NET_RESOURCE_AVAIL.

if resource aggregated (denormalized column) DELETED_FLAG Yes/No flag indicating whether the row will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-99 .Setting Up the ODS Load API RESOURCE_ID Resource identifier SHIFT_NUM Shift number SHIFT_DATE Calendar date FROM_TIME Shift start time TO_TIME Shift end time CAPACITY_UNITS Number of units available during the time interval SIMULATION_SET Simulation set identifier AGGREGATE_RESOURCE_ID Reference to aggregate resource.

Table 2–27 Parameter ORGANIZATION_ID OPERATION_SEQUENCE_ID COMPONENT_SEQUENCE_ID BILL_SEQUENCE_ID ROUTING_SEQUENCE_ID MSC_OPERATION_COMPONENTS Usage IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER Required x x x x x Derived Optional 2-100 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier populate by the collection program MSC_ST_OPERATION_COMPONENTS The staging table used by the collection program to validate and process data for table MSC_OPERATION_COMPONENTS.

Setting Up the ODS Load API Table 2–27 Parameter DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_OPERATION_COMPONENTS Usage IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required x x x x x x x x x x x Derived Optional ORGANIZATION_ID Organization identifier OPERATION_SEQUENCE_ID Operation sequence identifier COMPONENT_SEQUENCE_ID Component sequence identifier BILL_SEQUENCE_ID Bill sequence identifier ROUTING_SEQUENCE_ID Routing sequence identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS to be deleted Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-101 .

2-102 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh number populated by the collection program SR_INSTANCE_ID Source application instance identifier MSC_ST_OPERATION_RESOURCES The staging table used by the collection program to validate and process data for table MSC_OPERATION_RESOURCES.

Setting Up the ODS Load API Table 2–28 Parameter ROUTING_SEQUENCE_ID RESOURCE_TYPE OPERATION_SEQUENCE_ID RESOURCE_SEQ_NUM RESOURCE_ID ALTERNATE_NUMBER PRINCIPAL_FLAG BASIS_TYPE RESOURCE_USAGE MAX_RESOURCE_UNITS RESOURCE_UNITS UOM_CODE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_OPERATION_RESOURCES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x x Required x x Derived Optional ROUTING_SEQUENCE_ID Routing sequence identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-103 .

Setting Up the ODS Load API RESOURCE_TYPE Resource type OPERATION_SEQUENCE_ID Operation sequence identifier RESOURCE_SEQ_NUM Resource sequence number RESOURCE_ID Resource identifier ALTERNATE_NUMBER Alternate number PRINCIPAL_FLAG Flag to indicate whether the resource is the principal resource BASIS_TYPE Basis type RESOURCE_USAGE Resource usage MAX_RESOURCE_UNITS Maximum number of resource units consumed by this operation resource RESOURCE_UNITS Operation resource units (capacity) UOM_CODE Unit of measure DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted 2-104 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-105 .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh number populated by the collection program MSC_ST_OPERATION_RESOURCE_SEQS The staging table used by the collection program to validate and process data for table MSC_OPERATION_RESOURCE_SEQS.

Setting Up the ODS Load API Table 2–29 Parameter ROUTING_SEQUENCE_ID OPERATION_SEQUENCE_ID RESOURCE_SEQ_NUM SCHEDULE_FLAG MSC_OPERATION_RESOURCE_SEQS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x x x x Derived Optional RESOURCE_OFFSET_PERCENT DEPARTMENT_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID ROUTING_SEQUENCE_ID Routing sequence identifier OPERATION_SEQUENCE_ID Operation sequence identifier RESOURCE_SEQ_NUM Resource sequence number 2-106 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API SCHEDULE_FLAG Schedule RESOURCE_OFFSET_PERCENT Resource offset percent DEPARTMENT_ID Department identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-107 .

Setting Up the ODS Load API PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh number populated by the collection program MSC_ST_PARAMETERS The staging table used by the collection program to validate and process data for table MSC_PARAMETERS. Table 2–30 Parameter ORGANIZATION_ID DEMAND_TIME_FENCE_FLAG PLANNING_TIME_FENCE_FLAG OPERATION_SCHEDULE_TYPE CONSIDER_WIP CONSIDER_PO SNAPSHOT_LOCK PLAN_SAFETY_STOCK CONSIDER_RESERVATIONS PART_INCLUDE_TYPE DEFAULT_ABC_ASSIGNMENT_ GROUP PERIOD_TYPE RESCHED_ASSUMPTION PLAN_DATE_DEFAULT_TYPE INCLUDE_REP_SUPPLY_DAYS MSC_PARAMETERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(40) NUMBER NUMBER NUMBER NUMBER x Required x x x x x x x x x x Derived Optional x x x x 2-108 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–30 Parameter INCLUDE_MDS_DAYS DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID REPETITIVE_HORIZON1 REPETITIVE_HORIZON2 REPETITIVE_BUCKET_SIZE1 REPETITIVE_BUCKET_SIZE2 REPETITIVE_BUCKET_SIZE3 REPETITIVE_ANCHOR_DATE MSC_PARAMETERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER(38) NUMBER(38) NUMBER(38) NUMBER(38) NUMBER(38) DATE x x Required Derived Optional x x x x x x x x x x x x x x x x x ORGANIZATION_ID DEMAND_TIME_FENCE_FLAG Flag to indicate whether to consider demand time fence PLANNING_TIME_FENCE_FLAG IS Flag to indicate whether to consider planning time fence Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-109 .

Setting Up the ODS Load API OPERATION_SCHEDULE_TYPE Operation schedule type CONSIDER_WIP Flag to indicate whether to consider WIP CONSIDER_PO Flag to indicate whether to consider PO SNAPSHOT_LOCK Flag to indicate whether the snapshot should try to lock tables PLAN_SAFETY_STOCK Flag to indicate whether to plan safety stock CONSIDER_RESERVATIONS Flag to indicate whether to plan material reservations PART_INCLUDE_TYPE Flag to indicate which part to include DEFAULT_ABC_ASSIGNMENT_GROUP VARCHAR2(40) PERIOD_TYPE Calculate periods based on work dates or calendar dates RESCHED_ASSUMPTION Reschedule assumption PLAN_DATE_DEFAULT_TYPE Plan date default type INCLUDE_REP_SUPPLY_DAYS Flag to indicate whether to include Supply days 2-110 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API INCLUDE_MDS_DAYS Flag to indicate whether to include MDS days DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-111 .

Table 2–31 Parameter NAME DISPLAY_NAME PARTNER_ID PARTNER_SITE_ID PARTNER_TYPE EMAIL FAX ENABLED_FLAG MSC_PARTNER_CONTACTS Usage IN IN IN IN IN IN IN IN Type VARCHAR2(100) VARCHAR2(240) NUMBER NUMBER NUMBER VARCHAR2(240) VARCHAR2(240) VARCHAR2(1) x x x x Required Derived Optional x x x x 2-112 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API REFRESH_ID Refresh identifier populated by the collection program REPETITIVE_HORIZON1 First repetitive horizon REPETITIVE_HORIZON2 Second repetitive horizon REPETITIVE_BUCKET_SIZE1 First repetitive bucket size REPETITIVE_BUCKET_SIZE2 Second repetitive bucket size REPETITIVE_BUCKET_SIZE3 Third repetitive bucket size REPETITIVE_ANCHOR_DATE Repetitive anchor date MSC_ST_PARTNER_CONTACTS The staging table used by the collection program to validate and process data for table MSC_PARTNER_CONTACTS.

or buyer EMAIL Partner’s email address Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-113 .Setting Up the ODS Load API Table 2–31 Parameter DELETED_FLAG REFRESH_ID SR_INSTANCE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE MSC_PARTNER_CONTACTS Usage IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE x x x x x x x x x x Required x x Derived Optional NAME Partner’s user name DISPLAY_NAME Partner’s display name PARTNER_ID Partner Identifier PARTNER_SITE_ID Partner site identifier PARTNER_TYPE Indicate type of partner. supplier. customer.

Setting Up the ODS Load API FAX Partner’s FAX number ENABLED_FLAG Flag indicating contact is enabled DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted REFRESH_ID Refresh ID populated by the pull program SR_INSTANCE_ID Source application instance identifier LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column 2-114 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column MSC_ST_PERIOD_START_DATES The staging table used by the collection program to validate and process data for table MSC_PERIOD_START_DATES. Table 2–32 Parameter CALENDAR_CODE EXCEPTION_SET_ID PERIOD_START_DATE PERIOD_SEQUENCE_NUM PERIOD_NAME NEXT_DATE PRIOR_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_PERIOD_START_DATES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER DATE NUMBER VARCHAR2(3) DATE DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-115 .

Setting Up the ODS Load API CALENDAR_CODE Calendar code EXCEPTION_SET_ID Exception set unique identifier PERIOD_START_DATE Period start date PERIOD_SEQUENCE_NUM Sequence number PERIOD_NAME Period Name (depends on quarterly calendar type chosen) NEXT_DATE Next calendar date corresponding to next sequence number PRIOR_DATE Period start date DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column 2-116 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–33 Parameter ORGANIZATION_ID SR_INSTANCE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN MSC_PLANNERS Usage IN IN IN IN IN IN IN Type NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER Required x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-117 .Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier populated by the collection program SR_INSTANCE_ID Source application instance identifier MSC_ST_PLANNERS The staging table used by the collection program to validate and process data for table MSC_PLANNERS.

Setting Up the ODS Load API Table 2–33 Parameter DESCRIPTION DISABLE_DATE ATTRIBUTE_CATEGORY ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE MSC_PLANNERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(50) DATE VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER DATE VARCHAR2(240) NUMBER NUMBER x x x x x x x Required Derived Optional x x x x x x x x x x x x x x x x x x ELECTRONIC_MAIL_ADDRESS EMPLOYEE_ID CURRENT_EMPLOYEE_FLAG 2-118 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–33 Parameter REFRESH_ID DELETED_FLAG USER_NAME MSC_PLANNERS Usage IN IN IN Type NUMBER NUMBER VARCHAR2(100) Required Derived Optional x x x ORGANIZATION_ID Organization identifier SR_INSTANCE_ID Source application instance identifier LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column DESCRIPTION Describe the planner DISABLE_DATE Date on which the planner record is disable ATTRIBUTE_CATEGORY Descriptive flexfield structure defining column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-119 .

Setting Up the ODS Load API ATTRIBUTE1 Descriptive flexfield segment ATTRIBUTE2 Descriptive flexfield segment ATTRIBUTE3 Descriptive flexfield segment ATTRIBUTE4 Descriptive flexfield segment ATTRIBUTE5 Descriptive flexfield segment ATTRIBUTE6 Descriptive flexfield segment ATTRIBUTE7 Descriptive flexfield segment ATTRIBUTE8 Descriptive flexfield segment ATTRIBUTE9 Descriptive flexfield segment ATTRIBUTE10 Descriptive flexfield segment ATTRIBUTE11 Descriptive flexfield segment ATTRIBUTE12 Descriptive flexfield segment 2-120 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ATTRIBUTE13 Descriptive flexfield segment ATTRIBUTE14 Descriptive flexfield segment ATTRIBUTE15 Descriptive flexfield segment REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column ELECTRONIC_MAIL_ADDRESS Electronic mail address EMPLOYEE_ID Employee identifier assigned to the planner CURRENT_EMPLOYEE_FLAG Flag indicate whether the planner is current employee REFRESH_ID Refresh identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-121 .

Table 2–34 Parameter PROCESS_SEQUENCE_ID ITEM_ID ORGANIZATION_ID EFFECTIVITY_DATE DISABLE_DATE MINIMUM_QUANTITY MAXIMUM_QUANTITY PREFERENCE ROUTING_SEQUENCE_ID BILL_SEQUENCE_ID TOTAL_PRODUCT_CYCLE_TIME ITEM_PROCESS_COST LINE_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_PROCESS_EFFECTIVITY Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x Required x x x x x x x x x x x x x Derived Optional 2-122 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API USER_NAME MSC_ST_PROCESS_EFFECTIVITY The staging table used by the collection program to validate and process data for table MSC_PROCESS_EFFECTIVITY.

Setting Up the ODS Load API Table 2–34 Parameter PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID PRIMARY_LINE_FLAG PRODUCTION_LINE_RATE MSC_PROCESS_EFFECTIVITY Usage IN IN IN IN IN IN Type DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x Required Derived x x Optional LOAD_DISTRIBUTION_PRIORITY PROCESS_SEQUENCE_ID Process sequence identifier ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier EFFECTIVITY_DATE Effectivity date of the process DISABLE_DATE Disable date of the process MINIMUM_QUANTITY Minimum quantity for which the process can be used to produce the item MAXIMUM_QUANTITY Maximum quantity for which the process can be used to produce the item PREFERENCE Preference ROUTING_SEQUENCE_ID Routing sequence identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-123 .

Setting Up the ODS Load API BILL_SEQUENCE_ID Bill sequence identifier TOTAL_PRODUCT_CYCLE_TIME Total time that an assembly takes along the primary path in the operation network calculated by flow manufacturing ITEM_PROCESS_COST Cost of alternate BOM and routing LINE_ID Line identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column 2-124 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–35 Parameter PROJECT_ID ORGANIZATION_ID PLANNING_GROUP COSTING_GROUP_ID WIP_ACCT_CLASS_CODE SEIBAN_NUMBER_FLAG PROJECT_NAME PROJECT_NUMBER MSC_PROJECTS Usage IN IN IN IN IN IN IN IN Type NUMBER(15) NUMBER(15) VARCHAR2(30) NUMBER VARCHAR2(10) NUMBER(1) VARCHAR2(30) VARCHAR2(25) x x x Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-125 .Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier populated by the collection program SR_INSTANCE_ID Source application instance identifier PRIMARY_LINE_FLAG Flag indicating whether the line is used for lead time calculations PRODUCTION_LINE_RATE Number of assemblies which run down the line per hour LOAD_DISTRIBUTION_PRIORITY MSC_ST_PROJECTS The staging table used by the collection program to validate and process data for table MSC_PROJECTS.

Setting Up the ODS Load API Table 2–35 Parameter MSC_PROJECTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(25) VARCHAR2(250) DATE DATE NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER VARCHAR2(100) x x x x x x x x x x x x x x Required Derived Optional x x x x x PROJECT_NUMBER_SORT_ORDER PROJECT_DESCRIPTION START_DATE COMPLETION_DATE OPERATING_UNIT DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MATERIAL_ACCOUNT MANAGER_CONTACT PROJECT_ID Project identifier or Seiban identifier ORGANIZATION_ID Organization identifier PLANNING_GROUP Planning group code 2-126 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API COSTING_GROUP_ID Costing group identifier WIP_ACCT_CLASS_CODE Default WIP accounting class assigned to this project SEIBAN_NUMBER_FLAG Flag indicates whether project_id identifies a project or a seiban PROJECT_NAME Project name PROJECT_NUMBER Project number or seiban number PROJECT_NUMBER_SORT_ORDER Sort order PROJECT_DESCRIPTION Describe the project START_DATE Project start date COMPLETION_DATE Project completion date OPERATING_UNIT Operating unit DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-127 .

Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MATERIAL_ACCOUNT Material account 2-128 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API MANAGER_CONTACT MSC_ST_PROJECT_TASKS The staging table used by the collection program to validate and process data for table MSC_PROJECT_TASKS. Table 2–36 Parameter PROJECT_ID TASK_ID ORGANIZATION_ID TASK_NUMBER TASK_NAME DESCRIPTION MANAGER START_DATE END_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MANAGER_CONTACT MSC_PROJECT_TASKS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER(15) NUMBER(15) NUMBER VARCHAR2(25) VARCHAR2(20) VARCHAR2(250) VARCHAR2(240) DATE DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(100) x x x x x x x x x x x x x Required x x x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-129 .

Setting Up the ODS Load API PROJECT_ID Project identifier TASK_ID Task identifier ORGANIZATION_ID Organization identifier TASK_NUMBER Task number TASK_NAME Task name DESCRIPTION Task description MANAGER Manager START_DATE Task start date END_DATE Task end date DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column 2-130 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-131 .Setting Up the ODS Load API CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier populated by the collection program MANAGER_CONTACT MSC_ST_RESERVATIONS The staging table used by the collection program to validate and process data for table MSC_RESERVATIONS.

Setting Up the ODS Load API Table 2–37 Parameter INVENTORY_ITEM_ID ORGANIZATION_ID TRANSACTION_ID PARENT_DEMAND_ID DISPOSITION_ID REQUIREMENT_DATE REVISION RESERVED_QUANTITY DISPOSITION_TYPE SUBINVENTORY RESERVATION_TYPE DEMAND_CLASS AVAILABLE_TO_MRP RESERVATION_FLAG PROJECT_ID TASK_ID PLANNING_GROUP DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_RESERVATIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(3) NUMBER NUMBER VARCHAR2(10) NUMBER VARCHAR2(34) NUMBER NUMBER NUMBER(15) NUMBER(15) VARCHAR2(30) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional 2-132 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–37 Parameter PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_RESERVATIONS Usage IN IN IN Type DATE NUMBER NUMBER x x Required Derived x Optional INVENTORY_ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier TRANSACTION_ID Unique identifier generated from the source application instance PARENT_DEMAND_ID Parent demand identifier DISPOSITION_ID Disposition identifier REQUIREMENT_DATE Date of need REVISION Inventory item revision code RESERVED_QUANTITY Quantity reserved DISPOSITION_TYPE Disposition type SUBINVENTORY Subinventory identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-133 .

Setting Up the ODS Load API RESERVATION_TYPE Reservation type DEMAND_CLASS Demand class code AVAILABLE_TO_MRP Available-to-MRP flag RESERVATION_FLAG Reservation flag PROJECT_ID Project identifier TASK_ID Task identifier PLANNING_GROUP Planning group code DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column 2-134 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–38 Parameter DEPARTMENT_ID RESOURCE_ID SHIFT_NUM FROM_DATE TO_DATE FROM_TIME TO_TIME MSC_RESOURCE_CHANGES Usage IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER Required x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-135 .Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier populated by the collection program MSC_ST_RESOURCE_CHANGES The staging table used by the collection program to validate and process data for table MSC_RESOURCE_CHANGES.

Setting Up the ODS Load API Table 2–38 Parameter CAPACITY_CHANGE SIMULATION_SET ACTION_TYPE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_RESOURCE_CHANGES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(10) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x Required Derived Optional x DEPARTMENT_ID Department identifier (-1 for lines) RESOURCE_ID Resource identifier SHIFT_NUM Shift number FROM_DATE Capacity exception from date TO_DATE Capacity exception to date 2-136 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API FROM_TIME Capacity exception from time TO_TIME Capacity exception to time CAPACITY_CHANGE Capacity change SIMULATION_SET Simulation set identifier ACTION_TYPE Type of capacity modification DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-137 .

Table 2–39 Parameter GROUP_CODE MEANING DESCRIPTION FROM_DATE TO_DATE ENABLED_FLAG SR_INSTANCE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN MSC_ST_RESOURCE_CHANGES Usage IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(30) VARCHAR2(80) VARCHAR2(250) DATE DATE NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER x x x x x x x Required x x x x x Derived Optional 2-138 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier populated by the collection program SR_INSTANCE_ID Source application instance identifier MSC_ST_RESOURCE_GROUPS The staging table used by the collection program to validate and process data for table MSC_ST_RESOURCE_CHANGES.

Setting Up the ODS Load API Table 2–39 Parameter REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE ATTRIBUTE_CATEGORY ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 DELETED_FLAG REFRESH_ID MSC_ST_RESOURCE_CHANGES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER x x Required Derived x x x x x x x x x x x x x x x x x x x x Optional GROUP_CODE Resource group code MEANING Meaning Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-139 .

Setting Up the ODS Load API DESCRIPTION Resource group description FROM_DATE Resource start date TO_DATE Resource end date ENABLED_FLAG Flag indicates whether resource group is enable SR_INSTANCE_ID Source application instance identifier LAST_UPDATE_DATE Standard Who Column LAST_UPDATED_BY Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column 2-140 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column ATTRIBUTE_CATEGORY Descriptive flexfield structure defining column ATTRIBUTE1 Descriptive flexfield segment ATTRIBUTE2 Descriptive flexfield segment ATTRIBUTE3 Descriptive flexfield segment ATTRIBUTE4 Descriptive flexfield segment ATTRIBUTE5 Descriptive flexfield segment ATTRIBUTE6 Descriptive flexfield segment ATTRIBUTE7 Descriptive flexfield segment ATTRIBUTE8 Descriptive flexfield segment ATTRIBUTE9 Descriptive flexfield segment Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-141 .

Setting Up the ODS Load API ATTRIBUTE10 Descriptive flexfield segment ATTRIBUTE11 Descriptive flexfield segment ATTRIBUTE12 Descriptive flexfield segment ATTRIBUTE13 Descriptive flexfield segment ATTRIBUTE14 Descriptive flexfield segment ATTRIBUTE15 Descriptive flexfield segment DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted REFRESH_ID Refresh identifier MSC_ST_RESOURCE_REQUIREMENTS The staging table used by the collection program to validate and process data for table MSC_RESOURCE_REQUIREMENTS. Table 2–40 Parameter DEPARTMENT_ID RESOURCE_ID ORGANIZATION_ID INVENTORY_ITEM_ID SUPPLY_ID MSC_RESOURCE_REQUIREMENTS Usage IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER Required x x x x x Derived Optional 2-142 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–40 Parameter OPERATION_SEQ_NUM OPERATION_SEQUENCE_ID RESOURCE_SEQ_NUM START_DATE MSC_RESOURCE_REQUIREMENTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(34) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x OPERATION_HOURS_REQUIRED HOURS_EXPENDED DEMAND_CLASS BASIS_TYPE ASSIGNED_UNITS END_DATE WIP_JOB_TYPE SCHEDULED_COMPLETION_ DATE SCHEDULED_QUANTITY QUANTITY_COMPLETED DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-143 .

Setting Up the ODS Load API Table 2–40 Parameter WIP_ENTITY_ID STD_OP_CODE SUPPLY_TYPE MSC_RESOURCE_REQUIREMENTS Usage IN IN IN Type NUMBER VARCHAR2(4) NUMBER Required Derived Optional x x x DEPARTMENT_ID Department identifier RESOURCE_ID Resource identifier ORGANIZATION_ID Organization identifier INVENTORY_ITEM_ID Inventory item identifier SUPPLY_ID Supply identifier OPERATION_SEQ_NUM Operation sequence number OPERATION_SEQUENCE_ID Operation sequence identifier RESOURCE_SEQ_NUM Resource sequence number START_DATE Start date of the resource requirement OPERATION_HOURS_REQUIRED Operation hours required 2-144 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API HOURS_EXPENDED Hours expended DEMAND_CLASS Demand class code BASIS_TYPE Basis type ASSIGNED_UNITS Assigned units END_DATE End date of the resource requirement WIP_JOB_TYPE WIP job type SCHEDULED_COMPLETION_DATE Schedule completion date SCHEDULED_QUANTITY Quantity scheduled QUANTITY_COMPLETED Quantity completed DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-145 .

Setting Up the ODS Load API CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier WIP_ENTITY_ID WIP job identifier STD_OP_CODE Standard OP code SUPPLY_TYPE Supply type 2-146 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–41 Parameter DEPARTMENT_ID RESOURCE_ID SHIFT_NUM DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_RESOURCE_SHIFTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required x x x x x x x x x x x x x x Derived Optional DEPARTMENT_ID Department identifier RESOURCE_ID Resource identifier SHIFT_NUM Shift number DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-147 .Setting Up the ODS Load API MSC_ST_RESOURCE_SHIFTS The staging table used by the collection program to validate and process data for table MSC_RESOURCE_SHIFTS.

Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_ROUTINGS The staging table used by the collection program to validate and process data for table MSC_ROUTINGS. 2-148 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–42 Parameter ROUTING_SEQUENCE_ID ASSEMBLY_ITEM_ID ROUTING_TYPE ROUTING_COMMENT PRIORITY ALTERNATE_ROUTING_ DESIGNATOR PROJECT_ID TASK_ID LINE_ID UOM_CODE CFM_ROUTING_FLAG CTP_FLAG ROUTING_QUANTITY MSC_ROUTINGS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER VARCHAR2(10) NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER x x x x x x x x Required x x x x x x x x x x x x x x x x x x Derived Optional COMPLETION_SUBINVENTORY COMPLETION_LOCATOR_ID COMMON_ROUTING_SEQUENCE_ID MIXED_MODEL_MAP_FLAG TOTAL_PRODUCT_CYCLE_TIME ORGANIZATION_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-149 .

Null for primary routing PROJECT_ID Project identifier TASK_ID Task identifier LINE_ID Manufacturing line identifier 2-150 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API Table 2–42 Parameter PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_ROUTINGS Usage IN IN IN IN IN Type NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x Optional ROUTING_SEQUENCE_ID Routing sequence identifier ASSEMBLY_ITEM_ID Assembly item identifier ROUTING_TYPE Routing type ROUTING_COMMENT Routing comment PRIORITY Routing priority ALTERNATE_ROUTING_DESIGNATOR Name of the alternate routing.

Setting Up the ODS Load API UOM_CODE Unit of measure code CFM_ROUTING_FLAG CFM routing flag CTP_FLAG CTP flag ROUTING_QUANTITY Routing quantity COMPLETION_SUBINVENTORY Completion subinventory COMPLETION_LOCATOR_ID Completion locator identifier COMMON_ROUTING_SEQUENCE_ID Common routing sequence identifier MIXED_MODEL_MAP_FLAG Mix model map flag TOTAL_PRODUCT_CYCLE_TIME Total product cycle time ORGANIZATION_ID Organization identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-151 .

Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_ROUTING_OPERATIONS The staging table used by the collection program to validate and process data for table MSC_ROUTING_OPERATIONS. 2-152 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–43 Parameter OPERATION_SEQUENCE_ID ROUTING_SEQUENCE_ID OPERATION_SEQ_NUM OPERATION_DESCRIPTION EFFECTIVITY_DATE DISABLE_DATE FROM_UNIT_NUMBER TO_UNIT_NUMBER OPTION_DEPENDENT_FLAG OPERATION_TYPE MSC_ROUTING_OPERATIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER VARCHAR2(240) DATE DATE VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) VARCHAR2(4) NUMBER NUMBER DATE NUMBER x x x x x x x x x x x x x x x x x x x x x x Required x x x x Derived Optional MINIMUM_TRANSFER_QUANTITY YIELD DEPARTMENT_ID DEPARTMENT_CODE OPERATION_LEAD_TIME_ PERCENT CUMULATIVE_YIELD REVERSE_CUMULATIVE_YIELD NET_PLANNING_PERCENT TEAR_DOWN_DURATION SETUP_DURATION UOM_CODE STANDARD_OPERATION_CODE ORGANIZATION_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-153 .

Setting Up the ODS Load API Table 2–43 Parameter CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_ROUTING_OPERATIONS Usage IN IN IN IN IN IN IN IN IN Type DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x x x x x Optional OPERATION_SEQUENCE_ID Operation sequence identifier ROUTING_SEQUENCE_ID Routing sequence identifier OPERATION_SEQ_NUM Operation sequence number OPERATION_DESCRIPTION Operation description EFFECTIVITY_DATE Date operation is effective DISABLE_DATE End of effectivity FROM_UNIT_NUMBER Effective from this unit number 2-154 Oracle Manufacturing APIs and Open Interfaces Manual .

MINIMUM_TRANSFER_QUANTITY Minimum operation transfer quantity YIELD Process yield at this operation DEPARTMENT_ID Department identifier DEPARTMENT_CODE Department code OPERATION_LEAD_TIME_PERCENT Indicates the amount of overlap its lead time has with the parent lead time CUMULATIVE_YIELD Cumulative process yield from the beginning of routing to this operation REVERSE_CUMULATIVE_YIELD Cumulative process yield from the end of routing to comparable operation NET_PLANNING_PERCENT Cumulative planning percents derived from the operation network TEAR_DOWN_DURATION Duration of the tear down for this operation Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-155 . or Event.Setting Up the ODS Load API TO_UNIT_NUMBER Effective up to this unit number OPTION_DEPENDENT_FLAG Flag to indicate whether this operation option dependent OPERATION_TYPE Indicate operation type: Process. Line.

Setting Up the ODS Load API SETUP_DURATION Duration of the set-up UOM_CODE Unit of measure code STANDARD_OPERATION_CODE Code of the standard operation on which this operation is based ORGANIZATION_ID Organization identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column 2-156 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–44 Parameter ORGANIZATION_ID INVENTORY_ITEM_ID PERIOD_START_DATE SAFETY_STOCK_QUANTITY UPDATED STATUS DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID MSC_SAFETY_STOCKS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER x x x x x x x x Required x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-157 .Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SAFETY_STOCKS The staging table used by the collection program to validate and process data for table MSC_SAFETY_STOCKS.

Setting Up the ODS Load API Table 2–44 Parameter PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_SAFETY_STOCKS Usage IN IN IN IN Type NUMBER DATE NUMBER NUMBER x x Required Derived x x Optional ORGANIZATION_ID Organization identifier INVENTORY_ITEM_ID Inventory item identifier PERIOD_START_DATE Period start date SAFETY_STOCK_QUANTITY Safety stock quantity UPDATED Updated flag STATUS Status flag DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column 2-158 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SALES_ORDERS The staging table used by the collection program to validate and process data for table MSC_SAFETY_STOCKS. Table 2–45 Parameter INVENTORY_ITEM_ID ORGANIZATION_ID DEMAND_ID MSC_SAFETY_STOCKS Usage IN IN IN Type NUMBER NUMBER NUMBER Required x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-159 .

Setting Up the ODS Load API Table 2–45 Parameter PRIMARY_UOM_QUANTITY RESERVATION_TYPE RESERVATION_QUANTITY DEMAND_SOURCE_TYPE MSC_SAFETY_STOCKS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(34) DATE VARCHAR2(40) VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(122) VARCHAR2(100) x x x x x x x x x x x x x x x x x x x x x x x x Required x x x Derived Optional DEMAND_SOURCE_HEADER_ID COMPLETED_QUANTITY SUBINVENTORY DEMAND_CLASS REQUIREMENT_DATE DEMAND_SOURCE_LINE DEMAND_SOURCE_DELIVERY DEMAND_SOURCE_NAME PARENT_DEMAND_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID SALES_ORDER_NUMBER SALESREP_CONTACT 2-160 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–45 Parameter ORDERED_ITEM_ID AVAILABLE_TO_MRP CUSTOMER_ID SHIP_TO_SITE_USE_ID BILL_TO_SITE_USE_ID LINE_NUM TERRITORY_ID UPDATE_SEQ_NUM DEMAND_TYPE PROJECT_ID TASK_ID PLANNING_GROUP END_ITEM_UNIT_NUMBER DEMAND_PRIORITY MSC_SAFETY_STOCKS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(1) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) NUMBER Required Derived Optional x x x x x x x x x x x x x x INVENTORY_ITEM_ID Inventory item identifier ORGANIZATION_ID Organization identifier DEMAND_ID Unique identifier of a demand row from source application instance PRIMARY_UOM_QUANTITY Primary UOM quantity RESERVATION_TYPE Code for type of reservation Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-161 .

Setting Up the ODS Load API RESERVATION_QUANTITY Total quantity reserved expressed in primary unit of measure DEMAND_SOURCE_TYPE Demand source type DEMAND_SOURCE_HEADER_ID Header ID for the source of the demand COMPLETED_QUANTITY Completed quantity SUBINVENTORY Subinventory code DEMAND_CLASS Demand class code REQUIREMENT_DATE Planned ship date for summary demand DEMAND_SOURCE_LINE Line id of demand source DEMAND_SOURCE_DELIVERY For Sales Order demand. Line id of Sales order line detail row (SO_LINE_ DETAILS.LINE_DETAIL_I D) from source application instance DEMAND_SOURCE_NAME Identifier for user-defined Source Type PARENT_DEMAND_ID Parent demand identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted 2-162 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh number populated by the collection program SR_INSTANCE_ID Source application instance identifier SALES_ORDER_NUMBER Sales order number Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-163 .

Setting Up the ODS Load API SALESREP_CONTACT ORDERED_ITEM_ID Ordered item identifier AVAILABLE_TO_MRP Available to MRP flag CUSTOMER_ID Customer identifier SHIP_TO_SITE_USE_ID Ship to identifier of the sales order BILL_TO_SITE_USE_ID Bill to identifier of the sales order LINE_NUM Sales order line number TERRITORY_ID Territory identifier of the sales order UPDATE_SEQ_NUM Update sequence number DEMAND_TYPE Demand type PROJECT_ID Project identifier TASK_ID Task identifier PLANNING_GROUP Planning group 2-164 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API END_ITEM_UNIT_NUMBER Unit number identifier DEMAND_PRIORITY Demand priority MSC_ST_SHIFT_DATES The staging table used by the collection program to validate and process data for table MSC_SHIFT_DATES. Table 2–46 Parameter CALENDAR_CODE EXCEPTION_SET_ID SHIFT_NUM SHIFT_DATE SEQ_NUM NEXT_SEQ_NUM PRIOR_SEQ_NUM NEXT_DATE PRIOR_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_SHIFT_DATES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER NUMBER DATE NUMBER NUMBER NUMBER DATE DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-165 .

Setting Up the ODS Load API Table 2–46 Parameter PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_SHIFT_DATES Usage IN IN IN Type DATE NUMBER NUMBER x Required Derived x x Optional CALENDAR_CODE Calendar code EXCEPTION_SET_ID Exception set identifier SHIFT_NUM Calendar shift number SHIFT_DATE Calendar date SEQ_NUM Sequence number for shift date (only for working dates) NEXT_SEQ_NUM Next sequence number for calendar date (working day) PRIOR_SEQ_NUM Prior sequence number for calendar date (working day) NEXT_DATE Next date corresponding to next sequence number PRIOR_DATE Prior date corresponding to prior sequence number DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted 2-166 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-167 .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_SHIFT_EXCEPTIONS The staging table used by the collection program to validate and process data for table MSC_SHIFT_EXCEPTIONS.

Setting Up the ODS Load API Table 2–47 Parameter CALENDAR_CODE SHIFT_NUM EXCEPTION_SET_ID EXCEPTION_DATE EXCEPTION_TYPE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_SHIFT_EXCEPTIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER NUMBER DATE NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required x x x x x x x x x x x x x x x x Derived Optional CALENDAR_CODE Calendar code SHIFT_NUM Calendar shift number EXCEPTION_SET_ID Exception set identifier EXCEPTION_DATE Exception date 2-168 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API EXCEPTION_TYPE Exception type DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column REFRESH_ID Refresh identifier Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-169 .

Table 2–48 Parameter CALENDAR_CODE SHIFT_NUM FROM_TIME TO_TIME DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REFRESH_ID SR_INSTANCE_ID MSC_SHIFT_TIMES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(14) NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x Required x x x x x x x x x x x x x x x Derived Optional CALENDAR_CODE Calendar code SHIFT_NUM Shift number 2-170 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier MSC_ST_SHIFT_TIMES The staging table used by the collection program to validate and process data for table MSC_SHIFT_TIMES.

Setting Up the ODS Load API FROM_TIME Shift start time TO_TIME Shift end time DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-171 .

Table 2–49 Parameter ORGANIZATION_ID SIMULATION_SET DESCRIPTION USE_IN_WIP_FLAG DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_SIMULATION_SETS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(10) VARCHAR2(50) NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x x Derived Optional ORGANIZATION_ID Organization identifier 2-172 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API REFRESH_ID Refresh identifier SR_INSTANCE_ID Source application instance identifier MSC_ST_SIMULATION_SETS The staging table used by the collection program to validate and process data for table MSC_SIMULATION_SETS.

Setting Up the ODS Load API SIMULATION_SET Simulation set DESCRIPTION Describe simulation set USE_IN_WIP_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted DELETED_FLAG LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-173 .

Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SOURCING_HISTORY The staging table used by the collection program to validate and process data for table MSC_SOURCING_HISTORY. Table 2–50 Parameter INVENTORY_ITEM_ID ORGANIZATION_ID SR_INSTANCE_ID SOURCING_RULE_ID SOURCE_ORG_ID SOURCE_SR_INSTANCE_ID SUPPLIER_ID SUPPLIER_SITE_ID HISTORICAL_ALLOCATION REFRESH_NUMBER LAST_CALCULATED_DATE LAST_UPDATED_BY LAST_UPDATE_DATE CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID MSC_SOURCING_HISTORY Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE DATE NUMBER NUMBER NUMBER x x x x x x x x x Required x x x x x x x x Derived Optional 2-174 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–50 Parameter PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE Table 2–51 Index Name MSC_SOURCING_HISTORY Usage IN IN IN Index Index Type UNIQUE Sequence 1 2 3 4 Column Name SOURCING_RULE_ ID INVENTORY_ ITEM_ID ORGANIZATION_ ID SR_INSTANCE_ID Type NUMBER NUMBER DATE Required Derived x x x Optional MSC_ST_SOURCING_HISTORY_U1 INVENTORY_ITEM_ID Inventory Item Id ORGANIZATION_ID Organization Id SR_INSTANCE_ID sr instance Id SOURCING_RULE_ID Sourcing Rule/Bill of Distribution identifier SOURCE_ORG_ID Source Org Id SOURCE_SR_INSTANCE_ID source org sr instance Id Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-175 .

Setting Up the ODS Load API SUPPLIER_ID Supplier identifier SUPPLIER_SITE_ID Supplier site identifier HISTORICAL_ALLOCATION Historical Allocation REFRESH_NUMBER Refresh Number LAST_CALCULATED_DATE Last Calculated Date LAST_UPDATED_BY Standard Who Column LAST_UPDATE_DATE Standard Who Column CREATION_DATE Standard Who Column CREATED_BY Standard Who Column LAST_UPDATE_LOGIN Standard Who Column REQUEST_ID Concurrent Who Column PROGRAM_APPLICATION_ID Concurrent Who Column 2-176 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_ID Concurrent Who Column PROGRAM_UPDATE_DATE Concurrent Who Column MSC_ST_SOURCING_RULES The staging table used by the collection program to validate and process data for table MSC_SOURCING_RULES. Table 2–52 Parameter SOURCING_RULE_ID SR_SOURCING_RULE_ID SOURCING_RULE_NAME ORGANIZATION_ID DESCRIPTION STATUS SOURCING_RULE_TYPE PLANNING_ACTIVE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_SOURCING_RULES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(30) NUMBER VARCHAR2(80) NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x Required Derived Optional x Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-177 .

Setting Up the ODS Load API Table 2–52 Parameter PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_SOURCING_RULES Usage IN IN IN Type DATE NUMBER NUMBER x x Required Derived x Optional SOURCING_RULE_ID Sourcing rule / Bill of Distribution identifier SR_SOURCING_RULE_ID Sourcing rule / Bill of Distribution identifier from source application SOURCING_RULE_NAME Sourcing rule / Bill of Distribution name ORGANIZATION_ID Organization identifier DESCRIPTION Describe Sourcing rule / Bill of Distribution STATUS Status flag SOURCING_RULE_TYPE Flag indicates whether the row is sourcing rule or bill of distribution PLANNING_ACTIVE Flag indicates whether the row is planning active DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column 2-178 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-179 .Setting Up the ODS Load API LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SR_ASSIGNMENTS The staging table used by the collection program to validate and process data for table MSC_SR_ASSIGNMENTS.

Setting Up the ODS Load API Table 2–53 Parameter ASSIGNMENT_ID SR_ASSIGNMENT_ID ASSIGNMENT_SET_ID ASSIGNMENT_TYPE SOURCING_RULE_ID SOURCING_RULE_TYPE INVENTORY_ITEM_ID PARTNER_ID SHIP_TO_SITE_ID CUSTOMER_NAME SITE_USE_CODE LOCATION ORGANIZATION_ID CATEGORY_ID CATEGORY_NAME CATEGORY_SET_IDENTIFIER CATEGORY_SET_NAME DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE MSC_SR_ASSIGNMENTS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(50) VARCHAR2(30) VARCHAR2(40) NUMBER NUMBER VARCHAR2(163) NUMBER VARCHAR2(30) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE x x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x 2-180 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–53 Parameter SR_INSTANCE_ID REFRESH_ID MSC_SR_ASSIGNMENTS Usage IN IN IN Type NUMBER NUMBER NUMBER Required x x x Derived Optional SR_ASSIGNMENT_INSTANCE_ID ASSIGNMENT_ID Unique identifier for the row SR_ASSIGNMENT_ID Unique identifier for the row from the source application ASSIGNMENT_SET_ID Assignment set unique identifier ASSIGNMENT_TYPE Assignment set type SOURCING_RULE_ID Sourcing rule / Bill of Distribution identifier SOURCING_RULE_TYPE Sourcing rule type INVENTORY_ITEM_ID Inventory item identifier PARTNER_ID Trading partner identifier SHIP_TO_SITE_ID Ship to site identifier CUSTOMER_NAME Customer name Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-181 .

Setting Up the ODS Load API SITE_USE_CODE Site use code LOCATION Location ORGANIZATION_ID Organization identifier CATEGORY_ID Category identifier CATEGORY_NAME Category name CATEGORY_SET_IDENTIFIER Category set identifier CATEGORY_SET_NAME Category set name DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column 2-182 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier SR_ASSIGNMENT_INSTANCE_ID Source application instance identifier for the source assignment record MSC_ST_SR_RECEIPT_ORG The staging table used by the collection program to validate and process data for table MSC_SR_RECEIPT_ORG. Table 2–54 Parameter SR_RECEIPT_ID SR_SR_RECEIPT_ORG SOURCING_RULE_ID RECEIPT_PARTNER_ID RECEIPT_PARTNER_SITE_ID MSC_SR_RECEIPT_ORG Usage IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER x x x Required x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-183 .

Setting Up the ODS Load API Table 2–54 Parameter EFFECTIVE_DATE DISABLE_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID RECEIPT_ORG_INSTANCE_ID MSC_SR_RECEIPT_ORG Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type DATE DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER x x x x x x x x x x x x x Required x x Derived Optional SR_RECEIPT_ID Unique identifier for a row generated at planning server SR_SR_RECEIPT_ORG Receiving org from source application instance SOURCING_RULE_ID Sourcing rule / Bill of Distribution identifier RECEIPT_PARTNER_ID Trading partner unique identifier RECEIPT_PARTNER_SITE_ID Trading partner site unique identifier 2-184 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API EFFECTIVE_DATE Date of effectivity DISABLE_DATE Disable date DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-185 .

Table 2–55 Parameter SR_SOURCE_ID SR_SR_SOURCE_ID SR_RECEIPT_ID SOURCE_ORGANIZATION_ID SOURCE_PARTNER_ID SOURCE_PARTNER_SITE_ID SECONDARY_INVENTORY SOURCE_TYPE ALLOCATION_PERCENT RANK VENDOR_NAME VENDOR_SITE_CODE SHIP_METHOD DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE MSC_SR_SOURCE_ORG Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER NUMBER NUMBER VARCHAR2(80) VARCHAR2(15) VARCHAR2(30) NUMBER DATE NUMBER DATE x x x x x x x x x x x x x x x x Required Derived Optional x 2-186 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier RECEIPT_ORG_INSTANCE_ID Source application instance identifier associated with the receiving org MSC_ST_SR_SOURCE_ORG The staging table used by the collection program to validate and process data for table MSC_SR_SOURCE_ORG.

Setting Up the ODS Load API Table 2–55 Parameter CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID SOURCE_ORG_INSTANCE_ID MSC_SR_SOURCE_ORG Usage IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER x x x Required Derived x x x x x x Optional SR_SOURCE_ID Unique identifier for a row generated at planning server SR_SR_SOURCE_ID Unique identifier for the row generated at the source application SR_RECEIPT_ID SR receipt unique identifier SOURCE_ORGANIZATION_ID Source organization identifier SOURCE_PARTNER_ID Source trading partner identifier SOURCE_PARTNER_SITE_ID Source trading partner site identifier SECONDARY_INVENTORY Secondary inventory code (not currently used) Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-187 .

Setting Up the ODS Load API SOURCE_TYPE Source type ALLOCATION_PERCENT Percent of supply allocated to this source RANK Rank of source VENDOR_NAME Supplier name VENDOR_SITE_CODE Supplier site code SHIP_METHOD Ship method DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column 2-188 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–56 Parameter ORGANIZATION_ID SUB_INVENTORY_CODE DESCRIPTION DISABLE_DATE NETTING_TYPE DEMAND_CLASS PROJECT_ID MSC_SUB_INVENTORIES Usage IN IN IN IN IN IN IN Type NUMBER VARCHAR2(10) VARCHAR2(50) DATE NUMBER VARCHAR2(34) NUMBER(15) Required x x x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-189 .Setting Up the ODS Load API REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier associated with the sr source org record REFRESH_ID Refresh identifier SOURCE_ORG_INSTANCE_ID Source application instance identifier associated with the source organization MSC_ST_SUB_INVENTORIES The staging table used by the collection program to validate and process data for table MSC_SUB_INVENTORIES.

Setting Up the ODS Load API Table 2–56 Parameter TASK_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID INVENTORY_ATP_CODE MSC_SUB_INVENTORIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER(15) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER x x x x x x x x x x x x x Required Derived Optional x ORGANIZATION_ID Organization identifier SUB_INVENTORY_CODE Sub-inventory code DESCRIPTION Describe sub-inventory DISABLE_DATE Date on which the row is no longer in used NETTING_TYPE Netting type 2-190 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API DEMAND_CLASS Demand class code PROJECT_ID Project identifier TASK_ID Task identifier DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-191 .

Table 2–57 Parameter SUPPLIER_ID SUPPLIER_SITE_ID ORGANIZATION_ID USING_ORGANIZATION_ID INVENTORY_ITEM_ID VENDOR_NAME VENDOR_SITE_CODE FROM_DATE TO_DATE CAPACITY DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY MSC_SUPPLIER_CAPACITIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(80) VARCHAR2(15) DATE DATE NUMBER NUMBER DATE NUMBER DATE NUMBER x x x x x x x x x x x x x Required x x Derived Optional 2-192 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier INVENTORY_ATP_CODE Inventory ATP code MSC_ST_SUPPLIER_CAPACITIES The staging table used by the collection program to validate and process data for table MSC_SUPPLIER_CAPACITIES.

Setting Up the ODS Load API Table 2–57 Parameter LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_SUPPLIER_CAPACITIES Usage IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x x x Optional SUPPLIER_ID Supplier identifier SUPPLIER_SITE_ID Supplier site identifier ORGANIZATION_ID Organization identifier USING_ORGANIZATION_ID Using organization identifier INVENTORY_ITEM_ID Inventory item identifier VENDOR_NAME Supplier name VENDOR_SITE_CODE Supplier site code FROM_DATE First date of valid capacity Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-193 .

Setting Up the ODS Load API TO_DATE Last date of valid capacity CAPACITY Capacity DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column 2-194 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SUPPLIER_FLEX_FENCES The staging table used by the collection program to validate and process data for table MSC_SUPPLIER_FLEX_FENCES. Table 2–58 Parameter SUPPLIER_ID SUPPLIER_SITE_ID ORGANIZATION_ID USING_ORGANIZATION_ID INVENTORY_ITEM_ID VENDOR_NAME VENDOR_SITE_CODE FENCE_DAYS TOLERANCE_PERCENTAGE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID MSC_SUPPLIER_FLEX_FENCES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(80) VARCHAR2(15) NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x Required x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-195 .

Setting Up the ODS Load API Table 2–58 Parameter PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_SUPPLIER_FLEX_FENCES Usage IN IN IN Type DATE NUMBER NUMBER x x Required Derived x Optional SUPPLIER_ID Supplier identifier SUPPLIER_SITE_ID Supplier site identifier ORGANIZATION_ID Organization identifier USING_ORGANIZATION_ID Using organization identifier INVENTORY_ITEM_ID Inventory item identifier VENDOR_NAME Supplier name VENDOR_SITE_CODE Supplier site code FENCE_DAYS Number of advance days TOLERANCE_PERCENTAGE Capacity tolerance percentage DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted 2-196 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-197 .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_SUPPLIES The staging table used by the collection program to validate and process data for table MSC_SUPPLIES.

Setting Up the ODS Load API Table 2–59 Parameter PLAN_ID TRANSACTION_ID INVENTORY_ITEM_ID ORGANIZATION_ID SCHEDULE_DESIGNATOR_ID SOURCE_SCHEDULE_NAME REVISION UNIT_NUMBER NEW_SCHEDULE_DATE OLD_SCHEDULE_DATE NEW_WIP_START_DATE OLD_WIP_START_DATE MSC_SUPPLIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(10) VARCHAR2(30) DATE DATE DATE DATE DATE DATE DATE DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x FIRST_UNIT_COMPLETION_DATE LAST_UNIT_COMPLETION_DATE FIRST_UNIT_START_DATE LAST_UNIT_START_DATE DISPOSITION_ID DISPOSITION_STATUS_TYPE ORDER_TYPE SUPPLIER_ID NEW_ORDER_QUANTITY OLD_ORDER_QUANTITY NEW_ORDER_PLACEMENT_DATE OLD_ORDER_PLACEMENT_DATE RESCHEDULE_DAYS RESCHEDULE_FLAG SCHEDULE_COMPRESS_DAYS 2-198 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–59 Parameter NEW_PROCESSING_DAYS PURCH_LINE_NUM QUANTITY_IN_PROCESS IMPLEMENTED_QUANTITY FIRM_PLANNED_TYPE FIRM_QUANTITY FIRM_DATE MSC_SUPPLIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(34) DATE NUMBER NUMBER VARCHAR2(10) VARCHAR2(240) DATE NUMBER VARCHAR2(3) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(10) x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x x x IMPLEMENT_DEMAND_CLASS IMPLEMENT_DATE IMPLEMENT_QUANTITY IMPLEMENT_FIRM IMPLEMENT_WIP_CLASS_CODE IMPLEMENT_JOB_NAME IMPLEMENT_DOCK_DATE IMPLEMENT_STATUS_CODE IMPLEMENT_UOM_CODE IMPLEMENT_LOCATION_ID IMPLEMENT_SOURCE_ORG_ID IMPLEMENT_SUPPLIER_ID IMPLEMENT_SUPPLIER_SITE_ID IMPLEMENT_AS RELEASE_STATUS LOAD_TYPE PROCESS_SEQ_ID SCO_SUPPLY_FLAG ALTERNATE_BOM_DESIGNATOR ALTERNATE_ROUTING_DESIGNATOR Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-199 .

Setting Up the ODS Load API Table 2–59 Parameter OPERATION_SEQ_NUM SOURCE MSC_SUPPLIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER(15) NUMBER(15) VARCHAR2(30) NUMBER(15) NUMBER(15) NUMBER NUMBER VARCHAR2(10) VARCHAR2(10) VARCHAR2(30) NUMBER VARCHAR2(1) NUMBER Required Derived Optional x x x x x x x x x x x x x x x x x x x x x x x x x x x BY_PRODUCT_USING_ASSY_ID SOURCE_ORGANIZATION_ID SOURCE_SR_INSTANCE_ID SOURCE_SUPPLIER_SITE_ID SOURCE_SUPPLIER_ID SHIP_METHOD WEIGHT_CAPACITY_USED VOLUME_CAPACITY_USED SOURCE_SUPPLY_SCHEDULE_NAME NEW_SHIP_DATE NEW_DOCK_DATE LINE_ID PROJECT_ID TASK_ID PLANNING_GROUP IMPLEMENT_PROJECT_ID IMPLEMENT_TASK_ID IMPLEMENT_SCHEDULE_GROUP_ID IMPLEMENT_BUILD_SEQUENCE IMPLEMENT_ALTERNATE_BOM IMPLEMENT_ALTERNATE_ROUTING IMPLEMENT_UNIT_NUMBER IMPLEMENT_LINE_ID RELEASE_ERRORS NUMBER1 2-200 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–59 Parameter SOURCE_ITEM_ID ORDER_NUMBER SCHEDULE_GROUP_ID SCHEDULE_GROUP_NAME BUILD_SEQUENCE WIP_ENTITY_ID WIP_ENTITY_NAME WO_LATENESS_COST MSC_SUPPLIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(240) NUMBER VARCHAR2(30) NUMBER NUMBER VARCHAR2(240) NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(10) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER VARCHAR2(10) NUMBER NUMBER x x x x x x x x x x x x x x Required Derived Optional x x x x x x x x x x x x x IMPLEMENT_PROCESSING_DAYS DELIVERY_PRICE LATE_SUPPLY_DATE LATE_SUPPLY_QTY SUBINVENTORY_CODE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID SCHEDULE_DESIGNATOR VENDOR_ID VENDOR_SITE_ID Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-201 .

Setting Up the ODS Load API Table 2–59 Parameter SUPPLIER_SITE_ID PURCH_ORDER_ID EXPECTED_SCRAP_QTY QTY_SCRAPPED QTY_COMPLETED LOT_NUMBER EXPIRATION_DATE WIP_STATUS_CODE DAILY_RATE LOCATOR_ID SERIAL_NUMBER REFRESH_ID LOCATOR_NAME ONHAND_SOURCE_TYPE SR_MTL_SUPPLY_ID DEMAND_CLASS FROM_ORGANIZATION_ID WIP_SUPPLY_TYPE PO_LINE_ID MSC_SUPPLIES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) DATE NUMBER NUMBER NUMBER VARCHAR2(30) NUMBER VARCHAR2(204) NUMBER NUMBER VARCHAR2(34) NUMBER NUMBER NUMBER Required Derived Optional x x x x x x x x x x x x x x x PLAN_ID Plan identifier TRANSACTION_ID Transaction unique identifier INVENTORY_ITEM_ID Inventory item identifier 2-202 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API ORGANIZATION_ID Organization identifier SCHEDULE_DESIGNATOR_ID Schedule designator identifier SOURCE_SCHEDULE_NAME Source schedule name REVISION Inventory item revision code UNIT_NUMBER Unit number NEW_SCHEDULE_DATE End date of the supply (completion date of first unit) OLD_SCHEDULE_DATE Old schedule date NEW_WIP_START_DATE New WIP schedule start date OLD_WIP_START_DATE Old WIP schedule start date FIRST_UNIT_COMPLETION_DATE First unit completion date for recommended repetitive schedules LAST_UNIT_COMPLETION_DATE Last unit completion date for recommended repetitive schedules FIRST_UNIT_START_DATE First unit start date for repetitive schedule Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-203 .

SUPPLIER_ID Supplier identifier NEW_ORDER_QUANTITY Supply quantity OLD_ORDER_QUANTITY Old order quantity NEW_ORDER_PLACEMENT_DATE New order placement date OLD_ORDER_PLACEMENT_DATE Old order placement date RESCHEDULE_DAYS Different between old and new schedule dates RESCHEDULE_FLAG Flag indicating if this row been rescheduled SCHEDULE_COMPRESS_DAYS Schedule compress days 2-204 Oracle Manufacturing APIs and Open Interfaces Manual .. etc. purchase order.Setting Up the ODS Load API LAST_UNIT_START_DATE Last unit start date for repetitive schedule DISPOSITION_ID Identifier which references to source of supply DISPOSITION_STATUS_TYPE Disposition type code ORDER_TYPE Specifies type of order: planned order..

Setting Up the ODS Load API NEW_PROCESSING_DAYS Repetitive schedule processing days PURCH_LINE_NUM Purchase order line number (for purchase order) QUANTITY_IN_PROCESS Quantity being processed by the WIP/PO interface processes IMPLEMENTED_QUANTITY Planned order implemented quantity FIRM_PLANNED_TYPE Flag indicating whether the order is firm FIRM_QUANTITY Firm quantity FIRM_DATE Firm date IMPLEMENT_DEMAND_CLASS Implement demand class IMPLEMENT_DATE Implement due date IMPLEMENT_QUANTITY Planned order implemented quantity IMPLEMENT_FIRM Implement firm flag IMPLEMENT_WIP_CLASS_CODE Implement WIP class code Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-205 .

Setting Up the ODS Load API IMPLEMENT_JOB_NAME Implement job name IMPLEMENT_DOCK_DATE Implement dock date IMPLEMENT_STATUS_CODE Implement status code IMPLEMENT_UOM_CODE Implement unit of measure code IMPLEMENT_LOCATION_ID Implement location identifier IMPLEMENT_SOURCE_ORG_ID Implement source organization identifier IMPLEMENT_SUPPLIER_ID Implement supplier identifier IMPLEMENT_SUPPLIER_SITE_ID Implement supplier site identifier IMPLEMENT_AS Implement order type RELEASE_STATUS Release status code LOAD_TYPE Load program to execute PROCESS_SEQ_ID Process sequence identifier 2-206 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API SCO_SUPPLY_FLAG Flag to indicate if supply was suggested by SCO ALTERNATE_BOM_DESIGNATOR Alternate BOM designator ALTERNATE_ROUTING_DESIGNATOR Alternate routing designator OPERATION_SEQ_NUM Operation sequence number SOURCE BY_PRODUCT_USING_ASSY_ID SOURCE_ORGANIZATION_ID Source organization identifier SOURCE_SR_INSTANCE_ID Source org instance identifier SOURCE_SUPPLIER_SITE_ID Source supplier site identifier SOURCE_SUPPLIER_ID Source supplier identifier SHIP_METHOD Ship method WEIGHT_CAPACITY_USED Weight capacity used VOLUME_CAPACITY_USED Volume capacity used Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-207 .

Setting Up the ODS Load API SOURCE_SUPPLY_SCHEDULE_NAME Source supply schedule name NEW_SHIP_DATE New ship date NEW_DOCK_DATE New suggested dock date LINE_ID Manufacturing line identifier PROJECT_ID Project identifier TASK_ID Task identifier PLANNING_GROUP Planning group code IMPLEMENT_PROJECT_ID Implement project identifier IMPLEMENT_TASK_ID Implement task identifier IMPLEMENT_SCHEDULE_GROUP_ID Implement schedule group identifier IMPLEMENT_BUILD_SEQUENCE Implement build sequence for the planned order to be implemented as a discrete job IMPLEMENT_ALTERNATE_BOM Implement alternate BOM designator 2-208 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API IMPLEMENT_ALTERNATE_ROUTING Implement alternate routing IMPLEMENT_UNIT_NUMBER Implement unit number IMPLEMENT_LINE_ID Implement line identifier RELEASE_ERRORS NUMBER1 SOURCE_ITEM_ID Source item identifier ORDER_NUMBER Order number SCHEDULE_GROUP_ID Schedule group identifier SCHEDULE_GROUP_NAME Schedule group name BUILD_SEQUENCE Build Sequence for the Planned Order WIP_ENTITY_ID WIP entity identifier WIP_ENTITY_NAME WIP entity name WO_LATENESS_COST Work order lateness cost Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-209 .

Setting Up the ODS Load API IMPLEMENT_PROCESSING_DAYS Implement processing days DELIVERY_PRICE Supply unit price for purchasing supply LATE_SUPPLY_DATE Supply date for the shadow part of the split supplies LATE_SUPPLY_QTY Shadow supply quantity SUBINVENTORY_CODE Sub-inventory code DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column 2-210 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier SCHEDULE_DESIGNATOR Schedule designator VENDOR_ID Supplier identifier VENDOR_SITE_ID Supplier site identifier SUPPLIER_SITE_ID Supplier site identifier PURCH_ORDER_ID Purchase order identifier EXPECTED_SCRAP_QTY Expected scrap qty QTY_SCRAPPED Current job scrapped units QTY_COMPLETED Current job quantity completed Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-211 .

Setting Up the ODS Load API LOT_NUMBER Lot number for on-hand quantities EXPIRATION_DATE Expiration date WIP_STATUS_CODE WIP job status code DAILY_RATE Daily rate for recommended repetitive schedules LOCATOR_ID Locator identifier SERIAL_NUMBER Serial number REFRESH_ID Refresh identifier LOCATOR_NAME Locator name ONHAND_SOURCE_TYPE Onhand source type SR_MTL_SUPPLY_ID Supply identifier from the source DEMAND_CLASS Demand class code FROM_ORGANIZATION_ID From organization identifier 2-212 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–60 Parameter ORGANIZATION_ID SR_ORGANIZATION_ID INVENTORY_ITEM_ID SR_INVENTORY_ITEM_ID ITEM_NAME LOTS_EXPIRATION LOT_CONTROL_CODE SHRINKAGE_RATE FIXED_DAYS_SUPPLY FIXED_ORDER_QUANTITY FIXED_LOT_MULTIPLIER MINIMUM_ORDER_QUANTITY MAXIMUM_ORDER_QUANTITY ROUNDING_CONTROL_TYPE PLANNING_TIME_FENCE_DAYS DEMAND_TIME_FENCE_DAYS RELEASE_TIME_FENCE_CODE RELEASE_TIME_FENCE_DAYS DESCRIPTION MSC_SYSTEM_ITEMS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER VARCHAR2(40) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) x x x x x x x x x x x x x x x x Required x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-213 .Setting Up the ODS Load API WIP_SUPPLY_TYPE WIP supply type PO_LINE_ID Purchase order line identifier MSC_ST_SYSTEM_ITEMS The staging table used by the collection program to validate and process data for table MSC_SYSTEM_ITEMS.

Setting Up the ODS Load API Table 2–60 Parameter IN_SOURCE_PLAN REVISION SR_CATEGORY_ID CATEGORY_NAME ABC_CLASS_ID ABC_CLASS_NAME MRP_PLANNING_CODE FIXED_LEAD_TIME VARIABLE_LEAD_TIME MSC_SYSTEM_ITEMS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(3) NUMBER VARCHAR2(200) NUMBER VARCHAR2(40) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER NUMBER VARCHAR2(3) VARCHAR2(3) NUMBER NUMBER NUMBER VARCHAR2(1) NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x Required x x x x x x Derived Optional PREPROCESSING_LEAD_TIME POSTPROCESSING_LEAD_TIME FULL_LEAD_TIME CUMULATIVE_TOTAL_LEAD_TIME CUM_MANUFACTURING_LEAD_TIME UOM_CODE UNIT_WEIGHT UNIT_VOLUME WEIGHT_UOM VOLUME_UOM PRODUCT_FAMILY_ID ATP_RULE_ID MRP_CALCULATE_ATP_FLAG ATP_COMPONENTS_FLAG BUILT_IN_WIP_FLAG PURCHASING_ENABLED_FLAG PLANNING_MAKE_BUY_CODE REPETITIVE_TYPE 2-214 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–60 Parameter STANDARD_COST CARRYING_COST ORDER_COST DMD_LATENESS_COST SS_PENALTY_COST MSC_SYSTEM_ITEMS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(1) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(240) VARCHAR2(10) VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x x x Required Derived Optional x x x x x x x x x x SUPPLIER_CAP_OVERUTIL_COST LIST_PRICE AVERAGE_DISCOUNT END_ASSEMBLY_PEGGING_FLAG END_ASSEMBLY_PEGGING FULL_PEGGING ENGINEERING_ITEM_FLAG WIP_SUPPLY_TYPE MRP_SAFETY_STOCK_CODE MRP_SAFETY_STOCK_PERCENT SAFETY_STOCK_BUCKET_DAYS INVENTORY_USE_UP_DATE BUYER_NAME PLANNER_CODE PLANNING_EXCEPTION_SET EXCESS_QUANTITY EXCEPTION_SHORTAGE_DAYS EXCEPTION_EXCESS_DAYS EXCEPTION_OVERPROMISED_DAYS REPETITIVE_VARIANCE_DAYS BASE_ITEM_ID BOM_ITEM_TYPE Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-215 .

Setting Up the ODS Load API Table 2–60 Parameter ATO_FORECAST_CONTROL ORGANIZATION_CODE EFFECTIVITY_CONTROL MSC_SYSTEM_ITEMS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(7) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(1) NUMBER NUMBER NUMBER VARCHAR2(1) NUMBER(9) x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x ACCEPTABLE_EARLY_DELIVERY INVENTORY_PLANNING_CODE INVENTORY_TYPE ACCEPTABLE_RATE_INCREASE ACCEPTABLE_RATE_DECREASE PRIMARY_SUPPLIER_ID DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID ATP_FLAG INVENTORY_ITEM_FLAG REVISION_QTY_CONTROL_CODE EXPENSE_ACCOUNT INVENTORY_ASSET_FLAG BUYER_ID 2-216 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–60 Parameter MATERIAL_COST RESOURCE_COST SOURCE_ORG_ID PICK_COMPONENTS_FLAG MSC_SYSTEM_ITEMS Usage IN IN IN IN Type NUMBER NUMBER NUMBER VARCHAR2(1) Required Derived Optional x x x x ORGANIZATION_ID Organization identifier SR_ORGANIZATION_ID Source organization identifier INVENTORY_ITEM_ID Inventory item identifier SR_INVENTORY_ITEM_ID Source inventory item identifier ITEM_NAME Item name LOTS_EXPIRATION Lots expiration LOT_CONTROL_CODE Flag indicating if lots_expiration is used or not SHRINKAGE_RATE Percentage of shrinkage for this item FIXED_DAYS_SUPPLY Period of the supply days Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-217 .

Setting Up the ODS Load API FIXED_ORDER_QUANTITY Fixed order quantity FIXED_LOT_MULTIPLIER Fixed lot multiplier MINIMUM_ORDER_QUANTITY Minimum size of an order MAXIMUM_ORDER_QUANTITY Maximum size of an order ROUNDING_CONTROL_TYPE Flag indicating if rounding of the quantity is allowed PLANNING_TIME_FENCE_DAYS Planning time fences days of the item DEMAND_TIME_FENCE_DAYS Demand time fence days RELEASE_TIME_FENCE_CODE Release time fence code RELEASE_TIME_FENCE_DAYS Release time fence days DESCRIPTION Item description IN_SOURCE_PLAN Flag indicating whether the item is in the plan REVISION Item revision code 2-218 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API SR_CATEGORY_ID Source category identifier CATEGORY_NAME Category name ABC_CLASS_ID ABC class identifier ABC_CLASS_NAME ABC class name MRP_PLANNING_CODE MRP planning code FIXED_LEAD_TIME Fixed lead time VARIABLE_LEAD_TIME Variable lead time PREPROCESSING_LEAD_TIME Preprocessing lead time POSTPROCESSING_LEAD_TIME Postprocessing lead time FULL_LEAD_TIME Full lead time CUMULATIVE_TOTAL_LEAD_TIME Cumulative total lead time CUM_MANUFACTURING_LEAD_TIME Cumulative manufacturing lead time Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-219 .

Setting Up the ODS Load API UOM_CODE Unit of measure code UNIT_WEIGHT Weight of the item UNIT_VOLUME Volume of the item WEIGHT_UOM Unit of measure for the weight VOLUME_UOM Unit of measure for the volume PRODUCT_FAMILY_ID Product family identifier ATP_RULE_ID ATP rule identifier MRP_CALCULATE_ATP_FLAG Flag indication whether to calculate ATP in MRP ATP_COMPONENTS_FLAG Flag indicating whether to calculate components ATP BUILT_IN_WIP_FLAG Flag to indicate if the item can be built in WIP PURCHASING_ENABLED_FLAG Flag to indicate if the item can be purchased PLANNING_MAKE_BUY_CODE Plan this item as either a make item or buy item 2-220 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API REPETITIVE_TYPE Flag indicates if this item build repetitively STANDARD_COST Standard cost CARRYING_COST Actual carrying cost ORDER_COST Order cost DMD_LATENESS_COST DMD lateness cost SS_PENALTY_COST SS penalty cost SUPPLIER_CAP_OVERUTIL_COST Supplier capacity over-utilization cost LIST_PRICE Item list price AVERAGE_DISCOUNT Item average discount END_ASSEMBLY_PEGGING_FLAG Peg to the end assembly on reports END_ASSEMBLY_PEGGING Peg to the end assembly on reports (value is populated by the plan) FULL_PEGGING Full pegging flag Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-221 .

Setting Up the ODS Load API ENGINEERING_ITEM_FLAG Engineering item flag WIP_SUPPLY_TYPE WIP supply type MRP_SAFETY_STOCK_CODE Safety stock code MRP_SAFETY_STOCK_PERCENT Safety stock percent SAFETY_STOCK_BUCKET_DAYS Safety stock bucket days INVENTORY_USE_UP_DATE Use up date BUYER_NAME Buyer name PLANNER_CODE Planner code PLANNING_EXCEPTION_SET Exception control set EXCESS_QUANTITY Excess quantity EXCEPTION_SHORTAGE_DAYS Exception shortage days EXCEPTION_EXCESS_DAYS Exception excess days 2-222 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API EXCEPTION_OVERPROMISED_DAYS Exception overpromised days REPETITIVE_VARIANCE_DAYS Repetitive variance days BASE_ITEM_ID Inventory base item identifier BOM_ITEM_TYPE BOM item type ATO_FORECAST_CONTROL ATO forecast control ORGANIZATION_CODE Organization code EFFECTIVITY_CONTROL Effectivity control code ACCEPTABLE_EARLY_DELIVERY Acceptable early delivery INVENTORY_PLANNING_CODE Inventory planning code INVENTORY_TYPE Inventory type ACCEPTABLE_RATE_INCREASE Acceptable rate increase ACCEPTABLE_RATE_DECREASE Acceptable rate increase Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-223 .

Setting Up the ODS Load API PRIMARY_SUPPLIER_ID Primary supplier identifier DELETED_FLAG Peg to the end assembly on reports LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier 2-224 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API REFRESH_ID Refresh identifier ATP_FLAG ATP flag INVENTORY_ITEM_FLAG Inventory item identifier REVISION_QTY_CONTROL_CODE Revision quantity control EXPENSE_ACCOUNT Expense account INVENTORY_ASSET_FLAG Inventory asset flag BUYER_ID Buyer identifier MATERIAL_COST Material cost RESOURCE_COST Resource cost SOURCE_ORG_ID Source organization identifier PICK_COMPONENTS_FLAG Flag indicating whether all shippable components should be picked MSC_ST_TRADING_PARTNERS The staging table used by the collection program to validate and process data for table MSC_TRADING_PARTNERS. Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-225 .

Setting Up the ODS Load API Table 2–61 Parameter PARTNER_ID ORGANIZATION_CODE SR_TP_ID DISABLE_DATE STATUS MASTER_ORGANIZATION PARTNER_TYPE PARTNER_NAME PARTNER_NUMBER CALENDAR_CODE MSC_TRADING_PARTNERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(7) NUMBER DATE VARCHAR2(1) NUMBER NUMBER VARCHAR2(80) VARCHAR2(154) VARCHAR2(14) NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) VARCHAR2(3) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x x x x x x x x x x x x x x Required Derived Optional x x CALENDAR_EXCEPTION_SET_ID OPERATING_UNIT MAXIMUM_WEIGHT MAXIMUM_VOLUME WEIGHT_UOM VOLUME_UOM PROJECT_REFERENCE_ENABLED PROJECT_CONTROL_LEVEL DEMAND_LATENESS_COST SUPPLIER_CAP_OVERUTIL_COST RESOURCE_CAP_OVERUTIL_COST DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN 2-226 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–61 Parameter REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MODELED_CUSTOMER_ID MSC_TRADING_PARTNERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(34) NUMBER NUMBER NUMBER NUMBER x x x x x x x x x x x x x x x Required Derived x x x x Optional MODELED_CUSTOMER_SITE_ID MODELED_SUPPLIER_ID MODELED_SUPPLIER_SITE_ID TRANSPORT_CAP_OVER_UTIL_COST USE_PHANTOM_ROUTINGS INHERIT_PHANTOM_OP_SEQ DEFAULT_ATP_RULE_ID DEFAULT_DEMAND_CLASS MATERIAL_ACCOUNT EXPENSE_ACCOUNT SOURCE_ORG_ID ORGANIZATION_TYPE PARTNER_ID Unique partner identifier which can be customer id. or inventory organization id ORGANIZATION_CODE Organization code SR_TP_ID Unique partner identifier in the source application instance Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-227 . supplier id.

The code includes instance code and calendar code from the source apps. Supplier. or organization PARTNER_NAME Name of the supplier or customer PARTNER_NUMBER Number of the supplier or customer CALENDAR_CODE Calendar used for this partner. CALENDAR_EXCEPTION_SET_ID Calendar exception set identifier OPERATING_UNIT Operating unit MAXIMUM_WEIGHT Maximum weight MAXIMUM_VOLUME Maximum volume WEIGHT_UOM Weight unit of measure 2-228 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API DISABLE_DATE Disable date of the trading partner STATUS Status of the trading partner MASTER_ORGANIZATION Master organization identifier PARTNER_TYPE Specify the type of partner: Customer.

Setting Up the ODS Load API VOLUME_UOM Volume unit of measure PROJECT_REFERENCE_ENABLED Project reference enabled flag PROJECT_CONTROL_LEVEL Project control level DEMAND_LATENESS_COST Demand lateness cost SUPPLIER_CAP_OVERUTIL_COST Supplier over-utilization cost RESOURCE_CAP_OVERUTIL_COST Resource over-utilization cost DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-229 .

Setting Up the ODS Load API REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MODELED_CUSTOMER_ID Customer identifier which is modeled as inventory organization MODELED_CUSTOMER_SITE_ID Customer site identifier which is modeled as inventory organization MODELED_SUPPLIER_ID Supplier identifier which is modeled as inventory organization MODELED_SUPPLIER_SITE_ID Supplier site identifier which is modeled as inventory organization TRANSPORT_CAP_OVER_UTIL_COST Transportation over-utilization cost USE_PHANTOM_ROUTINGS Use phantom routings 2-230 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API INHERIT_PHANTOM_OP_SEQ Inherit phantom op sequence DEFAULT_ATP_RULE_ID Default ATP rule identifier DEFAULT_DEMAND_CLASS Default demand class MATERIAL_ACCOUNT Material account EXPENSE_ACCOUNT Expense account SOURCE_ORG_ID Organization to source items from ORGANIZATION_TYPE Organization MSC_ST_TRADING_PARTNER_SITES The staging table used by the collection program to validate and process data for table MSC_TRADING_PARTNER_SITES. Table 2–62 Parameter PARTNER_ID PARTNER_SITE_ID PARTNER_ADDRESS SR_TP_ID SR_TP_SITE_ID TP_SITE_CODE LOCATION MSC_TRADING_PARTNER_SITES Usage IN IN IN IN IN IN IN Type NUMBER NUMBER VARCHAR2(1600) NUMBER(15) NUMBER VARCHAR2(30) VARCHAR2(40) x x x x Required Derived Optional x x x Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-231 .

7) VARCHAR2(60) x x x x x Required x x x x x x x x x x x Derived Optional PARTNER_ID Trading partner unique identifier PARTNER_SITE_ID Trading partner site unique identifier PARTNER_ADDRESS Trading partner address SR_TP_ID Trading partner unique identifier from source application 2-232 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API Table 2–62 Parameter PARTNER_TYPE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID LONGITUDE LATITUDE OPERATING_UNIT_NAME MSC_TRADING_PARTNER_SITES Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER NUMBER(10.7) NUMBER(10.

or Organization DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-233 . Supplier.Setting Up the ODS Load API SR_TP_SITE_ID Trading partner site unique identifier from source application TP_SITE_CODE Site code LOCATION Partner location PARTNER_TYPE Indicate type of partner: Customer.

Setting Up the ODS Load API PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier LONGITUDE Longitude LATITUDE Latitude OPERATING_UNIT_NAME MSC_ST_UNITS_OF_MEASURE The staging table used by the collection program to validate and process data for table MSC_UNITS_OF_MEASURE. Table 2–63 Parameter UNIT_OF_MEASURE UOM_CODE UOM_CLASS BASE_UOM_FLAG DISABLE_DATE DESCRIPTION DELETED_FLAG LAST_UPDATE_DATE MSC_UNITS_OF_MEASURE Usage IN IN IN IN IN IN IN IN Type VARCHAR2(25) VARCHAR2(3) VARCHAR2(10) VARCHAR2(1) DATE VARCHAR2(50) NUMBER DATE x x Required x x x x x x Derived Optional 2-234 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API Table 2–63 Parameter LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_UNITS_OF_MEASURE Usage IN IN IN IN IN IN IN IN IN IN Type NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x Required Derived x x x x x x x x Optional UNIT_OF_MEASURE Unit of measure name UOM_CODE Abbreviated unit of measure code UOM_CLASS Unit of measure class BASE_UOM_FLAG Base unit of measure flag DISABLE_DATE Date when the unit can no longer be used to define conversions DESCRIPTION Unit of measure description DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-235 .

2-236 Oracle Manufacturing APIs and Open Interfaces Manual .Setting Up the ODS Load API LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_UNIT_NUMBERS The staging table used by the collection program to validate and process data for table MSC_UNIT_NUMBERS.

Setting Up the ODS Load API Table 2–64 Parameter UNIT_NUMBER END_ITEM_ID MSC_UNIT_NUMBERS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(30) NUMBER NUMBER VARCHAR2(240) NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x x Derived Optional MASTER_ORGANIZATION_ID COMMENTS DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID UNIT_NUMBER Unit number END_ITEM_ID End item unique identifier MASTER_ORGANIZATION_ID Master organization identifier COMMENTS Comments Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-237 .

Setting Up the ODS Load API DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier 2-238 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API MSC_ST_UOM_CLASS_CONVERSIONS The staging table used by the collection program to validate and process data for table MSC_UOM_CLASS_CONVERSIONS. Table 2–65 Parameter INVENTORY_ITEM_ID FROM_UNIT_OF_MEASURE FROM_UOM_CODE FROM_UOM_CLASS TO_UNIT_OF_MEASURE TO_UOM_CODE TO_UOM_CLASS CONVERSION_RATE DISABLE_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID MSC_UOM_CLASS_CONVERSIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type NUMBER VARCHAR2(25) VARCHAR2(3) VARCHAR2(10) VARCHAR2(25) VARCHAR2(3) VARCHAR2(10) NUMBER DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x x x x x x x x Derived Optional INVENTORY_ITEM_ID The inventory item for which the conversion factors between base units of measure Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-239 .

Setting Up the ODS Load API FROM_UNIT_OF_MEASURE Base unit of measure of the items base class FROM_UOM_CODE Base unit of measure short name for the items base class FROM_UOM_CLASS Base class of the item TO_UNIT_OF_MEASURE Base unit of the class to which the conversion is defined TO_UOM_CODE Base unit short name of the class to which the conversion is defined TO_UOM_CLASS Class to which the conversion is defined CONVERSION_RATE Conversion rate from the items class base unit to the “to” class base unit DISABLE_DATE Date when the defined inter-class conversion can no longer be used DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column 2-240 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 2–66 Parameter UNIT_OF_MEASURE UOM_CODE UOM_CLASS INVENTORY_ITEM_ID CONVERSION_RATE MSC_UOM_CONVERSIONS Usage IN IN IN IN IN Type VARCHAR2(25) VARCHAR2(3) VARCHAR2(10) NUMBER NUMBER Required x x x x x Derived Optional Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-241 .Setting Up the ODS Load API CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier MSC_ST_UOM_CONVERSIONS The staging table used by the collection program to validate and process data for table MSC_UOM_CONVERSIONS.

Setting Up the ODS Load API Table 2–66 Parameter MSC_UOM_CONVERSIONS Usage IN IN IN IN IN IN IN IN IN IN IN IN IN IN Type VARCHAR2(1) DATE NUMBER DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER x x x x x x x x x x x x Required x x Derived Optional DEFAULT_CONVERSION_FLAG DISABLE_DATE DELETED_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE SR_INSTANCE_ID REFRESH_ID UNIT_OF_MEASURE Primary unit of measure long name UOM_CODE Unit of measure code UOM_CLASS Destination class of conversion INVENTORY_ITEM_ID Inventory item identifier CONVERSION_RATE Conversion rate from conversion unit to base unit of class 2-242 Oracle Manufacturing APIs and Open Interfaces Manual .

Setting Up the ODS Load API DEFAULT_CONVERSION_FLAG Indicates whether the conversion factor applies for this item or it is defined as standard conversion factor DISABLE_DATE Date when the conversion is no longer valid to be used in the system (transactions.) DELETED_FLAG Yes/No flag indicates whether corresponding record in ODS will be deleted LAST_UPDATE_DATE Standard Who column LAST_UPDATED_BY Standard Who column CREATION_DATE Standard Who column CREATED_BY Standard Who column LAST_UPDATE_LOGIN Standard Who column REQUEST_ID Concurrent Who column PROGRAM_APPLICATION_ID Concurrent Who column PROGRAM_ID Concurrent Who column PROGRAM_UPDATE_DATE Concurrent Who column Oracle ASCP and Oracle Global ATP Server Open Interfaces 2-243 . etc.

Setting Up the ODS Load API SR_INSTANCE_ID Source application instance identifier REFRESH_ID Refresh identifier 2-244 Oracle Manufacturing APIs and Open Interfaces Manual .

3 Bills of Material Business Object Interface Topics covered in this chapter include: s Bill of Materials API Overview on page 3-2 Bills of Material Entity Diagram on page 3-3 Bill of Material Import Description on page 3-6 Bill of Material Parameter Descriptions on page 3-11 Bill of Material Package Interaction on page 3-33 Bill of Material Import Error Handling and Messaging on page 3-35 Bill of Material Export API on page 3-45 Routing API Overview on page 3-50 Routing Import Description on page 3-55 Routing Parameter Descriptions on page 3-60 Launching the Routing Import on page 3-89 Routing Package Interaction on page 3-94 Routing Import Error Handling and Messaging on page 3-96 s s s s s s s s s s s s Bills of Material Business Object Interface 3-1 .

3-2 Oracle Manufacturing APIs and Open Interfaces Manual . Updating. identify the record as a delete. Features s Creating. s Bills of Material Business Object Data Encapsulation When you import bills of material from an external system you are not required to provide system specific information. components. The Bills of Material API enables you import your bills of material from external system into Oracle Bills of Material. This document describes the basic business needs. Following the business hierarchy. major features. when you wish to delete bill of material information. business object architecture and components for the Insert. The Bills of Material API processes the information within a bill synchronously. substitute component and reference designator information in a very user friendly manner without using cryptic ID’s and system specific information. you can include revision information. the Bills of Material Business API reports detailed and translatable error messages. s Detailed and Translatable Error Messages If your import fails.Bill of Materials API Overview Bill of Materials API Overview The Bills of Material API enables you to import your Bills of Material information from a legacy or product data management (PDM) system into Oracle Bills of Material. Update and Delete features for the Bills of Material API. The Bills of Material API can process all types of bills. The Bills of Material Object Interface insure that your imported bills of material contain the same detail as those you enter manually in the Define Bill of Material form. s Asynchronous Processing of Bills of Material You can process multiple bills simultaneously. and Deleting Bills of Material Information. When you import a bill of material. You can update bills of material information to mimic the updates in the external system by identifying the bills of material record as an update. The error message identifies the severity of the error and how it affects other records. bill comments. it processes bill header information before components. The Bills of material API requires business specific data that is required to define a bill. s Synchronous Processing of information within a Bill. Similarly.

Bills of Material Entity Diagram Bills of Material Entity Diagram The following diagram shows the table structure for the ECO business object along with all its entities: Figure 3–1 Entity Diagram Bills of Material Business Object Architecture The Bills of Material Business Object Architecture is based on the hierarchical definition of BOM of material in Oracle Bills of Material. You can process more than one header record at a time. As in a genealogical tree. The entities connected directly below are its children. To use the Bills of Material Business object interface you only need to know structure of your BOM. the entity at the top is the parent. Bills of Material Header The BOM header entity is the topmost entity in the Bills of Material hierarchy. The header entity will contain Bills of Material Business Object Interface 3-3 .

and the information they store. Substitute Component A substitute component cannot exist without a component. you must identify the following information: organization. alternate designator if bill is an alternate and the revision. The following are the existing production tables that exist. you must identify the following information: organization. assembly item number and revision. When you create or update a bill of material you can choose to create a new revision or modify an existing revision. organization in which the item exists. You can also define different versions of a bills of material within the same revision. alternate if the component belongs on an alternate bill. item number. To identify a component you must specify the header information such as the item number. Reference Designator A reference designator cannot exist without a component. organization. alternate designator (if you are adding the component to an alternate bill). assembly item number. and substitute component number.Bills of Material Entity Diagram information such as the header item name. Production Tables Each of the entities shown in the Bills of Material entity diagram maps to a corresponding table in the database. assembly item number. and operation sequence number. component item number. 3-4 Oracle Manufacturing APIs and Open Interfaces Manual . and substitute component number. operation sequence number. Revisions The revisions entity enables you to define any number of revisions for a header item. To identify a revision you must specify the organization in which exists. To identify a substitute component. alternate if the component belongs on an alternate bill. To identify a reference designator. effectivity date. component item number. operation sequence number. effective date. effectivity date. Components A component cannot exist without a header entity.

Bills of Material Entity Diagram Table 3–1 Production Tables Production Table BOM_BILLS_OF_MATERIAL MTL_ITEM_REVISIONS BOM_INVENTORY_COMPONENTS BOM_REFERENCE_DESIGNATORS BOM_SUBSTITUTE_COMPONENTS Description Stores information about the Bills of Material header item or the Assembly Item Stores information about Bill of Materials revisions Stores information about the un-implemented single-level BOM components Stores information about the un-implemented BOM component reference designators Stores information about the un-implemented substitute components associated with a BOM component Stores exploded bill information for the specified assembly for all subordinate organizations in a specified organization hierarchy. It includes all constraints and considerations that the business needs to maintain and process data successfully. This implies that certain rules must be imposed on incoming data (business objects) to ensure its validity within the context of the business. BOM_EXPORT_TAB Business Logic and Business Object Rules Business logic helps model the business. Bills of Material Business Object Interface 3-5 .

Unique index helps uniquely identify a record in the database. This information is stored in the database along with the record Step 4: Pick up highest level un-processed record Step 5: Convert user-unique index to unique index The import program processes a parent and all its direct and indirect children. the highest level parent must be chosen. Prog_ Appid. Login_Id. Pull in values of profiles ENG: Standard Item Access. MDL_ Item_Access and PLN_Item_Access respectively. before moving onto to a sibling. Prog_Id in System_Information record. the program exits and transfers control to the caller.Bill of Material Import Description Bill of Material Import Description Table 3–2 Import Description Step Step 1: Pass Business Object to Public API Purpose The program will try to import it Description Caller must pass one business object at a time. it’s entire lineage is error-ed out since members of the lineage are referencing an invalid parent. It serves the following purposes: The user need not enter cryptic Ids If a user unique index could not be derived for a parent. User-unique index is a user-friendly equivalent of the unique index. There may be more than one record for other entities. Step 2: Check for Organization uniformity Step 3: Save system information We must ensure that all records in a business object belong to the same Organization. Severe Error III -N/AQuit import of business object Severe Error I Error -N/A- Saves system-specific information in System_Information record since it is common to the whole business object. 3-6 Oracle Manufacturing APIs and Open Interfaces Manual . and may consist of more than one column. When there are no more records. ENG: Model Item Access and ENG: Planning Item Access into STD_Item_Access. So. Derive unique index columns from user-unique index columns. There should be only one Header record. Initialize User_Id. Derive Organization_Id from Organization_Code Store Organization_Id value in System_ Information record. The highest level record with a {return status = NULL} is picked.

the indirect parent being referenced exists and is really the parent of the current record’s parent in the database. Description For CREATE.Bill of Material Import Description Table 3–2 Import Description Step Step 6: Existence Verification Purpose The record being updated or deleted in the database must already exist. Other: Standard Error A assembly item and any of it’s components cannot be operated upon if the user does not have access to the assembly item type. That is. and set System_Information flags accordingly. But a record being created must not. Severe Error III Step 8(a): Check operability of parent items and current item (if applicable) Step 8(b): Check operability of parent items and current item (if applicable) Step 9: Value-Id conversions A assembly item and any of it’s components cannot be operated upon if the assembly item is implemented or canceled. Error Severe Error III Step 7: Check Lineage Perform lineage checks for entity records that do not belong to the top-most entity in the hierarchy. We must ensure that the linkage of records is correct in the business object. child records must reference valid parents. since they are referencing an invalid parent. If not. the record must not already exist. and. Check if System_Information record has this information. For UPDATE and DELETE. OR If there is no immediate parent record in the business object. Bills of Material Business Object Interface 3-7 . Fatal Error III or Fatal Error II (depending on affected entity) Fatal Error III or Fatal Error II (depending on affected entity) CREATE: Severe Error IV. Query up database record into the associated OLD record. the record must exist. is truly the parent of this record in the database. A valid parent is one that exists. since the Ids can be derived from them. There are user-friendly value Derive Ids from user-friendly values columns that derive certain Id columns. based on Transaction_Type and the following factors: Immediate parent being referenced exists in the database. The value columns free up the user from having to enter cryptic Ids. for UPDATE and DELETE. Such an error in a record must cause all children to error out. find it in the database assembly item record. and is truly the current record’s parent in the database. Compare assembly item BOM_Item_ Type against the assembly item access fields in the System_Information record.

The user must enter values for these fields. This feature enables the user to enter minimal information for the operation. either by retrieving them from the database. copy over values for all such columns are copied over from OLD record. For CREATEs. from the OLD record. independently of each other. columns in other tables. the operation cannot go through. For all NULL columns in record. For all NULL columns found in Severe Error business object record. there is no OLD record.Bill of Material Import Description Table 3–2 Import Description Step Step 10: Required Fields checking Purpose Description Error CREATE: Severe Error IV. This feature enables the user to enter minimal information for the operation to go through. etc. checks against lookups etc. Some attributes are required based on certain external factors such as the Transaction_Type value. Standard Error 3-8 Oracle Manufacturing APIs and Open Interfaces Manual . Severe Error IV. other columns in defaulting the same table. them. Other: Standard Error CREATE: Severe Error IV. Without are not NULL. try to CREATE: default in values based on other values. Severe Error IV Step 15: Entity Certain column values may depend level on profile options. So the program must default in individual attribute values. try to default in IV values. Set all MISSING column values to UPDATE: NULL. Values business object record. valid. UPDATE: Standard Error Some fields are required for an Check that the required field columns operation to be performed. Step 11: Attribute validation (CREATEs and UPDATEs) Step 12: Populate NULL columns (UPDATEs and DELETEs) Step 13: Default values for NULL attributes (CREATEs) Each of the attributes/fields must Check that user-entered attributes are be checked individually for validity. Step 14: Check conditionally required attributes Perform checks to confirm all conditionally required attributes are present. Defaulting for these columns happens here. The user may send in a record with For all NULL columns found in -N/Acertain values set to NULL. or by having the program assign values. Check each attribute Examples of these checks are: range independently of the others checks.

Perform database write: Insert record for CREATE Overwrite record for UPDATE and CANCEL Remove record for DELETE Step 18: Process direct and indirect children The programwill finish processing an entire branch before moving on to a sibling branch. The following are checked: order specified in the -Purposevalidation column. The sibling may also contain a branch. Step 19: Process siblings When an entire branch of a record has been processed. Step 17: Database writes Write record to database table.Bill of Material Import Description Table 3–2 Import Description Step Purpose Description Error CREATE: Severe Error IV. the siblings of the current record are processed. Continue until all direct children have been processed. Cross-attribute checking: The validity of attributes may be checked. Pick up the first un-processed child record and Go to Step 5. So the processing for the sibling will be exactly the same as the current record. Pick up the first un-processed sibling record and Go to Step 5. A branch within the business object tree consists of all direct and indirect children. Go to Step 21. UPDATE: Standard Error Step 16: Entity This is where the whole record is Perform checks against record in the level checked. When no more records are found. When no more records are found. Then pick up the first un-processed indirect child record and do the same as above. Business logic: The record must comply with business logic rules. Go to Step 20. Continue through the loop until all siblings have been processed. Non-updateable columns (UPDATEs): Certain columns must not be changed by the user when updating the record. -N/A- -N/A- -N/A- Bills of Material Business Object Interface 3-9 . based on factors external to it.

When there are no more records. the program will move up to the parent (of this entire branch) and process all of its siblings (which will contains branches of their own). Go to Step 5. Error -N/A- 3-10 Oracle Manufacturing APIs and Open Interfaces Manual . Description Go up to parent and pick up the first un-processed sibling of the parent. Go to Step 4. Continue through the loop until all siblings have been processed.Bill of Material Import Description Table 3–2 Import Description Step Step 20: Process parent record’s siblings Purpose Once all the siblings have been processed.

Bill of Material Parameter Descriptions Bill of Material Parameter Descriptions Bills of Material Exposed Columns Table 3–3 Bill of Material Exposed Columns BOM Name Assembly_Item_ Name Organization_Code Alternate_BOM_ Code Type VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) Required x x x Derived x x x x Optional X x x x x x x x x x x x x x Common_Assembly_ VARCHAR2(81) Name Assembly_Type Transaction_Type Original_System_ Reference Return_Status Assembly_Type Transaction_Type Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute1 Attribute7 Attribute8 Attribute9 NUMBER VARCHAR2(30) VARCHAR2(50) VARCHAR2(1) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Bills of Material Business Object Interface 3-11 .

G_MISS_CHAR 3-12 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_CHAR Common_Organization_Code Organization identifier of a common bill. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Alternate_Bom_Designator Alternate designator code.G_MISS_CHAR Change_Description Change description.G_MISS_CHAR Common_Assembly_Item_Name Inventory item identifier of common assembly.Bill of Material Parameter Descriptions Table 3–3 Bill of Material Exposed Columns BOM Name Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Required Derived Optional x x x x x x Organization_Code Organization Identifier. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Assembly_Item_Name Inventory item identifier of manufactured assembly.

G_MISS_CHAR Error: FND_API.G_MISS_CHAR Return_Status Processing status of the API after it completes its function. Default Value: FND_API.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come.Bill of Material Parameter Descriptions Assembly_Type Type of assembly. 2. Default Value: FND_API.G_RET_STS_ERROR Transaction_Type Type of action: Create. Valid Values include: Success: FND_API. or delete.G_MISS_CHAR Attribute1-15 Descriptive flexfield segment. Manufacturing Bill Engineering Bill Default Value: FND_API. Default Value: FND_API.G_MISS_NUM Attribute_Category Descriptive flexfield structure defining column. 1. Update. Default Value: FND_API.G_MISS_CHAR Bills of Material Components Exposed Columns Bills of Material Business Object Interface 3-13 .

Bill of Material Parameter Descriptions Table 3–4 Bills of Material Components Exposed Columns BOM Name Organization_Code Assembly_Item_ Name Type VARCHAR2(3) VARCHAR2(81) Required x Derived x x x Optional x x x x x x x x x x x x x x x Alternate_Bom_Code VARCHAR2(10) Start_Effective_Date Operation_ Sequence_Number Component_Item_ Name Transaction_Type Organization_Code Assembly_Item_ Name Disable_Date New_Effectivity_ Date New_Operation_ Sequence_Number Item_Sequence_ Number Quantity_Per_ Assembly Planning_Percent Projected_Yield Include_In_Cost_ Rollup WIP_Supply_Type Supply_ Subinventory Locator_Name DATE NUMBER VARCHAR2(81) VARCHAR2(30) VARCHAR2(3) VARCHAR2(81) DATE DATE NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(81) 3-14 Oracle Manufacturing APIs and Open Interfaces Manual .

Bill of Material Parameter Descriptions Table 3–4 Bills of Material Components Exposed Columns BOM Name SO_Basis Optional Mutally_Exclusive Check_ATP Minimum_Allowed Quantity Type NUMBER NUMBER NUMBER NUMBER NUMBER Required Derived Optional x x x x x x x x x x x x x x x x x x x x x x x Maximum_Allowed_ NUMBER Quantity Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute12 Attribute13 Attribute14 Attribute15 From_End_Item_ Unit_Number To_End_Item_Unit_ Number VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(30) Bills of Material Business Object Interface 3-15 .

Default Value: FND_API.G_MISS_CHAR Assembly_Item_Name Inventory item identifier of manufactured assembly.G_MISS_CHAR Alternate_BOM_Code Alternate BOM designator code. Default Value: FND_API.G_MISS_CHAR Start_Effective_Date Effective Date. Default Value: FND_API.Bill of Material Parameter Descriptions Organization_Code Organization Identifier. Default Value: FND_API.G_MISS_DATE Operation_Sequence_Number Routing Operation unique identifier.G_MISS_CHAR New_Effectivity_Date New effective date. Default Value: FND_API.G_MISS_NUM Component_Item_Name Component Item identifier.G_MISS_DATE Disable_Date Disable date. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_DATE 3-16 Oracle Manufacturing APIs and Open Interfaces Manual .

Bill of Material Parameter Descriptions New_Operation_Sequence_Number New operation sequence number. Yes No Default Value: FND_API. Default Value: FND_API.G_MISS_NUM Item_Sequence_Number Item unique identifier.G_MISS_NUM Include_In_Cost_Rollup Flag that indicates to include the material cost of a component in the standard cost of the assembly. FND_API. Default Value: FND_API. Default Value: FND_API. 1. Default Value: FND_API.G_MISS_NUM Bills of Material Business Object Interface 3-17 . 2. Default Values: FND_API.G_MISS_NUM Planning_Percent Planning percentage.G_MISS_NUM Quantity_Per_Assembly Quantity per assembly.G_MISS_NUM Projected_Yield Projected yield for an operation.G_MISS_NUM Wip_Supply_Type WIP supply type code.

Yes No Default Value: FND_API.Bill of Material Parameter Descriptions So_Basis Quantity basis Oracle Order Management uses to determine how many units of a component to put on an order. 1.G_MISS_NUM Mutually_Exclusive Flag indicating if one or more children of a component can be picked when taking an order. Yes No Default Value: FND_API. 2. 2. 1. Yes No Default Value: FND_API. Yes No Default Value: FND_API.G_MISS_NUM Check_Atp Flag indicating if ATP check is required. Default Value: FND_API. 1.G_MISS_NUM 3-18 Oracle Manufacturing APIs and Open Interfaces Manual . 2.G_MISS_NUM Shipping_Allowed Flag indicating if a component may be shipped. 2. 1.G_MISS_NUM Optional Flag indicating if a flag is optional in a bill.

Default Value: FND_API. Default Value: FND_API.Bill of Material Parameter Descriptions Required_To_Ship Flag indicating that you must include this component of a pick-to-order item in the first shipment of the pick to order item. FND_API.G_MISS_NUM Quantity_Related Identifier to indicate if this component has quantity related reference designators. Default Value: FND_API.G_MISS_NUM Required_For_Revenue Flag that prevents invoicing for the pick-to-order item until you ship the component. Default Value:FND_API. Default Value: FND_API.G_MISS_CHAR Minimum_Allowed_Quantity Minimum quantity allowed on an order.G_MISS_CHAR Location_Name Supply Location Name.G_MISS_NUM Include_On_Ship_Docs Flag indicating if the component of the configure-to-order item should appear on Order Entry documents.G_MISS_NUM Bills of Material Business Object Interface 3-19 . Default Value: FND_API.G_MISS_NUM Supply_Subinventory Supply subinventory. Default Value: FND_API.G_MISS_NUM Maximum_Allowed_Quantity Maximum quantity allowed for an order.

Default Value: FND_API. update or delete. FND_API.G_MISS_CHAR Return_Status Processing status of the API after it completes its function. Default Value: FND_API. Valid values include: Success: FND_API.G_MISS_CHAR 3-20 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_CHAR Attributes 1-15 Descriptive Flexfield segments.G_MISS_CHAR From_End_Item_Unit_Number From end item unit number.G_MISS_CHAR To_End_Item_Unit_Number To end item unit number. Default Value: FND_API.Bill of Material Parameter Descriptions Component_Remarks Component Remarks.G_MISS_CHAR Attribute_Category Descriptive flexfield structure defining category Default Value: FND_API.G_MISS_CHAR Error: FND_API.G_RET_STS_ERROR Transaction_Type Type of action including create. Default Value: FND_API.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. Default Value: FND_API.

Bill of Material Parameter Descriptions Item Revision Exposed Columns Table 3–5 Item Revision Exposed Columns Item Revision Organization_Code Assembly_Item_ Name Start_Effective_Date Revision Transaction_Type Revision_Comment Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type VARCHAR2(3) VARCHAR2(81) VARCHAR2(3) VARCHAR2(15) VARCHAR2(30) VARCHAR2(240) VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Required x Derived Optional x x x x x x x x x x x x x x x x x x x x x x Bills of Material Business Object Interface 3-21 .

Default Value: FND_API. 3-22 Oracle Manufacturing APIs and Open Interfaces Manual . Attribute_Category Descriptive flexfield structure defining category.G_MISS_CHAR Reference_Designator_Name Component reference designator.Bill of Material Parameter Descriptions Organization_Code Organization Identifier. Default Value: FND_API.G_MISS_NUM Component_Item_Name Component Item identifier.G_MISS_CHAR Start_Effective_Date Effective date. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Ref_Designator_Comment Reference designator comment.G_MISS_CHAR Alternate_Bom_Code Alternate designator code.G_MISS_CHAR Assembly_Item_Name Inventory item identifier for manufactured assembly. Default Value: FND_API.G_MISS_DATE Operation_Sequence_Number Routing operation unique identifier. Default Value: FND_API. Default Value: FND_API.

G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. update or delete. Default Value: FND_API.Bill of Material Parameter Descriptions Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Attributes 1-15 Descriptive Flexfield segments.G_MISS_CHAR Return_Status Processing status of the API after it completes its function. Default Value: FND_API.G_RET_STS_ERROR Transaction_Type Type of action including create.G_MISS_CHAR Substitute Component Exposed Columns Table 3–6 Substitute Component Exposed Columns ISubstitute Component Organization_Code Assembly_Item_ Name Start_Effective_Date Type VARCHAR2(3) VARCHAR2(81) VARCHAR2(3) Required Derived Optional x x x Bills of Material Business Object Interface 3-23 .G_MISS_CHAR Error: FND_API.G_MISS_CHAR New_Reference_Designator Updated value for the old reference designator. Valid Values include: Success: FND_API.

Bill of Material Parameter Descriptions Table 3–6 Substitute Component Exposed Columns ISubstitute Component Operation_ Sequence_Number Alternate_BOM_ Code Component_Item_ Name Substitute_ Component_Name Transaction_Type Substitute_Item_ Quantity Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type NUMBER VARCHAR2(10) VARCHAR2(81) VARCHAR2(81) VARCHAR2(30) Number VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) Attribute3 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Required x Derived Optional x x x x x x x x x x x x x x x x x x x x x x 3-24 Oracle Manufacturing APIs and Open Interfaces Manual .

G_MISS_CHAR Assembly_Item_Name Inventory item identifier for manufactured assembly. FND_API. Default Value: FND_API.G_MISS_CHAR Alternate_BOM_Code Alternate BOM identifier. FND_API.G_MISS_CHAR Substitute_Item_Quantity The usage quantity of the substitute component.G_MISS_NUM Component_Item_Name The Component Item Name. FND_API.G_MISS_NUM Bills of Material Business Object Interface 3-25 .Bill of Material Parameter Descriptions Organization_Code Organization Identifier. FND_API.G_MISS_CHAR Substitute_Component_Name The name of the substitute component. FND_API.G_MISS_CHAR Start_Effective_Date Component Effective Date. Default Value: FND_API.G_MISS_DATE Operation_Sequence_Number The Routing step in which you use the component. FND_API.

3.Bill of Material Parameter Descriptions Attribute_Category Descriptive flexfield structure defining category. 2. Default Value: FND_API. Review all relevant information after the Public API has completed. Launching the Import The Three Step Rule: In order to use the business object APIs effectively. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current item.G_MISS_CHAR Return_Status Processing status of the API after it completes its function. Initialize the system information.G_MISS_CHAR New_Reference_Designator Updated value for the old reference designator. 3-26 Oracle Manufacturing APIs and Open Interfaces Manual . update or delete. Default Value: FND_API.G_MISS_CHAR Error: FND_API. Valid Values include: Success: FND_API.G_RET_STS_ERROR Transaction_Type Type of action including create. the user must follow the three step rule: 1. Call the Public API.G_MISS_CHAR Attributes 1-15 Descriptive flexfield segments.

4. x_return_status . x_msg_count IN NUMBER IN VARCHAR2:= FND_API. The procedure to call is Process_Eco. You initialize certain variables to provide the information to the import. the you must call the following procedure: FND_GLOBAL. This procedure initializes the global security context for each database session.Bill of Material Parameter Descriptions Step1: Initialize the system information Each database table requires you to enter system information. To initialize the variables. This initialization should be done when the session is established outside of a normal forms or concurrent program connection.G_FALSE OUT VARCHAR2 OUT NUMBER Bills of Material Business Object Interface 3-27 . User_id is the FND User Id of the person launching this program. while sending in one record at a time. Step2: Call the Public API You must call the public API programmatically. and the following is its specification: PROCEDURE Process_BOM (p_api_version_number . 6. 2.apps_initialize user_idIN NUMBER resp_idIN NUMBER resp_appl_idIN NUMBER security_group_idIN NUMBER DEFAULT 0 Pointers: 1. such as who is trying to update the current record. Resp_appl_id is the Application Responsibility Id. Resp id is the FND Responsibility Id the person is using. Security_group_id is the FND Security Group Id. The program retrieves system information from these variables during operation. p_init_msg_list . and a count of all associated error and warning messages. the record status. 5. 3. The Public API returns the processed record.

the caller may set this to FALSE (or accept the default value) in order to do the initialization itself by calling Error_Handler. x_ref_designator_tbl . All these data structures directly correspond to the entities shown in the BOM entity diagram. p_ref_designator_tbl . All the other data structures are PL/SQL tables of records that hold records for each of the other entities. p_assembly_item is a record that holds the Bill of Materials header for a BOM. 3-28 Oracle Manufacturing APIs and Open Interfaces Manual . p_sub_ component_tbl: This is the set of data structures that represents the incoming business object. p_rev_component_tbl . x_assembly_item_tbl . x_msg_data . p_assembly_item_tbl. All OUT parameters begin with x_. allows callers to request that the API do the initialization of the message list on their behalf. p_init_msg_list: This parameter. The following is a description of these parameters: s p_api_version_number: This parameter is required. p_sub_component_tbl .Bill of Material Parameter Descriptions . s s Please note that any of these data structures may be sent in empty (set to NULL) to indicate that there are no instances of that entity in the business object being sent in. p_ECO_rec .Initialize. p_ref_designator_tbl. p_rev_component_tbl. On the other hand. all IN parameters begin with p_. if set to TRUE. x_rev_component_tbl . It is used by the API to compare the version numbers of incoming calls to its current version number.1 of the Business Object Coding Standards document for a detailed description of this parameter. and return an unexpected error if they are incompatible. x_sub_component_tbl OUT VARCHAR2 IN Eco_Rec_Type:= G_MISS_ECO_REC IN Revised_Item_Tbl_Type:= IN Rev_Component_Tbl_Type:= IN Ref_Designator_Tbl_Type:= IN Sub_Component_Tbl_Type:= OUT Revised_Item_Tbl_Type OUT Rev_Component_Tbl_Type OUT Ref_Designator_Tbl_Type OUT Sub_Component_Tbl_Type) G_MISS_REVISED_ITEM_TBL G_MISS_REV_COMPONENT_TBL G_MISS_REF_DESIGNATOR_TBL G_MISS_SUB_COMPONENT_TBL As is obvious from the above specification. p_assembly_item_tbl . See section 4.

x_sub_ component_tbl: This is the set of data structures that represents the outgoing business object. The caller may look up this flag to choose an appropriate course of action (commit. this status will indicate the fact that there has been an error in the business object. a shell. x_return_status: This is a flag that indicates the state of the whole business object after the import. or subjected to further processing by the caller. except now it has all the changes that the import program made to it through all the steps in the Process Flow. or further processing by the caller). Bills of Material Business Object Interface 3-29 . this flag will carry a status to indicate that. The following is a list of all the possible business object states: s Table 3–7 Business Object States CODE ‘S’ ‘E’ ‘F’ ‘U’ s MEANING Success Error Fatal Error Unexpected Error x_msg_count: This holds the number of messages in the API message stack after the import.Bill of Material Parameter Descriptions s x_assembly_item_tbl. This parameter returns a 0 when there are no messages to return. the Public API must be called programmatically. The purpose of this parameter is to save the caller the extra effort of retrieving a lone message from the message list. if the business object import has been successful. These records essentially constitute the whole business object as it was sent in. Similarly. All these data structures directly correspond to the entities shown in the BOM entity diagram. This parameter returns NULL when there is more than one message. or some other API which serves to extend the functionality of the import program. x_msg_data: This returns a single message when the message count is 1. x_ref_designator_tbl. The caller here may be a form. If there has been an error in a record. rolled back. s As mentioned above. rollback. These records can be committed. x_rev_component_tbl.

RC (Revised Component). 5.Bill of Material Parameter Descriptions Note: A record must have an error status of NULL for it to be processed. All error and warning messages in the API message list. denoted by the symbols ECO (ECO Header). x_message_list ). Retrieving messages by entity: One implementation of procedure Get_Entity_ Message will return all messages pertaining to a particular entity (p_entity_id). Go to the start of the list: The following procedure reset the message index to the start of the list so the user can start reading from the start of the list PROCEDURE Reset. Retrieving the entire message list: The following procedure will return the entire message list to the user PROCEDURE Get_Message_List (x_message_list OUT Eng_Eco_Pub. All record attributes to see what change occurred after applying business logic to these records. the overall business object error status. 4. Initializing the message list: The following procedure clears the message list and initializes all associated variables PROCEDURE Initialize. 2. PROCEDURE Get_Entity_Message (p_entity_id . including. as well as the individual record statuses. RD (Reference Designator). IN VARCHAR2 OUT Eng_Eco_Pub. s s You can access the API message list using the following procedures and functions in the Error_Handler package: 1.Error_Tbl_Type). it will not be picked up for processing. The user must remember to NULL out this field when sending in a record. RI (Revised Item). If it has any other value. SC (Substitute Component).Error_Tbl_Type 3-30 Oracle Manufacturing APIs and Open Interfaces Manual . Step 3: Review all relevant information after the Public API has completed You must look up: s All error status that the Public API returns. 3.

RD (Reference Designator). Retrieving the current message: Procedure Get_Message will returns the message at the current message index and will advance the pointer to the next index. p_entity_index IN VARCHAR2 IN NUMBER). RD (Reference Designator). SC (Substitute Component). Deleting all messages for a certain entity: Another implementation of procedure Delete_Message lets the user delete all messages for a particular entity (p_ entity_id). The entity is denoted by the symbols BH (Bill Header). x_entity_index . RC (Revised Component). PROCEDURE Get_Message (x_message_text . x_message_text ). 9. The entity is denoted by the symbols BH (BOM Header). The entity index (p_entity_index) is the index in the entity array. SC (Substitute Component). Deleting a specific message: Procedure Delete_Message enables the user to delete a specific message at a specified entity index (p_entity_index) within the PL/SQL table of a specified entity (p_entity_id). p_entity_index . Retrieving a specific message: Another implementation of procedure Get_ Entity_Message will return the message pertaining to a particular entity (p_ entity_id). The entity index (p_entity_index) is the index in the entity array. RC (Revised Component). then the message index will be reset to the beginning of the list. PROCEDURE Delete_Message (p_entity_id . OUT VARCHAR2 OUT NUMBER OUT VARCHAR2 8. Bills of Material Business Object Interface 3-31 . The entity is denoted by the symbols BH (Bills Header).Bill of Material Parameter Descriptions 6. x_entity_id ). RD (Reference Designator). If the user tries to retrieve beyond the size of the message list. RC (Revised Component). PROCEDURE Get_Entity_Message (p_entity_id . IN VARCHAR2 IN NUMBER OUT VARCHAR2 7. SC (Substitute Component). at a specific array index in that entity table.

3-32 Oracle Manufacturing APIs and Open Interfaces Manual . Dumping the message list: The following message generates a dump of the message list using dbms_output PROCEDURE Dump_Message_List.Bill of Material Parameter Descriptions PROCEDURE Delete_Message (p_entity_id IN VARCHAR2). 10. Get a count of all messages: The following functions returns the total number of messages currently in the message list FUNCTION Get_Message_Count RETURN NUMBER. 11.

Check that all records in the business object belong to the same Bill.BOM_BO_PUB This packages allows only one business object through at a time. the records associated with an engineering change order would make up an instance of the ECO business object. 2.. All records in a specific business object must belong to the business object. and Messages Description If there is an Bill Header in the business object. they must all have the same Assembly Name and organization. all records must have the same Assembly Item Name and Organization_Code combination. Derive Organization_Id from Organization_Code and copy this value into all business object records. For example. Cause of Failure Any records have mismatched Assembly_ Item_Name and Organization_ Code values Error Severe Error I Message BOM_MUST_BE_IN_SAME_BOM: All records in a business object must belong to the same Bill of Material. If the business object does not have an Bill Header record. Bills of Material Business Object Interface 3-33 . That is.e. In this example all of the records in the ECO business object instance must reference the same engineering change order. Main Procedure: Process_BOM 1. check that all records have the same Assembly_Item_Name and Organization_Code combination as the first highest level entity record picked up. Errors.Bill of Material Package Interaction Bill of Material Package Interaction The Public Package . Table 3–8 Failure. Set business object status to S. check that all records have the same Assembly_item_ name and Organization_ Code values as the Header. i. Please check your records for this. 3.

4. Unexpected Error Other Message: BOM_UNEXP_ORG_INVALID: This record was not processed since an unexpected error while performing a value to id conversion for organization code. 3-34 Oracle Manufacturing APIs and Open Interfaces Manual . to identify this business object instance.Bill of Material Package Interaction Table 3–9 Errors and Messages Column Organization_Id Description Derive using Organization_Code from table MTL_ PARAMTERS Error Severe Error I Message BOM_ORG_INVALID: The Organization <org_id> you entered is invalid. Also pass the Assembly Item Name and Organization_Id to Private API. Pass business object into Private API if the business object status is still set to S. 5. Accept processed business object and return status from Private API after the import. and pass it back to the calling program.

records are marked so that erroneous records are not processed again.Bill of Material Import Error Handling and Messaging Bill of Material Import Error Handling and Messaging Error Handling Concepts Error handling depends on the severity of the error. Table 3–11 Code Meanings CODE ‘S’ ‘E’ ‘F’ ‘U’ MEANING Success Error Fatal Error Unexpected Error Bills of Material Business Object Interface 3-35 . and how the error affects the lineage (child record error states). Error Severity Levels Severity levels help distinguish between different types of errors since the import program behaves differently for each of these errors. They help the import program identify the records that do not need to be processed s . The following is a list of the error severity levels recognized by the import program Table 3–10 CODE ‘W’ ‘E’ ‘E’ ‘F’ ‘U’ Error Severity MEANING Warning / Debug Standard Error Severe Error Fatal Error Unexpected error Error States Error states serve two purposes: s They convey to the user the exact type of error in the record. the scope of the error. When an error occurs.

how many other records in the business object hierarchy the current error affects.Bill of Material Import Error Handling and Messaging Table 3–11 Code Meanings CODE ‘N’ MEANING Not Processed Error Scope This indicates what the depth of the error is in the business object. before committing it to the production tables. Standard Error: This error causes only the current record to be error-ed out. There are two error states that indicate how the child is affected: : Table 3–13 CODE ‘E’ ‘N’ Child Error States MEANING Error Not Processed Error Classes There are three major classes that determine the severity of the problem. Table 3–12 CODE ‘R’ ‘S’ ‘C’ ‘A’ Error Scope MEANING Error affects current ‘R’ecord Error affects all ‘S’ibling and child records Error affects ‘C’hild records Error affects ‘A’ll records in business object Child Error States If an error in a record affects child records. For example: Bill of Material entry already exists. 1. that is. 3-36 Oracle Manufacturing APIs and Open Interfaces Manual . the status of the child may vary based on the type of error. Expected errors: These are errors the program specifically looks for in the business object. but is not serious enough to affect any other records in the object. The current record status is set to E.

Please check your child records for errors as well as the current record. The following situations cause this error: s 3. All record statuses are set to F. the user somehow loses the database connection. for example. The child record statuses are set to N. This error is usually a organization uniformity error. The child record statuses are set to E. Severe Error I: This error affects all records. Severe Error IV: This error affects the current record and its child records since the program cannot properly process the child records. Fatal Error I: These errors occur when it is not possible to perform any operation on the ECO. Severe Error II: This error affects all records that are children of this record’s parent. This error usually occurs when a lineage check fails. 8. This usually occurs when the user tries to create. Such errors affect the entire business object. 7. Warnings: These are messages for information only. 6. A characteristic of this record’s parent caused the error. This type of errors occur when there are errors on CREATEs. 5. This error is usually a user-unique to unique index conversion error. These are errors that the program is not specifically looking for. 4. The following are situations that cause this error: You do not have access to this Item Type.Bill of Material Import Error Handling and Messaging 2. Fatal Error III: These errors affects the current record and its children. when the parent is not in the business object. Severe Error III: This error not only affects the current record but also its child records in the business object. 9. or delete a component of a assembly item that the user does not have access to. The current record and all its child record statuses are set to F. since it is not possible to perform any operation on these records. A characteristic of this record’s parent caused the error. All record statuses are set to E. so all it’s siblings and their children also get a record status of E. Fatal Error II: This error affects all records that are children of this record’s parent. so all it’s siblings and their children also get a record status of F. All records must have the same organization code. The purpose of warnings is: Bills of Material Business Object Interface 3-37 . You do not have access to the component item’s BOM item type Unexpected errors All errors that are not expected errors are unexpected errors. update. when the parent is not in the business object.

Bill of Material Import Error Handling and Messaging 1. to warn the user of problems that may occur when the bill is used by other manufacturing applications. The caller may also use the business object return status to choose an appropriate course of action (commit. it sets the business object error status (also called return status) appropriately to convey this to the user. a reference designator record that holds the same parent component unique key column values as a substitute component is a sibling of the substitute component. Likewise. Business Object Error Status This indicates the state of the whole business object after the import. is a sibling of the current component record. 2. The following is a list of all the possible business object states: Table 3–14 CODE ‘S’ ‘E’ ‘F’ ‘U’ Business Object States MEANING Success Error Fatal Error Unexpected Error 3-38 Oracle Manufacturing APIs and Open Interfaces Manual . For example. Sibling record A sibling record (of the current record) is one that holds the same parent unique key column values as the current record. As soon as the import program encounters an erroneous record. or further processing by the caller). rollback. For example: WIP Supply Type must be Phantom. Child record: All records carry the unique keys for all parents above them. It is then up to the user to locate the offending record(s) using the individual record error statuses as indicated below. A child record (of a particular parent) is one that holds the same values for the unique key columns as the parent record. to inform the user of any side-effects caused by user-entered data. a component record that holds the same parent assembly item unique key column values as the current component record.

and child statuses relate together to constitute the different error classes for records: Table 3–15 Error Warning Standard Error Severe Error I Severe Error II Severe Error III Severe Error IV Fatal Error I Fatal Error II Fatal Error III Status S: Success E: Error E: Error E: Error E: Error E: Error F: Fatal Error F: Fatal Error F: Fatal Error Error Status. s The following shows how the error status. error scope. if a record has a NULL return status. The user must send in records with {return status = NULL}. The error status is also referred to as return status or error state in this document. Sibling and Child Records C: Current and Child Record -N/AChild Statuses -N/A-N/AE: Error E: Error E: Error N: Not Processed -N/A -N/A -N/A N: Not Processed Unexpected Error U: Unexpected Error Bills of Material Business Object Interface 3-39 . The error status helps locate erroneous records in a business object that has error-ed out. and Child Statuses Scope R: Record Only R: Record Only A: All Records S: Current. s Every record is assigned an error status by the import program. The import program will not look at records that already have an error status value. it means that the import program has not gotten to it yet. since it assumes that a record with an error status value has already been looked at by the program.Bill of Material Import Error Handling and Messaging Record Error Status This is the state of the record after the import (success or error). The following are important pointers about the record error status. Hence. Scope. Sibling and Child Records C: Current and Child Record C: Current and Child Records A: All Records S: Current.

This is a PL/SQL table (array) of messages.Reference Designators SC .ECO Revisions RI . BO . Please see below for format information.Bills of Material Header BC . Description Error Handling API will be shared by ECO. The entity that this message belongs to. The default ID is ECO. some of which will identify the entity instances that this message is for. The following is a description of the API Message Table: Table 3–16 Field Business_Object_ID API Message Table Type VARCHAR2(3). ECO. The actual message that the user sees. The following tokens identify the several entities: Assembly Item: Assembly_Item_Name Revised Component: Revised_Component_Number 3-40 Oracle Manufacturing APIs and Open Interfaces Manual . or SC.Business Object ECO Header REV .Substitute Components BH.Bill of Material Import Error Handling and Messaging API Messaging Error Message Table All messages are logged in the Error Message Table. RC. REV.Revised Components RD . This may hold BO. RI. RD. Please see Accessing Messages in the Launching the Import section of this document on how to access these messages. Message_Text Entity_Id VARCHAR2(2000) VARCHAR2(3) Message formats Expected errors and warnings: The message text contains the translated and token substituted message text. BOM and RTG business objects.Revised Items RC . Please note that the message text may contain tokens.Bills of Material Comments Entity_Index NUMBER The index of the entity array this record belongs to.

4. It makes calls to the Error Handler when an error or warning needs to be issued. For all records affected by the type of error that occurred in the assembly item. with a severe or fatal error status. So if an error in a assembly item record will cause all it’s children to error out. Error Handler The program performs all it’s error handling and messaging through the Error Handler. 3. Which record caused this record to be affected. it has been errored out too. Set the return status of other records affected by this error. What process flow step in the offending record caused this record to be affected. then the following will be logged: For the Assembly item itself. How the error has affected this record. The following are the functions of the Error Handler: s Log the error/warning messages sent to it. What transaction type in the offending record caused this record to be affected. the error message describing the problem. the other message. that is. This message essentially mentions the following: 1. 2.Bill of Material Import Error Handling and Messaging Substitute Component: Substitute_Component_Number Reference Designator: Reference_Designator_Name Assembly Comment: Standard_Remark_Designator Unexpected errors: <Package Name> <Procedure/Function Name> <SQL Error Number> <SQL Error Message Text> Other message An Other Message is a message that is logged for all records that are affected by an error in a particular record. Set the return status of the record in error. or that it has not been processed. s s The following is the input that the Error Handler expects from the calling program: Bills of Material Business Object Interface 3-41 .

that is. the tokens are substituted into the translated message text. For expected errors and warnings. For unexpected errors. the entity that the record in error belongs to. Does not apply to ECO Header. Business Object Identifier Business Object Entity Records Message and Token List Error Status Error Level Entity Array Index Error Scope Other Message and Token List Other Status The Message and Token List. the Business Object identifier will help identify the errors. the calling program itself sends a message text. 3-42 Oracle Manufacturing APIs and Open Interfaces Manual . Index of record in error in its encompassing entity array. Then. Status the other affected records should be set to. the translated message text is retrieved using the message name. Status the record in error should be set to. Business Object hierarchy level that current record is an instance of. See below for description of this list. Indicates depth of error.Bill of Material Import Error Handling and Messaging Table 3–17 Input Error Handling Input Description Because the Error Handler will be shared by many business objects. and the message is logged. and the Other Message and Token List are temporary arrays that the calling program maintains. That is. List of messages generated for error in the current record. The Error Handler must log these messages into the API Message List. especially when the same user executes the business object for BOM and ECO which share some of the entities. See below for description. Message generated for the other affected records. The message is logged after token translation and substitution is performed. how many other records are affected by it. so no message retrieval is needed. Calling program must pass the whole business object as-is. They hold message-and-token records. after any requested token translation is performed.

Since this lone message may have more than one token. This API will reset the message counter to the start of the message list.Bill of Material Import Error Handling and Messaging Table 3–18 Field Message Name Message Text Token Name Token Value Translate Messages Description Name of the message used to retrieve the translated message text. This API will return a list of messages for a requested entity and business object identifier. Should this token value be translated ? Since each message may have more than one token. except that this list needs to carry only one message which is assigned to all other affected records. Name of the token in the message. This message list API will return a copy of the message list. IN p_bo_identifier DEFAULT ‘ECO’ OUT x_message_list) Bills of Material Business Object Interface 3-43 . Value of the token in the message. It will be users responsibility to extract message from this copy. Please note that the API Message List is not public and must be accessed through the Messaging API’s provided to access the message list. Message text for unexpected errors. These are the message list API’s that can be used to perform various operations on the Message List: Table 3–19 Message API Name Initialize Reset Get_Message_List Message API Description This API will clear the message list. the Message and Token List has as many occurrences of the same message as there are tokens in it. NULL for unexpected errors. there may be more than one occurrence of the message in the list. Get_Entity_Message (IN p_entity_id. The same applies to the Other Message and Token List.

IN p_entity_index) Get_Message (OUT x_entity_id. IN p_bo_ identifier) Delete_Message (IN p_entity_ic. OUT x_entity_index OUT x_message_text OUT x_bo_identifier Message API Description This API will return message from the index th position for an entity within a business object This API will delete all messages for a particular entity within a business object This API will delete message from the index the position for an entity within a business object This API can be used within a loop to get one message at a time from the Message List. 3-44 Oracle Manufacturing APIs and Open Interfaces Manual . IN p_bo_ identifier. Every time the user does a get_message. IN p_entity_index IN p_bo_identifier OUT x_message_text) Delete_Message (IN p_entity_id.Bill of Material Import Error Handling and Messaging Table 3–19 Message API Name Get_Entity_Message (IN p_entity_id. a message counter will be incremented to the next message index.

Assembly_item_id Must be the inventory_item_id of the bill. It uniquely identifies a bill which will be exploded with the bill details in the bom_export_tab. PL/SQL table.Bill of Material Export API Bill of Material Export API The Bill of Material Export API provides the ability to export bill of material data for a particular assembly. Organization_id Uniquely identifies a bill which will be exploded with the bill details in the bom_ export_tab. Alternate_bom_designator The alternate bill defined for this primary bill. and must exist in the mtl_system_items table for that organization. This item must exist in all subordinate organizations under the hierarchy origin. You can insert bill of material information returned by the API in the custom table or some other storage mechanism. BOMPXINQ. If this value is greater than or equal to the levels of the bill being exported. This API supports companies having large organization structures. This can be passed as NULL or if there are no alternatives defined. Org_hierarchy_name The name of the organization hierarchy to which all subordinate organizations will receive the exported bill of material data. then that bill will be exploded to the lowest level. Costs Bills of Material Business Object Interface 3-45 . Launching the Export You need to call the API in the following way: 1. The number of levels to which a BOM is exploded for a particular organization depends on the Max Bill Levels field setting in the Organization Parameters form.EXPORT_BOM INPUT Parameters Profile_id Security Profile Id. in all subordinate organizations in a specified organization hierarchy. PL/SQL table.

This information can be inserted into a custom table. then it will take the default value of 2. written to a text file. Cost_type_id Pass the appropriate cost_type_id for that item and organization combination. Oracle database related errors. Err_Msg Error Messages. If this parameter is passed as NULL or.Bill of Material Export API Pass parameter as 1. If the parameter is passed as 2. SQLCODE If the error code equals a value other than zero. OUTPUT Parameters bom_export_tab PL/SQL table containing the exploded bill of material information. Error_Code Error Codes. You need to reduce the number of levels of the bill. before inserting the date into a custom table. Pass the appropriate cost_ type_id for that item and organization combination.) Error_Code should have a value of zero and Err_ Msg should be NULL. or passed to host arrays (Oracle Call Interface. if cost details need to be exported. Bill exceeds the maximum number of levels defined for that organization. Because the output is inserted into a PL/SQL 3-46 Oracle Manufacturing APIs and Open Interfaces Manual . Export Error Handling and Messaging The Bill of Material Export API may return the following values for error code: Table 3–20 Error Code 0 9998 Error Codes Description Successful. then pass cost_type_id as having zero value. the contents of the output PL/SQL table (bom_export_tab) are deleted. This works in conjunction with the Costs parameter. or increase the maximum number of levels allowed for a bill in that organization.

After accessing this API. PL/SQL Output Table (BOM_EXPORT_TAB) Columns TOP_BILL_SEQUENCE_ID BILL_SEQUENCE_ID COMMON_BILL_SEQUENCE_ID ORGANIZATION_ID COMPONENT_SEQUENCE_ID COMPONENT_ITEM_ID COMPONENT_QUANTITY PLAN_LEVEL EXTENDED_QUANTITY SORT_ORDER GROUP_ID TOP_ALTERNATE_DESIGNATOR COMPONENT_YIELD_FACTOR TOP_ITEM_ID COMPONENT_CODE INCLUDE_IN_ROLLUP_FLAG LOOP_FLAG PLANNING_FACTOR OPERATION_SEQ_NUM BOM_ITEM_TYPE PARENT_BOM_ITEM_TYPE ASSEMBLY_ITEM_ID WIP_SUPPLY_TYPE ITEM_NUM EFFECTIVITY_DATE Bills of Material Business Object Interface 3-47 .Bill of Material Export API table instead of a database table. you should check the value of Error Code and Error Message before inserting the data from the PL/SQL table to custom tables. this API can be rerun multiple times without concerns regarding the committed data.

Bill of Material Export API DISABLE_DATE IMPLEMENTATION_DATE OPTIONAL SUPPLY_SUBINVENTORY SUPPLY_LOCATOR_ID COMPONENT_REMARKS CHANGE_NOTICE OPERATION_LEAD_TIME_PERCENT MUTUALLY_EXCLUSIVE OPTIONS CHECK_ATP REQUIRED_TO_SHIP REQUIRED_FOR_REVENUE INCLUDE_ON_SHIP_DOCS LOW_QUANTITY HIGH_QUANTITY SO_BASIS OPERATION_OFFSET CURRENT_REVISION LOCATOR ATTRIBUTE1 ATTRIBUTE2 ATTRIBUTE3 ATTRIBUTE4 ATTRIBUTE5 ATTRIBUTE6 ATTRIBUTE7 ATTRIBUTE8 ATTRIBUTE9 ATTRIBUTE10 3-48 Oracle Manufacturing APIs and Open Interfaces Manual .

Bill of Material Export API ATTRIBUTE11 ATTRIBUTE12 ATTRIBUTE13 ATTRIBUTE14 ATTRIBUTE15 Bills of Material Business Object Interface 3-49 .

This section describes the basic business needs. s Detailed and Translatable Error Messages. and Deleting Routing Information Use the Routing API to create. the Routing API reports detailed and translatable error messages. It processes the information within a routing synchronously and stills you to process more than one routing simultaneously. You can automatically process routing data without inserting cryptic IDs or system specific information. s Asynchronous Processing of Routing. You do not have to wait for one process to finish before starting the next. When processing data. s Routing Data Encapsulation. Routing Entity Diagram The following diagram shows the table structure to the Routing API along with the corresponding entities: 3-50 Oracle Manufacturing APIs and Open Interfaces Manual . Updating. You can use the Routing API located in the Open Interface program to update or delete routing in the external system.Routing API Overview Routing API Overview The Routing API enables you to import routing information from a legacy system. update and delete a routing from a form and the external system. it processes operation sequences before operation resources. The Routing API requires only the business data needed to define the routing.s You can process different Routing business objects simultaneously. update and delete routing information. business object architecture and components for the routing API. s Synchronous Processing of Information within a Routing. The error messages identifies the severity and scope of the error as well as how other associated records are effected. You can create. The Routing API processes the information within a routing synchronously. Upon failure. you do not have to provide system specific data. Routing API Features s Creating. major features. Following the business hierarchy.

Routing Header The routing header entity defines the basic routing scheme. The routing header contains information about the time. the alternate designator. The entities connected directly below are its children. To use the Routing Business object interface. There can only be one routing header per routing scheme.Routing API Overview Figure 3–2 Routing Entity Diagram Routing Architecture The Routing Business Object Architecture is based on the hierarchical definition of Routings and related sub-entities in Oracle Bill of Material. and the revision. As in a genealogical tree. unit of measure. alternate designator. and the organization. specify the item. you only need to know the structure or your routing. To identify a routing. Bills of Material Business Object Interface 3-51 . the entity at the top is the parent.

you must specify the item. specify the item. The Routing API as it exists in the database Each of the entities shown in the Routing entity diagram maps to a corresponding table in the database.Routing API Overview Routing Revisions The revisions entity stores the routing revision information. specify the item. To identify an operation resource. Use this entity to add a substitute resource to t he operation sequence and operation resources that contain a substitute group number and scheduling sequence number. organization. To identify a routing revision specify the item and the organization. operation effectivity date. schedule sequence number. alternate designator. operation effectivity date. Operation Sequence The operation sequence entity enables you to specify an operation sequence. Operation Network The operation network entity cannot exist without an operation sequence. operation type. operation effectivity date. 3-52 Oracle Manufacturing APIs and Open Interfaces Manual . To identify an operation sequence. To identify a substitute operation resource. Operation Resource The operation resource entity enables you to add resources to an operation sequence. organization. and substitute group number. operation type. and resource sequence number. operation type. and operation sequence number. The following are the existing production tables. Substitute Operation Resource The substitute operation resource entity cannot exist without an operation sequence and related operation resources. alternate designator. alternate designator. operation sequence number. organization operation sequence number.

Stores information about resources that you require to complete operations on routings. and each of the branches are child nodes or entities. If you do not have access to an assembly item. then you do not have access to any entity records associated with that item. Each node in a branch is the parent of the child nodes under it. To avoid these problems. This saves the program from retrieving information again. You can also view it as a tree with branches. Bills of Material Business Object Interface 3-53 . Stores information about substitute resources used in an operation Stores information about routing operation network. Stores information about operation sequences. Here is an example: Figure 3–3 API Traversal Strategy The Routing API is a closely tied object. BOM_OPERATIONAL_ROUTINGS MTL_RTG_ITEM_REVISIONS BOM_OEPRATION_RESOURCES BOM_OPERATION_SEQUENCES BOM_SUB_OPERATION_RESOURCES BOM_OPERATION_NETWORKS API Traversal Strategy The routing API articular is a hierarchy of entities. Certain assembly item characteristics and errors affect the children and possibly other assembly items and other API records. the program must traverse the tree in and efficient manner to achieve the following: s Cut down the amount of required processing.Routing API Overview Table 3–21 Production Table Production Tables Description Stores information about manufacturing and engineering routing headers Stores information revisions levels for routings. where the routing header entity is the parent. Use specific facts established during process of other records.

For example. Sometimes an error in a parent record implies an error in all children attached to a parent. if you are unable to create a routing header.Routing API Overview s Provide intelligent error handling. 3-54 Oracle Manufacturing APIs and Open Interfaces Manual . you will not be able to create a revised operation for the routing.

Prog_Id in System_Information record. -N/AQuit import of business object Severe Error I Error -N/A- Bills of Material Business Object Interface 3-55 . All records must have the same. MDL_Item_Access and OC_Item_ Access respectively. before moving onto to a sibling. Login_Id. The highest level record with a {return status = NULL} is picked. the highest level parent must be chosen. Step 3: Save system information Saves system-specific information in System_Information record since it is common to the whole business object. BOM: Model Item Access into STD_Item_Access. There should be only one Header record. Pull in values of profiles profile BOM: Standard Item Access. There may be more than one record for other entities. the program exits and transfers control to the caller. Step 2: Check for Organization uniformity We must ensure that all records in a business object belong to t he same Organization. Prog_ Appid. Step 4: Pick up highest level un-processed record The import program processes a parent and all its direct and indirect children. Set Business Object Identifier to ‘RTG’ in the system information. So. This information is stored in the database along with the record Initialize User_Id. When there are no more records. Pull in values of Cfm_routing_flag into Flow_Routing_Flag and Lot_Based_ Routing_Flag. Derive organization_id from Organization_Code Store organization_id value in System_ Information record.Routing Import Description Routing Import Description Table 3–22 Step Step 1: Pass Business Object to Public API Purpose The program will try to import it Routing Import Description Description Caller must pass one business object at a time.

For UPDATE and DELETE. and is truly the current record’s parent in the database. and may consist of more than one column. A valid parent is one that exists. It serves the following purposes: Step 6: Existence Verification The record being updated or deleted in the database must already exist. the record must exist. is truly the parent of this record in the database. Error Severe Error III Unique index helps uniquely identify a record in the database. based on Transaction_Type and the following factors: Immediate parent being referenced exists in the database. the indirect parent being referenced exists and is really the parent of the current record’s parent in the database.) cannot be operated upon if the assembly item is implemented or canceled.Routing Import Description Table 3–22 Step Step 5: Convert user-unique index to unique index Purpose Routing Import Description Description The user need not enter cryptic Ids If a user unique index could not be derived for a parent. Such an error in a record must cause all children to error out. For CREATE. If not. since they are referencing an invalid parent We must ensure that the linkage of records is correct in the business object. Derive unique index columns from user-unique index columns. Query up database record into the associated OLD record. Severe Error III Step 8(a): Check operability of parent items and current item (if applicable) Routing and any of it’s children (operation. That is. the record must not already exist. for UPDATE and DELETE. User-unique index is a user-friendly equivalent of the unique index. find it in the database assembly item record. OR If there is no immediate parent record in the business object. Check if System_Information record has this information. resources etc. and. Fatal Error III or Fatal Error II (depending on affected entity) 3-56 Oracle Manufacturing APIs and Open Interfaces Manual . child records must reference valid parents. But a record being created must not. it’s entire lineage is error-ed out since members of the lineage are referencing an invalid parent. and set System_Information flags accordingly. Severe Error III Step 7: Check Lineage Perform lineage checks for entity records that do not belong to the top-most entity in the hierarchy.

The user must enter values for these fields. Step 9: Check flow routing and Lot based routing operability If the routing is flow routing (Cfm_ routing_flag = 1). Bills of Material Business Object Interface 3-57 . since the Ids can be derived from them. them. Check if System_Information record has this information.) cannot be operated upon if the user does not have access to assembly item for routing. and set System_Information flags accordingly. valid. The value columns free up the user from having to enter cryptic Ids. If not. find it in the II database and set System_Information flag accordingly. UPDATE: Standard Error Step 11: Required Fields checking Step 12: Attribute validation (CREATEs and UPDATEs) Each of the attributes/fields must Check that user-entered attributes are be checked individually for validity. Error Fatal Error II Routing and any of it’s children (operation. If not. find it in the database assembly item record. . Check if the Organization is WSM Enabled Check if System_Information record Fatal Error has this information. Without are not NULL. the operation cannot go through. Check Flow Manufacturing have been installed If the routing is lot based routing (Cfm_routing_flag = 3). Check if System_Information record has this information. resources etc. Other: Standard Error CREATE: Severe Error IV. If not. Step 10: Value-Id conversions There are user-friendly value Derive Ids from user-friendly values. columns that derive certain Id columns. Some fields are required for an Check that the required field columns operation to be performed. Other: Standard Error CREATE: Severe Error IV. and set System_Information flags accordingly. CREATE: Severe Error IV. find it in the database assembly item record.Routing Import Description Table 3–22 Step Step 8(b): Check assembly item operability for Routing Purpose Routing Import Description Description Check item attribute if the user can create routing for the assembly item. Check each attribute Examples of these checks are: range independently of the others checks and checks against lookups.

try to default in IV values. For all NULL columns in record. independently of each other. Non-updateable columns (UPDATEs): Certain columns must not be changed by the user when updating the record. For all NULL columns found in Severe Error business object record. So the program must default in individual attribute values. columns in other tables. Values business object record. other columns in defaulting the same table. UPDATE: Standard Error CREATE: Severe Error IV. etc. there is no OLD record. This feature enables the user to enter minimal information for the operation. Set all MISSING column values to NULL. UPDATE: Standard Error Step 17: Entity This is where the whole record is Perform checks against record in the level checked. try to CREATE: default in values based on other values. Step 15: Check conditionally required attributes Perform checks to confirm all conditionally required attributes are present. Severe Error IV Step 16: Entity Certain column values may depend level on profile options. The following are checked: order specified in the -Purposevalidation column. either by retrieving them from the database. This feature enables you to enter minimal information for the operation to proceed. Severe Error IV.Routing Import Description Table 3–22 Step Step 13: Populate NULL column (UPDATEs and Deletes Step 14: Default values for NULL attributes (CREATEs) Purpose Routing Import Description Description Error The user may send in a record with For all NULL columns found in -N/Acertain values set to NULL. Some attributes are required based on certain external factors such as the Transaction_Type value. or by having the program assign values. copy over values for all such columns are copied over from OLD record from the OLD record. Cross-attribute checking: The validity of attributes may be checked. based on factors external to it Business logic: The record must comply with business logic rules 3-58 Oracle Manufacturing APIs and Open Interfaces Manual . Defaulting for these columns happens here. For CREATEs.

the program moves up to Process parent the parent (of this entire branch) record’s and processes all of its siblings siblings (which contain branches of their own). A branch within the business object tree consists of all direct and indirect children. Error -N/A- Write record to database table. Go to Step 21.Routing Import Description Table 3–22 Step Step 18: Database writes Purpose Routing Import Description Description Perform database write: Insert record for CREATE Overwrite record for UPDATE and CANCEl. Then pick up the first un-processed indirect child record and do the same as above. Pick up the first un-processed child record and Go to Step 5. Step 21: Go up to parents and pick up the first un-processed sibling of the parent. The sibling may also contain a branch. When no more records are found. the siblings of the current record are processed. So the processing for the sibling will be exactly the same as the current record. When no more records are found. -N/A- Once all the siblings have been processed. Step 19: Process direct and indirect children The program will finish processing an entire branch before moving on to a sibling branch. Go to Step 4. Continue through the loop until all siblings have been processed. -N/A- Step 20: Process siblings When an entire branch of a record has been processed. Bills of Material Business Object Interface 3-59 . Go to Step 5. Pick up the first un-processed sibling record and Go to Step 5. When there are nor more records. Go to Step 20. Continue until all direct children have been processed.

Table 3–23 IRouting Header Name Assembly_Item_ Name Organization_Code Alternate_Routing_ Code Eng_Routing_Flag Type VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) NUMBER Reference Designator Exposed Columns Required x x x Derived X Optional x x x x x x x x x x x x x x Common_Assembly_ VARCHAR2(81) Item_Name Routing_Comment Completion_ Subinventory Completion_ Location_Name Line_Code CFM_Routing_Flag VARCHAR2(240) VARCHAR2(10) VARCHAR2(81) VARCHAR2(10) NUMBER Mixed_Model_Map_ NUMBER Flag Total_Cycle_Time Priority CTP_Flag Attribute_Category Attribute1 Attribute2 Attribute3 NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 3-60 Oracle Manufacturing APIs and Open Interfaces Manual .Routing Parameter Descriptions Routing Parameter Descriptions Routing Headers Exposed Columns The following table describes all parameters the BOM_OPERATIONAL_ ROUTINGS table uses. Additional information on these parameters follows.

Routing Parameter Descriptions Table 3–23 IRouting Header Name Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Transaction_Type Return_Status Original_System_ Reference Type Reference Designator Exposed Columns Required x Derived Optional x x x x x x x x x x x x x x x x VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(1) VARCHAR2(50) Delete_Group_Name VARCHAR2(10) DG_Description VARCHAR2(240) Assembly_Item_Name Inventory item name of a manufactured assembly. Default Value: FND_API.G_MISS_CHAR Organization_Code Identifies the organization Default Value: FND_API.G_MISS_CHAR Bills of Material Business Object Interface 3-61 .

G_MISS_CHAR Completion_Subinventory Destination subinventory for assembly Default Value: FND_API. Default= FND_API.Routing Parameter Descriptions Alternate_Routing_Code Alternate routing designator code Default Value: FND_API. 2.G_MISS_CHAR 3-62 Oracle Manufacturing APIs and Open Interfaces Manual . MFG Routing Eng Routing) Default= FND_API.G_MISS_NUM Common_Assembly_Item_Name Inventory item identifier of a common assembly.G_MISS_CHAR Completion_Location_Name Destination location for an assembly Default Value: FND_API.G_MISS_CHAR Eng_Routing_Flag The rule that sets the routing as a manufacturing item or an engineering item. The default is derived from the common_assembly_item_name. Valid values are as follows: 1.G_MISS_CHAR Routing_Comment Common about Routing. Default Value: FND_API.G_MISS_CHAR Line_Code Name of the WIP line Default Value: FND_API.

G_MISS_NUM Total_Cycle_Time Total time an assembly takes along the primary path in the operation network calculated by Flow Manufacturing.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. Bills of Material Business Object Interface 3-63 . Yes No) Default Value: FND_API. Valid values are as follows: 1.G_MISS_NUM CTP_Flag Flag that indicates capacity must be checked when item is ordered Default Value: FND_API.G_MISS_NUM Priority This parameter is for informational use.G_MISS_NUM Attribute_category The category of the flexfield described in the attribute column Default Value: FND_API.Routing Parameter Descriptions CFM_Routing_Flag Continuous flow. 2. Default Value: FND_API.G_MISS_NUM Mixed_Model_Map_Flag You use this routing in mixed model map calculation. Default Value= FND_API. or traditional routing Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields.

Valid Values include: Success: FND_API. Table 3–24 IRouting Revision Name Assembly_Item_ Name Organization_Code Revision Start_Effective_Date Attribute_Category Attribute1 Type VARCHAR2(81) VARCHAR2(3) VARCHAR2(3) DATE ARCHAR2(30) VARCHAR2(150) Routing Revision Exposed Columns Required x x x Derived Optional x x x 3-64 Oracle Manufacturing APIs and Open Interfaces Manual . update or delete.G_RET_STS_ERROR Delete_Group_Name Delete group name of the entity type you are deleting Default Value: FND_API.G_MISS_CHAR Transaction_Type Type of action including create.G_MISS_CHAR Return_Status Processing status of the API after it completes its function.G_MISS_CHAR Routing Revision Exposed Columns The following table describes all the parameters the MTL_RTG_ITEM_REVISIONS table.G_MISS_CHAR Error: FND_API.G_MISS_CHAR DG_Description Description of the group you are deleting. Default Value: FND_API. Default Value: FND_API.Routing Parameter Descriptions Default Value: FND_API.

G_MISS_CHAR Bills of Material Business Object Interface 3-65 .Routing Parameter Descriptions Table 3–24 IRouting Revision Name Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Transaction_TypeReturn_StatusOriginal_System_ Reference Type Routing Revision Exposed Columns Required x Derived Optional x x x x x x x x x x x x x x x x VARCHAR2(150) VARCHAR2(150 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150 VARCHAR2(150) VARCHAR2(150 ARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(1) VARCHAR2(50 Assembly_Item_Name Inventory item name of a manufactured assembly.G_MISS_CHAR Organization_Code Identifies the organization Default Value: FND_API. Default Value: FND_API.

G_MISS_CHAR Revision Routing Revision Default Value: FND_API.G_MISS_CHAR Start_Effective_Date Effective Date. Default Value: FND_API.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. Default Value: FND_API.G_RET_STS_ERROR 3-66 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_CHAR Transaction_Type Type of action including create. Default Value: FND_API. Valid Values include: Success: FND_API. Default Value: FND_API.Routing Parameter Descriptions Alternate_Routing_Code Alternate routing designator code Default Value: FND_API.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields. update or delete.G_MISS_DATE Attribute_category The category of the flexfield described in the attribute column Default Value: FND_API.G_MISS_CHAR Return_Status Processing status of the API after it completes its function.G_MISS_CHAR Error: FND_API.

Table 3–25 IOperation Sequence Name Assembly_Item_ Name Organization_Code Alternate_Routing_ Code Operation_ Sequence_Number Operation_Type Start_Effective_Date New_Operation_ Sequence_Number Type VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) NUMBER NUMBER DATE NUMBER Operation Sequence Exposed Columns Required x x x x x Derived x Optional x x x x x x x x x x x New_Start_Effective_ DATE Date Standard_Operation_ NUMBER Code Department_Code Op_Lead_Time_ Percent Minimum_Transfer_ Quantity Count_Point_Type Operation_ Description Disable_Date Backflush_Flag Option_Dependent_ Flag NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) DATE NUMBER NUMBER Bills of Material Business Object Interface 3-67 .Routing Parameter Descriptions Operation Sequence Exposed Columns The following table describes all the parameters the BOM_OPERATION_ SEQUENCES table.

MBER VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 3-68 Oracle Manufacturing APIs and Open Interfaces Manual .Routing Parameter Descriptions Table 3–25 IOperation Sequence Name Reference_Flag Process_Seq_ Number Process_Code Line_Op_Code Yield Cumulative_Yield Reverse_CUM_Yield User_Labor_Time User_Machine_Time Net_Planning_ Percent Include_In_Rollup Op_Yield_Enabled_ Flag Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Type NUMBER NUMBER Operation Sequence Exposed Columns Required Derived x Optional x x x x x x x x x x x x x x x x x x x x x x x x VARCHAR2(4) VARCHAR2(4) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NU.

Routing Parameter Descriptions Table 3–25 IOperation Sequence Name Attribute13 Attribute14 Attribute15 Transaction_Type Return_Status Type Operation Sequence Exposed Columns Required x Derived Optional x x x x VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30)) VARCHAR2(1) Assembly_Item_Name Inventory item name of a manufactured assembly. Default Value: FND_API. a line operation.G_MISS_NUM Operation_Type A process. Default Value: FND_API.G_MISS_DATE Bills of Material Business Object Interface 3-69 .G_MISS_NUM Start_Effective_Date Default Value: FND_API.G_MISS_CHAR Organization_Code Identifies the organization.G_MISS_CHAR Operation_Sequence_Number Routing operation unique identifier Default Value: FND_API. or an event.G_MISS_CHAR Alternate_Routing_Code Alternate routing designator code. Default Value: FND_API. Default Value: FND_API.

Default Value: FND_API. Default Value: FND_API.Routing Parameter Descriptions New_Operation_Sequence_Number Added to facilitate updates because it is part of the primary key. FND_API.G_MISS_NUM New_Start_Effective_Date Added to facilitate updates because it is part of the primary key. Default Value: FND_API.G_MISS_DATE Standard_Operation_Code Standard operation unique identifier Default Value: FND_API.G_MISS_CHAR 3-70 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_CHAR Department_Code Department Code.G_MISS_NUM Minimum_Transfer_Quantity Minimum operation transfer quantity.G_MISS_CHAR Op_Lead_Time_Percent Indicates the amount of overlapping lead time the child operation with the parent operation.G_MISS_NUM Operation_Description Description of the operation FND_API.G_MISS_NUM Count_Point_Type Operation Move Type FND_API.

This applies only to events. Default Value: FND_API.Routing Parameter Descriptions Disable_Date Date the operation is no longer effective.G_MISS_NUM Process_Seq_Number Operation sequence identifier of parent process.G_MISS_DATE Backflush_Flag Indicates if an operations requires Backflush_Flag. even if no components of the configuration are used in this operation.G_MISS_NUM Reference_Flag If the Standard operation is references or copied then the operation cannot be updated. Default Value: FND_API.G_MISS_NUM Process_Code Process code. Default Value: FND_API. Bills of Material Business Object Interface 3-71 . Effectivity lasts until the end of the disable date.G_MISS_NUM Option_Dependent_Flag Indicates if to sue this operation in all configuration routings.G_MISS_CHAR Line_Op_Seq_Number Operation sequence identifier of the parent line operation. Default Value: FND_API.G_MISS_NUM Line_Op_Code Line Operation code. Default Value: FND_API. This applies only to events. Default Value: FND_API. Default Value: FND_API.

G_MISS_NUM Net_Planning_Percent Cumulative planning percent derived from the operation network. Default Value: FND_API.G_MISS_NUM Cumulative_Yield Cumulative process yield from beginning of routing to this operation.Routing Parameter Descriptions FND_API.G_MISS_NUM User_Labor_Time User calculated run time attributable to labor.G_MISS_NUM Include_In_Rollup Indicates if the operation yield is considered in cost rollup. Default Value: FND_API.G_MISS_NUM User_Machine_Time User calculated run time attributable to machines. Default Value: FND_API.G_MISS_NUM Reverse_CUM_Yield Cumulative process yield from end of routing to comparable operation. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Yield Process yield at this operation.G_MISS_NUM Op_Yield_Enabled_Flag Indicates if operation yield is considered during costing.G_MISS_NUM 3-72 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.

Bills of Material Business Object Interface 3-73 . Default Value: FND_API. Default Value: FND_API.G_MISS_CHA Operation Resources Exposed Columns The following table describes all the parameters the BOM_OPERATION_ RESOURCES table.G_MISS_CHAR Transaction_Type Type of action including create. update or delete. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Return_Status Processing status of the API after it completes its function.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields.G_RET_STS_ERROR Delete_Group_Name Delete group name of the entity type you are deleting. Default Value: FND_API.Routing Parameter Descriptions Attribute_category The category of the flexfield described in the attribute column.G_MISS_CHAR Error: FND_API.G_MISS_CHAR DG_Description Description of the group you are deleting.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. Default Value: FND_API. Valid values include: Success: FND_API.

Routing Parameter Descriptions Table 3–26 Operation Resource Name Type Assembly_Item_ Name Organization_Code Alternate_Routing_ Code Operation_ Sequence_Number Operation_Type Op_Start_Effective_ Date Resource_Sequence_ Number Resource_Code Activity Standard_Rate_Flag Assigned_Units Usage_Rate_Or_ amount Usage_Rate_Or_ Amount_Inverse Basis_Type Schedule_Flag Resource_Offset_ Percent Autocharge_Type Schedule_Sequence_ Number Principle_Flag Setup_Type Operation Resource Exposed Columns Required x x x x x Derived x x x x x x x x x x x x x x Optional - VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) NUMBER NUMBER DATE NUMBER VARCHAR2(10) VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) 3-74 Oracle Manufacturing APIs and Open Interfaces Manual .

G_MISS_CHAR Bills of Material Business Object Interface 3-75 . Default Value: FND_API.G_MISS_CHAR Organization_Code Identifies the organization. Default Value: FND_API.Routing Parameter Descriptions Table 3–26 Operation Resource Name Type Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Transaction_Type Return_Status Original_System_ Reference Operation Resource Exposed Columns Required x Derived Optional x x x x x x x x x x x x x x x x x x VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(1) VARCHAR2(50) Assembly_Item_Name Inventory item name of a manufactured assembly.

G_MISS_CHAR Department_Code Department Code. Default Value: FND_API.G_MISS_NUM Operation_Type A process.G_MISS_CHAR Operation_Sequence_Number Routing operation unique identifier Default Value: FND_API.Routing Parameter Descriptions Alternate_Routing_Code Itinerant routing designator code.G_MISS_CHAR Op_Lead_Time_Percent Indicates the amount of overlapping lead time the child operation with the parent operation. Default Value: FND_API. a line operation. or an event.G_MISS_NUM Start_Effective_Date Default Value: FND_API. 3-76 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_DATE New_Operation_Sequence_Number Added to facilitate updates because it is part of the primary key. FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM New_Start_Effective_Date Added to facilitate updates because it is part of the primary key.G_MISS_DATE Standard_Operation_Code Standard operation unique identifier.

G_MISS_NUM Reference_Flag If the Standard operation is references or copied then the operation cannot be updated.G_MISS_NUM Count_Point_Type Operation Move Type. FND_API. Effectivity lasts until the end of the disable date. even if no components of the configuration are used in this operation. Default Value: FND_API.G_MISS_NUM Operation_Description Description of the operation.G_MISS_NUM Option_Dependent_Flag Indicates if to sue this operation in all configuration routings.G_MISS_CHAR Disable_Date Date the operation is no longer effective. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.Routing Parameter Descriptions Default Value: FND_API.G_MISS_NUM Bills of Material Business Object Interface 3-77 . Default Value: FND_API.G_MISS_DATE Backflush_Flag Indicates if an operations requires Backflush_Flag.G_MISS_NUM Minimum_Transfer_Quantity Minimum operation transfer quantity. FND_API.

Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM Cumulative_Yield Cumulative process yield from beginning of routing to this operation. Default Value: FND_API. FND_API. Default Value: FND_API.G_MISS_NUM Line_Op_Code Line operation code.Routing Parameter Descriptions Process_Seq_Number Operation sequence identifier of parent process.G_MISS_NUM Process_Code Process Code.G_MISS_NUM User_Labor_Time User calculated run time attributable to labor.G_MISS_CHAR Yield Process yield at this operation. This applies only to events. This applies only to events.G_MISS_NUM 3-78 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_NUM Reverse_CUM_Yield Cumulative processes yield from end of routing to comparable operation. Default Value: FND_API.G_MISS_CHAR Line_Op_Seq_Number Operation sequence identifier of the parent line operation.

Default Value: FND_API. update or delete.G_MISS_NUM Op_Yield_Enabled_Flag Indicates if operation yield is considered during costing. Default Value: FND_API.G_MISS_CHAR Bills of Material Business Object Interface 3-79 .G_MISS_NUM Attribute_category The category of the flexfield described in the attribute column. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM Include_In_Rollup Indicates if the operation yield is considered in cost rollup. Default Value: FND_API.G_MISS_CHAR Transaction_Type Type of action including create.Routing Parameter Descriptions User_Machine_Time User calculated run time attributable to machines.G_MISS_NUM Net_Planning_Percent Cumulative planning percent derived from the operation network. Default Value: FND_API.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields.G_MISS_CHAR Original_System_Reference Legacy system from which the data for the current record has come. Default Value: FND_API.

Valid values include: Success: FND_API. v Table 3–27 Substitute Operation Resource Name Type Assembly_Item_ Name Organization_Code Alternate_Routing_ Code Operation_ Sequence_Number Operation_Type Op_Start_Effective_ Date Sub_Resource_Code Substitute Operation Resources Exposed Columns Required x x x x x x - Derived - Optional x x VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) NUMBER NUMBER DATE VARCHAR2(10) New_Sub_Resource_ VARCHAR2(10) Code 3-80 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_CHA INDEX BY BINARY_INTEGER Substitute Operation Resources Exposed Columns The following table describes all the parameters the BOM_SUB_OPERATION_ RESOURCES table.G_RET_STS_ERROR Delete_Group_Name Delete group name of the entity type you are deleting.Routing Parameter Descriptions Return_Status Processing status of the API after it completes its function. Default Value: FND_API.G_MISS_CHAR Error: FND_API.G_MISS_CHAR DG_Description Description of the group you are deleting.

Routing Parameter Descriptions Table 3–27 Substitute Operation Resource Name Type Schedule_Sequence_ Number Replacement_ Group_Number Activity Standard_Rate_Flag Assigned_Units Usage_Rate_Or_ amount Usage_Rate_Or_ Amount_Inverse Basis_Type Schedule_Flag Resource_Offset_ Percent Autocharge_Type Principle_Flag Setup_Type Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 NUMBER NUMBER Substitute Operation Resources Exposed Columns Required x x - Derived x x x x x x - Optional x x x x x x x x x x x x x x x x VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Bills of Material Business Object Interface 3-81 .

Default Value: FND_API.Routing Parameter Descriptions Table 3–27 Substitute Operation Resource Name Type Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Transaction_Type Return_Status Substitute Operation Resources Exposed Columns Required - Derived - Optional x x x x x x x VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(1) Assembly_Item_Name Inventory item name of a manufactured assembly. Default Value: FND_API.G_MISS_CHAR Operation_Sequence_Number Routing operation unique identifier Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM Op_Start_Effective_Date 3-82 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_NUM Operation_Type A process.G_MISS_CHAR Organization_Code Identifies the organization. a line operation. or an event.G_MISS_CHAR Alternate_Routing_Code Itinerant routing designator code.

G_MISS_NUM Replacement_Group_Number Substitute Group Number Default Value: FND_API.G_MISS_CHAR New_Sub_Resource_Code Default Value: FND_API.G_MISS_NUM Bills of Material Business Object Interface 3-83 .G_MISS_CHAR Schedule_Sequence_Number Scheduling Sequence Number Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Standard_Rate_Flag Use standard rate for shopfloor transactions Default Value FND_API.G_MISS_NUM Activity Activity identifier Default Value FND_API.G_MISS_NUM Usage_Rate_Or_Amount Resource usage rate. Default Value: FND_API.G_MISS_NUM Assigned_Units Resource units assigned Default Value: FND_API.G_MISS_DATE Sub_Resource_Code Substitute resource identifier.Routing Parameter Descriptions Default Value:FND_API.

Default Value: FND_API.G_MISS_NUM Schedule_Flag Default Value: FND_API. Default Value: FND_API.Routing Parameter Descriptions Usage_Rate_Or_Amount_Inverse Resource usage rate inverse. Default Value: 3-84 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_NUM Resource_Offset_Percent Resource offset percent from the start of the routing.G_MISS_NUM Autocharge_Type Default Value: FND_API.G_MISS_NUM Attribute_Category The category of the flexfield described in the attribute column Default Value: FND_API.G_MISS_CHAR Setup_Type Setup ID.G_MISS_NUM Basis_Type Basis type identifier.G_MISS_NUM Principle_Flag Principle Flag Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields.

Routing Parameter Descriptions Original_System_Reference Legacy system from which the data from the current record has come. Table 3–28 Operation Networks Name Type Assembly_Item_ Name Organization_Code Alternate_Routing_ Code Operation_Type From_Op_Seq_ Number From_Start_ Effective_Date VARCHAR2(81) VARCHAR2(3) VARCHAR2(10) NUMBER NUMBER DATE OPeration Networks Exposed Columns Required x x x x Derived Optional x x x x x To_Op_Seq_Number NUMBER To_Start_Effective_ Date Connection_Type DATE NUMBER Bills of Material Business Object Interface 3-85 .G_MISS_CHAR Return_Status Processing status of the API after it completes its function. Transaction_Type Type of action including create. Valid Values include: Success: FND_API.G_MISS_CHAR Error: FND_API.G_RET_STS_ERROR Operation Networks Exposed Columns The following table describes all the parameters the BOM_OPERATION_ NETWORKS table. Default Value: FND_API. update or delete.

Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR Organization_Code Identifies the organization.Routing Parameter Descriptions Table 3–28 Operation Networks Name Type Planning_Percent Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Transaction_Type Return_Status Original_System_ Reference NUMBER OPeration Networks Exposed Columns Required x Derived Optional x x x x x x x x x x x x x x x x x x VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(30) VARCHAR2(1) VARCHAR2(50) Assembly_Item_Name Inventory item name of a manufactured assembly.G_MISS_CHAR 3-86 Oracle Manufacturing APIs and Open Interfaces Manual .

G_MISS_NUM Planning_Percent Planning Percentage Default Value: FND_API. Alternate or Rework connection Default Value: FND_API.G_MISS_DATE To_Op_Seq_Number To routing operation identifier Default Value: FND_API.Routing Parameter Descriptions Alternate_Routing_Code Alternate routing designator code. Default Value: FND_API.G_MISS_CHAR Operation_Type A process.G_MISS_NUM From_Op_Seq_Number From routing operation identifier FND_API. a line operation.G_MISS_NUM To_Start_Effective_Date TBD Default Value: FND_API. or an event Default Value: FND_API.G_MISS_NUM From_Start_Effective_Date TBD Default Value: FND_API.G_MISS_NUM Bills of Material Business Object Interface 3-87 .G_MISS_DATE Connection_Type Primary.

3-88 Oracle Manufacturing APIs and Open Interfaces Manual . update or delete. Default Value: FND_API. Valid Values include: Success: FND_API.G_MISS_CHAR Attribute 1-15 Descriptive text for flexfields.Routing Parameter Descriptions Attribute_Category The category of the flexfield described in the attribute column Default Value: FND_API.G_MISS_CHAR Error: FND_API_G_RET_STS_ERROR Original_System_Reference Legacy system from which the data from the current record has come. Transaction_Type Type of action including create.G_MISS_CHAR Return Status processing status of the API after it complete its function.

Launching the Routing Import Launching the Routing Import Three Step Rule You must follow the three step rule to use the Routing API effectively. The following section describes the steps in detail. The Public API Bills of Material Business Object Interface 3-89 . Use the following procedure to initialize the variables: FND_BLGOAL. Resp_appl_id is the application Responsibility ID. while sending in one business object at a time.resp_appl_idIN NUMBER] . User_id is the FND User ID of the person launching the program. 4. Resp_id is the FND Responsibility Id. You initialize specific variables to provide this information to the import program. 6. This initialization should be done when the session is established outside of a noraml forms or concurrent program connection. You must call the API programmatically. Step 2: Call the Public API The Public API is your interface to the Import program. 5.security_group_idINNUMBER) Pointers 1. The program retrieves system information from these variables during operation. Security_group is the FND Security Group ID.resp_idIN NUMBER . 2. Step 1: Initialize the System Information Each database table the programs writes to requires system information. Review all relevant information after the Public API completes. Call the Public API. This procedure initializes the global security context for each database session. 3. Initialize the system information. 2.apps_initialize (user_IDIN NUMBER . 1. 3.

Op_Network_Tbl_Type OUT Bom_Rtg_Pub. p_operation_tbl . p_rtg_header_rec .Rtg_Revision_Tbl_Type OUT Bom_Rtg_Pub.G_MISS_RTG_HEADER_REC :=Bom_Rtg_Pub. p_sub_resource_tbl . x_msg_count .G_MISS_SUB_RESOURCE_TBL := Bom_Rtg_Pub.G_MISS_OPERATION_TBL := Bom_Rtg_Pub. p_op_network_tbl .log’ .G_MISS_OP_NETWORK_TBL 3-90 Oracle Manufacturing APIs and Open Interfaces Manual .Operation_Tbl_Type OUT Bom_Rtg_Pub. The procedure to call the API is as follows: PROCEDURE Process_Rtg (p_bo_identifier . x_sub_resource_tbl .Launching the Routing Import returns the process business object. p_init_msg_list .Rtg_Header_Rec_Type IN Bom_Rtg_Pub. x_op_resource_tbl .G_MISS_RTG_REVISION_TBL := Bom_Rtg_Pub. p_debug . the business object status.Rtg_Header_Rec_Type OUT Bom_Rtg_Pub. p_op_resource_tbl . x_op_network_tbl . x_rtg_revision_tbl . and a count of all associated err and warning messages.Sub_Resource_Tbl_Type OUT Bom_Rtg_Pub. p_rtg_revision_tbl .Op_Network_Tbl_Type OUT VARCHAR2 OUT NUMBER IN VARCHAR2:= ’N’ IN VARCHAR2:= NULL IN VARCHAR2:= ’RTG_BO_debug.G_MISS_OP_RESOURCE_TBL := Bom_Rtg_Pub. p_api_version_number IN NUMBER:= 1.Operation_Tbl_Type IN Bom_Rtg_Pub.Rtg_Revision_Tbl_Type IN Bom_Rtg_Pub.0 :=Bom_Rtg_Pub.Sub_Resource_Tbl_Type IN Bom_Rtg_Pub.Op_Resource_Tbl_Type OUT Bom_Rtg_Pub. p_debug_filename IN VARCHAR2:= ’RTG’ IN BOOLEAN:= FALSE IN Bom_Rtg_Pub.Op_Resource_Tbl_Type IN Bom_Rtg_Pub. p_output_dir . x_operation_tbl . x_return_status . x_rtg_header_rec .

p_operation_tbl. p_rtg_header_rec. All OUT parameters begin with x_. The caller may look up this flag to choose an appropriate course of action (commit. p_rtg_revision_tbl. p_ sub_resource_tbl. this status will indicate the fact that there has been an error in the business object. or further processing by the caller). All these data structures directly correspond to the entities shown in the Routing entity diagram. x_return_status: This is a flag that indicates the state of the whole business object after the import. These records essentially constitute the whole business object as it was sent in. p_op_resource_tbl. x_op_network_tbl: This is the set of data structures that represents the outgoing business object. rollback. s s s Please note that any of these data structures may be sent in empty (set to NULL) to indicate that there are no instances of that entity in the business object being sent in. All the other data structures are PL/SQL tables of records that hold records for each of the other entities. x_rtg_header_rec is a record that holds the Routing header for the Routing. allows callers to request that the API do the initialization of the message list on their behalf. and return an unexpected error if they are incompatible. rolled back. or subjected to further processing by the caller. p_rtg_header_rec is a record that holds the Routing header for the Routing. if the business object import has been successful. all IN parameters begin with p_. All these data structures directly correspond to the entities shown in the Routing entity diagram. The following is a description of these parameters: p_api_version_number: It is used by the API to compare the version numbers of incoming calls to its current version number. if set to TRUE. Similarly. All the other data structures are PL/SQL tables of records that hold records for each of the other entities. s x_rtg_header_rec. except now it has all the changes that the import program made to it through all the steps in the Process Flow. x_ sub_resource_tbl. p_op_network_tbl: This is the set of data structures that represents the incoming business object. s Bills of Material Business Object Interface 3-91 . x_rtg_revision_tbl. the caller may set this to FALSE (or accept the default value) in order to do the initialization itself by calling FND_MSG_PUB.1 of the Business Object Coding Standards document for a detailed description of this parameter. x_operation_tbl. On the other hand. These records can be committed. x_op_resource_tbl.Initialize. See section 4.Launching the Routing Import As is obvious from the above specification. p_init_msg_list: This parameter. If there has been an error in a record. this flag will carry a status to indicate that.

a shell. Step 3: Review all relevant information after the Public API has completed You must look up the following s all error status that the Public API returns. as well as the individual record statuses. s 3-92 Oracle Manufacturing APIs and Open Interfaces Manual . Please see the Sample Shell section in the Appendix for a complete listing of the shell that was written to test the import program. s s The user can access the API message list using the following procedures and functions in the Error_Handler package: Resetting Messages: The following commands allow you to reset messages s PROCEDURE Initialize PROCEDURE Reset. the overall business object error status. or some other API which serves to extend the functionality of the import program. If it has any other value. This shell illustrates the correct usage of the import program. Note: A record must have an error status of NULL for it to be processed. including. all record attributes to see what changes occurred after applying business logic to these records.Launching the Routing Import s x_msg_count: This holds the number of messages in the API message stack after the import. x_msg_data: This returns a single message when the message count is 1. The purpose of this parameter is to save the caller the extra effort of retrieving a lone message from the message list. The caller here may be a form. it will not be picked up for processing. This parameter returns a 0 when there are no messages to return. all error and warning messages in the API message list. the Public API must be called programmatically. The user must remember to NULL out this field when sending in a record. This parameter returns NULL when there is more than one message. s As mentioned above.

x_message_text OUT VARCHAR2). PROCEDURE Delete_Message (p_entity_id IN VARCHAR2). x_entity_index OUT NUMBER . PROCEDURE Dump_Message_List.Error_Tbl_Type). p_entity_index IN NUMBER). s s s s Deleting Messages: The following commands enable you to delete messages: s PROCEDURE Delete_Message (p_entity_id IN VARCHAR2 .Launching the Routing Import Retrieving Messages: The following commands enable you to retrieve messages s PROCEDURE Get_Message_List (x_message_list OUT Error_Handler. PROCEDURE Get_Message (x_message_text OUT VARCHAR2 . x_message_list OUT Error_Handler. s s Bills of Material Business Object Interface 3-93 . x_entity_id OUT VARCHAR2).Error_Tbl_Type). PROCEDURE Get_Entity_Message (p_entity_id IN VARCHAR2 . PROCEDURE Get_Entity_Message (p_entity_id IN VARCHAR2 p_entity_index IN NUMBER . FUNCTION Get_Message_Count RETURN NUMBER.

So. That is. 2. Set business object identifier to RTG in the System Information record. Set business object status to S. The business object here is the Routing.BOM_Rtg_PUB This package is like a gatekeeper. Table 3–29 Description If there is an Routing Header in the business object. and Messages Error Severe Error I Message BOM_MUST_BE_IN_ SAME_RTG All records in a business object must belong to the same Routing. i. letting only one business object through at a time.e. If the business object does not have an Routing Header record. all records in an Routing Business Object instance must reference the same Routing.. Cause of Failure Any records have mismatched Assembly_Item_ Name. Errors. Failure. 3.Routing Package Interaction Routing Package Interaction The Public Package . Organization_Code and Alternate Designator values as the Header. Main Procedure: Process_Rtg 1. check that all records have the same Assembly_ Item_Name. all records must have the same Assembly Item Name and Organization_Code combination and Alternate Designator. Check that all records in the business object belong to the same Routing. and incoming records together make up an instance of the business object. they must all have the same Assembly Item Name. Organization_ Code and Alternate_ Routing_Code values 3-94 Oracle Manufacturing APIs and Open Interfaces Manual . This essentially means that all records in the business object must belong to the business object. Please check your records for this. check that all records have the same Assembly_Item_ Name and Organization_Code combination as the first highest level entity record picked up. Organization and Alternate Designator.

Table 3–30 Column Organization_Id Description Derive using Organization_Code from table MTL_ PARAMTERS Unexpected Error Other Messages BOM_UNEXP_ORG_INVALID: Due to an unexpected error. while performing a value to id conversion for the organization code. Accept processed business object and return status from Private API after the import. Pass business object into Private API if the business object status is still S. to identify the business object instance. this record was not processed. and pass it back to the calling program. Derive Organization_Id from Organization_Code and copy this value into all business object records.Routing Package Interaction 4. Bills of Material Business Object Interface 3-95 . 5. Errors and Messages Error Severe Error I Message BOM_ORG_ INVALID: The Organization <rigid> you entered is invalid. Also pass the Assembly Item Name and Organization_Id to Private API. 6.

Error Severity Levels Severity levels help distinguish between different types of errors since the import program behaves differently for each of these errors. s 3-96 Oracle Manufacturing APIs and Open Interfaces Manual . records are marked so that erroneous records are not processed again. They help the import program identify the records that do not need to be processed. When an error occurs. the entities the error extends itself over (scope of the error).Routing Import Error Handling and Messaging Routing Import Error Handling and Messaging Error Handling Concepts Error handling depends on the severity of the error. and how the error affects the lineage (child record error states). The following is a list of the error severity levels recognized by the import program: Table 3–31 Error Severity CODE ‘W’ ‘E’ ‘E’ ‘F’ ‘U’ MEANING Warning / Debug Standard Error Severe Error Fatal Error Unexpected error Error States serve two purposes: s They convey to the user the exact type of error in the record.

the status of the child may vary based on the type of error. Table 3–33 CODE ‘R’ ‘S’ ‘C’ ‘A’ MEANING Error Scope Error affects current ‘Record Error affects all ‘Sibling and child records Error affects ‘Child records Error affects ‘All records in business object Child Error States If an error in a record affects child records. that is. There are two error states that indicate how the child is affected: Table 3–34 CODE ‘E’ ‘N’ Child Error States MEANING Error Not Processed Bills of Material Business Object Interface 3-97 . how many other records in the business object hierarchy the current error affects.Routing Import Error Handling and Messaging Table 3–32 CODE ‘S’ ‘E’ ‘F’ ‘U’ ‘N’ Error States MEANING Success Error Fatal Error Unexpected Error Not Processed Error Scope: This indicates what the depth of the error is in the business object.

1. PTO Item) You do not have access to Flow Routing or Lot Based Routing. 5. but is not serious enough to affect any other records in the object. This error is usually a user-unique to unique index conversion error. 3. A characteristic of this record’s parent caused the error. so all it’s siblings and their children also get a record status of E. This error usually occurs when a lineage check fails. Severe Error IV: This error affects the current record and its child records since the program cannot properly process the child records. The current record and all its child record statuses are set to F. when the parent is not in the business object. s 7. The current record status is set to E. The following are situations that cause this error: s 2. This error is usually a change notice/organization uniformity error. Severe Error I: This error affects all records. Severe Error II: This error affects all records that are children of this record’s parent. All record statuses are set to E. so all it’s siblings and their children also get a record status of F. All record statuses are set to F. 4. 3-98 Oracle Manufacturing APIs and Open Interfaces Manual .Routing Import Error Handling and Messaging Error Classes There are three major classes that determine the severity of the problem. when the parent is not in the business object. The child record statuses are set to N. The child record statuses are set to E. You do not have access to this assembly item BOM item type. A characteristic of this record’s parent caused the error. Severe Error III: This error not only affects the current record but also its child records in the business object. 6. You do not have access to this Item Type: (BOM is not allowed. Fatal Error II: This error affects all records that are children of this record’s parent. before committing it to the production tables. Please check your child records for errors as well as the current record. Standard Error: This error causes only the current record to be error-ed out. This type of errors occur when there are errors on CREATEs Fatal Error I: These errors occur when it is not possible to perform any operation on the Routing. Expected errors: These are errors the program specifically looks for in the business object. The following situations cause this error: s 8. Such errors affect the entire business object. All records must have the same change notice/organization combination. Fatal Error III: These errors affects the current record and its children. since it is not possible to perform any operation on these records.

Routing Import Error Handling and Messaging Unexpected errors: All errors that are not expected errors are unexpected errors. For example: New Delete Group is created. or further processing by the caller). For example: the user entered value in the column only for Flow Routing is ignored in a standard routing. For example. it sets the business object error status (also called return status) appropriately to convey this to the user. A child record (of a particular parent) is one that holds the same values for the unique key columns as the parent record. rollback. As soon as the import program encounters an erroneous record. It is then up to the user to locate the offending record(s) using the individual record error statuses as indicated below. Sibling record: A sibling record (of the current record) is one that holds the same parent unique key column values as the current record. The following is a list of all the possible business object states: Bills of Material Business Object Interface 3-99 . The caller may also use the business object return status to choose an appropriate course of action (commit. Child record: All records carry the unique keys for all parents above them. the user somehow loses the database connection. a operation record that holds the same parent routing unique key column values as the current operation record. These are errors that the program is not specifically looking for. for example. Likewise. an operation resource record that holds the same parent operation sequence unique key column values is a sibling of the operation resource Business Object Error Status: This indicates the state of the whole business object after the import. we must introduce some terms that used extensively in this section. is a sibling of the current operation record. Warnings: These are messages for information only. and the rest of the document. to inform the user of any side-effects caused by user-entered data. In order to bring together all the concepts above into a workable algorithm. The purpose of warnings is: to warn the user of problems that may occur when the routing is implemented.

Hence. The following are important pointers about the record error status. The user must send in records with {return status = NULL}. if a record has a NULL return status. it means that the import program has not gotten to it yet. s The following shows how the error status. The error status helps locate erroneous records in a business object that has error-ed out. s Every record is assigned an error status by the import program. and child statuses relate together to constitute the different error classes for records: Table 3–36 Error Warning Standard Error Severe Error I Severe Error II Severe Error III Severe Error IV Error Class Messages Status S: Success E: Error E: Error E: Error E: Error E: Error Scope R: Record Only R: Record Only A: All Records S: Current. Sibling and Child Records C: Current and Child Record C: Current and Child Records Child Statuses -N/A-N/AE: Error E: Error E: Error N: Not Processed 3-100 Oracle Manufacturing APIs and Open Interfaces Manual . The import program will not look at records that already have an error status value. since it assumes that a record with an error status value has already been looked at by the program. Please see the Error States section above for a list of statuses a record can receive.Routing Import Error Handling and Messaging Table 3–35 Error Status Table 1: CODE ‘S’ ‘E’ ‘F’ ‘U’ MEANING Success Error Fatal Error Unexpected Error Record Error Status: This is the state of the record after the import (success or error). error scope. The error status is also referred to as return status or error state in this document.

Sibling and Child Records C: Current and Child Record -N/AN: Not Processed Child Statuses Unexpected Error API Messaging API Message Table All messages are logged in the API Error Message Table. The actual message that the user sees. The default ID is ECO.Routing Import Error Handling and Messaging Table 3–36 Error Fatal Error I Fatal Error II Fatal Error III Error Class Messages Status F: Fatal Error F: Fatal Error F: Fatal Error U: Unexpected Error Scope A: All Records S: Current. This is a PL/SQL table (array) of messages. Please see below for format information. BOM and RTG business objects. Business_Object_ID VARCHAR2(3). Please see Accessing Messages in the Launching the Import section of this document on how to access these messages. Message_Text VARCHAR2(2000) Bills of Material Business Object Interface 3-101 . The following is a description of the API Message Table: Table 3–37 Field API Message Table Type Description Error Handling API will be shared by ECO.

Reference Designators SC .Bills of Material Header BC .Substitute Components BH.Substitute Operation Resources NWK . ECO. or SC.Routing Operations Sequence RES .Revised Components RD .Business Object ECO . Please note that the message text may contain tokens. RD.Routing Import Error Handling and Messaging Table 3–37 Field Entity_Id API Message Table Type VARCHAR2(3) Description The entity that this message belongs to.Routing Header OP .Revised Items RC .Operation Resources SR .ECO Header REV . This may hold BO. RC.Operation Networks Entity_Index NUMBER The index of the entity array this record belongs to.Revisions(BOM. ECO.Bills of Material Comments RTG . BO . REV. some of which will identify the entity instances that this message is for. Routing) RI . RI. The following tokens identify the several entities: Assembly Item Name: Assembly_Item_Name Alternate Routing Code: Alternate_Routing_Code Organization Code: Orchid Operation Sequence Number: Op_Seq_Number Operation Resource Sequence Number: Res_Seq_Number Schedule Sequence Number: Schedule_Seq_Number s s s s s s 3-102 Oracle Manufacturing APIs and Open Interfaces Manual . Message formats s Expected errors and warnings: The message text contains the translated and token substituted message text.

2. it has been error-ed out too. It makes calls to the Error Handler when an error or warning needs to be issued. s s The following is the input that the Error Handler expects from the calling program: Bills of Material Business Object Interface 3-103 .Routing Import Error Handling and Messaging s Substitute Resource Code: Sub_Resource_Code Unexpected errors: s <Package Name> <Procedure/Function Name> <SQL Error Number> <SQL Error Message Text> Other message: An Other Message is a message that is logged for all records that are affected by an error in a particular record. Set the return status of other records affected by this error. This message essentially mentions the following: How the error has affected this record. Which record caused this record to be affected. What process flow step in the offending record caused this record to be affected. then the following will be logged: s For the routing itself. the other message. Set the return status of the record in error. For all records affected by the type of error that occurred in the routing. s 1. Error Handler The program performs all error handling and messaging through the Error Handler. or that it has not been processed. with a severe or fatal error status. that is. The following are the functions of the Error Handler: s Log the error/warning messages sent to it. 3. So if an error in a routing record will cause all it’s children to error out. the error message describing the problem.

the tokens are substituted into the translated message text. the translated message text is retrieved using the message name. Indicates depth of error. That is. Then. Does not apply to Routing Header. See below for description. Status the record in error should be set to. For unexpected errors. Index of record in error in its encompassing entity array. Status the other affected records should be set to. They hold message-and-token records. The message is logged after token translation and substitution is performed. so no message retrieval is needed. See below for description of this list. the calling program itself sends a message text. Business Object hierarchy level that current record is an instance of. 3-104 Oracle Manufacturing APIs and Open Interfaces Manual . that is. List of messages generated for error in the current record. and the Other Message and Token List are temporary arrays that the calling program maintains. The calling program may want some of these message record tokens to be translated (such tokens are typically messages themselves). For expected errors and warnings. Message and Token List Records The Message and Token List. and the message is logged. The Error Handler must log these messages into the API Message List. the entity that the record in error belongs to. after any requested token translation is performed.Routing Import Error Handling and Messaging Table 3–38 Input Business Object Message and Token List Error Status Error Level Error Handler Input Description Calling program must pass the whole business object as-is. how many other records are affected by it. Message generated for the other affected records. Entity Array Index Error Scope Other Message and Token List Other Status The calling program must trap the error and send the above details to the Error Handler. The Error Handler handles the error and returns the altered object to the calling program.

NULL for unexpected errors. These are the message list API’s that can be used to perform various operations on the Message List. there may be more than one occurrence of the message in the list. Name of the token in the message. Should this token value be translated? Since each message may have more than one token.Routing Import Error Handling and Messaging Table 3–39 Field Message Name Message Text Token Name Token Value Translate Message and Token List Records Description Name of the message used to retrieve the translated message text. the Message and Token List has as many occurrences of the same message as there are tokens in it. except that this list needs to carry only one message which is assigned to all other affected records. Value of the token in the message. The same applies to the Other Message and Token List. Bills of Material Business Object Interface 3-105 . Message text for unexpected errors. Since this lone message may have more than one token. Please note that the API Message List is not public and must be accessed through the Messaging API’s provided to access the message list.

Routing Import Error Handling and Messaging 3-106 Oracle Manufacturing APIs and Open Interfaces Manual .

4 Oracle Cost Management Open Interfaces This chapter contains information about the following Oracle Cost Management open interfaces and application program interfaces: n Periodic Cost Open Interface on page 4-2 Cost Import Interface on page 4-14 n Oracle Cost Management Open Interfaces 4-1 .

Periodic Costs need to be loaded into the following interface tables with a value of PROCESS_FLAG = 1: n CST_PC_ITEM_COST_INTERFACE is used for the Periodic Cost data and all Periodic Cost related attributes. It cannot be used for subsequent periods. If the import succeeds validation. You can specify just the few required attributes and let the system do validation of imported data. CST_PC_COST_DET_INTERFACE is used for capturing the Periodic Cost details and related cost detail attributes. This is the header table storing cost information in the interface. n If the Periodic Costs and/or the periodic cost detail rows fail any validation. Initially. The columns ERROR_FLAG. and PROCESS_FLAG are populated and the import is failed. See Also Oracle Cost Management User’s Guide Oracle Bill of Materials Technical Reference Manual Functional Overview The Periodic Cost Open Interface lets you import Periodic Costing data into the Oracle Cost Management Application. the master/detail rows are flagged with errors. This interface should only be used to bring in periodic costs for the first opened periodic period. ERROR_EXPLANATION.Periodic Cost Open Interface Periodic Cost Open Interface The Oracle Periodic Cost Open Interface provides an open interface for you to easily load periodic item costs from external applications or legacy systems and migrate them into the Oracle Cost Management Application. Costs in subsequent periods are calculated by the system. the destination tables for periodic costs are: n CST_PAC_ITEM_COSTS CST_PAC_ITEM_COST_DETAILS CST_PAC_QUANTITY_LAYERS n n See Also Oracle Cost Management User’s Guide Oracle Bill of Materials Technical Reference Manual 4-2 Oracle Manufacturing APIs and Open Interfaces Manual .

n Unique index on INTERFACE_HEADER_ID on CST_PC_ITEM_COST_ INTERFACE Unique index on INTERFACE_LINE_ID on CST_PC_COST_DET_INTERFACE Non-unique index on INTERFACE_GROUP_ID column in the CST_PC_ITEM_ COST_INTERFACE table Non-unique index on INTERFACE_HEADER_ID column in the CST_PC_COST_ DET_INTERFACE table n n n Oracle Cost Management Open Interfaces 4-3 . Setting Up the Interface Create Indexes for Performance You should create indexes on the following columns to improve Periodic Cost Open Interface performance.Setting Up the Interface Figure 4–1 Periodic Cost Open Interface.

All defaults are set up as part of the basic Periodic Costing set up. These are runtime options for the Periodic Cost Open Interface: Delete Interface Rows After Successful Import n Yes Delete all the rows in the interface table.Periodic Cost Open Interface Runtime Options Set Profile Option Defaults None. select Import Periodic Costs from the Periodic Cost menu. Table 4–1 Periodic Costing Open Costs Interface Table CST_PC_ITEM_COSTS_INTERFACE Column Name INTERFACE_HEADER_ID INTERFACE_GROUP_ID COST_LAYER_ID PAC_PERIOD_ID COST_GROUP_ID COST_GROUP COST_TYPE PERIOD_NAME INVENTORY_ITEM_ID Type NUMBER (sequence) NUMBER NUMBER NUMBER NUMBER VARCHAR2(10) VARCHAR2(10) VARCHAR2(15) NUMBER X X X X Required X X X X X Derived Optional Reserved for Future Use 4-4 Oracle Manufacturing APIs and Open Interfaces Manual . Periodic Cost Open Interface Runtime Options To run the Periodic Cost Open Interface. No Do not delete the rows in the interface. n Inserting into the Periodic Cost Interface Tables Periodic Costs Interface Table Description CST_PC_ITEM_COSTS_INTERFACE is used for the Periodic Cost data and all Periodic Cost related attributes.

Inserting into the Periodic Cost Interface Tables Table 4–1 Periodic Costing Open Costs Interface Table CST_PC_ITEM_COSTS_INTERFACE Column Name QUANTITY_LAYER_ID BEGIN_LAYER_QUANTITY ISSUE_QUANTITY BUY_QUANTITY MAKE_QUANTITY ITEM_COST MARKET_VALUE JUSTIFICATION BEGIN_ITEM_COST ITEM_BUY_COST ITEM_MAKE_COST PL_MATERIAL PL_MATERIAL_OVERHEAD PL_RESOURCE PL_OUTSIDE_PROCESSING PL_OVERHEAD TL_MATERIAL TL_MATERIAL_OVERHEAD TL_RESOURCE TL_OUTSIDE_PROCESSING TL_OVERHEAD PL_ITEM_COST TL_ITEM_COST UNBURDENED_COST BURDEN_COST Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(2000) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER X X X X X X X X X X X X X X X X X X X X X Required Derived X Optional Reserved for Future Use Oracle Cost Management Open Interfaces 4-5 .

Inserting into the Periodic Cost Interface Tables Table 4–1 Periodic Costing Open Costs Interface Table CST_PC_ITEM_COSTS_INTERFACE Column Name MATERIAL_COST MATERIAL_OVERHEAD_COST RESOURCE_COST OVERHEAD_COST OUTSIDE_PROCESSING_COST PROCESS_FLAG REFERENCE ERROR_FLAG ERROR_EXPLANATION LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_APPLICATION_DATE LOCK_FLAG Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER VARCHAR2(2000) DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER X X X X X X Required Derived X X X X X Optional Reserved for Future Use 4-6 Oracle Manufacturing APIs and Open Interfaces Manual .

Table 4–2 Detail Table Periodic Cost Open Interface CST_PC_COST_DET_INTERFACE Column Name INTERFACE_LINE_ID INTERFACE_HEADER_ID COST_LAYER_ID COST_ELEMENT_ID LEVEL_TYPE ITEM_COST ITEM_BUY_COST ITEM_MAKE_COST PROCESS_FLAG REFERENCE ERROR_FLAG ERROR_EXPLANATION LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_APPLICATION_DATE Type NUMBER (sequence) NUMBER (FK) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER VARCHAR2(2000) DATE NUMBER DATE NUMBER NUMBER NUMBER NUMBER DATE X X X X X X X X X X X Required X X Derived Optional Reserved for Future Use Oracle Cost Management Open Interfaces 4-7 .Inserting into the Periodic Cost Interface Tables Periodic Cost Detail Interface Table Description CST_PC_COST_DET_INTERFACE is used for importing the Periodic Cost details and related cost detail attributes.

When the data is loaded. the PROCESS_FLAG must be set to a value of 1 (Unprocessed). see Table and View Definitions. The next table shows the required values for each interface table. Table 4–3 Required Values for Interface Tables Table CST_PC_ITEM_COSTS_ INTERFACE Columns INTERFACE_HEADER_ID PERIOD_NAME COST_GROUP COST_TYPE INVENTORY_ITEM_ID BEGIN_LAYER_QUANTITY PROCESS_FLAG Standard WHO column LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY CST_PC_COST_DET_ INTERFACE INTERFACE_LINE_ID INTERFACE_HEADER_ID COST_ELEMENT_ID ITEM_COST LEVEL_TYPE not null not null not null not null not null Required Value not null not null not null not null not null not null 1 4-8 Oracle Manufacturing APIs and Open Interfaces Manual .Inserting into the Periodic Cost Interface Tables Note: For information about columns not discussed in the Interface Manual. Oracle Bills of Material Technical Reference Manual. Required Data The Periodic Cost Interface uses the PROCESS_FLAG to indicate whether processing of the row succeeded or errored. This will allow the import program to process the row for validation and import.

users can manually delete them when necessary. The Periodic Cost Interface then validates each row. the PROCESS_FLAG is set to 7 (Complete).Unprocessed 2 .Running 3 . If a row in an interface table fails validation. Default values for derived columns are first updated. If the rows in the interface are not deleted. the program sets the PROCESS_FLAG to 3 (Error) and sets the appropriate ERROR_FLAG and ERROR_EXPLANATION. The rows in the interface that were successfully imported will be deleted if the runtime option ’Delete all the rows in the interface table’ = Yes is set. the interface inserts the rows into the appropriate Oracle Cost Management Periodic Cost tables.Validation Table 4–3 Required Values for Interface Tables Table Columns PROCESS_FLAG Standard WHO column LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY Required Value not null not null not null not null not null not null Derived Data Issues arising during derivation of values for these columns are flagged as error and the row fails import.Error n n Oracle Cost Management Open Interfaces 4-9 . Then. Once the validated row is successfully inserted into the Oracle Cost Management Periodic Cost table. The PROCESS_FLAG column has one of 4 possible values: n 1 . the value of the PROCESS_FLAG is updated to 2 (Running) to continue validation of data. For all successfully validated rows. Validation The Open Interface program processes rows that have a PROCESS_FLAG = 1 (Unprocessed).

Previous Level All values in the column COST_ GROUP_ID must exist in the CST_COST_GROUP_ ASSIGNMENTS table.Material Overhead 3 .Overhead LEVEL_TYPE must be either: 1 .Material.Outside Processing 5 . Tables abbreviations are: – – CPCDI . The Error Flag and Error Explanation detail the nature of the error.CST_PC_ITEM_COST_INTERFACE Table 4–4 Periodic Costing Open Cost Interface Validations Error Flag 1 2 Validation Rule No Corresponding Header COST_ELEMENT_ID must be one of following: 1 . 2 . When validations fail the PROCESS_ FLAG is set to 3 denoting an error condition.Complete Validation and Error Handling This table lists all the required Periodic Costing Open Cost Interface validations and the error conditions that result when these validations fail.Resource 4 . Error Explanation No Corresponding Header Invalid Cost Element Table CPCDI CPCDI 3 Invalid Level Type CPCDI 4 Invalid Cost Group or No Organizations in Cost Group CPICI 5 Invalid Cost Type or Cost Type not in Legal Entity CPICI 4-10 Oracle Manufacturing APIs and Open Interfaces Manual .Validation n 7 .CST_PC_COST_DET_INTERFACE CPICI . All values in the COST_TYPE_ ID column must exist in the CST_LE_COST_TYPES table.This (current) Level 2 .

The period for which the data is imported (into the CST_PAC_ ITEM_COSTS. CST_PAC_ ITEM_COST_DETAILS and CST_PAC_QUANTITY_ LAYERS tables must not pre-exist in the relevant tables at the time of import Header Failed as Line Failed Line Failed as Header failed MAKE_QUANTITY. All items should belong to at least one of the organizations in the MTL_SYSTEM_ITEMS. BUY_ QUANTITY. CST_PAC_ ITEM_COST_DETAILS and CST_PAC_QUANTITY_ LAYERS tables) should have a status of “OPEN” and the first defined period in the CST_PAC_ PERIODS table. 7 8 Line Record Missing All values in the column INVENTORY_ITEM_ID must exist in the MTL_SYSTEM_ ITEMS table. CST_ COST_GROUPS and CST_ COST_ GROUP_ ASSIGNMENTS tables.Validation Table 4–4 Periodic Costing Open Cost Interface Validations Error Flag 6 Validation Rule All values in the column PAC_ PERIOD_ID must exist in the CST_PAC_PERIODS table. ISSUE_ QUANTITY must all be 0 All quantity and cost columns should have a value of >= 0 Header Failed as Line Failed Line Failed as Header failed QOH Value Error CPICI Line Record Missing Invalid Inventory Item or item not in Periodic Costing Organization CPICI CPICI Error Explanation Period Name Invalid or period is not the first opened for the legal entity and cost type Table CPICI 10 11 12 CPICI CPCDI CPCDI 13 Cost Value Error CPICI CPCDI Oracle Cost Management Open Interfaces 4-11 . 9 Records brought into the CST_ Item Cost Exists PAC_ITEM_COSTS.

Reviewing Failed Rows Table 4–4 Periodic Costing Open Cost Interface Validations Error Flag 14 Validation Rule If MARKET_VALUE is supplied. then JUSTIFICATION should be NOT NULL Other Error Explanation Market Value Error Table CPICI 15 Justification cannot be NULL CPICI 99 Other CPICI CPCDI Importing Additional Periodic Cost Details Imported cost data for derived columns will overwrite any user specified values. Log File Messages Table 4–5 Log File Messages Message Code CST_PAC_OCI_START_ VALIDATION CST_PAC_OCI_ERR_CGLE CST_PAC_OCI_SUCC_CGLE CST_PAC_OCI_ERR_CTCM Message Text Starting to validate Periodic Open Cost Interface table information Error: Could not fetch cost group and/or legal entity identifiers Success: Retrieved cost group and legal entity identifiers Error: Could not fetch cost type and/or cost method identifiers Type Action Error Success Error 4-12 Oracle Manufacturing APIs and Open Interfaces Manual . put the flag back to 1. it should be less than the computed ITEM_COST value in CPICI If MARKET_VALUE is supplied. Since all rows in the interface tables have a value for PROCESS_ FLAG. If you want to reprocess any row. and clear all errors (columns ERROR_FLAG and ERROR_EXPLANATION). Reviewing Failed Rows You can review and report rows in any of the interface tables using SQL*Plus or any custom reports you develop. you can identify records that have not been successfully imported into Oracle Cost Management.

Reviewing Failed Rows Table 4–5 Log File Messages Message Code CST_PAC_OCI_SUCC_CTCM CST_PAC_OCI_ERR_PID CST_PAC_OCI_SUCC_PID CST_PAC_OCI_ERR_ITEMID CST_PAC_OCI_SUCC_ITEMID CST_PAC_OCI_ERR_COST CST_PAC_OCI_SUCC_COST CST_PAC_OCI_ERR_LAYER_ EXISTS CST_PAC_OCI_ERR_LAYER_ GEN Message Text Success: Retrieved cost type and/or cost method identifiers Error: Could not fetch proper Periodic Costing Period identifier Success: Retrieved Periodic Costing Period identifier Error: Could not validate inventory item identifier Success: Validated inventory item identifier Error: Item cost exists in the System Success: Item cost does not exist in the System Error: Layer Validation Error Error: Layer Creation Error Type Success Error Success Error Success Error Success Error Error Success Action Action CST_PAC_OCI_SUCC_LAYER_ Success: Layer Creation Successful GEN CST_PAC_OCI_UPDATE_ NULL CST_PAC_OCI_CALCULATE Action: Updating all derived columns to NULL in the Interface Tables Action: Computing and Updating derived columns in the Interface Tables Success: Computation of all derived columns compete Error: Market Value cannot be more than computed Item Cost Value Error: Justification cannot be NULL if Market Value is supplied Action: Starting to insert rows into Oracle Cost Management tables Success: Inserted into CST_PAC_ ITEM_COSTS table CST_PAC_OCI_SUCC_ CALCULATE CST_PAC_OCI_ERR_MARKET CST_PAC_OCI_ERR_ JUSTIFICATION CST_PAC_OCI_START_ INSERT CST_PAC_OCI_SUCC_CPIC Success Error Error Action Success Oracle Cost Management Open Interfaces 4-13 .

Only resource costs. The item costs will have to be imported into another cost type and then the cost update may be run to update to the frozen cost type. Importing resource costs and resource overhead rates is also supported. However. You will also be able to replace existing cost information with the new cost information. Only overhead rates. as well as import new cost information for existing items. Importing costs into frozen cost type is also not supported. The following list contains the Option and the table from which data is processed: 4-14 Oracle Manufacturing APIs and Open Interfaces Manual . or All cost information.Cost Import Interface Table 4–5 Log File Messages Message Code CST_PAC_OCI_SUCC_CPICD CST_PAC_OCI_SUCC_CPQL Message Text Success: Inserted into CST_PAC_ ITEM_COST_DETAILS table Success: Inserted into CST_PAC_ QUANTITY_LAYERS table Type Success Success Action Success Note CST_PAC_OCI_START_PURGE Action: Starting to purge processed rows from interface tables CST_PAC_OCI_SUCC_PURGE CST_PAC_OCI_CHECK_LOG Success: Purge Process Complete NOTE: Please check log for error transactions Cost Import Interface The Oracle Cost Import Interface enables you to import costs for items from legacy systems. Parameters and Descriptions This section includes the details to each of the following parameters: Import Cost Option Mode to Run This Request Group ID Option Cost Type to Import To Delete Successful Rows Import Cost Option A list of values is provided from which the user can select one of the import options which may be either to import Only item costs. updating of existing costs is not supported.

The use of this sequence generator is a must for generating multiple groups or may lead to data corruption as these interface tables are used by other processes as well.All the previous cost information for this item. and cst_dept_overheads_interface) will be processed in one run. Remove and replace costs . updatable cost types.From all four interface tables n n n If default material subelement is specified for an Organization and the material row in cst_ item_cst_dtls_interface has not subelement specified against it then the org level default would be picked up for the material row. Cost Type to Import To The user is provided with a list of values from which they need to select the cost type in which they wish to import the cost information. This would prevent any accidental overwrite of existing data. If the user wishes to submit multiple Cost Import process requests they can do so by submitting one request per group id.cst_res_overheas_interface and cst_dept_overheads_interface All Cost Information . cost_type. cst_resource_costs_interface.cst_resource_costs_interface Only overhead rates .This mode can be used if the user is importing large numbers of items and is unsure if Item/Organization/Cost Type combination exists in the production tables. organization combination will be deleted from the production tables and the new information will overwrite (replace) the existing one. If it does exist then the row in the interface table would be flagged as an error and not imported. Even if the user has populated a cost type or cost type ID in the interface tables. Mode to Run This Request A list of values is provided with possible two values: n Insert new cost . it would be overwritten with the one that is selected here. n Group ID Option A list of values is provided from which the user can either select All or Specific Group ID. For doing so the data in the interface tables should be stamped with distinct group id value by using the NEXTVAL from the sequence generator CST_LISTS_S. If the user selects All from the list then a group ID generated by a sequence will replace the group ID in the interface tables (if any) and all the unprocessed rows from the four interface tables (cst_item_cst_dtls_interface. The cost types that the user can pick from is restricted to the multi-org.cst_item_cst_dtls_interface Only resource costs . Oracle Cost Management Open Interfaces 4-15 . cst_res_overheads_ interface.Cost Import Interface n Only item cost .

CIC. For example. Setting Up the Cost Import Interface The Cost Import Interface includes four tables: n CST_RESOURCE_COSTS_INTERFACE CST_RES_OVERHEADS_INTERFACE CST_DEPT_OVERHEADS_INTERFACE CST_ITEM_CST_DTLS_INTERFACE Note: CICI is not used by the Cost Import process. after running the process.Setting Up the Cost Import Interface Delete Successful Rows This parameter determines whether the successfully processed rows should be deleted from the interface tables at the end of the run. 4-16 Oracle Manufacturing APIs and Open Interfaces Manual . This statement gives the cost optimizer an idea of the number of rows that will be present in the table. if the user is planning to run the trace for importing item costs.gather_table_stats('BOM'. This will ensure that the plan that is obtained.CICD before running the import process and the plan that is obtained will give a good picture of the actual execution plan. If this statement is not executed before the process is run then the plan that is obtained will be based on an old estimate of the number of rows and it may not provide an accurate picture of the actual execution plan. Obtaining a Trace You need to run "exec FND_STATS.10)" before the Cost Import process is run. then they will need to run the above statement for the 3 tables CICDI. If the user selects Yes then all the successful rows will be deleted (rows that do not have their error flag set to ’E’). gives a good picture of the execution plan.'<name of the table>'. n n n Note: The Process_flag indicates what stage of validation this row is in. This will be populated as the rows are being processed in various phases. This must be set to 1 initially.

Setting Up the Cost Import Interface CST_RESOURCE_COSTS_INTERFACE Table 4–6 Resource Cost Interface CST_RESOURCE_COST_INTERFACE Column Name Resource_ID Cost_type_ID Organization_ID Last_update_date Last_updated_by Creation_date Created_by Last_update_login Resource_rate Request_ID Program_application_ID Program_ID Program_update_date Attirbute_category Error_flag Error_code Error_explanation Resource_code Cost_type Organization_code Transaction_ID Group_ID Group_description Process_flag Type Number Number Number Date Number Date Number Number Number Number Number Number Date Varchar2(30) Varchar2(1) Varchar2(240) Varchar2(240) Varchar2(20) Varchar2(10) Varchar2(3) Number Number Varchar2(80) Number X X X X X X X X X X X X X X X X X X X X X X Required X X Derived Optional Reserved for Future Use Oracle Cost Management Open Interfaces 4-17 .

If a cost type is provided in this column. Creation_date . Error_code .This is set to "E" if there is an error.The Resource (subelement) identifier. This must be in BOM_ RESOURCES. This displays the cause of the error which can be reviewed using the list of common cost import error explanations further in this guide. Organization_ID . This must be in MTL_PARAMETERS. Either Organization_code or organization_id must be populated. Created_by .Unique row identifier.The error explanation.Standard Who column.Organization identifier.Standard Who column. Cost_type_ID .Standard Who column. Either resource_ID or resource_code has to be filled up.Standard Who column.Concurrent Who column. Cost_type .Concurrent Who column.The cost type identifier. Error_flag . 4-18 Oracle Manufacturing APIs and Open Interfaces Manual .The cost type identifier. Organization_code .Organization identifier.This identifies the error code. Error_explanation . This must be in mtl_parameters. Program_ID . This will be overwritten with the cost type mentioned while specified in the request parameters. All of the costs will be imported against the cost type specified in the request parameters.Concurrent Who column.Descriptive flexfield structure defining the column. This is auto generated. Resource_rate . This must be in BOM_RESOURCES. Program_applicatin_ID . Last_update_logon . Program_update_date .Setting Up the Cost Import Interface Column Descriptions Resource_ID .Concurrent Who column. Attribute_category . Last_updated_by .Resource unit cost. Request_ID .The resource (subelement) identifier. Last_update_date . Transaction_ID .Standard Who column. Resource_code . it will be overwritten.

It must have some value. This will be populated as the rows are being processed in various phases. organization. If the Resource_ID mentioned in the CST_RESOURCE_COSTS_INTERFACE table has the Functional_currency flag (in the BOM_RESOURCES table) set to yes. This must be set to 1 initially. If the Resource_ID. organization combination will be errored out and no item costs will be imported. and cost type combination. In other words the functional currency flag must not be equal to 1 for the resource to have a rate. In other words no new resources will be created. CST_RESOURCE_COSTS_INTERFACE Table Validations n The Resource_ID (or Resource_code) and Organization_ID combination must have been defined.Description of the Group_ID. You can populate this column if the process is to be run by group ID. Group_description . n n n CST_RES_OVERHEADS_INTERFACE Table 4–7 Resource Cost Overheads Interface CST_RES_OVERHEADS_INTERFACE Column Name Resource_ID Cost_type_ID Organization_ID Overhead_ID Last_update_date Last_updated_by Creation_date Created_by Type Number Number Number Number Date Number Date Number X X X X X X Required X X Derived Optional Reserved for Future Use Oracle Cost Management Open Interfaces 4-19 . Process_flag .Batch identifier.Flag that indicates what stage of validation this row is in. the rows for that particular item. then no resource rates can be entered for this Resource_ID organization combination.Setting Up the Cost Import Interface Group_ID . No two rows can be defined for the same resource. The resource rate cannot be null. Organization_ID is not found in the BOM_RESOURCES.

Organization identifier. Either Resource_ID or Resource_code has to be filled up. If a cost type is provided in this column.The cost type identifier. All of the costs will be imported against the cost type specified in the request parameters. 4-20 Oracle Manufacturing APIs and Open Interfaces Manual . Either Overhead_ID or Overhead must be populated. This must be in BOM_RESOURCES. This must be in MTL_PARAMETERS. Cost_type_ID .The Resource (subelement) identifier.Setting Up the Cost Import Interface CST_RES_OVERHEADS_INTERFACE Column Name Last_update_login Request_ID Program_application_ID Program_ID Program_update_date Attirbute_category Error_code Error_explanation Resource_code Cost_type Organization_code Overhead Transaction_ID Group_ID Group_description Error_flag Process_flag Type Number Number Number Number Date Varchar2(30) Varchar2(240) Varchar2(240) Varchar2(20) Varchar2(10) Varchar2(3) Varchar2(30) Number Number Varchar2(80) Varchar2(1) Number X X X X X X X Required Derived Optional X X X X X X X X X X Reserved for Future Use Column Descriptions Resource_ID . Overhead_ID . This must be in BOM_RESOURCES. it will be overwritten.Overhead subelement identifier. Either Organization_code or Organization_id must be populated. Organization_ID .

The cost type identifier. This is auto generated. Request_ID . Program_applicatin_ID .Concurrent Who column. This will be overwritten with the cost type specified in the request parameters.Standard Who column. No new resources will be created. Group_description . Error_explanation . Resource_code . Cost_type . Resource_ID combination must exist in the BOM_ RESOURCES. Creation_date .Standard Who column.Unique row identifier. Last_updated_by .Standard Who column.Organization identifier.This identifies the error code. This must be in BOM_ RESOURCES. Overhead . Last_update_logon . This must be set to 1 initially.Batch identifier. This displays the cause of the error which can be reviewed using the list of common cost import error explanations further in this guide.This is set to "E" if there is an error.Overhead subelement identifier. Error_flag .Concurrent Who column. You can populate this column if the process is to be run by group ID. This will be populated as the rows are being processed in various phases.The resource (subelement) identifier. Transaction_ID . Process_flag .Standard Who column.Concurrent Who column. Error_code . Program_update_date .The error explanation.Concurrent Who column.Standard Who column. Created_by . This must be in MTL_PARAMETERS. Organization_code . Attribute_category .Flag that indicates what stage of validation this row is in. CST_RES_OVERHEADS_INTERFACE Table Validations n The Organization_ID.Setting Up the Cost Import Interface Last_update_date . Oracle Cost Management Open Interfaces 4-21 .Descriptive flexfield structure defining the column. Program_ID . Group_ID .Description of the Group_ID.

The Organization_ID and Overhead_ID combination must exist in the BOM_ RESOURCES table. n CST_DEPT_OVERHEADS_INTERFACE Table 4–8 Department Cost Overheads Interface CST_DEPT_OVERHEADS_INTERFACE Column Name Department_ID Cost_type_ID Organization_ID Overhead_ID Last_update_date Last_updated_by Creation_date Created_by Last_update_login Basis_type Rate_or_amount Activity_ID Request_ID Program_application_ID Program_ID Program_update_date Attirbute_category Error_code Error_explanation Department_code Type Number Number Number Number Date Number Date Number Number Number Number Number Number Number Number Date Varchar2(30) Varchar2(240) Varchar2(240) Number X X X X X X X X X X X X X X X X X X Required X X Derived Optional Reserved for Future Use 4-22 Oracle Manufacturing APIs and Open Interfaces Manual . If both are provided then they must match. The Overhead_ID or the Overhead has to be provided.Setting Up the Cost Import Interface n The resource_ID or the Resource_code must be provided and must be valid for that Organization_ID.

Last_update_date . Either Overhead_ID or Overhead must be populated. Cost_type_ID . it will be overwritten. Either Organization_code or Organization_id must be populated.Standard Who column.Rate or amount for the overhead subelement.Standard Who column. If a cost type is provided in this column. Creation_date . Overhead_ID . Rate_or_amount .Overhead subelement identifier. Either Department_ID or Department must be populated. Basis_type . This must be in BOM_RESOURCES. You must populate this column.Standard Who column. Last_update_logon .Standard Who column. This must be in MTL_PARAMETERS. Last_updated_by .Department identifier.Standard Who column. Oracle Cost Management Open Interfaces 4-23 .The basis type identifier. Organization_ID .Organization identifier. This must be between 1 and 6. This must be in BOM_DEPARTMENTS.The cost type identifier.Setting Up the Cost Import Interface CST_DEPT_OVERHEADS_INTERFACE Column Name Cost_type Organization_code Overhead Transaction_ID Group_ID Group_description Process_flag Activity Error_flag Type Varchar2(10) Varchar2(3) Varchar2(30) Number Number Varchar2(80) Number Varchar2(20) Varchar2(1) X X X X X X X X Required Derived Optional Reserved for Future Use X Column Descriptions Department_ID . All of the costs will be imported against the cost type specified in the request parameters. Created_by .

Setting Up the Cost Import Interface

Activity_ID - Activity identifier. This must be in CST_ACTIVITIES. Request_ID - Concurrent Who column. Program_applicatin_ID - Concurrent Who column. Program_ID - Concurrent Who column. Program_update_date - Concurrent Who column. Attribute_category - Descriptive flexfield structure defining the column. Error_flag - This is set to "E" if there is an error. Error_code - This identifies the error code. Error_explanation - The error explanation. This displays the cause of the error which can be reviewed using the list of common cost import error explanations further in this guide. Department - Department identifier. Cost_type - Cost type identifier. This must be in CST_COST_TYPES. This will be overwritten with the cost type specified in the request parameters. Organization_code - Organization identifier. This must be in MTL_PARAMETERS. Overhead - Overhead subelement identifier. Transaction_ID - Unique row identifier. This is auto generated. Group_ID - Batch identifier. You can also populate this column if the process is to be run by group ID. Group_description - Description of the Group_ID. Process_flag - Flag that indicates what stage of validation this row is in. This will be populated as the rows are being processed in various phases. This must be set to 1 initially. Activity - Activity identifier. This must be in CST_ACTIVITIES.

CST_DEPT_OVERHEADS_INTERFACE Table Validations
n

Either Department_ID or Department will have to be provided. If both of them are provided and the Department_ID does not match Department, the row will error out. If only the Department is provided, the Department_ID column will be populated from the BOM_DEPARTMENTS table. Either Overhead_ID or Overhead will have to be provided wherever necessary. If both of them are provided and the Overhead_ID does not match Overhead, the row will error

n

4-24

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

out. If only the Overhead is provided, the Overhead_ID column will be populated from the BOM_RESOURCES table.
n

The Overhead_ID, Organization_ID combination that is provided in the CST_DEPT_ OVERHEADS_INTERFACE table must be defined in the BOM_RESOURCES table for the Cost_element_ID=5 (cost element overhead). The Basis_type must be a valid number between 1 and 6.

n

CST_ITEM_CST_DTLS_INTERFACE
Table 4–9 Item Cost Details Interface CST_ITEM_CST_DTLS_INTERFACE Column Name Cost_type_ID Cost_type Last_update_date Last_updated_by Creation_date Created_by Last_update_login Organization_ID Organization_code Operation_sequence_ID Operation_seq_num Department_ID Department Level_type Activity_ID Activity Resource_seq_num Resource_ID Type Number Varchar2(10) Date Number Date Number Number Number Varchar2(3) Number Number Number Varchar2(10) Number Number Varchar2(10) Number Number X X X X X X X X X X X X X X X X Required Derived Optional Reserved for Future Use X X

Oracle Cost Management Open Interfaces 4-25

Setting Up the Cost Import Interface

CST_ITEM_CST_DTLS_INTERFACE Column Name Resource_code Rollup_source_type Activity_context Request_ID Item_units Activity_units Basis_type Basis_resource_ID Basis_resource_code Usage_rate_or_amount Basis_factor Resource_rate Net_yield_or_shrinkage_factor Item_cost Program_application_ID Program_ID Program_update_date Attribute_category Lot_size Based_on_rollup_flag Shrinkage_rate Inventory_asset_flag Cost_element_ID Cost_element Item_number Group_ID Type Varchar2(10) Number Varchar2(30) Number Number Number Number Number Varchar2(10) Number Number Number Number Number Number Number Date Varchar2(30) Number Number Number Number Number Varchar2(50) Varchar2(81) Number X X X X X X X X X X X X X X X X X Required Derived Optional X X X X X X X X X Reserved for Future Use

4-26

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

CST_ITEM_CST_DTLS_INTERFACE Column Name Group_description Transaction_ID Error_flag Error_code Error_explanation Process_flag Type Varchar2(80) Number Varchar2(1) Varchar2(240) Varchar2(240) Number X Required Derived Optional X X X X X Reserved for Future Use

Column Descriptions
Inventory_item_ID - Item identifier. This must be in MTL_SYSTEM_ITEMS. Cost_type_ID - Cost type identifier. This will be overwritten with the cost type provided while submitting the request. Cost_type - Cost type identifier. This will be overwritten with the cost type provided while submitting the request. Last_update_date - Standard Who column. Last_updated_by - Standard Who column. Creation_date - Standard Who column. Created_by - Standard Who column. Last_update_login - Standard Who column. Organization_ID - Organization identifier. This must be in MTL_PARAMETERS. Either Organization_ID or Organization_code must be specified. Organization_code - Organization identifier. Must be in MTL_PARAMETERS. Operation_sequence_ID - Operation sequence identifier. This is not used. Operation_seq_num - Operation sequence number in a routing. This is not used. Department_ID - Not used. Department - Not used. Level_type - Level at which costs are incurred. Only 1 is supported.

Oracle Cost Management Open Interfaces 4-27

Setting Up the Cost Import Interface

Activity_ID - Activity identifier. This must be in CST_ACTIVITIES. Activity - Activity identifier. This must be in CST_ACTIVITIES. If Activity is mentioned, then Activity_ID is populated from CST_ACTIVITIES. Otherwise the default is null. Resource_seq_num - Not used. Resource_ID - Resource (subelement) identifier. This must be in BOM_RESOURCES. Either of Resource_ID or Resource_code must be entered for any cost elements other than material. This is either defined by the user or populated from BOM_RESOURCES based on the Resource_code. Recource_code - Resource (subelement) identifier. This must be in BOM_RESOURCES. Rollup_source_type - Cost source. This must be 1, which is user defined. Activity_context - Column for defining activity unit information. Request_ID - Concurrent Who column. Item_units - Number of units the activity cost is applied to. This must be greater than 0. Activity_units - Number of activity units applied to the item costs. This must be greater than, or equal to, 0. Basis_type - Basis type identifier. This must be between 1 and 6. Basis_resource_ID - Not used. Basis_resource_code - Not used. Usage_rate_or_amount - Number of resource units, overhead rate, or activity unit cost per basis. This must be greater than 0. Basis_factor - Basis factor. This is calculated from the Basis_type and lot size. Resource_rate - Resource unit cost. This must be null. Net_yield_or_shrinkage_factor - Item shrinkage factor. This is computed from the item shrinkage factor. Item_cost - Computed cost of the item. This is the product of Basis_factor, Resource_rate, Usage_rate_or_amount, Net_yield_or_shrinkage_rate. Program_application_ID - Concurrent Who column. Program_ID - Concurrent Who column. Program_update_date - Concurrent Who column. Attribute_category - Descriptive flexfield structure defining column.

4-28

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

Lot_size - Lot size. This must be greater than 0 if specified. Based_on_rollup_flag - Flag that indicates whether the cost has to be rolled up. This must be 1 or 2. Shrinkage_rate - Manufacturing shrinkage rate (for make items only). This must be between 0 and 0.99 (must be less than 1). Inventory_asset_flag - Flag that indicates whether the item is asset or expense item. This must be 1 for it to be able to have any costs. Cost_element_ID - Cost element identifier. This must be in CST_COST_ELEMENTS. Either of the Cost_element_ID or Cost_element has to be populated. Cost_element - Cost element identifier. This must be in CST_COST_ELEMENTS. Item_number - Not used. Group_ID - Batch identifier. You can also populate this column if the process is to be run by group ID. Group_description - Description of the Group_ID. Transaction_ID - Unique row identifier. This is populated by a sequence. Error_flag - This is set to "E" if there is an error. Error_code - The error code that identifies the error. Error_explanation - The error explanation. This displays the cause of the error which can be reviewed using the list of common cost import error explanations further in this guide. Process_flag - Flag that indicates what stage of validation this row is in. This will be populated as the rows are being processed in various phases. This must be set to 1 initially.

CST_ITEM_CST_DTLS_INTERFACE Table Validations
n

The Organization_ID, Cost_element_ID, Resource_ID combination in the CICDI must be defined in BOM_RESOURCES. No new resources will be supported. Also, subelements with Functional_currency_code set to 1 only will be supported for resource and outside processing Cost_elements. The Resource_ID or Resource_code has to be provided for cost elements other than material. For material cost element, if the Resource and Resource_ID is not provided, it will be defaulted from MTL_PARAMETERS for this organization. Only subelements with functional currency flag set to 1 will be allowed to be imported for cost elements resource and outside processing.

n

n

Oracle Cost Management Open Interfaces 4-29

Setting Up the Cost Import Interface

n

If Activity is provided, the Activity_ID will be populated from CST_ACTIVITIES. If Activity_ID is provided, the Organization_ID, Activity_ID combination must exist in the CST_ACTIVITIES table. If both Activity_ID and Activity is provided, then the Activity_ID should match the Activity. If any of the activity related information like the activity units, activity context, etc. is provided, it will be inserted into CST_ITEM_COSTS/CST_ITEM_COST_DETAILS without any validation. The Cost_element or Cost_element_id must be provided. If both are provided then they should match. The flags Based_on_rollup_flag, Inventory_asset_flag, and the columns Lot_size, Shrinkage_rate should be the same for all rows that correspond to a particular Inventory_item, Organization, Cost_type combination. If they do not match (are not the same for the same Inventory_item, Organization, Cost_type combination) then all the rows for that item will be errored out and no costs for that item, organization, cost type combination will be imported. If they are left empty, they will be defaulted from the item/organization/default cost type combination where the default cost type is derived from the CST_COST_TYPES table for the provided cost type. The Level_type is always 1 referring to "This" level cost information. If any level type is mentioned, all the rows for that item, organization, cost type combination will error out. The Usage_rate_or_amount cannot be null. The Rollup_source_type must always be 1 (user defined costs only). The Resource_rate must always be null. If the item is not an inventory asset item (i.e. the inventory asset flat is set to 2 in the CICDI or if the inventory_asset_flag is set to "N" in MTL_SYSTEM_ITEM for this item, organization combination) then no costs will be imported. Basis types of only 1 and 2 are allowed for any cost element other than material overhead. For material overhead all basis types are allowed. If the basis type of Activity is provided, then there have to be both activity units and item units defined. Moreover, Item_units_ cannot be zero if the basis type is Activity. Shrinkage_rate can never exceed 1. Lot_size can never be 0. If Based_on_rollup_flag is 2, then the item cannot have shrinkage rate (i.e. shrinkage rate must be 0).

n

n

n

n

n

n

n

n

n

n

n

n

4-30

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

Common Validations
Because of dependencies, tables CST_RESOURCE_COSTS_INTERFACE, CST_RES_ OVERHEADS_INTERFACE, CST_DEPT_OVERHEADS_INTERFACE, and CST_ITEM_ CST_DTLS_INTERFACE must be populated in the same order that they are listed here.
n

You will have to provide either Organization_ID or Organization_code wherever required. If both are provided and if the Organization_ID does not match the Organization code, then the row will be marked error. If only the Organization_code is provided, Organization_ID will be populated from the MTL_PARAMETERS table. You will have to provide the Inventory_item_ID. The Inventory_item_ID and the Organization_ID must exist in the MTL_SYSTEM_ITEMS table. Only the item ID is allowed. No item names are allowed. The Item_name field is not considered even if it is populated. Only item ID is considered. The Group_ID specifies the batch that the row will be processed in. This is automatically populated by a sequence. All rows with that particular batch ID will then be processed in that particular run. If you decides to specify this Group_ID, then this column must be populated with the next value from the sequence CST_LISTS_S. This is necessary to avoid these rows from getting picked up by the cost copy process. If the organization for which the cost/rates are being imported is not an organization that can control costs (i.e. it could be an organization whose costs are controlled by another master organization), then all the rows with this Organization_ID will error out.

n

n

n

Error Handling and Resubmission
The following list should be verified if any of the rows contain errors during validation:
n

Error_flag - This will be set to ’E’ to indicate that an error has occurred. Error_code - A code that will indicate the error. Error_explination - The actual short message that will enable the user to understand what exactly caused the error. Process_flag - This will indicate in what phase of the validation the validation failed.

n

n

n

If any row contains an error, the user can find out the reason for the error and fix the row(s) in the corresponding interface table(s). To fix a particular row, the user can use Transaction_ ID to identify a particular row. To resubmit an error row for re-processing after correcting the error the user would have to set the following:
n

Error_flag = null Process_flag = 1

n

Oracle Cost Management Open Interfaces 4-31

Setting Up the Cost Import Interface

The user will have to do this for all the rows for an item, organization, cost_type combination that has an error. This is because no partial cost information for an item will be imported. If there is an error with any one row for a particular item, organization, cost type combination, then all the rows for this item, organization, cost type combination for the current batch id will be contain errors.

Common Cost Import Interface Errors
This is a list of common errors that you may encounter when the rows are being validated. The error_code can be obtained from the Error_code column in the interface table. There is also a very brief explanation of the error in the Error_explanation column. A more detailed explanation of the errors is listed here: CST_NULL_ORGANIZATION - The row that has been marked with this error is missing values for both the Organization_ID and the Organization_code columns. At least one of the two must be provided for the row to be processed. CST_INVALID_ORGANIZATION - The row that has been marked with this error could have any of the following listed errors.
n

Organization_ID that does not match any Organization_ID in the MTL_PARAMETERS table Organization_code that is provided does not match any Organization_code in the MTL_ PARAMETERS table Both the Organization_ID and the Organization code that has been provided do not match (i.e the Organization_ID is not of the Organization_code that is mentioned)

n

n

CST_NULL_ITEMID - The row that has been marked with this error has missing Inventory_item_ID value. The Inventory_item_ID must be provided. CST_NULL_COSTELEMENT - The row that has been marked with this error has missing Cost_element_ID and Cost_element. At least one of the two must be provided. CST_INVALID_ROLLUP_SRC_TYPE - A row that has been marked with this error has an invalid value for the Rollup_source_type column. The only allowed value is 1 (user defined costs). CST_INVALID_ITEMID - A row that has been marked with this error has an Inventory_ item_ID, Organization_ID combination that does not exist (not defined in the MTL_ SYSTEM_ITEMS table). CST_INVALID_COSTELEMENT - The row that has been marked with this error has any of the following errors:
n

The Cost_element_ID mentioned is not defined in the CST_COST_ELEMENTS table

4-32

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

n

The Cost_element_ID, Cost_element combination that is mentioned does not exist in the CST_COST_ELEMENTS table

CST_INVALID_SUBELEMENT - A row that has been marked with this error has any of the following errors:
n

An invalid Organization_ID, Cost_element_ID, Resource_ID combination which is not defined in the BOM_RESOURCES table An invalid Organization_ID, Cost_element_ID, Resource_code combination which is not defined in the BOM_RESOURCES table An invalid Organization_ID, Cost_element_ID, Resource_ID, Resource_code combination which is not defined in the BOM_RESOURCES table

n

n

CST_NULL_SUBELEMENT - A row that has been marked with this error indicates that the row is missing values for Resource_ID and Resource_code columns. At least one of them will have to be provided. CST_NULL_DEFSUBELEMENT - A row that has been marked with this error suggests that it has missing values for both the Resource_ID and Resource_code columns. This error arises when either of the following conditions is true:
n

You have not provided either the Resource_ID or Resource_code for a cost element other than material or material overhead The default subelements from MTL_PARAMETERS are null for cost element material

n

CST_INVALID_FUNCCODE - A row that has been marked with this error indicates that the Resource_ID mentioned does not have the Functional_currency_flag set to 1 in the BOM_RESOURCES table. Subelements with Functional_currency_code set to 1, will only be supported for resource and outside processing Cost_elements. You can check the Functional_currency_flag in the BOM_RESOURCES table for the subelement that is defined in this row. CST_INVALID_LEVELTYPE - A row that has been marked with this error indicates that an invalid value has been entered for the Level_type column. Only Level_type value of 1 (this level costs) is supported. CST_INVALID_CIC_FLAGS - The 4 columns Based on_rollup_flag, Inventory_asset_flag, Shrinkage_rate, and Lot_size must have the same values for all the rows for a particular Inventory_item_ID, Organization, Cost_type combination. The rows that have been marked with this error indicate that the 4 columns do not match for these rows. You have to check up the valid combination and then fix all the other rows with this value. CST_INVALID_ROWS - If there is an error with any one row, all the rows with the same Item, Organization and Cost_type combination as this errored out row will be marked error.

Oracle Cost Management Open Interfaces 4-33

Setting Up the Cost Import Interface

This is necessary to avoid importing partial costs for an item. You must fix the errored out row and then resubmit all the rows for processing. CST_NO_ITORACUNITS - A row errored out with this error has a basis type of 6 (Activity) but either or both of Item_units and Activity_units is null. To fix this, you can mention the Item_units and the Activity_units, then resubmit for processing. CST_ZERO_LOTSIZE - A row errored out with this error has 0 lot size. You will have to enter a non zero lot size to fix this row. CST_NOT_COSTINGORG - A row is errored out with this error when the Organization_ID mentioned in this row is not an organization that can control costs (i.e this organization receives costing information from another master org). CST_NULL_DEPARTMENT - A row marked with this error has a null Department and Department_ID. To fix this, either a Department_ID or Department or both will have to be provided. CST_CANT_INSERT - Rows are errored out with this error when the cost import process is being run in the “insert new cost information only” mode and there are rows that already exist for the same item/organization/cost type combination as the rows in the interface table. Since the cost information already exists, rows in the interface table will be errored out. To fix this problem, the rows will have to resubmitted with a “remove and replace cost information option”. CST_DUPL_ROWS - Rows in the interface table are marked with this error when there are multiple rows in the interface table for the same Organization, Resource_ID, and Cost type combination. This error is applicable to only CST_RESOURCE_COSTS_INTERFACE, CST_RES_OVERHEADS_INTERFACE, and CST_DEPT_OVERHEADS_INTERFACE tables. To fix this error, you delete the duplicate rows. CST_INVALID_ACTIVITY - Rows marked with this error suggest one of the following:
n

The Activity_ID or Activity mentioned is invalid (does not exist in CST_ACTIVITES table) The Activity_ID and Activity combination is invalid The Activity_ID, Organization_ID combination is invalid

n

n

To fix the problem, you insert a valid Activity_ID or Activity name from CST_ ACTIVITIES. CST_INVALID_BASEDONRLP - Rows marked with this error suggest that the rows have an invalid Based_on_rollup_flag value. The only valid values are 1(yes) and 2(no). CST_INVALID_BASISTYPE - Rows errored out with this error could have been errored out because of either of the following reasons:

4-34

Oracle Manufacturing APIs and Open Interfaces Manual

Setting Up the Cost Import Interface

n

The Basis_type value is not between 1 and 6 If this error is for a row in CST_DEPT_OVERHEADS_INTERFACE table, the Basis_ type is not between 1 and 4 for cost element overhead The Cost_element_ID is not 2 (Material Overhead) and the Basis_type exceeds 2. For all other cost elements, other than material overhead, the only valid values are 1 and 2. For material overhead, all values (between 1 and 6) are allowed

n

n

CST_INVALID_BUYITEM - The rows marked with this error suggest that the item is not a buy item (Based_on_rollup is not 1) but a Shrinkage_rate (greater than 0) is being defined for this item. To fix this error, you can either input a value of 1 for the Based_on_rollup_flag or make the Shrinkage_rate equal to 0. CST_INVALID_OVERHEAD - Rows are marked with this error when either of the following hold true:
n

The Overhead_ID or Overhead is invalid (does not exist in BOM_RESOURCES) The Overhead and Organization combination does not exist in BOM_RESOURCES The Overhead_ID and Overhead combination is invalid

n

n

CST_INVALID_RESRATE - This error is applicable to the rows only in CST_ITEM_CST_ DTLS_INTERFACE table. The rows marked with this error suggest that the Resource_rate column does not have null as the value. Only null values are allowed. CST_INVALID_ROLLUP_SRC_TYPE - The rows marked with this error have an invalid value of Rollup_source_type flag. It must be 1 (user defined). Only a value of 1 is supported. CST_INVALID_SHRRATE - Rows marked with this error do not have a value of Shrinkage_rate between 0 and 1. The Shrinkage_rate can never be 1 or exceed 1. CST_NOT_INVASSITEM - Rows are marked with this error when either of the following is true:
n

The Inventory_asset_flag is not 1 for this row in the interface table The Inventory_asset_item is set to “N” in the MTL_SYSTEM_ITEMS table for this item/organization combination

n

CST_INVALID_DEFCSTTYPE - Rows are marked with this error when either of Based_ on_rollup_flag or Shrinkage_rate or Lot_size or Inventory_asset_flag has null values and there are no rows that exist in CST_ITEM_COSTS for this Item, Organization, Default_ cost_type combination. The Default_cost_type is derived from CST_COST_TYPES for the cost type provided during the request submission. You have two options to correct this:

Oracle Cost Management Open Interfaces 4-35

Setting Up the Cost Import Interface

n

Supply all the required defaults (i.e. Based_on_rollup_flag, Inventory_asset_item_flag, Shrinkage_rate, and Lot_size values) Rerun the request with a cost type that has a default cost type such that a row for the Item/Organization/Cost_type exists in CST_ITEM_COSTS from which defaults can be derived

n

CST_EXP_SUBELEMENT - Rows are marked with this error when either of the following is true:
n

The subelement has expired The Allow_costS_flag for this subelement is set to 2 (No)

n

CST_REQ_ERROR - This error occurs when two requests have the same Group_ID parameter.

4-36

Oracle Manufacturing APIs and Open Interfaces Manual

5
eAM Open Interfaces and APIs
This appendix details the integration tools used to integrate eAM with your existing non-Oracle systems. The following topics are covered:
s

eAM Interfaces and APIs on page 5-1 eAM Item Open Interface on page 5-2 eAM Asset Number Open Interface on page 5-9 eAM Asset Genealogy Open Interface on page 5-12 eAM Meter Reading Open Interface on page 5-15 Meter Reading API on page 5-18 Preventive Maintenance Definition API on page 5-21 Activity Creation API on page 5-27 Maintenance Object Instantiation API on page 5-40 Work Order Business API on page 5-41

s

s

s

s

s

s

s

s

s

eAM Interfaces and APIs
Oracle Enterprise Asset Management provides a number of open interfaces and APIs, enabling you to link with non-Oracle applications, applications you build, and applications on other computers.

eAM Open Interfaces and APIs

5-1

eAM Interfaces and APIs

This section includes the following topics: – – – – eAM Item Open Interface on page 5-2 eAM Asset Number Open Interface on page 5-9 eAM Asset Genealogy Open Interface on page 5-12 eAM Meter Reading Open Interface on page 5-15

eAM Item Open Interface
The eAM Item Open Interface enables you to import asset groups, asset activities, and rebuildable items into the eAM application in a batch process. You can create them as new items or update existing items (asset groups, asset activities, or rebuildable items). The Item Open Interface validates your data, insuring that your imported items contain the same item detail as items you enter manually in the Master Item window. You can also import item category assignments. This can be done simultaneously with a process of importing items, or as a separate task of importing item category assignments only. When importing items through the Item Open Interface, you create new items in your item master organization, update existing items, or assign existing items to additional organizations. You can specify values for all the item attributes, or you can specify just a few attributes and let the remainder default or remain null. The Item Open Interface also enables import revision details, including past and future revisions and effectivity dates. Validation of imported items is done using the same rules as the item definition windows, so you are insured of valid items. See: Overview of Engineering Prototype Environment, Oracle Engineering User’s Guide and Defining Items, Oracle Inventory User’s Guide. The Item Open Interface reads data from three tables for importing items and item details. Use the MTL_SYSTEM_ITEMS_INTERFACE table for new item numbers and all item attributes. This is the main item interface table, and may be the only table you choose to use. When importing revision details for new items, use the MTL_ITEM_REVISIONS_INTERFACE table. This table is used for revision information, and is not required. When importing item category assignments, use the MTL_ITEM_CATEGORIES_INTERFACE table to store data about item assignments to category sets, and categories to be imported into the Oracle Inventory MTL_ITEM_CATEGORIES table. A fourth table, MTL_INTERFACE_ ERRORS, is used for error tracking of all items that the Item Interface fails.

5-2

Oracle Manufacturing APIs and Open Interfaces Manual

eAM Interfaces and APIs

Before using the Item Open Interface, you must write and run a custom program that extracts item information from your source system and inserts the records into the MTL_SYSTEM_ITEMS_INTERFACE table, and (if revision detail is included) the MTL_ITEMS_REVISIONS_INTERFACE table, as well as the MTL_ITEM_ CATEGORIES_INTERFACE table. After you load item, revision, and item category assignment records into these interface tables, you run the Item Open Interface to import the data. The Item Open Interface assigns defaults, validates included data, and then imports the new items.
Note: You must import items into a master organization before

you import items into additional organizations. You can accomplish this by specifying only your master organization on a first pass run of the Item Open Interface. Once this has completed, you can run the Item Open Interface again, this time specifying an additional or all organizations.

Setting Up the Item Open Interface
1.

Create Indexes for Performance. Create the following indexes to improve the Item Open Interface performance. First, determine which segments are enabled for the System Items flexfield. Then, for example, if you have a two-segment flexfield, with SEGMENT8 and SEGMENT12 enabled, you would do the following:

SQL> create unique index MTL_SYSTEM_ITEMS_B_UC1 on MTL_SYSTEM_ITEMS_B (ORGANIZATION_ID, SEGMENT8, SEGMENT12); SQL> create unique index MTL_SYSTEM_ITEMS_INTERFACE_UC1 on mtl_system_items_interface (organization_id, segment8, segment12);

If you plan to populate the ITEM_NUMBER column in mtl_system_items_ interface instead of the item segment columns, do not create the MTL_ SYSTEM_ITEMS_INTERFACE_UC1 unique index. Instead, create MTL_ SYSTEM_ITEMS_INTERFACE_NC1 non-unique index on the same columns. Create the following indexes for optimum performance: MTL_SYSTEM_ITEMS_B
s

Non-Unique Index on organization_id, segmentn You need at least one indexed, mandatory segment.

s

eAM Open Interfaces and APIs

5-3

eAM Interfaces and APIs

MTL_SYSTEM_ITEMS_INTERFACE
s

Non Unique Index on inventory_item_id, organization_id Non Unique Index on Item _number Unique Index on Transaction_id Note: This Index will have to be recreated as Non Unique if you are populating organization_code, instead of organization_id. It should include the segment (s) having been enabled for the System Item Key Flexfield. You are enabled to use the created default index if you are using segment1.

s

s

MTL_ITEM_REVISIONS_INTERFACE
s

Non Unique Index on set_process_id Non Unique Index on Transaction_id Non Unique Index on Organization_id, Inventory_item_id, Revision

s

s

MTL_ITEM_CATEGORIES_INTERFACE
s

Non Unique Index on inventory_item_id, category_id Non Unique Index on set_process_id
Suggestion:

s

Populate _id fields whenever possible. Populating inventory_item_id instead of segment (n) for Update Mode will significantly improve performance. Populating organization_id instead of organization_code for both Create and Update modes, will also reduce processing time.

2.

Start the Concurrent Manager. Because the Item Open Interface process is launched and managed via the concurrent manager, you must ensure that the concurrent manager is running before you can import any items.

3.

Set Profile Option Defaults.

5-4

Oracle Manufacturing APIs and Open Interfaces Manual

eAM Interfaces and APIs

Some columns use profile options as default values. You must set these profiles if you want them to default. See: Inventory Profile Options, Oracle Inventory User’s Guide and Overview of Inventory Setup, Oracle Inventory User’s Guide.

Execution Steps
1.

Populate the interface tables. The item interface table MTL_SYSTEM_ITEMS_INTERFACE contains every column in the Oracle Inventory item master table, MTL_SYSTEM_ITEMS. The columns in the item interface correspond directly to those in the item master table. Except for ITEM_NUMBER or SEGMENTn columns, ORGANIZATION_ CODE or ORGANIZATION_ID, DESCRIPTION, PROCESS_FLAG, and TRANSACTION_TYPE, all of these columns are optional, either because they have defaults that can be derived, or because the corresponding attributes are optional and may be left null. You may put in details about other interface tables not used by the Item Open Interface. Currently, the interface does not support the MTL_CROSS_REFERENCE_ INTERFACE or MTL_SECONDARY_LOCS_INTERFACE. The MTL_ITEM_CATEGORIES_INTERFACE is used by the Item Open Interface for both internal processing of default category assignments, and to retrieve data populated by the user to be imported into the Oracle Inventory MTL_ITEM_CATEGORIES table.

Table 5–1 MTL_SYSTEM_ITEMS_INTERFACE Column Names (partial list of columns) PROCESS_FLAG Instruction Enter 1 for pending data to be imported. After running the import process, the PROCESS_FLAG of the corresponding rows will be set to different values, indicating the results of the import (1 = Pending, 2 = Assign complete, 3 = Assign/validation failed, 4 = Validation succeeded; import failed, 5 = Import in process, 6 = Import succeeded) TRANSACTION_TYPE SET_PROCESS_ID Enter CREATE to create a new item, or UPDATE to update existing items. Enter an arbitrary number. Rows designated with the same value for SET_PROCESS_ID will process together.

ORGANIZATION_CODE Enter the organization that the new item will import into.

eAM Open Interfaces and APIs

5-5

eAM Interfaces and APIs

Table 5–1 MTL_SYSTEM_ITEMS_INTERFACE Column Names (partial list of columns) SEGMENT1~20 DESCRIPTION EAM_ITEM_TYPE INVENTORY_ITEM_ FLAG Instruction Corresponds to the item name (for example, the name of the Asset Group, Asset Activity, or Rebuildable Item) Enter the description of the item. Enter 1 for Asset Group, 2 for Asset Activity, or 3 for Rebuildable Item. Enter Y for eAM items.

MTL_TRANSACTIONS_ Enter N for Asset Group and Asset Activity. Enter Y for ENABLED_FLAG Rebuildable Item. EFFECTIVITY_ CONTROL SERIAL_NUMBER_ CONTROL_CODE Enter 2 for Unit Effectivity Control for eAM Asset Groups. Enter 2 (Predefined) for Asset Groups; This should be NULL for Asset Activities. Enter 1 (No Control) for Non-Serialized Rebuildable Items. Enter 2 (Predefined) or 5 (Dynamic entry at inventory receipt) or 6 (Dynamic entry at sales order issue) for Serialized Rebuildable items. AUTO_SERIAL_ALPHA_ Serial Number Prefix PREFIX START_AUTO_SERIAL_ NUMBER Start Serial Number

Note: For information about columns not discussed, see Table and

View Definitions, Oracle Inventory Technical Reference Manual.
2.

Launch the Item Import process.
a.

Navigate to the Import Items window. Choose an organization if you have not specified one already. You must import items into the master organization before importing them to additional children organization.

b.

Enter parameters:

5-6

Oracle Manufacturing APIs and Open Interfaces Manual

eAM Interfaces and APIs

Table 5-1 Parameters
Parameter Name All Organizations Instruction Select Yes to run the interface for all organization codes within the item interface table. Select No to run the interface for only interface rows within the current organization. Validate Items Select Yes to validate all items, and their information residing in the interface table, that have not yet been validated. If items are not validated, they will not be imported into eAM. Select No to not validate items within the interface table. Use this option if you have previously run the Item Open interface and responded Yes in the Validate Items parameter, and No in the Process Items parameter, and now need to process your items. Process Items Select Yes to import all qualifying items in the interface table into eAM. Select No to not import items into eAM. Use this option, along with Yes in the Delete Processed Rows parameter, to remove successfully processed rows from the interface table, without performing any other processing. You can also use this option, with Yes in the Validate Items parameter, to validate items without any processing. Delete Processed Rows Select Yes to delete successfully processed rows from the item interface tables. Select No to leave all rows in the item interface tables. Process Set Enter a set id number for the set of rows in the interface table to process. The interface process will process rows having that id in the SET_PROCESS_ID column. If you leave this parameter blank, all rows are picked up for processing, regardless of the SET_PROCESS_ID column value. Select 1 to create new items. Select 2 to update existing items. You can create or update items via separate executions of the Import Items process. c. d.

Create or Update Items

Choose OK. Choose Submit to launch the Asset Number Import process. You can view its progress by choosing View from the tool bar, and then selecting Requests.

eAM Open Interfaces and APIs

5-7

eAM Interfaces and APIs

See Also: Oracle Manufacturing APIs and Open Interfaces Manual, Release 11i Defining Asset Groups, Oracle Enterprise Asset Management User’s Guide Defining Asset Activities, Oracle Enterprise Asset Management User’s Guide Defining Rebuildable Items, Oracle Enterprise Asset Management User’s Guide

5-8

Oracle Manufacturing APIs and Open Interfaces Manual

eAM Interfaces and APIs

eAM Asset Number Open Interface
The eAM Asset Number Open Interface enables you to import asset numbers into eAM, using a batch process. You can optionally import asset number attributes. You can create new asset numbers and attributes, or update existing asset numbers and attributes.

Execution Steps
1.

Populate the interface tables with the import information. The two item interface tables to be populated are MTL_EAM_ASSET_NUM_ INTERFACE (MEANI), and the MTL_EAM_ATTR_VAL_INTERFACE (MEAVI). The MTL_EAM_ASSET_NUM_INTERFACE table stores relevant asset number information. If the asset’s attributes are also imported; that information is stored in the MTL_EAM_ATTR_VAL_INTERFACE.

Table 5–2 MTL_EAM_ASSET_NUM_INTERFACE (MEANI) Column Name (partial list of columns) Instruction BATCH_ID PROCESS_FLAG IMPORT_MODE IMPORT_SCOPE INVENTORY_ITEM_ID SERIAL_NUMBER Enter an arbitrary number. Rows designated with the same BATCH_ID will process together. Enter a P for pending. This value will change to S if the import is successful, or E if the row contains an error. Enter 0 to create new rows (asset numbers), or 1 to update existing rows. Enter 0 to import both Asset Numbers and Attributes, 1 to import Asset Numbers only. Enter the inventory item id for Asset Group to associate with the imported Asset Number(s). Enter the name of the Asset Number.

ORGANIZATION_CODE Enter the current organization. OWNING_ DEPARTMENT_CODE ERROR_CODE ERROR_MESSAGE Enter the Owning Department of the asset number(s). This column will update by the Import process if an error occurs. This column will update by the Import process if an error occurs.

eAM Open Interfaces and APIs

5-9

eAM Interfaces and APIs

Table 5–2 MTL_EAM_ASSET_NUM_INTERFACE (MEANI) Column Name (partial list of columns) Instruction INTERFACE_HEADER_ ID This is used with the identically named column in the MEAVI table, to relate the Attributes associated with an Asset Number.

Table 5–3 MTL_EAM_ATTR_VAL_INTERFACE (MEAVI) Column Name (partial list of columns) Instruction PROCESS_STATUS INTERFACE_HEADER_ ID INTERFACE_LINE_ID END_USER_COLUMN_ NAME ATTRIBUTE_ CATEGORY LINE_TYPE ATTRIBUTE_ VARCHAR2_VALUE ATTRIBUTE_NUMBER_ VALUE ATTRIBUTE_DATE_ VALUE ERROR_NUMBER ERROR_MESSAGE Enter P (Pending). This value will change to S if the import is successful, or E if the row contains an error. Foreign key of the identically named column in the MEANI table to relate to the Asset Number an Attribute is associated with. A unique key Corresponds with the Attribute Name Corresponds with the Attribute Group Enter 1 if the Attribute is of type VARCHAR2, 2 if it is of type NUMBER, or 3 if it is of type DATE. Value of the Attribute; used with LINE_TYPE = 1 Value of the Attribute; used with LINE_TYPE = 2 Value of the Attribute; used with LINE_TYPE = 3 This column will update by the Import process if an error occurs. This column will update by the Import process if an error occurs.

Note: For information about columns not discussed, see Table and View Definitions, Oracle Enterprise Asset Management Technical Reference Manual.

5-10

Oracle Manufacturing APIs and Open Interfaces Manual

Any failed rows with error messages will not delete. Launch the Asset Number Import process to import interface information into the MTL_SERIAL_NUMBERS production table. Navigate to the Asset Number Import window.eAM Interfaces and APIs 2.G_ VALID_ LEVEL_FULL eAM Open Interfaces and APIs 5-11 . You can view its progress by choosing View from the tool bar. and then selecting Requests. Choose an organization if you have not specified one already.G_ FALSE FND_API. a. Table 5–4 INV_GENEALOGY_PUB Column Name P_API_VERSION P_INIT_MSG_LIST P_COMMIT P_VALIDATION_LEVEL Type Number Varchar2 Varchar2 Number Required Yes Default FND_API. d.G_ FALSE FND_API. Select No to keep all rows in the interface tables after they have successfully imported into the production tables. Enter parameters: Table 5-2 Parameters Column Name Batch ID Purge Option Instruction This is the same value that is populated in the BATCH_ID column within the MEANI table. c. Choose OK. b. and is called from the Asset Number Open Interface process. Select Yes to delete rows in the interface tables after they have successfully imported into the production tables. Choose Submit to launch the Asset Number Import process. Create and Update Asset Genealogy and Hierarchy API The INV_GENEALOGY_PUB public API is used to create and update asset genealogy and hierarchy information in the MTL_OBJECT_GENEALOGY table.

using a batch process. You can create new parent/child relationships. Execution Steps 1. Oracle Enterprise Asset Management User’s Guide eAM Asset Genealogy Open Interface The eAM Asset Genealogy Open Interface enables you to import asset genealogy (configuration history) into eAM. or update existing relationships. 5-12 Oracle Manufacturing APIs and Open Interfaces Manual . Populate the interface tables with the import information.eAM Interfaces and APIs Table 5–4 INV_GENEALOGY_PUB Column Name P_OBJECT_TYPE Type Number Required Yes Default - P_PARENT_OBJECT_TYPE Number P_OBJECT_ID P_OBJECT_NUMBER P_INVENTORY_ITEM_ID P_ORG_ID P_PARENT_OBJECT_ID P_PARENT_OBJECT_ NUMBER Number Varchar2 Number Number Number Varchar2 P_PARENT_INVENTORY_ Number ITEM_ID P_PARENT_ORG_ID P_GENEALOGY_ORIGIN P_GENEALOGY_TYPE P_START_DATE_ACTIVE P_END_DATE_ACTIVE P_ORIGIN_TXN_ID P_UPDATE_TXN_ID Number Number Number Date Date Number Number See Also: Defining Asset Numbers.

Enter 2 for eAM. Enter the Parent/Child relationship end date. Enter 3 (Manual) for eAM. Enter P (Pending). Rows designated with the same BATCH_ID will process together. Enter 2 for eAM. or 1 to update existing rows. or E if the row contains an error. eAM Open Interfaces and APIs 5-13 .eAM Interfaces and APIs The Asset Genealogy Import process reads information within the MTL_ OBJECT_GENEALOGY_INTERFACE (MOGI) table. This column will update by the Import process if an error occurs. This value will change to S if the import is successful. Unique key Enter 0 to create new rows (configuration histories). Corresponds to Asset Group Corresponds to Asset Number Corresponds to Parent Asset Group Corresponds to Parent Asset Number Enter the Parent/Child relationship start date. This column will update by the Import process if an error occurs. Enter 5 for eAM. Table 5–5 MTL_OBJECT_GENEALOGY_INTERFACE (MOGI) Column Name (partial list of columns) Instruction BATCH_ID PROCESS_STATUS INTERFACE_HEADER_ ID IMPORT_MODE OBJECT_TYPE PARENT_OBJECT_TYPE GENEALOGY_ORIGIN GENEALOGY_TYPE INVENTORY_ITEM_ID SERIAL_NUMBER PARENT_INVENTORY_ ITEM_ID PARENT_SERIAL_ NUMBER START_DATE_ACTIVE END_DATE_ACTIVE ERROR_CODE ERROR_MESSAGE Enter an arbitrary number. then imports that information into the production tables.

Navigate to the Asset Genealogy Import window. See Also: Viewing and Updating the Configuration History. Launch the Asset Genealogy Import process. You can view its progress by choosing View from the tool bar. Enter parameters: Table 5-3 Parameters Parameter Batch ID Purge Option Instruction This is the same value that is populated in the BATCH_ID column within the MOGI table.eAM Interfaces and APIs Note: For information about columns not discussed. see Table and View Definitions. c. and then selecting Requests. Select No to keep all rows in the interface tables after they have successfully imported into the production tables. You have to import asset genealogies into the master organization before importing them into additional children organizations. b. Choose Submit to launch the Asset Genealogy Import process. 2. d. Choose OK. Oracle Enterprise Asset Management Technical Reference Manual. a. Oracle Enterprise Asset Management User’s Guide Displaying the Asset Hierarchy. Oracle Enterprise Asset Management User’s Guide 5-14 Oracle Manufacturing APIs and Open Interfaces Manual . Select Yes to delete rows in the interface tables after they have successfully imported into the production tables. Choose an organization if you have not specified one already. Any failed rows with error messages will not delete.

READING_DATE READING_VALUE Date the reading is entered Reading value at the reading date eAM Open Interfaces and APIs 5-15 . the organization provided must be enabled for eAM. Execution Steps 1. Enter 2 for rows to be processed. LIFE_TO_DATE Enter a value for LIFE_TO_DATE or a value in the READING_ VALUE column. or E if the row contains an error. This value will change to S if the import is successful. If you enter an organization ID. Enter P (Pending). Enter No to not reset the meter reading. the processor will error.eAM Interfaces and APIs eAM Meter Reading Open Interface Import Meter Reading is an interface process used to import meter readings into eAM. then imports that information into the eAM production table. ORGANIZATION_ID ORGANIZATION_CODE If you enter an organization code. and the LIFE_TO_DATE_READING value is calculated from this current reading. Populate the interface table with the import information. If there is an already existing meter reading for the given meter that occurs after this reset reading. the organization provided must be enabled for eAM. If both columns are populated. then the READING_VALUE value is used to enter a reading. The Meter Reading Import process reads information within the EAM_METER_ READING_INTERFACE table. Enter Yes to reset the meter reading. This is not mandatory if you entered a METER_ID. Table 5–6 EAM_METER_READING_INTERFACE Column Name (partial list of columns) Instruction GROUP_ID PROCESS_STATUS PROCESS_PHASE METER_ID METER_NAME RESET_FLAG Enter an arbitrary number. Rows designated with the same GROUP_ID will process together. Unique key Enter the name of the meter to process.

Choose Submit to launch the Meter Reading Import process. 5-16 Oracle Manufacturing APIs and Open Interfaces Manual . c. Oracle Enterprise Asset Management Technical Reference Manual. Enter the work order name that the reading is associated with. then the ORGANIZATION_ID or ORGANIZATION_CODE columns are mandatory. Enter parameters: Group ID Corresponds to the GROUP_ID in the EAM_METER_READING_ INTERFACE table. and then selecting Requests. 2. then the ORGANIZATION_ID or ORGANIZATION_CODE columns are mandatory. Choose an organization if you have not specified one already.eAM Interfaces and APIs Table 5–6 EAM_METER_READING_INTERFACE Column Name (partial list of columns) Instruction WIP_ENTITY_ID Enter the work order id that the reading is associated with. see Table and View Definitions. You can view its progress by choosing View from the tool bar. Choose OK. Description of meter reading This column will update by the Import process if an error occurs. Navigate to the Import Jobs and Schedules window. If the column is populated. b. The import process will only process those meter readings that have a GROUP_ID in the interface table matching the value entered in this parameter. a. This column will update by the Import process if an error occurs. WORK_ORDER_NAME DESCRIPTION ERROR_CODE ERROR_MESSAGE Note: For information about columns not discussed. Launch the Meter Reading Import process. You must import work orders into the master organization before importing them into additional children organizations. If this column is populated.

2. and Created By. and reading value. such as Group ID. or Organization code. The rows that display failed to import into eAM. such as meter name. Description. select the Readings tab to display meter reading information. eAM Open Interfaces and APIs 5-17 . such as Organization. Reading Date. Figure 5–1 Pending Meter Reading Window 3. reading date. to narrow your search. 5. select the More tab to display information about the meter reading. select the Process tab to display general information about the errored meter readings. Optionally. 4. Choose Find.eAM Interfaces and APIs To view pending meter readings: You can display the rows within the interface table that failed to import into eAM. Navigate to the Find Meter Readings window. This window enables you to query rows using search criteria. Optionally. 1. Optionally. Work order.

select Errors to view additional detailed information regarding the type and cause of the failure. after correcting errors. Oracle Enterprise Asset Management User’s Guide Meter Reading API Package Name: EAM_METERREADING_PUB Procedure Name: CREATE_METER_READING The CREATE_METER_READING API creates meter readings and reset existing meter readings. Optionally. 7. choose Submit1 to import work orders.G_ FALSE Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API Output parameter Standard Oracle API Output parameter Standard Oracle API output parameter Standard Oracle API output parameter x_msg_count NUMBER x_msg_data VARCHAR2 x_return_status VARCHAR2 5-18 Oracle Manufacturing APIs and Open Interfaces Manual . See Also: Entering Meter Readings. again. Optionally. The table below provides the specifications for this API: Table 5–7 CREATE_METER_READING Parameter p_api_version p_init_msg_list p_commit Type NUMBER VARCHAR2 VARCHAR2 Required x FND_API.G_ FALSE FND_API.Meter Reading API 6.

meter_ reading_Rec_ Type p_value_before_ reset NUMBER NULL Value of the meter reading before reset. Required when the reading is a reset The meter_reading_ id of the newly created record x_meter_reading_ id NUMBER Table 5–8 meter_reading_rec_type Column name meter_id meter_reading_id current_reading current_reading_ date reset_flag description wip_entity_id Type NUMBER NUMBER NUMBER DATE VARCHAR2(1) VARCHAR2(100) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) eAM Open Interfaces and APIs 5-19 .Meter Reading API Table 5–7 CREATE_METER_READING Parameter Type Required x Default Description The record includes details of the meter reading p_meter_reading_ Eam_ rec MeterReadin g_ PUB.

The user also needs to supply either a meter name or a meter id to identify the meter. The table below provides the specifications for this API: Table 5–9 DISABLE_METER_READING Parameter p_api_version p_init_msg_list Type NUMBER VARCHAR2 Required x FND_API.Meter Reading API Table 5–8 meter_reading_rec_type Column name attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 source_line_id source_code wo_entry_fake_ flag Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER VARCHAR2(30) VARCHAR2(1) Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Package Name: EAM_METERREADING_PUB Procedure Name: DISABLE_METER_READING The DISABLE_METER_READING public API disables existing meter readings.G_ FALSE Default Description Standard Oracle API parameter Standard Oracle API parameter 5-20 Oracle Manufacturing APIs and Open Interfaces Manual . The user needs to supply either a meter reading id or a meter reading date. to identify the specific reading.

Package Name: EAM_PMDEF_PUB Procedure Name: CREATE_PM_DEF The CREATE_PM_DEF public API creates a new Preventive Maintenance definition.Preventive Maintenance Definition API Table 5–9 DISABLE_METER_READING Parameter p_commit x_return_status Type VARCHAR2 VARCHAR2 Required Default FND_API. Preventive Maintenance schedule header and rules are specified. and new Preventive Maintenance schedules or templates are validated and then generated.G_ FALSE Description Standard Oracle API parameter Standard Oracle API output parameter Standard Oracle API output parameter x Standard Oracle API output parameter NULL The meter_reading_ id of the meter reading to be disabled The meter_id of the meter Meter reading date Meter name x_msg_count NUMBER x_msg_data VARCHAR2 p_meter_reading_ NUMBER id p_meter_id NUMBER NULL NULL NULL p_meter_reading_ DATE date p_meter_name VARCHAR2 Preventive Maintenance Definition API The Preventive Maintenance Definition API creates a new Preventive Maintenance Schedules or Preventive Maintenance Schedule Templates. The table below provides the specifications for this API: eAM Open Interfaces and APIs 5-21 .

Preventive Maintenance Definition API

Table 5–10 Parameter

CREATE_PM_DEF Type NUMBER VARCHAR2 VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ FALSE Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API output parameter Standard Oracle API output parameter Standard Oracle API output parameter x This record contains all the information of the PM header A table of day interval rule records. If no day interval rules are defined for this PM definition, pass in an empty table of type pm_rule_tbl_ type A table of run time rule records. If no run time rules are defined for this PM definition, pass in an empty table of type pm_rule_tbl_ type

p_api_version p_init_msg_list p_commit x_msg_count

x_msg_data

VARCHAR2

x_return_status

VARCHAR2

p_pm_schedule_ rec p_pm_day_ interval_rules_tbl

pm_ scheduling_ rec_type pm_rule_tbl_ type

x

p_pm_runtime_ rules_tbl

pm_rule_tbl_ type

x

5-22

Oracle Manufacturing APIs and Open Interfaces Manual

Preventive Maintenance Definition API

Table 5–10 Parameter

CREATE_PM_DEF Type pm_rule_tbl_ type Required x Default Description A table of list date records. If no list date rules are defined for this PM definition, pass in an empty table of type pm_rule_tbl_ type The pm_schedule_ id for the newly created PM

p_pm_list_date_ rules_tbl

x_new_pm_ schedule_id

NUMBER

x

Package Name: EAM_PMDEF_PUB Procedure Name: UPDATE_PM_DEF The UPDATE_PM_DEF API updates an existing Preventive Maintenance definition. The table below provides the specifications for this API:
Table 5–11 UPDATE_PM_DEF Parameter p_api_version p_init_msg_list p_commit x_msg_count Type NUMBER VARCHAR2 VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ FALSE Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API Output parameter Standard Oracle API output parameter Standard Oracle API output parameter

x_msg_data

VARCHAR2

x_return_status

VARCHAR2

eAM Open Interfaces and APIs 5-23

Preventive Maintenance Definition API

Table 5–11 UPDATE_PM_DEF Parameter p_pm_schedule_ id Type NUMBER Required Default Description The pm_schedule_ id of the PM definition to be updated NULL This record contains all of the information for the PM header A table of day interval rule records A table of run time rule record A table of list date record

p_pm_schedule_ rec

pm_ scheduling_ rec_type pm_rule_tbl_ type pm_rule_tbl_ type pm_rule_tbl_ type x x x

p_pm_day_ interval_rules_tbl p_pm_runtime_ rules_tbl p_pm_list_date_ rules_tbl

Table 5–12

PM_SCHEDULING_REC_TYPE Type NUMBER VARCHAR2(1) DATE DATE NUMBER NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name pm_schedule_id non_schedule_ flag from_effective_ date to_effective_date rescheduling_ point lead_time

attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150)

5-24

Oracle Manufacturing APIs and Open Interfaces Manual

Preventive Maintenance Definition API

Table 5–12

PM_SCHEDULING_REC_TYPE Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(1) VARCHAR2(1) VARCHAR2(1) NUMBER NUMBER NUMBER DATE DATE NUMBER VARCHAR2(1) Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 day_tolerance source_code source_line default_ implement whichever_first include_manual set_name_id scheduling_ method_code type_code next_service_ start_date next_service_ end_date source_tmpl_id auto_ instantiation_flag

eAM Open Interfaces and APIs 5-25

Preventive Maintenance Definition API

Table 5–12

PM_SCHEDULING_REC_TYPE Type VARCHAR2(50) VARCHAR2(1) Default NULL NULL

Column name name tmpl_flag

Table 5–13

PM_RULE_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name rule_id rule_type day_interval meter_id runtime_interval last_service_ reading

effective_reading_ NUMBER from effective_reading_ NUMBER to effective_date_ from effective_date_to list_date list_date_desc DATE DATE DATE VARCHAR2(50)

TYPE pm_rule_tbl_type IS TABLE OF pm_rule_rec_type INDEX BY BINARY_INTEGER

5-26

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–14

PM_NUM_REC_TYPE Type NUMBER NUMBER NUMBER Default NULL NULL NULL

Column name index1 num1 other

TYPE pm_num_tbl_type IS TABLE OF pm_num_rec_type INDEX BY BINARY_INTEGER

Activity Creation API
Package Name: EAM_ACTIVITY_PUB Procedure Name: CREATE_ACTIVITY The CREATE_ACTIVITY API creates eAM activities. The user can specify the source of the Work Order that the API uses as a model for the new Activities. Optionally, the user needs to specify an item template in Create_Activity procedure (either by specifying parameter p_template_id or p_template_name) to define the attributes of the Activity. The user can specify various Activity properties, such as Activity Type, Cause, Shutdown Notification, and Source. The Activity Creation API includes various copy options that control the copy of Operations, Material, Resources, and Activity Association are supported. The table below provides the specifications of this API:
Table 5–15 Parameter p_api_version p_init_msg_list p_commit validation_level CREATE_ACTIVITY Type NUMBER VARCHAR2 VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ FALSE FND_API.G_ VALID_LEVEL_ FULL Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter

eAM Open Interfaces and APIs 5-27

Activity Creation API

Table 5–15 Parameter

CREATE_ACTIVITY Type VARCHAR2 Required Default Description Standard Oracle API output parameter Standard Oracle API output parameter Standard Oracle API output parameter Item record to define the attributes of the activity NULL Template id(if template name is also specified. Template id will overide template name) Template name Activity type Activity cause Shutdown type Notification Required Flag (’Y’ for enabled, ’N’ for disabled) Activity source Specifies the source Work Order the new activity is to be created from

x_return_status

x_msg_count

NUMBER

x_msg_data

VARCHAR2

p_asset_activity

x inv_item_ grp.item_rec_ type NUMBER

p_template_id

p_template_name p_activity_type_ code p_activity_cause_ code p_shutdown_ type_code p_notification_ req_flag

VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2

NULL NULL NULL NULL NULL

p_activity_ source_code p_work_order_ rec

VARCHAR2 EAM_ ACTIVITY_ PUB.WORK_ ORDER_ REC_TYPE

NULL

5-28

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–15 Parameter

CREATE_ACTIVITY Type NUMBER Required Default 2 Description Operation Copy Option: 1 (NONE), 2 (ALL) Material Copy Option: 1 (NONE), 2 (ISSUED), 3 (ALL) Resource Copy Option: 1 (NONE), 2 (ISSUED), 3 (ALL) Association Copy Option: 1 (NONE), 2 (CURRENT), 3 (ALL) Output. Validated Work Order record

p_operation_ copy_option p_material_copy_ option p_resource_copy_ option p_association_ copy_option

NUMBER

2

NUMBER

2

NUMBER

2

x_work_order_rec EAM_ ACTIVITY_ PUB.WORK_ ORDER_ REC_TYPE x_curr_item_rec INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2

Output. Validated current item record Output. Current item creation return status Output. Current item creation error table Output. Validated master item record Output. Master item creation return status Output. Master item creation error table

x_curr_item_ return_status x_curr_item_ error_tbl x_master_item_ rec x_master_item_ return_status x_master_item_ error_tbl

INV_ITEM_ GRP.ERROR_ TBL_TYPE INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2

INV_ITEM_ GRP.ITEM_ REC_TYPE

eAM Open Interfaces and APIs 5-29

Activity Creation API

Table 5–15 Parameter

CREATE_ACTIVITY Type BOM_Rtg_ Pub.Rtg_ Header_Rec_ Type Required Default Description Routing Business Object API output

x_rtg_header_rec

x_rtg_revision_tbl BOM_Rtg_ Pub.Rtg_ Revision_ Tbl_Type x_operation_tbl BOM_Rtg_ Pub.Operatio n_Tbl_Type

Routing Business Object API output

Routing Business Object API output Routing Business Object API output

x_op_resource_tbl BOM_Rtg_ Pub.Op_ Resource_ Tbl_Type x_sub_resource_ tbl BOM_Rtg_ Pub.Sub_ Resource_ Tbl_Type

Routing Business Object API output

x_op_network_tbl BOM_Rtg_ Pub.Op_ Network_ Tbl_Type x_rtg_return_ status x_rtg_msg_count x_rtg_msg_list VARCHAR2 NUMBER Error_ Handler.Erro r_Tbl_Type BOM_BO_ PUB.BOM_ Head_Rec_ Type BOM_BO_ PUB.BOM_ Revision_tbl_ Type

Routing Business Object API output

Routing Business Object API output Routing Business Object API output Routing Business Object API output BOM Business Object API output

x_bom_header_ rec

x_bom_revision_ tbl

BOM Business Object API output

5-30

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–15 Parameter

CREATE_ACTIVITY Type BOM_BO_ PUB.BOM_ Comps_Tbl_ Type VARCHAR2 NUMBER Error_ Handler.Erro r_Tbl_Type VARCHAR2 NUMBER VARCHAR2 EAM_ Activity_ PUB.Activity _ Association_ Tbl_Type EAM_ Activity_ PUB.Activity _ Association_ Tbl_Type Required Default Description BOM Business Object API output

x_bom_ component_tbl

x_bom_return_ status x_bom_msg_ count x_bom_msg_list

BOM Business Object API output BOM Business Object API output BOM Business Object API output Copy Association API output Copy Association API output Copy Association API output Copy Association API output

x_assoc_return_ status x_assoc_msg_ count x_assoc_msg_ data x_act_num_ association_tbl

x_activity_ association_tbl

Copy Association API output

eAM Open Interfaces and APIs 5-31

Activity Creation API

Package Name: EAM_ACTIVITY_PUB Procedure Name: COPY_ACTIVITY The COPY_ACTIVITY API creates a new activity from an existing activity. When copying from the source activity, the user can copy the source activity’s BOM, Routing and Associations. The table below provides the specifications of this API:
Table 5–16 Parameter p_api_version p_init_msg_list p_commit p_validation_ level x_return_status COPY_ACTIVITY Type NUMBER VARCHAR2 VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ FALSE FND_API.G_ VALID_LEVEL_ FULL Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API output parameter Standard Oracle API output parameter Standard Oracle API output parameter Item record to define the attributes of the activity NULL Template id(if template name is also specified. Template id will overide template name) Template name Activity type

VARCHAR2

x_msg_count

NUMBER

x_msg_data

VARCHAR2

p_asset_activity

inv_item_ x grp.item_rec_ type NUMBER

p_template_id

p_template_name p_activity_type_ code

VARCHAR2 VARCHAR2

NULL NULL

5-32

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–16 Parameter

COPY_ACTIVITY Type VARCHAR2 VARCHAR2 VARCHAR2 Required Default NULL NULL NULL Description Activity cause Shutdown type Notification Required Flag (’Y’ for enabled, ’N’ for disabled) Activity source Organization id source Activity source BOM source designator BOM revision date Routing designator Routing source date BOM Copy Option: 1 (NONE), 2 (ISSUED), 3 (ALL) Routing Copy Option: 1 (NONE), 2 (ISSUED), 3 (ALL) Association Copy Option: 1 (NONE), 2 (ISSUED), 3 (ALL) Output. Validated current item record

p_activity_cause_ code p_shutdown_ type_code p_notification_ req_flag

p_activity_ source_code p_source_org_id p_source_ activity_id p_source_alt_ bom_designator p_source_bom_ rev_date p_source_alt_rtg_ designator p_source_rtg_ rev_date p_bom_copy_ option p_routing_copy_ option p_association_ copy_option x_curr_item_rec

VARCHAR2 NUMBER NUMBER VARCHAR2 DATE VARCHAR2 DATE NUMBER

NULL

NUMBER

NUMBER

INV_ITEM_ GRP.ITEM_ REC_TYPE

eAM Open Interfaces and APIs 5-33

Activity Creation API

Table 5–16 Parameter

COPY_ACTIVITY Type VARCHAR2 Required Default Description Output. Current item creation return status Output. Current item creation error table Output. Validated master item record Output. Master item creation return status Output. Master item creation error table Routing Business Object API output Routing Business Object API output Routing Business Object API output Routing Business Object API output

x_curr_item_ return_status x_curr_item_ error_tbl x_master_item_ rec x_master_item_ return_status x_master_item_ error_tbl x_assoc_return_ status x_assoc_msg_ count x_assoc_msg_ data x_act_num_ association_tbl

INV_ITEM_ GRP.ERROR_ TBL_TYPE INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2

INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2 NUMBER VARCHAR2 EAM_ Activity_ Pub.Activity_ Association_ Tbl_Type EAM_ Activity_ Pub.Activity_ Association_ Tbl_Type

x_activity_ association_tbl

Routing Business Object API output

5-34

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Package Name: EAM_ACTIVITY_PUB Procedure Name: CREATE_ACTIVITY_WITH_TEMPLATE The CREATE_ACTIVITY_WITH_TEMPLATE API creates an activity from a pre-defined template. The table below provides the specifications of this API:
Table 5–17 Parameter p_api_version p_init_msg_list p_commit p_validation_ level x_return_status COPY_ACTIVITY Type NUMBER VARCHAR2 VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ FALSE FND_API.G_ VALID_LEVEL_ FULL Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API output parameter Standard Oracle API output parameter Standard Oracle API output parameter Organization id Organization code NULL NULL NULL NULL NULL NULL NULL Asset activity Segment 1 Segment 2 Segment 3 Segment 4 Segment 5 Segment 6

VARCHAR2

x_msg_count

NUMBER

x_msg_data

VARCHAR2

p_organization_id NUMBER p_organization_ code p_asset_activity p_segment1 p_segment2 p_segment3 p_segment4 p_segment5 p_segment6 NUMBER VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2

eAM Open Interfaces and APIs 5-35

Activity Creation API

Table 5–17 Parameter p_segment7 p_segment8 p_segment9

COPY_ACTIVITY Type VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 NUMBER VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 VARCHAR2 NULL NULL NULL NULL NULL NULL Required Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Description Segment 7 Segment 8 Segment 9 Segment 10 Segment 11 Segment 12 Segment 13 Segment 14 Segment 15 Segment 16 Segment 17 Segment 18 Segment 19 Segment 20 Description Template id Name of template Activity code Activity cause Shutdown type Notification Required Flag (’Y’ for enabled, ’N’ for disabled) Activity source

p_segment10 p_segment11 p_segment12 p_segment13 p_segment14 p_segment15 p_segment16 p_segment17 p_segment18 p_segment19 p_segment20 p_description p_template_id p_template_name p_activity_type_ code p_activity_cause_ code p_shutdown_ type_code p_notification_ req_flag

p_activity_ source_code

VARCHAR2

NULL

5-36

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–17 Parameter

COPY_ACTIVITY Type INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2 Required Default Description Output. Validated current item record Output. Current item creation return status Output. Current item creation error table Output. Validated master item record Output. Master item creation return status Output. Master item creation error table

x_curr_item_rec

x_curr_item_ return_status x_curr_item_ error_tbl x_master_item_ rec x_master_item_ return_status x_master_item_ error_tbl

INV_ITEM_ GRP.ERROR_ TBL_TYPE INV_ITEM_ GRP.ITEM_ REC_TYPE VARCHAR2

INV_ITEM_ GRP.ITEM_ REC_TYPE

Table 5–18

WORK_ORDER_REC_TYPE Type NUMBER VARCHAR2(3) NUMBER VARCHAR2(240) Default NULL NULL NULL NULL

Column name organization_id organization_ code wip_entity_id wip_entity_name

eAM Open Interfaces and APIs 5-37

Activity Creation API

Table 5–19

ACTIVITY_ASSOCIATION_REC_TYPE Type NUMBER NUMBER DATE DATE VARCHAR2(30) Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name organization_id asset_activity_id start_date_active end_date_active priority_code

attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 owning_ department_id activity_cause_ code activity_type_ code activity_source_ code VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30)

5-38

Oracle Manufacturing APIs and Open Interfaces Manual

Activity Creation API

Table 5–19

ACTIVITY_ASSOCIATION_REC_TYPE Type VARCHAR2(10) NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) NUMBER VARCHAR2(1) VARCHAR2(30) VARCHAR2(1) NUMBER VARCHAR2(1) VARCHAR2(240) Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name class_code maintenance_ object_id maintenance_ object_type genealogy_id inventory_item_ id serial_number activity_ association_id tagging_ required_flag shudown_type_ code tmpl_flag creation_ organization_id return_status error_mesg

TYPE activity_association_tbl_type IS TABLE OF activity_association_rec_type INDEX BY BINARY_INTEGER

eAM Open Interfaces and APIs 5-39

Maintenance Object Instantiation API

Maintenance Object Instantiation API
Package Name: EAM_OBJECTINSTANTIATION_PUB Procedure Name: INSTANTIATE_OBJECT The INSTANTIATE_OBJECT API is first triggered after the creation of a Maintenance Object. It will then call the private packages for the Activity Instantiation (from the Maintenance Item, or Activity Templates), and Preventive Maintenance and Meter Instantiations (from their templates). The table below provides the specifications for this API:
Table 5–20 Parameter p_api_version p_init_msg_list p_validation_ level x_return_status INSTANTIATE_OBJECT Type NUMBER VARCHAR2 NUMBER Required x FND_API.G_ FALSE FND_API.G_ VALID_LEVEL_ FULL Default Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API output parameter Standard Oracle API parameter Standard Oracle API output parameter x Standard Oracle API output parameter Only support type 1 (serial numbers) FND_API.G_ FALSE Standard Oracle API parameter

VARCHAR2

x_msg_count x_msg_data

NUMBER VARCHAR2

p_maintenance_ object_id p_maintenance_ object_type p_commit

NUMBER

NUMBER VARCHAR2

x

TYPE association_id_tbl_type IS TABLE OF number INDEX BY BINARY_INTEGER;

5-40

Oracle Manufacturing APIs and Open Interfaces Manual

Work Order Business API

Work Order Business API
Package Name: EAM_PROCESS_WO_PUB Procedure Name: PROCESS_WO The PROCESS_WO API creates, updates, and deletes the eAM Work Orders and their sub-entities, such as Operations, Materials, Resources, Resources Instances, and Operation Dependency. The user can use this API to create these entities in the database. The user can set and update all relevant attributes of the Work Order and its sub-entities. The table below provides the specifications of this API:
Table 5–21 Parameter p_bo_identifier p_api_version_ number p_init_msg_list p_eam_wo_rec PROCESS_WO Type VARCHAR2 NUMBER BOOLEAN EAM_ PROCESS_ WO_ PUB.eam_ wo_rec_type EAM_ PROCESS_ WO_ PUB.eam_ op_tbl_type EAM_ PROCESS_ WO_ PUB.eam_ op_network_ tbl_type EAM_ PROCESS_ WO_ PUB.eam_ res_tbl_type x Required x Default EAM 1.0 FALSE Description Standard Oracle API parameter Standard Oracle API parameter Standard Oracle API parameter Input Work Order record

p_eam_op_tbl

Input PL/SQL table of operation records

p_eam_op_ network_tbl

Input PL/SQL table of operation network records

p_eam_res_tbl

Input PL/SQL table of resource records

eAM Open Interfaces and APIs 5-41

Work Order Business API

Table 5–21 Parameter

PROCESS_WO Type EAM_ PROCESS_ WO_ PUB.eam_ res_inst_tbl_ type EAM_ PROCESS_ WO_ PUB.eam_ res_usage_ tbl_type EAM_ PROCESS_ WO_ PUB.eam_ mat_req_tbl_ type EAM_ PROCESS_ WO_ PUB.eam_ wo_rec_type EAM_ PROCESS_ WO_ PUB.eam_ op_tbl_type EAM_ PROCESS_ WO_ PUB.eam_ op_network_ tbl_type EAM_ PROCESS_ WO_ PUB.eam_ res_tbl_type Required x Default Description Input PL/SQL table of resource instance records

p_eam_res_inst_ tbl

p_eam_res_ usage_tbl

Input PL/SQL table of resource usage records

p_eam_mat_req_ tbl

Input PL/SQL table of material requirements records

x_eam_wo_rec

Output Work Order record

x_eam_op_tbl

Output PL/SQL table of operation records

x_eam_op_ network_tbl

Output PL/SQL table of operation network records

x_eam_res_tbl

Output PL/SQL table of resource records

5-42

Oracle Manufacturing APIs and Open Interfaces Manual

Work Order Business API

Table 5–21 Parameter

PROCESS_WO Type EAM_ PROCESS_ WO_ PUB.eam_ res_inst_tbl_ type EAM_ PROCESS_ WO_ PUB.eam_ res_usage_ tbl_type EAM_ PROCESS_ WO_ PUB.eam_ mat_req_tbl_ type VARCHAR2 Required Default Description Output PL/SQL table of resource instance records

x_eam_res_inst_ tbl

x_eam_res_ usage_tbl

Output PL/SQL table of resource usage records

x_eam_mat_req_ tbl

Output PL/SQL table of material requirements records

x_return_status

Standard Oracle API output parameter Standard Oracle API output parameter N Standard Oracle API output parameter Input parameter for specifying the location of the debug file Input parameter for debug file name

x_msg_count

NUMBER

p_debug

VARCHAR2

p_output_dir

VARCHAR2

NULL

p_debug_ filename

VARCHAR2

EAM_WO_ DEBUG.log

eAM Open Interfaces and APIs 5-43

Work Order Business API

Table 5–22

EAM_WO_REC_TYPE Type VARCHAR2(240) NUMBER NUMBER VARCHAR2(240) VARCHAR2(30) NUMBER NUMBER VARCHAR2(30) NUMBER NUMBER NUMBER VARCHAR2(10) NUMBER VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) VARCHAR2(30) NUMBER NUMBER DATE NUMBER NUMBER DATE Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL

Column name wip_entity_name wip_entity_id organization_id description asset_number asset_group_id rebuild_item_id rebuild_serial_ number maintenance_ object_id Maintenance_ object_type maintenance_ object_source class_code asset_activity_id activity_type activity_cause activity_source work_order_type status_type job_quantity date_released owning_ department priority requested_start_ date

5-44

Oracle Manufacturing APIs and Open Interfaces Manual

Work Order Business API Table 5–22 EAM_WO_REC_TYPE Type DATE VARCHAR2(30) NUMBER VARCHAR2(1) VARCHAR2(1) Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name due_date shutdown_type firm_planned_ flag notification_ require tagout_required plan_maintenance VARCHAR2(1) project_id task_id end_item_unit_ number schedule_group_ id bom_revision_ date routing_revision_ date alternate_ routing_ designator alternate_bom_ designator routing_revision bom_revision parent_wip_ entity_id manual_rebuild_ flag pm_schedule_id wip_supply_type material_account NUMBER NUMBER VARCHAR2(30) NUMBER DATE DATE VARCHAR2(10) VARCHAR2(10) VARCHAR2(3) VARCHAR2(3) NUMBER VARCHAR2(1) NUMBER NUMBER NUMBER NULL NULL NULL NULL NULL NULL NULL NULL eAM Open Interfaces and APIs 5-45 .

Work Order Business API Table 5–22 EAM_WO_REC_TYPE Type Default NULL NULL NULL Column name material_ NUMBER overhead_account resource_account outside_ processing_ account material_ variance_account resource_ variance_account outside_proc_ variance_account std_cost_ adjustment_ account NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NULL NULL NULL NULL overhead_account NUMBER overhead_ variance_account schedule_start_ date schedule_ completion_date common_bom_ sequence_id common_ routing_ sequence_id po_creation_time gen_object_id NUMBER DATE DATE NUMBER NUMBER NULL NULL NULL NULL NULL NULL NUMBER NUMBER NULL NULL NULL NULL NULL NULL attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 5-46 Oracle Manufacturing APIs and Open Interfaces Manual .

Work Order Business API Table 5–22 EAM_WO_REC_TYPE Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(1) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(30) VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 material_issue_ by_mo user_id reponsibility_id request_id program_id program_ application_id source_line_id source_code return_status transaction_type eAM Open Interfaces and APIs 5-47 .

Work Order Business API Table 5–23 EAM_OP_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER NUMBER NUMBER VARCHAR2(30) DATE DATE Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id organization_id operation_seq_ num standard_ operation_id department_id operation_ sequence_id description minimum_ transfer_quantity count_point_type backflush_flag shutdown_type start_date completion_date attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 5-48 Oracle Manufacturing APIs and Open Interfaces Manual .

Work Order Business API Table 5–23 EAM_OP_REC_TYPE Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(4000) NUMBER NUMBER NUMBER VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name attribute11 attribute13 attribute14 attribute15 long_description request_id program_id program_ application_id return_status transaction_type Table 5–24 EAM_RES_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER NUMBER NUMBER NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id organization_id operation_seq_ num resource_seq_ num resource_id uom_code basis_type usage_rate_or_ amount activity_id schedule_flag eAM Open Interfaces and APIs 5-49 .

Work Order Business API Table 5–24 EAM_RES_REC_TYPE Type NUMBER NUMBER NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name assigned_units autocharge_type standard_rate_ flag applied_resource_ NUMBER units applied_resource_ NUMBER value start_date comletion_date schedule_seq_ num DATE DATE NUMBER substitute_group_ NUMBER num replacement_ group_num NUMBER attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 5-50 Oracle Manufacturing APIs and Open Interfaces Manual .

Work Order Business API Table 5–24 EAM_RES_REC_TYPE Type VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name attribute14 attribute15 department_id request_id program_ application_id program_id program_update_ date return_status transaction_type Table 5–25 EAM_RES_INST_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER DATE DATE NUMBER VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id organization_id operation_seq_ num instance_id serial_number start_date completion_date batch_id return_status transaction_type eAM Open Interfaces and APIs 5-51 .

Work Order Business API Table 5–26 EAM_SUB_RES_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(3) NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id organization_id operation_seq_ num resource_seq_ num resource_id uom_code basis_type usage_rate_or_ amount activity_id schedule_flag assigned_units autocharge_type standard_rate_ flag applied_resource_ NUMBER units applied_resource_ NUMBER value start_date comletion_date schedule_seq_ num DATE DATE NUMBER substitute_group_ NUMBER num replacement_ group_num NUMBER 5-52 Oracle Manufacturing APIs and Open Interfaces Manual .

Work Order Business API Table 5–26 EAM_SUB_RES_REC_TYPE Type Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 attribute5 attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 department_id request_id program_ application_id program_id program_update_ date return_status transaction_type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) NUMBER NUMBER NUMBER NUMBER DATE VARCHAR2(1) NUMBER eAM Open Interfaces and APIs 5-53 .

Work Order Business API Table 5–27 EAM_RES_USAGE_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER DATE DATE NUMBER NUMBER NUMBER NUMBER DATE NUMBER NUMBER VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id operation_seq_ num resource_seq_ num organization_id start_date completion_date assigned_units request_id program_ application_id program_id program_update_ date instance_id serial_number return_status transaction_type 5-54 Oracle Manufacturing APIs and Open Interfaces Manual .

Work Order Business API Table 5–28 EAM_MAT_REQ_REC_TYPE Type NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER NUMBER DATE Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name wip_entity_id organization_id operation_seq_ num inventory_item_ id quantity_per assembly department_id wip_supply_type date_required required_quantity NUMBER quantity_issued supply_ subinventory NUMBER VARCHAR2(10) supply_locator_id NUMBER mrp_net_flag mps_required_ quantity mps_date_ required component_ sequence_id comments NUMBER NUMBER DATE NUMBER VARCHAR2(240) attribute_category VARCHAR2(30) attribute1 attribute2 attribute3 attribute4 attribute5 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) eAM Open Interfaces and APIs 5-55 .

5-56 Oracle Manufacturing APIs and Open Interfaces Manual . Type eam_op_network_tbl_type is table of eam_op_network_rec_type INDEX BY BINARY_INTEGER.Work Order Business API Table 5–28 EAM_MAT_REQ_REC_TYPE Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(1) NUMBER NUMBER NUMBER DATE VARCHAR2(1) NUMBER Default NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL NULL Column name attribute6 attribute7 attribute8 attribute9 attribute10 attribute11 attribute11 attribute13 attribute14 attribute15 auto_request_ material request_id program_ application_id program_id program_update_ date return_status transaction_type Type eam_op_tbl_type is table of eam_op_rec_type INDEX BY BINARY_INTEGER.

Type eam_mat_req_tbl_type is table of eam_mat_req_rec_type INDEX BY BINARY_INTEGER. eAM Open Interfaces and APIs 5-57 . Type eam_res_usage_tbl_type is table of eam_res_usage_rec_type INDEX BY BINARY_INTEGER. Type eam_sub_res_tbl_type is table of eam_sub_res_rec_type INDEX BY BINARY_INTEGER.Work Order Business API Type eam_res_tbl_type is table of eam_res_rec_type INDEX BY BINARY_INTEGER. Type eam_res_inst_tbl_type is table of eam_res_inst_rec_type INDEX BY BINARY_INTEGER.

Work Order Business API 5-58 Oracle Manufacturing APIs and Open Interfaces Manual .

Update and Delete features for the ECO Business Object Interface. With the ECO Business Object Interface. update and delete ECO information. You can create.6 Engineering Change Order Business Object Interface The Engineering Change Order (ECO) Business Object Interface enables you to import your change order information from a legacy or product data management (PDM) system into Oracle Engineering. you can automatically import data from your PDM or Legacy system without inserting cryptic Ids or system specific information. Topics included are: s Features on page 6-2 Business Object APIs on page 6-7 Entity Process Flows on page 6-13 s s Engineering Change Order Business Object Interface 6-1 . major features. The ECO Business Object Interface will import the information within an ECO synchronously while still enabling you to import more than one ECO simultaneously. business object architecture and components for the Insert. This document describes the basic business needs.

update. Instead of forcing you to enter cryptic ID and system specific values. update. The Open Interface program figures out all the remaining information. It allows users to update and delete existing ECO data. You should be able to create. The ECO Business Object Interface should process parent information before its processes child information. and delete ECO information synchronously. The Open Interface program validates all data before importing it into the production tables. s s 6-2 Oracle Manufacturing APIs and Open Interfaces Manual . You can easily import create. and delete data.Features Features s The ECO Business Object Interface allows users to create new ECOs in the Oracle Engineering tables. the ECO Business Object Interface allows you to enter only the necessary business information that defines your ECO.

Each new ECO that is setup and processed by the user can be thought of as a business object instance. Engineering Change Order Business Object Interface 6-3 . The ECO Business Object Interface should allows you to import different ECOs simultaneously. ECO Business Object The ECO business object encompasses several entities to fully model the flow of information through it.Features Figure 6–1 ECO Information s You should be able to process ECOs asynchronously.

and the ECO entity diagram. Table 6–1 Production Table and Stored Information Production Table ENG_ENGINEERING_CHANGES ENG_CHANGE_ORDER_REVISIONS ENG_REVISED_ITEMS BOM_INVENTORY_COMPONENTS BOM_REFERENCE_DESIGNATORS BOM_SUBSTITUTE_COMPONENTS Description Stores information about ECO headers Stores information about revisions of an ECO Stores information about revised items on an ECO Stores information about the un-implemented single-level BOM components Stores information about the un-implemented BOM component reference designators Stores information about the un-implemented substitute components associated with a BOM component 6-4 Oracle Manufacturing APIs and Open Interfaces Manual . The following are the existing production tables that exist. Other entities : The other entities represent detailed information about the ECO. ECO Revisions : This provides additional information about the ECO. the organization responsible for it. It shows all the entities that make up the business object. and consequently. such as. The user may wish to keep this entity up-to-date if he/she is particular about implementing a revision control system. s s These entities are governed by business rules that dictate the relationships between the entities. The Business Object in the Database Each of the entities shown in the ECO entity diagram maps to a corresponding table in the database. it holds revision information for an ECO. Following from the above definition of a business object. the processing algorithms used. etc. the ECO name. and the information they store. each ECO business object instance contains the following specific information about its entities : s ECO header : This entity represents general ECO attributes.Features ECO Entity Diagram The following diagram is a representation of the ECO business object. In particular. the change order type. its requestor.

you need only to specify the change notice (ECO name) and the organization in which it exists.Features Business Object Interface Design The Business object architecture is a hierarchy of entities. To import ECO information into Oracle Engineering. To identify an engineering change order. The entities connected directly below are its children. approval status. you only need to know the basic ECO hierarchical tree. and each of its branches consists of child nodes (entities). As in a genealogical tree. Each node in the branch in turn is a parent of the child nodes under it. There can only be one ECO header record per business object. Here is an example: Figure 6–2 Business Object Interface Design ECO Business Object Architecture The ECO Business Object Architecture is based on the business definition of an engineering change order. Engineering Change Order: The ECO header entity is the parent and defines the basic business object. It can also be viewed as a tree with branches. Engineering Change Order Business Object Interface 6-5 . This entity contains information about the status. reason. hence each node has a branch of its own. where the ECO Header entity is the parent. priority and if it is linked to a workflow. the entity at the top is the parent.

It cannot exist without an ECO. change. its operation sequence number. and if there is a new item revision. your reference designator. or disable a component on your revised item’s bill. This entity stores the eco revision information. It cannot exist without a revised component. you must specify the change notice. if you wish to revised the main bill or an alternate. You can enter information into this entity if you wish to revised an item or its bill. the component item number. It cannot exist without a revised item. you must specify the change notice. its effectivity date. the organization in which it exists. you must specify the change notice. its operation sequence number. your revised item number. you simply need to categorize your data into ECO Business Object and identify which records you wish to import. its effectivity date. You can enter information into this entity if you wish to add or disable a reference designator on your revised component. and whether you wish to add or disable your reference designator. No elaborate Ids or system specific information is required. the organization in which it exists. if there is a new revised item revision. you must specify the change notice. the revised item number. the organization in which it exists. its effectivity date. 6-6 Oracle Manufacturing APIs and Open Interfaces Manual . the revised item number. To identify a reference designator. To identify a substitute component. and the name of the revision. You can enter information into this entity if you wish to add.Features ECO Revisions: The revisions entity is a direct child of the ECO header. Reference Designator: The reference designator entity is a direct child of the revised components entity. if there is a new revised item revision. the component item number. the substitute component number. It cannot exist without an ECO. To identify an ECO Revision. the organization which it exists. if you wish to revise the main bill or an alternate. To identify a revised item. the component item number. Substitute Component: The substitute components entity is a direct child of the revised components entity. and its operation sequence number. The information you need to pass to the ECO Business Object Interface is the same information you would need to convey to any other person about your ECO. if there is a new revised item revision. Revised Components: The revised components entity is a direct child of the revised items entity. To import data into the ECO Business Object Interface. To identify a revised component. you must specify the change notice. the organization in which it exists. if you wish to revised the main bill or an alternate. Revised Items: The revised items entity is also a direct child of the ECO header. You can enter information into this entity if you wish to add or disable a substitute component on your revised component. its effectivity date. It cannot exists without a revised component. and whether you wish to add or disable your substitute component. the revised item number.

regardless of the outcome of the transaction. In a nutshell. Engineering Change Order Business Object Interface 6-7 . Figure 6–3 Business Object APIs Business Object API Framework The below framework demonstrates how forms and business object interfaces can use the business object API framework simultaneously.Business Object APIs Business Object APIs The Business Object API framework is designed to provide flexible usage. and almost all calls that support PL/SQL calls to Oracle RDBMS. Business Object APIs can be called from Oracle Forms. The APIs encompass all the business rules required to process incoming data. they are the interface between the user and the database. They perform a complete transaction on a business object. but with a unified programming style. Business object interfaces. and always leave the database in a consistent state. PL/SQL programs. Web-based applications.

before moving onto to a sibling. 6-8 Oracle Manufacturing APIs and Open Interfaces Manual . -N/ASevere Error I Error -N/A- Step 4: Pick up highest level un-processed record The import program processes a parent and all its direct and indirect children. This information is stored in the database along with the record Initialize User_Id. Prog_Appid. So.· When there are no more records. Derive Organization_Id from Organization_Code Store ECO_Name and Organization_Id value in System_Information record. MDL_Item_Access and PLN_Item_Access respectively. the program exits and transfers control to the caller. We must ensure that all records in a business object belong to the same ECO. There may be more than one record for other entities. Login_Id. ENG: Model Item Access and ENG: Planning Item Access into STD_Item_Access. All records must have the same Change Notice and Organization values. the highest level parent must be chosen. Saves system-specific information in System_Information record since it is common to the whole business object.Business Object APIs Process Flow Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 1: Pass Business Object to Public API Purpose The program will try to import it. The highest level record with a {return status = NULL} is picked. Step 2: Check for Organization / Change Notice uniformity Step 3: Save system information Each instance of the business object represents a particular ECO. There should be only one Header record. business object Pull in values of profiles ENG: Standard Item Access. Quit importof Prog_Id in System_Information record. Description Caller must pass one business object at a time.

its entire lineage is error-ed out since members of the lineage are referencing an invalid parent. child records must reference valid parents. OR If there is no immediate parent record in the business object. based on Transaction_ Type and the following factors: Immediate parent being referenced exists in the database. for UPDATE and DELETE. It serves the following purposes: The user need not enter cryptic Ids If a user unique index could not be derived for a parent. Such an error in a record must cause all children to error out. Severe Error III Engineering Change Order Business Object Interface 6-9 . the indirect parent being referenced exists and is really the parent of the current record’s parent in the database. is truly the parent of this record in the database. For CREATE. the record must not already Severe Error III exist. For UPDATE and DELETE. Description Derive unique index columns from user-unique index columns.Business Object APIs Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 5: Convert user-unique index to unique index Purpose Unique index helps uniquely identify a record in the database. A valid parent is one that exists. Error Severe Error III Step 7: Check Lineage Perform lineage checks for entity records that do not belong to the top-most entity in the hierarchy. and may consist of more than one column. We must ensure that the linkage of records is correct in the business object. But a record being created must not. Step 6: Existence Verification The record being updated or deleted in the database must already exist. and. since they are referencing an invalid parent. That is. User-unique index is a user-friendly equivalent of the unique index. and is truly the current record’s parent in the database. the record must exist. Query up database record into the associated OLD record.

If not. Severe Error IV. Fatal Error III or Fatal Error II (depending on affected entity) A revised item and any of its components cannot be operated upon if the user does not have access to the revised item type. Derive Ids from user-friendly values CREATE: Severe Error IV. the operation cannot go through. The user must enter values for these fields. Other: Standard Error 6-10 Oracle Manufacturing APIs and Open Interfaces Manual . and set System_Information flags accordingly. and set System_Information flags accordingly. Check if System_Information record has this information. Fatal Error III or Fatal Error II (depending on affected entity) There are user-friendly value columns that derive certain Id columns. Compare revised item BOM_Item_Type against the revised item access fields in the System_Information record. An ECO and any of its constituents cannot be operated upon if the user does not have access to the Change Order type of that ECO. If not. compare Assembly_Type of Change Order Type against value of profile ENG: Engineering Item Change Order Access. find it in the database revised item record. Other: Standard Error Step 10: Required Fields checking Check that the required field columns are CREATE: not NULL. If not. Some fields are required for an operation to be performed. The value columns free up the user from having to enter cryptic Ids. Set System_Information flag accordingly. Without them. Fatal Error I Step 8(c): Check operability of parent items and current item (if applicable) Step 8(d): Check operability of parent items and current item (if applicable) Step 9: Value-Id conversions A revised item and any of its components cannot be operated upon if the revised item is implemented or canceled. find it in ECO Header record in database.Business Object APIs Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 8(a): Check ECO operability Purpose An ECO and its constituents cannot be operated upon if the ECO has already been implemented/canceled. Step 8(b): Check ECO operability Check if System_Information record has this information. since the Ids can be derived from them. If profile value is No. Description Error First check if System_Information record Fatal Error I has this information. then Assembly_ Type must not be Engineering. or if the ECO is in a workflow process (with Approval _Status = Approval Requested).

UPDATE: Standard Error For all NULL columns found in business object record. there is no OLD record. other columns in the same table. Standard Error Engineering Change Order Business Object Interface 6-11 . CREATE: Severe Error IV. So the program must default in individual attribute values.Business Object APIs Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 11: Attribute validation (CREATEs and UPDATEs) Step 12: Populate NULL columns(UP DATEs and DELETEs) Step 13: Default values for NULL attributes (CREATEs) Step 14: Check conditionally required attributes Step 15: Entity level defaulting Purpose Each of the attributes/fields must be checked individually for validity. Severe Error IV For all NULL columns in record. This feature enables the user to enter minimal information for the operation to go through. -N/A- For all NULL columns found in business object record. This feature enables the user to enter minimal information for the operation. checks against lookups etc. Check each attribute independently of the others Error CREATE: Severe Error IV. try to default in values. Defaulting for these columns happens here. For CREATEs. Values for all such columns are copied over from the OLD record. Severe Error IV Perform checks to confirm all conditionally required attributes are present. UPDATE: Set all MISSING column values to NULL. or by having the program assign values. either by retrieving them from the database. try to default in values based on other values. Some attributes are required based on certain external factors such as the Transaction_Type value. The user may send in a record with certain values set to NULL. Description Check that user-entered attributes are valid. independently of each other. etc. Certain column values may depend on profile options. copy over values from OLD record. Examples of these checks are: range checks. columns in other tables.

column. Step 17: Database writes Write record to database table. Perform database write: Insert record for CREATE Overwrite record for UPDATE and CANCEL Remove record for DELETE -N/ADescription Perform checks against record in the order specified in the -Purpose. Error CREATE: Severe Error IV. UPDATE: Standard Error 6-12 Oracle Manufacturing APIs and Open Interfaces Manual .Business Object APIs Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 16: Entity level validation Purpose This is where the whole record is checked. based on factors external to it. The following are checked: Non-updateable columns (UPDATEs): Certain columns must not be changed by the user when updating the record. Business logic: The record must comply with business logic rules. Cross-attribute checking: The validity of attributes may be checked.

conditionally required fields. but are not exposed to the user are called un-exposed columns. In the latter case. When no more records are found. Continue until all direct children have been processed. All columns that exist in the Production table. Once all the siblings have been processed. the program will move up to the parent (of this entire branch) and process all of its siblings (which will contains branches of their own). Go to Step 4. Pick up the first un-processed sibling record and Go to Step 5. A branch within the business object tree consists of all direct and indirect children. and are included in the data structures that the user passes the business object records in. or because no user-input is required. Go to Step 21. the siblings of the current record are processed. Step 18(b): Process siblings When an entire branch of a record has been processed. When no more records are found. These columns are not exposed either because they are not user-enterable. The sibling may also contain a branch. Description Pick up the first un-processed child record and Go to Step 5. the Engineering Change Order Business Object Interface 6-13 . These columns are called exposed columns. So the processing for the sibling will be exactly the same as the current record. Go up to parent and pick up the first un-processed sibling of the parent. Continue through the loop until all siblings have been processed.Entity Process Flows Table 6–2 Process Flow for Forms and Business Object Interfaces using the API Framework Simultaneously Step Step 18(a): Process direct and indirect children Purpose The program will finish processing an entire branch before moving on to a sibling branch. Continue through the loop until all siblings have been processed. There are also some other columns that are user-enterable for the import program. When there are no more records. Then pick up the first un-processed indirect child record and do the same as above. Go to Step 20. Go to Step 5. -N/A-N/AError -N/A- Step 18 (c): Process parent record’s siblings Entity Process Flows Exposed Columns and Un-exposed columns Each business object record that the user includes in the business object needs user-input for certain columns (required fields. user-unique index columns).

Each column can take in missing or null values. this will cause the record to error out. Data Entry Rules s Certain fields are REQUIRED fields. Defaulting only happens for columns with NULL values. it can also have the value CANCEL for the Revised Component entity only.99E125 Date : TO_DATE(‘1’. this field must have values (CREATE. Also. They cannot be derived or defaulted. Transaction_Type is always required. So the user must enter values for these fields.Entity Process Flows import program saves on processing. The following are the missing values for the different data types: s s s Varchar2 : chr(12) Int : 9. In addition. UPDATE. On the other hand.’j’) s s ECO Headers Columns Exposed to the User Table 6–3 Visible Columns Exposed Name ECO_Name Organization_Code Transaction_Type Change_Type_Code Status_Type ECO_Department_Name Actual Column Name Type Change_Notice Organization_Id -N/AChange_Order_Type Status_Type Responsible_ Organization_Id VARCHAR2(10) VARCHAR2(3) VARCHAR2(30) VARCHAR2(10) NUMBER VARCHAR2(3) Comments User-Unique Index User-Unique Index Required Required for Create 6-14 Oracle Manufacturing APIs and Open Interfaces Manual . unless the business logic explicitly requires specific defaulting. It specifies what operation is to be performed on a record. or DELETE). since user-input will require validation that the program can avoid by defaulting values into these columns by itself. When left empty (NULL). a column with a missing value is NULL-ed out.

Entity Process Flows Table 6–3 Visible Columns Exposed Name Priority_Code Approval_List_Name Approval_Status_Type Reason_Code ENG_Implementation_Cost Actual Column Name Type Priority_Code Approval_List_Name Approval_Status_ Type Reason_Code Estimated_ENG_Cost VARCHAR2(10) VARCHAR2(10) NUMBER VARCHAR2(10) NUMBER Comments MFG_Implementation_Cost Estimated_MFG_Cost NUMBER Cancellation_Comments Requestor Cancellation_ Comments Requestor_Id VARCHAR2(240) NUMBER Requestor = Employee Number Description Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Description -N/AAttribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 VARCHAR2(2000 ) VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Engineering Change Order Business Object Interface 6-15 .

Entity Process Flows Table 6–3 Visible Columns Exposed Name Attribute14 Attribute15 Actual Column Name Type Attribute14 Attribute15 VARCHAR2(150) VARCHAR2(150) Comments ECO Revisions Columns Exposed to the User Table 6–4 Visible Columns Name ECO_Name Organization_Code Revision New_Revision Transaction_Type Comments Return_Status Attribute_Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Actual Name Change_Notice Organization_Id Revision Revision -N/AComments -N/AType VARCHAR2(10) VARCHAR2(3) VARCHAR2(10) VARCHAR2(10) VARCHAR2(30) VARCHAR2(240) VARCHAR2(30) Comments User-Unique Index User-Unique Index User-Unique Index Allows updates to Revision Required Attribute_Category VARCHAR2(30) Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 6-16 Oracle Manufacturing APIs and Open Interfaces Manual .

Entity Process Flows Table 6–4 Visible Columns Name Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Actual Name Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Comments Revised Items Columns Exposed to the User Table 6–5 Visible Columns Name ECO_Name Organization_Code Revised_Item_Name New_Revised_Item_ Revision Updated_Revised_Item_ Revision Start_Effective_Date New_Effective_Date Assoc. Column Name Change_Notice Organization_Code Revised_Item_Id New_Item_Revision New_Item_Revision Type VARCHAR2(10) VARCHAR2(3) VARCHAR2(81) VARCHAR2(3) VARCHAR2(3) Comments User-Unique Index User-Unique Index User-Unique Index User-Unique Index Allows updates to New_Revised_ Item_Revision User-Unique Index Allows updates to Effectivity_ Date Required Scheduled_Date Scheduled_Date DATE DATE Transaction_Type Alternate_BOM_Code Status_Type MRP_Active -N/AAlternate_BOM_ Designator Status_Type MRP_Active VARCHAR2(30) VARCHAR2(10) NUMBER NUMBER 1/yes 2/no Engineering Change Order Business Object Interface 6-17 .

Column Name Early_Schedule_Date Use_Up_Item_Id Use_Up_Plan_Name Disposition_Type Update_WIP Cancel_Comments Change_Description Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type DATE VARCHAR2(81) VARCHAR2(10) NUMBER NUMBER VARCHAR2(240) VARCHAR2(240) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 1/yes 2/no Comments 6-18 Oracle Manufacturing APIs and Open Interfaces Manual .Entity Process Flows Table 6–5 Visible Columns Name Earliest_Effective_Date Use_Up_Item_Name Use_Up_Plan_Name Disposition_Type Update_WIP Cancel_Comments Descriptive_Text Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Assoc.

its revision is overwritten by the new value. updates to it have to be made by entering the new revision into Updated_Revised_Item_Revision. All Effective Date changes will be recorded in the history table ENG_Current_Start_Effective_Dates.Entity Process Flows Notes: The New_Revised_Item_Revision is not updateable for revised items since it is part of the unique key which uniquely identifies a record. After the record is retrieved using the unique key. Revised item revisions go into MTL_ITEM_REVISIONS. : s Just like New_Revised_Item_Revision. Any subsequent revisions are added to or updated in MTL_ITEM_ REVISIONS. s s Revised Components Columns Exposed to the User Table 6–6 Visible Columns Name ECO_Name Organization_Code Revised_Item_Name New_Revised_Item_ Revision Start_Effective_Date Associated Column Name ECO_Name Organization_Id Revised_Item_Id New_Item_Revision Effectivity_Date Type VARCHAR2(10) VARCHAR2(3) VARCHAR2(81) VARCHAR2(3) DATE Comments User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index Engineering Change Order Business Object Interface 6-19 . So. The user can reschedule a revised item by entering the new Effective Date in New_Effective_Date. When an item is first defined through the Define Item form. along with requestor_id and comments. Start_Effective_Date is a unique index column. So changes to it have to be made by entering the new value into New_ Effective_Date. a starting revision record is written out to this table.

Entity Process Flows Table 6–6 Visible Columns Name Operation_Sequence_ Number Component_Item_Name Alternate_BOM_Code Transaction_Type ACD_Type Associated Column Name Operation_Seq_Num Component_Item_Id Alternate_BOM_ Designator -N/AACD_Type Type NUMBER VARCHAR2(81) VARCHAR2(10) VARCHAR2(30) NUMBER Comments User-Unique Index User-Unique Index User-Unique Index Required Required. 1/add 2/change 3/disable Old_Effectivity_Date Old_Operation_ Sequence_Number New_Operation_ Sequence_Number Item_Sequence_Number Quantity_Per_Assembly Planning_Percent Projected_Yield Include_In_Cost_Rollup WIP_Supply_Type Supply_Subinventory Locator_Name SO_Basis Optional Mutually_Exclusive Check_ATP Minimum_Allowed_ Quantity Effectivity_Date Operation_Seq_Num Operation_Seq_Num DATE NUMBER NUMBER Allows updates to Operation_ Seq_Num Item_Num Component_Quantity Planning_Factor NUMBER NUMBER NUMBER Component_Yield_Factor NUMBER Include_In_Cost_Rollup WIP_Supply_Type Supply_Subinventory Locator_Id SO_Basis Optional Mutually_Exclusive_ Options Check_ATP Low_Quantity NUMBER NUMBER VARCHAR2(10) VARCHAR2(81) NUMBER NUMBER NUMBER NUMBER NUMBER 1/yes 2/no 1/yes 2/no 1/yes 2/no 1/yes 2/no 1/yes 2/no 6-20 Oracle Manufacturing APIs and Open Interfaces Manual .

Entity Process Flows Table 6–6 Visible Columns Name Maximum_Allowed_ Quantity Shipping_Allowed Required_To_Ship Required_For_Revenue Include_On_Ship_Docs Comments Quantity_Related Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Associated Column Name High_Quantity Shipping_Allowed Required_To_Ship Required_For_Revenue Include_On_Ship_Docs Component_Remarks Quantity_Related -N/AAttribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type NUMBER NUMBER NUMBER NUMBER NUMBER VARCHAR2(240) NUMBER VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) 1/yes 2/no 1/yes 2/no 1/yes 2/no 1/yes 2/no 1/yes 2/no Comments Engineering Change Order Business Object Interface 6-21 .

So Effectivity Date changes have to made using the parent revised item’s New_Effective_Date column. Adding a component to a bill-less revised item causes a new primary bill to be created.Entity Process Flows Notes: The ECO Header unique key is part of the revised item unique key. Users can cancel Revised Components by entering a Transaction_Type value of CANCEL. There are no APIs to validate flexfields. that revised item Effectivity Date changes will be propagated to all un-implemented child revised components. and New_Operation_Sequence_Number will be null. consequently. Operation_Sequence_ Number identifies the current un-implemented record. Item locators cannot be created dynamically. For ACD_Type = (‘Change’ or ‘Disable’). Reference Designators Columns Exposed to the User Table 6–7 Visible Columns Name ECO_Name Organization_Code Associated Column Name ECO_Name Organization_Code Type VARCHAR2(10) VARCHAR2(3) Comments User-Unique Index User-Unique Index 6-22 Oracle Manufacturing APIs and Open Interfaces Manual . So confirming the revised item confirms the revised item-ECO Header link. the Header’s link to all other entity records. Please note however. Old_Operation_Sequence_Number identifies the implemented record being changed or disabled. and. Old_Operation_Sequence_Number will equal Operation_Sequence_Number. For acd_type = ‘Add’. New_Operation_Sequence_ Number allows user-updates to Operation_Sequence_Number. : Start_Effectivity_Date is not updateable.

Entity Process Flows Table 6–7 Visible Columns Name Revised_Item_Name Start_Effective_Date New_Revised_Item_ Revision Operation_Sequence_ Number Alternate_BOM_Code Component_Item_Name Reference_Designator_ Name ACD_Type Transaction_Type Associated Column Name Revised_Item_Id Effectivity_Date New_Item_Revision Operation_Seq_Num Alternate_BOM_ Designator Component_Item_Id Type VARCHAR2(81) VARCHAR2(3) DATE NUMBER VARCHAR2(10) VARCHAR2(81) Comments User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index Required Component_Reference_ VARCHAR2(15) Designator ACD_Type -N/ANUMBER VARCHAR2(30) VARCHAR2(240) VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Ref_Designator_Comment Ref_Designator_ Comment Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 -N/AAttribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Engineering Change Order Business Object Interface 6-23 .

Entity Process Flows Table 6–7 Visible Columns Name Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Associated Column Name Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Comments Substitute Components Columns Exposed to the User Table 6–8 Visible Columns Name ECO_Name Organization_Code Revised_Item_Name Start_Effective_Date New_Revised_Item_ Revision Operation_Sequence_ Number Alternate_BOM_Code Component_Item_Name Substitute_Component_ Name Name Change_Notice Organization_Id Revised_Item_Id Effectivity_Date New_Item_Revision Operation_Seq_Num Alternate_BOM_ Designator Component_Item_Id Substitute_ Component_Id Type VARCHAR2(10) VARCHAR2(3) VARCHAR2(81) VARCHAR2(3) DATE NUMBER VARCHAR2(10) VARCHAR2(81) VARCHAR2(81) Comments User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index User-Unique Index 6-24 Oracle Manufacturing APIs and Open Interfaces Manual .

Engineering Change Order Business Object Interface 6-25 .Entity Process Flows Table 6–8 Visible Columns Name ACD_Type Transaction_Type Substitute_Item_Quantity Return_Status Attribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Name ACD_Type -N/A Substitute_Item_ Quantity -N/AAttribute Category Attribute1 Attribute2 Attribute3 Attribute4 Attribute5 Attribute6 Attribute7 Attribute8 Attribute9 Attribute10 Attribute11 Attribute12 Attribute13 Attribute14 Attribute15 Type NUMBER VARCHAR2(30) NUMBER VARCHAR2(1) VARCHAR2(30) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) VARCHAR2(150) Comments User-Unique Index Required New API Packages The ECO Business object interface program will contain new Business Object API packages. Please see the Business Object Framework section for the flow of control in these packages.

ENG_EcoRevision_UTIL: This package contains entity utility functions and procedures for the ECO Revision. ENG_Default_EcoRevision: This package contains default attribute procedures for the ECO Revision. This package contains all attribute-level validation logic.Entity Process Flows Main Packages s ENG_Eco_PUB : This is the public PL/SQL package that is to be programmatically called to launch the import. s s s Entity Packages s ENG_Validate_Eco: This package contains Attribute and Entity level validation for the ECO Header. This package is responsible for logging error messages and erroring out records. s Shared Packages s ENG_Globals : This Global package contains all global structure and variable definitions. This package contains all Value-Id conversions. as well as commonly used procedures and functions. ENG_Value_to_ID : This is the shared Value-Id conversion package. s s s s s s 6-26 Oracle Manufacturing APIs and Open Interfaces Manual . ENG_Validate_RevisedItem: This package contains Attribute and Entity level validation for the Revised Item. ENG_Default_Eco: This package contains default attribute procedures for the ECO Header. It performs all the business logic by calling the Entity and Shared packages as and when required. ENG_Validate_EcoRevision: This package contains Attribute and Entity level validation for the ECO Revision. Error_Handler : This is the shared error handling package. This package ensures that all records belong to the same business object before it lets the business object through to the Private package. ENG_Eco_Util: This package contains entity utility functions and procedures for the ECO Header. ENG_Eco_PVT : This is the private PL/SQL package. ENG_Validate : This is a shared validation package.

BOM_SubstituteComp_UTIL: This package contains entity utility functions and procedures for the Substitute Component. ENG_RevisedItem_UTIL: This package contains entity utility functions and procedures for the Revised Item. s s s s s s s s s s Commits and Rollbacks None of the ECO business object APIs issue commits or rollbacks.Entity Process Flows s ENG_Default_RevisedItem: This package contains default attribute procedures for the Revised Item. This ensures that parts of the transaction are not left in the database. Therefore. BOM_Validate_SubstituteComp: This package contains Attribute and Entity level validation for the Substitute Component. It is the responsibility of the calling code to issue them. or it has been successfully processed. BOM_Validate_RevisedComp: This package contains Attribute and Entity level validation for the Revised Component. This gives callers the flexibility to issue commits and rollbacks where they decide. BOM_Validate_ReferenceDesig: This package contains Attribute and Entity level validation for the Reference Designator. the whole transaction is rolled back. The caller could use this to perform further activities by building on top of the APIs. Engineering Change Order Business Object Interface 6-27 . BOM_Default_ReferenceDesig: This package contains default attribute procedures for the Reference Designator. BOM_Default_RevisedComp: This package contains default attribute procedures for the Revised Component. The APIs pass back to the caller. BOM_RevisedComp_UTIL: This package contains entity utility functions and procedures for the RevisedComponent. If an error occurs. API work is either all completed or none of the work is done. the state of the business object. BOM_Default_SubstituteComp: This package contains default attribute procedures for the Substitute Component. BOM_ReferenceDesig_UTIL: This package contains entity utility functions and procedures for the Reference Designator. whether there has been an error.

during operation. Review all relevant information after the Public API has completed. user_id is the FND User Id of the person launching this program. 3. 3. This procedure initializes the global security context for each database session. The user must call it programmatically. 2. while sending in one business object at a time. 2. The program will retrieve system information from these variables. The user must provide this information to the import program by initializing certain variables. resp id is the FND Responsibility Id the person is using. Call the Public API. Step2: Call the Public API The Public API is the user’s interface to the Import program. 4. security_group_id IN NUMBER DEFAULT 0 ) Pointers: 1. 6. resp_id IN NUMBER . resp_appl_id is the Application Responsibility Id. Initialize the system information. resp_appl_id IN NUMBER . such as who is trying to update the current record. To initialize the variables. security_group_id is the FND Security Group Id. The Public API 6-28 Oracle Manufacturing APIs and Open Interfaces Manual . Step1: Initialize the system information Each database table that the program writes to requires system information. the user must call the following procedure: FND_GLOBAL.Entity Process Flows Launching the Import The Three Step Rule: To use the business object APIs effectively. This initialization should be done when the session is established outside of a normal forms or concurrent program connection. the user must follow the three step rule: 1. 5.apps_initialize ( user_id IN NUMBER .

p_revised_item_tbl ITEM_TBL . x_msg_count . x_return_status . p_rev_component_tbl COMPONENT_TBL . p_sub_component_tbl COMPONENT_TBL .Entity Process Flows returns the processed business object. p_init_msg_list . p_ref_designator_tbl DESIGNATOR_TBL . x_revised_item_tbl .G_FALSE OUT VARCHAR2 OUT NUMBER OUT VARCHAR2 IN Eco_Rec_Type := G_MISS_ECO_REC . The following is a description of these parameters : Engineering Change Order Business Object Interface 6-29 . x_ref_designator_tbl . p_eco_revision_tbl REVISION_TBL . All OUT parameters begin with x_. The procedure to call is Process_Eco. and the following is its specification : PROCEDURE Process_Eco ( p_api_version_number . and a count of all associated error and warning messages. the business object status. p_ECO_rec IN NUMBER IN VARCHAR2 := FND_API. x_rev_component_tbl . all IN parameters begin with p_. x_eco_revision_tbl . x_sub_component_tbl ) IN Eco_Revision_Tbl_Type := G_MISS_ECO_ IN Revised_Item_Tbl_Type := G_MISS_REVISED_ IN Rev_Component_Tbl_Type := G_MISS_REV_ IN Ref_Designator_Tbl_Type := G_MISS_REF_ IN Sub_Component_Tbl_Type := G_MISS_SUB_ OUT Eco_Rec_Type OUT Eco_Revision_Tbl_Type OUT Revised_Item_Tbl_Type OUT Rev_Component_Tbl_Type OUT Ref_Designator_Tbl_Type OUT Sub_Component_Tbl_Type As is obvious from the above specification. x_ECO_rec . x_msg_data .

x_sub_component_tbl : This is the set of data structures that represents the outgoing business object. p_eco_revision_tbl. if set to TRUE. x_eco_revision_tbl. if the business object import has been successful. The following is a list of all the possible business object states: x_msg_count : This holds the number of messages in the API message stack after the import. p_eco_rec. The caller may look up this flag to choose an appropriate course of action (commit. All the other data structures are PL/SQL tables of records that hold records for each of the other entities. If there has been an error in a record. p_sub_component_tbl : This is the set of data structures that represents the incoming business object.1 of the Business Object Coding Standards document for a detailed description of this parameter. p_rev_component_tbl. These records essentially constitute the whole business object as it was sent in. s s 6-30 Oracle Manufacturing APIs and Open Interfaces Manual . x_ref_ designator_tbl. s s Please note that any of these data structures may be sent in empty (set to NULL) to indicate that there are no instances of that entity in the business object being sent in.Entity Process Flows s p_api_version_number : This parameter is required. x_return_status : This is a flag that indicates the state of the whole business object after the import. All the other data structures are PL/SQL tables of records that hold records for each of the other entities. the caller may set this to FALSE (or accept the default value) in order to do the initialization itself by calling FND_MSG_PUB. x_revised_item_tbl. or subjected to further processing by the caller. p_init_msg_list : This parameter. this flag will carry a status to indicate that. See section 4. s x_eco_rec.Initialize. p_revised_item_tbl. this status will indicate the fact that there has been an error in the business object. It is used by the API to compare the version numbers of incoming calls to its current version number. or further processing by the caller). All these data structures directly correspond to the entities shown in the ECO entity diagram. and return an unexpected error if they are incompatible. allows callers to request that the API do the initialization of the message list on their behalf. except now it has all the changes that the import program made to it through all the steps in the Process Flow. Similarly. rollback. x_eco_rec is a record that holds the ECO header for the ECO. x_rev_component_tbl. On the other hand. p_eco_rec is a record that holds the ECO header for the ECO. This parameter returns a 0 when there are no messages to return. These records can be committed. p_ ref_designator_tbl. rolled back. All these data structures directly correspond to the entities shown in the ECO entity diagram.

This parameter returns NULL when there is more than one message. Step 3: Review all relevant information after the Public API has completed The user must look up: s all error status that the Public API returns. it will not be picked up for processing. The user must remember to NULL out this field when sending in a record. Please see the Sample Shell section in the Appendix for a complete listing of the shell that was written to test the import program. as well as the individual record statuses. 2.Error_Tbl_Type). Retrieving the entire message list: The following procedure will return the entire message list to the user PROCEDURE Get_Message_List ( x_message_list OUT Eng_Eco_Pub. the overall business object error status. Note : A record must have an error status of NULL for it to be processed. 3. If it has any other value. As mentioned above. or some other API which serves to extend the functionality of the import program. a shell. This shell illustrates the correct usage of the import program.Entity Process Flows s x_msg_data : This returns a single message when the message count is 1. The caller here may be a form. all error and warning messages in the API message list. all record attributes to see what changes occurred after applying business logic to these records. s s The user can access the API message list using the following procedures and functions in the Error_Handler package: 1. the Public API must be called programmatically. Engineering Change Order Business Object Interface 6-31 . Go to the start of the list: The following procedure reset the message index to the start of the list so the user can start reading from the start of the list PROCEDURE Reset. Initializing the message list: The following procedure clears the message list and initializes all associated variables PROCEDURE Initialize. The purpose of this parameter is to save the caller the extra effort of retrieving a lone message from the message list. including.

7. SC (Substitute Component). 5. IN VARCHAR2 OUT Eng_Eco_Pub. then the message index will be reset to the beginning of the list. RI (Revised Item). RC (Revised Component). at a specific array index in that entity table.Error_Tbl_Type Retrieving a specific message: Another implementation of procedure Get_ Entity_Message will return the message pertaining to a particular entity (p_ entity_id). The entity is denoted by the symbols ECO (ECO Header). SC 6-32 Oracle Manufacturing APIs and Open Interfaces Manual . 6. RC (Revised Component). PROCEDURE Get_Entity_Message ( p_entity_id . RD (Reference Designator). OUT VARCHAR2 OUT NUMBER OUT VARCHAR2 Deleting a specific message: Procedure Delete_Message enables the user to delete a specific message at a specified entity index (p_entity_index) within the PL/SQL table of a specified entity (p_entity_id). x_entity_id ). The entity is denoted by the symbols ECO (ECO Header). If the user tries to retrieve beyond the size of the message list. IN VARCHAR2 IN NUMBER OUT VARCHAR2 Retrieving the current message: Procedure Get_Message will return the message at the current message index and will advance the pointer to the next index. PROCEDURE Get_Entity_Message ( p_entity_id . x_message_text ). RI (Revised Item). RI (Revised Item). x_entity_index . Retrieving messages by entity: One implementation of procedure Get_Entity_ Message will return all messages pertaining to a particular entity (p_entity_id). SC (Substitute Component). RD (Reference Designator). p_entity_index . The entity index (p_ entity_index) is the index in the entity array. RC (Revised Component). denoted by the symbols ECO (ECO Header). PROCEDURE Get_Message ( x_message_text . x_message_list ).Entity Process Flows 4.

RD (Reference Designator). Set business object status to ‘S’.e. PROCEDURE Delete_Message ( p_entity_id . The entity index (p_entity_ index) is the index in the entity array. all records in an ECO business object instance must reference the same ECO.ENG_ECO_PUB This package is like a gatekeeper. 10. Dumping the message list: The following message generates a dump of the message list using dbms_output PROCEDURE Dump_Message_List. So. i.Entity Process Flows (Substitute Component). IN VARCHAR2 IN NUMBER Deleting all messages for a certain entity: Another implementation of procedure Delete_Message lets the user delete all messages for a particular entity (p_ entity_id). 2. The business object here is the ECO. SC (Substitute Component). Package Interaction The Public Package . p_entity_index ). Check that all records in the business object belong to the same Bill. all records must have the same Assembly Item Name and Organization_Code combination Engineering Change Order Business Object Interface 6-33 . 8. This essentially means that all records in the business object must belong to the business object. letting only one business object through at a time. Main Procedure: Process_ECO 1. RD (Reference Designator). PROCEDURE Delete_Message ( p_entity_id 9. RI (Revised Item).. IN VARCHAR2 ). The entity is denoted by the symbols ECO (ECO Header). and incoming records together make up an instance of the business object. RC (Revised Component). Get a count of all messages: The following functions returns the total number of messages currently in the message list FUNCTION Get_Message_Count RETURN NUMBER.

3. Also pass the Assembly Item Name and Organization_Id to Private API. Any records Severe have Error I mismatched ECO_Name and Organization _Code values Derive Organization_Id from Organization_Code and copy this value into all business object records.Entity Process Flows Table 6–9 Errors Description If there is an ECO Header in the business object. Table 6–10 Column Organization_Id Unexpected Error Other Message: ENG_UNEXP_ORG_INVALID: This record was not processed since an unexpected error while performing a value to id conversion for organization code. If the business object does not have an ECO Header record. Please check your records for this. Cause of Failure Error Message ENG_MUST_BE_IN_SAME_ ECO:All records in a business object must belong to the same ECO. That is. Accept processed business object and return status from Private API after the import. 5. to identify this business object instance. they must all have the same ECO Name and organization. check that all records have the same ECO_name and Organization_Code values as the Header. 6-34 Oracle Manufacturing APIs and Open Interfaces Manual . 4. Errors Description Derive using Organization_ Code from table MTL_ PARAMTERS Error Severe Error I Message ENG_ORG_ INVALID:The Organization <org_id> you entered is invalid. and pass it back to the calling program. Pass business object into Private API if the business object status is still ‘S’. check that all records have the same ECO_Name and Organization_Code combination as the first highest level entity record picked up.

Login_Id. The entity procedure descriptions below also point out how the Private API reacts to errors in entity process flow steps. Ref_Desgs. call ECO_Header If BOM Revisions records exist. Main Procedure: Process_ECO 1. Each of these entity procedures performs all the entity process flow steps listed by entity under the Entity Process Details section. Engineering Change Order Business Object Interface 6-35 . It carries out all the business object checks listed in the Process Flow. call ECO_Rev Call Rev_Comps to process immediate-parentless components Call Ref_Desgs to process immediate-parentless reference designators Call Sub_Comps to process immediate-parentless substitute components Return import status and processed business object to Public API The sections below list the steps performed within each of the entity procedures: ECO_Header. 8. Initialize User_Id. Table 6–11 Column Descriptions Column User_Id Login_Id Prog_AppId Prog_Id 2. Description From environment From environment From environment From environment Initialize Assembly_Item_Name and Org_Id in System_Information record from values passed by Public API. Rev_Comps.Entity Process Flows The Private Package .ENG_BO_PVT This package is called by the Public package. and also performs production tables inserts. 4. If an BOM Header was passed in. 6. Sub_Comps. updates and deletes. 7. 3. They also call other entity procedures to process child records. Prog_Id in System_Information record. Prog_AppId. It then passes the business object and the business object import status back to the Public API. 5. while making any necessary changes to it. ECO_Rev.

Eng_Eco_Pub. Eng_Eco_Pub. he/she specifies a TEST TAG (p_test_tag). Eng_Eco_Pub. It uses interface table ENG_ENG_CHANGES_ INTERFACE.Error_Tbl_Type. /********************************************************************************************** ************************************** This package calls the Public API. BM_REF_DESGS_ INTERFACE and BOM_SUB_COMPS_INTERFACE. NUMBER. BOM_INVENTORY_COMPS_INTERFACE. VARCHAR2(1). This program picks up all records that carry this test tag value as one business object.Rev_Component_Tbl_Type. Eng_Eco_Pub. its purpose here is to illustrate how the user might call the Public API. *********************************************************************************************** ***************************************/ CREATE OR REPLACE PROCEDURE Public_API_UT ( p_test_tag IN VARCHAR2 ) IS l_eco_rec Eng_Eco_Pub. VARCHAR2(2000). ENG_REVISED_ITEMS_ INTERFACE. ENG_ECO_REVISIONS_INTERFACE. l_eco_revision_tbl l_revised_item_tbl l_rev_component_tbl l_sub_component_tbl l_ref_designator_tbl l_return_status l_msg_count l_msg_data l_Error_Table 6-36 Oracle Manufacturing APIs and Open Interfaces Manual . Each record will have a TEST TAG which identifies the whole business object uniquely to the user. Eng_Eco_Pub.Revised_Item_Tbl_Type. and then runs this program. and then tries to import it into the production tables. Eng_Eco_Pub. When the user runs this program.Eco_Rec_Type.Sub_Component_Tbl_Type.Entity Process Flows Sample Launch Package The following is the PL/SQL program that was coded to test the APIs.Ref_Designator_Tbl_Type. The way it works is that it assumes that user has loaded these tables with business object records.Eco_Revision_Tbl_Type.

Engineering Change Order Business Object Interface 6-37 . number. CURSOR c_eco_rec IS SELECT * FROM eng_eng_changes_interface WHERE eng_changes_ifce_key like p_test_tag. CURSOR c_rev_comps IS SELECT * FROM bom_inventory_comps_interface WHERE bom_inventory_comps_ifce_key like p_test_tag.Query all the records and call the Private API. CURSOR c_sub_comps IS SELECT * FROM bom_sub_comps_interface WHERE bom_sub_comps_ifce_key like p_test_tag. CURSOR c_ref_desgs IS SELECT * FROM bom_ref_desgs_interface WHERE bom_ref_desgs_ifce_key like p_test_tag. i BEGIN -. CURSOR c_rev_items IS SELECT * FROM eng_revised_items_interface WHERE eng_revised_items_ifce_key like p_test_tag. CURSOR c_eco_rev IS SELECT * FROM eng_eco_revisions_interface WHERE eng_eco_revisions_ifce_key like p_test_tag.Entity Process Flows l_Message_text VARCHAR2(2000).

responsible_org_code. l_eco_rec. l_eco_rec. END LOOP.priority_code := eco_rec.eng_implementation_cost := eco_rec.reason_code.change_notice. l_eco_rec.status_type. l_eco_rec.transaction_type := eco_rec. l_eco_revision_tbl(i).eco_name := rev.eco_department_name := eco_rec. l_eco_rec. l_eco_revision_tbl(i).approval_status_type.Entity Process Flows FOR eco_rec IN c_eco_rec LOOP l_eco_rec. l_eco_rec.requestor.change_type_code := eco_rec.revision. l_eco_revision_tbl(i).cancellation_comments:=eco_rec. l_eco_rec.approval_list_name.transaction_type. -.transaction_type. l_eco_revision_tbl(i). l_eco_rec.eco_name := eco_rec.change_order_type. 6-38 Oracle Manufacturing APIs and Open Interfaces Manual .status_type := eco_rec. l_eco_rec.Fetch ECO Revisions i := 1.requestor := eco_rec.organization_code := eco_rec.description := eco_rec.description. l_eco_rec.estimated_eng_cost.approval_status_type := eco_rec.organization_code. FOR rev IN c_eco_rev LOOP l_eco_revision_tbl(i). l_eco_revision_tbl(i).estimated_mfg_cost. l_eco_rec.transaction_type := rev.mfg_implementation_cost := eco_rec. l_eco_rec.approval_list_name := eco_rec.change_notice. l_eco_rec.reason_code := eco_rec.revision := rev.organization_code:= rev.cancellation_comments.organization_code.new_revision.comments.new_revision := rev.comments := rev. l_eco_rec.priority_code.

END IF.scheduled_date.revised_item_name := ri.start_effective_date := ri.organization_code := ri.use_up_plan_name := ri.new_revised_item_revision := NULL.new_item_revision. l_revised_item_tbl(i).disposition_type.use_up_item_name := ri.early_schedule_date.revised_item_number. l_revised_item_tbl(i).alternate_bom_code := ri.use_up_item_number.change_notice.new_revised_item_revision := ri. IF ri. l_revised_item_tbl(i).use_up_plan_name. l_revised_item_tbl(i).organization_code.earliest_effective_date := ri.new_item_revision = FND_API. ELSE l_revised_item_tbl(i). -. END LOOP.mrp_active. l_revised_item_tbl(i).Entity Process Flows i := i + 1.status_type. l_revised_item_tbl(i). l_revised_item_tbl(i).eco_name := ri.status_type := ri. Engineering Change Order Business Object Interface 6-39 .disposition_type := ri.alternate_bom_designator.G_MISS_CHAR THEN l_revised_item_tbl(i).mrp_active := ri. l_revised_item_tbl(i). l_revised_item_tbl(i).Fetch revised items i := 1. l_revised_item_tbl(i). FOR ri IN c_rev_items LOOP l_revised_item_tbl(i).

cancel_comments := ri.update_wip.start_effective_date := rc.transaction_type := ri.disable_date. END LOOP.organization_code:= rc.descriptive_text. l_rev_component_tbl(i). l_rev_component_tbl(i).Fetch revised components i := 1. l_rev_component_tbl(i).old_effectivity_date := rc. -.operation_sequence_number := rc. l_rev_component_tbl(i).new_revised_item_revision := NULL.alternate_bom_designator. l_rev_component_tbl(i).transaction_type.alternate_bom_code := rc. l_rev_component_tbl(i).Entity Process Flows l_revised_item_tbl(i).operation_seq_num. FOR rc IN c_rev_comps LOOP l_rev_component_tbl(i). l_rev_component_tbl(i).change_notice. l_rev_component_tbl(i). l_revised_item_tbl(i). l_rev_component_tbl(i). l_rev_component_tbl(i).update_wip := ri.revised_item_name := rc.effectivity_date.organization_code.change_description := ri. l_revised_item_tbl(i).old_effectivity_date.assembly_item_number.component_item_number.eco_name := rc.cancel_comments. i := i + 1.acd_type.old_operation_sequence_number := 6-40 Oracle Manufacturing APIs and Open Interfaces Manual .disable_date := rc. l_rev_component_tbl(i).acd_type := rc. l_revised_item_tbl(i).component_item_name := rc.

required_to_ship. l_rev_component_tbl(i). l_rev_component_tbl(i).item_sequence_number := rc.old_operation_seq_num.planning_factor.planning_percent := rc.required_for_revenue := rc.include_in_cost_rollup.so_basis := rc.component_yield_factor. l_rev_component_tbl(i).Entity Process Flows rc.location_name := rc. l_rev_component_tbl(i). l_rev_component_tbl(i).quantity_related := rc. Engineering Change Order Business Object Interface 6-41 . l_rev_component_tbl(i).mutually_exclusive := rc.quantity_per_assembly := rc. l_rev_component_tbl(i).projected_yield := rc.include_in_cost_rollup := rc.location_name.optional. l_rev_component_tbl(i). l_rev_component_tbl(i).quantity_related.required_to_ship := rc. l_rev_component_tbl(i).supply_subinventory.optional := rc.wip_supply_type. l_rev_component_tbl(i).check_atp.supply_subinventory := rc.check_atp := rc.wip_supply_type := rc.mutually_exclusive_options. l_rev_component_tbl(i). l_rev_component_tbl(i). l_rev_component_tbl(i). l_rev_component_tbl(i).item_num.minimum_allowed_quantity := rc. l_rev_component_tbl(i). l_rev_component_tbl(i).component_quantity.shipping_allowed.so_basis.include_on_ship_docs := rc. l_rev_component_tbl(i).required_for_revenue.low_quantity.include_on_ship_docs.shipping_allowed := rc.

l_sub_component_tbl(i). l_sub_component_tbl(i). l_sub_component_tbl(i). 6-42 Oracle Manufacturing APIs and Open Interfaces Manual .alternate_bom_code := sc. l_rev_component_tbl(i).eco_name := sc.operation_seq_num. l_sub_component_tbl(i).organization_code. l_sub_component_tbl(i).assembly_item_number.start_effective_date := sc. END LOOP.new_revised_item_revision := NULL.Entity Process Flows l_rev_component_tbl(i). l_rev_component_tbl(i).change_notice.acd_type := sc. l_sub_component_tbl(i).organization_code:= sc.component_remarks := rc.component_remarks.substitute_component_name := sc. -.transaction_type := rc.component_item_name := sc.substitute_comp_number.operation_sequence_number := sc. l_sub_component_tbl(i).Fetch substitute component records i := 1.alternate_bom_designator.component_item_number.revised_item_name := sc.acd_type. l_sub_component_tbl(i).effectivity_date.transaction_type. l_sub_component_tbl(i).high_quantity. i := i + 1. FOR sc IN c_sub_comps LOOP l_sub_component_tbl(i).maximum_allowed_quantity := rc.

-.organization_code.acd_type := rd.transaction_type.acd_type.assembly_item_number.Fetch reference designators i := 1. l_ref_designator_tbl(i). l_ref_designator_tbl(i).ref_designator_comment.component_reference_designator.substitute_item_quantity := sc. l_sub_component_tbl(i).operation_seq_num.start_effective_date := rd. END LOOP.ref_designator_comment := rd.alternate_bom_designator.component_item_number.component_item_name := rd.operation_sequence_number := rd.transaction_type := sc. l_ref_designator_tbl(i). l_ref_designator_tbl(i). l_ref_designator_tbl(i). l_ref_designator_tbl(i).alternate_bom_code := rd.organization_code := rd. i := i + 1.effectivity_date. l_ref_designator_tbl(i). Engineering Change Order Business Object Interface 6-43 . l_ref_designator_tbl(i). FOR rd IN c_ref_desgs LOOP l_ref_designator_tbl(i).eco_name := rd.reference_designator_name := rd.substitute_item_quantity.change_notice.Entity Process Flows l_sub_component_tbl(i).new_revised_item_revision := null.revised_item_name := rd. l_ref_designator_tbl(i). l_ref_designator_tbl(i).

org_id := 207. x_msg_count .login_id := 2462.transaction_type. fnd_global. p_ref_designator_tbl => 1. ENG_GLOBALS.user_id := 2462.prog_id:= NULL.Process_Eco ( p_api_version_number .system_information.new_reference_designator := rd.Entity Process Flows l_ref_designator_tbl(i).req_id := NULL. Eng_Globals.G_WHO_REC. Eng_Globals.G_WHO_REC.Call the private API Eng_Eco_PUB.G_WHO_REC. p_eco_revision_tbl . Eng_Globals.G_WHO_REC. END LOOP.0 => l_return_status => l_msg_count => l_eco_rec => l_eco_revision_tbl => l_revised_item_tbl => l_rev_component_tbl => l_sub_component_tbl => l_ref_designator_tbl 6-44 Oracle Manufacturing APIs and Open Interfaces Manual .G_WHO_REC.new_designator. p_eco_rec .prog_appid := 703. resp_id => Eng_Globals.G_WHO_REC.G_WHO_REC.transaction_type := rd.org_id := 207. -. p_sub_component_tbl . resp_appl_id => Eng_Globals.user_id => 20567 . Eng_Globals. Eng_Globals.apps_initialize ( user_id . l_ref_designator_tbl(i).G_WHO_REC.prog_appid ). p_rev_component_tbl . Eng_Globals. p_revised_item_tbl . x_return_status .

x_rev_component_tbl . END LOOP.put_line(’Mesg: ’||l_error_table(i). Error_Handler.Get_Message_List( x_message_list => l_error_table).Perform all the error handler operations to verify that the -. x_revised_item_tbl => l_eco_rec => l_eco_revision_tbl => l_revised_item_tbl => l_rev_component_tbl => l_sub_component_tbl => l_ref_designator_tbl .COUNT LOOP dbms_output.message_text).put_line(’Index: ’||l_error_table(i).Dump_Message_List.Get_Entity_Message ( p_entity_id . x_message_list => ’ECO’ => l_error_table Engineering Change Order Business Object Interface 6-45 .entity_id). dbms_output.function provided to the user work correctly.l_error_table.error or warning are displayed and all the error table interface -. dbms_output.put_line(’Message Count Function: ’||to_char(l_msg_count)). dbms_output. dbms_output. x_ref_designator_tbl ).put_line(’Total Messages: ’ || to_char(i)).entity_index).On return from the PUB API -. -- -. FOR i IN 1. dbms_output. x_sub_component_tbl . Error_Handler. l_msg_count := Error_Handler.Entity Process Flows . x_eco_rec .. -Error_Handler.put_line(’---------------------------------------’). x_eco_revision_tbl .Get_Message_Count.put_line(’Entity Id: ’||l_error_table(i).

x_message_list ). x_message_list ). Error_Handler. x_message_list ). x_message_list ). Error_Handler. 6-46 Oracle Manufacturing APIs and Open Interfaces Manual . Error_Handler. => ’RD’ => l_error_table => ’SC’ => l_error_table => ’RC’ => l_error_table => ’RI’ => l_error_table => ’REV’ => l_error_table END Public_API_UT.Entity Process Flows ).Get_Entity_Message ( p_entity_id . Error_Handler. Error_Handler.Get_Entity_Message ( p_entity_id .Get_Entity_Message ( p_entity_id .Get_Entity_Message ( p_entity_id . Import Error Handling and Messaging Error Handler Flow Diagram This flow diagram charts the possible paths an error might take once it has exited the general main ECO Business Object Interface process flow. x_message_list ).Get_Entity_Message ( p_entity_id .

the entities the error extends itself over (scope of the error) . The following is a list of the error severity levels recognized by the import program: Table 6–12 CODE ‘W’ ‘E’ ‘E’ ‘F’ ‘U’ Code Meanings MEANING Warning / Debug Standard Error Severe Error Fatal Error Unexpected error Error States Error states serve two purposes : s They convey to the user the exact type of error in the record. Error Severity Levels Severity levels help distinguish between different types of errors since the import program behaves differently for each of these errors.Entity Process Flows Error Handling Concepts Error handling depends on the severity of the error. They help the import program identify the records that do not need to be processed. Code Meanings MEANING Success Error Fatal Error Unexpected Error Not Processed s Table 6–13 CODE ‘S’ ‘E’ ‘F’ ‘U’ ‘N’ Engineering Change Order Business Object Interface 6-47 . When an error occurs. and how the error affects the lineage (child record error states). records are marked so that erroneous records are not processed again.

Severe Error I: This error affects all records. 3. 6-48 Oracle Manufacturing APIs and Open Interfaces Manual . when the parent is not in the business object. Expected errors: These are errors the program specifically looks for in the business object. This error is usually a change notice/organization uniformity error. before committing it to the production tables. how many other records in the business object hierarchy the current error affects. that is.Entity Process Flows Error Scope This indicates what the depth of the error is in the business object. All record statuses are set to ‘E’. Severe Error II: This error affects all records that are children of this record’s parent. All records must have the same change notice/organization combination. A characteristic of this 2. For example: Revised item cannot be updated to status=10. There are two error states that indicate how the child is affected: Table 6–15 CODE ‘E’ ‘N’ Code Meanings MEANING Error Not Processed Error Classes There are three major classes that determine the severity of the problem. 1. Standard Error: This error causes only the current record to be error-ed out. but is not serious enough to affect any other records in the object. The current record status is set to ‘E’. the status of the child may vary based on the type of error. Table 6–14 CODE ‘R’ ‘S’ ‘C’ ‘A’ Code Meanings MEANING Error affects current ‘R’ecord Error affects all ‘S’ibling and child records Error affects ‘C’hild records Error affects ‘A’ll records in business object Child Error States If an error in a record affects child records.

The following are situations that cause this error: s 5.Entity Process Flows record’s parent caused the error. Fatal Error II: This error affects all records that are children of this record’s parent. so all its siblings and their children also get a record status of ‘F’. This error is usually a user-unique to unique index conversion error. the user somehow loses the database connection. The child record statuses are set to ‘N’. 6. All record statuses are set to ‘F’. Fatal Error I: These errors occur when it is not possible to perform any operation on the ECO. update. Fatal Error III: These errors affects the current record and its children. This error usually occurs when a lineage check fails. ECO is implemented in the production tables ECO is canceled in the production tables Workflow activity is in progress for the ECO You do not have access to this ECO (change order type) s s s 7. The child record statuses are set to ‘E’. The following situations cause this error: s 8. since it is not possible to perform any operation on these records. This type of errors occur when there are errors on CREATEs. Severe Error IV: This error affects the current record and its child records since the program cannot properly process the child records. A characteristic of this record’s parent caused the error. when the parent is not in the business object. The current record and all its child record statuses are set to ‘F’. Severe Error III: This error not only affects the current record but also its child records in the business object. or delete a component of a revised item that was already implemented or cancelled. Such errors affect the entire business object. Please check your child records for errors as well as the current record. for example. Engineering Change Order Business Object Interface 6-49 . so all its siblings and their children also get a record status of ‘E’. Revised item is implemented in the production tables Revised item is canceled in the production tables You do not have access to this revised item (BOM item type) s s Unexpected errors: All errors that are not expected errors are unexpected errors. This usually occurs when the user tries to create. 4. These are errors that the program is not specifically looking for.

The purpose of warnings is: 6-50 Oracle Manufacturing APIs and Open Interfaces Manual .Entity Process Flows Figure 6–4 Unexpected Errors Warnings: These are messages for information only.

For example. it sets the business object error status (also called return status) appropriately to convey this to the user. Sibling record : A sibling record (of the current record) is one that holds the same parent unique key column values as the current record. to inform the user of any side-effects caused by user-entered data. and the rest of the document. The caller may also use the business object return status to choose an appropriate course of action (commit. The error status is also referred to as return status or error state in this Engineering Change Order Business Object Interface 6-51 . Likewise. a reference designator record that holds the same parent component unique key column values as a substitute component is a sibling of the substitute component. to warn the user of problems that may occur when the ECO is implemented. : Table 6–16 CODE ‘S’ ‘E’ ‘F’ ‘U’ Code Meanings MEANING Success Error Fatal Error Unexpected Error Record Error Status : This is the state of the record after the import (success or error). or further processing by the caller). How it all works To bring together all the concepts above into a workable algorithm. For example: Revised item is being referenced on another pending ECO. rollback. It is then up to the user to locate the offending record(s) using the individual record error statuses as indicated below. Child record : All records carry the unique keys for all parents above them. A child record (of a particular parent) is one that holds the same values for the unique key columns as the parent record. As soon as the import program encounters an erroneous record. is a sibling of the current component record. Business Object Error Status : This indicates the state of the whole business object after the import. For example: All Approval History records associated with ECO have been deleted. a component record that holds the same parent revised item unique key column values as the current component record.Entity Process Flows 1. we must introduce some terms that used extensively in this section. The following is a list of all the possible business object states. 2.

Hence. if a record has a NULL return status. it means that the import program has not gotten to it yet. and child statuses relate together to constitute the different error classes for records : Table 6–17 Error Warning Error Status. s Every record is assigned an error status by the import program. Sibling and Child Records C: Current and Child Record -N/AN: Not Processed Unexpected Error U: Unexpected Error This flow diagram charts the possible paths an error might take: 6-52 Oracle Manufacturing APIs and Open Interfaces Manual . Sibling and Child Records C: Current and Child Record Child Statuses -N/A-N/AE: Error E: Error E: Error Standard Error Severe Error I Severe Error II Severe Error III Severe Error IV Fatal Error I Fatal Error II Fatal Error III C: Current and Child Records N: Not Processed A: All Records S: Current. Scope and Child Status Status S: Success E: Error E: Error E: Error E: Error E: Error F: Fatal Error F: Fatal Error F: Fatal Error Scope R: Record Only R: Record Only A: All Records S: Current. The error status helps locate erroneous records in a business object that has error-ed out.Entity Process Flows document. The user must send in records with {return status = NULL}. error scope. The import program will not look at records that already have an error status value. The following are important pointers about the record error status. s The following shows how the error status. since it assumes that a record with an error status value has already been looked at by the program. Please see the Error States section above for a list of statuses a record can receive.

Entity Process Flows Figure 6–5 Possible Error Paths The list below shows the sequence of steps that need to be performed when warnings or errors are encountered: p_severity_level = Standard Error s Log error messages Set record status to ‘E’ Set business object status to ‘E’ s s p_severity_level = Severe Error I s Log error messages Set record status to ‘E’ Set all business object record statuses to ‘E’ Set business object status to ‘E’ s s s Engineering Change Order Business Object Interface 6-53 .

Set business object status to ‘E’ s s s p_severity_level = Severe Error III s Log error messages Set record status to ‘E’ Set direct and indirect children statuses to ’E’. Set business object statuses to ‘F’ s s s 6-54 Oracle Manufacturing APIs and Open Interfaces Manual . Also set statuses of sibling records and all their children to ’F’.Entity Process Flows p_severity_level = Severe Error II s Log error messages Set record status to ‘E’ Set direct and indirect children statuses to ’E’. Set business object statuses to ‘F’ s s s p_severity_level = Fatal Error II s Log error messages Set record status to ‘F’ Set direct and indirect children statuses to ’F’. Also set statuses of sibling records and all their children to ’E’. Set business object status to ‘E’ s s s p_severity_level = Severe Error IV s Log error messages Set record status to ‘E’ Set direct and indirect children statuses to ’N’. Set business object status to ‘E’ s s s p_severity_level = Fatal Error I s Log error messages Set record status to ‘F’ Set all business object records to ’F’.

Set business object statuses to ‘U’ s s s p_severity_level = Warning s Log error messages API Messaging API Message Table All messages are logged in the API Error Message Table. The entity that this message belongs to. RI. Please see below for format information.ECO RevisionsRI . or SC. This may hold BO.Reference DesignatorsSC Substitute Components Engineering Change Order Business Object Interface 6-55 . This is a PL/SQL table (array) of messages.BO Business ObjectECO . RD. ECO.Revised ComponentsRD .Entity Process Flows p_severity_level = Fatal Error III s Log error messages Set record status to ‘F’ Set direct and indirect children statuses to ’F’ Set business object statuses to ‘F’ s s s p_severity_level = Unexpected Error s Log error messages Set record status to ‘U’ Set all remaining un-processes business object record statuses to ’N’. The following is a description of the API Message Table: Table 6–18 Field Message_Text Entity_Id API Message Table Type VARCHAR2(2000) VARCHAR2(3) Description The actual message that the user sees. RC. Please see Accessing Messages in the Launching the Import section of this document on how to access these messages.Revised ItemsRC . REV.ECO HeaderREV .

then the following will be logged: s For the revised item itself. For all records affected by the type of error that occured in the revised item. the other message. the error message describing the problem. some of which will identify the entity instances that this message is for. Please note that the message text may contain tokens. So if an error in a revised item record will cause all its children to error out. The following tokens identify the several entities: s Revised Item : Revised_Item_Name Revised Component : Revised_Component_Number Substitute Component : Substitute_Component_Number Reference Designator : Reference_Designator_Name ECO Revisions : Revision ECO Header : ECO_Name s s s s s Unexpected errors: <Package Name> <Procedure/Function Name> <SQL Error Number> <SQL Error Message Text> Other message: An Other Message is a message that is logged for all records that are affected by an error in a particular record. how the error has affected this record. 6-56 Oracle Manufacturing APIs and Open Interfaces Manual . or that it has not been processed.Entity Process Flows Table 6–18 Field Entity_Index API Message Table Type NUMBER VARCHAR2(1) Description The index of the entity array this record belongs to. 2. that is. with a severe or fatal error status. This message essentially mentions the following: s 1. Message_Type Message Formats Expected errors and warnings: The message text contains the translated and token substituted message text. it has been error-ed out too. which record caused this record to be affected. Indicates whether message is an error or warning.

Business Object hierarchy level that current record is an instance of. Essentially the purpose of the other message is to give the user as much information as possible about the error that got propagated to this record. that is. See below for description of this list. Does not apply to ECO Header. See below for description. 4. Engineering Change Order Business Object Interface 6-57 . Message generated for the other affected records. what transaction type in the offending record caused this record to be affected. s s The following is the input that the Error Handler expects from the calling program. It makes calls to the Error Handler when an error or warning needs to be issued. : Table 6–19 Input Input Description Calling program must pass the whole business object as-is. Indicates depth of error. List of messages generated for error in the current record. Status the record in error should be set to. the entity that the record in error belongs to. what process flow step in the offending record caused this record to be affected. The Error Handler handles the error and returns the altered object to the calling program. how many other records are affected by it. Set the return status of other records affected by this error.Entity Process Flows 3. Set the return status of the record in error. Business Object Message and Token List Error Status Error Level Entity Array Index Error Scope Other Message and Token List Other Status The calling program must trap the error and send the above details to the Error Handler. The following are the functions of the Error Handler: s Log the error/warning messages sent to it. Error Handler The program performs all its error handling and messaging through the Error Handler. That is. Index of record in error in its encompassing entity array. Status the other affected records should be set to.

Should this token value be translated ? Message Text Token Name Token Value Translate Since each message may have more than one token. so no message retrieval is needed. They hold message-and-token records. there may be more than one occurrence of the message in the list. after any requested token translation is performed. the translated message text is retrieved using the message name. Name of the token in the message. For unexpected errors. For expected errors and warnings. Value of the token in the message. Message text for unexpected errors. Then. The same applies to the Other Message and Token List.Entity Process Flows Message and Token List Records The Message and Token List. Since this lone message may have more than one token. The Error Handler must log these messages into the API Message List. The calling program may want some of these message record tokens to be translated (such tokens are typically messages themselves). 6-58 Oracle Manufacturing APIs and Open Interfaces Manual . except that this list needs to carry only one message which is assigned to all other affected records. The message is logged after token translation and substitution is performed. the tokens are substituted into the translated message text. the calling program itself sends a message text. and the message is logged. Please note that the API Message List is public. and the Other Message and Token List are temporary arrays that the calling program maintains. NULL for unexpected errors. the Message and Token List has as many occurrences of the same message as there are tokens in it. Table 6–20 Field Message Name Field Descriptions Description Name of the message used to retrieve the translated message text. but the Message and Token Lists are not.

7 Oracle Inventory Open Interfaces and APIs This chapter contains information about the following Oracle Inventory open interfaces and application program interfaces: s Open Transaction Interface on page 7-2 Open Replenishment Interface on page 7-28 Open Item Interface on page 7-38 Customer Item and Customer Item Cross-Reference Open Interfaces on page 7-68 Cycle Count Entries Interface on page 7-83 Cycle Count Application Program Interface on page 7-89 Kanban Application Program Interface on page 7-92 Lot Application Program Interface on page 7-95 Material Reservation Application Program Interface on page 7-97 Reservations Manager Application Program Interface on page 7-110 Sales Order Application Program Interface on page 7-113 Move Order Application Program Interface on page 7-118 Pick Release Application Program Interface on page 7-134 Pick Confirm Application Program Interface on page 7-138 Quantity Tree Program Interface on page 142 Transaction Processing Program Interface on page 7-154 s s s s s s s s s s s s s s s Oracle Inventory Open Interfaces and APIs 7-1 .

In the first processing mode.Open Transaction Interface Open Transaction Interface Oracle Inventory provides an open interface for you to load transactions from external applications and feeder systems. or transfers loaded from data collection devices. groups the transaction rows. For material movement of items that are under lot or serial control. passing the group identifier of the interfaced transactions as a parameter so that the worker can recognize which subset of transactions to process. receipts. These transactions could include sales order shipment transactions from an order entry system other than Oracle Order Entry. 7-2 Oracle Manufacturing APIs and Open Interfaces Manual . You must write the load program that inserts a single row for each transaction into the MTL_TRANSACTIONS_INTERFACE table. There are two modes you can use to process your transactions through the interface. or they could be simple material issues. Oracle Order Management’s Inventory Interface program populates the interface tables with transactions submitted through the Confirm Shipments window. you must also insert rows into the CST_COMP_SNAP_ INTERFACE table if the organization referenced uses average costing. you must also insert rows into MTL_ TRANSACTION_LOTS_INTERFACE and MTL_SERIAL_NUMBERS_INTERFACE respectively. The following transaction types are supported by this interface: s Inventory issues and receipts (including user-defined transaction types) Subinventory transfers Direct inter-organization transfers Intransit shipments WIP component issues and returns WIP assembly completions and returns Sales order shipments Inventory average cost updates s s s s s s s This interface is also used as an integration point with Oracle Order Entry for shipment transactions. If you insert WIP assembly/completion transactions that complete or return job assemblies. you insert the rows in the interface table and call a Transaction Worker directly. In the second processing mode. The system uses this information to calculate completion cost. and launches a Transaction Worker to process each group. Then the Transaction Manager polls the interface table asynchronously looking for transactions to process. you populate the interface table only.

If you are completing an ATO assembly. and relieve costs of completed assembly from the job/schedule. and the transaction value and quantity (if appropriate) to calculate the new average. on-hand quantity. and then you issue 4 boxes to that department. Finally. picking up all transactions from the history table that have not yet been marked as costed. Next. with a remaining balance of 6 reserved boxes. you must specify the sales order demand details so that Oracle Inventory can reserve the completed units to the appropriate sales order line/shipment. Average Cost Transactions In average cost organizations. Once the transaction has been successfully processed. Additional Transaction Processing Flow Steps The following transactions require additional processing by the transaction processor or other modules. For example. WIP Issue Transactions WIP issue transactions also update quantity issued for all material requirements on the job or repetitive schedule and charge the costs of issued components to the job/schedule. and derives or defaults any additional columns. If the WIP completion/return transaction completes or return job assemblies in an average costing organization. or transfer locations. the reservation will automatically be partially consumed. Inventory Issue Transactions Inventory Issue transactions consume any existing reservations where the Transaction Source Type and Source match. the transaction is costed by the transaction cost processor which runs periodically. the Transaction Processor records the transaction details in the transaction history table along with relevant current cost information. All material movement transactions update inventory perpetual balances for the issue. the corresponding row is deleted from the interface table. receipts and average cost update transactions modify the item’s average cost using the current average cost. launch appropriate backflush transactions. updates the error code and explanation if a validation or processing error occurs. WIP Completion Transactions WIP completion transactions update the job or repetitive schedule completed quantities.Open Transaction Interface The Transaction Worker calls the Transaction Validator which validates the row. the rows in the CST_COMP_SNAP_INTERFACE Oracle Inventory Open Interfaces and APIs 7-3 . receipt. if you reserved 10 boxes of paper for the Finance department.

but you also need to populate each lot row with a unique value in MTL_TRANSACTION_LOT_ NUMBERS.SERIAL_TRANSACTION_TEMP_ID. you populate the foreign key MTL_TRANSACTION_ LOTS_INTERFACE. Similarly. Completion Cost Detail Relationships If you are completing or returning WIP assembly items for a job in an average costing organization. Sales Order Shipment Transactions For sales order shipment transactions. you populate the foreign key MTL_SERIAL_NUMBERS_ INTERFACE. If the item is under lot control. Line.TRANSACTION_INTERFACE_ID with the same value for all child lot rows of the transaction and ensure that the total of all the lot quantities adds up to the transaction quantity on the parent row. You accomplish this by populating MTL_TRANSACTIONS_INTERFACE. Lot and Serial Transaction Detail Relationships If you are transacting items under lot and/or serial control. you need to link the completion cost detail rows to their 7-4 Oracle Manufacturing APIs and Open Interfaces Manual . This means that the relationship between MTL_ TRANSACTIONS_INTERFACE and MTL_ TRANSACTION_LOT_NUMBERS remains the same as in the case where the item is under only lot control. You then need to populate the foreign key MTL_SERIAL_NUMBERS_INTERFACE.Open Transaction Interface table are transferred to the CST_COMP_SNAPSHOT table so that completion costs can be calculated. the processor also creates an interface row in MRP_ RELIEF_INTERFACE that the MRP Planning Manager uses to relieve the Master Demand Schedule. TRANSACTION_INTERFACE_ID with a unique value to be used as the primary key to link the child lot/serial rows. you need to link the lot/serial transaction detail rows to their parent row. TRANSACTION_INTERFACE_ID with the value in the parent row and ensure that the total number of serial numbers adds up to the transaction quantity of the parent row. Delivery. If MRP is installed. the Transaction Processor attempts to consume any reservations that may have been created for an order by matching the Order. the serial interface rows must belong to lot parent rows. If the item is under both lot and serial control. TRANSACTION_INTERFACE_ID with the value in the parent lot row and ensure that the total number of serial numbers adds up to the lot quantity in the parent row. and Picking Line identifiers. if the item is under serial control.

You must also populate the foreign key CST_COMP_SNAP_INTERFACE. you can substantially reduce the time to process your interfaced transactions by increasing the target processes and reducing the concurrent manager sleep time using the Concurrent Managers window. You can also launch a worker from the operating system using the Oracle Inventory Open Interfaces and APIs 7-5 . you need to set up your concurrent manager to best handle your transaction volumes while balancing your performance requirements and your system load restrictions. TRANSACTION_INTERFACE_ID with a unique value to be used as the primary key to link the child completion cost rows. Starting the Inventory Transaction Manager Once you have set up the Inventory concurrent manager. Oracle Applications System Administrator’s Guide. This launches the Material Transaction manager and lets you specify the polling interval and the number of transactions to be processed by each worker. After polling the MTL_ TRANSACTIONS_INTERFACE table for eligible rows. See: Launching Transaction Managers. It is defaulted to run in the Standard work shift with Target Processes = 1 and Sleep Time of 60 seconds. See: Defining Managers and their Work Shifts. See: Transaction Managers. Oracle Inventory User’s Guide. Submitting a Transaction Worker Directly as a Concurrent Process The transaction worker can be directly called either from an Oracle Form or a c program. you can launch the Inventory Transaction Manager in the Interface Managers window.Open Transaction Interface parent rows. Oracle Inventory ships the Transaction Manager to be run in Inventory’s own concurrent manager named Inventory Manager. Setting Up the Transaction Interface Setting Up the Inventory Concurrent Manager For optimal processing in the Inventory Transaction Interface.TRANSACTION_INTERFACE_ID with the same value for all child completion cost calculation rows. This will allow Transaction Workers to run in parallel with the Transaction Manager and with each other. You accomplish this by populating MTL_TRANSACTIONS_ INTERFACE. With this configuration. the Transaction Manager creates the necessary number of Transaction Workers to process the load. If you have the available resources. Oracle Inventory User’s Guide. the Material Transaction Manager and all Transaction Workers that are spawned must share the same processing queue.

Consequently. This means that you must set up Inventory’s Sales Order flexfield (MKTS) using the Key Flexfield Segments window with enough segments so that the combination is unique across all orders. you should use the Sales Order segment values to identify the order. TABLE Pass 1 for the Interface table and 2 for the temp table. For example. followed by a section giving a brief description of a subset of columns requiring further 7-6 Oracle Manufacturing APIs and Open Interfaces Manual . HEADER_ID This is the transaction_header_id that you want the worker to process.Open Transaction Interface Application Object library CONCSUB utility. standard installation steps require that you set up three segments. SOURCE_HEADER_ID This column will be used to select rows to process if HEADER_ID is not specified. When you enter shipment transactions into the interface. If you can guarantee that one segment is sufficient (for example. Inserting into the Transaction Interface Tables This section provides a chart for each interface table that lists all columns. order type. If no header id is passed the worker will assign itself. Setting Up Your Sales Order Flexfield Oracle Inventory uses a flexfield to hold the unique Sales Order name so that it does not need to join back to the feeder Order Entry system. and order number. and if the code combination does not already exist will create a new one. then that is all you need to enable in your flexfield definition. Oracle Order Entry guarantees uniqueness within an installation. SOURCE_CODE This column is used to select rows to process if header id is not specified. See: Key Flexfield Segments. Order Number). Oracle Flexfields User’s Guide. You need to specify the following parameters in the given order. All references to the order number internal to Inventory in reports and inquiries will be based on this relationship. The Material Transaction Manager will validate against MTL_SALES_ORDERS.

and Distribution Account. the Transaction Validator will automatically validate them and derive the internal identifiers. This is particularly true of flexfields. INVENTORY_ITEM_ID) for the required value. MTL_TRANSACTIONS_INTERFACE The following graphic describes the MTL_TRANSACTIONS_INTERFACE table: Table 7–1 MTL_TRANSACTIONS_iNTERFACE Table Column Name SOURCE_CODE SOURCE_LINE_ID SOURCE_HEADER_ID PROCESS_FLAG TRANSACTION_MODE LOCK_FLAG TRANSACTION_HEADER_ID ERROR_CODE ERROR_EXPLANATION VALIDATION_REQUIRED TRANSACTION_INTERFACE_ID INVENTORY_ITEM_ID ITEM_SEGMENT1 to ITEM_ SEGMENT20 Type Varchar2(30) Number Number Number(1) Number Number(1) Number Varchar2(240) Varchar2(240) Number Number Number Varchar2(40) x x x x x x x Required x x x x x x Derived Optional Oracle Inventory Open Interfaces and APIs 7-7 . In these cases. Derived. Several of the attributes in the interface tables can be populated using either the user-friendly values or the internal identifiers. If you populate the user-friendly values. such as Item. Reference numbers corresponding to notes immediately following the table help identify the mandatory conditions. Many of the columns are conditionally required. If the translation is already available to the external system. you have the option to specify either the flexfield segment representation or the internal identifier (for example.Open Transaction Interface explanation. or Optional. Locator. The chart identifies each column’s datatype and whether it is Required. it may be advantageous to use the internal identifiers to improve performance (see discussion below on validation).

Open Transaction Interface Table 7–1 MTL_TRANSACTIONS_iNTERFACE Table Column Name REVISION ORGANIZATION_ID SUBINVENTORY_CODE LOCATOR_ID LOC_SEGMENT1toLOC_ SEGMENT20 TRANSACTION_QUANTITY TRANSACTION_UOM PRIMARY_QUANTITY TRANSACTION_DATE ACCT_PERIOD_ID TRANSACTION_SOURCE_ID DSP_SEGMENT1toDSP_ SEGMENT30 Type Varchar2(3) Number Varchar2(10) Number Varchar2(40) Number Varchar2(3) Number Date Number Number Varchar2(40) x x x x x x x x 4 5 5 x x x x x Required 1 x 2 3 3 x x x Derived Optional TRANSACTION_SOURCE_NAME Varchar2(30) TRANSACTION_SOURCE_TYPE_ ID TRANSACTION_ACTION_ID TRANSACTION_TYPE_ID REASON_ID TRANSACTION_REFERENCE TRANSACTION_COST DISTRIBUTION_ACCOUNT_ID DST_SEGMENT1toDST_ SEGMENT30 CURRENCY_CODE CURRENCY_CONVERSION_ TYPE CURRENCY_CONVERSION_ RATE Number Number Number Number Varchar2(240) Number Number Varchar2(25) Varchar(30) Varchar(30) Number 7-8 Oracle Manufacturing APIs and Open Interfaces Manual .

6 7 x x x x x x x Required Derived Optional x x x x x Oracle Inventory Open Interfaces and APIs 7-9 .12 10 10 10 8 8 8 9 6 6 3.6 3.Open Transaction Interface Table 7–1 MTL_TRANSACTIONS_iNTERFACE Table Column Name CURRENCY_CONVERSION_ DATE USSGL_TRANSACTION_CODE ENCUMBRANCE_ACCOUNT ENCUMBRANCE_AMOUNT VENDOR_LOT_NUMBER TRANSFER_SUBINVENTORY TRANSFER_ORGANIZATION TRANSFER_LOCATOR XFER_LOC_SEGMENT1toXFER_ LOC_SE SHIPMENT_NUMBER TRANSPORTATION_COST TRANSPORTATION_ACCOUNT TRANSFER_COST FREIGHT_CODE CONTAINERS WAYBILL_AIRBILL EXPECTED_ARRIVAL_DATE NEW_AVERAGE_COST VALUE_CHANGE PERCENTAGE_CHANGE DEMAND_ID PICKING_LINE_ID DEMAND_SOURCE_HEADER_ID DEMAND_SOURCE_LINE DEMAND_SOURCE_DELIVERY WIP_ENTITY_TYPE Type Date Varchar(30) Number Number Varchar2(30) Varchar2(10) Number Number Varchar2(40) Varchar2(30) Number Number Number Varchar2(25) Number Varchar2(20) Date Number Number Number Number Number Number Varchar2(30) Varchar(30) Number 11.

12 12 Optional 7-10 Oracle Manufacturing APIs and Open Interfaces Manual .Open Transaction Interface Table 7–1 MTL_TRANSACTIONS_iNTERFACE Table Column Name SCHEDULE_ID OPERATION_SEQ_NUM REPETITIVE_LINE_ID NEGATIVE_REQ_FLAG TRX_SOURCE_LINE_ID TRX_SOURCE_DELIVERY_ID CUSTOMER_SHIP_ID SHIPPABLE_FLAG LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID COST_GROUP_ID PROGRAM_UPDATE_DATE ATTRIBUTE_CATEGORY ATTRIBUTE1 to ATTRIBUTE15 BOM_REVISION BOM_REVISION_DATE ROUTING_REVISION ROUTING_REVISION_DATE ALTERNATE_BOM_ DESIGNATOR ALTERNATE_ROUTING_ DESIGNATOR Type Number Number Number Number Number Number Number Varchar2(1) Date Number Date Number Number Number Number Number Number Date Varchar2(30) Varchar2(150) Varchar2(1) Date Varchar2(1) Date Varchar2(1) Varchar2(1) 8 x x x 15 15 15 15 14 14 x x x x x x x x x 11 13 x 9 9 x Required Derived 11.

or intra-organization) 7 Intransit shipments 8 Average cost update transactions only 9 Sales order shipment transactions 10 To reserve/unreserve ATO items to a sales order upon completion/return from a WIP job 11 WIP component issues/returns 12 WIP assembly completions/returns 13 Repetitive schedules Oracle Inventory Open Interfaces and APIs 7-11 .Open Transaction Interface Table 7–1 MTL_TRANSACTIONS_iNTERFACE Table Column Name ACCOUNTING_CLASS DEMAND_CLASS PARENT_ID SUBSTITUTION_ID SUBSTITUTION_ITEM_ID SCHEDULE_GROUP BUILD_SCHEDULE REFERENCE_CODE FLOW_SCHEDULE SCHEDULED_FLAG Type Varchar2(1) Varchar2(1) Number Number Number Number Number Number Varchar2(1) 16 17 Required Derived Optional 15 14 14 14 14 14 14 14 Notes: 1 If under revision control 2 All transaction types except average cost update 3 If under locator control 4 Inventory Issues and Receipts in an average cost organization 5 Inventory Issues/Receipts of an asset item to/from an asset subinventory and sales order shipment transactions 6 Inventory direct transfers (inter.

The valid options are: 2 . For other transaction types. SOURCE_LINE_ID You can use this column as an external system reference.Concurrent 3 . derived if null 16 Must be set to Y 17 Must be set to 2 SOURCE_CODE This column is required for Sales Order transactions to identify the source Order Entry system. The valid values are: 1 .Background 7-12 Oracle Manufacturing APIs and Open Interfaces Manual . The values entered are transferred directly to the transaction history table.Yes 2 . you can enter any useful value for tracking purposes.Error TRANSACTION_MODE This column determines how the interfaced transactions will be processed. The values entered are transferred directly to the transaction history table. The values entered are transferred directly to the transaction history table.No 3 . You should insert a row that you intend to be processed with a value of 1 (Yes). PROCESS_FLAG This column controls whether rows in the interface table are processed.Open Transaction Interface 14 For work order-less completions 15 For work order-less completions. SOURCE_HEADER_ID You can use this column as an external system reference.

Open Transaction Interface Interface transactions marked for Background processing will be picked up by the transaction manager polling process and assigned to a transaction worker. TRANSACTION_HEADER_ID This column groups transactions for assignment to specific transaction workers. ERROR_CODE DERIVED If a transaction error occurs. this column is either required (concurrent mode) or derived by the transaction manager (background mode). In this case. LOCK_FLAG The Transaction Manager uses this column to manage the worker assignment process. The options are: 1 .Full validation 2 . Full validation is used. you will need to reset the LOCK_FLAG to 2 so your failed transactions can be reprocessed. These transactions will not be processed unless the transaction manager is running. check the log file for details using the View Requests window. Depending on the value of TRANSACTION_MODE.Validate only columns required for derivation If you leave this field null. the Transaction Validator populates this column with short descriptive text indicating the type of error that has occurred. This column maps to MTL_MATERIAL_TRANSACTIONS. ERROR_EXPLANATION DERIVED If a transaction error occurs. VALIDATION_REQUIRED You can use this flag to control whether the Transaction Validator skips certain validation steps for certain transaction types. The Transaction Manager does not process transactions marked for concurrent processing. You use Concurrent transaction mode if you want to launch a dedicated transaction worker to explicitly process a set of transactions. If an explanation is not provided.TRANSACTION_SET_ID in the transaction history tables. You should need to update this column only if a transaction has failed due to an exceptional failure such as the system going down in the middle of transaction worker processing. Oracle Inventory Open Interfaces and APIs 7-13 . the Transaction Validator populates this column with an explanation of the error.

Enter a quantity of 0 for Average Cost Update transactions. and negative for both issues out of inventory and transfers. If the transacted item is under serial control and not lot control. this column maps to MTL_SERIAL_NUMBERS_INTERFACE. TRANSACTION_INTERFACE_ID. TRANSACTION_UOM You can enter the TRANSACTION_QUANTITY in any unit of measure that has conversion rates defined to the item’s primary unit of measure. Use this column to specify the transacted unit of measure even if it is the same as the primary unit of measure. PRIMARY_QUANTITY This column is the transaction quantity in the item’s primary unit of measure calculated using TRANSACTION_QUANTITY and TRANSACTION_UOM. TRANSACTION_QUANTITY Enter the transaction quantity in the transaction unit of measure. TRANSACTION_INTERFACE_ID This column is required for transactions of items under lot or serial control. TRANSACTION_INTERFACE_ID. The quantity should be positive for receipts into inventory. If the transacted item is under lot control. and the transaction date must lie within the boundaries of an open period (in ORG_ACCT_PERIODS). this column maps to MTL_ TRANSACTION_LOTS_INTERFACE. ACCT_PERIOD_ID This column is derived using the entered TRANSACTION_DATE to determine within which period the transaction occurred. The value in the column in this table is used to identify the child rows in the lot or serial interface tables MTL_TRANSACTION_LOTS_INTERFACE and MTL_SERIAL_ NUMBERS_INTERFACE. 7-14 Oracle Manufacturing APIs and Open Interfaces Manual .Open Transaction Interface Note: See: Validation on page 7-26. The transaction date must be on or before the system date at time of transaction processing.

The transaction types and internal IDs supported by the interface are: Table 7–2 Transaction Types and Internal IDs Internal ID 01 31 32 35 17 40 41 42 43 44 02 03 21 80 33 Transaction Type Account Issue Account Alias Issue Miscellaneous Issue Issue Components to WIP Return Assemblies to WIP Account Receipt Account Alias Receipt Miscellaneous Receipt Return Components from WIP WIP Assembly Completion Subinventory Transfer Direct Inter-Organization Transfer Intransit Shipment Average Cost Update Sales Order Shipment You can identify the TRANSACTION_TYPE_ID for user-defined transactions by selecting from MTL_TRANSACTION_TYPES where TRANSACTION_TYPE_ NAME is the transaction type you wish to use. TRANSACTION_SOURCE_TYPE_ID This column is derived from MTL_TRANSACTION_TYPES using the value you enter in TRANSACTION_TYPE_ID.Open Transaction Interface TRANSACTION_TYPE_ID Enter the type of transaction you are executing. Oracle Inventory Open Interfaces and APIs 7-15 .

WIP_ENTITY_TYPE For WIP component issues and returns.CODE_COMBINATION_ID MTL_GENERIC_DISPOSITIONS. such as an order number. TRANSACTION_SOURCE_ID TRANSACTION_SOURCE_ID or the corresponding flexfield segment columns (DSP_SEGMENT1 to DSP_SEGMENT30) are required for all transaction source types other than those that are user-defined.Open Transaction Interface TRANSACTION_SOURCE_NAME This column is required for user-defined transaction source types.WIP_ENTITY_ID MTL_SALES_ORDERS.SALES_ORDER_ID Source Type Account Account Alias Job or Schedule Sales Order DSP_SEGMENT1 TO DSP_SEGMENT30 You can use these flexfield segment columns instead of TRANSACTION_SOURCE_ ID to enter the more user-friendly information. You should enter the foreign key ID that points to the context table identified by the transaction source type. if the interfaced transaction is for an Issue to Account transaction type.DISPOSITION_ID WIP_ENTITIES. OPERATION_SEQ_NUM For assembly completions and returns. enter 1. to be displayed on all transaction reports and inquiries. For example. Table 7–3 TRANSACTION_SOURCE_ID. and WIP assembly completions and returns. this value is required. Foreign Key References Foreign Key Reference GL_CODE_COMBINATIONS. TRANSACTION_ACTION_ID This column is derived from MTL_TRANSACTION_TYPES using the value you enter in TRANSACTION_TYPE_ID. enter one of the following values: 7-16 Oracle Manufacturing APIs and Open Interfaces Manual . this value is derived. Enter the value of the source name. you would enter the GL Code Combination segment values in these columns instead of putting the Code GL Code Combination ID in TRANSACTION_SOURCE_ID. For WIP routings. For WIP component issues and returns with routings.

4. 3. and derived by the Transaction Worker based on the transaction source type and source for Account Issue/Receipt and Account Alias Issue/Receipt transactions. if the interfaced transaction is for an Issue to Account transaction type. you would enter the GL Code Combination segment values in these columns instead of putting the Code GL Code Combination ID in DISTRIBUTION_ACCOUNT_ID. Oracle Inventory Open Interfaces and APIs 7-17 . For example. DISTRIBUTION_ACCOUNT_ID Use this column (or the flexfield segment columns) to specify the account to charge for the cost of the Inventory transaction. If you leave it blank.Open Transaction Interface 1. the current system unit cost is used. enter the currency code. TRANSACTION_COST You can use this column to specify a transaction unit cost for average cost Inventory issues and receipts. It is required for user-defined transactions. DST_SEGMENT1 TO DST_SEGMENT30 You can use these flexfield segment columns instead of DISTRIBUTION_ ACCOUNT_ID to enter the more user-friendly information. 2. TRANSACTION_REFERENCE Use this column to enter any transaction reference information to be displayed in transaction inquiries and reports. Standard discrete jobs Repetitive schedules Non-standard discrete jobs Work Order-less Schedule REASON_ID Use this column to specify a transaction reason from the predefined list of reasons in MTL_TRANSACTION_REASONS. CURRENCY_CODE If your transaction cost is in a different currency than the functional currency of your set of books.

TRANSFER_LOCATOR This column is required for subinventory transfers within the same organization and direct transfers from one organization to another when the item being transferred is under locator control in the destination subinventory. VENDOR_LOT_NUMBER Use this column as transaction reference information and/or to cross-reference supplier lot numbers against internal lot numbers. 7-18 Oracle Manufacturing APIs and Open Interfaces Manual . For these scenarios.Open Transaction Interface CURRENCY_CONVERSION_TYPE If you enter a currency code other than the functional currency for your set of books. enter the conversion type. enter the conversion rate CURRENCY_CONVERSION_DATE Enter the currency conversion date for which the conversion rate is valid for the transaction. For these scenarios. Enter the destination organization’s internal ID. TRANSFER_ORGANIZATION This column is required for all inter-organization transfers. enter the destination subinventory. you can optionally use these columns instead of TRANSFER_LOCATOR when you want to use the user-friendly flexfield representation of the transfer locator instead of the internal ID. CURRENCY_CONVERSION_RATE If you enter a currency code other than the functional currency for your set of books. XFER_LOC_SEGMENT1-XFER_LOC_SEGMENT20 When a transfer locator is required. TRANSFER_SUBINVENTORY This column is required for subinventory transfers within the same organization and direct transfers from one organization to another. enter the destination locator internal ID.

or PERCENTAGE_CHANGE be populated. The Transaction Worker will not process intransit transactions if a shipment header already exists in RCV_SHIPMENT_HEADERS that matches SHIPMENT_NUMBER. It groups shipment lines in RCV_ SHIPMENT_LINES under a parent shipment number in RCV_SHIPMENT_ HEADERS. If you want to group shipment lines under the same header.Open Transaction Interface SHIPMENT_NUMBER This column is required for intransit shipments. using the TRANSACTION_HEADER_ID to group your interface transactions. depending on the type of cost update being performed. leave this column blank. If you do not have the DEMAND_ID information. You can accomplish this using the concurrent processing mode. and the Transaction Processor will try to match reservations to relieve by checking MTL_DEMAND to see if there are any reservations where there is a match on: Oracle Inventory Open Interfaces and APIs 7-19 . VALUE_CHANGE. you must ensure they are processed by the same worker. NEW_AVERAGE_COST Average cost update transactions require that either NEW_AVERAGE_COST. and directly calling a Transaction Worker to process that group. PERCENTAGE_CHANGE See NEW_AVERAGE_COST. VALUE_CHANGE See NEW_AVERAGE_COST. DEMAND_ID Use this column for sales order shipment transactions to identify the exact reservation row to be relieved in MTL_DEMAND.

DEMAND_SOURCE_DELIVERY See DEMAND_SOURCE_HEADER_ID. DEMAND_SOURCE_LINE See DEMAND_SOURCE_HEADER_ID. The transaction processor will automatically create a reservation for the completed quantity to that sales order. and DEMAND_SOURCE_DELIVERY_ID that match the appropriate demand rows in MTL_DEMAND. DEMAND_SOURCE_HEADER_ID Use this column for completion (and returns) of ATO items from a Final Assembly Order if the quantity you are completing is to be reserved to an existing sales order. See DEMAND_ID. See DEMAND_ID. 7-20 Oracle Manufacturing APIs and Open Interfaces Manual . TRX_SOURCE_DELIVERY_ID Use this column to specify details of reservations to be relieved with an issue transaction. Enter values in DEMAND_SOURCE_HEADER_ID.Open Transaction Interface Table 7–4 Table Mapping: MTL_TRANSACTIONS_INTERFACE to MTL_DEMAND MTL_DEMAND ORGANIZATION_ID INVENTORY_ITEM_ID DEMAND_SOURCE_TYPE_ID DEMAND_SOURCE_HEADER_ID DEMAND_SOURCE_LINE DEMAND_SOURCE_NAME DEMAND_SOURCE_DELIVERY MTL_TRANSACTIONS_INTERFACE ORGANIZATION_ID INVENTORY_ITEM_ID TRANSACTION_SOURCE_TYPE_ID TRANSACTION_SOURCE_ID TRX_SOURCE_LINE_ID TRANSACTION_SOURCE_NAME TRX_DELIVERY_ID TRX_SOURCE_LINE_ID Use this column to specify details of reservations to be relieved with an issue transaction. DEMAND_SOURCE_LINE_ID.

2 . Oracle Inventory Open Interfaces and APIs 7-21 .Delete: Delete a component from the operation. SUBSTITUTION_ID Use this column to specify the substitution type 3 . ROUTING_REVISION The routing revision and date determines which version of the routing is used to create work order-less component requirements. 1 .Change: Substitute one component for another at the operation. 4 . ALTERNATE_BOM_DESIGNATOR An alternate bill of material is optional if alternates have been defined for the assembly you are building. SCHEDULE_GROUP This column can specify any active schedule group. ALTERNATE_ROUTING_DESIGNATOR An alternate routing is optional if alternates have been defined for the assembly you are building.Open Transaction Interface BOM_REVISION The bill revision and date determine which version of the bill is used to explode work order-less component requirements. BUILD_SEQUENCE For future use. PARENT_ID This column identifies the work order-less completion interface ID.Lot/Serial: Specify lot/serial number information for items. SUBSTITUTION_ITEM_ID This column identifies the inventory item number of the substitute item.Add: Add a component at the operation.

Open Transaction Interface REFERENCE_CODE For future use. MTL_TRANSACTION_LOTS_INTERFACE The following graphic describes the MTL_TRANSACTION_LOTS_INTERFACE table: Table 7–5 Transaction Lot Numbers Interface Type Number Varchar2(30) Number Varchar2(30) x Date Number Number Number Varchar2(30) Date Number Date Number Number Number Number Number Date x x x x x x x x x 2 x 1 x x Required 3 x x Derived Optional Column Name TRANSACTION_INTERFACE_ ID SOURCE_CODE SOURCE_LINE_ID LOT_NUMBER LOT_EXPIRATION_DATE TRANSACTION_QUANTITY PRIMARY_QUANTITY SERIAL_TRANSACTION_TEMP_ID ERROR_CODE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE 7-22 Oracle Manufacturing APIs and Open Interfaces Manual .

Open Transaction Interface Notes: 1 If item is under lot expiration control 2 If item is under both lot and serial control LOT_NUMBER Enter the lot number that is being transacted. SERIAL_TRANSACTION_TEMP_ID This column is required only for items under both lot and serial control. MTL_SERIAL_NUMBERS_INTERFACE The following graphic describes the MTL_SERIAL_NUMBERS_INTERFACE Interface table: Oracle Inventory Open Interfaces and APIs 7-23 . It is used to identify the child rows in MTL_SERIAL_NUMBERS_INTERFACE. TRANSACTION_INTERFACE_ID Use this column to associate lot transaction detail rows with the parent transaction row in MTL_TRANSACTIONS_INTERFACE.

If you enter only the ‘from’ serial number. The transaction processor will attempt to transact all serial numbers within the range of the right-most numeric digits. 7-24 Oracle Manufacturing APIs and Open Interfaces Manual . TO_SERIAL_NUMBER You can enter a ‘to’ serial number to specify a range. the Transaction Processor assumes that only one serial number is being transacted.Open Transaction Interface Table 7–6 Transaction Serial Numbers Interface Type Number Varchar2(30) Varchar2(30) Varchar2(30) Number Varchar2(30) Varchar2(30) Date Number Date Number Number Number Number Number Date x x x x x x x x x x x x x x Required x x Derived Optional Column Name TRANSACTION_INTERFACE_ ID SOURCE_CODE FM_SERIAL_NUMBER TO_SERIAL_NUMBER SOURCE_LINE_ID VENDOR_SERIAL_NUMBER ERROR_CODE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE FM_SERIAL_NUMBER Enter the starting serial number in the range.

The vendor serial number is stored in the serial number table MTL_SERIAL_NUMBERS. it should point to MTL_ TRANSACTIONS_INTERFACE. CST_COMP_SNAP_INTERFACE The following graphic describes the CST_COMP_SNAP_INTERFACE Interface table: Oracle Inventory Open Interfaces and APIs 7-25 . this should point to MTL_ TRANSACTION_LOTS_INTERFACE SERIAL_TRANSACTION_TEMP_ID.Open Transaction Interface TRANSACTION_INTERFACE_ID Use this column to associate serial number transaction detail rows with their parent rows. TRANSACTION_INTERFACE_ID VENDOR_SERIAL_NUMBER You can use this column to enter vendor cross-reference information. Otherwise. If the item is under both lot and serial control.

Validation Oracle Inventory lets you choose the level of validation you want performed against interfaced transaction rows. OPERATION_SEQ_NUMBER You can use this column to enter operation sequence information. The operation sequence number is stored in the WIP operations table WIP_OPERATIONS.Open Transaction Interface Table 7–7 Completion Cost Calculation Interface Type Number Number Number Date Number Date Number Number x x Number x x x Number Number Number Date x x x x Required x x x x x x x x Derived Optional Column Name TRANSACTION_INTERFACE_ ID WIP_ENTITY_ID OPERATION_SEQ_NUMBER LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN NEW_OPERATION_FLAG PRIMARY_QUANTITY QUANTITY_COMPLETED PRIOR_COMPLETION_QUANTITY PRIOR_SCRAP_QUANTITY REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE WIP_ENTITY_ID The job number. you can specify whether you want full validation or only partial validation of columns 7-26 Oracle Manufacturing APIs and Open Interfaces Manual . Using the VALIDATION_REQUIRED flag.

In these cases. For example. however. you can do so using this window. Fixing Failed Transactions Options Errors in the interface may be caused by problems unrelated to your interfaced transactions. the entire transaction processing group is marked with the error code. ORGANIZATION_ID is always validated because there are dependent attributes such as LOCATOR_ID that require a valid organization for derivation. or by directly updating the PROCESS_FLAG and LOCK_FLAG values via SQL*PLUS. and therefore is not validated if the VALIDATION_REQUIRED flag is not set. the interface processing flags will automatically be reset so the Transaction Manager will pick them up. or the failure could even be the result of a system error. however. on the other hand. you need to either delete the failed transactions and resubmit them from the feeder system. disabled). For example. it may be acceptable to simply resolve the conflict and resubmit the same interfaced rows by either using the Pending Transactions window to resubmit your transactions. while the transaction row(s) that actually failed will have an error explanation. The validation and derivation processes will provide an error code and description for all transaction rows that fail explicit validation checks. If an error occurs during reservation relief for a specific transaction. has no dependencies. or update the transaction in the interface table using SQL*PLUS. Oracle Inventory User’s Guide. Resolving Failed Transaction Interface Rows Viewing Failed Transactions You can view both pending and failed Inventory transactions in the MTL_ TRANSACTIONS_INTERFACE table using the Pending Transactions window. such as running out of space. This should happen. Oracle Inventory Open Interfaces and APIs 7-27 . See: Viewing Pending Transactions. all rows in the transaction processing group will be errored out with a common error message. there may be validation that failed because an entity that was being checked had the wrong status (for example. REVISION. If. If you set ‘Resubmit=Yes’. If your transactions errored out and you would like to resubmit them.Open Transaction Interface required for derivation of other required columns. When you resubmit updated transactions for processing. you need to make changes to the transaction data itself. If an error occurs in the transaction processor. all validation is performed again. only if there is an Oracle error or table deadlock during processing.

The validator derives any additional columns and updates the error flag if an error is detected. The validator processes the replenishment count specified as a parameter at process submission. A record for each item included in the count header must be inserted into the MTL_REPLENISH_ LINES_INT table. There are two modes you can use to send your replenishment counts through the interface. the records are inserted into the MTL_REPLENISH_ HEADERS and MTL_REPLENISH_LINES tables and are deleted from the interface tables. passes all required validation. These are Concurrent and Background modes. Functional Overview You must write the load program that inserts a single row for each replenishment count/request into the MTL_REPLENISH_HEADERS _INT table. If an error is detected during the validation process. Oracle Inventory User’s Guide. validating rows in both the MTL_REPLENISH_HEADER_INT and MTL_REPLENISH_LINES_INT tables. Such requests may be in the form of stock-take counts or requisition requests for subinventories in which you do not track quantities.Open Replenishment Interface Open Replenishment Interface Oracle Inventory provides an open interface for you to easily load replenishment requests from external systems such as a bar-code application. See: Entering and Processing Replenishment Counts. both header and lines. 7-28 Oracle Manufacturing APIs and Open Interfaces Manual . you use the Replenishment Processor as described in the Oracle Inventory User’s Guide to process the counts and create requisitions. For Background mode processing. Once the lines are in the internal replenishment tables. you populate the interface tables and then let the Replenishment Validator asynchronously poll the tables for replenishment counts to process. you populate the interface tables for a specific replenishment count and then call the replenishment validator from the Oracle Inventory menu (Counting/Replenishment Counts/Process Interface). the header and corresponding replenishment lines will be left in the interface table. You may also use the Replenishment Interface to process requisition requests generated by external applications for tracked subinventories. If the replenishment count. Under Concurrent mode processing.

INVENTORY_ITEM_ID) for the required value. ORGANIZATION_ID). You can also use the Schedule button to specify resubmission parameters that will control how frequently the Replenishment Validator polls for records in the interface tables. followed by a section giving a brief description of a subset of columns requiring further explanation. Replenishment Headers Interface Tables The following graphic describes the MTL_REPLENISH_HEADERS_INT table: Table 7–8 Oracle Inventory Replenishment Headers Interface Type Number Varchar2(10) Date Date Required 3 3 3 3 Derived Optional Column Name REPLENISHMENT_HEADER_ID REPLENISHMENT_COUNT_NAME COUNT_DATE LAST_UPDATE_DATE Oracle Inventory Open Interfaces and APIs 7-29 . Inserting into the Replenishment Interface Tables This section provides a chart for each interface table that lists all columns. the Replenishment Validator will validate them and will derive the internal identifiers. Several of the attributes in the interface tables can be populated using either the user-friendly values or the internal identifiers. The chart identifies each column’s datatype and whether it is Required. select Validate Replenishment Interface. When specifying the organization. If you populate the user friendly values. Derived. Select the type of request by choosing Single Request. If the translation is available to the external system. it may be advantageous to use the internal identifiers to improve performance. In the Parameters window. select Concurrent or Background as the Processing Mode and select the Count Name for processing.g. you may either use the organization code or the internal identifier (e. Select Submit Request to begin processing.Open Replenishment Interface Setting Up the Replenishment Interface Access the Replenishment Interface through the Oracle Inventory menu (Counting/Replenishment Counts/Process Interface).g. you have the choice of specifying either the flexfield segment representation or the internal identifier (e. For example. or Optional. In the Request Name field.

The error flag for a replenishment header will be set if either the validation of the header fails or if the validation of any of the lines of the header fails. ORGANIZATION_ID This column identifies the internal identifier of the organization from which the replenishment count originated.Open Replenishment Interface Table 7–8 Oracle Inventory Replenishment Headers Interface Type Date Number Number Number Number Varchar2(3) Varchar2(10) Date Number Number Number Number Number Number Date Number Varchar2(20) 3 3 3 3 3 3 3 3 3 3 3 3 3 x 3 Required 3 3 3 Derived Optional Column Name CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN LAST_UPDATED_BY ORGANIZATION_ID ORGANIZATION_CODE SUBINVENTORY_CODE SUPPLY_CUTOFF_DATE PROCESS_STATUS PROCESS_MODE ERROR_FLAG REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE DELIVERY_LOCATION_ID DELIVERY_LOCATION_CODE ERROR_FLAG If a validation error occurs. You must enter either the internal organization identifier or the user friendly organization code. the replenishment validator populates this column with an error code. 7-30 Oracle Manufacturing APIs and Open Interfaces Manual .

in which case the internal identifier will be derived. It may be used instead of the internal identifier. This error indicates an exceptional condition and should not occur. Oracle Inventory Open Interfaces and APIs 7-31 .Background Interface replenishment counts marked for Background processing will be picked up by the replenishment validator polling process. After the validator has run. PROCESS_MODE This column determines how the interfaced replenishment count will be processed. from the interface table. You should insert rows that you intend to be processed with a value of 2 (Pending). 5. You use Concurrent processing mode if you want to launch a dedicated replenishment validator process to explicitly process a single replenishment count. identified as a parameter to the program. 3. The valid values for this column are: 1.Open Replenishment Interface ORGANIZATION_CODE This column is the user friendly code for the organization that is the source of the replenishment count. 4. The validator will pick up and process all replenishment counts with a process mode of Background each time it runs. whether validation errors were detected or not. 2. PROCESS_STATUS This column is used to identify the current processing status of the replenishment count. you can use this column by setting the value to 1 (Hold). This status is used whenever the process completes. Hold Pending Processing Error Completed If you want to insert records into the interface tables but temporarily prevent them from being processed.Concurrent 3 . it will set the value of this column to 5 (Completed). The valid options are: 2 . A status of 4 (Error) indicates an internal error occurred.

in which case the internal identifier will be derived. You may specify neither the code or the identifier. in which case the default delivery location of the organization originating the replenishment will be used. You may use the sequence MTL_REPLENISH_HEADERS_S to obtain a unique identifier. The value for this column will be derived from system date if it is left null. You may enter the delivery location identifier. You may enter this code instead of the internal identifier. DELIVERY_LOCATION_CODE Enter the user friendly code for the delivery location of the replenishment. REPLENISH_COUNT_NAME Enter a unique name for the replenishment count. The following graphic describes the MTL_REPLENISH_LINES_INT table: Table 7–9 Oracle Inventory Replenishment Lines Interface Type Number Number Number Required 3 3 3 Derived Optional Column Name REPLENISHMENT_HEADER_ID REPLENISHMENT_LINE_ID ORGANIZATION_ID 7-32 Oracle Manufacturing APIs and Open Interfaces Manual .Open Replenishment Interface REPLENISH_HEADER_ID Enter a unique identifier for the replenishment count. This column is used to group the lines of a replenishment count with the header. DELIVERY_LOCATION_ID Enter the internal identifier for the location to which the replenishment should be delivered. SUBINVENTORY_CODE This column identifies the subinventory that is the source of the replenishment count. the default delivery location for the organization from which the replenishment originated is defaulted. SUPPLY_CUTOFF_DATE Enter the date after which planned supply will not be considered in available quantity calculations. the user friendly delivery location code or neither. If neither is specified.

You may use the sequence MTL_REPLENISH_LINES_S to obtain a unique identifier for the line. INVENTORY_ITEM_ID Enter the internal identifier for the item to be replenished. Oracle Inventory Open Interfaces and APIs 7-33 . The identifier entered here is the foreign key reference which links the header table with the lines table to associate a group of lines with a single header. REPLENISHMENT_LINE_ID Enter the identifier for the line within the replenishment count.Open Replenishment Interface Table 7–9 Oracle Inventory Replenishment Lines Interface Type Date Date Number Number Number Number Varchar2(40) Number Number Varchar2(240) Number Number Number Number Date Varchar2(25) Varchar2(3) 3 3 3 3 3 3 3 Required 3 3 3 3 3 3 3 3 3 3 Derived Optional Column Name LAST_UPDATE_DATE CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN LAST_UPDATED_BY INVENTORY_ITEM_ID SEGMENT {1-20} COUNT_TYPE_CODE COUNT_QUANTITY REFERENCE ERROR_FLAG REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE COUNT_UNIT_OF_MEASURE COUNT_UOM_CODE REPLENISHMENT_HEADER_ID Enter the unique identifier of the replenishment count.

the count quantity is the on-hand balance determined during the stock-take. REFERENCE Use this column to enter any replenishment count reference information. the organization identifier will be derived from the replenishment header. This count type may be used with either tracked or non-tracked subinventories. This column is not used when the count type is Order Maximum. COUNT_QUANTITY This column is used to specify the count quantity that corresponds to the count type entered for the line. the count quantity represents the quantity to be ordered. When the count type is Order Quantity. 3. When the count type is On-hand Quantity. This count type may be used with either tracked or non-tracked subinventories. Use Order Maximum when you want to place an order for the min-max maximum quantity specified for item in the subinventory specified. Use Order Quantity when you want to specify the quantity to be ordered. COUNT_TYPE_CODE Enter the type of the replenishment count entry. On-hand Quantity Order Quantity Order Maximum Use On-hand Quantity to identify counts that are the result of stock-takes of subinventories in which you do not track on-hand quantities. If you do not enter a value here.Open Replenishment Interface SEGMENT{1-20} You may use these flexfield columns instead of INVENTORY_ITEM_ID to enter the item identifier in a more user-friendly form. 2. ORGANIZATION_ID This column identifies the internal identifier of the organization from which the replenishment count originated. 7-34 Oracle Manufacturing APIs and Open Interfaces Manual . The valid count types are: 1.

This column is meaningful only when a value is entered in the COUNT_QUANTITY columns. COUNT_UOM_CODE This column is represents the unit of measure code used for the count. This column is meaningful only when a value is entered in the COUNT_QUANTITY columns. Validation Oracle Inventory validates the following conditions: s The value of REPLENISH_HEADER_ID must be unique among existing replenishment counts The value of REPLENISH_COUNT_NAME must be unique among existing count headers The value of LAST_UPDATED_BY must be a valid user name ORGANIZATION_ID must be a valid identifier of an organization SUBINVENTORY_CODE must refer to an existing subinventory DELIVERY_LOCATION_ID must be a valid identifier of a location associated with the organization generating the replenishment There must be at least one line per header The ORGANIZATION_ID at the header level must be the same as that at the line level COUNT_TYPE_CODE must be either 1. The replenishment validator populates this column with a line corresponding to the error detected during validation. This column may be used to specify the full name for the unit of measure. You may specify the code when populating this table or you may use the full name for the unit of measure.Open Replenishment Interface COUNT_UNIT_OF_MEASURE Enter the count unit of measure identifier. in which case this column will be derived. 2. or 3 and must be consistent with whether the subinventory is tracked or non-tracked The value of COUNT_QUANTITY must be consistent with COUNT_TYPE_ CODE and must be greater than zero s s s s s s s s s Oracle Inventory Open Interfaces and APIs 7-35 . ERROR_FLAG This flag indicates the error status of the validation of a replenishment line.

Open Replenishment Interface s INVENTORY_ITEM_ID must refer to a transactable item in the organization specified The item must exist in the subinventory and must be min-max planned in that subinventory The COUNT_UOM_CODE must be valid and conversions to primary UOM must exist Each line must correspond to a header s s s Viewing Failed Transactions Replenishment counts that fail the validation process will remain in the MTL_ REPLENISH_HEADERS_INT and MTL_REPLENISH_LINES_INT tables.Header failed because line failed 18 .Invalid subinventory 7 .No item specified in either identifier or segments 7-36 Oracle Manufacturing APIs and Open Interfaces Manual .Invalid item identifier or item isn’t transactable 9 . Possible values for the ERROR_FLAG column in the MTL_REPLENISH_ HEADERS_INT table are: 1 .No corresponding header id 3 . You may use SQL*PLUS to identify the headers that have failed by selecting those rows with a process_status of 5 (Complete).Invalid user name 4 .Header with no corresponding replenishment lines 10 . The reason for the failure will be reflected in the ERROR_FLAG column.Invalid organization identifier 5 .Delivery location is not valid Possible values for the ERROR_FLAG column in the MTL_REPLENISH_LINES_ INT table are: 1 .Invalid user name 8 .Invalid unit of measure or no conversion to primary unit of measure exists 11 .Non-unique replenishment count name 3 .Non-unique replenishment header id 2 .

the resolution is simple. For example. there may be validation that failed because an entity that was being validated had the wrong status (i.On-hand count type used for tracked subinventory 14 . disabled). once you have made the necessary changes. correct them in the external feeder system and resubmit them. errors in the interface are caused by problems external to the replenishment count itself. When you resubmit updated transactions for processing. you need to make changes to the data in the interface table. or update the interface record in the interface table using SQL*PLUS. such as running out of space. or the failure could even be the result of a system error. all validation will be performed again. however. Oracle Inventory Open Interfaces and APIs 7-37 . If. you need to either delete the failed records.e.Item is not specified in the subinventory or is not min-max planned in the subinventory Fixing Failed Transactions Frequently.Lines organization header does not match header organization identifier 17 .Invalid count quantity 15 .Invalid count type 13 .Open Replenishment Interface 12 . In these cases. you simply need to resubmit the replenishment validator process.

Validation of imported items is done using the same rules as the item definition windows. migrate assembly and component items from a legacy manufacturing system.Open Item Interface Open Item Interface You can import items from any source into Oracle Inventory and Oracle Engineering using the Item Interface. or as a separate task of importing item category assignments only. the Inventory menu contains the Import submenu with the Import Items and Import Item Category Assignments menu entries. convert purchased items from a custom purchasing system. When you import items through the Item Interface. You can also import item category assignments. Oracle Inventory User’s Guide. update existing items. See: Defining Items. and import new items from a Product Data Management package. You use the MTL_SYSTEMS_ITEM_INTERFACE table for your new item numbers and all item attributes. Functional Overview The Item Interface lets you import items into Oracle Inventory and. including past and future revisions and effectivity dates. so you are insured of valid items. and categories to be imported into the Oracle Inventory MTL_ITEM_CATEGORIES table. and is not required. If you are importing revision details for your new items. The Item Interface reads data from three tables for importing items and item details. You can specify values for all the item attributes. MTL_ 7-38 Oracle Manufacturing APIs and Open Interfaces Manual . This can be done simultaneously with a process of importing items. you can convert inventory items from another inventory system. This is the main item interface table. To import item category assignments. Oracle Engineering User’s Guide and Defining Items. insuring that your imported items contain the same item detail as items you enter manually in the Master Item window. Oracle Inventory User’s Guide. For this purpose. This table is used only for revision information. you create new items in your item master organization. or you can specify just a few attributes and let the remainder default or remain null. the MTL_ITEM_CATEGORIES_INTERFACE table is used to store data about item assignments to category sets. or assign existing items to additional organizations. The Item Interface also lets you import revision details. The Item Interface validates your data. and may be the only table you choose to use. With this interface. Oracle Engineering. See: Overview of Engineering Prototype Environment. The purpose of this essay is to explain how to use the Item Interface. you can use the MTL_ITEM_REVISIONS_INTERFACE table. if installed at your site. A fourth table.

and revision details. the records will import correctly. do not create the MTL_SYSTEM_ITEMS_ INTERFACE_UC1 unique index. as well as the MTL_ITEM_ CATEGORIES_INTERFACE table. Note: You can process both master and child item records in the same run. revision. The Item Interface assigns defaults. Instead. you must write and run a custom program that extracts item information from your source system and inserts the records into the MTL_SYSTEM_ITEM_INTERFACE table. SEGMENT8. and then imports the new items. determine which segments are enabled for the System Items flexfield. You can also use the Item Interface to import item material cost. SEGMENT12). Create the following indexes for optimum performance: MTL_SYSTEM_ITEMS_B Oracle Inventory Open Interfaces and APIs 7-39 . First. if you have a two-segment flexfield. material overhead. you run the Item Interface to import the data. SQL> create unique index MTL_SYSTEM_ITEMS_INTERFACE_UC1 on MTL_SYSTEM_ITEMS_ INTERFACE (ORGANIZATION_ID. Before you use the Item Interface. create MTL_SYSTEM_ITEMS_ INTERFACE_NC1 non-unique index on the same columns. and (if revision detail is included) the MTL_ITEMS_REVISIONS_INTERFACE table. you would do the following: SQL> create unique index MTL_SYSTEM_ITEMS_B_UC1 on MTL_SYSTEM_ITEMS_B (ORGANIZATION_ID. validates data you include. and item category assignment records into these interface tables. with SEGMENT8 and SEGMENT12 enabled.Open Item Interface INTERFACE_ERRORS. After you load item. If you plan to populate the ITEM_NUMBER column in mtl_system_items_interface instead of the item segment columns. SEGMENT12). for example. Setting Up the Item Interface Create Indexes for Performance You should create the following indexes to improve Item Interface performance. SEGMENT8. is used for error tracking of all items that the Item Interface fails. Then.

It should include the segment (s) having been enabled for the System Item Key Flexfield. 7-40 Oracle Manufacturing APIs and Open Interfaces Manual . segmentn Note: This Index will have to be recreated as Non Unique if you s s s are populating organization_code. MTL_ITEM_REVISIONS_INTERFACE s Non Unique Index on set_process_id Non Unique Index on Transaction_id Non Unique Index on Organization_id. organization_id Non Unique Index on Item _number Unique Index on Transaction_id Unique Index on organization_id. MTL_SYSTEM_ITEMS_INTERFACE s Non Unique Index on inventory_item_id. Revision s s MTL_ITEM_CATEGORIES_INTERFACE s Non Unique Index no inventory_item_id. will also reduce processing time. Populating organization_id instead of organization_code for both Create and Update modes. mandatory segment. Inventory_item_id. You are enabled to use the created default index if you are using segment1. segmentn You need at least one indexed. category_id Non Unique Index on set_process_id Unique Index on transaction_id Suggestion: s s Populate _id fields whenever possible. Populating inventory_item_id instead of segment (n) for Update Mode will significantly improve performance. instead of organization_id.Open Item Interface s Non-Unique Index on organization_id.

Oracle Inventory User’s Guide and Overview of Inventory Setup. See: Oracle Inventory Profile Options. No Run the interface only for the organization you are currently in. You must set these profiles if you want them to default. Oracle Inventory User’s Guide. Item interface rows for organizations other than your current organization are ignored. you must ensure that the concurrent manager is running before you can import any items. These are runtime options for the Item Interface: All Organizations Runtime Options Yes Run the interface for all organization codes in the item interface table. Validate Items Yes Validate all items and their data residing in the interface table that have not yet been validated. You would use this option if Oracle Inventory Open Interfaces and APIs 7-41 . select Import Items from the Import submenu.Open Item Interface Start the Concurrent Manager Since you launch and manage the Item Interface concurrent program through the concurrent manager. Set Profile Option Defaults Some columns use profile options as default values. See: Importing Customer Items. No Do not validate items in the interface table. When you run the Item Interface. If items are not validated. Item Interface Runtime Options To run the Item Interface. Oracle Inventory User’s Guide. Note that items that have not been validated will not be processed into Oracle Inventory. accessed from the Inventory menu. they will not be processed into Oracle Inventory. or select Import Items in the Request Name field in the All Reports window. you are prompted for report parameters.

Create or Update Items Create or Update Items 1 Create new items. to remove successfully processed rows from the interface table without performing any other processing. along with Yes for Delete Processed Items. Delete Processed Rows Yes Delete successfully processed items from the item interface tables. 2 Update existing items. Process Set Enter a set id number for the set of records in the interface table that you want to process. 7-42 Oracle Manufacturing APIs and Open Interfaces Manual . See: Update Existing Items below. along with Yes for Validate Items. all rows are picked up for processing regardless of the SET_PROCESS_ID column value. You can create or update items via separate executions of the Import Items program. if you want to validate items without any processing. No Do not insert items into Oracle Inventory. Use this option. and now want to process your items. No Leave all rows in the item interface tables. The program picks up the records having that id in the SET_PROCESS_ID column. Process Items Yes All qualifying items in the interface table are inserted into Oracle Inventory. You can also use this option. If you leave this field blank.Open Item Interface you had previously run the item interface and responded Yes for Validate Items and No for Process Items.

DESCRIPTION. Table 7–10 Partial List of Columns. You may also put in details about other interface tables not used by the Item Interface. ORGANIZATION_CODE or ORGANIZATION_ID..) and the REVISION column are used for importing item costs and revisions and are discussed in a later section of this chapter. and TRANSACTION_ TYPE. Currently. The item costing columns (those that begin MATERIAL_. The columns in the item interface correspond directly to those in the item master table. the interface does not support the MTL_CROSS_REFERENCE_ INTERFACE or MTL_SECONDARY_LOCS_INTERFACE..Open Item Interface Inserting into the Item Interface Table Item Interface Table Description The item interface table MTL_SYSTEM_ITEMS_INTERFACE contains every column in the Oracle Inventory item master table. PROCESS_FLAG. either because they have defaults that can be derived. all of these columns are optional. The MTL_ITEM_CATEGORIES_INTERFACE is used by the Item interface for both internal processing of default category assignments. Except for ITEM_NUMBER or SEGMENTn columns. or because the corresponding attributes are optional and may be left null. Oracle Inventory Item Interface MTL_SYSTEM_ITEMS_INTERFACE Type Varchar2(81) Varchar2(240) Number Number Varchar2(50) Number Varchar2(50) Number Varchar2(3) conditionally Required conditionally conditionally x x x x x x Derived Optional (Partial List of Columns) Column Name ITEM_NUMBER DESCRIPTION MATERIAL_COST MATERIAL_OVERHEAD_RATE MATERIAL_OVERHEAD_SUB_ELEM MATERIAL_OVERHEAD_SUB_ELEM_ID MATERIAL_SUB_ELEM MATERIAL_SUB_ELEM_ID ORGANIZATION_CODE Oracle Inventory Open Interfaces and APIs 7-43 . and to retrieve data populated by the user to be imported into the Oracle Inventory MTL_ITEM_CATEGORIES table. MTL_SYSTEM_ITEMS.

see Table and View Definitions. you must insert the system item flexfield separator between each segment of your item number. Specifying either the ORGANIZATION_ID or ORGANIZATION_CODE adequately identifies the organization. if you are using a two segment item and have defined a dash (-) as your separator. For example. To identify the item when importing it. a typical item would be entered as 1234-5678. 7-44 Oracle Manufacturing APIs and Open Interfaces Manual . you may specify either the ITEM_NUMBER or SEGMENTn columns—the Item Interface generates the INVENTORY_ITEM_ID for you. When more than one of these columns has been entered and they conflict. See: Key Flexfield Segments. Note: If you enter a value for the ITEM_NUMBER column and you are using a multi-segment item. 1234 would be put in SEGMENT1. 5678 in SEGMENT2. it searches for this separator to indicate the end of one segment value and the start of the next segment value. ITEM_NUMBER overrides SEGMENTn and ORGANIZATION_ID overrides ORGANIZATION_CODE. Oracle Inventory Item Interface MTL_SYSTEM_ITEMS_INTERFACE Type Number Varchar2(3) Number Varchar2(5) Number x x x Required x x Derived Optional (Partial List of Columns) Column Name PROCESS_FLAG REVISION TRANSACTION_ID TRANSACTION_TYPE SET_PROCESS_ID Note: For information about columns not discussed in the Interface Manual. When the Item Interface derives the item’s segment values. In our example. Required Data Every row in the item interface table must identify the item and organization. Oracle Inventory Technical Reference Manual. It is strongly recommended that you use SEGMENT column instead of ITEM_NUMBER.Open Item Interface Table 7–10 Partial List of Columns. Oracle Flexfields User’s Guide.

be sure that the segments you use correspond to the key flexfield segments you defined for your items. This has to be the same as the master record when you import rows from the child organizations if the description attribute is maintained at the item master level. Your system items flexfield should not be defined with any optional segments. which tells the Item Interface how to handle the row.Open Item Interface Note: If you enter values for SEGMENTn columns. Always set the TRANSACTION_TYPE column to CREATE. Also. Oracle Inventory Open Interfaces and APIs 7-45 . Note: No segment validation is done against value sets. When you import a new item. There are two other columns the Item Interface uses to manage processing. to create an item record (true when both importing a new item and assigning an already existing item to another organization). so that the Item Interface can pick up the row and process it into the production tables. if the description is at the item-organization level. Of course. The Item Interface uses the PROCESS_FLAG to indicate whether processing of the row succeeded or failed. which indicates the current status of the row. No validation for the correct segments occurs when you run the Item Interface. give the PROCESS_ FLAG a value of 1 (Pending). They are TRANSACTION_TYPE. the Item Interface expects that all segments that you use for the system item flexfield be required segments. you are always able to override the master organization description by giving this column a value. When a row is ready to be processed. This is the only value currently supported by the Item Interface. you are also required to specify the DESCRIPTION. and PROCESS_FLAG.

You can review and update any failed rows in each interface table using custom reports and programs.Open Item Interface Table 7–11 Code 1 2 3 4 5 7 Meaning of PROCESS_FLAG Values Meaning Pending Assign complete Assign/validation failed Validation succeeded. but you are unlikely to see all of these. Other columns. because they have default values or their values can be derived from other sources. import failed Import in process Import succeeded A full list of values for the PROCESS_FLAG is in Table 1–14. Check the defaults and derived values carefully. A row is inserted into the MTL_INTERFACE_ERRORS table for all failed rows. as they may not be the values you desire. If the Item Interface cannot insert a row into the production table. If a row in the interface table fails validation. although required in the production tables. are not required in the item interface table. Columns with defaults are listed in Table 7–12 . the PROCESS_FLAG column for the failed row is set to 4 (Import failed). the PROCESS_FLAG column is set to 3 (validation failed). 7-46 Oracle Manufacturing APIs and Open Interfaces Manual . If the Item Interface successfully processes a row in the item interface table or the revision interface table. Derived Data Many columns have defaults that the Item Interface uses when you leave that column null in the item interface table. the program sets the PROCESS_FLAG to 7 (Import succeeded) for the row.

Open Item Interface Table 7–12 Column Defaults in the Item Interface MTL_SYSTEM_ITEMS_INTERFACE Default Value Y Y N N N N N 0 N N N N N N N N N N N 1 1 No No No No No 0 No No No No No No No No No No No Push Not under revision quantity control from Purchasing Options. ALLOW_ITEM_DESC_ UPDATE_FLAG Oracle Inventory Open Interfaces and APIs 7-47 . otherwise Yes Value Displayed in Window (Partial List of Columns) Column Name SUMMARY_FLAG 1 ENABLED_FLAG PURCHASING_ITEM_FLAG SHIPPABLE_ITEM_FLAG CUSTOMER_ORDER_FLAG INTERNAL_ORDER_FLAG SERVICE_ITEM_FLAG SERVICE_STARTING_DELAY_DAYS INVENTORY_ITEM_FLAG ENG_ITEM_FLAG 2 INVENTORY_ASSET_FLAG PURCHASING_ENABLED_FLAG CUSTOMER_ORDER_ENABLED_ FLAG INTERNAL_ORDER_ENABLED_ FLAG SO_TRANSACTIONS_FLAG MTL_TRANSACTIONS_ENABLED_ FLAG STOCK_ENABLED_FLAG BOM_ENABLED_FLAG BUILD_IN_WIP_FLAG WIP_SUPPLY_TYPE REVISION_QTY_CONTROL_CODE ALLOW_ITEM_DESC_UPDATE_FLAG from PO_SYSTEM_ PARAMETERS_ALL.

otherwise No from Purchasing Options.Open Item Interface Table 7–12 Column Defaults in the Item Interface MTL_SYSTEM_ITEMS_INTERFACE Default Value from PO_SYSTEM_ PARAMETERS_ALL. RECEIVING_FLAG from PO_SYSTEM_ PARAMETERS_ALL. RFQ_REQUIRED_FLAG 1 1 1 2 2 1 4 1 4 N N N N from profile INV: Default Primary Unit of Measure 3 Value Displayed in Window from Purchasing Options. otherwise No No lot control No shelf life control No serial number control Subinventories not restricted to predefined list Locators not restricted to predefined list No locator control User-defined time fence 1 Standard No No No No from Personal Profile Values (Partial List of Columns) Column Name RECEIPT_REQUIRED_FLAG RFQ_REQUIRED_FLAG LOT_CONTROL_CODE SHELF_LIFE_CODE SERIAL_NUMBER_CONTROL_CODE RESTRICT_SUBINVENTORIES_CODE RESTRICT_LOCATORS_CODE LOCATION_CONTROL_CODE PLANNING_TIME__FENCE_CODE PLANNING_TIME__FENCE_DAYS BOM_ITEM_TYPE PICK_COMPONENTS_FLAG REPLENISH_TO_ORDER_FLAG ATP_COMPONENTS_FLAG ATP_FLAG PRIMARY_UNIT_OF_MEASURE ALLOWED_UNITS_LOOKUP_CODE COST_OF_SALES_ACCOUNT SALES_ACCOUNT_DSP Both standard and item specific from MTL_PARAMETERS.SALES_ ACCOUNT from Organization Parameters 7-48 Oracle Manufacturing APIs and Open Interfaces Manual . from Organization Parameters COST_OF_SALES_ACCOUNT from MTL_PARAMETERS.

Open Item Interface Table 7–12 Column Defaults in the Item Interface MTL_SYSTEM_ITEMS_INTERFACE Default Value Value Displayed in Window (Partial List of Columns) Column Name ENCUMBRANCE_ACCOUNT from from Organization Parameters MTL_ PARAMETERS.ENCUMBRAN CE_ACCOUNT from MTL_ PARAMETERS.EXPENSE_ ACCOUNT 0 from profile INV: Default Item Status 6 2 1 Y M N N 0 0 0 0 1 N 0 0 N 0 N from Organization Parameters EXPENSE_ACCOUNT LIST_PRICE_PER_UNIT INVENTORY_ITEM_STATUS_CODE INVENTORY_PLANNING_CODE PLANNING_MAKE_BUY_CODE MRP__SAFETY_STOCK_CODE TAXABLE_FLAG MATERIAL_BILLABLE FLAG EXPENSE_BILLABLE_FLAG TIME_BILLABLE_FLAG SERVICE_DURATION MARKET_PRICE PRICE_TOLERANCE_PERCENT SHELF_LIFE_DAYS RESERVABLE_TYPE REPETITIVE_PLANNING_FLAG ACCEPTABLE_RATE_DECREASE ACCEPTABLE_RATE_INCREASE END_ASSEMBLY_PEGGING_FLAG POSTPROCESSING_LEAD_TIME VENDOR_WARRANTY_FLAG 0 from Personal Profile Values Not planned Buy Non-MRP planned from Purchasing Options. otherwise No Material No No 0 0 0 0 Reservable No 0 0 None 0 No Oracle Inventory Open Interfaces and APIs 7-49 .

but in the Master Items window the default value depends on whether the window is accessed from Oracle Engineering. 7-50 Oracle Manufacturing APIs and Open Interfaces Manual . but the Master Items window defaults N for this column.Open Item Interface Table 7–12 Column Defaults in the Item Interface MTL_SYSTEM_ITEMS_INTERFACE Default Value N Y N N 2 N N N N N N N N 6 N N N 0 0 No Yes No No Inspection not required No No No No No No No No Not planned No No None 0 Value Displayed in Window (Partial List of Columns) Column Name SERVICEABLE_COMPONENT_FLAG SERVICEABLE_PRODUCT_FLAG PREVENTIVE_MAINTENANCE_ FLAG SHIP_MODEL_COMPLETE RETURN_INSPECTION_ REQUIREMENT PRORATE_SERVICE_FLAG INVOICEABLE_ITEM_FLAG INVOICE_ENABLED_FLAG MUST_USE_APPROVED_VENDOR_ FLAG OUTSIDE_OPERATION_FLAG COSTING_ENABLED_FLAG CYCLE_COUNT_ENABLED_FLAG AUTO_CREATED_CONFIG_FLAG MRP_PLANNING_CODE CONTAINER_ITEM_FLAG VEHICLE_ITEM_FLAG END_ASSEMBLY_PEGGING_FLAG SERVICE_DURATION SET_PROCESS_ID Notes: 1 Defaulted to Y by the Item Interface. 2 Defaulted to N by the Item Interface.

Open Item Interface You can import item descriptive flexfield values when you have implemented a descriptive flexfield for items. all item-level attributes default down from the master organization—but only when the attribute column is null in the item interface table. and a status is used setting BOM_ ENABLED_FLAG to Yes. These attributes always derive from the item’s status. the INVENTORY_ITEM_FLAG must be set to Yes for the imported item. then the item status has no effect on the attribute’s value for the imported item. This is because the attribute dependency rules stipulate that BOM_ENABLED_FLAG can be only Yes for an Inventory Item. then the attribute value always derives from the item’s status. If you supply a value for a item-level attribute in a child organization record. Whether you import a new item to an master organization or assign an existing item to a non-master organization. The exception is status attributes under status control. the Item Interface rejects the record as an error. If an attribute is under status control. simply include values for the descriptive flexfield columns (ATTRIBUTE_CATEGORY and ATTRIBUTEn columns) in the item interface table. and any value in the attribute column of the item interface table is ignored. Oracle Inventory Open Interfaces and APIs 7-51 . In addition. the Item Interface processes the item with the BOM_ ENABLED_FLAG set to No. it still must follow the attribute dependency rules. if the BOM_ENABLED_ FLAG is under status control. See Table 7–12 for the list of defaults supplied by the Item Interface. Note: If an attribute is under status control. the Item Interface always enters a unique numeric identifier in the TRANSACTION_ID column of the item interface table. If the item has INVENTORY_ ITEM_FLAG set to No (or it is left null and therefore defaults to No). If an attribute is under default status control. No validation is performed on descriptive flexfield values. the Item Interface uses the item’s status (INVENTORY_ITEM_STATUS_ CODE) to determine the value of attributes under status control. To do this. For example. then the attribute value derives from the item’s status only if there is no value in the attribute column of the item interface table. If an attribute is not under any status control. Note: When you assign an item to a child organization. never from the master record.

Note: When running Import Items in update mode. For example. the Item Interface validates the data and any derived values the same way manually entered items are validated. suppose you define a category set Inventory with a default category of glass. Oracle Inventory User’s Guide and Defining Default Category Sets. This validation ensures that: s Required columns have an included or defaulted value Control levels are reflected in item attribute values Status control settings for status attributes are maintained Interdependences between item attribute values are consistent s s s 7-52 Oracle Manufacturing APIs and Open Interfaces Manual . the proper default category set and category is assigned to the item. if the defining attribute for a Functional area is enabled. when there is data for item category assignments in the MTL__ITEM_CATEGORIES_INTERFACE table. Validation When you import or update an item. the item is also assigned to mandatory category sets with the default category. Even if the item is assigned to a item level category set (non-mandatory) in the master organization. See: Defining Category Sets.Open Item Interface and the concurrent request number in the REQUEST_ID column of the item master table. and you designate Inventory as the mandatory category set for inventory items. The default category for each category set is used. the item defining attributes determine to which mandatory category sets the item is assigned. and a corresponding row is inserted into MTL_ITEM_CATEGORIES. Oracle Inventory User’s Guide. As described above. Item Categories When the Item Interface imports an item. When the interface imports an inventory item (INVENTORY_ITEM_FLAG = Y). The Item Interface also allows you to assign items to other category sets and categories. it also assigns the item to the mandatory category sets based on the item defining attributes. When using the Item Interface to assign an existing item to another organization. it is not assigned to that category set in the item’s new organization. the item is assigned to the glass category in the Inventory category set.

the interface inserts the rows into Oracle Inventory’s item master table. However. do not split a given item’s separate organization records into two different set_ process_id that are running in parallel.Open Item Interface Note: Before you can import an item into a child organization. you can write custom programs that report and delete any successfully imported rows. list the rows in a report. For all successfully validated rows. it must exist in the master organization. The program can search for rows with a PROCESS_FLAG value of 7 (Import Succeeded). The Item Interface then validates each row. then updates the value of the PROCESS_FLAG column to 2 (Assign Succeeded). If a row in the interface table fails validation. See: Defining Items. See: Multi-Thread Capability below. Oracle Inventory User’s Guide When you import items. you can automatically run the custom program after each submission of the Item Interface. the program sets the PROCESS_FLAG to 4 (Import Failed) and inserts a row into the error table. To minimize the number of rows stored in the interface table. This may cause the Child record to be processed before the Master record. the PROCESS_FLAG is set to 7 (Import Succeeded). the row is deleted or. You can also run multiple Item Interface processes. The Item Interface imports the details specified Oracle Inventory Open Interfaces and APIs 7-53 . you can specify at run time that the program delete successfully processed records after insertion. as one Item Open Interface process is not aware of other Item Open Interfaces processes running in parallel. The Master records are automatically separated from Children records. the program sets the PROCESS_FLAG to 3 (Assign/Validation Failed) and inserts a row into the error table. The interface first assigns the default values to the derived columns of the row. MTL_SYSTEM_ITEMS. If you do not delete successfully processed records automatically. After this program inserts the imported item into the item master table. and then delete them from the table. By defining a report set in Oracle Application Object Library. depending on the runtime option. and processed first. the Item Interface program validates all rows in the table that have a PROCESS_FLAG set to 1 (Pending). If a row cannot be inserted into the item master table. Importing Additional Item Details You can import additional cost and revision details for an imported item using interface tables listed in Table 7–13.

Oracle Inventory User’s Guide. you must define your cost types and activities before you can assign item costs. For example. the tables listed in Table 7–13 are the only interface tables used by the Item Interface to import item details. and summarized in the item costs table. Defining Default Category Sets. Before importing additional item details. The interface may import this costing information automatically using organization and category defaults. this material overhead rate is inserted into the cost details table.Open Item Interface in these tables at the same time that it imports the items themselves. this program validates the included or derived values the same way Oracle Inventory validates manually entered details. Table 7–13 Item Detail Costs Revisions Oracle Inventory Item Details Interface Interface Table MTL_SYSTEM_ITEMS_INTERFACE MTL_SYSTEM_ITEMS_INTERFACE (for imported items only) MTL_ITEM_REVISIONS_INTERFACE Number of Rows per Item 1 1 1 or more Note: Although there are many other tables in Oracle Inventory whose names may imply use. and Defining Item Revisions. CST_ITEM_COST_DETAILS. it may also import costing information into Oracle Cost Management tables. Importing Cost Details When the Item Interface imports an item. CST_ 7-54 Oracle Manufacturing APIs and Open Interfaces Manual . and the starting Revision must be set for all organizations. derives additional columns. Oracle Inventory User’s Guide. The program validates all rows you insert into the interface tables. The default cost category set must be specified using the Default Category Sets window. The Item Interface validates all required data and some optional data included in the item detail interface tables. and creates the item and item details in Oracle Inventory. When you import your cost or revision data. or you may specify the information for the item itself in the item interface table. Oracle Inventory User’s Guide. See: Overview of Inventory Setup. If you set up a default material overhead rate for the item’s organization or for the default cost category. you must complete the same setup steps required for manually defining these item details.

In other words. See: Organization Parameters Window. use the revision interface table. Oracle Inventory User’s Guide. MTL_ITEM_REVISIONS_INTERFACE. The interface imports the basis type for the material sub-elements and material overhead subelements from the BOM_RESOURCES table. Since revisions exist at the item-organization level. You may also include ECN information (see Table 7–14). Note: When importing multiple revisions for the same item. If the default basis type is not defined. if one of the revisions fails validation. Oracle Inventory Open Interfaces and APIs 7-55 . Oracle Cost Management User’s Guide and Defining Overhead. revision A must have an effectivity date less than or equal to revision B. Each row must reference the item’s ITEM_NUMBER and ORGANIZATION_ID or ORGANIZATION_CODE. You may specify one material cost and one material overhead rate for the item directly in the item interface table itself. Include a row for each revision (with an effectivity date) to import. for each item-organization combination. all revisions for that item fail. Each row in this table must correspond to a row in the item interface table. See: Defining Material Sub-Elements. Oracle Cost Management User’s Guide. the basis type of these sub-elements is set to Item and Total Value respectively. you need revision data for each item-organization you are updating. item costs cannot be updated. Remember to include the material sub-element for the material cost and overhead rate by specifying the sub-element. s s To import multiple item revisions and effectivity dates. You need to create your own program for populating this table. in ascending order. and so on. Note: When running the Item Interface in update mode. Importing Revision Details You can import detailed revision history with your new items in any one of the following ways: s Specify revisions and effectivity dates in the revision interface table Specify the current revision for each item in the item interface table Do not specify any revisions and let the Item Interface default the revision based on the starting revision defined in the Organization Parameters window.Open Item Interface ITEM_COSTS.

Possible values for the column are listed in Table 7–11. 7-56 Oracle Manufacturing APIs and Open Interfaces Manual . and do not include a revision in the item interface table. you cannot add revisions with effectivity dates earlier than the date assigned by the Item Interface. you should set the PROCESS_FLAG to 1 (Pending) and TRANSACTION_TYPE to CREATE. the column PROCESS_FLAG indicates the current state of processing for a row in the revision interface table. Oracle Inventory User’s Guide. include a value for the REVISION column in the item interface table. using the default specified in the Organization Parameters. The system date is the effectivity date. (Use the revision interface table described above if you want to specify a revision effectivity date. Note: Although most item information defaults from the master organization when you assign an existing item to a child organization. the Item Interface does not default an item’s revision detail from the master organization. The Item Interface automatically creates this revision with an effective date equal to the system date when it imports the item.Open Item Interface To import an item and its current revision only.) If you choose not to use the revision interface table. When you insert rows into the revision interface table. the Item Interface assigns each item a beginning revision. See: Defining Item Revisions. As with the item interface table. Once established.

The Item Interface may also be used to create revisions for existing items. Importing Item Category Assignments When the Item Interface imports items. simply load revision detail for the existing items into MTL_ITEM_ REVISIONS_INTERFACE and run the Item Interface. To do this.Open Item Interface Table 7–14 Column-Mappings from Revision Interface Table to Oracle Inventory MTL_ITEM_REVISIONS_INTERFACE Column Source ITEM_NUMBER ORGANIZATION_ID or ORGANIZATION_CODE REVISION CHANGE_NOTICE ECN_INITIATION_DATE IMPLEMENTATION_DATE IMPLEMENTED_SERIAL_NUMBER EFFECTIVITY_DATE ATTRIBUTE_CATEGORY ATTRIBUTEn REVISED_ITEM_SEQUENCE_ID DESCRIPTION MTL_ITEM_REVISIONS Column Name INVENTORY_ITEM_ID ORGANIZATION_ID REVISION CHANGE_NOTICE ECN_INITIATION_DATE IMPLEMENTATION_DATE IMPLEMENTED_SERIAL_NUMBER EFFECTIVITY_DATE ATTRIBUTE_CATEGORY ATTRIBUTEn REVISED_ITEM_SEQUENCE_ID DESCRIPTION You can import revision descriptive flexfield values when you have implemented a descriptive flexfield for revisions. you insert item category assignments data into the MTL_ITEM_CATEGORIES_INTERFACE table Oracle Inventory Open Interfaces and APIs 7-57 . Note: New item revisions cannot be added to existing items. To do this. while running Import Items in update mode. it can also import item category assignments into Oracle Inventory. For this to happen. Only revision labels and effectivity dates higher than existing revisions may be imported. simply include values for the descriptive flexfield columns (ATTRIBUTE_CATEGORY and ATTRIBUTEn columns) in the revision interface table when you import revisions.

No Do not insert item category assignments into Oracle Inventory. This column value cannot be NULL. 7-58 Oracle Manufacturing APIs and Open Interfaces Manual . Upload Processed Records Yes All qualifying item category assignment records in the interface table are inserted into Oracle Inventory. accessed from the Inventory menu. items are not imported. In this case. Item category assignment import can also be done as a separate task by selecting Import Item Category Assignments from the Import submenu. Delete Processed Records Yes Delete successfully processed item category assignment records from the item categories interface table. These are runtime options for the Item Category Interface: Record Set Id Enter a set id number for the set of records in the interface table that you want to process. you should use the sequence MTL_SYSTEM_ITEMS_INTF_SETS_S when populating the SET_ PROCESS_ID column. When you run the Item Category Interface. accessed from the Inventory menu. The program picks up the records having that id nin the SET_PROCESS_ ID column. select Import Item Category Assigments from the Import submenu. In order to avoid set id value conflicts between record sets imported by different users. you are prompted for report parameters. Item Category Assignment Interface Runtime Options To run the Item Interface.Open Item Interface Note: Item category assignments are imported when running the Item Interface in either the Create mode or Update mode. Use this option if you want to validate items without any processing.

DELETE) in the current record set. MTL_ITEM_CATEGORIES_INTERFACE. Inserting into the Item Categories Interface Table Item Categories Interface Description The item category interface table. the following MTL_ITEM_ CATEGORIES_INTERFACE columns need to be populated: Transaction Control Columns SET_PROCESS_ID record set to be processed by a single import program run. In addition. in order to prevent interference with other users’ interface data. then CREATE. These are described below. the Item Categories Interface processes all transaction types (CREATE. TRANSACTION_TYPE valid values are CREATE and DELETE. Before running item category assignment import. this value will tie the categories interface rows back to the MTL_SYSTEM_ITEMS_INTERFACE rows when item category assignments are imported together with Items. MTL_ITEM_CATEGORIES. Note: In contrast to the Transaction Type control in the Item Interface. PROCESS_FLAG indicates current status of a record (initially = 1).Open Item Interface No Leave all records in the item categories interface table. there are transaction control columns and attribute value columns. The columns in the item category interface table correspond directly to those in the item category assignments table. contains every column in the Oracle Inventory item category assignments table. an Updated transaction can only be performed as a combination of DELETE assignment. as specified in the TRANSACTION_TYPE column. Oracle Inventory Open Interfaces and APIs 7-59 . a SET_PROCESS_ID value should preferably be selected from the MTL_SYSTEM_ITEMS_INTF_SETS_S sequence. corresponding to the id columns. and it is not controlled via runtime option (parameter).

and assign templates to existing items. The status change is then recorded in the MTL_PENDING_ITEM_ STATUS table. You can update existing item attributes. the transaction_id column will populate with the inventory_item_id of the locked record. and remain for diagnostic purposes if the parameter is passed as No. AUTO_CHILD. Note: If a given item record has been locked by another user or process. and status controlled dependencies. Item Attribute Update Every item attribute can be updated. the proper default category set and category is assigned to the item. Master level controlled attributes are correctly propagated to the Child records when the Master Item record is updated. The Child records are copied into MTL_ SYSTEM_ITEMS_INTERFACE for validation and are identified with a transaction_ type. These records are deleted if the Delete Processed Rows parameter has been passed as Yes. In this case. and all necessary validations are performed to enforce item attribute interdependencies. master/child attribute dependencies. The status can be changed for existing items and the proper attributes default. these may be provided as either values or ids: ORGANIZATION_ID or ORGANIZATION_CODE INVENTORY_ITEM_ID or ITEM_NUMBER CATEGORY_SET_ID or CATEGORY_SET_NAME CATEGORY_ID or CATEGORY_NAME Update Existing Items You can run Import Items in update mode by setting the Create or Update Items parameter to 2. the update for the item in all organizations will error to maintain Master/Child relationship integrity. When the defining attribute for a Functional area is enabled. accordingly. within the row written to the MTL_INTERFACE_ ERRORS table.Open Item Interface Attributes that define a particular assignment to be imported. 7-60 Oracle Manufacturing APIs and Open Interfaces Manual .

determined above. To identify the error message for the failed row.000 items or less. plus the 400 additional. then delete the records from the interface table. the Item Interface sets the PROCESS_FLAG to 3 (Assign/validation failed) and inserts a row in the interface errors table.000 but you may want to try larger batch sizes. Load the records for one group. Note the time the Item Interface takes to process these rows in one batch.000 or less. Resolving Failed Interface Rows If a row fails validation. The best way to determine your batch size is by benchmarking. Leaving large numbers of processed rows in the interface table will degrade performance of the Open Item Interface.000 items into smaller groups. up to 5. A batch size of 1.000 items.Open Item Interface Determining Batch Size Running the Item Interface in Create Mode The optimum batch size depends upon the amount of data being imported and the power of your system. See: Multi-Thread Capability (Parallel Runs of the Item Interface). automatically created. If this time is more than 20 minutes. break the 10. you may want to try larger batch sizes. if you are updating 100 Master records. If you are processing 10. MTL_ INTERFACE_ERRORS. you may also use a batch size of 2. the program automatically populates the TRANSACTION_ID column in this table with Oracle Inventory Open Interfaces and APIs 7-61 . stick with the batch size of 2. process them.000 to 2. instead of deleting them.000 should be adequate to process these rows efficiently. and process them in parallel for optimum performance. there is extra processing required for Child records. you should break down your records into batch size. for more information. First. and each item is assigned to four organizations. Otherwise. try loading 2. For example. create separate history tables and move processed rows there. If you wish to maintain history.000 items into interface tables. For a greater number of records. If importing a large number of records. AUTO_CHILD (transaction_type within the MTL_SYSTEM_ ITEMS_INTERFACE table) records in the interface table. then the Item Interface will process the 100 populated records. Running the Item Interface in Update Mode A proper batch size when running the Item Interface in Update mode is approximately five times smaller than when running the Item Interface in Create mode.

Each error in the interface errors table has a value for the MESSAGE_NAME and REQUEST_ID columns. and unit of measure conversions tables. You should resolve errors in the sequence that they were found by the interface. the sequence of errors can be determined by examining UNIQUE_ID for a given TRANSACTION_ID. several conditions that previously caused the Interface to error all rows have been modified so that only the offending row is marked in error. in increasing order of UNIQUE_ID for any TRANSACTION_ID. the interface inserts these rows into the item master. item revisions. if a row in the item interface table fails. while the remaining rows process normally. then you can see which error occurred first by looking at the row with the smallest UNIQUE_ID for TRANSACTION_ID 2000. Depending on the item information you import. The Item Interface inserts validated rows into the production tables in Oracle Inventory and Oracle Cost Management. the program inserts a row into the interface errors table with the failed row’s TRANSACTION_ID as the error row’s TRANSACTION_ID. The Item Interface populates these columns for item detail errors the same way it populates the table for item errors. Thus. the PROCESS_FLAG column for all remaining rows is set to 4 (Import failed) and the Concurrent Item Interface inserts a row in the interface errors table. resolving the first few errors and restarting the Item Interface will cause the other (spurious) errors for that failed row to disappear. for a given row.Open Item Interface the TRANSACTION_ID value from the corresponding item interface table. that is. Since all rows in the interface tables have a value for PROCESS_FLAG. For example. For example. 7-62 Oracle Manufacturing APIs and Open Interfaces Manual . The UNIQUE_ID column in MTL_INTERFACE_ERRORS is populated from the sequence MTL_SYSTEM_ITEMS_INTERFACE_S. item categories. pending item status. if your row with TRANSACTION_ID 2000 failed with two errors in the MTL_INTERFACE_ERRORS table. If a row cannot be inserted into one of these tables. Reviewing Failed Rows You can review and report rows in any of the interface tables using SQL*Plus or any custom reports you develop. However. The program handles these processing errors in the same way it handles validation errors. cost details. Quite often. you can identify records that have not been successfully imported into Oracle Inventory. item costs.

and MIRI4. MICI3. you must first fix the row corresponding to the error with the appropriate value. Then reset PROCESS_FLAG = 1. and TRANSACTION_ID = null. 3. 2. Table 7–15 PROCESS _FLAG 1 2 3 Oracle Inventory Item Details Interface Error After and Before PROCESS_FLAG 1 and 2 2 and 3 2 and 3 Relaunch the Item Interface after Fixing the Oracle Error Fixing the Oracle Error Updating MSII1 and fixing the corresponding error in MIE2. Then resubmit the row for reprocessing. This could be at PROCESS_FLAG = 1. or 4. rows can error out either due to validation (indicated by PROCESS_FLAG = 3 in MTL_SYSTEM_ITEMS_INTERFACE and the corresponding error in MTL_INTERFACE_ERRORS) or due to an Oracle Error. When an Oracle Error is encountered. the processing is stopped and everything is rolled back to the previous save point. Then setting PROCESS_FLAG = 1 and INVENTORY_ ITEM_ID = null in MSII1. Multi-Thread Capability (Parallel Runs of the Item Interface) The following tables have a NOT NULL NUMBER column called SET_PROCESS_ ID: s MTL_SYSTEM_ITEMS_INTERFACE Oracle Inventory Open Interfaces and APIs 7-63 .Open Item Interface Resubmitting an Errored Row During Item Interface processing. INVENTORY_ITEM_ID = null. Fixing the Oracle Error 4 4 and 7 Notes: 1 MTL_SYSTEM_ITEMS_INTERFACE 2 MTL_INTERFACE_ERRORS 3 MTL_ITEM_CATEGORIES_INTERFACE 4 MTL_ITEM_REVISIONS_INTERFACE When you encounter rows errored out due to validations.

Open Item Interface s MTL_ITEM_REVISIONS_INTERFACE MTL_ITEM_CATEGORIES_INTERFACE s The SET_PROCESS_ID column has a database default value of zero in the three tables above. It is a good idea to divide your records into roughly equal batch sizes. you must modify them to include the SET_PROCESS_ID column. specify the Process Set for a given run in the Process Set parameter. The four Item Interface processes run in parallel. then that interface record is not processed. the SET_PROCESS_ID column for records in the interface tables has to be populated with a positive. You should assign all organization records of the same item to the same set_ process_id. and so on. nonzero number. To have parallel runs of the Item Interface. each working on the set you specified. populate the first 250 records with SET_PROCESS_ID = 1. Also remember that any corresponding records that you enter in the MTL_ITEM_ REVISIONS_INTERFACE table should have the matching SET_ PROCESS_ID values. and you decide to have four parallel Item Interface processes to accomplish this task. you can enter any SET_PROCESS_ID between one and 2. 2. 7-64 Oracle Manufacturing APIs and Open Interfaces Manual .647. If you enter a value greater than this. This initiates four Item Interface concurrent programs with the Process Set parameter set to 1.147. Example: You have 1000 records in the MTL_SYSTEM_ITEMS_INTERFACE table that you want to insert into MTL_SYSTEM_ITEMS. From the Item Interface SRS launch form. the next 250 records with SET_PROCESS_ID = 2. In the scripts you use to insert data into the MTL_SYSTEM_ITEMS_INTERFACE table.483. and 4 respectively. 3. Note: If you have custom scripts to insert data into the MTL_ SYSTEM_ITEMS_INTERFACE table.

s s s Not following these rules will cause multiple Item Interface processes trying to work on the same set of rows and lead to unpredictable errors. All processes must access the same tables. Note: Using the System Administrator Responsibility. as your records run in Update mode. the request can be modified to launch a greater or lesser number of parallel processes. within the Inventory Responsibility. The SET_PROCESS_ID column will get the default value of zero. the interface processes all rows (regardless of the SET_PROCESS_ID value) as it did in earlier releases. Do not create an enormous number of parallel processes.Open Item Interface Note: Leaving a null in the Process Set parameter will process all rows regardless of the process set value. Do not have parallel runs of the Item Interface on the same process set. This request can be accessed via the Item Reports and All Reports menu options. depending on the parameter settings. this request calls INCOIN with five parallel sessions. If you do not want the new multi-thread capability. Do not use the same set_process_id for your records run in Create mode. you can populate the interface tables as you always have. The request will launch five INCOIN processes in parallel that either Create or Update items. Multi-threading Rules The Applications DBA for the site should enforce these rules: s If you run an Item Interface process with the Process Set value null. The parameters default in as follows: Oracle Inventory Open Interfaces and APIs 7-65 . increasing the number of processes will not always increase throughput. Concurrent Requests Used To Facilitate Parallel Processing Use the Import Items request to facilitate parallel processing. (Navigator > Request > Set) When run in Create mode. you should not concurrently run any other Item Interface processes. When you run the Item Interface with the Process Set parameter blank.

Open Item Interface Parameters All Organizations Yes Validate Items Yes Process Items Yes Delete Processed Rows Yes Process Set 101. 205 Create or Update Items 2 7-66 Oracle Manufacturing APIs and Open Interfaces Manual . this request calls INCOIN with five parallel sessions. 102. 202. 203. 105 Create or Update Items 1 When run in Update mode. The parameters default in as follows: Default Parameters All Organizations Yes Validate Items Yes Process Items Yes Delete Processed Rows Yes Process Set 201. 103. 104. 204.

Open Item Interface Oracle Inventory Open Interfaces and APIs 7-67 .

You create a 7-68 Oracle Manufacturing APIs and Open Interfaces Manual .Customer Item and Customer Item Cross-Reference Open Interfaces Customer Item and Customer Item Cross-Reference Open Interfaces A number of manufacturing industries are characterized by a multi-tiered.Customer Item Interface The Customer Item Interface lets you import customer items into Oracle Inventory. you can provide Master and Detail Container information. See: Defining Customer Items. For each customer item you must define related information such as the Customer and Item Definition Level. You can import customer items and customer item cross-references from any legacy system into Oracle Inventory using the Customer Item Interface and the Customer Item Cross-Reference Interface. By cross-referencing customer items with their own inventory items. Suppliers must be able to react quickly to their customers’ often changing requirements. These interfaces validate all data that you import into Oracle Inventory. Customer Address is required if you set Item Definition Level 3 while Customer Category is required for Item Definition Level 2. Oracle Inventory User’s Guide. Validation of the customer items uses the same rules as the Customer Items window to ensure that only valid items are imported. For each customer item cross-reference. just-in-time supply chain structure. acceptable values. you run the Customer Item Interface. and Rank. The Customer Item Interface reads each record from the interface table and adds items that are successfully validated to the MTL_ CUSTOMER_ITEMS table. Model Items and other attributes such as Demand Tolerances and Departure Planning Flags for each customer item. After you add new customer items to the MTL_CI_INTERFACE table. you must define the Customer. suppliers can achieve faster order processing and shipments by allowing customers to place orders using customer item numbers. and value ranges. They also perform foreign key validation and check for attribute inter-dependencies.Customer Item Cross-Reference Interface The Customer Item Cross-Reference Interface lets you import cross-references between customer items and existing Oracle Inventory items into your Master organization. Customer Item. The interfaces ensure that the imported customer items and cross-references contain the same detail as items entered manually using the Customer Items and Customer Item Cross-References windows. Functional Overview . Commodity Codes. Customer Item Definition Level. Today’s manufacturing environment requires a close working relationship between customers and suppliers along the entire supply chain. Error codes and corresponding error messages for all errors detected during validation are written to the interface tables. In addition. Functional Overview .

Attention: The Customer Item Interface must be run successfully before the Customer Item Cross-Reference Interface. Cross references are defined at the Master Organization level of the cross-referenced inventory item. All menu in Oracle Inventory.Customer Item and Customer Item Cross-Reference Open Interfaces cross-reference to the associated Oracle Inventory item by specifying the item and its Master Organization. Validation of the customer items cross-references uses the same rules as the Customer Item Cross-References window to ensure that only valid cross-references are imported. and then import the new customer items and customer item cross-references. Oracle Inventory User’s Guide and Importing Customer Item Cross-References. Oracle Oracle Inventory Open Interfaces and APIs 7-69 .Customer Item Interface and Customer Item Cross-Reference Interface Before you use the Customer Item and Customer Item Cross-Reference Interfaces. Once a customer item cross-reference to an Inventory item has been defined. validate data you include. Then the Customer Item Cross-Reference Interface validates each record and moves the successfully validated items to the MTL_CUSTOMER_ ITEM_XREFS table. you must write and run custom programs that extract customer item and customer item cross-reference information from your source system and insert it into the MTL_CI_INTERFACE and MTL_CI_XREFS_INTERFACE tables. Interface Runtime Options You can access the Customer Item and Customer Item Cross-Reference Interfaces via the Reports. you run the Customer Item and Customer Item Cross-Reference Interfaces to import the data. Workflow . You can create multiple cross-references between customer items and one Oracle Inventory item. You first add the customer item cross-reference records to the MTL_CI_XREFS_ INTERFACE table. This is to ensure that a customer item has been defined before an attempt is made to cross-reference it with an Oracle Inventory item. The Customer Item Cross-Reference Interface errors out if an attempt is made to create a cross-reference to an invalid inventory item. You can also create multiple cross-references between Oracle Inventory items and one customer item. it is applicable to all organizations assigned the cross-referenced Inventory Item. (See: Importing Customer Items. These interfaces assign defaults. After you load the customer items and customer item cross-references into these interface tables.

For all errors encountered during validation of records in the Customer Item Interface or Customer Item Cross-Reference Interface. Records that were successfully validated are transferred to the MTL_CUSTOMER_ITEMS and MTL_CUSTOMER_ITEM_XREFS tables.Successfully validated records in the Customer Item Interface are copied over to the MTL_CUSTOMER_ITEMS table and automatically deleted from the MTL_ CI_INTERFACE table. Abort on Error Valid values for this option are Yes or No. The default is Yes.) Both Interfaces offer two options at runtime: Abort on Error and Delete Successful Records.Customer Item and Customer Item Cross-Reference Open Interfaces Inventory User’s Guide.Both the Customer Item Interface and the Customer Item Cross-Reference Interface will abort execution if an error is encountered during validation of a record. for the Customer Item Cross-Reference Interface. No . Records that were successfully validated are transferred to the MTL_CUSTOMER_ITEMS and MTL_ CUSTOMER_ITEM_XREFS tables.Processing of the records in the Interface tables continues until the end of the table is reached. the ERROR_ CODE and the ERROR_EXPLANATION columns in the MTL_CI_INTERFACE and MTL_CI_XREFS_INTERFACE tables are populated with the appropriate error code and error description. The ERROR_CODE and ERROR_ EXPLANATION columns in the MTL_CI_INTERFACE and MTL_CI_XREFS_ INTERFACE tables are populated with the appropriate error code and error explanation for the record that caused the Interface to error out. respectively. 7-70 Oracle Manufacturing APIs and Open Interfaces Manual . No additional records will be processed. Similarly. the Customer Item Interface and Customer Item Cross-Reference Interface simply populate the MTL_CUSTOMER_ITEMS and MTL_CUSTOMER_ITEM_XREFS tables without deleting records from the interface tables.For successfully validated records. Yes . Delete Successful Records Valid values for this option are Yes or No. No . Yes . respectively. successfully validated records are copied to the MTL_CUSTOMER_ITEM_XREFS table and automatically deleted from the MTL_CI_XREFS_INTERFACE table. The default is No.

includes all the columns in the Customer Items table. Note: Information about columns that need to be populated for audit trail and maintenance purposes can be found in the Table Administration and Audit Trail section. Oracle Inventory Technical Reference Manual.Customer Item and Customer Item Cross-Reference Open Interfaces Customer Item Interface Table Table Description The Customer Item Interface table. Table 7–16 Field Name PROCESS_FLAG PROCESS_MODE LAST_UPDATED_BY LAST_UPDATE_DATE LAST_UPDATE_LOGIN CREATED_BY CREATION_DATE REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE TRANSACTION_TYPE CUSTOMER_NAME CUSTOMER_NUMBER CUSTOMER_ID List of Columns. see Table and View Definitions. The columns are discussed after the table. See: Cycle Count Entries Interface on page 7-83. For information about columns not discussed in the Interface manual. MTL_CI_INTERFACE. Customer Item Interface Type Varchar2(1) Number Number Date Number Number Date Number Number Number Date Varchar2(6) Varchar2(50) Varchar2(30) Number x Conditionally Conditionally Conditionally x x Required x x x x Oracle Inventory Open Interfaces and APIs 7-71 . MTL_CUSTOMER_ITEMS.

Customer Item and Customer Item Cross-Reference Open Interfaces Table 7–16 Field Name List of Columns. Customer Item Interface Type Varchar2(30) Varchar2(80) Varchar2(240) Varchar2(240) Varchar2(240) Varchar2(240) Varchar2(50) Varchar2(50) Varchar2(50) Varchar2(50) Varchar2(30) Number Varchar2(50) Varchar2(240) Varchar2(1) Varchar2(30) Varchar2(50) Number Varchar2(30) Number Varchar2(40) Varchar2(2000) Number Varchar2(60) Varchar2(3) Number Varchar2(40) Conditionally Conditionally Required Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally x CUSTOMER_CATEGORY_CODE CUSTOMER_CATEGORY ADDRESS1 ADDRESS2 ADDRESS3 ADDRESS4 CITY STATE COUNTY COUNTRY POSTAL_CODE ADDRESS_ID CUSTOMER_ITEM_NUMBER CUSTOMER_ITEM_DESC ITEM_DEFINITION_LEVEL ITEM_DEFINITION_LEVEL_DESC MODEL_CUSTOMER_ITEM_NUMBER MODEL_CUSTOMER_ITEM_ID COMMODITY_CODE COMMODITY_CODE_ID MASTER_CONTAINER_SEGMENTn MASTER_CONTAINER MASTER_CONTAINER_ITEM_ID CONTAINER_ITEM_ORG_NAME CONTAINER_ITEM_ORG_CODE CONTAINER_ITEM_ORG_ID DETAIL_CONTAINER_SEGMENTn 7-72 Oracle Manufacturing APIs and Open Interfaces Manual .

Defining a Unique Customer Item You must define a unique record in each row of the MTL_CI_INTERFACE table. Customer Item To create a unique Customer Item record in the MTL_CI_INTERFACE table.Customer Item and Customer Item Cross-Reference Open Interfaces Table 7–16 Field Name List of Columns. Customer You define a customer by populating either of the CUSTOMER_NAME. you must define a Customer Item number and Customer Item Description in the CUSTOMER_ITEM_NUMBER and CUSTOMER_ITEM_DESC fields respectively. Category Code. CUSTOMER_NUMBER. and Item Definition Level for each record. To create a unique record in the MTL_CI_INTERFACE table. Note that at least one of these Oracle Inventory Open Interfaces and APIs 7-73 . Customer Item Interface Type Varchar2(2000) Number Number Varchar2(1) Varchar2(1) Varchar2(1) Varchar2(30) Varchar2(150) Number Number Varchar2(9) Varchar2(2000) x Required DETAIL_CONTAINER DETAIL_CONTAINER_ITEM_ID MIN_FILL_PERCENTAGE DEP_PLAN_REQUIRED_FLAG DEP_PLAN_PRIOR_BLD_FLAG INACTIVE_FLAG ATTRIBUTE_CATEGORY ATTRIBUTEn DEMAND_TOLERANCE_POSITIVE DEMAND_TOLERANCE_NEGATIVE ERROR_CODE ERROR_EXPLANATION Customer Item Interface . you must define a Customer Item and the associated Customer. The CUSTOMER_ITEM_NUMBER is a required field and is sufficient by itself for validation. However. Address. or CUSTOMER_ID fields. it is strongly recommended that the CUSTOMER_ITEM_ DESC field be populated with accurate information to clearly identify customer items by their description.

ADDRESS3. You must enter the detail customer address information. However. COUNTRY and POSTAL_CODE. CITY. The customer address you enter must exactly match the information in the RA_ ADDRESSES table for successful validation. Address Category information is required if Item Definition Level is set to 2 or Item Definition Level Description is set to "Address Category. The Interface will error out with the appropriate error code if the customer information cannot be validated.” Any information entered in these fields is validated against the RA_ADDRESSES table. including any blank spaces. 7-74 Oracle Manufacturing APIs and Open Interfaces Manual . COUNTY. then only the data in the highest priority field is used for validation according to the following rules of precedence: s CUSTOMER_ID has priority over CUSTOMER_NUMBER. including the street address (ADDRESS1. these are conditionally required fields and may be Null. special characters and capitalized alphabets. This is also validated against the RA_ADDRESSES table.Customer Item and Customer Item Cross-Reference Open Interfaces fields must be entered for validation. STATE. Alternatively. The Address Category can be defined in the Interface tables by populating either one of the CUSTOMER_CATEGORY_CODE or the CUSTOMER_CATEGORY fields. ADDRESS4). only data in the highest priority field is used for validation against the RA_ADDRESSES table according to the following rule of precedence: s CUSTOMER_CATEGORY_CODE has precedence over CUSTOMER_ CATEGORY. s Address Category Address Category is a grouping of multiple customer ship-to addresses that have been defined in the RA_ADDRESSES table. This grouping is based on functional rules specific to your business and allows you to select multiple customer addresses by specifying the Address Category. and detail customer address information is picked up from this table for successful validation. CUSTOMER_NUMBER has priority over CUSTOMER_NAME. exactly as it is entered in Oracle’s RA_ADDRESSES table. you can enter the customer’s ADDRESS_ID. The information provided in these fields is validated against the Oracle table RA_CUSTOMERS. If more than one field is populated to identify a customer. If both fields are populated to define an Address Category. Customer Address You can define the Customer Address information by entering either the detail customer address or the customer ADDRESS_ID. ADDRESS2.

You can define a customer item at the Address level if you ship the item to only one ship-to site for a customer. you must first reference the customer item to a valid Oracle model item. Oracle Inventory User’s Oracle Inventory Open Interfaces and APIs 7-75 .Other fields Transaction_Type TRANSACTION_TYPE is a required field. Address Category level or Address level. Address Category. Customer Item Definition Level A customer item can be defined at one of three different levels: Customer level. which has the BOM Item Type attribute set to Model. Model items You can define a customer item as a model item that can be referenced by other customer items. You must define the Customer Item Definition Level by populating either the ITEM_DEFINITION_LEVEL or the ITEM_DEFINITION_LEVEL_DESC column. if you ship an item to multiple customer ship-to sites that have been grouped as an Address Category.Customer Item and Customer Item Cross-Reference Open Interfaces Customer Address information is required if the Item Definition Level is set to 3 or the Item Definition Level Description is set to Address. and Address respectively. then only data in the highest priority field is used for validation according to the following rule of precedence: s ITEM_DEFINITION_LEVEL has higher priority than the ITEM_DEFINITION_ LEVEL_DESC Customer Item Interface . you can define the customer item for that specific Address Category. Always set the TRANSACTION_TYPE to CREATE to create a new item in the MTL_CUSTOMER_ITEMS table. (See: Bills of Material Attribute Group. This is the only value supported currently by this interface. However. In order to define a model customer item. or 3. A customer item defined at the Customer level is recognized across all Addresses and Address Categories for that customer. The corresponding values for ITEM_DEFINITION_LEVEL_DESC are seeded in the MFG_LOOKUPS table and are Customer. The interface will error out if a required field is missing or contains invalid data. If both the fields are populated to identify the Item Definition Level. 2. Valid values for the ITEM_DEFINITION_LEVEL are 1.

or errors out if the Abort on Error option is set to Yes. Commodity Codes Commodity codes are used to group customer items in much the same fashion as the use of category codes to group inventory items. You can define a model customer item by either specifying the MODEL_ CUSTOMER_ITEM_ID or the MODEL_CUSTOMER_ITEM_NUMBER. the base model customer item must precede any Customer items that reference it. Any information in MODEL_CUSTOMER_ITEM_NUMBER is completely ignored in this case. The Interface performs validation starting with the first record in MTL_CI_ INTERFACE until it reaches the end of the table. of a larger outer unit. or the inner container. The base model customer item must be validated successfully before other model customer items can be created that reference it.Customer Item and Customer Item Cross-Reference Open Interfaces Guide. you can reference other customer items to it. are applicable to all organizations belonging to the Master Organization. For example. Container items can be defined by setting the Container item attribute to Yes. Oracle Inventory User’s Guide. while a pallet can be its master container. If both the fields are specified. You must define the Commodity code by specifying either the COMMODITY_ CODE or the COMMODITY_CODE_ID for each Customer Item. 7-76 Oracle Manufacturing APIs and Open Interfaces Manual . The business functionality and meaning of these codes are user-defined. the master container. after the MTL_CUSTOMER_ ITEMS table has been successfully populated.) Once a model customer item has been defined successfully. commodity codes can be used to query up all customer items that belong to a specific commodity code. otherwise the Interface will error out. If both fields are populated to define a commodity code. a box can be a detail container for a customer item. Commodity Codes are defined at the Master Organization level in Oracle Inventory and thus. only data in the highest priority field is used for validation according to the following rule of precedence: s COMMODITY_CODE_ID has higher priority than the COMMODITY_CODE Containers A container item could be a pallet. bag or any other inventory item that needs to be tracked between a customer and a supplier. For example. box. See: Physical Attribute Group. in the MTL_CI_INTERFACE table. then MODEL_CUSTOMER_ITEM_ID has precedence over MODEL_CUSTOMER_ITEM_NUMBER for validation. Thus. A detail container is a subunit. In the Customer Item Interface. you set the default master or detail container for a customer item.

ensure that the segment values you populate correspond to the key flexfield segments that you defined for your items. Warning: If you enter values for SEGMENTn columns. Alternatively. MASTER_CONTAINER has priority over SEGMENTn values. that should be filled by the detail. or outer container. The Minimum Fill Percentage item attribute defines the minimum percentage of the master. you can use the MASTER_CONTAINER_SEGMENTn field to specify a multi-segment container. or Oracle Inventory Open Interfaces and APIs 7-77 . The interface will error out with the appropriate error code if no master organization is specified for a master container or if no master container is specified for a detail container. s Similarly. Similarly. a detail container can be defined by populating either the DETAIL_ CONTAINER. You can also specify the MIN_FILL_PERCENTAGE attribute when you define the master container. The same rules of precedence apply as for master container above. then only data in the highest priority field is used for validation according to the following rules of precedence: s MASTER_CONTAINER_ITEM_ID has priority over MASTER_CONTAINER. The interface assumes that you are using segments in sequential order beginning with SEGMENT1. You must specify the master organization for each master container in the Customer Item Interface. If more than one field is populated to identify a master container. DETAIL_CONTAINER_ITEM_ID or the SEGMENTn values for the descriptive flexfield. Warning: The interface derives each item’s segment values by searching for the segment separator to indicate the end of one segment value and the start of the next segment value.Customer Item and Customer Item Cross-Reference Open Interfaces Containers are defined at the master organization level in Oracle Inventory. you must specify the master container for each detail container. A master container can be defined by populating either the MASTER_CONTAINER or the MASTER_CONTAINER_ITEM_ID fields. Include the appropriate segment separator when populating the MASTER_CONTAINER or DETAIL_CONTAINER fields for a multi-segment key flexfield.

The DEP_PLAN_PRIOR_BLD_FLAG is used to indicate that Departure Planning is required before building this item.ATTRIBUTE15 columns are used for the descriptive flexfield information. 7-78 Oracle Manufacturing APIs and Open Interfaces Manual . Descriptive Flex. the Customer Item is considered as status Inactive in Oracle Inventory. See: Physical Attribute Group. No range validation is performed for the first order of an item since no history information exists in the demand tables. Note that the interface does not perform any validation on the SEGMENTn fields even though you may have defined a valid value set for the descriptive flexfield. Inactive_Flag INACTIVE_FLAG is a required field and can be set to 1 for Yes or 2 for No. If the DEP_ PLAN_PRIOR_BLD_FLAG is Yes. You can set the INACTIVE_FLAG to Yes to deactivate a customer item in Oracle Inventory. then the DEP_PLAN_REQUIRED_FLAG must also be set to Yes. This range is based on a customer’s last order for the same item. Demand Tolerance Range The DEMAND_TOLERANCE_POSITIVE and DEMAND_TOLERANCE_ NEGATIVE fields are used to define the percentage range within which the order quantities for a customer item are acceptable. and to draw your attention towards substantial changes in order volume activity from a customer. If a customer order falls outside the range defined by these fields then the demand processor will raise an exception to that order.Customer Item and Customer Item Cross-Reference Open Interfaces inner container. This feature is designed to flag any order entry or EDI transfer errors.SEGMENTn The ATTRIBUTE_CATEGORY and ATTRIBUTE1 . The DEP_PLAN_REQUIRED_FLAG is used to signal Oracle Shipping to perform Departure Planning for this item. before the master container can be shipped. However. Oracle Inventory User’s Guide. The customer item information is still carried over from MTL_CI_INTERFACE to the MTL_CUSTOMER_ITEMS table if the record is successfully validated. Departure Planning Flags The DEP_PLAN_REQUIRED_FLAG and DEP_PLAN_PRIOR_BLD_FLAG fields can have the values of 1 for Yes and 2 for No.

Note that the interface overwrites any data already in these fields. MTL_ CUSTOMER_ITEM_XREFS. Address and Item Definition Level are subject to the same rules and definitions as those described for the Customer Item Interface table. then the error codes and the corresponding error description are written to the ERROR_CODE and the ERROR_ EXPLANATION columns respectively. ERROR_CODE and ERROR_ EXPLANATION.Customer Item and Customer Item Cross-Reference Open Interfaces Error Codes If any errors are found during validation. See: Cycle Count Entries Interface on page 7-83. Customer Item Cross-Reference Interface Table Table Description The Customer Item Cross-Reference Interface table. MTL_CI_XREFS_INTERFACE. and TRANSACTION_TYPE columns. You can also refer to the previous section for explanation of Descriptive Flexfields. see Table and View Definitions. INACTIVE FLAG. Many columns in the Customer Item Cross-Reference Interface table are similar to columns in the Customer Item Interface table. PROCESS_FLAG and PROCESS_MODE. Oracle Inventory Open Interfaces and APIs 7-79 . Note: Information about columns that need to be populated for audit trail and maintenance purposes can be found in the Table Administration and Audit Trail section. Customer Category. Columns that identify the Customer. contains all the columns in the Customer Item Cross-Reference table. Note: For information about columns not discussed in the Interface manual. Record Status The PROCESS_FLAG and PROCESS_MODE columns report the status of the record after the import and validation process is complete. Data already in these columns is ignored and overwritten if necessary. See: Customer Item Interface Table on page 7-71. Oracle Inventory Technical Reference Manual. Note that these are required columns and should be populated with 1.

Customer Item Cross-Reference Interface Type Varchar2(1) Number Date Number(15) Date Number(15) Number(15) Number(15) Number(15) Number(15) Date Varchar2(6) Varchar2(50) Varchar2(30) Number Varchar2(30) Varchar2(80) Varchar2(240) Varchar2(240) Varchar2(240) Varchar2(240) Varchar2(50) Varchar2(50) Varchar2(50) Varchar2(50) x Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Required x x x x x x Derived Optional 7-80 Oracle Manufacturing APIs and Open Interfaces Manual . and Rank in the MTL_CI_XREFS_INTERFACE table.Customer Item and Customer Item Cross-Reference Open Interfaces This section provides an explanation of fields used to define the Inventory Item. Master Organization. Table 7–17 Field Name PROCESS_FLAG PROCESS_MODE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE TRANSACTION_TYPE CUSTOMER_NAME CUSTOMER_NUMBER CUSTOMER_ID CUSTOMER_CATEGORY_CODE CUSTOMER_CATEGORY ADDRESS1 ADDRESS2 ADDRESS3 ADDRESS4 CITY STATE COUNTY COUNTRY List of Columns.

Oracle Inventory Open Interfaces and APIs 7-81 . Alternatively. The inventory item is validated against the MTL_SYSTEM_ITEMS table for the specified Master Organization. you can define an inventory item by specifying the SEGMENTn values of the item key flexfield for a multi-segment item. Customer Item Cross-Reference Interface Type Varchar2(30) Number Varchar2(50) Number Varchar2(30) Varchar2(1) Varchar2(40) Varchar2(2000) Number Varchar2(60) Varchar2(3) Number Number Varchar2(1) Varchar2(30) Varchar2(150) Varchar2(9) Varchar2(2000) Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally Conditionally x x Required Conditionally Conditionally x Derived Optional POSTAL_CODE ADDRESS_ID CUSTOMER_ITEM_NUMBER CUSTOMER_ITEM_ID ITEM_DEFINITION_LEVEL_DESC ITEM_DEFINITION_LEVEL INVENTORY_ITEM_SEGMENTn INVENTORY_ITEM INVENTORY_ITEM_ID MASTER_ORGANIZATION_NAME MASTER_ORGANIZATION_CODE MASTER_ORGANIZATION_ID PREFERENCE_NUMBER INACTIVE_FLAG ATTRIBUTE_CATEGORY ATTRIBUTEn ERROR_CODE ERROR_EXPLANATION Inventory Item You must define a valid inventory item for each customer item to define a successful cross-reference relationship. You can define an inventory item by specifying either the INVENTORY_ITEM or the INVENTORY_ITEM_ID.Customer Item and Customer Item Cross-Reference Open Interfaces Table 7–17 Field Name List of Columns. The interface errors out with the appropriate error code if an invalid inventory item is specified. The inventory item must be a valid item in the Master Organization for which the cross-reference is being defined.

then only data in the highest priority field is used for validation according to the following rules of precedence: s INVENTORY_ITEM_ID has priority over INVENTORY_ITEM.Customer Item and Customer Item Cross-Reference Open Interfaces If more than one field is populated to identify an inventory item. inventory items for a customer item. The top ranked Inventory item is processed before a lower ranked item in the supplying organization. INVENTORY_ITEM has priority over SEGMENTn values. This is a required field and must be entered. s Master Organization For each inventory item in the Customer Item Cross-Reference table. In this case. The interface errors out with the appropriate error code if an invalid Master Organization is specified. You can define a Master Organization by specifying either the MASTER_ ORGANIZATION_ID or the MASTER_ORGANIZATION_CODE of the organization. You must specify the Rank of the cross-referenced relationship for each cross-reference that you define. then MASTER_ORGANIZATION_ID has precedence over MASTER_ORGANIZATION_CODE. If both fields are specified. Rank You can define multiple references between a customer item and several inventory items. This can be used to define alternate. a preference ranking is established to determine the item that must be processed in Oracle Inventory when a customer item is demanded. you must also specify the Master Organization for which the cross-reference is being defined. Thus. or substitute. 7-82 Oracle Manufacturing APIs and Open Interfaces Manual . an Inventory item with a rank of 1 will be processed before another item with a rank of 2 that references the same Customer Item.

see Table and View Definitions. Oracle Inventory Technical Reference Manual. The Interface offers the following options at runtime: s Cycle Count Name Number of Workers Commit Point Error Report Level Delete Successful Records s s s s Cycle Count Entries Interface Table Table Description The Cycle Count Entries Interface table. Note: For information about columns not discussed in the Interface manual. This interface validates all data that you import into Oracle Inventory. Note: Information about columns that need to be populated for audit trail and maintenance purposes can be found in the Table Administration and Audit Trail section. It also performs foreign key validation and checks for attribute inter-dependencies. Interface Runtime Options You can access the Cycle Count Entries Interface via the Reports. All menu in Oracle Inventory. Errors detected during validation are written to the Cycle Count Interface Errors table. MTL_CC_ENTRIES_INTERFACE. The interface ensures that the imported cycle count entries contain the same detail as items entered manually using the Cycle Count Entries window. Oracle Inventory Open Interfaces and APIs 7-83 .Cycle Count Entries Interface Cycle Count Entries Interface You can import cycle count entries from an external system into Oracle Inventory using the Cycle Count Entries Interface. See: Table Administration and Audit Trail on page 7-87. acceptable values. and value ranges. MTL_CYCLE_COUNT_ENTRIES. includes all the columns in the Cycle Count Entries table.

Cycle Count Entries Interface Type Number Number Date Number Date Number Number Number Number Number Number Varchar2(30) Number Number Varchar2(40) Varchar2(3) Varchar2(10) Number Varchar2(40) Varchar2(30) Varchar2(30) Number Varchar2(3) Varchar2(25) Number Number Number Null N N N N N N Y Y Y N Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y CC_ENTRY_INTERFACE_ID ORGANIZATION_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN CC_ENTRY_INTERFACE_GROUP_ID CYCLE_COUNT_ENTRY_ID ACTION_CODE CYCLE_COUNT_HEADER_ID CYCLE_COUNT_HEADER_NAME COUNT_LIST_SEQUENCE INVENTORY_ITEM_ID ITEM_SEGMENT1-20 REVISION SUBINVENTORY LOCATOR_ID LOCATOR_SEGMENT1-20 LOT_NUMBER SERIAL_NUMBER PRIMARY_UOM_QUANTITY COUNT_UOM COUNT_UNIT_OF_MEASURE COUNT_QUANTITY SYSTEM_QUANTITY ADJUSTMENT_ACCOUNT_ID 7-84 Oracle Manufacturing APIs and Open Interfaces Manual .Cycle Count Entries Interface Table 7–18 Field Name List of Columns.

Cycle Count Entries Interface Table 7–18 Field Name List of Columns. Cycle Count Entries Interface Type Varchar2(25) Date Number Varchar2(240) Varchar2(240) Number Varchar2(30) Number Number Number Date Number Number Number Number Number Number Number Varchar2(30) Varchar2(150) Number Number Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Y Null Y Y Y Y ACCOUNT_SEGMENT1-30 COUNT_DATE EMPLOYEE_ID EMPLOYEE_FULL_NAME REFERENCE TRANSACTION_REASON_ID TRANSACTION_REASON REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE LOCK_FLAG PROCESS_FLAG PROCESS_MODE VALID_FLAG DELETE_FLAG STATUS_FLAG ERROR_FLAG ATTRIBUTE_CATEGORY ATTRIBUTE1-15 PROJECT_ID TASK_ID Oracle Inventory Open Interfaces and APIs 7-85 .

Oracle Inventory Technical Reference Manual. Note: Information about columns that need to be populated for audit trail and maintenance purposes can be found in the Table Administration and Audit Trail section. is populated with errors encountered while processing interface rows. See: Cycle Count Entries Interface on page 7-83. MTL_CC_INTERFACE_ERRORS.Cycle Count Entries Interface Cycle Count Interface Errors Table Table Description The Cycle Count Interface Errors table. see Table and View Definitions. Note: For information about columns not discussed in the Interface manual. This table provides for the reporting of multiple errors for each interface record. 7-86 Oracle Manufacturing APIs and Open Interfaces Manual .

This is a required field. Populate this field according to your organization’s s s Oracle Inventory Open Interfaces and APIs 7-87 . CREATION_DATE contains the date on which a particular customer item record was created. Use the SQL function SYSDATE in this column to automatically record the current system date when the record is updated. s LAST_UPDATE_DATE should contain the date on which the record was last updated.Cycle Count Entries Interface Table 7–19 Field Name List of Columns. This section explains the purpose of these Standard Who columns. LAST_UPDATED_BY field is populated with the user identification number of the person updating the customer item tables. Cycle Count Interface Errors Type Number Number Date Number Date Number Number Number Number Number Date Varchar2(240) Varchar2(32) Varchar2(30) Varchar2(30) Null N N N N N N Y Y Y Y Y Y Y Y Y INTERFACE_ERROR_ID CC_ENTRY_INTERFACE_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE ERROR_MESSAGE ERROR_COLUMN_NAME ERROR_TABLE_NAME MESSAGE_NAME Table Administration and Audit Trail Some columns in the Interface tables are required for audit trail maintenance and table administration data. This is a required field. Follow your organization’s convention for the user identification number to populate this field.

PROGRAM_ID is the program identifier of the last record to affect the record. This is not a required field and can be Null. LAST_UPDATE_LOGIN is not a required field. s CREATED_BY contains the user identification number of the person who originally created this customer item record. This is a required field. This is not a required field and can be Null. PROGRAM_APPLICATION_ID is the application identifier of the owner of the program to last affect that record. This field is currently not being used and should be populated with -1. This is not a required field and can be Null. This is a required field. Follow your organization’s convention for generating user identification numbers to populate this field if this information is not available from the legacy system. This is not a required field and can be Null. s s s s s 7-88 Oracle Manufacturing APIs and Open Interfaces Manual .Cycle Count Entries Interface convention if this information is not available from the legacy system. REQUEST_ID is the concurrent request identifier of the last concurrent program to affect that record. PROGRAM_UPDATE_DATE is the last date on which a program updated that record.

p_init_msg_list Requests that the API initialize the message list on your behalf. The Cycle Count API includes the public procedure import_countrequest. The values are: Oracle Inventory Open Interfaces and APIs 7-89 . This API takes a cycle count interface row that has been passed through the p_interface_rec parameter and processes it based on the values of the parameter fields.GET. IMPORT_COUNTREQUEST Table 7–20 Parameter p_api_version_ number p_init_msg_list p_commit p_validation_level x_return_status x_msg_count x_msg_data p_interface_rec Cycle Count API Parameters Usage IN IN IN IN OUT OUT OUT IN Type Number Varchar2 Varchar2 Number Varchar2 Number Varchar2 Record x Required x x x x Derived Optional p_api_version_number Indicates the API version number. Additional information on these parameters follows the chart. then the list of messages must be retrieved using the call FND_ MSG_PUB.Cycle Count Application Program Interface Cycle Count Application Program Interface The Cycle Count API is a public API that allows you to perform on-line processing for cycle count records. If the x_msg_count is greater than 1. Setting Up the Cycle Count API Parameter Descriptions The following chart lists all parameters used by the Cycle Count API.

G_FALSE p_validation_level Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API. s s s Default Value: FND_API.G_VALID_LEVEL_FULL x_return_status Requests that the API return the status of the data for you after it completes its function. If the x_msg_count is equal to 1. Valid values include: s Success: FND_API. Default Value: FND_API.Cycle Count Application Program Interface s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. x_msg_data Displays error message text. 7-90 Oracle Manufacturing APIs and Open Interfaces Manual .G_FALSE p_commit Requests that the API update information for you after it completes its function.G_RET_STS_SUCCESS Error: FND_API. p_interface_rec Indicates the complete interface record. then this contains the actual message.

see your Oracle Inventory Technical Reference Manual for details. For specific information on the data implied by these parameters. Table 7–21 Condition Success Failure Failure Cycle Count API Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. the API will return an error status to the calling module.Cycle Count Application Program Interface Validation of Cycle Count API Standard Validation Oracle Inventory validates all input parameters in the Cycle Count API. The Cycle Count API processes the rows and reports the following values for every record. Error Handling If any validation fails. Oracle Inventory Open Interfaces and APIs 7-91 .

UPDATE_CARD_SUPPLY_STATUS Table 7–22 Parameter p_api_version_number p_init_msg_level p_commit x_msg_count x_msg_data x_return_status p_kanban_card_id p_supply_status Update_Card_Supply_Status Parameters Usage IN IN IN OUT OUT OUT IN IN Type Number Varchar2 Varchar2 Number Varchar2 Varchar2 Varchar2 Varchar2 x x Required x x x Derived Optional p_api_version_number Indicates the API version number.GET. Setting Up the Kanban API Parameter Descriptions The following chart lists all parameters used by the update_card_supply_status procedure. If the x_msg_count is greater than 1. you use the public procedure update_card_ supply_status.Kanban Application Program Interface Kanban Application Program Interface The Kanban API is a public API that allows you to update the supply status of kanban cards. To accomplish this task. The values are: s p_msg_index => I p_encoded => F s 7-92 Oracle Manufacturing APIs and Open Interfaces Manual . then the list of messages must be retrieved using the call FND_ MSG_PUB. Additional information on these parameters follows the chart. p_init_msg_list Requests that the API initialize the message list on your behalf.

then this contains the actual message. Default Value: FND_API. x_msg_data Displays error message text. If the x_msg_count is equal to 1.G_FALSE p_commit Requests that the API update information for you after it completes its function.G_RET_STS_UNEXP_ERROR s s p_kanban_card_id Indicates the kanban card identifier to be updated. s Default Value: FND_API.Kanban Application Program Interface s p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.G_RET_STS_ERROR Unexpected Error: FND_API.G_FALSE x_msg_count Indicates the number of error messages the API has encountered.G_RET_STS_SUCCESS Error: FND_API. p_supply_status Indicates the updated status of the kanban card. x_return_status Requests that the API return the status of the data for you after it completes its function. Valid values include: s Success: FND_API. Oracle Inventory Open Interfaces and APIs 7-93 .

The Kanban API processes the rows and reports the following values for every record. Error Handling If any validation fails. For specific information on the data implied by these parameters. Table 7–23 Condition Success Failure Failure Error Handling Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. the API will return an error status to the calling module. see your Oracle Inventory Technical Reference Manual for details.Kanban Application Program Interface Validation of Kanban API Standard Validation Oracle Inventory validates all input parameters in the update_card_supply_status procedure. 7-94 Oracle Manufacturing APIs and Open Interfaces Manual .

The Lot API has one public procedure. Setting Up the Lot API Parameter Descriptions The following chart lists all parameters used by the insertlot procedure. If the API is able to insert the lot. This API derives the expiration date from the controls set for shelf_life_code and shelf_life_days for the item.Lot Application Program Interface Lot Application Program Interface The Lot API is a public API that allows you to insert a lot into the MTL_LOT_ NUMBERS table. The Lot API returns an error status if there is any validation error. Standard WHO information is used from the FND_GLOBAL API. It performs all the necessary validation before it inserts the lot. insertlot. Additional information on these parameters follows the chart. p_organization_id Indicates the organization identifier. it places a message on the stack to indicate that the lot already exists. p_lot_number Indicates the lot number. INSERTLOT Table 7–24 Parameter p_inventory_item_id p_organization_id p_lot_number p_expiration_date x_return_status Insertlot Procedure Parameters Usage IN IN IN IN/OUT OUT Type Number Number Varchar2 Date Varchar2 Required x x x x x x Derived Optional p_inventory_item_id Indicates the inventory item identifier. it returns a status of success. Oracle Inventory Open Interfaces and APIs 7-95 . If the lot already exists for the same item and organization. the API also returns a status of success. however.

For specific information on the data implied by these parameters. see your Oracle Inventory Technical Reference Manual for details. Valid values include: s Success: FND_API. Error Handling If any validation fails. x_return_status Requests that the API return the status of the data for you after it completes its function. the API will return error status to the calling module. The Pick Release API processes the rows and reports the following values for every record.Lot Application Program Interface p_expiration_date Indicates the expiration date. Table 7–25 Condition Success Failure Failure Error Handling Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. 7-96 Oracle Manufacturing APIs and Open Interfaces Manual .G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_UNEXP_ERROR s s Validation of Lot API Standard Validation Oracle Inventory validates all input parameters in the Lot API.G_RET_STS_ERROR Unexpected Error: FND_API.

s delete_reservation Deletes existing reservations. Oracle Inventory Open Interfaces and APIs 7-97 . of an existing reservation.Material Reservation Application Program Interface Material Reservation Application Program Interface The Material Reservation API is a public API that allows you to do the following: s Query existing reservations Create reservations Update existing reservations Transfer existing reservations Delete existing reservations s s s s Functional Overview The Material Reservation API provides the following public procedures that allow you to accomplish the tasks listed above: s query_reservation Returns all reservations that match the specified criteria. s transfer_reservation Transfers either supply or demand information from one source to another. Additional information on these parameters follows each chart. Used when a reservation is no longer needed or has been fulfilled. s create_reservation Creates a material reservation for an item. Setting Up the Material Reservation API Parameter Descriptions The following charts list all parameters used by the procedures listed above. including quantity. s update_reservation Updates the demand and supply information.

then the list of messages must be retrieved using the call FND_ MSG_PUB. p_init_msg_list Requests that the API initialize the message list on your behalf. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s 7-98 Oracle Manufacturing APIs and Open Interfaces Manual .Material Reservation Application Program Interface QUERY_RESERVATION Table 7–26 Parameter p_api_version_ number p_init_msg_list x_return_status x_msg_count x_msg_data p_query_input p_lock_records p_sort_by_rec_date p_cancel_order_ mode x_mtl_reservation_ tbl x_mtl_reservation_ tbl_count x_error_code Query_Reservation Usage IN IN OUT OUT OUT IN IN IN IN OUT OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Record Varchar2 Number Number PL/SQL Table Number Number x x x x Required x x Derived Optional p_api_version_number Indicates the API version number.GET. If the x_msg_count is greater than 1.

Default Value: FND_API.G_FALSE x_return_status Requests that the API returns the status of the data for you after it completes its function.G_CANCEL_ORDER_NO Oracle Inventory Open Interfaces and APIs 7-99 .G_RET_STS_EXC_ERROR Unexpected Error: FND_API. the reservations will be returned in a specific order. then this contains the actual message.G_RET_STS_SUCCESS Error: FND_API.G_FALSE p_sort_by_req_date Specifies whether to sort the return records by requirement date. Default Value: FND_API. If the x_msg_count is equal to 1. Valid values include: s Success: FND_API. Default Value: INV_RESERVATION_GLOBAL. p_lock_records Specifies whether to lock matching records. Default Value: INV_RESERVATION_GLOBAL.Material Reservation Application Program Interface where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered.G_QUERY_NO_SORT p_cancel_order_mode If you intend to cancel an order and want to query related reservations. p_query_input Contains information to be used to identify the reservations. x_msg_data Displays error message text.

7-100 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: INV_RESERVATION_GLOBAL. CREATE_RESERVATION Table 7–27 Parameter p_api_version_ number p_init_msg_list x_return_status x_msg_count x_msg_data p_rsv_rec p_serial_number x_serial_number p_partial_ reservation_flag p_force_reservation_ flag x_quantity_reserved x_reservation_id Create_Reservation Usage IN IN OUT OUT OUT IN IN OUT IN IN OUT OUT Type Number Varchar2 Varchar2 Number Varchar2 Record PL/SQL Table PL/SQL Table Varchar2 Varchar2 Number Number x x Required x x Derived Optional p_api_version_number Indicates the API version number.g_ret_sts_error.MTL_RESERVATION_TBL_TYPE x_mtl_reservation_tbl_count Indicates the number of records in x_mtl_reservation_tbl. x_error_code This error code is meaningful only if x_return_status equals fnd_api.Material Reservation Application Program Interface x_mtl_reservation_tbl Indicates reservations that match the criteria.

G_RET_STS_EXC_ERROR Unexpected Error: FND_API. Default Value: INV_RESERVATION_GLOBAL.G_FALSE x_return_status Requests that the API returns the status of the data for you after it completes its function.SERIAL_NUMBER_TBL_TYPE Oracle Inventory Open Interfaces and APIs 7-101 . then the list of messages must be retrieved using the call FND_ MSG_PUB.MTL_RESERVATION_REC_TYPE p_serial_number Contains serial numbers to be reserved. p_rsv_rec Contains information to create the reservations.G_RET_STS_SUCCESS Error: FND_API. s s s Default Value: FND_API. Valid values include: s Success: FND_API. If the x_msg_count is greater than 1. then this contains the actual message. Default Value: INV_RESERVATION_GLOBAL. If the x_msg_count is equal to 1.Material Reservation Application Program Interface p_init_msg_list Requests that the API initialize the message list on your behalf.GET.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. x_msg_data Displays error message text. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.

Default Value: FND_API_. Possible values are FND_API_.Material Reservation Application Program Interface X_serial_number The serial numbers actually reserved if procedure succeeded.G_TRUE Default Value: FND_API_.G_TRUE. Default Value: FND_API_. x_reservation_id This reservation identifier for the reservation is created if the procedure succeeded.G_FALSE p_force_reservation_flag Specifies whether to reserve the quantity without performing a quantity check.G_FALSE p_validation_flag Specifies whether to reserve the quantity without performing a validation.G_FALSE and FND_API_. Default Value: INV_RESERVATION_GLOBAL. UPDATE_RESERVATION Table 7–28 Parameter p_api_version_ number p_init_msg_list x_return_status x_msg_count x_msg_data p_original_rsv_rec Update_Reservation Usage IN IN OUT OUT OUT IN Type Number Varchar2 Varchar2 Number Varchar2 Record x Required x x Derived Optional 7-102 Oracle Manufacturing APIs and Open Interfaces Manual . x_quantity_reserved The actual quantity reserved if the procedure succeeded.SERIAL_NUMBER_TBL_TYPE p_partial_reservation_flag If not enough quantity is available. specifies whether to reserve the amount that is available.

If the x_msg_count is greater than 1.G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered.G_FALSE x_return_status Requests that the API returns the status of the data for you after it completes its function. s s s Default Value: FND_API.Material Reservation Application Program Interface Table 7–28 Parameter Update_Reservation Usage IN IN IN IN Type Record PL/SQL Table PL/SQL Table Varchar2 Required x Derived Optional p_to_rsv_rec p_original_serial_ number p_to_serial_number p_validation_flag p_api_version_number Indicates the API version number.GET. Oracle Inventory Open Interfaces and APIs 7-103 .G_RET_STS_EXC_ERROR Unexpected Error: FND_API. Valid values include: s Success: FND_API. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. p_init_msg_list Requests that the API initialize the message list on your behalf. then the list of messages must be retrieved using the call FND_ MSG_PUB.

G_MISS_NUM). it identifies the existing reservation and all other attributes in this record are ignored.SERIAL_NUMBER_TBL_TYPE p_to_serial_number Contains the new serial numbers to be reserved.MTL_RESERVATION_REC_TYPE p_to_rsv_rec Contains new values of the attributes to be updated. Default Value: FND_API. Default Value: INV_RESERVATION_GLOBAL. Default Value: INV_RESERVATION_GLOBAL.MTL_RESERVATION_REC_TYPE p_original_serial_number Contains the serial numbers reserved by the existing reservation. Default Value: INV_RESERVATION_GLOBAL.SERIAL_NUMBER_TBL_TYPE p_validation_flag Indicates whether to reserve without validation.Material Reservation Application Program Interface x_msg_data Displays error message text. p_original_rsv_rec Contains information to identify the existing reservation. the new value of the attribute is assigned to the attribute in this record. If the value of an attribute of the existing reservation requires updating.G_TRUE TRANSFER_RESERVATION Table 7–29 Parameter p_api_version_ number p_init_msg_list Transfer_Reservation Usage IN IN Type Number Varchar2 Required x x Derived Optional 7-104 Oracle Manufacturing APIs and Open Interfaces Manual . If the x_msg_count is equal to 1. then this contains the actual message. If the reservation identifier is passed (not null and not equal to FND_API. Default Value: INV_RESERVATION_GLOBAL.

s s s Default Value: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB. Valid values include: s Success: FND_API.G_RET_STS_SUCCESS Oracle Inventory Open Interfaces and APIs 7-105 . p_init_msg_list Requests that the API initialize the message list on your behalf. If the x_msg_count is greater than 1.GET. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.G_FALSE x_return_status Requests that the API returns the status of the data for you after it completes its function.Material Reservation Application Program Interface Table 7–29 Parameter Transfer_Reservation Usage OUT OUT OUT IN IN IN IN IN OUT Type Varchar2 Varchar2 Varchar2 Varchar2 Record Number Number Varchar2 Number x x x x Required Derived Optional x_return_status x_msg_count x_msg_data p_is_transfer_supply p_original_rsv_rec p_original_serial_ number p_to_serial_number p_validation_flag x_to_reservation_id p_api_version_number Indicates the API version number.

MTL_RESERVATION_REC_TYPE p_original_serial_number Contains the serial numbers reserved by the existing reservation.SERIAL_NUMBER_TBL_TYPE p_to_serial_number Contains the new serial numbers to be reserved.G_RET_STS_UNEXP_ERROR s x_msg_count Indicates the number of error messages the API has encountered. the new value of the attribute is assigned to the attribute in this record. Default Value: INV_RESERVATION_GLOBAL.G_TRUE 7-106 Oracle Manufacturing APIs and Open Interfaces Manual .G_TRUE p_original_rsv_rec Contains information to identify the existing reservation. then this contains the actual message. x_msg_data Displays error message text.SERIAL_NUMBER_TBL_TYPE p_validation_flag Indicates whether to reserve without validation. Default Value: FND_API.G_RET_STS_EXC_ERROR Unexpected Error: FND_API.G_MISS_NUM). it identifies the existing reservation and all other attributes in this record are ignored. If the value of an attribute of the existing reservation requires updating. If the reservation identifier is passed (not null and not equal to FND_API. p_is_transfer_supply Default Value: FND_API. Default Value: INV_RESERVATION_GLOBAL.Material Reservation Application Program Interface s Error: FND_API. Default Value: INV_RESERVATION_GLOBAL.MTL_RESERVATION_REC_TYPE p_to_rsv_rec Contains new values of the attributes to be updated. If the x_msg_count is equal to 1. Default Value: INV_RESERVATION_GLOBAL.

then the list of messages must be retrieved using the call FND_ MSG_PUB. If the x_msg_count is greater than 1. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. s s s Default Value: FND_API.Material Reservation Application Program Interface x_to_reservation_id Indicates the new reservation identifier. p_init_msg_list Requests that the API initialize the message list on your behalf.G_FALSE Oracle Inventory Open Interfaces and APIs 7-107 .GET. DELETE_RESERVATION Table 7–30 Parameter p_api_version_ number p_init_msg_list x_return_status x_msg_count x_msg_data p_rsv_rec p_serial_number Delete_Reservation Usage IN IN OUT OUT OUT IN IN Type Number Varchar2 Varchar2 Number Varchar2 Record x x Require d x x Derived Optional p_api_version_number Indicates the API version number.

G_RET_STS_SUCCESS Error: FND_API. If the x_msg_count is equal to 1.G_RET_STS_EXC_ERROR Unexpected Error: FND_API.Material Reservation Application Program Interface x_return_status Requests that the API returns the status of the data for you after it completes its function. For specific information on the data implied by these parameters. see your Oracle Inventory Technical Reference Manual for details. x_msg_data Displays error message text. Default Value: INV_RESERVATION_GLOBAL. then this contains the actual message. 7-108 Oracle Manufacturing APIs and Open Interfaces Manual . p_rsv_rec Contains information to identify the existing reservation. Valid values include: s Success: FND_API. Error Handling If any validation fails. The Material Reservation API processes the rows and reports the following values for every record.SERIAL_NUMBER_TBL_TYPE Validation of Material Reservation API Standard Validation Oracle Inventory validates all input parameters in the Material Reservation API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. the API will return an error status to the calling module.MTL_RESERVATION_REC_TYPE p_serial_number Contains serial numbers reserved by the existing reservation. Default Value: INV_RESERVATION_GLOBAL.

Oracle Inventory Open Interfaces and APIs 7-109 .Material Reservation Application Program Interface Table 7–31 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i.

Setting Up the Reservations Manager API Parameter Descriptions The following chart lists all parameters used by Reservations Manager API. Default Value: 1 7-110 Oracle Manufacturing APIs and Open Interfaces Manual . Additional information on these parameters follow the chart.Reservations Manager Application Program Interface Reservations Manager Application Program Interface The Reservations Manager API is a public API that allows you to call the reservation manager on-line or submit reservation requests concurrently. RSV_INTERFACE_MANAGER Table 7–32 Parameter x_errbuf x_retcode p_api_version_ number p_init_msg_lst p_form_mode RSV_INTERFACE_MANAGER Usage OUT OUT IN IN IN Type Varchar2 Number Number Varchar2 Varchar2 x x x Required Derived Optional x_errbuf A mandatory concurrent program parameter. The Reservations Manager API includes the public procedure rsv_interface_manager. x_retcode A mandatory concurrent program parameter. transferring. and deleting reservations. p_api_version_number Indicates the API version number. The Reservations Manager processes reservation requests from the MTL_ RESERVATIONS_INTERFACE table for creating. updating.

then the list of messages must be retrieved using the call FND_ MSG_PUB. If the x_msg_count is greater than 1. s s s Default Value: FND_API. N to indicate the Reservations Manager is not called from the form Default Value: N Validation of Reservations Manager API Standard Validation Oracle Inventory validates all input parameters in the Reservations Manager API. Possible values include: Y to indicate the Reservations Manager is called from the form.Reservations Manager Application Program Interface p_init_msg_list Requests that the API initialize the message list on your behalf. For specific information on the data implied by these parameters. Error Handling If any validation fails. see your Oracle Inventory Technical Reference Manual for details. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. Oracle Inventory Open Interfaces and APIs 7-111 . the API will return an error status to the calling module. The Reservations Manager API processes the rows and reports the following values for every record.GET.G_FALSE p_form_mode Specifies whether the Reservations Manager is called from the form.

Reservations Manager Application Program Interface Table 7–33 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. 7-112 Oracle Manufacturing APIs and Open Interfaces Manual .

Additional information on these parameters follows each chart. s s s Functional Overview The Sales Order API provides three public procedures that allow you to accomplish the tasks listed above.Sales Order Application Program Interface Sales Order Application Program Interface The Sales Order API is a public API that allows you to do the following: s Create a sales order in Oracle Inventory’s local definition of a sales order Update a sales order in Oracle Inventory’s local definition of a sales order Get a corresponding Oracle Order Management order header identifier given a sales order identifier Get a corresponding sales order identifier given an Order Management order header identifier. s get_salesorder_for_oeheader Allows you to get a corresponding sales order identifier given an Oracle Order Management order header identifier. If there is no matching sales order identifier. Oracle Inventory Open Interfaces and APIs 7-113 . The procedures are as follows: s create_salesorder Creates a sales order in Oracle Inventory’s local definition of a sales order. A value of negative one (-1) is returned if the sales order identifierwas created by a system other than Oracle Order Management. Setting Up the Sales Order API Parameter Descriptions The following charts list all parameters used by the Sales Order API. a null is returned. s get_oeheader_for_salesorder Allows you to get a corresponding Oracle Order Management order header identifier given a sales order identifier.

p_init_msg_list Requests that the API initialize the message list on your behalf.GET. s s s Default Value: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_FALSE 7-114 Oracle Manufacturing APIs and Open Interfaces Manual .Sales Order Application Program Interface CREATE_SALESORDER Table 7–34 Parameter p_api_version_ number p_init_msg_list p_segment1 p_segment2 p_segment3 p_validate_full p_validation_date x_salesorder_id x_msg_data x_msg_count x_return_status CREATE_SALESORDER Usage IN IN IN IN IN IN IN OUT OUT OUT OUT Type Number Varchar2 Number Varchar2 Varchar2 Number Date Number Varchar2 Number Varchar2 Require d x x x x x x x Derived Optional p_api_version_number Indicates the API version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. If the x_msg_count is greater than 1.

then this contains the actual message. x_return_status Requests that the API return the status of the data for you after it completes its function.G _EXC_ERROR Unexpected Error: FND_API. When set to a value of 1. Valid values include: s Success: FND_API. x_msg_data Displays error message text.Sales Order Application Program Interface p_segment1 Indicates the order number. flexfield APIs are used to create sales order flexfields.G_RET_SUCCESS Error: FND_API. p_segment3 Indicates the order source. the sales order flexfield is created manually. When set to a value of 0. If the x_msg_count is equal to 1. p_segment2 Indicates the order type. x_msg_count Indicates the number of error messages the API has encountered. p_validate_full Indicates whether flexfield APIs are used to create sales order flexfields. x_salesorder_id Indicates the returned sales order identifier. Default Value: 1 p_validation_date Indicates the date of creation.G_EXC_UNEXPECTED_ERROR s s Oracle Inventory Open Interfaces and APIs 7-115 . which is not unique in the Oracle Order Management system.

x_return_status Requests that the API return the status of the data for you after it completes its function. Valid values include: s Success: FND_API.Sales Order Application Program Interface GET_OEHEADER_FOR_SALESORDER Table 7–35 Parameter p_salesorder_id x_oe_header_id x_return_status GET_OEHEADER_FOR_SALESORDER Usage IN OUT OUT Type Number Number Varchar2 Required x Derived Optional p_salesorder_id Indicates the sales order identifier x_oe_header_id Indicates the Oracle Order Management order header identifier.G_RET_SUCCESS Error: FND_API. 7-116 Oracle Manufacturing APIs and Open Interfaces Manual .G_EXC_UNEXPECTED_ERROR s s GET_SALESORDER_FOR_OEHEADER Table 7–36 Parameter p_oe_header_id GET_SALESORDER_FOR_OEHEADER Usage IN Type Number Required x Derived Optional p_oe_header_id Returns a sales order identifier when an Oracle Order Management order header is passed to it.G _EXC_ERROR Unexpected Error: FND_API.

Oracle Inventory Open Interfaces and APIs 7-117 . see your Oracle Inventory Technical Reference Manual for details. For specific information on the data implied by these parameters. Table 7–37 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. Error Handling If any validation fails. The Sales Order API processes the rows and reports the following values for every record.Sales Order Application Program Interface Validation of Sales Order API Standard Validation Oracle Inventory validates all input parameters in the Sales Order API. the API will return an error status to the calling module.

7-118 Oracle Manufacturing APIs and Open Interfaces Manual . Additional information on the parameters follows each chart.Move Order Application Program Interface Move Order Application Program Interface The Move Order API is a public API that allows you to do the following: s Create a move order header Create a move order line Process a move order (create or update) Lock a move order Get a move order for a given header or header identifier Process a move order line (cancel or update) s s s s s Functional Overview The Move Order API provides the following public procedures that allow you to accomplish the tasks listed above: s create_move_order_header create_move_order_lines process_move_order lock_move_order get_move_order process_move_order_line s s s s s Setting Up the Move Order API Parameter Descriptions The following charts list all parameters used by the Move Order API.

GET. then the list of messages must be retrieved using the call FND_ MSG_PUB.Move Order Application Program Interface CREATE_MOVE_ORDER_HEADER Table 7–38 Parameter p_api_version_ number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_trohdr_rec p_trohdr_val_rec x_trohdr_rec x_trohdr_val_rec p_validation_flag CREATE_MOVE_ORDER_HEADER Usage IN IN IN IN OUT OUT OUT IN IN OUT OUT IN Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Record Record Record Record Varchar2 x x Require d x x x x Derived Optional p_api_version_number Indicates the API version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. If the x_msg_count is greater than 1. p_init_msg_list Requests that the API initializes the message list on your behalf. s s s Oracle Inventory Open Interfaces and APIs 7-119 .

If the x_msg_count is equal to 1. Valid values include: s Success: FND_API. Default Value: FND_API. Default Value: G_MISS_TROHDR_REC p_trohdr_val_rec Contains information values rather than internal identifiers used to create the move order header.Move Order Application Program Interface Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.G_FALSE p_commit Requests that the API update information for you after it completes its function.G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. 7-120 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API.G_FALSE p_return_values Requests that the API sends back the values on your behalf. then this contains the actual message. Default Value: G_MISS_TRODHDR_VAL_REC x_trohdr_rec The information of the move order header that was created. p_trohdr_rec The record that contains the information to be used to create the move order header. x_msg_data Displays error message text.

If this is set to ’N’. CREATE_MOVE_ORDER_LINES Table 7–39 Parameter p_api_version_ number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_trolin_tbl p_trolin_val_tbl x_trolin_tbl x_trolin_val_tbl p_validation_flag CREATE_MOVE_ORDER_LINES Usage IN IN IN IN OUT OUT OUT IN IN OUT OUT IN Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table Varchar2 x x Required x x x x Derived Optional p_api_version_number Indicates the API version number. p_validation_flag Flag that indicates whether the data needs to be validated. If this is set to ’Y’. Oracle Inventory Open Interfaces and APIs 7-121 . the move order header is created after performing the appropriate validations. the move order lines are directly created from the input header record type passed.Move Order Application Program Interface x_trohdr_val_rec The information values of the move order header that was created.

G_FALSE p_return_values Requests that the API sends back the values on your behalf.G_RET_STS_SUCCESS Error: FND_API. s s s Default Value: FND_API. then this contains the actual message.Move Order Application Program Interface p_init_msg_list Requests that the API initializes the message list on your behalf. Valid values include: s Success: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.GET. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. x_msg_data Displays error message text. If the x_msg_count is equal to 1. If the x_msg_count is greater than 1. 7-122 Oracle Manufacturing APIs and Open Interfaces Manual .G_FALSE p_commit Requests that the API update information for you after it completes its function. Default Value: FND_API. Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.

PROCESS_MOVE_ORDER Table 7–40 Parameter p_api_version_ number p_init_msg_list p_return_values p_commit x_return_status x_msg_count PROCESS_MOVE_ORDER Usage IN IN IN IN OUT OUT Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number x Required x x x Derived Optional Oracle Inventory Open Interfaces and APIs 7-123 . x_trolin_val_tbl The information values of the move order lines that were created. the move order header is created after performing the appropriate validations. If this is set to ’Y’. the move order lines are directly created from the input header record type passed. p_validation_flag Flag that indicates whether the data needs to be validated. Default Value: G_MISS_TROLIN_TBL p_trolin_val_tbl Contains information values rather than internal identifiers used to create the move order header. Default Value: G_MISS_TROLIN_VAL_TBL x_trolin_tbl The information of the move order lines that were created. If this is set to ’N’.Move Order Application Program Interface p_trolin_tbl A table of records that contains the information to be used to create the move order lines.

GET. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_FALSE p_return_values Requests that the API sends back the values on your behalf. 7-124 Oracle Manufacturing APIs and Open Interfaces Manual . p_init_msg_list Requests that the API initializes the message list on your behalf. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. s s s Default Value: FND_API.Move Order Application Program Interface Table 7–40 Parameter x_msg_data PROCESS_MOVE_ORDER Usage OUT IN IN IN IN OU OUT OUT OUT Type Varchar2 Record Record PL/SQL Table PL/SQL Table Record Record PL/SQL Table PL/SQL Table x x x x Required Derived Optional p_trohdr_rec p_trohdr_val_rec p_trolin_tbl p_trolin_val_tbl x_trohdr_rec x_trohdr_val_rec x_trolin_tbl x_trolin_val_tbl p_api_version_number Indicates the API version number. If the x_msg_count is greater than 1.

then this contains the actual message. p_trohdr_rec The record that contains the information to be used to create the move order header.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. Default Value: G_MISS_TROHDR_VAL_REC p_trolin_tbl A table of records that contains the information to create the move order lines. x_msg_data Displays error message text. Default Value: G_MISS_TROHDR_REC p_trohdr_val_rec Contains information values rather than internal identifiers used to create the move order header.G_FALSE p_commit Requests that the API update information for you after it completes its function.G_RET_STS_ERROR Unexpected Error: FND_API. If the x_msg_count is equal to 1.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered.Move Order Application Program Interface Default Value: FND_API. Valid values include: s Success: FND_API.G_RET_STS_SUCCESS Error: FND_API. Default Value: G_MISS_TROLIN_TBL Oracle Inventory Open Interfaces and APIs 7-125 . Default Value: FND_API.

x_trolin_val_tbl The information values of the move order lines that were created. x_trolin_tbl The information of the move order lines that were created. LOCK_MOVE_ORDER Table 7–41 Parameter p_api_version_ number p_init_msg_list p_return_values x_return_status x_msg_count x_msg_data p_trohdr_rec p_trohdr_val_rec p_trolin_tbl p_trolin_val_tbl LOCK_MOVE_ORDER Usage IN IN IN OUT OUT OUT IN IN IN IN Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Record Record PL/SQL Table PL/SQL Table x x x x Required x x x Derived Optional 7-126 Oracle Manufacturing APIs and Open Interfaces Manual . x_trohdr_val_rec The information values of the move order header that was created.Move Order Application Program Interface p_trolin_val_tbl Contains information values rather than internal identifiers used to create the move order header. Default Value: G_MISS_TROLIN_VAL_TBL x_trohdr_rec The information of the move order header that was created.

p_init_msg_list Requests that the API initializes the message list on your behalf. Valid values include: s Success: FND_API.Move Order Application Program Interface Table 7–41 Parameter LOCK_MOVE_ORDER Usage OUT OUT OUT OUT Type Record Record PL/SQL Table PL/SQL Table Required Derived Optional x_trohdr_rec x_trohdr_val_rec x_trolin_tbl x_trolin_val_tbl p_api_version_number Indicates the API version number. s s s Default Value: FND_API. If the x_msg_count is greater than 1.G_RET_STS_ERROR s Oracle Inventory Open Interfaces and APIs 7-127 .GET. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.G_RET_STS_SUCCESS Error: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_FALSE p_return_values Requests that the API sends back the values on your behalf. Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.

then this contains the actual message. p_trohdr_rec The record that contains the information to create the move order header. x_trohdr_val_rec The information values of the move order header that was created. Default Value: G_MISS_TROLIN_VAL_TBL x_trohdr_rec The information of the move order header that was created. Default Value: G_MISS_TROLIN_TBL p_trolin_val_tbl Contains information values rather than internal identifiers used to create the move order header.Move Order Application Program Interface s Unexpected Error: FND_API. Default Value: G_MISS_TROHDR_REC p_trohdr_val_rec Contains information values rather than internal identifiers used to create the move order header. x_msg_data Displays error message text. If the x_msg_count is equal to 1. x_trolin_tbl The information of the move order lines that were created.G_RET_STS_UNEXP_ERROR x_msg_count Indicates the number of error messages the API has encountered. 7-128 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: G_MISS_TROHDR_VAL_REC p_trolin_tbl A table of records that contains the information to create the move order lines.

GET_MOVE_ORDER Table 7–42 Parameter p_api_version_ number p_init_msg_list p_return_values x_return_status x_msg_count x_msg_data p_header_id GET_MOVE_ORDER Usage IN IN IN OUT OUT OUT IN Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 Number x (you must indicate either this parameter or the following) p_header IN Varchar2 x (you must indicate either this parameter or the preceding) x_trohdr_rec x_trohdr_val_rec x_trolin_tbl x_trolin_val_tbl OUT OUT OUT OUT Record Record PL/SQL Table PL/SQL Table Required x x x Derived Optional p_api_version_number Indicates the API version number.Move Order Application Program Interface x_trolin_val_tbl The information values of the move order lines that were created. Oracle Inventory Open Interfaces and APIs 7-129 .

G_RET_STS_ERROR Unexpected Error: FND_API.G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. If the x_msg_count is greater than 1. If the x_msg_count is equal to 1.G_MISS_NUM 7-130 Oracle Manufacturing APIs and Open Interfaces Manual . then the list of messages must be retrieved using the call FND_ MSG_PUB. then this contains the actual message. s s s Default Value: FND_API.Move Order Application Program Interface p_init_msg_list Requests that the API initializes the message list on your behalf.G_FALSE p_return_values Requests that the API sends back the values on your behalf. Default Value: FND_API. Valid values include: s Success: FND_API. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively. x_msg_data Displays error message text. p_header_id The header identifier of the move order that you want to get. Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function.GET.

x_trohdr_val_rec The information values of the move order header that was created.G_MISS_CHAR x_trohdr_rec The information of the move order header that was created. x_trolin_tbl The information of the move order lines that were created. x_trolin_val_tbl The information values of the move order lines that were created.Move Order Application Program Interface p_header The header description of the move order that you want to get. Default Value: FND_API. PROCESS_MOVE_ORDER_LINE Table 7–43 Parameter p_api_version_ number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_trolin_tbl p_trolin_old_tbl x_trolin_tbl PROCESS_MOVE_ORDER_LINE Usage IN IN IN IN OUT OUT OUT IN IN OUT Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 PL/SQL Table PL/SQL Table PL/SQL Table x x x Required x x x x Derived Optional Oracle Inventory Open Interfaces and APIs 7-131 .

G_TRUE x_return_status Requests that the API return the status of the data for you after it completes its function. p_init_msg_list Requests that the API initializes the message list on your behalf. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out s s s where 1_message and 1_msg_index_out are local variables of types Varchar2(2000) and Number respectively.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. Valid values include: s Success: FND_API.Move Order Application Program Interface p_api_version_number Indicates the API version number.G_RET_STS_SUCCESS Error: FND_API. 7-132 Oracle Manufacturing APIs and Open Interfaces Manual .GET.G_FALSE p_return_values Requests that the API sends back the values on your behalf. If the x_msg_count is greater than 1. Default Value: FND_API.G_FALSE p_commit Requests that the API update information for you after it completes its function. Default Value: FND_API. Default Value: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_RET_STS_ERROR Unexpected Error: FND_API.

Validation of Move Order API Standard Validation Oracle Inventory validates all input parameters in the Move Order API. then this contains the actual message. For specific information on the data implied by these parameters. Error Handling If any validation fails. see your Oracle Inventory Technical Reference Manual for details. If the x_msg_count is equal to 1. Table 7–44 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i.Move Order Application Program Interface x_msg_data Displays error message text. The Move Order API processes the rows and reports the following values for every record. the API will return an error status to the calling module. p_trolin_tbl Contains information to be used to process move order lines. Oracle Inventory Open Interfaces and APIs 7-133 .

and. runs the pick confirm process immediately afterwards. The Pick Release API includes the public procedure pick_release. PICK_RELEASE Table 7–45 Parameter p_api_version_ number p_init_msg_list p_commit x_return_status x_msg_count x_msg_data p_mo_line_tbl p_auto_pick_confirm p_grouping_rule_id x_return_status x_msg_count x_msg_data PICK_RELEASE Usage IN IN IN OUT OUT OUT IN IN IN OUT OUT OUT Type Number Varchar2 Varchar2 Varchar2 Number Varchar2 PL/SQL Table Number Number Varchar2 Varchar2 Varchar2 x x x Require d x x x Derived Optional 7-134 Oracle Manufacturing APIs and Open Interfaces Manual . Additional information on these parameters follows the chart.Pick Release Application Program Interface Pick Release Application Program Interface The Pick Release API is a public API that allows you to release a set of move order lines for pick wave move orders. depending on the parameters passed in. Setting Up the Pick Release API Parameter Descriptions The following chart lists all parameters used by the pick_release procedure. This API creates move order line details for the lines that are released.

G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. If the x_msg_count is greater than 1.G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. Valid values include: s Success: FND_API. p_init_msg_list Requests that the API initialize the message list on your behalf.Pick Release Application Program Interface Table 7–45 Parameter PICK_RELEASE Usage Out Type PL/SQL Table Require d Derived Optional x_pick_release_ status p_api_version_number Indicates the API version number. s s s Default Value: FND_API.G_FALSE p_commit Requests that the API update information for you after it completes its function. Default Value: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_RET_STS_ERROR Unexpected Error: FND_API.GET. Oracle Inventory Open Interfaces and APIs 7-135 .

G_MISS_NUM x_return_status Requests that the API return the status of the data for you after it completes its function. Valid values include: s Success: FND_API.Pick Release Application Program Interface x_msg_data Displays error message text. If the x_msg_count is equal to 1. p_mo_line_tbl Indicates the PL/SQL table from which move order line records are chosen. Default Value: FND_API. x_pick_release_status A table of records that specifies the pick release status for each move order line that is passed in. then this contains the actual message.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. x_msg_data Displays error message text.G_MISS_NUM p_grouping_rule_id Overrides the organization level parameter and the move order header level grouping rule for generating pick slip numbers. p_auto_pick_confirm Overrides the organization level parameter to indicate whether the Pick Confirm API is automatically called after the records have been pick released. If the x_msg_count is equal to 1. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API. 7-136 Oracle Manufacturing APIs and Open Interfaces Manual . then this contains the actual message.G_RET_STS_ERROR Unexpected Error: FND_API.

Table 7–46 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. see your Oracle Inventory Technical Reference Manual for details. the API will return an error status to the calling module.Pick Release Application Program Interface Validation of Pick Release API Standard Validation Oracle Inventory validates all input parameters in the Pick_Release procedure. The Pick Release API processes the rows and reports the following values for every record. For specific information on the data implied by these parameters. Error Handling If any validation fails. Oracle Inventory Open Interfaces and APIs 7-137 .

Additional information on these parameters follows the chart. PICK_CONFIRM Table 7–47 Parameter p_api_version_ number p_init_msg_list p_commit x_return_status x_msg_count x_msg_data p_move_order_type p_transaction_mode PICK_CONFIRM Usage IN IN IN OUT OUT OUT IN IN Type Number Varchar2 Varchar2 Varchar2 Varchar2 Varchar2 Number Number x x Required x x x Derived Optional 7-138 Oracle Manufacturing APIs and Open Interfaces Manual . pick_confirm. which transfers move order line detail records from the MTL_MATERIAL_ TRANSACTIONS_TEMP table into the MTL_MATERIAL_TRANSACTIONS table. Setting Up the Pick Confirm API Parameter Descriptions The following chart lists all parameters used by the Pick_Confirm procedure. which then updates the move order line delivered quantity as well as shipping and reservation information.Pick Confirm Application Program Interface Pick Confirm Application Program Interface The Pick Confirm API is a public API that allows you to perform pick confirmations on move order line detail records. Functional Overview The Pick Confirm API provides one public procedure. To transact the records. the API calls the transaction processor.

p_init_msg_list Requests that the API initialize the message list on your behalf.G_FALSE p_commit Requests that the API updates information for you after it completes its function. Default Value: FND_API.GET.Pick Confirm Application Program Interface Table 7–47 Parameter p_trolin_tbl PICK_CONFIRM Usage IN Type Required Derived Optional x (you must indicate either this parameter or the following) p_mold_tbl IN x (you must indicate either this parameter or the preceding) x_mmtt_tbl x_trolin_tbl OUT OUT p_api_version_number Indicates the API version number. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. s s s Default Value: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.G_FALSE Oracle Inventory Open Interfaces and APIs 7-139 . If the x_msg_count is greater than 1.

7-140 Oracle Manufacturing APIs and Open Interfaces Manual . and 3 to background. p_trolin_tbl Indicates the PL/SQL table from which the move order line records are chosen. x_mmtt_tbl Indicates the return value of the p_mold_tbl parameter.G_RET_STS_ERROR Unexpected Error: FND_API. p_transaction_mode Indicates the transaction mode. x_msg_data Displays error message text. p_mold_tbl Indicates the PL/SQL table from which the move order line detail records are chosen. Valid values include: s Success: FND_API. 2 to concurrent.Pick Confirm Application Program Interface x_return_status Requests that the API returns the status of the data for you after it completes its function.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates the number of error messages the API has encountered. x_trolin_tbl Indicates the return value of the p_trolin_tbl parameter. If the x_msg_count is equal to 1. A value of 1 refers to on-line. then this contains the actual message.G_RET_STS_SUCCESS Error: FND_API. p_move_order_type Indicates the move order type.

Oracle Inventory Open Interfaces and APIs 7-141 . For specific information on the data implied by these parameters.Pick Confirm Application Program Interface Validation of Pick Confirm API Standard Validation Oracle Inventory validates all input parameters in the Pick_Confirm procedure. Error Handling If any validation fails. The Pick Confirm API processes the rows and reports the following values for every record. see your Oracle Inventory Technical Reference Manual for details. Table 7–48 Condition Success Failure Failure Record Values Message Returned S E U Meaning of Message Returned Process succeeded Expected error Unexpected error See Also Oracle Applications Message Reference Manual This manual is available in HTML format on the documentation CD-ROM for Release 11i. the API will return an error status to the calling module.

Call this procedure when you call rollback. revervable quantity onhand. In all other cases. set the P_Transfer_ Subinventory_Code parameter to NULL. and available to reserve (ATR).Quantity Tree Program Interface Quantity Tree Program Interface Procedure Name: CLEAR_QUANTITY_CACHE The CLEAR_QUANTITY_CACHE procedure deletes all quantity trees in memory. The table below provides the specifications for this API: Table 7–49 Parameter p_api_version_ number p_init_msg_lst x_return_status x_msg_count x_msg_data p_organization_id p_inventory_item_id p_tree_mode p_is_revision_ control p_is_lot_control p_is_serial_control p_demand_source_ type_id QUERY_QUANTITIES Usage IN IN OUT OUT OUT IN IN IN IN IN IN IN -9999 False Default Type Number Varchar2 Varchar2 Number Varchar2 Number Number Integer Boolean Boolean Boolean Number x x x x x x x x Required x x Derived Optional 7-142 Oracle Manufacturing APIs and Open Interfaces Manual . available to transact (ATT). the trees in memory may not be in sync with the data in the corresponding database tables. quantity reserved. Otherwise. Procedure Name: QUERY_QUANTITIES The QUERY_QUANTITIES procedure is used to find the values for quantity onhand. and the transaction is a subinventory transfer. then you need to pass the subinventory code of the destination sub in the p_ transfer_subinventory_code parameter. If the tree in the database is being queried in transaction mode. quantity suggested.

Quantity Tree Program Interface Table 7–49 Parameter QUERY_QUANTITIES Usage IN IN IN IN IN IN IN IN IN OUT OUT OUT OUT OUT OUT IN IN IN IN Null Null Null Null 3 Default -9999 -9999 Null Null Type Number Number Varchar2 Date Varchar2 Varchar2 Varchar2 Number Number Number Number Number Number Number Number Varchar2 Number Number Number Null x x x x x x x x x Required Derived Optional x x x x p_demand_source_ header_id p_demand_source_ line_id p_demand_source_ name p_lot_expiration_ date p_revision p_lot_number p_subinventory_ code p_locator_id p_onhand_source x_qoh x_rqoh x_qr x_qs x_att x_atr p_transfer_ subinventory_code p_cost_group_id p_lpn_id p_transfer_locator_ id p_api_version_number Indicates the API version number. Oracle Inventory Open Interfaces and APIs 7-143 .

p_tree_mode Either reservation mode (1). Fnd_Api. If the x_msg_count is greater than 1.G_Ret_Sts_Unexp_Error. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively.GET.G_Ret_Sts_Success for success.G_FALSE x_return_status Returns Fnd_Api. p_is_revision_control Item is Revision Controlled. then the list of messages must be retrieved using the call FND_MSG_ PUB. 7-144 Oracle Manufacturing APIs and Open Interfaces Manual . x_msg_data Contains the error message if x_msg_count =1.G_Ret_Sts_error for failure to process request due to incorrect input or for an unexpected error fnd_ Api. Loose Only mode (3) or No LPN Reservation mode (4).Quantity Tree Program Interface p_init_msg_list Requests API initialization of the message list on your behalf. s s s Default Value: FND_API. x_msg_count Indicates the number of error messages the API has encountered. p_organization_id This column identifies the internal identifier of the Organization. (2). Transaction mode. p_inventory_item_id This column identifies the internal identifier of the Inventory item.

p_demand_source_line_id Demand Source Line ID.Quantity Tree Program Interface p_is_lot_control Item is Lot Controlled. p_demand_source_header_id Demand Source Header ID. p_subinventory_code Subinventory Code. p_demand_source_type_id Demand Source Type ID. p_lot_expiration_date Only consider lots that will not expire at or before this date. p_revision Item Revision. p_lot_number Lot Number. All (3). Nettable (2). Oracle Inventory Open Interfaces and APIs 7-145 . p_demand_source_name Demand Source Name. p_locator_id Locator ID. p_onhand_source Describes subinventories in which to search for onhand: ATPable (1). ATPable or Nettable (4). p_is_serial_control Item is Serial Controlled.

The UPDATE_QUANTITIES procedure 7-146 Oracle Manufacturing APIs and Open Interfaces Manual . x_qs Quantity Suggested. Should be NULL otherwise.Quantity Tree Program Interface x_qoh Quantity On Hand. Procedure Name: UPDATE_QUANTITIES The UPDATE_QUANTITIES procedure changes the quantity in the quantity tree at the level specified by the input. p_cost_group_id Cost Group ID. p_transfer_subinventory_code Destination Subinventory for Subinventory Transfer transactions. then the p_primary_quantity value is added to the quantity onhand. p_transfer_locator_id Destination Locator for Subinventory Transfer transactions. x_rqoh Reservable Quantity On Hand. The quantity updated depends on the quantity type parameter. p_lpn_id LPN ID. If the quantity type g_qs_txn. If the quantity type is g_qoh. It returns the quantities at the level after the update. Should be NULL otherwise. x_att Quantity Available to Transact. Update_ quantity does not update the database. then the quantity suggested value is updated. x_qr Quantity Reserved.

The updates to both the destination and source should happen for actual transactions. Including suggested receipts could lead to missing inventory if the suggestion is not transacted For a subinventory transfer transaction. which updates both the destination location and the source location.Quantity Tree Program Interface updates the local version of the quantity tree. UPDATE_QUANTITIES must be called twice. The quantity is always added to the appropriate node quantity. For reserving items or suggesting an issue. Do not update the tree with suggested receipts. the quantity passed in should be positive. the value passed in should be positive incrementing quantity reserved or quantity suggested. For an issue transaction. The database must be updated separately. not suggested transfers. The table below provides the specifications for this API: UPDATE_QUANTITIES Usage IN IN OUT OUT OUT IN IN IN IN IN IN IN -9999 False Default Type Number Varchar2 Varchar2 Number Varchar2 Number Number Integer Boolean Boolean Boolean Number x x x x x x x x Required x x Derived Optional s Table 7–50 Parameter p_api_version_ number p_init_msg_lst x_return_status x_msg_count x_msg_data p_organization_id p_inventory_item_id p_tree_mode p_is_revision_ control p_is_lot_control p_is_serial_control p_demand_source_ type_id Oracle Inventory Open Interfaces and APIs 7-147 . add the quantity to the destination sub or location. the quantity passed in should have a negative sign (to decrement on hand quantity). First. s The quantity passed into update_quantities is important. Then decrement the quantity from the source sub or location. For a receipt transaction.

Quantity Tree Program Interface Table 7–50 Parameter UPDATE_QUANTITIES Usage IN IN IN IN IN IN IN IN IN IN IN OUT OUT OUT OUT OUT OUT IN IN IN IN IN Null Null Null Null Null 3 Default -9999 -9999 Null Null Type Number Number Varchar2 Date Varchar2 Varchar2 Varchar2 Number Number Integer Number Number Number Number Number Number Number Varchar2 Number Number Number Number x x Null x x x x x x x x x Required Derived Optional x x x x p_demand_source_ header_id p_demand_source_ line_id p_demand_source_ name p_lot_expiration_ date p_revision p_lot_number p_subinventory_ code p_locator_id p_primary_quantity p_quantity_type p_onhand_source x_qoh x_rqoh x_qr x_qs x_att x_atr p_transfer_ subinventory_code p_cost_group_id p_containerized p_lpn_id p_transfer_locator_ id 7-148 Oracle Manufacturing APIs and Open Interfaces Manual .

g_ret_sts_error for failure to process request due to incorrect input or for an unexpected error fnd_api. p_inventory_item_id Inventory item id. Oracle Inventory Open Interfaces and APIs 7-149 . p_tree_mode Either reservation mode (1). Loose Only mode (3) or No LPN Reservation mode (4).GET. x_msg_count Indicates the number of error messages the API has encountered. x_msg_data Contains the error message if x_msg_count =1. p_init_msg_list Requests that the API initialize the message list on your behalf.g_ret_sts_ unexp_error.g_ret_sts_success for success.G_FALSE x_return_status Returns fnd_api. p_organization_id Organization id. fnd_api. s s s Default Value: FND_API. Transaction mode. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. If the x_msg_count is greater than 1. then the list of messages must be retrieved using the call FND_ MSG_PUB.Quantity Tree Program Interface p_api_version_number Indicates the API version number. (2).

Quantity Tree Program Interface p_is_revision_control Item is Revision Controlled. p_is_serial_control Item is Serial Controlled. p_subinventory_code Subinventory Code. p_is_lot_control Item is Lot Controlled. p_lot_expiration_date Only consider lots that will not expire at or before this date. p_demand_source_name Demand Source Name. 7-150 Oracle Manufacturing APIs and Open Interfaces Manual . p_locator_id Locator ID. p_lot_number Lot Number. p_demand_source_type_id Demand Source Type ID. p_demand_source_line_id Demand Source Line ID. p_revision Item Revision. p_demand_source_header_id Demand Source Header ID.

x_rqoh Reservable Quantity On Hand. p_lpn_id LPN ID. Should be NULL otherwise. ATPable or Nettable (4). quantity reserved same demand source (2).Quantity Tree Program Interface p_primary_quantity Quantity to update tree with (in primary UOM). p_onhand_source Describes subinventories in which to search for onhand: ATPable (1). Nettable (2). p_transfer_subinventory_code Destination Subinventory for Subinventory Transfer transactions. quantity reserved other demand (3). quantity suggested for reservation (4). All (3). x_qr Quantity Reserved. p_quantity_type Used to specify which quantity to change: quantity onhand (1). x_qs Quantity Suggested. x_att Quantity Available to Transact. Oracle Inventory Open Interfaces and APIs 7-151 . p_cost_group_id Cost Group ID. quantity suggested for transaction (5). x_qoh Quantity On Hand.

It should be called before committing quantity updates to the database. Either sessions would lead to a negative quantity. If the x_msg_count is greater than 1. it would be possible for two different sessions to try to reserve or transact the same quantity. The values are: s p_msg_index => I 7-152 Oracle Manufacturing APIs and Open Interfaces Manual . Should be NULL otherwise. To solve this problem. Updates in a quantity tree are not reflected in other quantity trees of the same organization or item.Quantity Tree Program Interface p_transfer_locator_id Destination Locator for Subinventory Transfer transactions. then x_no_violation will be false. call do-check before commiting. then the list of messages must be retrieved using the call FND_ MSG_PUB. Updates should then be rolled back. Thus.GET. The table below provides the specifications for this procedure: Table 7–51 Parameter p_api_version_ number p_init_msg_lst x_return_status x_msg_count x_msg_data x_no_violation DO_CHECK Usage IN IN OUT OUT OUT OUT False Default Type Number Varchar2 Varchar2 Number Varchar2 Boolean Required x x Derived Optional p_api_version_number Indicates the API version number. Procedure Name: DO_CHECK The DO_CHECK procedure checks to determine whether tree updates are still valid. There can be multiple quantity trees for each item and organization. If your updates result in negative quantities (and if negative quatities are not allowed). p_init_msg_list Requests that the API initialize the message list on your behalf. The DO_CHECK procedure rebuilds the quantity tree with the current information in the database.

Error Handling If any validation fails. Validation of Quantity Tree API Standard Validation Oracle Inventory validates all input parameters in the Quantity Tree API. see your Oracle Inventory Technical Reference Manual.Quantity Tree Program Interface s p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. For specific information on the data implied by these parameters.g_ret_sts_ unexp_error.g_ret_sts_error for failure to process request due to incorrect input or for an unexpected error fnd_api. x_msg_count Indicates the number of error messages the API has encountered. s s Default Value: FND_API. the API will return an error status to the calling module. Table 7–52 Condition Success VALIDATION OF QUANTITY TREE API Message Returned S Description Process succeeded Oracle Inventory Open Interfaces and APIs 7-153 .G_FALSE x_return_status Returns fnd_api.g_ret_sts_success for success. otherwise value equal false. x_no_violation Return true if no validation found. x_msg_data Contains the error message if x_msg_count =1. fnd_api.

The API will process the transactions and create a historical record in mtl_ material_transactions and update onhand.Transaction Processing Program Interface Table 7–52 Condition Failure Failure VALIDATION OF QUANTITY TREE API Message Returned E U Description Expected Error Unexpected Error Transaction Processing Program Interface The Inventory Transaction Manager Program is a public API. It also enables you to process pending transaction from table. as they will be validated before being processed. The assumption is that records being processed via mtl_material_transactions_temp have been validated. that enables you to process transactions from the interface table. Records created through non-Oracle applications should be inserted in Mtl_Transactions_Interface. Setting Up Transaction Processing API Package Name: INV_TXN_MANAGER_PUB Function Name: PROCESS_TRANSACTION Return: 0 for sucess. or Mtl_Material_Transactions_Temp. mtl_transactions_interface.g_ false fnd_ api. Mtl_Material_Transaction_ Temp. -1 for failure Description: This function is used to process records in the table Mtl_Transactions_ Interface.g_ false Default Type Number Varchar2 Required x x x Derived Optional p_commit IN Varchar2 x 7-154 Oracle Manufacturing APIs and Open Interfaces Manual . Table 7–53 Parameter p_api_version_ number p_init_msg_lst PROCESS_TRANSACTION Usage IN IN fnd_ api.

Transaction Processing Program Interface Table 7–53 Parameter PROCESS_TRANSACTION Usage IN Default fnd_ api. Default Value: FND_API. The values are: s p_msg_index => I p_encoded => F p_data => 1_message p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. p_init_msg_list Requests that the API initialize the message list on your behalf. s s s Default Value: FND_API.G_FALSE. then the list of messages must be retrieved using the call FND_ MSG_PUB. Oracle Inventory Open Interfaces and APIs 7-155 .g_ valid_ level_ full Type Number Required Derived Optional x p_validate_level x_return_status x_msg_count x_msg_data x_trans_count p_table p_header_id OUT OUT OUT OUT IN IN 1 Varchar2 Number Varchar2 Number Number Number x x x x p_api_version_number Indicates the API version number.G_FALSE p_commit Requests that the API update information for you after it completes its function. If the x_msg_count is greater than 1.GET.

Transaction Processing Program Interface p_validate_level P_Validate_Level can have two possible values: G_Valid_Level_Full or G_Valid_ Level_None.g_ret_sts_error for failure to process request due to incorrect input or for an unexpected error fnd_api. A value of G_Valid_Level_none is for internal use only. 7-156 Oracle Manufacturing APIs and Open Interfaces Manual . Value 1 implies the records to be processed reside in mtl_transactions_ interface. G_valid_level_full. Default value: Fnd_Api. p_table Value 2 implies the records to be processed reside in mtl_material_transactions_ temp. x_msg_data Display error message text. x_msg_count Indicates the number of error messages that API has encountered.G_Valid_Level_Full. fnd_api. implies the records from Mtl_Transactions_ Interface will undergo thorough validations. x_trans_count Number of records processed. If the x_msg_count is equal to 1.g_ret_sts_success for success. p_header_id This is an input parameter corresponding to the transaction_header_id of the batch to be processed from mtl_transactions_interface or mtl_material_transactions_temp. x_return_status Returns fnd_api. Oracle does not expect third party to invoke this API with a value of 2 (records in mtl_material_transactions_temp).g_ret_sts_ unexp_error. then this contains the actual message.

8 Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs This chapter contains information about the following Oracle Master Scheduling/MRP and Oracle supply Chain Planing open interfaces and application program interfaces: s Open Forecast Interface on page 8-2 Open Master Schedule Interface on page 8-8 Open Forecast Entries Application Program Interface on page 8-14 Sourcing Rule Application Program Interface on page 8-21 s s s Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-1 .

forecast set. the Planning Manager must also be running before you can import forecasts via the Open Forecast Interface. The Forecast Interface Load program is launched by the Planning Manager. item. and then processes it by creating new forecasts in Oracle Master Scheduling/MRP. which periodically checks the Open Forecast Interface to see if there are any new rows waiting to be processed. derives any additional data as necessary. Functional Overview All processing is performed by the Forecast Interface Load program. This is typically used for batch loads. It is not interactive. Inserting into the Open Forecast Interface Table You must load your forecasts into the MRP_FORECAST_INTERFACE table. The Forecast Interface Load program validates your forecasts. performed when the load is low on the concurrent processing system. The purpose of this essay is to explain how to use the Open Forecast Interface so that you can integrate other applications with Oracle Master Scheduling/MRP. and forecast name before using the Open Forecast Interface. Table 8–1 Open Forecast Interface Table Description Column Name INVENTORY_ITEM_ID FORECAST_DESIGNATOR ORGANIZATION_ID Type Number Varchar2(10) Number x x Required Derived Optional 8-2 Oracle Manufacturing APIs and Open Interfaces Manual .Open Forecast Interface Open Forecast Interface You can import forecasts from any source using the Open Forecast Interface table. Setting Up the Open Forecast Interface You must define at least one organization. Open Forecast Interface Table Description The Open Forecast Interface Table is described in the following table. Since the Planning Manager decides when to call the Forecast Interface Load program. Oracle Master Scheduling/MRP automatically validates and implements imported forecasts as new forecasts in Oracle Master Scheduling/MRP.

ATTRIBUTE15 PROJECT ID TASK ID LINE ID Type Date Date Number Date Number Number Number Number Number Varchar2(240) Varchar2(240) Number Number Number Date Number Number Date Number Varchar2(10) Number Varchar230) Varchar2(150) Number(15) Number(15 Number(15 x x x x x x x x x x x x x x x x x x x x Required x x x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-3 .Open Forecast Interface Table 8–1 Open Forecast Interface Table Description Column Name FORECAST_DATE LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN QUANTITY PROCESS_STATUS CONFIDENCE_PERCENTAGE COMMENTS ERROR_MESSAGE REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE WORKDAY_CONTROL BUCKET_TYPE FORECAST_END_DATE TRANSACTION_ID SOURCE_CODE SOURCE_LINE_ID ATTRIBUTE_CATEGORY ATTRIBUTE1 .

Processed s s s s When you first load a new forecast entry into the Open Forecast Interface. Shift forward 3. and QUANTITY are used by the Forecast Interface Load program to create new forecast entries in MRP_FORECAST_DATES. The Forecast Interface Load program creates a new row in MRP_FORECAST_ ITEMS for each new forecast entry that refers to an item that has not been assigned to the forecast referenced in the Open Forecast Interface. Shift backward s s 8-4 Oracle Manufacturing APIs and Open Interfaces Manual .Open Forecast Interface Legend 1: Multiple Period Forecast Entries only Required Data ORGANIZATION_ID. Optional Data Use WORKDAY_CONTROL to indicate the action that the Forecast Interface Load should take if it finds a forecast date or forecast end date that is not a valid workday. PROCESS_STATUS indicates the current state of processing of each new forecast entry in the Open Forecast Interface. INVENTORY_ITEM_ID. Do not process 2. Reject 2. Valid values include: s 1. Error 5. set PROCESS_STATUS to 2 (Waiting to be processed). FORECAST_DATE. Waiting to be processed 3. FORECAST_DESIGNATOR. Enter one of the following: s 1. Being processed 4. Derived Data ERROR_MESSAGE indicates a problem that prevents the Forecast Interface Load program from successfully processing a new forecast entry in the Open Forecast Interface.

Days 2.Open Forecast Interface If WORKDAY_CONTROL is set to Null. the Forecast Interface Load program assumes a value of 1 (Days). Use SOURCE_CODE and SOURCE_LINE_ID to identify the source of new forecast entries. Use BUCKET_TYPE to indicate the bucket type of each new forecast entry. the Forecast Interface Load program assumes a value of 1 (Reject). For specific information on the data implied by these columns. Other Validation Oracle Master Scheduling/MRP also performs the following validation: INVENTORY_ITEM_ID Must be a valid item defined IN MTL_SYSTEM_ITEMS. see your Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual for details. Enter one of the following: s 1. The Forecast Interface Load deletes any existing entries in MRP_ FORECAST_DATES with the same TRANSACTION_ID before importing the new forecast entry. See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Validation Standard Validation Oracle Master Scheduling/MRP validates all required columns in the interface table. Weeks 3. Use FORECAST_END_DATE for forecast entries that span multiple periods. Use TRANSACTION_ID if you wish to replace an existing entry in MRP_ FORECAST_DATES with a new forecast entry that you have loaded into the Open Forecast Interface. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-5 . Periods s s If BUCKET_TYPE is null.

Days 2. Periods s s TRANSACTION_ID If provided. FORECAST_QUANTITY Must be greater than 0 and less than or equal to 99999999. Reject 2. FORECAST_END_DATE Must be greater than or equal to FORECAST_DATE. Shift backward s s BUCKET_TYPE Must be one of: s 1. TRANSACTION_ID must match an existing TRANSACTION_ID in MRP_FORECAST_DATES. Weeks 3. Waiting to be processed 3. Shift forward 3. FORECAST_DESIGNATOR Must be a valid. Processed s s s s WORKDAY_CONTROL Must be one of: s 1. non-disabled forecast name defined in MRP_FORECAST_DESIGNATORS. Error 5. Being processed 4.Open Forecast Interface ORGANIZATION_ID Must be a valid organization defined in ORG_ORGANIZATION_ DEFINITIONS. PROCESS_STATUS Must be one of: s 1.9. FORECAST_DATE Must be less than or equal to RATE_END_DATE if RATE_END_ DATE is provided. 8-6 Oracle Manufacturing APIs and Open Interfaces Manual . Do not process 2.

Fixing Failed Transactions Options Use SQL*Plus to manually correct failed transactions. and set the REQUEST_ID and ERROR_ MESSAGE columns to Null s The Planning Manager will detect the new rows when it next checks the Open Forecast Interface. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-7 . reset the PROCESS_STATUS column to 2 (Waiting to be processed). and launch the Forecast Interface Load program accordingly. or Correct the error in the Open Forecast Interface. This manual is available in HTML format on the documentation CD-ROM for Release 11i. See Also The Oracle Applications Message Reference Manual. and reload the corrected forecast into the Open Forecast Interface. Viewing Failed Transactions Use SQL*Plus to view failed transactions in the Open Forecast Interface.Resolving Failed Open Forecast Interface Rows Resolving Failed Open Forecast Interface Rows Error Messages Oracle Master Scheduling/MRP may display specific error messages during interface processing. correct the error in your external forecast. The ERROR_MESSAGE column indicates why the Forecast Interface Load program was unable to successfully process each failed transaction. You can either: s Delete the failed row in the Open Forecast Interface.

The purpose of this essay is to explain how to use the Open Master Schedule Interface so that you can integrate other applications with Oracle Master Scheduling/MRP. the Planning Manager must also be running before you can import master schedules via the Open Master Schedule Interface. which periodically checks the Open Master Schedule Interface to see if there are any new rows waiting to be processed. and master schedule name before using the Open Master Schedule Interface. Functional Overview All processing is performed by the Master Schedule Interface Load program. Inserting into the Open Master Schedule Interface Table You must load your master schedules into the MRP_SCHEDULE_INTERFACE table. The Master Schedule Interface Load program is launched by the Planning Manager. Open Master Schedule Interface Table Description The Open Master Schedule Interface Table is described in the following table: Table 8–2 Open Master Schedule Interface Table Description Column Name INVENTORY_ITEM_ID SCHEDULE_DESIGNATOR Type Number Varchar2(10) Required x x Derived Optional 8-8 Oracle Manufacturing APIs and Open Interfaces Manual . Oracle Master Scheduling/MRP automatically validates and implements imported master schedules as new master schedules in Oracle Master Scheduling/MRP. derives any additional data as necessary. and then processes it by creating new master schedules in Oracle Master Scheduling/MRP.Open Master Schedule Interface Open Master Schedule Interface You can import master schedules from any source using the Open Master Schedule Interface. Setting Up the Open Master Schedule Interface You must define at least one organization. Since the Planning Manager decides when to call the Master Schedule Interface Load program. The Master Schedule Interface Load program validates your master schedules. item.

Open Master Schedule Interface Table 8–2 Open Master Schedule Interface Table Description Column Name ORGANIZATION_ID LAST_UPDATE_DATE LAST_UPDATED_BY CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN SCHEDULE_DATE NEW_SCHEDULE_DATE RATE_END_DATE NEW_RATE_END_DATE SCHEDULE_QUANTITY SCHEDULE_COMMENTS ERROR_MESSAGE WORKDAY_CONTROL TRANSACTION_ID PROCESS_STATUS SOURCE_CODE SOURCE_LINE_ID REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE ATTRIBUTE_CATEGORY ATTRIBUTE1 .ATTRIBUTE15 PROJECT ID TASK ID LINE ID Type Number Date Number Date Number Number Date Date Date Date Number Varchar2(240) Varchar2(240) Number Number Number Varchar2(10) Number Number Number Number Date Varchar2(30) Varchar2(150) Number(15) Number(15 Number(15 x x x x x x x x x x x x x x x x x x x x x Required x x x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-9 .

SCHEDULE_DESIGNATOR. Enter one of the following: s 1. Shift backward s s 8-10 Oracle Manufacturing APIs and Open Interfaces Manual . and SCHEDULE_QUANTITY are used by the Master Schedule Interface Load program to create new schedule entries in MRP_SCHEDULE_ DATES. Being processed 4. Processed s s s s When you first load a new schedule entry into the Open Master Schedule Interface. INVENTORY_ITEM_ID. SCHEDULE_DATE. The Master Schedule Interface Load program creates a new row in MRP_ SCHEDULE_ITEMS for each new schedule entry that refers to an item that has not been assigned to the master schedule referenced in the Open Master Schedule Interface. Optional Data Use WORKDAY_CONTROL to indicate the action that the Master Schedule Interface Load should take if it finds a schedule date or schedule end date that is not a valid workday. Do not process 2. Possible values include: s 1.Open Master Schedule Interface Legend 1: Rate-based Master Schedule Entries only Required Data ORGANIZATION_ID. Reject 2. PROCESS_STATUS indicates the current state of processing of each new schedule entry in the Open Master Schedule Interface. Derived Data ERROR_MESSAGE indicates a problem that prevents the Master Schedule Interface Load program from successfully processing a new schedule entry in the Open Master Schedule Interface. Waiting to be processed 3. Shift forward 3. set PROCESS_STATUS to 2 (Waiting to be processed). Error 5.

Master Demand Schedules can only include MPS planned or MRP planned items. The Master Schedule Interface Load deletes any existing entries in MRP_SCHEDULE_DATES with the same TRANSACTION_ID before importing the new schedule entry. Use SOURCE_CODE and SOURCE_LINE_ID to identify the source of new schedule entries. Other Validation Oracle Master Scheduling/MRP also performs the following validation: INVENTORY_ITEM_ID Must be a valid item defined IN MTL_SYSTEM_ITEMS.Open Master Schedule Interface If WORKDAY_CONTROL is set to Null. the Master Schedule Interface Load program assumes a value of 1 (Reject). see your Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual for details. For specific information on the data implied by these columns. SCHEDULE_DESIGNATOR Must be a valid. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-11 . Use TRANSACTION_ID if you wish to replace an existing entry in MRP_ SCHEDULE_DATES with a new schedule entry that you have loaded into the Open Master Schedule Interface. ORGANIZATION_ID Must be a valid organization defined in ORG_ORGANIZATION_ DEFINITIONS. Use SCHEDULE_END_DATE for rate-based master schedule entries. See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Validation Standard Validation Oracle Master Scheduling/MRP validates all required columns in the interface table. non-disabled master schedule name defined in MRP_SCHEDULE_DESIGNATORS. Master Production Schedules can only include MPS planned items.

SCHEDULE_QUANTITY Must be greater than 0 and less than or equal to 99999999. Shift forward 3. TRANSACTION_ID must match an existing TRANSACTION_ID in MRP_SCHEDULE_DATES. Shift backward s s PROCESS_STATUS Must be one of: s 1. Error 5.Open Master Schedule Interface SCHEDULE_DATE Must be less than or equal to RATE_END_DATE if RATE_END_ DATE is provided.9. This manual is available in HTML format on the documentation CD-ROM for Release 11i. Do not process 2. RATE_END_DATE Must be greater than or equal to SCHEDULE_DATE. 8-12 Oracle Manufacturing APIs and Open Interfaces Manual . Reject 2. Processed s s s s TRANSACTION_ID If provided. Resolving Failed Open Master Schedule Interface Rows Error Messages Oracle Master Scheduling/MRP may display specific error messages during interface processing. Only repetitively planned items can have a RATE_END_DATE. See Also The Oracle Applications Message Reference Manual. Being processed 4. WORKDAY_CONTROL Must be one of: s 1. Waiting to be processed 3.

correct the error in your external schedule. reset the PROCESS_ STATUS column to 2 (Waiting to be processed).Open Master Schedule Interface Viewing Failed Transactions Use Scalpels to view failed transactions in the Open Master Schedule Interface. and launch the Master Schedule Interface Load program accordingly. and set the REQUEST_ID and ERROR_MESSAGE columns to Null s The Planning Manager will detect the new rows when it next checks the Open Master Schedule Interface. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-13 . The ERROR_MESSAGE column indicates why the Master Schedule Interface Load program was unable to successfully process each failed transaction. You can either: s Delete the failed row in the Open Master Schedule Interface. and reload the corrected schedule into the Open Master Schedule Interface. or Correct the error in the Open Master Schedule Interface. Fixing Failed Transactions Options Use Scalpels to manually correct failed transactions.

The second parameter is a table defining the forecast and organization. The purpose of this essay is to explain how to use the Open Forecast Entries API so that you can integrate other applications with Oracle Master Scheduling/MRP.with two parameters. s This is achieved by the use of a PL/SQL table instead of a database table. The forecast data that needs to be imported is loaded from a table and inserted into the MRP_FORECAST_DATES parameter. Open Forecast Entries Application Program Interface PL/SQL Table Description The Open Forecast Entries Application Program Interface PL/SQL table is described in the following table: 8-14 Oracle Manufacturing APIs and Open Interfaces Manual . Inserting into the Open Forecast Entries API Tables You must load your forecast data into the T_FORECAST_INTERFACE PL/SQL table.Open Forecast Entries Application Program Interface Open Forecast Entries Application Program Interface The Open Forecast Entries Application Program Interface(API) allows you to create. replace existing forecasts. One parameter is a PL/SQL table structured the same as MRP_ FORECAST_INTERFACE. or delete forecast entries for existing forecasts and forecast sets in Oracle Master Scheduling/MRP.MRP_FORECAST_INTERFACE. and delete forecast entries within a defined forecast name or designator. and the FORECAST_DESIGNATOR PL/SQL table. Functional Overview You can process MRP Forecast Entries directly from within your calling module without running a concurrent process. This program allows you to create new forecasts. and you can manipulate data within a commit cycle controlled by the calling module. Setting Up the Open Forecast Entries API The Open Forecast Entries API is a stored PL/SQL function. it is PL/SQL based. MRP_FORECAST_INTERFACE_PK. The Open Forecast Entries API differs from the Open Forecast Interface in two ways: s There is tighter coupling between the calling interface and the MRP system. It is used for synchronous actions on the forecasting data. replace.

ATTRIBUTE15 PROJECT ID TASK ID Type Number Varchar2(10) Number Date Number Date Number Number Number Number Number Varchar2(240) Varchar2(240) Number Number Number Date Number Number Date Number Varchar2(10) Number Varchar2(150) Number(15) Number(15 x x x x x x x x x x x x x x x x x x Required x x x x x x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-15 .Open Forecast Entries Application Program Interface Table 8–3 Oracle Master Scheduling/MRP Open Forecast Entries API T_FORECAST_INTERFACE Column Name INVENTORY_ITEM_ID FORECAST_DESIGNATOR ORGANIZATION_ID FORECAST_DATE LAST_UPDATE_DATE CREATION_DATE CREATED_BY LAST_UPDATE_LOGIN QUANTITY PROCESS_STATUS CONFIDENCE_PRECENTAGE COMMENTS ERROR_MESSAGE REQUEST_ID PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE WORKDAY_CONTROL BUCKET_TYPE FORECAST_END_DATE TRANSACTION_ID SOURCE_CODE SOURCE_LINE_ID ATTRIBUTE1 .

Open Forecast Entries Application Program Interface Table 8–3 Oracle Master Scheduling/MRP Open Forecast Entries API T_FORECAST_INTERFACE Column Name LINE ID Type Number(15 Required Derived Optional x Open Forecast Interface Designator Table Description The Open Forecast Interface Designator Table is described in the following table: Table 8–4 Oracle Master Scheduling/MRP Open Forecast Interface Designator T_FORECAST_DESIGNATOR Column Name ORGANIZATION_ID FORECAST_DESIGNATOR Type Number Varchar2(10) Required x x Derived Optional Legend 1: Multiple Period Forecast Entries only Returns True if successful. FORECAST_DATE. Forecast Designator Varchar2(10) In/Out In and Out In Required Data ORGANIZATION_ID. and QUANTITY are used by the Forecast Interface Entries program to create. 8-16 Oracle Manufacturing APIs and Open Interfaces Manual . Parameters Table 8–5 Parameters Name T_FORECAST_ INTERFACE T_FORECAST_ DESIGNATOR Type Table of MRP_FORECAST_INTERFACE ROWTYPE Table of User-defined record REC_FORECAST_ DESG (Organization_id number. INVENTORY_ITEM_ID. replace. False if failure. FORECAST_DESIGNATOR. or delete forecast entries in T_FORECAST_INTERFACE.

Days 2. the Forecast Interface Load program assumes a value of 1 (Days). Enter one of the following: s 1. The values 3 (Being processed). are derived and set by the API accordingly. Use FORECAST_END_DATE for forecast entries that span multiple periods. Enter one of the following: s 1. Optional Data Use WORKDAY_CONTROL to indicate the action that the Forecast Interface Entry should take if it finds a forecast date or forecast end date that is not a valid workday. Reject 2. Use TRANSACTION_ID if you wish to replace an existing entry in MRP_ FORECAST_DATES with a new forecast entry that you have loaded into the Open Forecast Interface. Shift backward s s If WORKDAY_CONTROL is set to Null. the Forecast Interface Entry program assumes a value of 1 (Reject). Do not process 2. Shift forward 3. Waiting to be processed s When you first load a new forecast entry into the Open Forecast Entries Interface. set PROCESS_STATUS to 2 (Waiting to be processed). along with the error message column. Valid values include: s 1.Open Forecast Entries Application Program Interface PROCESS_STATUS indicates the current state of processing of each new forecast entry. Derived Data The concurrent program and WHO columns. The Forecast Interface Load deletes any existing entries in MRP_ Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-17 . 4 (Error). Weeks 3. and 5 (Processed) are used to report back to the calling program. Use BUCKET_TYPE to indicate the bucket type of each new forecast entry. Periods s s If BUCKET_TYPE is null.

Do not process 2. Waiting to be processed s FORECAST_END_DATE Must be greater than or equal to FORECAST_DATE.9. Use SOURCE_CODE and SOURCE_LINE_ID to identify the source of new forecast entries. PROCESS_STATUS Must be one of: s 1. see your Oracle Master Scheduling/MRP Reference Manual for details. FORECAST_DESIGNATOR Must be a valid. ORGANIZATION_ID Must be a valid organization defined in ORG_ORGANIZATION_ DEFINITIONS. non-disabled forecast name defined in MRP_FORECAST_DESIGNATORS. For specific information on the data implied by these columns. Must be greater than 0 and less than or equal to 99999999. FORECAST_DATE Must be less than or equal to FORECAST_END_DATE if FORECAST_END_DATE is provided.Open Forecast Entries Application Program Interface FORECAST_DATES with the same TRANSACTION_ID before importing the new forecast entry. FORECAST_QUANTITY Must be greater than 0 and less than or equal to 99999999. Other Validation Oracle Open Forecast Entries Interface also performs the following validation: INVENTORY_ITEM_ID Must be a valid item defined IN MTL_SYSTEM_ITEMS.9. See Also Oracle Master Scheduling/MRP Technical Reference Manual Validation Standard Validation Oracle Master Scheduling/MRP validates all required columns in the interface table. 8-18 Oracle Manufacturing APIs and Open Interfaces Manual .

Days 2. Periods s s TRANSACTION_ID If provided. the column ERROR_MESSAGE will indicate the error 5 the row was inserted into MRP_FORECAST_DATES s s s Replacing Forecast Entries s Populate table T_FORECAST_INTERFACE with all the forecast data that needs to be imported. The application program interface will process the rows and set the column PROCESS_STATUS to a value of either 4 or 5: – – 4 an error occurred. Using the Open Forecast Entries API Creating New Forecast Entries s Populate table T_FORECAST_INTERFACE with all the forecast data that needs to be imported. Set PROCESS_STATUS to a value of 2 for all rows. Shift forward 3.MRP _FORECAST_INTERFACE using parameter T_FORECAST_INTERFACE and T_FORECAST_ DESIGNATOR. Weeks 3. Set PROCESS_STATUS to a value of 2 for all rows. Shift backward s s BUCKET_TYPE Must be one of: s 1. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-19 . Reject 2.Open Forecast Entries Application Program Interface WORKDAY_CONTROL Must be one of: s 1. Call MRP_FORECAST_INTERFACE_PK. TRANSACTION_ID must match an existing TRANSACTION_ID in MRP_FORECAST_DATES. The Forecast Interface Entry program creates a new row in MRP_FORECAST_ ITEMS for each new forecast entry that refers to an item that has not been assigned to the forecast referenced in the Open Forecast Interface.

The application program interface will delete the existing entries for each forecast designator in T_FORECAST_DESIGNATOR. It will process the rows in T_FORECAST_INTERFACE and set the column PROCESS_STATUS to a value of either 4 or 5: – – 4 an error occurred.Open Forecast Entries Application Program Interface s Populate table T_FORECAST_DESIGNATOR with all the forecast desIgnators for which entries need to be deleted. Call MRP_FORECAST_INTERFACE_PK. s s Error Handling The Open Forecast Entries Interface program will process the rows and report the following values for every record in the FORECAST__INTERFACE entry table. Table 8–6 Record Values Condition Success Failure PROCESS_STATUS 5 4 ERROR_MESSAGE Null actual error message 8-20 Oracle Manufacturing APIs and Open Interfaces Manual . T_FORECAST_DESIGNATOR.MRP _FORECAST_INTERFACE with parameter T_FORECAST_DESIGNATOR.MRP_FORECAST_INTERFACE with the following parameters: FORECAST_INTERFACE. The application program interface will delete the existing entries for each forecast desIgnator in T_FORECAST_DESIGNATOR. Call MRP_FORECAST_INTERFACE_PK. the column ERROR_MESSAGEwill indicate the error 5 the row was inserted into MRP_FORECAST_DATES s s Deleting All Forecast Entries in Multiple Forecast Designators s Populate table T_FORECAST_DESIGNATOR with all the forecast desIgnators for which entries need to be deleted.

This section explains how to use the Sourcing Rule API and how it functions in Oracle planning products. you can process one sourcing rule or bill of distribution per call. The Sourcing Rule API consists of two objects: the Sourcing Rule object and the Assignment object. It can be used for both custom applications and legacy systems. Each of these objects consists of several entities. You can process sourcing rule entries directly from within your calling module without running a concurrent process. It is PL/SQL based. Sourcing Rule/Bill of Distribution API Features The Sourcing Rule/Bill of Distribution API object consists of three entities: Figure 8–1 Three Entities of the Sourcing Rule/Bill of Distribution API Object s Sourcing Rule/Bill of Distribution Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-21 . maintain. and delete sourcing rule or bill of distribution information in Oracle Master Scheduling/MRP and Oracle Supply Chain Planning.Sourcing Rule Application Program Interface Sourcing Rule Application Program Interface The Sourcing Rule Application Program Interface (API) is a public API that allows you to create. This API differs from the planning interfaces because it puts information directly into the Oracle Master Scheduling/MRP tables rather than inserting information into an interface table.

each row of the table specifies a receiving organization for a date range. Table: MRP_SR_SOURCE_ORG The relationships between these tables create the sourcing information used in MPS. Table: MRP_SR_RECEIPT_ORG s Shipping Organization You can process multiple shipping organizations belonging to the sourcing rule/bill of distribution. and get operations: s Process_Sourcing_Rule Accepts object specific information (through the parameters) and handles Create. Functional Overview The Sourcing Rule/Bill of Distribution API provides three public procedures for calling the create. and DRP plans. and delete receiving organizations. A sourcing rule is paired with an assignment from the MRP_SR_ASSIGNMENTS table. see: Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual. 8-22 Oracle Manufacturing APIs and Open Interfaces Manual . MRP. Update and Delete operation. and delete entries. update existing information. The MRP_ SR_SOURCE_ORG table stores data on the source suppliers for the sourcing rule or bill of distribution. delete. s Get_Sourcing_Rule Handles the Select Operation Lock_Sourcing_Rule. For more information on planning table. and delete shipping organizations. update existing information. update. update existing sourcing rule/bill of distribution information. It contains receiving organization data for material sources. The receiving organization information is in the MRP_SR_RECEIPT_ORG table. You can create new entries.Sourcing Rule Application Program Interface You can create new entries. all this information is fed into the material items and categories tables. Table: MRP_SOURCING_RULES s Receiving Organization You can process multiple receiving organizations belonging to the sourcing rule/bill of distribution. The MRP_SOURCING_RULES table stores sourcing rule names and descriptions. You can create new entries.

There is a specific order of processing information into the parameters and it is as follows: s First. Additional information on these parameters follows. Each of these three procedures first performs a check for call compatibility and then calls the respective private API. And then the shipping organization information is processed through the p_ shipping_org parameter.Sourcing Rule Application Program Interface s Select Operation Lock_Sourcing_Rule Locks records that define a particular Sourcing Rule and associated child entities.PROCESS_SOURCING_RULE The following chart describes all parameters used by the public API MRP_ SOURCING_RULE_PUB. set up and activate the following parameters: s Version number Sourcing rule Receiving organization Shipping organization s s s Procedure Parameter Descriptions MRP_SOURCING_RULE_PUB. Before using the API. Table 8–7 Parameters Parameter p_api_version_number p_init_msg_list Usage IN IN Type Number Varchar2 Required x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-23 . Next.PROCESS_SOURCING_RULE procedure. s s Setting Up the Sourcing Rule/Bill of Distribution API The Sourcing Rule API is a stored PL/SQL function. the receiving organization information is passed to the p_receiving_org parameter. Sourcing Rule information is processed by passing in through the p_ sourcing _rule_rec parameter. All of the inbound and outbound parameters are listed.

p_init_msg_list Requests that the API initialize the message list on your behalf. If the x_msg_count is greater than 1.Sourcing Rule Application Program Interface Table 8–7 Parameters Parameter p_return_values p_commit x_return_status x_msg_count x_msg_data p_sourcing_rule_rec p_sourcing_rule_val_rec p_receiving_org_tbl p_receiving_org_val_tbl p_shipping_org_tbl p_shipping_org_val_tbl x_sourcing_rule_rec x_sourcing_rule_val_rec x_receiving_org_tbl x_receiving_org_val_tbl x_shipping_org_tbl x_shipping_org_val_tbl Usage IN IN OUT OUT OUT IN IN IN IN IN IN OUT OUT OUT OUT OUT OUT Type Varchar2 Varchar2 Varchar2 Number Varchar2 Record Record PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table Record Record PL/SQL Table PL/SQL Table PL/SQL Table PL/SQL Table x x x x x x x x x x x x x Required Derived Optional x x x x p_api_version_number Used to compare the incoming API call’s version number with the current version number.GET. An error is returned if the version numbers are incompatible. then the list of messages must be retrieved using the call FND_ MSG_PUB. The values are: s p_msg_index => I p_encoded => F p_data => 1_message s s 8-24 Oracle Manufacturing APIs and Open Interfaces Manual .

If the x_msg_count is equal to 1.G_RET_STS_ERROR Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.G_FALSE p_commit Requests that the API update information for you after it completes its function. p_sourcing_rule_rec The sourcing rule or bill of distribution record referenced by the API.Sourcing Rule Application Program Interface s p_msg_index_out => 1_msg_index_out where 1_message and 1_msg_index_out are local variables of types Varchar2(2000 and Number respectively. Default Value: FND_API.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. Default Value: FND_API. Default Value: FND_API.G_FALSE p_return_values Requests that the API send back the values on your behalf. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-25 . and then returns the information for the sourcing rule/bill of distribution record. x_msg_data Displays error message text. Valid values include: s Success: FND_API. then this contains the actual message. Default Value: G_MISS_SOURCING_RULE_REC p_sourcing_rule_val_rec Resolves the values for the API.G_RET_STS_SUCCESS Error: FND_API.

Default Value: G_MISS_RECEIVING_ORG_TBL p_receiving_org_val_tbl Resolves the values for the API.Sourcing Rule Application Program Interface Default Value: G_MISS_SOURCING_RULE_VAL_REC p_receiving_org_tbl The receiving organization information listed in the rule is returned to this parameter. Default Value: G_MISS_SHIPPING_ORG_VAL_TBL x_sourcing_rule_rec Result of the API data after it completes its function for the sourcing rule/bill of distribution record. x_receiving_org_tbl Resolves the values for the API. x_receiving_org_val_tbl Resolves the values for the API. 8-26 Oracle Manufacturing APIs and Open Interfaces Manual . and then returns the information for the receiving organization listed in the sourcing rule/bill of distribution record. Default Value: G_MISS_RECEIVING_ORG_VAL_TBL p_shipping_org_tbl The shipping organization information listed in the rule is returned to this parameter. and then returns the information for the sourcing rule/bill of distribution record. and then returns the information for the receiving organization listed in the sourcing rule. and then returns the information for the receiving organization listed in the rule. and then returns the information for the shipping organization listed in the sourcing rule. x_sourcing_rule_val_rec Resolves the values for the API. Default Value: G_MISS_SHIPPING_ORG_TBL p_shipping_org_val_tbl Resolves the values for the API.

delete x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-27 . and then returns the information for the shipping organization listed in the sourcing rule/bill of distribution record. and then returns the information for the shipping organization listed in the rule. Record Parameter Descriptions SOURCING_RULE_REC_TYPE The procedure passes information to record groups and PL/SQL tables. The chart below describes all records that are used by the SOURCING_RULE_REC_TYPE record. Table 8–8 SOURCING_RULE_REC_TYPE Parameter sourcing_rule_id attribute 1 . x_shipping_org_val_tbl Resolves the values for the API. Additional information on these parameters follows.15 attribute_category created_by creation_date description last_updated_by last_update_date last_update_login organization_id planning_active program_application_id program_id program_update_date request_id Type Number Varchar2(150) Varchar2(30) Number Date Varchar2(80) Number Date Number Number Number Number Number Date Number x x x x x x x x x x x x Required x update.Sourcing Rule Application Program Interface x_shipping_org_tbl Resolves the values for the API.

8-28 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_NUM creation_date Date this program session was created. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_CHAR attribute_category The category of the flexfield described in the attribute column. Default Value: FND_API.G_MISS_NUM attribute 1 .G_MISS_CHAR created_by Identification number for user initiating this program session.G_MISS_DATE description Text describing the sourcing rule record type. Default Value: FND_API.15 Descriptive text for flexfields.Sourcing Rule Application Program Interface Table 8–8 SOURCING_RULE_REC_TYPE Parameter sourcing_rule_name sourcing_rule_type status return_status db_flag operation Type Varchar2(30) Number Number Varchar2(1) Varchar2(1) Varchar2(30) x x Required x insert x Derived Optional x x x x sourcing_rule_id Identification number for the sourcing rule or bill of distribution record referenced by the API.

G_MISS_NUM organization_id The identification number for the organization referenced in the sourcing rule or bill of distribution record. Default Value: FND_API.G_MISS_DATE last_update_login User login for user updating this program. if it is registered as a concurrent program in Oracle Application Object Library.G_MISS_NUM last_update_date Date program was last updated. Default Value: FND_API. Default Value: FND_API.Sourcing Rule Application Program Interface Default Value: FND_API.G_MISS_NUM Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-29 . Default Value: FND_API. Default Value: FND_API.G_MISS_NUM program_application_id Application identifier of the program that has made a call to the Sourcing Rule API if it is registered as a concurrent program in Oracle Application Object Library. Default Value: FND_API.G_MISS_NUM program_id Identifier of the program that has made a call to the Sourcing Rule API. Default Value: FND_API.G_MISS_NUM planning_active Rule is active when the sum of the allocation percentages equals 100.G_MISS_CHAR last_updated_by User ID for user creating this program session.

Sourcing Rule Application Program Interface program_update_date The date when the program inserts or updates the sourcing records into the appropriate tables.G_RET_STS_ERROR s 8-30 Oracle Manufacturing APIs and Open Interfaces Manual . Valid values include: s Success: FND_API. The Sourcing Rule API processes the rows and reports the following values for every record. the API will return error status to the calling module. Processing status of the sourcing rule.G_MISS_NUM sourcing_rule_name Valid name of rule defined in the MRP_SOURCING _RULES table.G_MISS_CHAR sourcing_rule_type Valid types must be one of the following values: s (1) Sourcing Rule (2) Bill of Distribution s Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API. Default Value: FND_API.the Status attribute is set to 1.G_MISS_DATE request_id The request ID determines which profile values are used as a default. If the sourcing rule does not already exist in the system .G_MISS_NUM status If any validation fails. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM return_status Processing status of the API after it completes its function. valid values are: s (1) (2) s Default Value: FND_API.

Valid values include: s Create Update Delete s s Default Value: FND_API. updated. Default Value: FND_API.Sourcing Rule Application Program Interface s Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR Default Value: FND_API. Additional information on these parameters follows.G_MISS_CHAR See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual RECEIVING_ORG_REC_TYPE The procedure passes information to record groups and PL/SQL tables.G_MISS_CHAR operation Indicator of whether the record is inserted. Table 8–9 RECEIVING_ORG_REC_TYPE Parameter sr_receipt_id attribute 1 .G_MISS_CHAR db_flag Indicator of the record existing in the database.15 attribute_category created_by creation_date disable_date effective_date Type Number Varchar2(150) Varchar2(30) Number Date Date Date x x x x Required x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-31 . or deleted. The chart below describes all records that are used by the RECEIVING_ORG_REC_TYPE record.

15 Descriptive text for flexfields. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM 8-32 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API.G_MISS_NUM attribute 1 .G_MISS_CHAR created_by Identification number for user initiating this program session.G_MISS_CHAR attribute_category The category of the flexfield described in the attribute column.Sourcing Rule Application Program Interface Table 8–9 RECEIVING_ORG_REC_TYPE Parameter last_updated_by last_update_date last_update_login program_application_id program_id program_update_date receipt_organization_id request_id sourcing_rule_id return_status db_flag operation Type Number Date Number Number Number Date Number Number Number Varchar2(1) Varchar2(1) Varchar2(30) x x x x x x Required Derived x x x x x x Optional sr_receipt_id Identification number for the receiving organization referenced in the sourcing rule or bill of distribution record.

Default Value: FND_API. Default Value: FND_API.G_MISS_NUM program_id Identifier of the program that has made a call to the Sourcing Rule API. Default Value: FND_API.G_MISS_NUM program_application_id Application identifier of the program that has made a call to the Sourcing Rule API if it is registered as a concurrent program in Oracle Application Object Library. Default Value: FND_API.G_MISS_DATE disable_date Date the receipt organization is no longer effective.G_MISS_DATE last_update_login User login for user updating this program. Default Value: FND_API. Default Value: FND_API. if it is registered as a concurrent program in Oracle Application Object Library.G_MISS_DATE effective_date Beginning date the receipt organization becomes effective.G_MISS_DATE last_updated_by User ID for user creating this program session.G_MISS_NUM Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-33 .G_MISS_NUM last_update_date Date program was last updated.Sourcing Rule Application Program Interface creation_date Date this program session was created. Default Value: FND_API. Default Value: FND_API.

G_RET_STS_UNEXP_ERROR s s Default Value: FND_API. Valid values include: s Success: FND_API.G_MISS_NUM sourcing_rule_id Identification number for the sourcing rule or bill of distribution record referenced by the API.G_MISS_NUM request_id The request ID determines which profile values are used as a default. Default Value: FND_API.G_MISS_DATE receipt_organization_id Identifier of the organization that serves as the destination for the sourcing rule or bill of distribution. Default Value: FND_API.G_MISS_CHAR db_flag Indicator of the record existing in the database.G_MISS_CHAR operation Indicator of whether the record is inserted. updated.G_RET_STS_SUCCESS Error: FND_API. Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API.Sourcing Rule Application Program Interface program_update_date The date when the program inserts or updates the sourcing records into the appropriate tables. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM return_status Processing status of the API after it completes its function. or deleted. Valid values include: s Create 8-34 Oracle Manufacturing APIs and Open Interfaces Manual .

The chart below describes all records that are used by the SHIPPING_ORG_REC_TYPE record.Sourcing Rule Application Program Interface s Update Delete s Default Value: FND_API. Table 8–10 Parameter sr_source_id allocation_percent attribute 1 .15 attribute_category created_by creation_date last_updated_by last_update_date last_update_login program_application_id program_id program_update_date rank request_id secondary_inventory ship_method source_organization_id source_type sr_receipt_id SHIPPING_ORG_REC_TYPE Type Number Number Varchar2(150) Varchar2(30) Number Date Number Date Number Number Number Date Number Number Varchar2(10) Varchar2(30) Number Number Number x x x x x x x x x x x x x Required x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-35 .G_MISS_CHAR SHIPPING_ORG_REC_TYPE The procedure passes information to record groups and PL/SQL tables. Additional information on these parameters follows.

Default Value: FND_API.15 Descriptive text for flexfields.G_MISS_NUM allocation_percent Percentage allocated to each source organization/supplier site destination. Default Value: FND_API.G_MISS_NUM creation_date Date this program session was created. Default Value: FND_API.G_MISS_CHAR attribute_category The category of the flexfield described in the attribute column.G_MISS_CHAR created_by Identification number for user initiating this program session.G_MISS_NUM attribute 1 . Default Value: FND_API.G_MISS_DATE 8-36 Oracle Manufacturing APIs and Open Interfaces Manual .Sourcing Rule Application Program Interface Table 8–10 Parameter vendor_id SHIPPING_ORG_REC_TYPE Type Number Number Varchar2(1) Varchar2(1) Varchar2(30) Number x x x Required Derived Optional vendor_site_id return_status db_flag operation receiving_org_index sr_source_id Primary key in the sourcing rule or bill of distribution table. Default Value: FND_API. Default Value: FND_API.

Default Value: FND_API. Default Value: FND_API.G_MISS_NUM program_id Identifier of the program that has made a call to the Sourcing Rule API. Default Value: FND_API. Default Value: FND_API. if it is registered as a concurrent program in Oracle Application Object Library.G_MISS_DATE rank Rank of the sources. Default Value: FND_API.G_MISS_NUM program_application_id Application identifier of the program that has made a call to the Sourcing Rule API if it is registered as a concurrent program in Oracle Application Object Library.G_MISS_DATE last_update_login User login for user updating this program.G_MISS_NUM Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-37 .Sourcing Rule Application Program Interface last_updated_by User ID for user creating this program session.G_MISS_NUM last_update_date Date program was last updated.G_MISS_NUM request_id The request ID determines which profile values are used as a default. Default Value: FND_API. valid values are non-zero integers. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM program_update_date The date when the program inserts or updates the sourcing records into the appropriate tables.

Default Value: FND_API. Default Value: FND_API.G_MISS_NUM sr_receipt_id Identification number for the receiving organization referenced in the sourcing rule or bill of distribution record.G_MISS_NUM vendor_site_id Identifier where the vendor’s materials are located. Default Value: FND_API.G_MISS_CHAR source_organization_id Identifier of the source organization. Default Value: FND_API. Valid values are: s Make Transfer Buy s s Default Value: FND_API. Default Value: FND_API. ship_method Method used when transporting material between source and destination.G_MISS_NUM source_type Indicator of the type of source.G_MISS_NUM 8-38 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_NUM vendor_id Identifier of the vendor suppling the materials.Sourcing Rule Application Program Interface secondary_inventory Not currently used.

Default Value: FND_API. or deleted.Sourcing Rule Application Program Interface return_status Processing status of the API after it completes its function.G_MISS_CHAR receiving_org_index Foreign key to the receipt organization PL/SQL table.G_RET_STS_ERROR Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR s s Default Value: FND_API.G_MISS_CHAR db_flag Indicator of the record existing in the database.G_MISS_CHAR operation Indicator of whether the record is inserted. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API.G_MISS_NUM See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-39 . Valid values include: s Create Update Delete s s Default Value: FND_API. Valid values include: s Success: FND_API. updated.

The organization_id attribute is associated with a valid organization. sourcing_rule_type: must be a either (1) Sourcing Rule or (2) Bill of Distribution. s When you create a new sourcing rule. pass in a Boolean constant defined in FND_API (G_TRUE or G_FALSE). If you do not want to update a particular column in: s MRP_SOURCING_RULE_PUB. it will check the allocation percent for each receiving organization that belongs to the sourcing rule or bill of distribution. the following record level validations occur: s organization_id: must be a valid organization defined in ORG_ ORGANIZATION_DEFINITIONS. the following object level validations occur: s At least one receiving organization record is created. Otherwise the attribute is set to 2.If the sourcing rule does not already exist in the system .. unless it is null. or do not pass any value at all. For specific information on the data implied by these columns. 8-40 Oracle Manufacturing APIs and Open Interfaces Manual .). For all flag parameters. see your Oracle Master Scheduling/MRP Technical Reference Manual for details. Either use one of the missing parameter constants defined in the FND_API package (G_MISS_. s When you create a new sourcing rule. If the total allocation percent is 100.. Creating Sourcing Rule API Entries When you create a new sourcing rule the following item level validations: s sourcing_rule_name: must be defined in the MRP_SOURCING _RULES table. the plannning_active attribute is set to a value of 1. Each time the API is called.the Status attribute is set to 1.PROCESS_SOURCING_RULE do not enter NULL for its corresponding interface parameter unless the default in the PL/SQL specification is NULL.Sourcing Rule Application Program Interface Validation of Sourcing Rule /Bill of Distribution API Standard Validation Oracle Master Scheduling/MRP validates all required columns in the Sourcing Rule/Bill of Distribution API.

Sourcing Rule Application Program Interface s At least one shipping organization record is created. the following record level validation occurs: s Required attributes are either sourcing_rule_id. s When you update an existing sourcing rule.e and organization_id. Deleting Sourcing Rule API Entries You cannot delete a sourcing rule if assignment data exists for the rule. When you delete an existing sourcing rule. Updating Sourcing Rule API Entries When you update an existing sourcing rule. Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-41 . If validation is successful. When you delete an existing sourcing rule. the API returns a success status to the calling module. a record is inserted into the MRP_SOURCING_RULES table. the following item level validations occur: s If the sourcing rule name is changed. or sourcing _rule_name. and all flexfields must be validated. If validation is successful. the following record level validations occur: s Required attributes are either sourcing_rule_id. The organization cannot be changed and the sourcing rule type cannot be changed. the new name cannot already exist in the system. a record is updated in the MRP_SOURCING_RULES table. the following object level validations occur: s All receiving organization records associated with the rule/bill of distribution record in the MRP_SR_RECEIPT_ORG table. The sourcing rule/bill of distribution record from MRP_SOURCING_RULES table. All shipping organization records associated with the rule/bill of distribution record in the MRP_SR_SOURCE_ORG table. and organization_id. s s If deletion is successful. or sourcing _rule_nam.

Sourcing Rule Application Program Interface Error Handling If any validation fails. Table 8–11 Record Values Condition Success Failure PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Applications Message Reference Manual 8-42 Oracle Manufacturing APIs and Open Interfaces Manual . The Sourcing Rule API processes the rows and reports the following values for every record. the API will return error status to the calling module.

These assignments are grouped together in sets. update existing assignment information. Table: MRP_ASSIGNMENT_SETS s Assignment You can process multiple assignments belonging to the sourcing rule/bill of distribution. See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-43 . For example. Table: MRP_SR_ASSIGNMENTS The relationship between these tables create the sourcing assignment information used in MPS. The following chart demonstrates the relationship between the assignment object and the sourcing rule /bill of distribution object: Figure 8–2 Relationship Between the Assignment Object and the Sourcing Rule/Bill of Distribution Object s Assignment Set You can create new entries.Sourcing Rule Application Program Interface Sourcing Rule Assignment API Features The Sourcing Rule Assignment API object consists of two entities. This includes creating new. you must assign them to items and organizations. or just in an inventory organization. Once you have defined your sourcing rules and bills of distribution. you may assign an items in all organizations. updating or deleting existing entries. The MRP_ASSIGNMENT_SET table stores assignment set names and the different levels of assignment. MRP. and DRP plans. The MRP_SR_ASSIGNMENTS table stores data on the sourcing rule or bill of distribution for the assignment. and delete entries.

Update and Delete Operation. s Setting Up the Sourcing Rule Assignment API The Sourcing Rule Assignment API is a stored PL/SQL function.Sourcing Rule Application Program Interface Functional Overview The Sourcing Assignment API provides three public procedures for calling the create. There is a specific order of processing information into the parameters and it is as follows: s Assignment set information is processed by passing in through the p_ assignment_set_rec table parameter. Next. the assignment information is passed to the p_assignment_set_tbl table parameter. Each of these three procedures first performs a check for call compatibility and then calls the respective private API. Before using the API. s Get_Assignment Handles the Select Operation Lock_Assignment. update. delete and get operations: s Process_Assignment Accepts object specific information (through the parameters) and handles Create. s Select Operation Lock_Assignment Locks records that define a particular Sourcing Rule and associated child entities. set up and/or activate the following parameters: s Version number Sourcing Assignment Set Number Assignment records s s 8-44 Oracle Manufacturing APIs and Open Interfaces Manual . You need to define certain data before you create or update assignment information.

PROCESS_ASSIGNMENT The table below describes all parameters that are used by the public API MRP_ SRC_ASSIGNMENT_PUB. Table 8–12 Parameter p_api_version_number p_init_msg_list p_return_values p_commit x_return_status x_msg_count x_msg_data p_assignment_set_rec p_assignment_set_val_ rec p_assignment_tbl p_assignment_val_tbl x_assignment_set_rec x_assignment_set_val_ rec x_assignment_tbl x_assignment_val_tbl Inbound and Outbound Parameters Usage IN IN IN IN OUT OUT OUT IN IN IN IN OUT OUT OUT OUT Type Number Varchar2 Varchar2 Varchar2 Varchar2 Number Varchar2 Record Record PL/SQL Table PL/SQL Table Record Record PL/SQL Table PL/SQL Table x x x x x x x x x Required x x x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-45 . Additional information on these parameters follows.Sourcing Rule Application Program Interface Procedure Parameter Descriptions MRP_SRC_ASSIGNMENT_PUB.PROCESS_ASSIGNMENTprocedure. All of the inbound and outbound parameters are listed.

GET.Sourcing Rule Application Program Interface p_api_version_number Used to compare the incoming API call’s version number with the current version number. An error is returned if the version numbers are incompatible. Default Value: FND_API. If the x_msg_count is equal to 1. p_assignment_set_rec Enter the assignment set record.G_RET_STS_ERROR Unexpected Error: FND_API.G_RET_STS_UNEXP_ERROR s s x_msg_count Indicates number of error messages API has encountered.G_FALSE p_return_values Requests that the API send back the values on your behalf. Default Value: G_MISS_ASSIGNMENT_SET_REC 8-46 Oracle Manufacturing APIs and Open Interfaces Manual . p_init_msg_list Requests that the API initialize the message list on your behalf. Valid values include: s Success: FND_API. Default Value: FND_API.G_FALSE p_commit Requests that the API update information for you after it completes its function. If the x_msg_count is greater than 1. then this contains the actual message.G_FALSE x_return_status Requests that the API return the status of the data for you after it completes its function. x_msg_data Displays error message text. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API. then the list of messages must be retrieved using the call FND_ MSG_PUB.

Sourcing Rule Application Program Interface p_assignment_set_val_rec Resolves the values for the API. x_assignment_tbl References the assignment listed in the assignment set. and then returns the information for the assignment set listed in the sourcing rule/bill of distribution record. Resolves the values for the API. See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-47 . Default Value: G_MISS_ASSIGNMENT_TBL p_assignment_val_tbl Resolves the values for the API. and then returns the information for the assignment set listed in the rule. Default Value: G_MISS_ASSIGNMENT_SET_VAL_REC p_assignment_tbl References the assignment parameters listed in the assignment set. x_assignment_set_val_rec Resolves the values for the API. and then returns the information for the assignment set listed in the sourcing rule/bill of distribution record. x_assignment_val_tbl Resolves the values for the API. and then returns the information for the assignment set listed in the sourcing rule/bill of distribution record. Default Value: G_MISS_ASSIGNMENT_VAL_TBL x_assignment_set_rec The assignment set record. and then returns the information for the assignment set listed in the rule.

The table below describes all record parameters that are used by the ASSIGNMENT_SET_ REC_TYPE record. Additional information on these parameters follows.Sourcing Rule Application Program Interface Record Parameter Descriptions ASSIGNMENT_SET_REC_TYPE The procedure passes information to record groups and PL/SQL tables. Table 8–13 Parameter assignment_set_id assignment_set_name attribute 1 .15 attribute_category created_by creation_date description last_updated_by last_update_date last_update_login program_application_id program_id program_update_date request_id return_status db_flag operation ASSIGNMENT_SET_REC_TYPE Type Number Varchar2(30) Varchar2(150) Varchar2(30) Number Date Varchar2(80) Number Date Number Number Number Date Number Varchar2(1) Varchar2(1) Varchar2(30) x x x x x x x x x x x x x Required x x x x Derived Optional assignment_set_id Identification number for the assignment set record referenced by the API. Default Value: FND_API.G_MISS_NUM 8-48 Oracle Manufacturing APIs and Open Interfaces Manual .

G_MISS_CHAR attribute_category The category of the flexfield described in the attribute column. Default Value: FND_API. Default Value: FND_API.G_MISS_DATE description Text describing the sourcing rule record type.Sourcing Rule Application Program Interface assignment_set_name Valid name of the assignment set defined in the MRP_ASSIGNMENT_SETS table. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_DATE Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-49 .G_MISS_NUM last_update_date Date program was last updated.G_MISS_CHAR last_updated_by User ID for user creating this program session.G_MISS_CHAR created_by Identification number for user initiating this program session.15 Descriptive text for flexfields. Default Value: FND_API.G_MISS_CHAR attribute 1 . Default Value: FND_API.G_MISS_NUM creation_date Date this program session was created. Default Value: FND_API.

Default Value: FND_API. Default Value: FND_API.G_RET_STS_UNEXP_ERROR s s Default Value: FND_API.G_MISS_NUM program_update_date The date when the program inserts or updates the sourcing records into the appropriate tables.G_MISS_CHAR db_flag Indicator of the record existing in the database.G_MISS_NUM return_status Processing status of the API after it completes its function. Default Value: FND_API. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API.G_MISS_CHAR 8-50 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_NUM program_application_id Application identifier of the program that has made a call to the Sourcing Rule API if it is registered as a concurrent program in Oracle Application Object Library. Valid values include: s Success: FND_API.Sourcing Rule Application Program Interface last_update_login User login for user updating this program.G_MISS_NUM program_id Identifier of the program that has made a call to the Sourcing Rule API. if it is registered as a concurrent program in Oracle Application Object Library. Default Value: FND_API. Default Value: FND_API.G_MISS_DATE request_id The request ID determines which profile values are used as a default.

15 attribute_category category_id category_set_id created_by creation_date customer_id inventory_item_id last_updated_by last_update_date Parameters Type Number Number Number Varchar2(150) Varchar2(30) Number Number Number Date Number Number Number Date Required x x x x Derived Optional Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-51 . Valid values include: s Create Update Delete s s Default Value: FND_API. updated.Sourcing Rule Application Program Interface operation Indicator of whether the record is inserted. Additional information on these parameters follows. The table below describes all record parameters that are used by the ASSIGNMENT_REC_ TYPE record. or deleted.G_MISS_CHAR See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual ASSIGNMENT_REC_TYPE The procedure passes information to record groups and PL/SQL tables. Table 8–14 Parameter assignment_id assignment_set_id assignment_type attribute 1 .

G_MISS_NUM assignment_type Valid types of sourcing assignments include the following values: s (1) Global (2) Category (3) Item (4) Organization (5) Category/Organization s s s s 8-52 Oracle Manufacturing APIs and Open Interfaces Manual .G_MISS_NUM assignment_set_id Identification number for the assignment set record referenced by the API. Default Value: FND_API. Default Value: FND_API.Sourcing Rule Application Program Interface Table 8–14 Parameter Parameters Type Number Number Number Number Date Number Varchar2(10) Number Number Number Varchar2(1) Varchar2(1) Varchar2(30) x Required Derived Optional last_update_login organization _id program_application_id program_id program_update_date request_id secondary_inventory ship_to_site_id sourcing_rule_id sourcing_rule_type return_status db_flag operation assignment_id Identification number for the assignment record referenced by the API.

G_MISS_DATE customer_id Identification number for the customer record referenced by the API.G_MISS_NUM creation_date Date this program session was created. Default Value: FND_API. Default Value: FND_API.15 Descriptive text for flexfields.G_MISS_NUM inventory_item_id Identification number for the item record referenced by the API.G_MISS_CHAR created_by Identification number for user initiating this program session. Default Value: FND_API.G_MISS_NUM last_update_date Date program was last updated.G_MISS_DATE Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-53 .G_MISS_CHAR attribute_category The category of the flexfield described in the attribute column. Default Value: FND_API. Default Value: FND_API.G_MISS_NUM last_updated_by User ID for user creating this program session. Default Value: FND_API.G_MISS_NUM attribute 1 . Default Value: FND_API. Default Value: FND_API.Sourcing Rule Application Program Interface s (6) Item/Organization Default Value: FND_API.

G_MISS_NUM program_update_date The date when the program inserts or updates the sourcing records into the appropriate tables. program_application_id Application identifier of the program that has made a call to the Sourcing Rule API if it is registered as a concurrent program in Oracle Application Object Library.G_MISS_NUM program_id Identifier of the program that has made a call to the Sourcing Rule API. ship_to_site_id Used with customer identification attribute and organization assignment type to define shipping location. Default Value: FND_API.G_MISS_NUM organization_id The identification number for the organization referenced in the assignment record.Sourcing Rule Application Program Interface last_update_login User login for user updating this program. Default Value: FND_API. Default Value: FND_API. Default Value: FND_API.G_MISS_DATE request_id The request ID determines which profile values are used as a default.G_MISS_NUM 8-54 Oracle Manufacturing APIs and Open Interfaces Manual . Default Value: FND_API. if it is registered as a concurrent program in Oracle Application Object Library. Default Value: FND_API.G_MISS_NUM secondary_inventory Currently not used.

G_MISS_CHAR operation Indicator of whether the record is inserted.G_MISS_CHAR db_flag Indicator of the record existing in the database. Default Value: FND_API. updated.G_MISS_CHAR See Also Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Technical Reference Manual Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-55 .G_RET_STS_UNEXP_ERROR s s Default Value: FND_API. Default Value: FND_API.G_RET_STS_SUCCESS Error: FND_API. Valid values include: s Create Update Delete s s Default Value: FND_API.G_RET_STS_ERROR Unexpected Error: FND_API. or deleted. Valid values include: s Success: FND_API.Sourcing Rule Application Program Interface sourcing_rule_id Identification number for the sourcing rule or bill of distribution record referenced by the API.G_MISS_NUM sourcing_rule_type Valid types must be one of the following values: s (1) Sourcing Rule (2) Bill of Distribution s Default Value: FND_API.G_MISS_NUM return_status Processing status of the API after it completes its function.

ship-to -site id. see your Oracle Master Scheduling/MRP Reference Manual for details. sourcing rule type Organization—organization id. the following record level validations occur: s Assignment type attributes are conditionally required: s Global—sourcing rule type Category—item/category. customer id. Item-Org Sourcing_rule_id Assignment_set_id Organization_id s s s When you create a new assignment. For each call. For specific information on the data implied by these columns. the procedure performs a check for call compatibility and then processes the assignment set and the assignment information. sourcing rule type s s s 8-56 Oracle Manufacturing APIs and Open Interfaces Manual .PROCESS_ASSIGNMENT do not enter NULL for its corresponding interface parameter unless the default in the PL/SQL specification is NULL.. Creating Assignment API Entries When you create a new assignment. the following item level validations occur: s Assignment_type must be Global Category. If you do not want to update a particular column in: s MRP_SRC_ASSIGNMENT_PUB. sourcing rule type Item—tem/category.. organization.). For all flag parameters. Either use one of the missing parameter constants defined in the FND_API package (G_MISS_. pass in a Boolean constant defined in FND_API (G_TRUE or G_FALSE). or do not pass any value at all. item.Sourcing Rule Application Program Interface Validation of Sourcing Rule Assignment API Standard Validation Oracle Master Scheduling/MRP validates all required columns in the Sourcing Assignment API. Category-Org.

s s s s s s When you update an assignment. global sourcing rule Item—bill of distribution. If validation is successful. global sourcing rule Category—bill of distribution. global sourcing rule Organization—local sourcing rule. customer id. sourcing rule type Item-Org— organization id. the following object level validations occur: s Sourcing rules or bills of distribution are applicable to different assignment types: s Global—bill of distribution. Updating Assignment API Entries When you update an existing assignment. the following record level validation occurs: Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 8-57 . sourcing rule type s When you create a new assignment. global sourcing rule Category-Org—local sourcing rule. ship-to -site id. item/category. customer id. item/category. the following item level validations occur: s Assignment_type Sourcing_rule_id Assignment_set_id Organization_id Assignment_id attribute If the assignment set name is changed. global sourcing rule s s s s s s API can only assign a sourcing rule or bill of distribution to a category if there is a default value in the profile option MRP:Sourcing Rule Category Set.Sourcing Rule Application Program Interface s Category-Org—organization id. the new name cannot already exist in the system. a record is inserted into the MRP_SR_ASSIGNMENTS table. Either assignment set name or assignment set id is required. global sourcing rule Item-Org—local sourcing rule. ship-to -site id.

Sourcing Rule Application Program Interface s Assignment type attributes are conditionally required depending on assignment type. a record is updated in the MRP_ASSIGNMENT_SETS table. the following object level validation occurs: Sourcing rules or bills of distribution are applicable to different assignment types. The Sourcing Assignment API processes the rows and reports the following values for every record. The assignment record is deleted from MRP_SR_ASSIGNMENT table. See: Creating Assignment API Entries. the API will return error status to the calling module. When you update an assignment. See: Creating Assignment API Entries. s s If validation is successful. the following item level validations occur: s Assignment_id is required. Deleting Assignment API Entries When you delete an existing assignment set. s Error Handling If any validation fails. Table 8–15 Condition Success Failure Record Values PROCESS_STATIS 5 4 ERROR_MESSAGE null actual error message See Also Oracle Applications Message Reference Manual 8-58 Oracle Manufacturing APIs and Open Interfaces Manual .

9 Oracle Shop Floor Management Open Interfaces This chapter contains information about the following Oracle Shop Floor Management open interfaces and application program interfaces: s Import Lot Jobs Concurrent Program on page 9-2 Lot Move Transactions Concurrent Program on page 9-17 Import WIP Lot Transactions Concurrent Program on page 9-37 Inventory Lot Transactions Interface Concurrent Program on page 9-91 s s s Oracle Shop Floor Management Open Interfaces 9.1 .

Import Lot Based Jobs interface has two major components. These profile options allow fine tuning to optimize processing and reduce the total execution time depending on system processor availability and memory capability. Figure 9–1 below describes the basic flow of the Import Lot Jobs Concurrent Program. There are two profile options that can be adjusted according to capability and workload: Maximum number of import lot job workers. When specifying values for these options. and maximum number of rows processed by a lot based job worker as a batch. The first one relates to the import of lot based jobs for the first sector. 9-2 Oracle Manufacturing APIs and Open Interfaces Manual . while the second component relates to import/ creation of lot jobs for subsequent sectors. you can use the lot based job forms to view the job and carry out subsequent move transactions through a move transaction form or move interface. Maximum number of import lot job workers sets the number of worker programs launched in parallel that process rows from wsm_lot_job_interface table. the total available memory and the load profile of the system should be taken into account. Once the lot jobs are imported successfully. The values for these two options are typically set by the database administrator. The Import Lot Based Job program validates the data and then imports the lot based job data from MES into Oracle Applications. The lot based job data from MES is inserted into the WSM_LOT_JOB_ INTERFACE table by running a script. Maximum number of rows processed by a lot based job worker as a batch specifies the number of rows from the interface table each worker can process at a time.Import Lot Jobs Concurrent Program Import Lot Jobs Concurrent Program You can insert records into the import jobs interface from any manufacturing execution system or any other third party planning system. Import lot based jobs are processed in parallel based on user-configurable parameters set at installation.

Import Lot Jobs Concurrent Program Figure 9–1 Basic Flow of the Import Lot Jobs Concurrent Program Oracle Shop Floor Management Open Interfaces 9-3 .

This lot is released and moves through a series of operations to an inventory location. where it becomes an Inventory Lot. additionally. WIP_OPERATION_RESOURCES. if the job is in released status. MODE_FLAG has a value 2 when a WIP lot is created from an Inventory lot under these circumstances. and.Import Lot Jobs Concurrent Program Import Lot Jobs Concurrent Program Features There are two modes of lot based jobs. WIP_REQUIREMENT_ OPERATIONS. All these types of transactions create records in the existing WIP tables. one for the first sector and one for the other subsequent sectors. WIP_ ENTITIES. The two modes are discriminated by the MODE_FLAG value. A mode 2 job. A mode 1 job creates records into the following WIP base tables: WIP_DISCRETE_JOBS. Creation of a lot for the first sector is indicated by a MODE_FLAG value of 1. WIP_PERIOD_BALANCES. WIP_OPERATIONS. The Inventory Lot then moves into the next BOM level where it becomes a primary component for a new WIP lot in the next sector. creates rows into MTL_MATERIAL_TRANSACTIONS. 9-4 Oracle Manufacturing APIs and Open Interfaces Manual . WIP_OPERATIONAL_YIELDS.

For a mode 1 job. if any. 2. For creating a mode 1 job. inserts a row into WSM_STARTING_LOTS_INTERFACE table. Oracle Shop Floor Management Open Interfaces 9-5 . additionally. The processor selects only rows from WLJI which are in the Pending status. For creating a mode 2 job. For a mode 2 job. the HEADER_ ID of the row in WSM_STARTING_LOTS_INTERFACE table should be equal to the SOURCE_LINE_ID of the corresponding row in WSM_LOT_JOB_ INTERFACE. All these rows are internally assigned GROUP_IDs and assigned to workers launched by the import program. HEADER_ID is a NOT NULL column and it should be unique. the user. SOURCE_LINE_ID will have NULL. The processor code uses the HEADER_ID as a unique identifier for each row in the interface table. 3. Errors and warnings. Errors and Validations: 4. Appropriate messages are also given inthe interface tables to refer to the WSM_INTERFACE_ERRORS table when there is any error. the user has to take care that the HEADER_ID column is populated using some sequence. the user inserts a row into WSM_LOT_JOB_ INTERFACE. are written into the WSM_INTERFACE_ERRORS table. While populating the interface table.Import Lot Jobs Concurrent Program Functional Overview Following are the major design features of this interface: 1.

Rescheduling suggestions on start and end dates will be supported. Update of status of existing jobs. updating alternate BOM and routing designator is supported. 6.Import Lot Jobs Concurrent Program Calling the Import Lot Based Jobs Concurrent Program In Oracle Shop Floor Management. that particular row is errored out. updating BOM and routing reference is supported. Update of co-product supply flag is supported. 5. Table 9–1 Error Handling Table Condition Failure Running New Record PROCESS_STATUS 3 2 1 ERROR_MESSAGE actual error message null null Load type of 5 should be used when creating a new lot based job. Update of quantity of non-transacted jobs. 4. For unreleased standard lot based job. For unreleased non-standard lot based job. Error Handling If any validation fails. 3. The Import Lot Based Jobs Concurrent Program processes the rows and reports the following values for every record. select Import Lot Based Jobs. 2. 9-6 Oracle Manufacturing APIs and Open Interfaces Manual . Validation of Import Lot Based Jobs Standard Oracle Shop Floor Management validates all required columns in the Import Lot Based Jobs Concurrent Program. from the Run Requests menu. Load type 6 indicates that an update will be performed on an exsiting job. The following update scenarios are currently supported: 1.

Import Lot Jobs Concurrent Program Oracle Shop Floor Management Open Interfaces 9-7 .

Create Lot based Job 2 .prog_ appl_id x program_id number program_application_ id program_update_date group_id number date number wsm_lot_ job_ interface_s x source_code varchar2(30) x 9-8 Oracle Manufacturing APIs and Open Interfaces Manual .lot created from an inventory lot last_update_date last_updated_by date number x x Fnd_ global. Some columns are not used by the program and marked as ignored.user_ id x creation date created_by date number x x Fnd_ global.conc_ request_id fnd_ global.user_ id x last_update_login request_id number number fnd_ global.comc _program_ id fnd_ global. Table 9–2 WSM_LOT_JOB_INTERFACE (WLJI) Table Column mode_flag Type number Required x Derived Optional Permitted Values 1 .Import Lot Jobs Concurrent Program WSM_LOT_JOB_ INTERFACE Table The following table lists the columns in the WSM_LOT_JOB_ INTERFACE table and provides their load/update type and validation information.

Job update status_type number x 1 .Released 4 .Job creation 6 .Unreleased 3 .Canceled old_status_type last_unit_completion_ date old_completion_date processing_work_days daily_production_rate line_id primary_item_id bom_reference_id routing_reference_id bom_revision_date routing_revision_date number date x Ignored This column or the first_ unit_completion_date are required.On hold 7 . Ignored Ignored Ignored Ignored x x x x x Derived Optional Permitted Values process_type organization_id load_type number number number date number number number number number number date date Oracle Shop Floor Management Open Interfaces 9-9 .Import Lot Jobs Concurrent Program Table 9–2 WSM_LOT_JOB_INTERFACE (WLJI) Table Column source_line_id Type number Required required for mode_ flag 2 Ignored x x 5 .Complete 6 .

Yes 2 .Import Lot Jobs Concurrent Program Table 9–2 WSM_LOT_JOB_INTERFACE (WLJI) Table Column wip_supply_type Type number Required Derived Optional Permitted Values 1 .15 varchar2(10) varchar2(10) varchar2(30) number number number number varchar2(2000 ) number varchar2(30) varchar2(150) x x Ignored x x (for load type 6) Ignored Ignored Ignored x Ignored x x Ignored x x Ignored last_updated_by_name varchar2(100) 9-10 Oracle Manufacturing APIs and Open Interfaces Manual .Push 2 .Operation Pull 4 .Based on BOM class_code lot_number lot_control_code job_name description firm_planned_flag varchar2(10) varchar2(30) number varchar2(240) varchar2(240) number x x x 1 .Vendor 6 .Assembly Pull 3 .No alternate_routing_ designator alternate_bom_ designator demand_class start_quantity old_start_quantity wip_entity_id repetitive_schedule_id error parent_group_id attribute_category attribute1 .Bulk 5 .

Import Lot Jobs Concurrent Program Table 9–2 WSM_LOT_JOB_INTERFACE (WLJI) Table Column created_by_name process_phase process_status organization_code first_unit_start_date Type varchar2(100) number number varchar2(3) date x x x This column or the last_ unit_completion_date are required.Lead time 3 . Ignored Ignored x 2 .Manual line_code primary_item_ segments bom_reference_ segments routing_reference_ segments routing_revision bom_revision completion_ subinventory completion_locator_id completion_locator_ segments schedule_group_id schedule_group_name build_sequence project_id varchar2(10) varchar2(2000 ) varchar2(2000 ) varchar2(2000 ) varchar2(3) varchar2(3) varchar2(10) number varchar2(2000 ) number varchar2(30) number number x x x Ignored x x x x Ignored x Ignored Ignored Ignored Ignored Required Derived Optional Permitted Values Ignored Ignored 1 .Pending first_unit_completion_ date last_unit_start_date scheduling method date date number Oracle Shop Floor Management Open Interfaces 9-11 .

Import Lot Jobs Concurrent Program Table 9–2 WSM_LOT_JOB_INTERFACE (WLJI) Table Column project_name task_id task_name net_quantity descriptive_flex_ segments project_number task_number project_costed end_item_unit_ number overcompletion_ tolerance_type overcompletion_ tolerance_value kanban_card_id priority due_date allow_explosion header_id delivery_id error_code error_msg interface_id Type varchar2(30) number varchar2(20) number varchar2(2000 ) varchar2(25) varchar2(25) number varchar2(30) number number number number date varchar2(1) number number number varchar2(2000 ) number x x Ignored x x Ignored x x Ignored Ignored Ignored Ignored Ignored Ignored Ignored Ignored Required Derived Optional Permitted Values Ignored Ignored Ignored Control Columns The following columns are control columns for the Import Lot Based Jobs program. 9-12 Oracle Manufacturing APIs and Open Interfaces Manual .

Possible PROCESS_STATUS values include: s 1 Pending 2 Running 3 Error s s Records should be inserted into the WSM_LOT_JOB_INTERFACE table with a PROCESS_STATUS = 1 (Pending). If you do not enter a required value. the PROCESS_STATUS of that record is set to 3 (Error). You must assign one of the following possible values or an error occurs: s s s 5 Create Lot Based Job 6 Reschedule Lot Based Job s s PROCESS_STATUS: The PROCESS_STATUS column indicates the current status of each record. user can specify group_id. s STATUS TYPE: You can only create lot based jobs with a status of 3. Unreleased. if you specify values for both the name and the ID. and has a NOT NULL restriction. Sometime it is not possible to write a row into WSM_LOT_JOB_INTERFACE table without specifying values for certain columns. Released or 1. the value for Oracle Shop Floor Management Open Interfaces 9-13 . These values indicate that the record is ready to be processed. For attirbutes that have a name and an associated id. Only rows with the given group_id will be picked up by the concurrent program. LOAD_TYPE: Determines whether the current interface record is to create a new lot-based job or to update an existing job.Import Lot Jobs Concurrent Program s ALLOW_EXPLOSION: This should always be set to Y to ensure that the bill of material and the routing of the assembly specified are exploded. HEADER_ID: Identifies each individual row in the table. the Import Lot Based Jobs program does not process the record and inserts an error record in the WSM_INTERFACE_ERRORS table for the appropriate record. or Derived or Ignored. Should have a unique value for each row. It also controls whether interface table columns are Required. Optional/Derived if Null. s Required Columns You must specify values for columns in this category. Optional. If the program fails at any stage when processing a record. Group_id: When launching ’Import Lot Based Job’. else error is reported.

you receive an error. You should leave all columns in this category blank (NULL). 9-14 Oracle Manufacturing APIs and Open Interfaces Manual . since values entered in these columns are ignored or overwritten. If the entered or derived ID is NULL. Optional Columns You do not have to enter values for columns in this category. Derived or Ignored Columns These columns are for internal processing only.Import Lot Jobs Concurrent Program the ID is used and the value for the name is ignored during validation.

Otherwise. from the Run Requests menu. 5. Table 9–3 WSM_STARTING_LOTS_INTERFACE Table Column header_id lot_number inventory_item_id organization_id quantity component_issue_ quantity Type number varchar2(30) number number number number Required x x x x x x This quantiy is ignored If not entered. when user launches ’Import Lot Based Job’ with a group_id. inserts a row into WSM_STARTING_LOTS_INTERFACE table. the user inserts a row into WSM_LOT_JOB_ INTERFACE. the user. Jobs can be created for any quantity as long as the quantity required to be issued from the inventory lot is less than or equal to the available quantity in the source lot. Thus job quantity will be checked against the actual available quantity determined using the quantity tree. For creating a mode 2 job. Oracle Shop Floor Management. For creating a mode 1 job. the HEADER_In WSLI should be equal to the source line id in WLJI. For a mode 2 job. select Import Lot Based Jobs. A parameter ’group_id’ is introduced to WSM_LOT_JOB_INTERFACES. it will be honored Derived Optional Permitted Values subinventory_code varchar2(10) x Oracle Shop Floor Management Open Interfaces 9-15 .Import Lot Jobs Concurrent Program Mode-2 Job Creation through Interface Following are the major design features of Mode 2 job creation through the interfaces: 1. Rows with the given group_id will be picked up by the concurrent program. 4. 2. additionally. this quantity will be derived from job quantity and quantity per assembly defined in BOM. 3. User can create a lot based job of any name from a source lot as long as the name is unique.

Import Lot Jobs Concurrent Program Table 9–3 WSM_STARTING_LOTS_INTERFACE Table Column last_update_date last_update_by creation_date created_by last_update_login Type date number date number number Required x x x x x Derived Optional Permitted Values 9-16 Oracle Manufacturing APIs and Open Interfaces Manual .

you can: s Move jobs between operations and intraoperation steps Jump to any standard operation defined inside or outside the network routing Scrap certain quantities of a job Return assemblies into WIP Undo the last move. Oracle Shop Floor Management Open Interfaces 9-17 . You then use the interface to load these transactions into the appropriate tables. assigns a group id to them and spawns any necessary workers (WSCMTI). or scrap transaction s s s s Lot move transactions are processed in parallel. Figure 9–2 below describes the basic flow of the Lot Move Transactions interface. The lot move transactions in MES are inserted into the WSM_LOT_MOVE_TXN_ INTERFACE table by running a script. The Move concurrent transaction manager (WSCMTM) program picks up a set of records from wsm_lot_move_txn_ interface. All transactions are validated.Lot Move Transactions Concurrent Program Lot Move Transactions Concurrent Program You can load Move Transaction information into the Open Move Transaction Interface table from a variety of sources. The Move Transactions worker validates the lot move transactions to be interfaced. The open interface enables you to perform many of the functions possible from the Move Transactions form. Invalid transactions are marked so that you can correct and resubmit them. including external data collection devices such as bar code readers. jump. The lot move transactions from MES are then imported into Oracle Applications. For example. automated test equipment or other manufacturing execution systems.

initiates completion transactions (for combination move and completion/return 9-18 Oracle Manufacturing APIs and Open Interfaces Manual . Next. The system uses this information to calculate completion cost. the Move Transaction Worker performs the actual move transaction. The Move Transaction Manager selects the pending move transactions for processing and spawns any necessary workers. which validates the row. derives or defaults any additional columns. initiates related resource and overhead transactions and requisitions for outside resources (for outside processing only).Lot Move Transactions Concurrent Program Figure 9–2 Basic Flow of the Lot Move Transactions Concurrent Program Lot Move Transactions Concurrent Program Features The interface requires WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) and WIP_ MOVE_TXN_INTERFACE (WMTI) tables. Functional Overview You must write the load program that inserts a single row for each move transaction into the WSM_LOT_MOVE_TXN_INTERFACE table. It writes it to history. The requisite data is to be inserted into the WLMTI table only. The Move Transaction Worker calls the WSM Transaction Validation Engine program. and inserts errors into the WIP_TXN_INTERFACE_ERRORS table. updates operation balances.

Lot Move Transactions Concurrent Program transactions). The user inserts rows into the WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) table. s s s 3. Although many transactions can be processed simultaneously. and deletes successfully processed transaction rows from the WIP_ MOVE_TXN_INTERFACE table. The number of transactions that are assigned to a worker are determined by the worker rows that you set up for Lot Move transactions. select Interface Managers under Run Requests in Oracle Shop Floor Management. The group_id must be NULL A valid wip_entity_id or wip_entity_name The transaction date is no later than the current date A transaction from the same job is not currently running in another move worker. 4. starting workers as necessary. wip_entity_id. and processing_order. only one worker at a time can process transactions that belong to the same job. Following are the major design features of this interface: 1. Figure 9–3 below describes the basic flow of the Lot Move Transactions Manager. organization_id. HEADER_ID is populated using the sequence given in the table requirements section below. To make this change. Oracle Shop Floor Management Open Interfaces 9-19 . The Backflush Setup program then determines and initiates related operation pull backflushes. The transaction manager picks up a transaction for processing according to the following criteria: s 2. The manager picks up pending records in wsm_lot_move_txn_interface and processes them in parallel. The manager assigns a set of move transactions to one or more workers in the following order: transaction_date.

the error column contains the error message. see Oracle Shop Floor Management Technical Reference Manual or eTRM for details. 3. The Import Lot Based Move Transactions Concurrent Program processes the rows and reports the following values for every record. 1. To resubmit the errored transactions for processing. first rectify the error and then do the following: 9-20 Oracle Manufacturing APIs and Open Interfaces Manual . Error Handling If any validation fails. For specific information on the data implied by these columns. the Concurrent Program will return error status to the calling module. Whenever any transaction errors out. 2. Errors and warnings.Lot Move Transactions Concurrent Program Figure 9–3 Lot Move Transaction Manager Validation of Import Lot Based Move Transactions Standard Validation Oracle Shop Floor Management validates all required columns in the Import Lot Based Move Transactions Concurrent Program. if any. are also written into the WSM_LOT_MOVE_TXN_ INTERFACE table and the WSM_INTERFACE_ERRORS table.

The details of the job are correct. The interface makes the following validation checks: a. department. b.Lot Move Transactions Concurrent Program a. Change the PROCESS_STATUS of the required transactions from 3 (ERROR) to 1 (PENDING). c. 4. uom’s. TO_DEPARTMENT_ID. The details of the operation to which the move is to be done are valid. Set the group_id to NULL. the job must have been completed. and TO_INTRAOPERATION_STEP_TYPE. current status in terms of operation sequence number. The details include the job name. qty. TO_OPERATION_CODE. b. These include TO_OPERATION_SEQ_NUM. etc. operation code. Table 9–4 Error Handling Table Condition Success Failure Running PROCESS_STATIS 4 3 2 ERROR_MESSAGE null actual error message null See Also Oracle Shop Floor Management Technical Reference Manual 11i Oracle Shop Floor Management Open Interfaces 9-21 . For return transactions.

Lot Move Transactions Concurrent Program Figure 9–4 Move Transaction Worker 9-22 Oracle Manufacturing APIs and Open Interfaces Manual .

see: Transaction Managers. you must launch the Import Move Transaction program to import from external sources Launching the Move Transaction Processor Launch the Lot Move Transaction Manager in the Interface Managers window by selecting Interface Managers under Run Requests in Oracle Shop Floor Management. The use of multiple transaction workers enables parallel processing of transactions that can be especially helpful when importing a large batch of transactions through the Move Transaction Interface. After polling the WSM_LOT_MOVE_TXN_INTERFACE table for eligible rows. For more information. Oracle Inventory User’s Guide. Oracle Shop Floor Management Open Interfaces 9-23 . the Lot Move Transaction Manager creates the necessary number of Move Transaction Workers to process the load. In addition. You can specify the resubmit interval and number of transactions processed by each worker during each interval when you launch the Lot Move Transaction Manager. Oracle Work in Process and Oracle Shop Floor Management setup activities required for move transactions.Lot Move Transactions Concurrent Program Setting Up the Move Transaction Interface You must perform all the Oracle Bills of Material.

The system validates each transaction row. then processes each transaction. Move Complete and Move Return transactions into the WSM_LOT_MOVE_TXN_INTERFACE table. The following tables describe the WSM_LOT_MOVE_TXN_INTERFACE table: Table 9–5 Number Types and Descriptions Number Type 1 2 3 4 Transaction Type Description Move Transaction (defined by TRANSACTION_TYPE = 1 and valid from and to operation information) Move Completion (defined by TRANSACTION_TYPE = 2) Move Return (defined by TRANSACTION_TYPE = 3) Move Undo (defined by TRANSACTION_TYPE = 4) Table 9–6 FORWARD MOVES AND COMPLETIONS Column header_id Type number Required =wsm_lot_ move_txn_ interface_s WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Derived Optional Permitted Values transaction_id last_update_date last_updated_by number date number x x wip_ interface_s last_updated_by_name varchar2(100) creation_date created_by created_by_name last_update_login request_id program_application_ id program_id date number varchar2(100) number number number number x x x x x x 9-24 Oracle Manufacturing APIs and Open Interfaces Manual .Lot Move Transactions Concurrent Program Inserting Records into the WSM_LOT_MOVE_TXN_INTERFACE Table You must insert your Move. derives any additional data as necessary.

Lot Move Transactions Concurrent Program Table 9–6 FORWARD MOVES AND COMPLETIONS Column program_update_date group_id source_code source_line_id status transaction_type organization_id organization_code wip_entity_id wip_entity_name entity_type primary_item_id line_id line_code repetitive_schedule_id transaction_date acct_period_id fm_operation_seq_ num fm_operation_code fm_department_id fm_department_code fm_intraoperation_ step_type to_operation_seq_num to_operation_code to_department_id Type date number varchar2(30) number number number number varchar2(3) number varchar2(240) number number number varchar2(10) number date number number varchar2(4) number varchar2(10) number number varchar2(4) number x x x x x x x x x =5 Required WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Derived Optional Permitted Values wip_ interface_s =1 (PENDING) =1 (MOVE) / 2 (COMPLETION) x x x x x x x x Oracle Shop Floor Management Open Interfaces 9-25 .

15 qa_collection_id kanban_card_id overcompletion_ transaction_qty overcompletion_ primary_qty overcompletion_ transaction_id error jump_flag processing_order Type varchar2(10) number number varchar2(3) number varchar2(3) number number varchar2(30) varchar2(240) varchar2(30) varchar2(150) number number number number number varchar2(240) varchar2(1) number for Jumps x for scrap txns x x x Required WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Derived x Optional Permitted Values 9-26 Oracle Manufacturing APIs and Open Interfaces Manual .Lot Move Transactions Concurrent Program Table 9–6 FORWARD MOVES AND COMPLETIONS Column to_department_code to_intraoperation_ step_type transaction_quantity transaction_uom primary_quantity primary_uom scrap_account_id reason_id reason_name reference attribute_category attribute1 .

Lot Move Transactions Concurrent Program Table 9–7 UNDO MOVES Column header_id Type WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Required =wsm_lot_ move_txn_ interface_s wip_ transaction_s x x x x x x x x Derived Optional Permitted Values number transaction_id last_update_date last_updated_by number date number last_updated_by_name varchar2(100) creation_date created_by created_by_name last_update_login request_id program_application_ id program_id program_update_date group_id source_code source_line_id status transaction_type organization_id organization_code wip_entity_id wip_entity_name entity_type date number varchar2(100) number number number number date number varchar2(30) number number number number varchar2(3) number varchar2(240) number x =5 =1 (PENDING) =4 (UNDO) x wip_ interface_s x x x x Oracle Shop Floor Management Open Interfaces 9-27 .

Lot Move Transactions Concurrent Program Table 9–7 UNDO MOVES Column primary_item_id line_id line_code repetitive_schedule_id transaction_date acct_period_id fm_operation_seq_ num fm_operation_code fm_department_id fm_department_code fm_intraoperation_ step_type to_operation_seq_num to_operation_code to_department_id to_department_code to_intraoperation_ step_type transaction_quantity transaction_uom primary_quantity primary_uom scrap_account_id reason_id reason_name reference Type WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Required Derived x Optional x Permitted Values number number varchar2(10) number date number number varchar2(4) number varchar2(10) number number varchar2(4) number varchar2(10) number number varchar2(3) number varchar2(3) number number varchar2(30) varchar2(240) x x x x x x x x x x x x x x x x x x x x x x x for scrap txns for scrap txns 9-28 Oracle Manufacturing APIs and Open Interfaces Manual .

Lot Move Transactions Concurrent Program Table 9–7 UNDO MOVES Column attribute_category attribute1 .15 qa_collection_id kanban_card_id overcompletion_ transaction_qty overcompletion_ primary_qty overcompletion_ transaction_id error jump_flag processing_order Type WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Required Derived Optional Permitted Values varchar2(30) varchar2(150) number number number number number varchar2(240) varchar2(1) number Table 9–8 RETURNS Column header_id WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Type number Required =wsm_lot_ move_txn_ interface_s wip_ transaction_s x x x x x x x x Derived Optional Permitted Values transaction_id last_update_date last_updated_by number date number last_updated_by_name varchar2(100) creation_date created_by created_by_name last_update_login date number varchar2(100) number Oracle Shop Floor Management Open Interfaces 9-29 .

Lot Move Transactions Concurrent Program Table 9–8 RETURNS Column request_id program_application_ id program_id program_update_date group_id source_code source_line_id status transaction_type organization_id organization_code wip_entity_id wip_entity_name entity_type primary_item_id line_id line_code repetitive_schedule_id transaction_date acct_period_id fm_operation_seq_ num fm_operation_code fm_department_id fm_department_code WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Type number number number date number varchar2(30) number number number number varchar2(3) number varchar2(240) number number number varchar2(10) number date number number varchar2(4) number varchar2(10) x x x x x x x x x =5 x x =1 (PENDING) =3 (RETURN) x x x x x wip_ interface_s Required Derived Optional Permitted Values 9-30 Oracle Manufacturing APIs and Open Interfaces Manual .

Lot Move Transactions Concurrent Program Table 9–8 RETURNS Column fm_intraoperation_ step_type to_operation_seq_num to_operation_code to_department_id to_department_code to_intraoperation_ step_type transaction_quantity transaction_uom primary_quantity primary_uom scrap_account_id reason_id reason_name reference attribute_category attribute1 .15 qa_collection_id kanban_card_id overcompletion_ transaction_qty overcompletion_ primary_qty overcompletion_ transaction_id WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Type number number varchar2(4) number varchar2(10) number number varchar2(3) number varchar2(3) number number varchar2(30) varchar2(240) varchar2(30) varchar2(150) number number number number number x x Required Derived x x x x x x x x x Optional x x x x Permitted Values Oracle Shop Floor Management Open Interfaces 9-31 .

this column represents the operation from which you are moving the jobs before they are completed into inventory. In Move and Completion transactions. FM_INTRAOPERATION_STEP_TYPE (Required): this column is only required when performing Move and Move Completion transactions. FM_OPERATION_SEQ_NUM and FM_INTRAOPERATION_STEP_TYPE must be set to the operation sequence on the routing at which the job currently exists. The Organization ID identifies the organization to which the transaction belongs. s s s ORGANIZATION_CODE (Derived): this column is derived from the Organization ID. very few columns are required because the system derives or defaults many column values and/or allows these column values to be optional. 9-32 Oracle Manufacturing APIs and Open Interfaces Manual .Lot Move Transactions Concurrent Program Table 9–8 RETURNS Column error jump_flag processing_order WSM_LOT_MOVE_TXN_INTERFACE (WLMTI) Type varchar2(240) varchar2(1) number Required Derived Optional Permitted Values You must include data in each of the required columns. you must set the values of these columns to their derived values. Overall. If you do not wish to leave these columns blank when performing an Undo Move and Return transaction. In Undo Move and Return transactions. FM_OPERATION_SEQ_NUM (Required): in Move transactions. It must be an enabled intraoperation step. this column represents the operation from which you are moving the jobs. Columns are derived using foreign key relationships within Oracle Manufacturing. you may leave this column and the FM_INTRAOPERATION_STEP_TYPE column blank. The following derived columns are control columns that the Move Transaction Manager uses to provide closed loop transaction processing control and relational integrity throughout the interface process: Control Columns s ATTRIBUTE1 through ATTRIBUTE15 (Optional): the descriptive flexfield attributes in the columns ATTRIBUTE1 through ATTRIBUTE15 map to ATTRIBUTE1 through ATTRIBUTE15 in WIP_MOVE_TRANSACTIONS.

For forward move transactions and jumps within the current routing. STATUS (Required): this column control describes the transaction state of the row and controls whether rows in the interface table are processed. calculated using TRANSACTION_ QUANTITY and TRANSACTION_UOM. You should insert a row that you intend to be processed with a value of 1. you could use a different source code to identify each collection method. SOURCE_CODE and SOURCE_LINE_ID (Optional): the SOURCE_CODE and SOURCE_LINE_ID columns can be used to identify the source of your Move transactions. TO_INTRAOPERATION_STEP_TYPE (Required): If you are undoing a move or returning an assembly from inventory back to WIP. s s s Oracle Shop Floor Management Open Interfaces 9-33 . this column need not be populated. you must insert a SCRAP_ACCOUNT_ID if the WIP Require Scrap Account parameter is set. For jumps outside the network routing this column must be left blank. if you collect Move transaction information from a bar code reader and a radio frequency device. the TO_ OPERATION_SEQ_NUM should be populated with the OPERATION_ SEQUENCE_NUMBER defined in the network routing. both columns are derived. 1 Pending 2 Running 3 Error 4 Completed You should always load 1 (Pending) s s SCRAP_ACCOUNT_ID (Optional): if the TO_INTRAOPERATION_STEP_TYPE is scrap and a scrap account is required. If you are undoing a move or returning an assembly from inventory to WIP leave this column and the TO_INTRAOPERATION_STEP_TYPE columns blank. For example. this column represents the operation step into which you are moving the job.Lot Move Transactions Concurrent Program s PRIMARY_QUANTITY (Derived): this column is the transaction quantity in the assembly’s primary unit of measure. you must insert a SCRAP_ACCOUNT_ ID. you cannot specify the To Move intraoperation step. For undo transactions. If you specify the Scrap intraoperation step. TO_OPERATION_SEQ_NUM (Required): in Move transactions.

this column represents the operation that the assemblies are being returned to from inventory.Lot Move Transactions Concurrent Program In Return transactions. s TRANSACTION_QUANTITY (Required): enter the transaction quantity in the same unit of measure used in the transaction. the jump flag needs to be set to Y. The options are: s s 1 Move 2 Move Completion 3 Move Return 4 Undo s s s If the transaction type is set to 1 and you are moving into the last operation To Move intraoperation step. WIP_ENTITY_NAME (Required): this column represents the job name used to derive the WIP_ENTITY_ID. set TRANSACTION_TYPE to 3. Jumps can be made either within the same network routing or outside of the network routing. the program defaults the transaction type to 2 and performs the completion transaction. For return transactions. s TRANSACTION_UOM (Required): you can enter the TRANSACTION_ QUANTITY in any unit of measure that has conversion rates defined for the item’s primary unit of measure. s Required Columns s For normal Move transactions. the Move transaction processor returns the assemblies from the completion subinventory/locator back into WIP. Use this column to specify the transacted unit of measure. The FROM and TO OPERATION_SEQ_NUM. JUMP_FLAG: Jump is a move transaction in which the operation to which the job is to be moved is not the immediately next operation on the network routing attached to the job. INTRAOPERATION_STEP. OPERATION_CODE. s s s 9-34 Oracle Manufacturing APIs and Open Interfaces Manual . TRANSACTION_TYPE (Optional): This column indicates the type of Move transaction. When TRANSACTION_TYPE is 3. set TRANSACTION_TYPE to 1 or NULL. Whenever jumps are made. and DEPARTMENT_ID must be set by the user. set TRANSACTION_TYPE to 2. even if it is the same as the primary unit of measure. For completion transactions.

Lot Move Transactions Concurrent Program s The column STATUS contains the state of the transaction. but not override it. you could use a different source code to identify each collection method. For example. The following derived columns are control columns that the Move Transaction Worker uses to provide closed loop transaction processing control and relational integrity throughout the interface process: s CREATED_BY_NAME s s GROUP_ID LAST_UPDATED_BY_NAME PROGRAM_APPLICATION_ID PROGRAM_ID PROGRAM_UPDATE_DATE REQUEST_ID TRANSACTION_ID s s s s s You can insert data into certain derived columns. You can insert data into the following derived columns: s LINE_ID s REASON_ID Optional Columns s The columns SOURCE_CODE and SOURCE_LINE_ID can be used to identify the source of Move transactions. The WSM Transaction Validation Engine will validate your data. You should always load 1 (Pending): s 1 Pending 2 Running 3 Error 4 Complete s s s Derived Data The WSM Transaction Validation Engine derives columns using foreign key relationships within Oracle Manufacturing. if you collect Move transaction information from a bar code reader and a radio frequency device. Oracle Shop Floor Management Open Interfaces 9-35 .

9-36 Oracle Manufacturing APIs and Open Interfaces Manual .Lot Move Transactions Concurrent Program s The descriptive flexfield attributes in the columns ATTRIBUTE1 through ATTRIBUTE15 map to ATTRIBUTE1 through ATTRIBUTE15 in WIP_MOVE_ TRANSACTIONS.

Oracle Shop Floor Management Open Interfaces 9-37 . merge. the COSTED status of the records will also be changed to COMPLETE. merge. update and bonus lot data in MES is inserted into Oracle Shop Floor Management interface tables by running interface loader scripts from the external system. Finally. The WIP split. use the concurrent program Cost Manager to cost the record with process_status = complete. update and bonus lot data to be interfaced. merge. quantity and lot names can be classified as update records. where as updates of assembly. routings. update and bonus lot transactions in MES are then imported into Oracle Applications. Split. This is a two step process. This import program validates the WIP split. merge and bonus can be classified as transactions. import it into the base tables and then process it. After this step. use the concurrent program Import WIP Lot Transactions to validate each transaction record in the interfaces tables. The WIP split. Figure 9–5 below describes the basic flow of the WIP Lot Transactions Concurrent Program for transactions. The PROCESS_STATUS of affected transaction records in the base tables will be COMPLETE once these transaction have been successfully imported and processed. First.Import WIP Lot Transactions Concurrent Program Import WIP Lot Transactions Concurrent Program The WIP Lot Transactions interface supports the following types of transactions: Table 9–9 Transaction Types and Descriptions Transaction Type 1 2 3 4 5 6 7 Transaction Description Split Merge Update Assembly Bonus Update Routing Update Quantity Update Lot Name The transactions in this interface can be broadly divided into two categories: transactions and update records.

Import WIP Lot Transactions Concurrent Program Figure 9–5 Basic Flow of the Import WIP Lot Transactions Concurrent Program for Transactions 9-38 Oracle Manufacturing APIs and Open Interfaces Manual .

OUT OUT IN IN VARCHAR2. the run Requests menu. 2. NUMBER. If a GROUP_ID is specified. enter the following command: WSMPLOAD. NUMBER NULL). Errors and Validations: 1. and WSM_RESULTING_JOBS_ INTERFACE (WRJI) tables. independent transactions should be grouped together. To run from the command line. WSM_STARTING_JOBS_INTERFACE (WSJI). 4. VARCHAR2.load (errbuf retcode p_copy_qa p_group_id p_copy_qa is ignored currently. Following are the major design features of this interface: 1.Import WIP Lot Transactions Concurrent Program Functional Overview In Oracle Shop Floor Management. 3. If no GROUP_ID is specified. select Import WIP Lot Transactions. by the order of TRANSACTION_DATE. the GROUP_ 2. Within a group. The user inserts rows into WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI). In this case. Preferably. He/she may or may not enter a GROUP_ID. Transactions in WSMTI are joined with the transactions in WSJI and WRJI by the HEADER_ID column in these tables. No interdependent transactions should exist within a group. all the PENDING transactions are processed group by group. Ideally. transactions are processed according to TRANSACTION_ DATE. When a concurrent request is launched for WIP Lot Transaction Interface. a unique GROUP_ID is assigned for each PENDING transaction which has a NULL GROUP_ID. Oracle Shop Floor Management Open Interfaces 9-39 . the PROCESS_STATUS of the entire group is set to ERROR. the user can specify a GROUP_ID. But only the transactions that actually errored out will have the ERROR_MESSAGE column containing the error message. The user groups transactions in WSMTI by using the same GROUP_ID. Whenever any one row errors out within a given group. only the PENDING transactions with the given GROUP_ID will be processed.

will be written into the WSM_INTERFACE_ ERRORS table. Appropriate messages will be given in the parent and child interface tables to refer to WSM_INTERFACE_ERRORS table when there is any error. 5. To resubmit the errored transactions for processing. Errors and warnings. If GROUP_ID is not specified when a concurrent request is launched and any one group errors out. The interface makes all the validations that get done when going though the front-end. if a GROUP_ID is specified when a concurrent request is launched and the group errors out. All of the inbound and outbound parameters are listed. the status of the concurrent program is set to WARNING. if any. 6. 4. the user has to rectify the error and change the PROCESS_STATUS of the required transactions from 3 (ERROR) to 1 (PENDING). the status of the concurrent program is set to ERROR. Table 9–10 Parameter group_id Parameter Descriptions Usage Type Required Derived Optional x 9-40 Oracle Manufacturing APIs and Open Interfaces Manual . 3. On the other hand. Setting Up the Import WIP Lot Transactions Concurrent Program Parameter Descriptions The following chart describes all parameters used by the public WIP LOT Transaction Concurrent Program.Import WIP Lot Transactions Concurrent Program ID should be left blank so that each transaction is assigned a unique GROUP_ID according to TRANSACTION_DATE and the transactions are processed row-by-row as if they were a group with a single transaction in it.

see your Oracle Shop Floor Management Technical Reference Manual for details. the Concurrent Program will return error status to the calling module. The Import WIP Lot Processor Transactions Concurrent Program processes the rows and reports the following values for every record. Table 9–11 Error Handling Table Condition Success Failure Running PROCESS_STATIS 4 3 2 ERROR_MESSAGE null actual error message null See Also Oracle Shop Floor Management Technical Reference Manual 11i Figure 9–6 below describes the same process for updating records. Oracle Shop Floor Management Open Interfaces 9-41 . For specific information on the data implied by these columns.Import WIP Lot Transactions Concurrent Program Validation of Import WIP Lot Transactions Program Standard Validation Oracle Shop Floor Management validates all required columns in the Import WIP Lot Processor Transactions Concurrent Program. Error Handling If any validation fails.

Import WIP Lot Transactions Concurrent Program Figure 9–6 Basic Flow for processing WIP Lot Transactions through Interface 9-42 Oracle Manufacturing APIs and Open Interfaces Manual .

Merge 3 . using sequence wsm_sm_txn_int_group_s User populated .Update Assembly 4 .using sequence wsm_sm_txn_interface_s Program generated using sequence wsm_split_merge_ transactions_s Type of transaction: 1 . Some columns are not used by the program and marked as ignored. WSM_STARTING_JOBS_INTERFACE (WSJI.Update Routing 6 . The following three tables describe the important columns in the WSM_SPLIT_ MERGE_TXN_INTERFACE (WSMTI).Update Quantity 7 . derives any additional data as necessary.Import WIP Lot Transactions Concurrent Program Important Columns in WSM_SPLIT_MERGE_TXN_INTERFACE. WSM_ STARTING_JOBS_INTERFACE (WSJI). then processes each transaction.Bonus 5 . Table 9–12 Column group_id header_id transaction_id transaction_type_id IMPORTANT COLUMNS WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Description User populated / Program generated if NULL.Update Lot Name process_status 1 .) and WSM_RESULTING_JOBS_INTERFACE (WRJI) tables. and WSM_RESULTING_JOBS_INTERFACE Tables The interface requires WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI).Split 2 . WSM_STARTING_ JOBS_INTERFACE.PENDING Oracle Shop Floor Management Open Interfaces 9-43 . The system validates each transaction row. and WSM_RESULTING_JOBS_INTERFACE (WRJI) tables.

PENDING process_status Table 9–14 Column group_id header_id IMPORTANT COLUMNS WSM_RESULTING_JOBS_INTERFACE (WRJI) Description User populated / System generated if NULL. Matches the value for the txn entered in WSMTI table 1 . Matches the value for the txn entered in WSMTI table 1 .Import WIP Lot Transactions Concurrent Program Table 9–13 Column group_id header_id IMPORTANT COLUMNS WSM_STARTING_JOBS_INTERFACE (WSJI) Description User populated / System generated if NULL. Value same as that in WSMTI table User populated .PENDING process_status 9-44 Oracle Manufacturing APIs and Open Interfaces Manual . Value same as that in WSMTI table User populated .using sequence wsm_sm_txn_interface_s.using sequence wsm_sm_txn_interface_s.

and WSM_RESULTING_JOBS_INTERFACE Tables The following tables describe WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI). WSM_STARTING_ JOBS_INTERFACE. Bonus Transaction: Table 9–15 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference group_id BONUS WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Type number(15) number(15) date number(15) number number(15) varchar2(240) number(15) =wsm_sm_ txn_int_ group_s. and WSM_RESULTING_JOBS_ INTERFACE (WRJI) tables for each of the seven transaction types.Import WIP Lot Transactions Concurrent Program Inserting Records into the WSM_SPLIT_MERGE_TXN_INTERFACE. if NULL =1 (PENDING) =wsm_ split_ merge_ transactions _s x Required =wsm_sm_txn_ interface_s =4 x x Derived Optional Permitted Values process_status transaction_id number number(15) error_message last_update_date last_updated_by creation_date created_by last_update_login varchar2(240) date number date number number x x x x Oracle Shop Floor Management Open Interfaces 9-45 . WSM_STARTING_JOBS_INTERFACE (WSJI).

15 request_id program_application_ id program_id program_update_date xml_document_id internal_group_id Note: No records are required for insertion to WSJI table for bonus transactions. if NULL x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type varchar2(240) number 9-46 Oracle Manufacturing APIs and Open Interfaces Manual .Import WIP Lot Transactions Concurrent Program Table 9–15 Column BONUS WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Type varchar2(30) varchar2(150) number(15) number(15) number(15) date number number Not for use. For internal purposes only.header _id =wsm_sm_ txn_int_ group_s. Any Previous value will be overwritten Ignored System generated System generated System generated System generated Required Derived Optional Permitted Values attribute_category attribute1 . Table 9–16 Column header_id BONUS WSM_RESULTIING_JOBS_INTERFACE (WRJI) Type number(15) Required =wsm_sm_txn_ interface_s & =WSMTI.

primary_item_id and alternated_ routing_ designator. then error out. then the record will error out. If NO Network routing exists for this condition. Required Derived Optional Permitted Values organization_id description primary_item_id class_code start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id number number number number x x x Derived using organization_id. common_routing_ sequence_id number x x routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator alternate_routing_ designator varchar2(3) date varchar2(3) date varchar2(10) varchar2(10) x x x x x x x x x x x x NULL value is PRIMARY BOM. primary_item_id and alternate_ bom_designator. Oracle Shop Floor Management Open Interfaces 9-47 . NULL value is PRIMARY Routing.Import WIP Lot Transactions Concurrent Program Table 9–16 Column BONUS WSM_RESULTIING_JOBS_INTERFACE (WRJI) Type number varchar2(240) number varchar2(10) x x x If class_code can not be derived using defaults. Derived using organization_id.

Optional Permitted Values completion_ subinventory starting_operation_ code starting_operation_ seq_num number x starting_std_op_id number x (if op_ code / op_ seq_num given) x=1 (QUEUE) x BONUS Transactions are supported only at QUEUE Intra-operation step. starting_ intraoperation_step number scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id date date varchar2(240) number number(15) x x x=4 x Should be a valid account id from the organization’s Set of Books. Starting Operation Sequence Number in the PRIMARY PATH of the network routing. This can be a Non-standard operation also. demand_class process_status varchar2(30) number = 1 (PENDING) 9-48 Oracle Manufacturing APIs and Open Interfaces Manual .Import WIP Lot Transactions Concurrent Program Table 9–16 Column BONUS WSM_RESULTIING_JOBS_INTERFACE (WRJI) Type varchar2(10) varchar2(4) Required Derived x x (if op_ seq_num given) x (if op_ code given) x If starting operation is a standard operation.

For internal purposes only. Any Previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x Required Derived Optional Permitted Values error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id program_application_ id program_id program_update_date completion_locator_id coproducts_supply net_quantity internal_group_id Oracle Shop Floor Management Open Interfaces 9-49 .Import WIP Lot Transactions Concurrent Program Table 9–16 Column BONUS WSM_RESULTIING_JOBS_INTERFACE (WRJI) Type varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) number(15) date number(15) number number number x x x x x Should be less than start quantity Not for use.

Import WIP Lot Transactions Concurrent Program Split Transaction: Table 9–17 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference group_id SPLIT WSM_SPLIT_MERGE TXN_INTERFACE (WSMTI) Type number(15) number(15) date number(15) number number(15) varchar2(240) number(15) =wsm_sm_ txn_int_ group_s. if NULL =1 (PENDING) =wsm_ split_ merge_ transactions _s x Required =wsm_sm_txn_ interface_s =1 x x Derived Optional Permitted Values process_status transaction_id number number(15) error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id program_application_ id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) Ignored Ignored System Generated System Generated x x x x 9-50 Oracle Manufacturing APIs and Open Interfaces Manual .

For internal purposes only.Import WIP Lot Transactions Concurrent Program Table 9–17 Column program_id SPLIT WSM_SPLIT_MERGE TXN_INTERFACE (WSMTI) Type number(15) date number number Not for use. if NULL = 1 (PENDING) x x x 1 or 3 process_status number Oracle Shop Floor Management Open Interfaces 9-51 . Any Previous value will be overwritten Required Derived Optional Permitted Values System Generated System Generated program_update_date xml_document_id internal_group_id Table 9–18 Column header_id SPLIT WSM_STARTING_JOBS_INTERFACE (WSJI) Type number(15) Required =wsm_sm_txn_ interface_s & =WSMTI.header _id either wip_entity_ id or wip_entity_ name must be entered Derived Optional Permitted Values wip_entity_id number xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num intraoperation_step representative_flag group_id number number number varchar2(1) number(15) =wsm_sm_ txn_int_ group_s.

For internal purposes only.15 request_id program_application_ id program_id program_update_date routing_seq_id primary_item_id internal_group_id 9-52 Oracle Manufacturing APIs and Open Interfaces Manual .Import WIP Lot Transactions Concurrent Program Table 9–18 Column SPLIT WSM_STARTING_JOBS_INTERFACE (WSJI) Type varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) date number number number Not for use. Any Previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x Required Derived Optional Permitted Values error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .

if NULL x x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type organization_id description primary_item_id class_code varchar2(240) number number varchar2(240) number varchar2(10) x x Should be the same as starting job start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id number number number number x To be specified for non-standard jobs To be specified for non-standard jobs x From primary_ item_id (for standard jobs) or bom_reference_id (for non-standard jobs) and alternate_bom_ designator Oracle Shop Floor Management Open Interfaces 9-53 .header _id =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–19 Column header_id SPLIT WSM_RESULTING_JOBS_INTERFACE (WRJI) Type number(15) Required =wsm_sm_txn_ interface_s & =WSMTI.

Import WIP Lot Transactions Concurrent Program Table 9–19 Column SPLIT WSM_RESULTING_JOBS_INTERFACE (WRJI) Type number Required Derived x Optional Permitted Values From primary_ item_id (for standard jobs) or routing_ reference_id (for non-standard jobs) and alternate_routing_ designator x x x x x x x x x common_routing_ sequence_id routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator alternate_routing_ designator completion_ subinventory starting_operation_ code starting_operation_ seq_num starting_std_op_id starting_ intraoperation_step varchar2(3) date varchar2(3) date varchar2(10) varchar2(10) varchar2(10) varchar2(4) number number number x x x x=1 (QUEUE) / 3 (TO MOVE) x x x Derived from the starting lots. scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id date date varchar2(240) number number(15) x=4 Ignored 9-54 Oracle Manufacturing APIs and Open Interfaces Manual .

a minimum of two records will be inserted if all the quantities in the starting lots are split. For internal purposes only.Import WIP Lot Transactions Concurrent Program Table 9–19 Column SPLIT WSM_RESULTING_JOBS_INTERFACE (WRJI) Type varchar2(30) number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) date number(15) number number number x x x Should be less than start quantity Not for use.15 request_id program_application_ id program_id program_update_date completion_locator_id coproducts_supply net_quantity internal_group_id Note: For a Split transaction. Any Previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x = 1 (PENDING) Required Derived Optional Permitted Values demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 . Oracle Shop Floor Management Open Interfaces 9-55 .

Import WIP Lot Transactions Concurrent Program Merge Transaction: Table 9–20 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference group_id MERGE WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Type number(15) number(15) date number(15) number number(15) varchar2(240) number(15) =wsm_sm_ txn_int_ group_s. if NULL =1 (PENDING) =wsm_ split_ merge_ transactions _s x Ignored Required =wsm_sm_txn_ interface_s =2 x x Derived Optional Permitted Values process_status transaction_id number number(15) error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id program_application_ id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) Ignored Ignored System Generated System Generated x x x x 9-56 Oracle Manufacturing APIs and Open Interfaces Manual .

header _id either wip_entity_ id or wip_entity_ name must be entered Derived Optional Permitted Values wip_entity_id number xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num number number x Merge is NOT permitted at a Non-standard operation. For internal purposes only. 1 or 3 1 or 2.Import WIP Lot Transactions Concurrent Program Table 9–20 Column program_id MERGE WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Type number(15) date number number Not for use. Any Previous value will be overwritten Required Derived Optional Permitted Values System Generated System Generated program_update_date xml_document_id internal_group_id Table 9–21 Column header_id MERGE WSM_STARTING_JOBS_INTERFACE (WSJI) Type number(15) Required =wsm_sm_txn_ interface_s & =WSMTI. Only one record can have a value of 1 for a Merge Transaction intraoperation_step representative_flag number varchar2(1) x x Oracle Shop Floor Management Open Interfaces 9-57 .

Any Previous value will be overwritten 9-58 Oracle Manufacturing APIs and Open Interfaces Manual .15 request_id program_application_ id program_id program_update_date routing_seq_id primary_item_id internal_group_id number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) date number number number x x x x Ignored x System generated x Not for use. For internal purposes only.Import WIP Lot Transactions Concurrent Program Table 9–21 Column group_id MERGE WSM_STARTING_JOBS_INTERFACE (WSJI) Type number(15) Required Derived =wsm_sm_ txn_int_ group_s. if NULL = 1 (PENDING) Optional x Permitted Values process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .

header _id =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–22 Column header_id MERGE WSM_RESULTING_JOBS_INTERFACE (WRJI) Type number(15) Required =wsm_sm_txn_ interface_s & =WSMTI. if NULL x x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type organization_id description primary_item_id class_code varchar2(240) number number varchar2(240) number varchar2(10) x x Should be the same as parent representative job start_quantity bom_reference_id number number x Derived based on Representative Lot Derived based on Representative Lot x Derived based on Representative Lot routing_reference_id number common_bom_ sequence_id number Oracle Shop Floor Management Open Interfaces 9-59 .

Import WIP Lot Transactions Concurrent Program Table 9–22 Column MERGE WSM_RESULTING_JOBS_INTERFACE (WRJI) Type number Required Derived x Optional Permitted Values Derived based on Representative Lot common_routing_ sequence_id routing_revision varchar2(3) x x Derived based on Representative Lot routing_revision_date date x x Derived based on Representative Lot bom_revision varchar2(3) x x Derived based on Representative Lot bom_revision_date date x Derived based on Representative Lot alternate_bom_ designator varchar2(10) x x Derived based on Representative Lot alternate_routing_ designator varchar2(10) x x Derived based on Representative Lot completion_ subinventory starting_operation_ code varchar2(10) x x Derived based on Representative Lot Derived based on Representative Lot varchar2(4) 9-60 Oracle Manufacturing APIs and Open Interfaces Manual .

15 request_id program_application_ id program_id date date varchar2(240) number number(15) varchar2(30) number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) Ignored = 1 (PENDING) x x x x Ignored Ignored System Generated System Generated System Generated Oracle Shop Floor Management Open Interfaces 9-61 .Import WIP Lot Transactions Concurrent Program Table 9–22 Column MERGE WSM_RESULTING_JOBS_INTERFACE (WRJI) Type number Required Derived Optional Permitted Values Derived based on Representative Lot Derived based on Representative Lot x=1 (QUEUE) / 3 (TO MOVE) x x x Derived based on Representative Lot starting_operation_ seq_num starting_std_op_id number starting_ intraoperation_step number scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .

Any previous value will be overwritten internal_group_id number Note: For a merge. a transaction minimum of two records are inserted into this table. Not for use.Import WIP Lot Transactions Concurrent Program Table 9–22 Column MERGE WSM_RESULTING_JOBS_INTERFACE (WRJI) Type date number(15) Required Derived Optional Permitted Values System Generated Derived based on Representative Lot program_update_date completion_locator_id coproducts_supply net_quantity number number Should be less than the resulting job start quantity. One of the records is a representative lot. For internal purposes only. Update Assembly Transaction: Table 9–23 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference UPDATE ASSEMBLY Type number(15) number(15) date number(15) number number(15) varchar2(240) WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required =wsm_sm_txn_ interface_s =3 x x Derived Optional Permitted Values 9-62 Oracle Manufacturing APIs and Open Interfaces Manual .

15 request_id program_application_ id program_id program_update_date xml_document_id internal_group_id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) number(15) date number number Not for use.Import WIP Lot Transactions Concurrent Program Table 9–23 Column group_id UPDATE ASSEMBLY Type number(15) WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required Derived =wsm_sm_ txn_int_ group_s. For internal purposes only. Any previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x Oracle Shop Floor Management Open Interfaces 9-63 . if NULL =1 (PENDING) =wsm_ split_ merge_ transactions _s Optional x Permitted Values process_status transaction_id number number(15) error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .

15 request_id number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) x x x x Ignored Ignored x System Generated 9-64 Oracle Manufacturing APIs and Open Interfaces Manual .header _id either wip_entity_ id or wip_entity_ name must be entered Derived Optional Permitted Values wip_entity_id number xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num intraoperation_step representative_flag group_id number number number varchar2(1) number(15) =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–24 Column header_id UPDATE ASSEMBLY Type number(15) WSM_STARTING_JOBS_INTERFACE (WSJI) Required =wsm_sm_txn_ interface_s & =WSMTI. if NULL = 1 (PENDING) x x =Q/TM process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .

Any previous value will be overwritten internal_group_id number Table 9–25 Column header_id UPDATE ASSEMBLY Type number(15) WSM_RESULTING_JOBS_INTERFACE (WRJI) Required =wsm_sm_txn_ interface_s & =WSMTI.header _id =wsm_sm_ txn_int_ group_s. Not for use. For internal purposes only. if NULL x x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id varchar2(240) Oracle Shop Floor Management Open Interfaces 9-65 .organizati on_id.Import WIP Lot Transactions Concurrent Program Table 9–24 Column UPDATE ASSEMBLY Type number number(15) date number number WSM_STARTING_JOBS_INTERFACE (WSJI) Required Derived Optional Permitted Values System Generated x System Generated System Generated program_application_ id program_id program_update_date routing_seq_id primary_item_id New Lot controlled Assembly Item. Should have a valid Network Routing in WSMTI.

Import WIP Lot Transactions Concurrent Program Table 9–25 Column job_type UPDATE ASSEMBLY Type number number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values organization_id description primary_item_id class_code varchar2(240) number varchar2(10) x x Should be the same as starting job start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id number number number number x To be specified for non-standard jobs To be specified for non-standard jobs x From primary_ item_id (for standard jobs) or bom_reference_id (for non-standard jobs) and alternate_bom_ designator From primary_ item_id (for standard jobs) or routing_ reference_id (for non-standard jobs) and alternate_routing_ designator x x x x x x common_routing_ sequence_id number x routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator varchar2(3) date varchar2(3) date varchar2(10) x x x 9-66 Oracle Manufacturing APIs and Open Interfaces Manual .

starting_std_op_id starting_ intraoperation_step number number x=1 (QUEUE) / 3 (TO MOVE) x 3 is disallowed.Import WIP Lot Transactions Concurrent Program Table 9–25 Column UPDATE ASSEMBLY Type varchar2(10) varchar2(10) varchar2(4) number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived x x Optional x Permitted Values alternate_routing_ designator completion_ subinventory starting_operation_ code starting_operation_ seq_num Ignored if the starting lot is at TO_MOVE Intra-operation. if the starting operation sequence num is the last operation in the target routing. scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login date date varchar2(240) number number(15) varchar2(30) number varchar2(240) date number date number number x x = 1 (PENDING) x x x x Oracle Shop Floor Management Open Interfaces 9-67 .

Any previous value will be overwritten Update Routing Transaction: Table 9–26 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference UPDATE ROUTING Type number(15) number(15) date number(15) number number(15) varchar2(240) WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required =wsm_sm_txn_ interface_s =5 x x Derived Optional Permitted Values 9-68 Oracle Manufacturing APIs and Open Interfaces Manual .15 request_id program_application_ id program_id program_update_date completion_locator_id coproducts_supply net_quantity internal_group_id varchar2(150) number(15) number number(15) date number(15) number number number Not for use.Import WIP Lot Transactions Concurrent Program Table 9–25 Column UPDATE ASSEMBLY Type varchar2(30) WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values Ignored Ignored System Generated System Generated System Generated System Generated attribute_category attribute1 . For internal purposes only.

if NULL =1 (PENDING) =wsm_ split_ merge_ transactions _s Optional x Permitted Values number(15) process_status transaction_id number number(15) error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 -15 request_id program_application_ id program_id program_update_date xml_document_id internal_group_id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) number(15) date number number Not for use. Any previous value will be overwritten System Generated System Generated System Generated Ignored Ignored x x x x Oracle Shop Floor Management Open Interfaces 9-69 .Import WIP Lot Transactions Concurrent Program Table 9–26 Column group_id UPDATE ROUTING Type WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required Derived =wsm_sm_ txn_int_ group_s. For internal purposes only.

header _id Derived Optional Permitted Values System Generated number(15) wip_entity_id number either wip_entity_ id or wip_entity_ name must be entered xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num intraoperation_step representative_flag group_id number number number varchar2(1) number(15) =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–27 Column header_id UPDATE ROUTING Type WSM_STARTING_JOBS_INTERFACE (WSJI) Required =wsm_sm_txn_ interface_s & =WSMTI. if NULL = 1 (PENDING) x x =Q/TM 1 or 3 process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) x x x x Ignored Ignored x System Generated 9-70 Oracle Manufacturing APIs and Open Interfaces Manual .

header _id =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–27 Column UPDATE ROUTING Type number WSM_STARTING_JOBS_INTERFACE (WSJI) Required Derived Optional Permitted Values System Generated x System Generated System Generated program_application_ id program_id program_update_date routing_seq_id primary_item_id internal_group_id number(15) date number number number Not for use. if NULL x x Derived Optional Permitted Values number(15) group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type organization_id description primary_item_id varchar2(240) number number varchar2(240) number x Oracle Shop Floor Management Open Interfaces 9-71 . For internal purposes only. Any previous value will be overwritten Table 9–28 Column header_id UPDATE ROUTING Type WSM_RESULTING_JOBS_INTERFACE (WRJI) Required =wsm_sm_txn_ interface_s & =WSMTI.

Import WIP Lot Transactions Concurrent Program Table 9–28 Column class_code UPDATE ROUTING Type WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived x Optional Permitted Values Should be the same as starting job varchar2(10) start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id number number number number x To be specified for non-standard jobs To be specified for non-standard jobs x From primary_ item_id (for standard jobs) or bom_reference_id (for non-standard jobs) and alternate_bom_ designator From primary_ item_id (for standard jobs) or routing_ reference_id (for non-standard jobs) and alternate_routing_ designator x x x x x x x x x NULL value permitted if different from current designator common_routing_ sequence_id number x routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator alternate_routing_ designator varchar2(3) date varchar2(3) date varchar2(10) varchar2(10) x x x completion_ subinventory varchar2(10) x 9-72 Oracle Manufacturing APIs and Open Interfaces Manual .

scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id date date varchar2(240) number number(15) varchar2(30) number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) x x = 1 (PENDING) x x x x Ignored Ignored System Generated Oracle Shop Floor Management Open Interfaces 9-73 .Import WIP Lot Transactions Concurrent Program Table 9–28 Column UPDATE ROUTING Type WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values starting_operation_ code starting_operation_ seq_num varchar2(4) number Ignored if the starting lot is at TO_MOVE Intra-operation. starting_std_op_id starting_ intraoperation_step number number x=1 (QUEUE) / 3 (TO MOVE) x 3 is disallowed. if the starting operation sequence num is the last operation in the target routing.

Import WIP Lot Transactions Concurrent Program Table 9–28 Column UPDATE ROUTING Type number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values System Generated System Generated System Generated program_application_ id program_id program_update_date completion_locator_id coproducts_supply net_quantity internal_group_id number(15) date number(15) number number number x 1 or 2 Not for use. if NULL x WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required =wsm_sm_txn_ interface_s =6 x x Derived Optional Permitted Values 9-74 Oracle Manufacturing APIs and Open Interfaces Manual . Any previous value will be overwritten Update Quantity Transaction: Table 9–29 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference group_id UPDATE QUANTITY Type number(15) number(15) date number(15) number number(15) varchar2(240) number(15) =wsm_sm_ txn_int_ group_s. For internal purposes only.

Any previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x Oracle Shop Floor Management Open Interfaces 9-75 . For internal purposes only.Import WIP Lot Transactions Concurrent Program Table 9–29 Column UPDATE QUANTITY Type number number(15) WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required =1 (PENDING) =wsm_ split_ merge_ transactions _s Derived Optional Permitted Values process_status transaction_id error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id program_application_ id program_id program_update_date xml_document_id internal_group_id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) number(15) date number number Not for use.

Import WIP Lot Transactions Concurrent Program Table 9–30 Column header_id UPDATE QUANTITY Type number(15) WSM_STARTING_JOBS_INTERFACE (WSJI) Required =wsm_sm_txn_ interface_s & =WSMTI.header _id either wip_entity_ id or wip_entity_ name must be entered Derived Optional Permitted Values wip_entity_id number xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num intraoperation_step representative_flag group_id number number number varchar2(1) number(15) =wsm_sm_ txn_int_ group_s. if NULL = 1 (PENDING) x x =Q/TM process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) x x x x Ignored Ignored x System Generated 9-76 Oracle Manufacturing APIs and Open Interfaces Manual .

For internal purposes only.header _id =wsm_sm_ txn_int_ group_s. if NULL x x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type organization_id description primary_item_id varchar2(240) number number varchar2(240) number x Oracle Shop Floor Management Open Interfaces 9-77 . Any previous value will be overwritten Table 9–31 Column header_id UPDATE QUANTITY Type number(15) WSM_RESULTING_JOBS_INTERFACE (WRJI) Required =wsm_sm_txn_ interface_s & =WSMTI.Import WIP Lot Transactions Concurrent Program Table 9–30 Column UPDATE QUANTITY Type number number(15) date number number number WSM_STARTING_JOBS_INTERFACE (WSJI) Required Derived x x x Optional Permitted Values System Generated System Generated System Generated program_application_ id program_id program_update_date routing_seq_id primary_item_id internal_group_id Not for use.

Import WIP Lot Transactions Concurrent Program Table 9–31 Column class_code UPDATE QUANTITY Type WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived x x Derived from Starting Lots Optional Permitted Values Derived from Starting Lots varchar2(10) number number number number number varchar2(3) date varchar2(3) date varchar2(10) varchar2(10) varchar2(10) varchar2(4) number number number start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id common_routing_ sequence_id routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator alternate_routing_ designator completion_ subinventory starting_operation_ code starting_operation_ seq_num starting_std_op_id starting_ intraoperation_step x x x x x x x x x x x x x x x Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots x=1 (QUEUE) / 3 (TO MOVE) x Derived from Starting Lots 9-78 Oracle Manufacturing APIs and Open Interfaces Manual .

Import WIP Lot Transactions Concurrent Program Table 9–31 Column UPDATE QUANTITY Type date date WSM_RESULTING_JOBS_INTERFACE (WRJI) Required x x Derived Optional Permitted Values scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id varchar2(240) number number(15) x Valid account Id from the organization’s set of books. demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 -15 request_id program_application_ id program_id program_update_date completion_locator_id varchar2(30) number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) date number(15) Ignored Ignored System Generated System Generated System Generated System Generated Derived from Starting Lots x x x x = 1 (PENDING) Oracle Shop Floor Management Open Interfaces 9-79 . Important for proper valuation of the job.

Not for use.Import WIP Lot Transactions Concurrent Program Table 9–31 Column UPDATE QUANTITY Type number number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values Derived from Starting Lots Should be less than the start quantity in resulting jobs. if NULL =1 (PENDING) x WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required =wsm_sm_txn_ interface_s =7 x x 7 Derived Optional Permitted Values process_status number 9-80 Oracle Manufacturing APIs and Open Interfaces Manual . Any previous value will be overwritten coproducts_supply net_quantity internal_group_id number Update Lot Name Transaction: Table 9–32 Column header_id transaction_type_id transaction_date organization_id reason_id suspense_acct_id transaction_reference group_id UPDATE LOT NAME Type number(15) number(15) date number(15) number number(15) varchar2(240) number(15) =wsm_sm_ txn_int_ group_s. For internal purposes only.

Import WIP Lot Transactions Concurrent Program Table 9–32 Column UPDATE LOT NAME Type number(15) WSM_SPLIT_MERGE_TXN_INTERFACE (WSMTI) Required Derived =wsm_ split_ merge_ transactions _s Optional Permitted Values transaction_id error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 . Any previous value will be overwritten Ignored Ignored System Generated System Generated System Generated System Generated x x x x Oracle Shop Floor Management Open Interfaces 9-81 .15 request_id program_application_ id program_id program_update_date xml_document_id internal_group_id varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number(15) number(15) date number number Not for use. For internal purposes only.

header _id either wip_entity_ id or wip_entity_ name must be entered Derived Optional Permitted Values wip_entity_id number xml_document_id wip_entity_name varchar2(240) varchar2(240) either wip_entity_ id or wip_entity_ name must be entered organization_id operation_seq_num intraoperation_step representative_flag group_id number number number varchar2(1) number(15) =wsm_sm_ txn_int_ group_s. if NULL = 1 (PENDING) x x =Q/TM process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .15 request_id number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) x x x x Ignored Ignored x System Generated 9-82 Oracle Manufacturing APIs and Open Interfaces Manual .Import WIP Lot Transactions Concurrent Program Table 9–33 Column header_id UPDATE LOT NAME Type number(15) WSM_STARTING_JOBS_INTERFACE (WSJI) Required =wsm_sm_txn_ interface_s & =WSMTI.

Any previous value will be overwritten Table 9–34 Column header_id UPDATE LOT NAME Type number(15) WSM_RESULTING_JOBS_INTERFACE (WRJI) Required =wsm_sm_txn_ interface_s & =WSMTI.header _id =wsm_sm_ txn_int_ group_s.Import WIP Lot Transactions Concurrent Program Table 9–33 Column UPDATE LOT NAME Type number number(15) date number number number WSM_STARTING_JOBS_INTERFACE (WSJI) Required Derived Optional Permitted Values System Generated x System Generated System Generated program_application_ id program_id program_update_date routing_seq_id primary_item_id internal_group_id Not for use. if NULL x x Derived Optional Permitted Values group_id number(15) wip_entity_name varchar2(240) Length cannot exceed 30 characters excluding sector extensions and lot separators xml_document_id job_type organization_id description primary_item_id varchar2(240) number number varchar2(240) number x Oracle Shop Floor Management Open Interfaces 9-83 . For internal purposes only.

Import WIP Lot Transactions Concurrent Program Table 9–34 Column class_code UPDATE LOT NAME Type varchar2(10) number number number number number varchar2(3) date varchar2(3) date varchar2(10) varchar2(10) varchar2(10) varchar2(4) number number number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived x x Derived from Starting Lots Derived from Starting Lots x x x x x x x x x x x x x x x Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Derived from Starting Lots Optional Permitted Values Derived from Starting Lots start_quantity bom_reference_id routing_reference_id common_bom_ sequence_id common_routing_ sequence_id routing_revision routing_revision_date bom_revision bom_revision_date alternate_bom_ designator alternate_routing_ designator completion_ subinventory starting_operation_ code starting_operation_ seq_num starting_std_op_id starting_ intraoperation_step x=1 (QUEUE) / 3 (TO MOVE) x Derived from Starting Lots 9-84 Oracle Manufacturing APIs and Open Interfaces Manual .

Import WIP Lot Transactions Concurrent Program Table 9–34 Column UPDATE LOT NAME Type date date WSM_RESULTING_JOBS_INTERFACE (WRJI) Required x x Not used Ignored Derived Optional Permitted Values scheduled_start_date scheduled_ completion_date starting_wip_entity_ rename forward_op_option bonus_acct_id demand_class process_status error_message last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 -15 request_id program_application_ id program_id program_update_date completion_locator_id varchar2(240) number number(15) varchar2(30) number varchar2(240) date number date number number varchar2(30) varchar2(150) number(15) number number(15) date number(15) x x x x = 1 (PENDING) Ignored Ignored System Generated System Generated System Generated System Generated Derived from Starting Lots Oracle Shop Floor Management Open Interfaces 9-85 .

Any previous value will be overwritten 9-86 Oracle Manufacturing APIs and Open Interfaces Manual .Import WIP Lot Transactions Concurrent Program Table 9–34 Column UPDATE LOT NAME Type number WSM_RESULTING_JOBS_INTERFACE (WRJI) Required Derived Optional Permitted Values Derived from Starting Lots coproducts_supply net_quantity number Derived from Starting Lots internal_group_id number Not for use. For internal purposes only.

Importing WIP Lot Transactions was a three-step process s Import WIP Lot Transactions WIP Lot Transactions Processor Lot Based Transaction Cost Manager s s Oracle Shop Floor Management Open Interfaces 9-87 .Import WIP Lot Transactions Concurrent Program Upgrade to Patchset I Prior to Patchset I.

Import WIP Lot Transactions Concurrent Program Figure 9–7 Basic Flow of Import WIP Lot Transactions Concurrent Program before Patchset I 9-88 Oracle Manufacturing APIs and Open Interfaces Manual .

Oracle Shop Floor Management Open Interfaces 9-89 . the ERRORed transaction should be corrected and resubmitted with PENDING status. it will be a two-step process s Import WIP Lot Transactions Cost Manager s The Import WIP Lot Transactions Concurrent Program will pickup the transactions submitted in the Interfaces tables. If the validations as well as the processing completes sucessfully. If there is any ERRORed transaction for a lot based job in the WIP Lot Transactions interface tables. Each transaction is validated and processed immediately. In such a case. else the interface transaction errors with the appropriate message populated in ERROR_ MESSAGE column. the additional step of running the WIP Lot Transactions Processor prior to Patchset I has been eliminated. the PROCESS_STATUS is set to COMPLETE. the further PENDING transactions (with transaction dates after the ERRORed transaction) for this lot based job will not be picked up for processing. one by one. Thus. by the order of transaction date.Import WIP Lot Transactions Concurrent Program But from Patchset I onwards.

Import WIP Lot Transactions Concurrent Program Figure 9–8 Basic Flow of Import WIP Lot Transactions Concurrent Program from Patchset I 9-90 Oracle Manufacturing APIs and Open Interfaces Manual .

Inventory Lot Transactions Interface Concurrent Program Inventory Lot Transactions Interface Concurrent Program The Inventory Lot Transactions interface supports the following types of transactions: Table 9–35 Transaction Types and Descriptions Transaction Description Split—creation of new Inventory lots Merge—increases quantity of an existing Inventory lot by combining 2 or more lots Translate—updates item. Figure 9–9 describes how data is imported from MES to Oracle Shop Floor Management through interface tables. or both Transfer—creates a subinventory transfer Transaction Type 1 2 3 4 Note: All of these transactions are identified as Miscellaneous Issues and Receipts in inventory material transactions. lot name. Oracle Shop Floor Management Open Interfaces 9-91 .

Inventory Lot Transactions Interface Concurrent Program Figure 9–9 Basic Flow of the Inventory Lot Transactions Interface for Updating Records 9-92 Oracle Manufacturing APIs and Open Interfaces Manual .

Usually either p_group_id or p_header_id should be populated but both can be simultaneously specified. To run from the command line. When calling this API. p_mode = 2 should be used to process all rows corresponding to group_id = p_group_id and row corresponding to header_id = p_ header_id. Oracle Shop Floor Management Open Interfaces 9-93 . select Import Inventory Lot Transactions. NUMBER.Inventory Lot Transactions Interface Concurrent Program Calling the Import Inventory Lot Transactions Interface Program In Oracle Shop Floor Management. NUMBER). NUMBER. NUMBER. the Run Requests menu.process_interface_rows (errbuf retcode p_group_id p_header_id p_mode OUT OUT IN IN IN VARCHAR2. enter the following command: WSMPINVL.

Some columns are not used by the program and marked as ignored.nextval x 1 .translate 4 .Login_ id) Ignored Ignored y (FND_ System Generated Global. Table 9–36 Column transaction_id WSM_LOT_SPLIT_MERGES_INTERFACE Null yes Data Type number Required Derived y (wsm_ split_ merge_ transactions _s.transfer Optional transaction_type_id no number organization_id wip_flag split_flag last_update_date last_updated_by creation_date created_by transaction_reference reason_id transaction_date last_update_login attribute_category attribute1 .merge 3 .Inventory Lot Transactions Interface Concurrent Program WSM_LOT_SPLIT_MERGES_ INTERFACE Table The following table lists the columns in the WSM_LOT_SPLIT_MERGES_ INTERFACE table and provides their load/update type and validation information.conc _request_id) 9-94 Oracle Manufacturing APIs and Open Interfaces Manual .split 2 .15 request_id no no no no no no no yes yes yes yes yes yes yes number number number date number date number varchar2(240) number date number varchar2(30) varchar2(150) number x x x x x x x IGNORED IGNORED y x y (FND_Global.

Inventory Lot Transactions Interface Concurrent Program Table 9–36 Column WSM_LOT_SPLIT_MERGES_INTERFACE Null yes Data Type number Required Derived y (FND_ GLOBAL.error 4 .running 3 .pending 2 .complete error_message group_id transaction_reason header_id yes yes yes no varchar2(2000) number varchar2(30) number x x System Generated if NULL Oracle Shop Floor Management Open Interfaces 9-95 .pr og_appl_id) y (FND_ GLOBAL.co nc_ program_ id) Optional System Generated program_application_ id Program_id yes number System Generated program_update_date process_status yes yes date number x y (SYSDATE) 1 .

pr og_appl_id) System Generated Optional lot_number inventory_item_id organization_id quantity subinventory_code locator_id revision last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .co nc_request_ id) y (FND_ GLOBAL.15 request_id no no no no no yes yes no no no no yes yes yes yes varchar2(30) number number number varchar2(10) number varchar2(3) date number date number number varchar2(30) varchar2(150) number program_application_ id yes number System Generated 9-96 Oracle Manufacturing APIs and Open Interfaces Manual .Inventory Lot Transactions Interface Concurrent Program WSM_STARTING_LOTS_INTERFACE Table The following table lists the columns in the WSM_STARTING_LOTS_ INTERFACE table and provides their load/update type and validation information: Table 9–37 Column transaction_id WSM_STARTING_LOTS_INTERFACE Null yes Data Type number Required Derived y (wsm_ split_ merge_ transactions _s.nextval x x x x x x (conditional) if subinventory is locator controlled y x x x x y (FND_Global.Login_ id) Ignored Ignored y (FND_ GLOBAL.

co nc_ program_ id) Optional System Generated program_update_date header_id yes no date number x y (SYSDATE) Oracle Shop Floor Management Open Interfaces 9-97 .Inventory Lot Transactions Interface Concurrent Program Table 9–37 Column program_id WSM_STARTING_LOTS_INTERFACE Null yes Data Type number Required Derived y (FND_ GLOBAL.

nextval x x x x used only by mode 2 lot controlled for imported lot based jobs Optional lot_number inventory_item_id organization_id wip_entity_id no no no yes varchar2(30) number number number quantity subinventory_code locator_id revision last_update_date last_updated_by creation_date created_by last_update_login attribute_category attribute1 .Login_ id) Ignored Ignored y (FND_ GLOBAL.co nc_request_ id) System Generated 9-98 Oracle Manufacturing APIs and Open Interfaces Manual .15 request_id no no yes yes no no no no yes yes yes yes number varchar2(10) number varchar2(3) date number date number number varchar2(30) varchar2(150) number x x x (conditional) if subinventory is locator controlled y x x x x y (FND_Global.Inventory Lot Transactions Interface Concurrent Program WSM_RESULTING_LOTS_INTERFACE Table The following table lists the columns in the WSM_RESULTING_LOTS_ INTERFACE table and provides their load/update type and validation information: Table 9–38 Column transaction_id WSM_RESULTING_LOTS_INTERFACE Null yes Data Type number Required Derived y (wsm_ split_ merge_ transactions _s.

pr og_appl_id) y (FND_ GLOBAL.Inventory Lot Transactions Interface Concurrent Program Table 9–38 Column WSM_RESULTING_LOTS_INTERFACE Null yes Data Type number Required Derived y (FND_ GLOBAL.co nc_ program_ id) Optional System Generated program_application_ id program_id yes number System Generated program_update_date header_id yes no date number x y (SYSDATE) Oracle Shop Floor Management Open Interfaces 9-99 .

Inventory Lot Transactions Interface Concurrent Program Validation of Inventory Lot Transactions Standard Validation Oracle Shop Floor Management validates all required columns in the Inventory Lot Transactions interface. The Inventory Lot Transactions processes the rows and reports the following values for every record. see your Oracle Shop Floor Management Technical Reference Manual for details. Table 9–39 Condition Success Failure Running Error Handling Table PROCESS_STATIS 4 3 2 ERROR_MESSAGE null actual error message null See Also Oracle Shop Floor Management Technical Reference Manual 11i 9-100 Oracle Manufacturing APIs and Open Interfaces Manual . the program will return error status to the calling module. Error Handling If any validation fails. For specific information on the data implied by these columns.

the PROCESS_STATUS of the corresponding header id is set to ERROR. The interface makes all the necessary validations that would be typically done from the front-end. Typically. When a concurrent request is launched for importing Inventory Lot Transactions. WSM_RESULTING_LOTS_INTERFACE tables. 5. Errors and Validations 1. 6. then only those records in the group and in the Pending status would by considered for processing. If a GROUP_ID is specified. 3. header_id column must be NOT NULL. 4. then the status of the concurrent request is set to WARNING.Inventory Lot Transactions Interface Concurrent Program Functional Overview Following are the major design features of the interface: 1. Use the wsm_lot_sm_ifc_header sequence to populate the header_id and group_id columns. 4. If the import program is run without specifying a GROUP_ID. If no group is specified while launching the import program. You can group the transactions to be put into the interface table by providing a GROUP_ID. 5. 2. All errors and warnings are written to the WSM_INTERFACE_ERRORS table. Whenever one record errors out within a group. the user can specify a GROUP_ID. 3. It is preferable to group only independent transactions. Unique GROUP_IDs are assigned to records in which the GROUP_ID is null. then the import program would assign a GROUP_ID to each and every transaction based on the TRANSACTION_ DATE. and if some GROUP_ID errors out. then the processing is done group by group for all the pending records in the respective group. Insert rows into the WSM_LOT_SPLIT_MERGE_INTERFACE. But if a group is specified and it errors out. transactions are processed in the order of TRANSACTION_ DATE. If a GROUP_ID is not specified. interdependent transactions should not be grouped together. 2. Oracle Shop Floor Management Open Interfaces 9-101 . WSM_ STARTING_LOTS_INTERFACE. Within a group. then the status of the concurrent request is set to ERROR. Transactions in one of these tables are joined with the transactions in the other two tables through the HEADER_ID column.

Inventory Lot Transactions Interface Concurrent Program 9-102 Oracle Manufacturing APIs and Open Interfaces Manual .

10 Oracle Purchasing Open Interfaces This chapter contains information about the following Oracle Purchasing open interfaces: s Requisitions Open Interface on page 10-2 Purchasing Documents Open Interface on page 10-31 Receiving Open Interface on page 10-87 Purchase Order Change APIs on page 10-123 Cancel PO API on page 10-131 s s s s Oracle Purchasing Open Interfaces 10-1 .

This interface lets you integrate Oracle Purchasing quickly with new or existing applications such as material requirements planning. 10-2 Oracle Manufacturing APIs and Open Interfaces Manual . Purchasing automatically validates your data and imports your requisitions. Functional Overview Figure 10–1 Functional Overview The diagram above shows the inputs and outputs that comprise the interface process. You can import requisitions as often as you want. and place them on purchase orders or internal sales orders. Then. The purpose of this essay is to explain how to use the Requisitions Open Interface so that you can integrate other applications with Purchasing. approve or reserve funds for them if necessary. you can review these requisitions.Requisitions Open Interface Requisitions Open Interface You can automatically import requisitions from other Oracle Applications or your existing non-Oracle systems using the Requisitions Open Interface. inventory management. and production control systems.

you should use the PO_REQ_DIST_INTERFACE_ALL table to create multiple distributions only for requisitions created in non-Oracle systems that use multiple distributions. Note: If you import the requisitions from Oracle Master Scheduling/MRP. DIST_SEQUENCE_ID. the program validates your data and derives or defaults additional information. multiple distributions and the PO_REQ_DIST_ INTERFACE_ALL table are not used. since Self-Service Purchasing updates the Purchasing interface tables directly rather than using Requisition Import. in Release 11i. enter No for Multiple Distributions (set MULTI_ DISTRIBUTIONS to N). If you do not specify any values for these parameters. Therefore. You then pass these values as parameters to the Requisition Import program. the program imports all the requisition lines in the PO_REQUISITIONS_INTERFACE_ALL table. You identify the set of rows you want to import by setting the INTERFACE_SOURCE_CODE and BATCH_ID columns appropriately in the PO_REQUISITIONS_INTERFACE_ALL table. The Requisition Import program operates in three phases. Oracle Order Management. As long as the Multiple Distributions field in the Requisition Import program is No (or blank). in the PO_REQ_DIST_INTERFACE_ALL table to determine what distributions belong to which requisition line. If MULTI_DISTRIBUTIONS is set to Y. In the first phase. If the column MULTI_DISTRIBUTIONS in the PO_REQUISITIONS_INTERFACE_ ALL table is Y. Then you use the Submit Request window to launch the Requisition Import program for any set of rows. Requisition Import looks for distribution information in the PO_REQUISITIONS_INTERFACE_ALL table.Requisitions Open Interface You must write the program that inserts a single row into the PO_REQUISITIONS_ INTERFACE_ALL and/or the PO_REQ_DIST_INTERFACE_ALL table for each requisition line that you want to import. The program generates an error message for every validation that fails and creates a row in the PO_INTERFACE_ERRORS table with detailed information about each error.0 and later. or Oracle Inventory (INV). Each run of the Requisition Import program picks up distribution information from either the PO_REQUISITIONS_INTERFACE_ALL or the PO_REQ_DIST_ INTERFACE_ALL table. the column REQ_DIST_SEQUENCE_ID in the PO_REQUISITIONS_INTERFACE_ALL table points to the primary key column. for Self-Service Purchasing (known then as Web Requisitions). The PO_REQ_DIST_INTERFACE_ALL table was used in Release 11. Requisition Import also checks for any records in the PO_ Oracle Purchasing Open Interfaces 10-3 . In Self-Service Purchasing 4. You also specify the requisition grouping and numbering criteria as parameters to the Requisition Import program.

and starts numbering requisitions. BUDGET_ACCOUNT_ID. For every line that is successfully imported. In the second phase. all lines with the same value in this column are grouped together under a requisition header. You can group requisition lines in one of the following ways that the Requisition Import program supports by: s BUYER CATEGORY LOCATION VENDOR ITEM ALL (all requisition lines grouped under one header) s s s s s If you provide a value in the REQ_NUMBER_SEGMENT1 column of the PO_ REQUISITIONS_INTERFACE_ALL table. ACCRUAL_ACCOUNT_ID. If you do not provide a value for this parameter.Requisitions Open Interface REQUISITIONS_INTERFACE_ALL table without corresponding distribution information in the PO_REQ_DIST_INTERFACE_ALL table and loads these as errors in the PO_INTERFACE_ERRORS table. all lines with the same value for this column are grouped together under a requisition header. If you specify a value in the REQ_ NUMBER_SEGMENT1 column of the PO_REQUISITIONS_INTERFACE_ALL table. This report 10-4 Oracle Manufacturing APIs and Open Interfaces Manual . this value becomes the requisition number.) Requisition supply is also created for every approved requisition that is successfully imported. and creates a report which lists the number of interface records that were successfully imported and the number that were not imported. If you do not provide values in either of these columns. the program loops until it finds a unique number. a default distribution is created with the account information that you specify. the program deletes all the successfully processed rows in the interface tables. In the third phase. (You specify account information in any of the following columns in either the PO_REQUISITIONS_INTERFACE_ALL or the PO_REQ_DIST_INTERFACE_ ALL table: CHARGE_ACCOUNT_ID. or any of the CHARGE_ACCOUNT_ SEGMENT columns. the program uses the default Group By that you set up to group requisition lines. If you provide a value in the GROUP_CODE column. the Requisition Import program uses either the Last Requisition Number parameter if specified or the next unique number stored in the PO_ UNIQUE_IDENTIFIER_CONTROL table. If not. the program groups and numbers the validated requisition lines according to the following criteria. the Requisition Import program uses the Group By parameter to group lines together. adds 1 to this number. If any of the requisition numbers generated already exists. VARIANCE_ ACCOUNT_ID.

Release 11i Assigning a Business Purpose to a Customer Address.Requisitions Open Interface can be viewed by choosing View Output for the Requisition Import concurrent Request ID in the Requests window. Oracle Purchasing User’s Guide. Release 11i Requisition Import Exceptions Report. Oracle Purchasing User’s Guide. The concurrent manager manages all processing. Oracle Receivables User’s Guide. You can launch the Requisition Import Exceptions Report to view the rows that were not imported by the Requisition Import program along with the failure reason(s) for each row. You must provide values for all columns that are required. you must associate a customer with your deliver-to