r12 scm open interfaces and apis

Oracle Supply Chain Management APIs and Open InterfacesGuide Release 12Part No. B40113-02

September 2007

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

Contents

Send Us Your Comments Preface 1 Integrating Your SystemsOverview................................................................................................................................... 1-1 Overview of Oracle Supply Chain Management APIs and Open Interfaces.......................... 1-1

2

Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 1ODS Load API Features............................................................................................................ 2-2 Functional Overview................................................................................................................. 2-6 Setting Up the ODS Load API.................................................................................................. 2-7 Parameter Descriptions............................................................................................................. 2-7 MSC_ST_ASSIGNMENT_SETS.............................................................................................. 2-7 MSC_ST_ATP_RULES............................................................................................................ 2-10 MSC_ST_BILL_OF_RESOURCES.......................................................................................... 2-18 MSC_ST_BIS_BUSINESS_PLANS......................................................................................... 2-21 MSC_ST_BIS_PERIODS......................................................................................................... 2-24 MSC_ST_BIS_PFMC_MEASURES.........................................................................................2-28 MSC_ST_BIS_TARGETS........................................................................................................ 2-31 MSC_ST_BIS_TARGET_LEVELS.......................................................................................... 2-37 MSC_ST_BOMS...................................................................................................................... 2-42 MSC_ST_BOM_COMPONENTS........................................................................................... 2-45 MSC_ST_BOR_REQUIREMENTS......................................................................................... 2-51 MSC_ST_CALENDAR_DATES..............................................................................................2-56 MSC_ST_CALENDAR_SHIFTS............................................................................................. 2-59

iii

MSC_ST_CAL_WEEK_START_DATES................................................................................ 2-62 MSC_ST_CAL_YEAR_START_DATES................................................................................. 2-65 MSC_ST_CATEGORY_SETS................................................................................................. 2-67 MSC_ST_COMPONENT_SUBSTITUTES............................................................................. 2-70 MSC_ST_DEMANDS............................................................................................................. 2-73 MSC_ST_DEMAND_CLASSES............................................................................................. 2-83 MSC_ST_DEPARTMENT_RESOURCES...............................................................................2-88 MSC_ST_DESIGNATORS..................................................................................................... 2-96 MSC_ST_INTERORG_SHIP_METHODS........................................................................... 2-101

3

Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 2MSC_ST_ITEM_CATEGORIES............................................................................................... 3-2 MSC_ST_ITEM_SUPPLIERS.................................................................................................... 3-5 MSC_ST_LOCATION_ASSOCIATIONS.............................................................................. 3-10 MSC_ST_NET_RESOURCE_AVAIL...................................................................................... 3-13 MSC_ST_OPERATION_COMPONENTS..............................................................................3-16 MSC_ST_OPERATION_RESOURCES.................................................................................. 3-19 MSC_ST_OPERATION_RESOURCE_SEQS......................................................................... 3-22 MSC_ST_PARAMETERS........................................................................................................3-25 MSC_ST_PARTNER_CONTACTS.........................................................................................3-31 MSC_ST_PERIOD_START_DATES...................................................................................... 3-34 MSC_ST_PLANNERS............................................................................................................. 3-37 MSC_ST_PROCESS_EFFECTIVITY.......................................................................................3-42 MSC_ST_PROJECTS.............................................................................................................. 3-46 MSC_ST_PROJECT_TASKS...................................................................................................3-50 MSC_ST_RESERVATIONS.................................................................................................... 3-54 MSC_ST_RESOURCE_CHANGES........................................................................................ 3-58 MSC_ST_RESOURCE_GROUPS........................................................................................... 3-61 MSC_ST_RESOURCE_REQUIREMENTS............................................................................. 3-66 MSC_ST_RESOURCE_SHIFTS.............................................................................................. 3-72 MSC_ST_ROUTINGS............................................................................................................. 3-74 MSC_ST_ROUTING_OPERATIONS.................................................................................... 3-79 MSC_ST_SAFETY_STOCKS.................................................................................................. 3-84 MSC_ST_SALES_ORDERS.................................................................................................... 3-87 MSC_ST_SHIFT_DATES........................................................................................................ 3-93

4

Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 3MSC_ST_SHIFT_EXCEPTIONS............................................................................................... 4-1 MSC_ST_SHIFT_TIMES.......................................................................................................... 4-4 MSC_ST_SIMULATION_SETS............................................................................................... 4-7

iv

MSC_ST_SOURCING_HISTORY............................................................................................ 4-9 MSC_ST_SOURCING_RULES............................................................................................... 4-13 MSC_ST_SR_ASSIGNMENTS...............................................................................................4-16 MSC_ST_SR_RECEIPT_ORG.................................................................................................4-20 MSC_ST_SR_SOURCE_ORG................................................................................................. 4-23 MSC_ST_SUB_INVENTORIES.............................................................................................. 4-28 MSC_ST_SUPPLIER_CAPACITIES....................................................................................... 4-31 MSC_ST_SUPPLIES................................................................................................................ 4-37 MSC_ST_SYSTEM_ITEMS.................................................................................................... 4-56 MSC_ST_TRADING_PARTNERS......................................................................................... 4-72 MSC_ST_TRADING_PARTNER_SITES............................................................................... 4-80 MSC_ST_UNITS_OF_MEASURE.......................................................................................... 4-83 MSC_ST_UOM_CLASS_CONVERSIONS............................................................................ 4-88 MSC_ST_UOM_CONVERSIONS.......................................................................................... 4-92

5 Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIsOpen Forecast Interface............................................................................................................. 5-2 Validation.................................................................................................................................. 5-6 Resolving Failed Open Forecast Interface Rows...................................................................... 5-7 Open Master Schedule Interface...............................................................................................5-8 Validation................................................................................................................................ 5-12 Resolving Failed Open Master Schedule Interface Rows...................................................... 5-13 Open Forecast Entries Application Program Interface........................................................... 5-14 Open Forecast Interface Designator Table Description......................................................... 5-17 Validation................................................................................................................................ 5-19 Using the Open Forecast Entries API......................................................................................5-21 Sourcing Rule Application Program Interface....................................................................... 5-22 Setting Up the Sourcing Rule/Bill of Distribution API......................................................... 5-24 Record Parameter Descriptions............................................................................................... 5-28 Validation of Sourcing Rule /Bill of Distribution API.......................................................... 5-41 Sourcing Rule Assignment API Features............................................................................... 5-43 Setting Up the Sourcing Rule Assignment API......................................................................5-44 Record Parameter Descriptions............................................................................................... 5-47 Validation of Sourcing Rule Assignment API....................................................................... 5-56

6

Bills of Material Open InterfacesBill of Materials API Overview................................................................................................ 6-1 Using the Bills of Materials Open Interfaces........................................................................... 6-2 Bills of Material Entity Diagram............................................................................................. 6-10

v

Bill of Material Import Description........................................................................................ 6-12 Bill of Material Parameter Descriptions................................................................................. 6-20 Bill of Material Package Interaction ...................................................................................... 6-39 Bill of Material Import Error Handling and Messaging........................................................ 6-41 Bill of Material Export API..................................................................................................... 6-51 Routing API Overview............................................................................................................ 6-55 Routing Import Description.................................................................................................... 6-59 Routing Parameter Descriptions............................................................................................. 6-67 Launching the Routing Import............................................................................................... 6-93 Routing Package Interaction .................................................................................................. 6-98 Routing Import Error Handling and Messaging.................................................................. 6-100 API Messaging....................................................................................................................... 6-105

7

Cost Management Open InterfacesPeriodic Cost Open Interface.................................................................................................... 7-1 Setting Up the Interface............................................................................................................ 7-3 Periodic Cost Open Interface Runtime Options.......................................................................7-3 Inserting into the Periodic Cost Interface Tables..................................................................... 7-3 Validation................................................................................................................................ 7-11 Reviewing Failed Rows .......................................................................................................... 7-15 Cost Import Interface.............................................................................................................. 7-18 Setting Up the Cost Import Interface...................................................................................... 7-19

8

Engineering Open InterfacesOverview................................................................................................................................... 8-1 Features...................................................................................................................................... 8-2 Business Object APIs................................................................................................................ 8-6 Entity Process Flows................................................................................................................ 8-16 ECO Headers........................................................................................................................... 8-16 ECO Revisions......................................................................................................................... 8-18 Revised Items.......................................................................................................................... 8-20 Revised Components............................................................................................................... 8-22 Reference Designators............................................................................................................. 8-26 Substitute Components........................................................................................................... 8-28 New API Packages................................................................................................................... 8-29 Launching the Import.............................................................................................................. 8-32 Package Interaction................................................................................................................. 8-37 Import Error Handling and Messaging.................................................................................. 8-48 API Messaging......................................................................................................................... 8-57 Error Handler........................................................................................................................... 8-59

vi

9

Oracle Flow Manufacturing Open Interfaces and APIsFlow Schedule API.................................................................................................................... 9-1

10

Oracle Shop Floor Management Open InterfacesImport Lot Jobs Concurrent Program..................................................................................... 10-1 Lot Move Transactions Concurrent Program........................................................................ 10-46 Import WIP Lot Transactions Concurrent Program..............................................................10-72 Inventory Lot Transactions Interface Concurrent Program............................................... 10-150 Lot Attributes....................................................................................................................... 10-159

11

Oracle Quality Open Interfaces and APIsCollection Import Interface..................................................................................................... 11-1 Collection Plan Views........................................................................................................... 11-20 Overview of the Oracle Quality Application Program Interfaces....................................... 11-22 Create Specification Application Program Interface............................................................11-26 Add Specification Element Application Program Interface.................................................11-32 Complete Specification Application Program Interface...................................................... 11-36 Delete Specification Application Program Interface........................................................... 11-39 Delete Specification Element Application Program Interface............................................. 11-42 Copy Specification Application Program Interface............................................................. 11-45 Using the Specification APIs................................................................................................ 11-49 Create Collection Plan Application Program Interface........................................................ 11-53 Add Collection Plan Element Application Program Interface............................................. 11-57 Complete Collection Plan Processing Application Program Interface................................ 11-62 Delete Collection Plan Application Program Interface........................................................ 11-65 Delete Collection Plan Element Application Program Interface......................................... 11-69 Copy Collection Plan Application Program Interface.......................................................... 11-72 Using the Collection Plan APIs............................................................................................. 11-76

12

Oracle Work in Process Open InterfacesOpen Move Transaction Interface.......................................................................................... 12-1 Functional Overview......................................................................................................... 12-2 Setting Up the Move Transaction Interface........................................................................ 12-3 Launching the Move Transaction Manager................................................................. 12-3 Inserting Records into the WIP_MOVE_TXN_INTERFACE Table............................. 12-4 Validating Move Transactions................................................................................... 12-14 Resolving Failed Rows.............................................................................................. 12-15 Open Resource Transaction Interface................................................................................... 12-16

vii

Functional Overview....................................................................................................... 12-16 Setting Up the Resource Transaction Interface................................................................ 12-17 Launching the Cost Manager.................................................................................... 12-17 Inserting Records into the WIP_COST_TXN_INTERFACE Table............................. 12-17 Validating Resource Transactions............................................................................. 12-24 Resolving Failed Rows.............................................................................................. 12-25 Work Order Interface............................................................................................................ 12-25 Functional Overview....................................................................................................... 12-27 Setting Up the Work Order Interface.........................................................................12-29 Inserting Records Into the Work Order Interface...................................................... 12-29 WIP_JOB_SCHEDULE_INTERFACE Table.............................................................. 12-31 WIP_JOB_DTLS_INTERFACE Table.................................................................. 12-58 Primary and Alternate Resources.............................................................................. 12-73 Validating Work Order Interface Records................................................................. 12-73 Resolving Failed Rows.............................................................................................. 12-74

13

Oracle Inventory Open Interfaces and APIsOpen Transaction Interface..................................................................................................... 13-2 Setting Up the Transaction Interface................................................................................ 13-12 Inserting into the Transaction Interface Tables................................................................ 13-14 Transaction Lots Interface................................................................................................ 13-31 Serial Numbers Interface................................................................................................. 13-44 CST_COMP_SNAP_INTERFACE.................................................................................... 13-55 Validation........................................................................................................................ 13-56 Resolving Failed Transaction Interface Rows.................................................................. 13-57 Transaction Flow Application Program Interface................................................................ 13-57 Open Replenishment Interface............................................................................................. 13-66 Inserting into the Replenishment Interface Tables........................................................... 13-67 Replenishment Headers Interface Tables......................................................................... 13-68 Validation........................................................................................................................ 13-74 Viewing Failed Transactions............................................................................................ 13-75 Fixing Failed Transactions............................................................................................... 13-76 Cycle Count Entries Interface............................................................................................... 13-76 Cycle Count Entries Interface Table................................................................................. 13-77 Cycle Count Interface Errors Table.................................................................................. 13-80 Table Administration and Audit Trail............................................................................. 13-81 Cycle Count Application Program Interface........................................................................ 13-82 Setting Up the Cycle Count API.......................................................................................13-82 Validation of Cycle Count API.........................................................................................13-84 Kanban Application Program Interface................................................................................ 13-85

viii

Validation of Kanban API................................................................................................ 13-87 Lot Application Program Interface....................................................................................... 13-88 Setting Up the Lot API..................................................................................................... 13-88 Validation of Lot API..................................................................................................... 13-107 Material Reservation Application Program Interface........................................................ 13-108 Setting Up the Material Reservation API....................................................................... 13-109 Validation of Material Reservation API......................................................................... 13-127 Reservations Manager Application Program Interface...................................................... 13-128 Setting Up the Reservations Manager API..................................................................... 13-128 Validation of Reservations Manager API....................................................................... 13-130 Sales Order Application Program Interface....................................................................... 13-130 Setting Up the Sales Order API...................................................................................... 13-131 Validation of Sales Order API........................................................................................ 13-134 Move Order Application Program Interface.......................................................................13-135 Setting Up the Move Order API..................................................................................... 13-136 Validation of Move Order API....................................................................................... 13-150 Move Order Admin API...................................................................................................... 13-151 Line_Details_pub................................................................................................................ 13-158 Pick Confirm Application Program Interface.....................................................................13-162 Setting Up the Pick Confirm API................................................................................... 13-162 Validation of Pick Confirm API..................................................................................... 13-165 Pick Release Interface..................................................................................................... 13-166 Quantity Tree Program Interface........................................................................................ 13-167 Procedure Name: UPDATE_QUANTITIES................................................................... 13-173 Procedure Name: DO_CHECK...................................................................................... 13-179 Procedure Name: QUERY_QUANTITIES......................................................................13-181 Validation of Quantity Tree API.................................................................................... 13-187 Material Transactions Applications Program Interface..................................................... 13-187 Setting Up Transaction Processing API......................................................................... 13-187 Inter-Company Transaction Flow Application Program Interface.................................... 13-190 Setting Up the Inter-Company Transaction Flow API................................................... 13-191 Validation of Inter-Company Transaction Flow API..................................................... 13-222 Serial Number Public Application Program Interface....................................................... 13-223 Setting Up the Serial Number API................................................................................. 13-223 Validation of Serial Number.......................................................................................... 13-231 User Defined Serial Generation Application Program Interface.......................................13-231 Setting Up the User Defined Serial Generation API.......................................................13-231 Validation of User Defined Serial Generation API.........................................................13-234

ix

14

Oracle Items Open Interfaces and APIsItem Open Interface................................................................................................................ 14-1 Setting Up the Item Open Interface....................................................................................14-2 Item Open Interface Run-Time Options............................................................................. 14-4 Inserting Item Information into the Item Open Interface Table......................................... 14-5 Validation........................................................................................................................ 14-17 Importing Additional Item Details.................................................................................. 14-18 Importing Item Category Assignments............................................................................14-22 Item Category Assignment Interface Runtime Options................................................... 14-22 Inserting Item Category Information into the Item Categories Interface Table............... 14-23 Update Existing Items...................................................................................................... 14-23 Determining Batch Size.................................................................................................... 14-24 Resolving Failed Interface Rows...................................................................................... 14-25 Multithread Capability (Parallel Runs of the Item Open Interface)................................. 14-27 Category Application Program Interface.............................................................................. 14-30 Item Category Assignment API............................................................................................ 14-37 Customer Item and Customer Item Cross-Reference Open Interfaces................................ 14-41 Interface Run-Time Options.............................................................................................14-43 Customer Item Open Interface Table............................................................................... 14-44 Customer Item Open Interface - Defining a Unique Customer Item............................... 14-47 Customer Item Open Interface - Other Fields.................................................................. 14-49 Customer Item Cross-Reference Interface Table.............................................................. 14-52

15

Oracle Warehouse Management Open Interfaces and APIsCompliance Label Application Program Interface................................................................. 15-1 Functional Overview......................................................................................................... 15-2 Detailed Discussion of Parameters Required for Each Label Type.................................... 15-6 Oracle Warehouse Management Device Integration API...................................................... 15-7 Device Confirmation API................................................................................................... 15-9 Locator Maintenance API...................................................................................................... 15-10 Create Locator API........................................................................................................... 15-11 Update Locator API......................................................................................................... 15-16 Create Locator Item Tie API.............................................................................................15-20 Delete Locator API........................................................................................................... 15-22 Container API........................................................................................................................ 15-23 Generate LPN API........................................................................................................... 15-23 Create LPN API............................................................................................................... 15-28 Modify LPN API.............................................................................................................. 15-32 Oracle Warehouse Management Installation API................................................................ 15-34

x

Radio Frequency Identifier APIs.......................................................................................... 15-35 Process RFID Transaction API......................................................................................... 15-36 WMS Read RFID Event API............................................................................................. 15-37 Get New Load Verification Threshold Value API............................................................ 15-39 Close Truck and Ship Confirm API...................................................................................... 15-42 Electronic Product Code API................................................................................................. 15-43 Crossdock Customization API.............................................................................................. 15-50 Rules Engine Custom API..................................................................................................... 15-59

16

Receiving Open InterfaceReceiving Open Interface........................................................................................................ 16-2 Functional Overview............................................................................................................... 16-4 Receiving Transaction Processor Activities............................................................................ 16-8 ASN Quantity Updates........................................................................................................... 16-9 Cascading Transaction Quantities for ASNs and Receipts.................................................... 16-9 Setting Up the Receiving Open Interface............................................................................. 16-10 Inserting into the Receiving Open Interface Table.............................................................. 16-10 Receiving Headers Interface Table Description................................................................... 16-11 Receiving Transactions Interface Table Description........................................................... 16-26 Oracle Warehouse Management License Plate Number Interface Table Description........ 16-61 Derived Data.......................................................................................................................... 16-69 Optional Data........................................................................................................................ 16-69 Validation.............................................................................................................................. 16-70 Debugging............................................................................................................................. 16-70 Resolving Failed Receiving Open Interface Rows............................................................... 16-71 Receiving Open Interface Details for Advanced Shipment Notice Import and Receipt Transactions........................................................................................................................... 16-72 Receiving Open Interface Data Details for Post Receipt Transactions................................16-83 Sample Scripts....................................................................................................................... 16-88 Stuck Transaction Scenarios and Scripts............................................................................ 16-107 Oracle Warehouse Management LPN Interface Table Supplemental Information.......... 16-115

17

eAM Open Interfaces and APIseAM Open Interfaces and APIs.............................................................................................. 17-2 eAM Item Open Interface....................................................................................................... 17-3 eAM Asset Number Open Interface....................................................................................... 17-9 eAM Asset Genealogy Open Interface................................................................................. 17-18 eAM Meter Reading Open Interface.................................................................................... 17-20 Asset Number API................................................................................................................. 17-24 Asset Attribute Values API................................................................................................... 17-30

xi

Asset Attribute Groups API.................................................................................................. 17-37 Asset Routes API................................................................................................................... 17-40 Asset Areas API..................................................................................................................... 17-46 Department Approvers API.................................................................................................. 17-49 EAM Parameters API............................................................................................................. 17-51 EAM Meters API................................................................................................................... 17-57 EAM Meter Association API................................................................................................. 17-63 Meter Reading API................................................................................................................ 17-65 EAM PM Schedules API (includes PM Rules as children records)..................................... 17-69 Activity Creation API............................................................................................................ 17-77 EAM Activity Association API..............................................................................................17-93 EAM Activity Suppression API.......................................................................................... 17-101 EAM Set Name API............................................................................................................. 17-105 Maintenance Object Instantiation API............................................................................... 17-110 Work Order Business Object API....................................................................................... 17-112 Work Request API............................................................................................................... 17-139

18

eAM Profile OptionsProfile Option Summary......................................................................................................... 18-1 Profile Option Details............................................................................................................. 18-3 Profile Options in Other Applications................................................................................... 18-6 Profile Option Details............................................................................................................. 18-7

19

Oracle Complex Maintenance Repair and Overhaul Open InterfacesComplex Maintenance Repair and Overhaul API Overview.................................................19-1

20

Oracle Service Contracts APIs IntroductionOverview................................................................................................................................. 20-1 Parameter Specifications......................................................................................................... 20-1 Standard IN Parameters.......................................................................................................... 20-2 Standard OUT Parameters...................................................................................................... 20-3 Parameter Size......................................................................................................................... 20-4 Missing Parameter Attributes................................................................................................. 20-4 Parameter Validations............................................................................................................. 20-5 Invalid Parameters................................................................................................................... 20-5 Version Information................................................................................................................ 20-5 Status Messages....................................................................................................................... 20-6

xii

21

Oracle Asset Tracking APIOverview of the Oracle Asset Tracking API.......................................................................... 21-1 Oracle Asset Tracking Public Package................................................................................... 21-1 Contents of Package CSE_DEPLOYMENT_GRP................................................................... 21-4

22

Oracle Service Contracts Public APIsEntitlement/OM Integration APIs ..........................................................................................22-1 Package OKS_ENTITLEMENTS_PUB................................................................................... 22-4 Check Coverage Times............................................................................................................ 22-5 Check Reaction Times............................................................................................................. 22-6 Get React Resolve By Time..................................................................................................... 22-8 Get All Contracts................................................................................................................... 22-12 Get Contract Details.............................................................................................................. 22-17 Get Contracts ........................................................................................................................ 22-20 Get Contracts......................................................................................................................... 22-24 Get Contracts......................................................................................................................... 22-30 Get Coverage Levels.............................................................................................................. 22-35 Get Contacts........................................................................................................................... 22-40 Get Preferred Engineers........................................................................................................ 22-42 Get Coverage Type................................................................................................................ 22-44 Get Cov Txn Groups.............................................................................................................. 22-46 Get Txn Billing Types........................................................................................................... 22-49 Get Contracts Expiration....................................................................................................... 22-54 Validate Contract line........................................................................................................... 22-55 Package OKS_CON_COVERAGE_PUB............................................................................... 22-59 Apply Contract Coverage...................................................................................................... 22-59 Get BP Pricelist...................................................................................................................... 22-63 Package OKS_OMINT_PUB................................................................................................. 22-65 Get Duration.......................................................................................................................... 22-65 Is Service Available............................................................................................................... 22-68 Available Services................................................................................................................. 22-71 OKS Available Services........................................................................................................ 22-73

Index

xiii

Send Us Your CommentsOracle Supply Chain Management APIs and Open Interfaces Guide, Release 12Part No. B40113-02

Oracle welcomes customers' comments and suggestions on the quality and usefulness of this document. Your feedback is important, and helps us to best meet your needs as a user of our products. For example: Are the implementation steps correct and complete? Did you understand the context of the procedures? Did you find any errors in the information? Does the structure of the information help you with your tasks? Do you need different information or graphics? If so, where, and in what format? Are the examples correct? Do you need more examples?

If you find any errors or have any other suggestions for improvement, then please tell us your name, the name of the company who has licensed our products, the title and part number of the documentation and the chapter, section, and page number (if available). Note: Before sending us your comments, you might like to check that you have the latest version of the document and if any concerns are already addressed. To do this, access the new Applications Release Online Documentation CD available on Oracle MetaLink and www.oracle.com. It contains the most current Documentation Library plus all documents revised or released recently. Send your comments to us using the electronic mail address: [email protected] Please give your name, address, electronic mail address, and telephone number (optional). If you need assistance with Oracle software, then please contact your support representative or Oracle Support Services. If you require training or instruction in using Oracle software, then please contact your Oracle local office and inquire about our Oracle University offerings. A list of Oracle offices is available on our Web site at www.oracle.com.

xv

Preface

Intended AudienceWelcome to Release 12 of the Oracle Supply Chain Management APIs and Open Interfaces Guide. See Related Information Sources on page xviii for more Oracle Applications product information.

TTY Access to Oracle Support ServicesOracle provides dedicated Text Telephone (TTY) access to Oracle Support Services within the United States of America 24 hours a day, seven days a week. For TTY support, call 800.446.2398.

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

Accessibility of Code Examples in DocumentationScreen readers 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, some screen readers may not always read a line of text that

xvii

consists solely of a bracket or brace.

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

Structure1 Integrating Your Systems 2 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 1 3 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 2 4 Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 3 5 Oracle Master Scheduling/MRP and Oracle Supply Chain Planning Open Interfaces and APIs 6 Bills of Material Open Interfaces 7 Cost Management Open Interfaces 8 Engineering Open Interfaces 9 Oracle Flow Manufacturing Open Interfaces and APIs 10 Oracle Shop Floor Management Open Interfaces 11 Oracle Quality Open Interfaces and APIs 12 Oracle Work in Process Open Interfaces 13 Oracle Inventory Open Interfaces and APIs 14 Oracle Items Open Interfaces and APIs 15 Oracle Warehouse Management Open Interfaces and APIs 16 Receiving Open Interface 17 eAM Open Interfaces and APIs 18 eAM Profile Options 19 Oracle Complex Maintenance Repair and Overhaul Open Interfaces 20 Oracle Service Contracts APIs Introduction 21 Oracle Asset Tracking API 22 Oracle Service Contracts Public APIs

Related Information SourcesIntegration RepositoryThe Oracle Integration Repository is a compilation of information about the service endpoints exposed by the Oracle E-Business Suite of applications. It provides a complete catalog of Oracle E-Business Suite's business service interfaces. The tool lets users easily discover and deploy the appropriate business service interface for integration with any system, application, or business partner. The Oracle Integration Repository is shipped as part of the E-Business Suite. As your instance is patched, the repository is automatically updated with content appropriate for the precise revisions of interfaces in your environment.

xviii

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

xix

1Integrating Your SystemsThis chapter covers the following topics: Overview Overview of Oracle Supply Chain Management APIs and Open Interfaces

OverviewThis chapter provides an overview of Oracle Supply Chain Management integration tools and explains how to use these tools to integrate Oracle Supply Chain Management products with one another and with your existing nonOracle systems. Oracle Supply Chain Management integration tools are powerful, flexible tools that enable you to capture data from other Oracle applications or your own applications, define necessary format conversions, and direct data to your Oracle Supply Chain Management products. Topics covered here include: Overview of Oracle Supply Chain Management APIs and Open Interfaces

Overview of Oracle Supply Chain Management APIs and Open InterfacesOracle Supply Chain Management products provide a number of open interfaces that enable you to link with non-Oracle applications, applications you build, applications on other computers, and even the applications of your suppliers and customers. The purpose of this essay is to help you understand the general model Oracle Supply Chain Management products use for open application interfaces. Other essays in this chapter provide specific information on how to use each of the open interfaces. Additional functional information on these interfaces is available in each product's User's Guide. Additional technical information on these interfaces is available in each product's technical reference manual.

Integrating Your Systems 1-1

Basic Business NeedsOracle Supply Chain Management product application programming interfaces (APIs) and open interfaces provide you with the features that you need to support the following basic business needs: Connect to data collection devices. This feature lets you collect material movement transactions such as receipts, issues, quality data, movements, completions, and shipments. This feature speeds data entry and improves transaction accuracy. Connect to other systems (such as finite scheduling packages, computer-aided design systems, custom, and legacy manufacturing systems) to create integrated enterprise-wide systems. Connect to external systems (such as the customer's purchasing system and the supplier's order entry system) to better integrate the supply chain through electronic commerce. Control processing of inbound data imported from outside Oracle applications. Validate imported data to ensure integrity of Oracle Supply Chain Management products. Review, update, and resubmit imported data that failed validation. Export data from Oracle Supply Chain Management products.

Oracle Supply Chain Management InterfacesOpen Interfaces Architectures Oracle Supply Chain Management products use three different methods to import and export data: Interface Tables Interface Views (Business Views) Function Calls or Programmatic Interfaces (Processes)

Interface Tables Interface tables, both inbound and outbound, normally require some validation through a concurrent program. These tables are fully documented in the essays that follow this chapter. In several instances, 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.

1-2 Oracle Supply Chain Management APIs and Open Interfaces Guide

Interface Views (Business Views) Views simplify the data relationships for easier processing, whether for reporting or data export. Oracle Supply Chain Management and Distribution products have defined business views that identify certain areas of key business interest. You can access this data using your tool of choice. The MTL_ITEM_QUANTITIES_VIEW is an example of a key business view. Product views are defined in the technical reference manuals. The view definitions also briefly describe how they are used. Many views, such as shortage reporting views in Oracle Work in Process, have been added specifically for easier reporting. Dynamic Views have also been added in Oracle Quality. Dynamic Views are views that are dynamically created and re-created as you create and modify collection plans in Oracle Quality. Function Calls or Programmatic Interfaces (Processes) Some open interfaces are more fundamental to the architecture of Oracle Supply Chain Management products. They are not interfaces as much as open integration. For example, note flex-field validation by table/view. In this class of inbound interfaces, the addition of views automatically imports data into an existing function. This provides tight integration without adding a batch process to move data. Another example is modifying open stored procedures. In the Oracle Bills of Material concurrent program AutoCreate Configuration, you can add business-specific logic to match configurations (check for duplicate configurations) by modifying the stored procedures provided for this purpose. Summary: Beyond Published Interfaces The Oracle Cooperative Applications Initiative references many third-party products that provide import and export capabilities and enable loose-to-tight integration with legacy systems, other supplier systems, and so on. Contact your Oracle consultant for more information about system integration. Current Documentation For Open Interfaces Here are the actual names of the tables, views, and modules:Key Data Flow Direction Inbound means into Oracle Supply Chain Management; Outbound means out from Oracle Supply Chain Management The interface is documented in detail in the Oracle Supply Chain Management and Distribution Open Interfaces Manual

Iface Man


TRM

The tables, views, or modules are described in the product's technical reference manual

Interface/API Name

Data Flow Direction

Table, View, Process, or Procedure

Iface Man

TRM

Table, View, Module Name, or Procedure Name INV MTL_TRANS ACTIONS_I NTERFACE MTL_SERIAL _NUMBERS_ INTERFACE MTL_TRANS ACTION_LO TS_ INTERFACE MTL_DEMA ND_INTERF ACE MTL_ITEM_ QUANTITIES _VIEW MTL_USER_ SUPPLY MTL_USER_ DEMAND MTL_REPLE NISH_HEAD ERS_INT MTL_REPLE NISH_LINES _INT

INV Transactions

INV Inbound

INV Table

INV Yes

INV Yes

Demand Interface

Inbound

Table

Yes

Yes

On-Hand Balances

Outbound

View

Yes

User-Defined Supply User-Defined Demand Replenishme nt

Inbound

Table

Yes

Inbound

Table

Yes

Inbound

Table

Yes

Yes


Item

Inbound

Table

Yes

Yes

MTL_SYSTE M_ITEMS_IN TERFACE MTL_ITEMS_ REVISIONS_ INTERFACE MTL_CI_INT ERFACE MTL_CI_XRE FS_INTERFA CE

Customer Item Customer_ite m Cross-Refere nces Material

Inbound

Table

Yes

Yes

Inbound

Table

Yes

Yes

Inbound

Table

Yes

Yes

MTL_TRANS ACTIONS_I NTERFACE MTL_SERIAL _NUMBERS_ INTERFACE MTL_TRANS ACTION_LO TS_ INTERFACE ENG/BOM BOM_CALE NDAR_MON THS_VIEW

ENG/BOM MFG Calendar

ENG/BOM Outbound

ENG/BOM View

ENG/BOM

ENG/BOM Yes


Bill of Material

Inbound

Table

Yes

Yes

BOM_BILL_ OF_MTLS_IN TERFACE BOM_INVEN TORY_COM PS_ INTERFACE BOM_REF_D ESGS_INTER FACE BOM_SUB_C OMPS_INTE RFACE MTL_ITEMS_ REVISIONS_ INTERFACE BOM_EXPOR T_TAB BOM_SMAL L_EXPL_TE MP BOM_OP_RO UTINGS_INT ERFACE BOM_OP_SE QUENCES_I NTERFACE BOM_OP_RE SOURCES_I NTERFACE MTL_RTG_IT EM_REVS_I NTERFACE

Routings

Inbound

Table

Yes

Yes


ECO

Inbound

Table

Yes

Yes

ENG_ENG_C HANGES_IN TERFACE ENG_ECO_R EVISIONS_I NTERFACE ENG_REVISE D_ITEMS_IN TERFACE BOM_INVEN TORY_COM PS_ INTERFACE BOM_REF_D ESGS_INTER FACE BOM_SUB_C OMPS_INTE RFACE eAM MTL_SYSTE M_ITEMS_IN TERFACE MTL_ITEM_ REVISIONS_ INTERFACE MTL_ITEM_ CATEGORIE S_ INTERFACE MTL_INTER FACE_ERRO RS MTL_EAM_ ASSET_NUM _ INTERFACE MTL_EAM_ ATTR_VAL_I NTERFACE MTL_EAM_ ATTR_VAL_I NTERFACE

eAM eAM Item Open Interface

eAM Inbound

eAM Table

eAM Yes

eAm Yes

eAM Asset Number Open Interface

Inbound

Table

Yes

Yes


eAM Asset Genealogy Open Interface eAm Work Order Open Interface

Inbound

Table

Yes

Yes

MTL_OBJEC T_GENEALO GY_ INTERFACE WIP_JOB_SC HEDULE_IN TERFACE WIP_DISCRE TE_JOBS EAM_METE R_READING _ INTERFACE -

Inbound

Table

Yes

Yes

eAM Meter Reading Open Interface Oracle Cost Management (see Oracle Bills of Material Technical Reference Manual) Item Cost Inquiry

Inbound

Table

Yes

Yes

-

-

-

-

Outbound

View

Yes

CST_INQUIR Y_TYPES CSTFQVIC (View Item Cost Information) CST_REPOR T_TYPES CSTRFICR (Inventory Valuation Report) MRP/SCP MRP_FOREC AST_INTERF ACE

MFG Cost Reporting

Outbound

View

Yes

MRP/SCP Forecast Interface

MRP/SCP Inbound

MRP/SCP Table

MRP/SCP Yes

MRP/SCP Yes


Forecast Entries API

Inbound

Process PL/SQL Table

Yes

Yes

T_FORECAS T_INTERFAC E T_FORECAS T_DESIGNA TOR MRP_SCHED ULE_INTERF ACE MRP_RELIEF _INTERFACE

Master Schedule Interface Master Schedule Relief Interface Planner Workbench Interface

Inbound

Table

Yes

Yes

Inbound

Table

Yes

Outbound

Process

Yes

Stored Procedure MRPPL06, or WIP_JOB_SC HEDULE_IN TERFACE PO_REQUISI TIONS_INTE RFACE PO_RESCHE DULE_INTE RFACE MRP_RECO MMENDATI ONS MRP_GROSS _REQUIREM ENTS

Projected Requirements Interface Projected Supply Interface

Outbound

Table

Yes

Outbound

Table

Yes


Sourcing Rule API

Outbound

Procedure

Yes

Yes

MRP_SOURC ING_RULE_ PUB.PROCES S_SOURCIN G_RULE MRP_SRC_A SSIGNMENT _ PUB.PROCES S_ASSIGNM ENT PO PO_REQUISI TIONS_INTE RFACE PO_REQ_DIS T_INTERFAC E PO_RESCHE DULE_INTE RFACE PO_HEADER S_INTERFAC E PO_LINES_I NTERFACE PO_DISTRIB UTIONS_INT ERFACE RCV_HEADE RS_INTERFA CE RCV_TRANS ACTIONS_I NTERFACE QA QA_RESULT S_INTERFAC E

PO Requisitions

PO Inbound

PO Table

PO Yes

PO Yes

Requisition Reschedule

Inbound

Table

Yes

Yes

Purchasing Documents

Inbound

Table

Yes

Yes

Receiving

Inbound

Table

Yes

Yes

QA Collection Import

QA Inbound

QA Table

QA Yes

QA Yes


Dynamic Collection Plan View Dynamic Collection Import View WSM Import Lot Jobs

Outbound

View

Yes

Yes

Q_COLLECT ION_PLAN_ NAME_V Q_COLLECT ION_PLAN_ NAME_IV WSM WSM_LOT_J OB_INTERF ACE WSM_LOT_ MOVE_TXN_ INTERFACE WSM_SPLIT_ MERGE_TXN _ INTERFACE WSM_START ING_JOBS_I NTERFACE WSM_RESUL TING_JOBS_ INTERFACE WSM_LOT_S PLIT_MERG ES_ INTERFACE WSM_START ING_LOTS_ INTERFACE WSM_RESUL TING_LOTS_ INTERFACE WIP

Inbound

View

Yes

Yes

WSM Inbound

WSM Table

WSM Yes

WSM Yes

Lot Move Transactions

Inbound

Table

Yes

Yes

WIP Lot Transactions

Inbound

Table

Yes

Yes

Inventory Lot Transactions

Inbound

Table

Yes

Yes

WIP

WIP

WIP

WIP

WIP


Move Transaction

Inbound

Table

Yes

Yes

WIP_MOVE_ TXN_INTER FACE CST_COMP_ SNAP_INTE RFACE (if organization uses average costing) WIP_COST_T XN_INTERF ACE WIP_JOB_SC HEDULE_IN TERFACE WIP_JOB_DT LS_INTERFA CE WMS PRINT_LABE L_MANUAL _WRAP PRINT_LABE L PRINT_LABE L_WRAP WMS_DEVIC E_INTEGRA TION_ PVT.DEVICE _REQUEST WMS_DEVIC E_INTEGRA TION_ PUB.SYNC_ DEVICE_RE QUEST

Resource Transaction

Inbound

Table

Yes

Yes

Work Order Interface

Inbound

Table

Yes

Yes

WMS Compliance Label

WMS Inbound

WMS Procedure

WMS Yes

WMS Yes

Device Integration

Inbound

Procedure

Yes

Yes


Locator Maintenance

Inbound

Procedure

Yes

Yes

CREATE_LO CATOR UPDATE_LO CATOR CREATE_LO C_ITEM_TIE DELETE_LO CATOR


Container

Inbound

Procedure

Yes

Yes

GENERATE_ LPN_CP GENERATE_ LPN ASSOCIATE_ LPN CREATE_LP N MODIFY_LP N MODIFY_LP N_WRAPPE R PACKUNPA CK_CONTAI NER PACK_PREP ACK_CONT AINER VALIDATE_ UPDATE_W T_VOLUME PURGE_LPN EXPLODE_L PN TRANSFER_ LPN_CONTE NTS CONTAINER _REQUIRED _QTY GET_OUTER MOST_LPN GET_LPN_LI ST PREPACK_L PN_CP PREPACK_L PN PRINT_CON TENT_REPO RT LPN_PACK_ COMPLETE CHECK_INS TALL

WMS Installation

Inbound

Procedure

Yes

Yes


Inbound Open Interface ModelOracle Supply Chain Management products provide both inbound and outbound interfaces. For inbound interfaces, where these products are the destination, Oracle provides interface tables, as well as supporting validation, processing, and maintenance programs. For outbound interfaces, where these products are the source, Oracle provides database views. The destination application should provide the validation, processing, and maintenance programs. Discussion of Inbound Interfaces Only This overview and the rest of the documents in this chapter discuss only inbound interfaces in detail. You can find information about the tables, views, and processes involved in outbound interfaces in the product's technical reference manual. Note that the technical reference manuals do not contain detailed, narrative discussions about the outbound interfaces. Open Interface Diagram The general model for open application interfaces is as follows:


Open Interface Diagram

Open API Diagram The model used by APIs such as the Service Request interfaces (Oracle Service) is as follows:


Open API Diagram

Components of an Open InterfaceThere are a number of components that are generally common to all open interfaces. This section discusses these components. However, all open interfaces do not include every component, and in some cases, you can implement the component slightly differently than described here. Source Application You obtain data from a source application to pass on to a destination application for further processing and storage. Typically, the data completes processing in the source application before it is passed. Oracle Supply Chain Management products are the source for outbound interfaces. For example, Oracle Inventory is the source for the On-Hand Balances Interface. This interface is used to export on-hand balances from Oracle Inventory for use by other planning and distribution destination applications. Destination ApplicationYou send data to a destination application so that the application can perform further processing and storage.


Oracle Supply Chain Management products are the destinations for inbound interfaces. For example, Oracle Purchasing is the destination for receiving transactions imported using the Receiving Open Interface. Oracle Purchasing updates purchase orders for each receiving transaction and creates and stores the receiving transaction history. Interface Table For inbound interfaces, 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 Supply Chain Management product. The various types of interface columns, with examples from the Oracle Work in Process Move Transaction Interface, are listed here: Identifier Columns Identifier columns uniquely identify rows in the interface table and provide foreign key reference to both the source and destination applications. For example, typical identifier columns for a move transaction would identify: The source application, such as the bar code device identifier The row's unique identifier in the source application, such as the job name The destination application's unique identifier, such as the Work in Process entity ID.

Control Columns Control columns track the status of each row in the interface table as it is inserted, validated, errored, processed, and ultimately deleted. Additional control columns identify who last updated the row and the last update date. Data Columns Data columns store the specific attributes that the source application is sending to the Oracle Supply Chain Management product. For example, transaction quantity is one attribute of a move transaction. Required Columns Required columns store the minimum information needed by the Oracle Supply Chain Management product to successfully process the interface row. For example, an organization code is required for all move transactions. Some columns are conditionally required based on the specifics of the interface. For example, repetitive move transactions require production line information, whereas discrete move transactions do not. Derived ColumnsThe destination product creates the derived columns from information in the required columns. For example, on a move transaction, the primary unit of measure is derived from the assembly that you are moving. Optional Columns Oracle Supply Chain Management products do not necessarily require optional columns but you can use them for additional value-added functionality. For example, for move transactions, the reason code is not required, but you can use the code to collect additional transaction information. Errors Table For inbound interfaces, the errors table stores all errors found by the validation and processing functions. In some cases, the errors table is a child of the interface table. This


enables each row in the interface table to have many errors, so that you can manage multiple errors at once. In other cases, the errors are stored in a column within the interface table. In this case, you must fix each error independently. For example, in the Oracle Work in Process Open Resource Transaction Interface, the validation program inserts an error into an errors table when resource transaction records fail validation because of a missing piece of required data, such as the resource transaction quantity. In contrast, the Order Import process in Oracle Order Management/Shipping inserts errors into a single errors column in the interface table when rows fail validation. Database View Database views are database objects that make data from the Oracle Supply Chain Management source products available for selection and use by destination applications. Oracle Supply Chain Management products provide predefined views of key data that is likely to be used by destination applications. In addition to the predefined views that these products use, Oracle Quality also provides non-predefined, dynamic views. These views join related tables within source products so that the destination application can select the data. For example, Oracle Cost Management provides work in process valuation and transaction distribution database views for use by other cost reporting destination products. Load Function For inbound interfaces, the load function is the set of programs that selects and accumulates data from the source application and inserts it into Oracle Supply Chain Management interface tables. The programming languages and tools used in the load function are highly dependent on the hardware and system software of the source application. For example, if you are passing data between an Oracle-based source application and an Oracle Supply Chain Management product, you would likely use a tool such as Pro*C or PL/SQL because these tools work in both environments. If you are bringing data from a non Oracle-based application into a product's interface table, you would likely use a procedural language available on the source application to select the data and convert it into an ASCII file. Then you could use SQL*Loader to insert that file into the destination product's interface table. For outbound interfaces, the load function is the SQL that creates the database view. For example, 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. Validate Function The validate function is the set of programs that Oracle Supply Chain Management destination products use to ensure the integrity of inbound data. In the source


application, you can typically validate data upon entry using techniques such as forms triggers, not null columns, data types, and so on. However, because Oracle Supply Chain Management products are not the source of this data, validation programs ensure data integrity. In addition, the validate function can derive additional columns based on the required columns and foreign key relationships with other data elsewhere in the Oracle Supply Chain Management destination application. The validation programs check the interface table for rows requiring validation, then validate and update each row indicating either validation complete or errors found. If errors are found, validation programs must write errors to the destination application's errors table or to the interface table's error column. For example, the move transaction validation program performs several validation tasks within the Oracle Work in Process Open Move Transaction Interface. These tasks include: 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


2Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 1This chapter covers the following topics: ODS Load API Features Functional Overview Setting Up the ODS Load API Parameter Descriptions MSC_ST_ASSIGNMENT_SETS MSC_ST_ATP_RULES MSC_ST_BILL_OF_RESOURCES MSC_ST_BIS_BUSINESS_PLANS MSC_ST_BIS_PERIODS MSC_ST_BIS_PFMC_MEASURES MSC_ST_BIS_TARGETS MSC_ST_BIS_TARGET_LEVELS MSC_ST_BOMS MSC_ST_BOM_COMPONENTS MSC_ST_BOR_REQUIREMENTS MSC_ST_CALENDAR_DATES MSC_ST_CALENDAR_SHIFTS MSC_ST_CAL_WEEK_START_DATES MSC_ST_CAL_YEAR_START_DATES MSC_ST_CATEGORY_SETS

Oracle ASCP and Oracle Global ATP Server Open Interfaces - Part 1 2-1

MSC_ST_COMPONENT_SUBSTITUTES MSC_ST_DEMANDS MSC_ST_DEMAND_CLASSES MSC_ST_DEPARTMENT_RESOURCES MSC_ST_DESIGNATORS MSC_ST_INTERORG_SHIP_METHODS

ODS Load API FeaturesThe ODS API consists of the following entities (staging tables): Inventory Items information In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update information for existing items. The following staging tables are used: MSC_ST_SYSTEM_ITEMS MSC_ST_SAFETY_STOCKS

Sourcing Rules In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing sourcing information. The following tables are used: MSC_ST_ASSIGNMENT_SETS MSC_ST_SOURCING_RULES MSC_ST_SR_ASSIGNMENTS MSC_ST_SR_RECEIPT_ORG MSC_ST_SR_SOURCE_ORG In complete refresh mode, you can renew all entries using the table, MSC_ST_INTERORG_SHIP_METHODS In both complete and refresh mode, you can update the sourcing history information using the table, MSC_ST_SOURCING_HISTORY

ATP Rules In complete refresh mode, you can renew all entries using the table,


MSC_ST_ATP_RULES Bill of Resources In complete refresh mode, you can renew all entries. The following tables are used: MSC_ST_BILL_OF_RESOURCES MSC_ST_BOR_REQUIREMENTS

BOMs/Routings In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing BOM/Routing data. The following tables are used: 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

Calendar system In complete refresh mode, you can renew all entries. The following tables are used: 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

Categories In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing categories information. The following tables are used: MSC_ST_CATEGORY_SETS MSC_ST_ITEM_CATEGORIES

MDS/MPS designators In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing designators information. These operations use the table, MSC_ST_DESIGNATORS

Demands and Sales Orders In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing demands and sales orders information. The following tables are used: MSC_ST_DEMANDS MSC_ST_RESERVATIONS MSC_ST_SALES_ORDERS

Supplies In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing supplies information. These operations use the table, MSC_ST_SUPPLIES

Resources In complete refresh mode, you can renew all entries. The following tables are used: MSC_ST_RESOURCE_GROUPS


MSC_ST_DEPARTMENT_RESOURCES In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing resources information. The following tables are used:

MSC_ST_NET_RESOURCE_AVAIL MSC_ST_RESOURCE_REQUIREMENTS MSC_ST_RESOURCE_CHANGES

Approved Suppliers Information In complete refresh mode, you can renew all entries. The following tables are used: MSC_ST_ITEM_SUPPLIERS MSC_ST_SUPPLIER_FLEX_FENCES In complete refresh mode, you can renew all entries. In incremental refresh mode, you can create new entries, and update existing supplier capacities information. These operations use the table, MSC_ST_SUPPLIER_CAPACITIES

Trading Partners Information In complete refresh mode, you can renew all entries. The following tables are used: MSC_ST_TRADING_PARTNERS MSC_ST_TRADING_PARTNER_SITES MSC_ST_LOCATION_ASSOCIATIONS MSC_ST_PARAMETERS MSC_ST_SUB_INVENTORIES MSC_ST_PARTNER_CONTACTS

Planner Information In complete refresh mode, you can renew all entries using the table, MSC_ST_PLANNERS

Units Of Measure In complete refresh mode, you can renew all entries. The following tables are used:


MSC_ST_UNITS_OF_MEASURE MSC_ST_UOM_CONVERSIONS MSC_ST_UOM_CLASS_CONVERSIONS

Unit Number, Projects, and Tasks Information In complete refresh mode, you can renew all entries. The following tables are used: MSC_ST_UNIT_NUMBERS MSC_ST_PROJECTS MSC_ST_PROJECT_TASKS

BIS Objects In complete refresh mode, you can renew all entries. MSC_ST_BIS_BUSINESS_PLANS MSC_ST_BIS_PERIODS MSC_ST_BIS_PFMC_MEASURES MSC_ST_BIS_TARGET_LEVELS MSC_ST_BIS_TARGETS

Demand Classes In complete refresh mode, you can renew all entries using the table, MSC_ST_DEMAND_CLASSES

See AlsoThe Oracle ASCP and Oracle Global ATP Server Technical Reference Manual.

Functional OverviewThe ODS Load API provides a public procedure, Launch_Monitor, for loading the data into the ODS tables. The Launch_Monitor procedure performs the following major processes: Generate new local ID for the global attributes such as item, category set, vendor, vendor site, customer, and customer site.


Launch the ODS Load Workers to perform Create, Update, and Delete Operation for each entity in ODS. Recalculate the sourcing history based on the latest sourcing information and the data from the transaction systems. Recalculate the net resource availability based on the calendars, shifts, and department resources information. Purge the data in the staging tables.

Setting Up the ODS Load APIThe ODS Load API is a stored PL/SQL function. You need to define certain data before you create or update ODS data. Before using the API, set up and/or activate the following parameters: Instance Code Number of Workers Recalculate Net Resource Availability (Yes/No) Recalculate Sourcing History (Yes/No)

Parameter DescriptionsThe following charts describe all staging tables used by the ODS Load API. All of the inbound and outbound parameters are listed for these table. Additional information on these parameters follows each chart.

MSC_ST_ASSIGNMENT_SETSThe staging table used by the collection program to valid and process data for table MSC_ASSIGNMENT_SETS.


Parameter SR_ASSIGN MENT_SET_I D ASSIGNMEN T_SET_NAM E DESCRIPTIO N DELETED_F LAG LAST_UPDA TE_DATE LAST_UPDA TED_BY CREATION_ DATE CREATED_B Y LAST_UPDA TE_LOGIN REQUEST_ID PROGRAM_ APPLICATIO N_ID PROGRAM_I D PROGRAM_ UPDATE_DA TE

Usage IN

Type NUMBER

Required x

Derived

Optional

IN

VARCHAR2( 34)

x

IN

VARCHAR2( 80) NUMBER

x

IN

x

IN

DATE

x

IN

NUMBER

x

IN

DATE

x

IN

NUMBER

x

IN

NUMBER

x

IN IN

NUMBER NUMBER

x x

IN

NUMBER

x

IN

DATE

x


Parameter SR_ASSIGN MENT_SET_I D SR_INSTAN CE_ID REFRESH_ID

Usage IN

Type NUMBER

Required x

Derived

Optional

IN

NUMBER

x

IN

NUMBER

x

SR_ASSIGNMENT_SET_IDAssignment set identifier from source application instance ASSIGNMENT_SET_NAME Assignment set name 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 REFRESH_ID Refresh identifier

MSC_ST_ATP_RULESThe staging table used by the collection program to validate and process data for table MSC_ATP_RULES.Parameter RULE_ID SR_INSTAN CE_ID RULE_NAM E DESCRIPTIO N ACCUMULA TE_AVAILA BLE_FLAG Usage IN IN Type NUMBER NUMBER Required x x Derived Optional

IN

VARCHAR2( 80) VARCHAR2( 240) NUMBER

x

IN

x

IN

x


Parameter BACKWARD _CONSUMP TION_FLAG FORWARD_ CONSUMPTI ON_FLAG PAST_DUE_ DEMAND_C UTOFF_FEN CE PAST_DUE_S UPPLY_CUT OFF_FENCE INFINITE_S UPPLY_FEN CE_CODE INFINITE_S UPPLY_TIM E_FENCE ACCEPTABL E_EARLY_FE NCE ACCEPTABL E_LATE_FEN CE DEFAULT_A TP_SOURCE S INCLUDE_S ALES_ORDE