Oracle® Process ManufacturingQuality Management API User’s Guide Release 11i Part No. B10350-02 January 2005 Oracle Process Manufacturing Quality Management API User’s Guide, Release 11i Part No. B10350-02 Copyright © 2003, 2005, Oracle Corporation. All rights reserved. Primary Author: Michele-Andrea Fields Major Contributors: Sanjay Rastogi, Karen Hunt, Harminder Verdding, Nancy Cheung, Brenda Stone The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; 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. Oracle Corporation does not warrant that this document is 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, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR 52.227-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. Oracle is a registered trademark of Oracle Corporation and/or its affiliates. Other names may be trademarks of the irrespective owners. Contents Send Us Your Comments .................................................................................................................... v Preface........................................................................................................................................................... vii Audience for This Guide ..................................................................................................................... vii How To Use This Guide ...................................................................................................................... vii Other Information Sources ................................................................................................................. viii Online Documentation................................................................................................................... viii Related User’s Guides.................................................................................................................... viii Guides Related to All Products ..................................................................................................... ix User Guides Related to This Product ........................................................................................... ix Installation and System Administration .................................................................................... xiv Other Implementation Documentation....................................................................................... xv Training and Support................................................................................................................... xvii Do Not Use Database Tools to Modify Oracle Applications Data ............................................ xvii About Oracle ........................................................................................................................................ xviii Your Feedback ..................................................................................................................................... xviii 1 Quality Management API Introduction Introducing the Quality Management API .................................................................................... Quality Management API Features ........................................................................................... Quality Management API Support Policy ................................................................................ Oracle Applications Packages Supplied ........................................................................................ Quality Management API Bill of Materials .................................................................................. Understanding the General Input Structure ................................................................................. 1-2 1-2 1-3 1-4 1-4 1-6 iii API Hints .............................................................................................................................................. 1-7 2 Quality Management Inbound API Business Objects OPM Quality Specifications APIs ................................................................................................... OPM Quality Specification Validity Rules APIs .......................................................................... OPM Quality Test APIs ................................................................................................................... OPM Quality Samples APIs ........................................................................................................... OPM Quality Results APIs ............................................................................................................. 2-2 2-6 2-15 2-20 2-25 3 Quality Management Outbound API Business Objects Fetch Test Methods ............................................................................................................................. Fetch Tests............................................................................................................................................. Fetch Specification Validity Rules................................................................................................... Fetch Sample Groups ....................................................................................................................... Fetch Samples .................................................................................................................................... Fetch Results ...................................................................................................................................... Fetch Composite Results ................................................................................................................. 3-2 3-5 3-9 3-22 3-29 3-37 3-41 A Messages and Errors Handling Messages ............................................................................................................................ A-2 Interpreting Error Conditions .......................................................................................................... A-3 Understanding Error Messages ........................................................................................................ A-3 iv Send Us Your Comments Oracle Process Manufacturing Quality Management API User’s Guide, Release 11i Part No. B10350-02 Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this publication. Your input is an important part of the information used for revision. ■ ■ ■ ■ ■ Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most about this manual? If you find any errors or have any other suggestions for improvement, please indicate the chapter, section, and page number (if available). You can send comments to us in the following ways: ■ ■ FAX: 650-506-7200 Attn: Oracle Process Manufacturing Postal service: Oracle Corporation Oracle Process Manufacturing 500 Oracle Parkway Redwood City, CA 94065 U.S.A. ■ Electronic mail message to
[email protected] If you would like a reply, please give your name, address, and telephone number below. If you have problems with the software, please contact your local Oracle Support Services. v vi and validating the user name. Oracle Process Manufacturing (OPM) If you have never used Oracle Process Manufacturing Quality Management APIs. Quality Management API bill of material. ■ ■ vii . the entity relationship diagram. Oracle suggests you attend one or more of the Oracle Process Manufacturing training classes available through Oracle University. Chapter 2 provides the relationships between the Quality Management API table structure and its entities. Discusses Quality Management API business objects. ■ Chapter 1 describes the Application Program Interfaces (APIs) that support external interfaces to the OPM Quality Management tables including: packages supplied. Discusses Quality Management API outbound business objects. creating a new formula and importing formula data structures. To learn more about the Oracle Applications graphical user interface. How To Use This Guide This guide contains the information you need to understand and use Oracle Process Manufacturing Quality Management APIs. creating a new formula and importing formula data structures. Chapter 3 provides the relationships between the Quality Management API outbound table structure and its entities. stored procedures. See Other Information Sources for more information about Oracle Applications product information. the entity relationship diagram. wrapper function. This guide assumes you have a working knowledge of the following: ■ The principles and customary practices of your business area. business object interface design. ■ ■ The Oracle Applications graphical user interface. business object interface design. read the Oracle Applications User’s Guide.Preface Audience for This Guide Welcome to Release 11i of the Oracle Process Manufacturing Quality Management API User’s Guide. Other Information Sources You can choose from many sources of information. If this guide refers you to other Oracle Applications documentation. a Windows screen reader. with good usability. however. training. To that end.The new features section in the HTML help describes new features in 11i. ■ Online Help .com/accessibility/ Accessibility of Code Examples in Documentation JAWS. JAWS may not always read a line of text that consists solely of a bracket or brace. this document describes the new features. Standards will continue to evolve over time. services. This documentation is available in HTML format. to increase your knowledge and understanding of Oracle Process Manufacturing Quality Management APIs. viii . to the disabled community. 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. use only the Release 11i versions of those guides. if your administrator has installed software from a mini-packs an upgrade. may not always correctly read the code examples in this document. the interpretation of error conditions. Online Documentation All Oracle Applications documentation is available online (HTML or PDF). our documentation includes features that make information available to users of assistive technology. and support services. The new features section also includes information about any features that were not yet available when this guide was printed. Online help patches are available on MetaLink. For additional information. and an understanding of error messages. For example. Documentation Accessibility Our goal is to make Oracle products. and supporting documentation accessible.■ Appendix A provides message handling. The conventions for writing code require that closing braces should appear on an otherwise empty line. including online documentation. visit the Oracle Accessibility Program Web site at http://www. and contains markup to facilitate access by the disabled community.oracle. This information is updated for each new release of Oracle Process Manufacturing. Guides Related to All Products Oracle Applications User’s Guide This guide explains how to enter data. User Guides Related to This Product Accounting Setup User’s Guide The OPM Accounting Setup application is where users set up global accounting attributes about the way financial data will be collected by OPM. you can purchase them from the Oracle Store at http://oraclestore. These attributes include such things as account keys. you may want to refer to other user’s guides when you set up and use Oracle Process Manufacturing. Readme File .This document lists new features available by patch and identifies any associated new documentation.com.■ 11i Features Matrix . You can access this user’s guide online by choosing”Getting Started with Oracle Applications” from any Oracle Applications help file. as well as running and reviewing reports and concurrent processes. If you require printed guides. much of the ix . You can read the guides online by choosing Library from the expandable menu on your HTML help window. and account segments. ■ Related User’s Guides Oracle Process Manufacturing Quality Management APIs shares business and setup information with other Oracle Applications products. The new features matrix document is available on MetaLink. query. run reports. This guide also includes information on setting user profiles. financial calendars. Since OPM is closely integrated with Oracle General Ledger (GL).oracle. and navigate using the graphical user interface (GUI) available with this release of Oracle Process Manufacturing Quality Management APIs (and any other Oracle Applications products).Refer to the readme file for patches that you have installed to learn about new documentation or documentation patches that you can download. or by using a Web browser with a URL that your system administrator provides. by reading from the Oracle Applications Document Library CD included in your media pack. Therefore. The OPM Oracle Financials Integration application is where users define how that data is transferred. event RCPT (Inventory Receipts) results in a debit to inventory. Inventory Management User’s Guide The OPM Inventory Management application is where data about the items purchased for. and therefore. a credit to accrued accounts payable. a debit or a credit to purchase price variance. The Oracle Process Manufacturing Inventory Management User’s Guide includes information to help you effectively work with the Oracle Process Manufacturing Inventory application. The Oracle Process Manufacturing Oracle Financials Integration User’s Guide describes how to setup and use this application. and created as a result of the manufacturing process are tracked. financial data that is collected about the manufacturing processes must be transferred to the Oracle Financials applications. For example. users define whether data is transferred real time or batched and transferred at intervals. The Oracle Process Manufacturing Manufacturing Accounting Controller User’s Guide describes how to setup and use this application. the windows are display only within OPM. consumed during.attributes are defined in the Oracle GL instead of OPM. For example. etc. These impacts are predefined in the Manufacturing Accounting Controller application so users may begin using OPM to collect financial data out-of-the-box. The Oracle Process Manufacturing Cost Management User’s Guide describes how to setup and use this application. Cost Management User’s Guide The OPM Cost Management application is used by cost accountants to capture and review the manufacturing costs incurred in their process manufacturing businesses. they may also be adjusted per your business needs. The Oracle Process Manufacturing Accounting Setup User’s Guide describes how to setup and use this application. however. Manufacturing Accounting Controller User’s Guide The Manufacturing Accounting Controller application is where users define the impact of manufacturing events on financials. Oracle Financials Integration User’s Guide Since OPM is closely integrated with Oracle General Ledger. x . Order Management accepts orders entered through Oracle Customer Relationship Management (CRM). Then. manufactured. while sales orders are taken and tracked in Oracle Order Management. The Oracle Process Manufacturing Purchase Management User’s Guide describes how to setup and use this integrated solution. Order Fulfillment enables order entry personnel to inform customers of scheduled delivery dates and pricing. The Oracle Order Management User’s Guide and Using Oracle Order Management with Process Inventory Guide describes how to setup and use this integrated solution. such as dual UOM and lot control. Purchase orders are entered in Oracle Purchasing and received in OPM. through Order Management. allocate xi . and update your onhand quantities accordingly. Process Execution lets you convert firm planned orders to single or multiple production batches. the receipts entered in OPM are sent to Oracle Purchasing. Order Fulfillment User’s Guide The OPM Order Fulfillment application automates sales order entry to reduce order cycle time. Seamlessly integrated to the Product Development application. The Oracle Process Manufacturing Physical Inventory User’s Guide describes how to setup and use this application. The Oracle Process Manufacturing Order Fulfillment User’s Guide describes how to setup and use this application. The manufacturing process is tracked and handled within Oracle Process Manufacturing. Within CRM. are enabled depending on the inventory organization for the item on the sales order. and iStore. and sold. The OPM Physical Inventory application automates and enables the physical inventory process. Sales Online. Process Execution User’s Guide The OPM Process Execution application lets you track firm planned orders and production batches from incoming materials through finished goods. Purchase Management User’s Guide OPM Purchase Management and Oracle Purchasing combine to provide an integrated solution for Process Manufacturing.Physical Inventory User’s Guide Performing physical inventory count is the most accurate way to get an accounting of all material quantities purchased. making the CRM suite of products available to Process customers. and are booked in Order Management. Process attributes. Using Oracle Order Management with Process Inventory Guide Oracle Process Manufacturing and Oracle Order Management combine to provide an integrated solution for process manufacturers. orders can originate from TeleSales. The Master Production Scheduling (MPS) application lets you shorten that view to a much narrower and immediate time horizon. record actual ingredient usage. The Oracle Process Manufacturing MPS/MRP and Forecasting User’s Guide describes how to setup and use this application. used by the OPM Production Execution and New Product Development applications. and see the immediate effects of demand and supply actions. The integration provides for constraint-based planning. Resource setup. you set up manufacturing. you can optimize the xii . and functionality of the OPM Process Execution application. and then complete and close production batches. The Oracle Process Manufacturing Integration with Advanced Planning and Scheduling User’s Guide describes how to setup and use this application. Using Oracle Process Manufacturing with Oracle Manufacturing Scheduling Oracle Process Manufacturing integrates with Oracle Manufacturing Scheduling to manage and utilize resources and materials. Integration with Advanced Planning and Scheduling User’s Guide Oracle Process Manufacturing and Oracle Advanced Planning and Scheduling (APS) combine to provide an integrated solution for process manufacturers that can help increase planning efficiency. MPS/MRP and Forecasting User’s Guide The Oracle Process Manufacturing Material Requirements Planning (MRP) application provides long-term "views" of material demands and projected supply actions to satisfy those demands. and details the windows. and combine all of these methods within the same plant/company. procurement and sales order data. is also described. performance management. mixed mode manufacturing that enables you to choose the best method to produce each of your products. materials management by exception. Capacity Planning User’s Guide The OPM Capacity Planning User's Guide describes the setup required to use OPM with the Oracle Applications Advanced Supply Chain Planning solutions. Through the Manufacturing Scheduling application. Through the Process Manufacturing application. Production inquiries and preformatted reports help you optimize inventory costs while maintaining a high level of customer satisfaction with on-time delivery of high quality products. It provides prerequisite setup in other applications. In addition.ingredients. inventory. The OPM Process Execution User’s Guide presents overviews of the tasks and responsibilities for the Production Supervisor and the Production Operator. features. testing. and being able to quickly react to unplanned constraints. Product Development coordinates each development function and enables a rapid. You can compare specifications to assist in regrading items. You can optimize formulations before beginning expensive laboratory test batches. By optimally scheduling shop floor jobs. You can characterize and simulate the technical properties of ingredients and their effects on formulas. Aggregate test results and print statistical assessments on quality certificates. The Oracle Process Manufacturing Quality Management User’s Guide describes how to set up and use this application. you can lower manufacturing costs. Using different optimization objectives. The application lets you enter specifications and control their use throughout the enterprise. enterprise-wide implementation of new products in your plants. and result processing. Using Oracle Manufacturing Scheduling helps you improve productivity and efficiency on your shop floor. Product Development User’s Guide The Oracle Process Manufacturing Product Development application provides features to manage formula and laboratory work within the process manufacturing operation. Several preformatted reports and inquiries help manage quality testing and reporting. you can tailor Manufacturing Scheduling to meet your needs. and increase customer satisfaction through improved on-time delivery. and match customer specifications. It lets you manage multiple laboratory organizations and support varying product lines throughout the organization. Regulatory Management User’s Guide The Oracle Process Manufacturing Regulatory Management application generates the Material Safety Data Sheets (MSDSs) required by authorities to accompany hazardous materials during shipping. The Using Oracle Process Manufacturing with Oracle Manufacturing Scheduling User’s Guide describes how to setup and use this integrated solution. production. The Oracle Process Manufacturing Product Development User’s Guide describes how to setup and use this application. increase resource utilization and efficiency. Customized workflows and electronic record keeping automate plans for sampling. Quality Management User’s Guide The Oracle Process Manufacturing Quality Management application provides features to test material sampled from inventory. You can create MSDSs from OPM Formula xiii .schedule based on resource and component constraints and user predefined priorities. or receipts from external suppliers. technology stack. APIs make it possible to pass information into and out of the application. System Administration User’s Guide Much of the System Administration duties are performed at the Oracle Applications level. Implementation Guide The Oracle Process Manufacturing Implementation Guide offers information on setup. Installation and System Administration Oracle Applications Concepts This guide provides an introduction to the concepts. and organizations.Management with Regulatory or Production effectivities. features. The Oracle Process Manufacturing Regulatory Management User’s Guide describes how to setup and use this application. That is. This guide xiv . Any tasks that must be completed in order to use the system out-of-the-box are included in this manual. bypassing the user interface. and the Oracle Process Manufacturing Cost Management API User's Guide. those tasks you must complete following the initial installation of the Oracle Process Manufacturing software. It provides a useful first book to read before an installation of Oracle Applications. API User’s Guides Public Application Programming Interfaces (APIs) are available for use with different areas of the Oracle Process Manufacturing application. Oracle Process Manufacturing Process Execution API User’s Guide. Oracle Process Manufacturing Quality Management API User's Guide. The Oracle Process Manufacturing System Administration User’s Guide provides information on the few tasks that are specific to OPM. It offers information on performing OPM file purge and archive. Oracle Process Manufacturing Product Development Formula API User's Guide. architecture. units of measure. Additional API User’s Guides are periodically added as additional public APIs are made available. and are therefore described in the Oracle Applications System Administrator's Guide. and maintaining such things as responsibilities. and terminology for Oracle Applications Release 11i. Oracle Process Manufacturing Product Development Recipe API User's Guide. Use of these APIs is documented in individual manuals such as the Oracle Process Manufacturing Inventory API User’s Guide. to upgrade to Release 11i. and other information that you need to run the AD utilities. Oracle Applications System Administrator’s Guide This guide provides planning and reference information for the Oracle Applications System Administrator. You should use this guide in conjunction with individual product user’s guides and implementation guides. In Release 11i. the Oracle8 technology stack. xv . languages and character sets. Installing Oracle Applications This guide provides instructions for managing the installation of Oracle Applications products. SmartClient.7 (NCA. Oracle Alert User’s Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. AD Controller. This guide also provides information on maintaining the Oracle applications file system and database. and others. AD Administration. and manage concurrent processing. AutoPatch.0.also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS).0 products to Release 11i. AD Relink. such as AutoUpgrade. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your installation. and Self-Service Web Applications. or character mode) or Release 11. and the Oracle8i Server technology stack by automating many of the required steps. It contains information on how to define security. Upgrading Oracle Applications Refer to this guide if you are upgrading your Oracle Applications Release 10. License Manager. This guide describes the upgrade process and lists database and product-specific upgrade tasks. customize menus and online help. much of the installation process is handled using Oracle Rapid Install. It contains how-to steps.7.7 or Release 11. which minimizes the time to install Oracle Applications. screenshots. You cannot upgrade to Release 11i directly from releases prior to 10. Maintaining Oracle Applications Use this guide to help you run the various AD utilities. You must be either at Release 10. 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. profile options. It includes new features. Oracle Applications User Interface Standards for Forms-Based Products This guide contains the user interface (UI) standards followed by the Oracle Applications development staff. and seed data for this interval. 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. use this manual before implementing Oracle Process Manufacturing Quality Management APIs.0 and Release 11i. xvi . Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency. Multiple Organizations in Oracle Applications This guide describes how to set up and use Oracle Process Manufacturing Quality Management APIs with Oracle Applications' Multiple Organization support feature. It provides a history of the changes to individual Oracle Applications products between Release 11. Other Implementation Documentation Oracle Applications Product Update Notes Use this guide as a reference for upgrading an installation of Oracle Applications.Oracle Applications Developer’s Guide This guide contains the coding standards followed by the Oracle Applications development staff. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications. enhancements. so you can define and support different organization structures when running a single installation of Oracle Process Manufacturing. This manual details additional steps and setup considerations for implementing Oracle Process Manufacturing Quality Management APIs with this feature. and changes made to database objects. and programs for a specific Oracle Applications product.Oracle Workflow Guide This guide explains how to define new workflow business processes as well as customize existing Oracle Applications-embedded workflow processes. This documentation includes API’s and open interfaces found in Oracle Order Management Suite. Oracle Applications Flexfields Guide This guide provides flexfields planning. xvii . Oracle Applications Message Reference Manual This manual describes all Oracle Applications messages. and write custom reports for Oracle Applications products. setup and reference information for the Oracle Process Manufacturing Quality Management APIs implementation team. forms. This documentation includes API’s and open interfaces found in Oracle Manufacturing. This manual is available in HTML format on the documentation CD-ROM for Release 11i. 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. This information helps you convert data from your existing applications. Oracle eTechnical Reference Manuals Each eTechnical Reference Manual (eTRM) contains database diagrams and a detailed description of database tables. This manual also provides information on creating custom reports on flexfields data. 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. reports.You also use this guide to complete the setup steps necessary for any Oracle Applications product that includes workflow-enabled processes. as well as for users responsible for the ongoing maintenance of Oracle Applications product data. integrate Oracle Applications data with non-Oracle applications. Training and Support Training Oracle offers a complete set of training courses to help you and your staff master Oracle Process Manufacturing Quality Management APIs and reach full productivity quickly. In addition. managing an Oracle8i server. retrieve. Oracle Data Browser. you risk destroying the integrity of your data and you lose the ability to audit changes to your data. Account Manager. or you can use Oracle Learning Network (OLN). 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. Oracle University's online education utility. our team of experienced professionals provides the help and information you need to keep Oracle Process Manufacturing Quality Management APIs working for you. But if you use Oracle tools such as SQL*Plus to modify Oracle Applications data. change. and data as examples in a customized training session delivered at your own facility. so you take only those courses appropriate to your job or area of responsibility. You have a choice of educational environments. and Oracle’s large staff of consultants and support specialists with expertise in your business area. Support From on-site support to central support. If your xviii . Do Not Use Database Tools to Modify Oracle Applications Data Oracle STRONGLY RECOMMENDS that you never use SQL*Plus. This team includes your Technical Representative. But when you modify Oracle Applications data using anything other than Oracle Applications. For example. store. These courses are organized into functional learning paths. or any other tool to modify Oracle Applications data unless otherwise instructed. and maintain information in an Oracle database. Oracle provides powerful tools you can use to create. you may want to use your organization structure. database triggers. Because Oracle Applications tables are interrelated. Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. You can attend courses offered by Oracle University at any one of our many Education Centers. and your hardware and software environment. terminology. you can arrange for our trainers to teach at your facility. When you use Oracle Applications to modify your data. tools. About Oracle Oracle Corporation develops and markets an integrated line of software products for database management. Oracle offers its database. education. different networks. Oracle Applications automatically checks that your changes are valid. as well as Oracle Applications. Oracle products are available for mainframes. Oracle Applications Documentation Manager Oracle Corporation 500 Oracle Parkway xix . 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. Mail your comments to the following address or call us directly at (650) 506-7000. and the world’s second largest software company. minicomputers. personal computers. Your Feedback Thank you for using Oracle Process Manufacturing Quality Management APIs and this user’s guide. you may store invalid information. along with related consulting. and applications products. and even different database management systems. Oracle values your comments and feedback. If you enter information into database tables using database tools. manufacturing. in over 145 countries around the world. Oracle Applications also keeps track of who changes information. unified computing and information resource. project systems. At the end of this guide is a Reader’s Comment Form you can use to explain what you like or dislike about Oracle Process Manufacturing Quality Management APIs or this user’s guide. applications development.tables get out of synchronization with each other. decision support. network computers and personal digital assistants. human resources and customer relationship management. and support services. different operating systems. an integrated suite of more than 160 software modules for financial management. into a single. and office automation. allowing organizations to integrate different computers. you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Applications. Oracle is the world’s leading supplier of software for information management. supply chain management. send electronic mail to
[email protected] Shores. CA 94065 U.S. Or.com. xx . 1 Quality Management API Introduction This document describes the Application Program Interfaces that support external interfaces to the Oracle Process Manufacturing Quality Management tables. The topics discussed in this topic are: ■ Introducing the Quality Management API Oracle Applications Packages Supplied Quality Management API Bill of Materials Wrapper Function and Stored Procedures ■ ■ ■ Quality Management API Introduction 1-1 . You can also write to log files before calling and after returning from a function. you can include all pertinent information using a friendly tool that does not have cryptic IDs and system specific information. The interface ensures that your imported information contains the same detail as those you enter manually on the OPM Quality Management window. and components for the Insert. To make use of these APIs. then the APIs return one of the following status codes: ■ S for success E for error U for unknown or unexpected status ■ ■ Quality Management API Features These APIs offer the following features: ■ Creating Updating and Deleting Information Proper Encapsulation Synchronous Processing Following the Business Hierarchy Detailed and Translatable Error Messages ■ ■ ■ 1-2 Oracle Process Manufacturing Quality Management API User’s Guide .Introducing the Quality Management API Introducing the Quality Management API Quality Management APIs let you import quality information from an existing quality management system into the Oracle Process Manufacturing Quality Management tables. The interfaces can make use of the standard functionality and logic implemented in the Quality Management application. Update. major features. architecture. code the wrapper function that passes the appropriate parameters to the APIs. If there is a problem during execution of a call. What Is In This Document This document describes the basic business needs. Quality Management APIs can process virtually all information. Quality Management APIs are written in PL/SQL that can be called by your own programs. When you import this information. and disconnecting from the database upon return. and Delete features for the Quality Management APIs. Your program is also responsible for connecting to a database before calling an API function. The application is divided into application-specific objects that let you link OPM functionality into your own programs. Oracle ensures that the APIs function as designed. This means: ■ Oracle provides objects and libraries needed to use to the APIs and the documentation for their use. ■ ■ Quality Management API Introduction 1-3 .Introducing the Quality Management API Quality Management API Support Policy Quality Management APIs are supported by Oracle. Oracle does not support customer generated programs that use the APIs. FND_PUB_MSG . used to interrogate the procedure messages. Public level specification validity rules package supplying APIs to create or delete specifications and associated specification validity rules. GMDGSVRB.the standard Oracle Applications messaging function. Group level specifications package containing validation procedures and functions for verifying specification and spec test data.pls. GMDPSPCB.pls. The business API can be used for creating. This is used by the stored procedure to report status and error handling. Refer to the Oracle Applications Coding Standards manual for additional details.pls.pls 1-4 Oracle Process Manufacturing Quality Management API User’s Guide . These must be on your system for your interface to compile and link properly.the standard Oracle Applications message retrieval function. This is used by the stored procedure to check valid API version number and also contains constant variables such as TRUE and FALSE. GMDPSVRB.pls Description Public level package that the user defined function calls. FND_MESSAGE . Quality Management API Bill of Materials The following are the packages and files that are delivered with the OPM Quality Management APIs. or deleting a specifications. GMD_SPEC_GRP GMDGSPCS.pls.pls GMD_SPEC_VRS_PUB GMDPSVRS.pls.pls GMD_SAMPLES_PUB GMDPSMPS. Public level samples package supplying APIs to create or delete samples and associated entities. Package Name GMD_SPEC_PUB File Names GMDPSPCS. Group level specification validity rules package containing validation procedures and functions for verifying specification validity rules data. GMDGSPCB. ■ ■ These packages are installed as part of the current release.pls GMD_SPEC_VRS_GRP GMDGSVRS.Oracle Applications Packages Supplied Oracle Applications Packages Supplied Quality Management APIs make use of the following standard Oracle Applications packages: ■ FND_API .the standard Oracle Applications API version checking function. modifying. GMDPSMPB. pls GMDGRESS. Public level results package supplying APIs to record results and add tests to a sample.pls. GMDPTSTB. Public level QM package containing APIs to export inoformation to third party products. Group level results package containing validation procedures and functions for verifying results. Public level QC Tests package containing validation procedures and functions for verifying test and results data.pls GMDPRESS.pls Description Group level samples package containing validation procedures and functions for verifying samples. GMDGSMPB. GMDGTSTB.pls Quality Management API Introduction 1-5 .pls. GMD_RESULTS_GRP GMD_RESULTS_PUB GMD_QC_TESTS_PUB GMD_QC_TESTS_GRP GMDGTSTS. GMDGRESB. GMDPRESB.pls GMD_OUTBOUND_APIS_PUB GMDOAPIS. GMDOAPIB.Quality Management API Bill of Materials Package Name GMD_SAMPLES_GRP File Names GMDGSMPS. Group level QC Tests package containing validation procedures and functions for verifying test and results data.pls.pls.pls.pls GMDPTSTS.pls. It is an optional parameter. Examination of both the x_return_status and x_msg_count indicates the pass or fail status of the call.G_FALSE. Returns the messages in an encoded format. Used to specify whether the API must commit its work before returning to the calling function. Specifies whether the API was successful or failed: S = Successful E = failed due to expected error U= failed due to unexpected error Q = Could not calculate the total input and output quantities x_msg_count x_msg_data number varchar2 OUT OUT N N Specifies number of messages added to message list. Standard parameters that are common to all API activities and their details are summarized in the following: Parameter p_api_version Type varchar2 IN/OUT IN Required Y Validation Validates version compatibility.Understanding the General Input Structure Understanding the General Input Structure All stored procedure APIs are called with PL/SQL parameters.G_FALSE which means that the API does not initialize the message list. For future use. The version sent by the calling function is compared to the internal version of the API and an unexpected error (U) is generated if these do not match. and if not supplied. These messages can then be processed by the standard message functions as defined in business object API Coding Standards Document. then it defaults to FND_API. Used to specify whether the message list must be initialized on entry to the API. If not supplied. then it defaults to FND_API. p_init_msg_list varchar2 IN N p_commit varchar2 IN N p_validation_ level x_return_status varchar2 varchar2 IN OUT N N 1-6 Oracle Process Manufacturing Quality Management API User’s Guide . When an API has the same type of parameter defined as IN and OUT. You must set the call up so that p_qc_samples_rec and x_qc_samples_rec have different variables: create_sample(p_qc_samples_rec => l_in_sample x_qc_samples_rec => l_out_sample) In addition. p_qc_samples_rec and x_qc_samples_rec both have the variable l_ sample. NOCOPY hints have been added to the OUT parameters of the APIs. This gives an incorrect result because both the parameters cannot have the same variable. the Create_sample API contains p_qc_samples_rec and x_qc_samples_ rec: Create_Sample(p_qc_samples_rec GMD_SAMPLES%ROWTYPE. x_qc_samples_rec GMD_SAMPLES%ROWTYPE) Therefore. pass in different variables. For example. check the return status of the API (generally returned through x_ return_status parameter) before looking at other OUT variables returned by the API. the call can be set up to read: create_sample(p_qc_samples_rec => l_sample x_qc_samples_rec => l_sample) In this example.API Hints API Hints For performance improvement. Quality Management API Introduction 1-7 . then you must not use any of the OUT parameters passed back from the API. If the return status is not Success. API Hints 1-8 Oracle Process Manufacturing Quality Management API User’s Guide . 2 Quality Management Inbound API Business Objects To use Quality Management API business objects it is important to understand the relationships of the table structure with all its entities. You must also understand the fundamental API business object interface design before you import quality data structures and manage any errors that arise during these operations. The following topics are discussed: ■ OPM Quality Specifications APIs OPM Quality Specification Validity Rules APIs OPM Quality Test APIs OPM Quality Samples APIs OPM Quality Results APIs ■ ■ ■ ■ Quality Management Inbound API Business Objects 2-1 . The specification references an item and. insert one or more specification tests into GMD_SPEC_TESTS. Create Specification This procedure lets you: ■ insert a specification into GMD_SPECIFICATIONS. If the API is able to insert. a grade.OPM Quality Specifications APIs OPM Quality Specifications APIs A specification defines the tests to be carried out on an item for quality control purposes.p_spec (IN) This is a row type parameter that identifies the specification header. ■ All data is validated prior to insert. together these form a unique key. Parameter . If an error is encountered. The following topic demonstrates the mechanics of importing data structures for: ■ Specification Header Specification Detail ■ A single general input structure is described in the following topic. Table Structure of Specification tests. The following table explains the required columns of the row: 2-2 Oracle Process Manufacturing Quality Management API User’s Guide . Table Structure of Specification tests. optionally. Record Structure of Specifications. then an error is returned. Following is the definition of Create Specification: Parameter p_spec p_spec_tests_tbl p_user_name x_spec x_spec_tests_tbl Required Y Y Y Y Y In/Out IN IN IN OUT OUT Description Record Structure of Specifications. It also has an owner and an owning organization. then a status of success is returned. Each specification is identified by its name and version. Oracle Applications login. The specification owns one or more specification tests specifying the test procedures to be carried out against the item identified in the specification header. High. Number of test repetitions required per sample integer value greater than 0.Item specification or M .OPM Quality Specifications APIs Parameter spec_id Description Spec_id must be null when a new gmd_specifications row is being created. Parameter . The following table explains the required columns of the table: Parameter spec_id test_id test_method_id seq test_priority test_replicate Description Spec_id not required. Positive integer value. Spec_name and spec_vers must form a unique key. Quality Management Inbound API Business Objects 2-3 . Sequence of this test within the specification. Value 100 signifies NEW.Normal.x_spec (OUT) This is a row type parameter that returns the populated specification. Valid values are I . A valid spec_id must be provided when there is no requirement to create a new gmd_specifications row and the intention is to reference an existing one in order to add gmd_ spec_tests.Monitoring specification. Valid values are 5N . Valid values from sy_orgn_usr. Positive integer value.item and M .p_spec_tests_tbl (IN) This is a table type parameter that identifies the specification tests. spec_type spec_name spec_vers spec_desc spec_status owner_orgn_code owner_id spec_type Parameter . Duplicates not allowed within a single specification.Low. Specification type.monitoring. 1L . Must reference a valid entry in gmd_test_methods. Must reference a valid entry in gmd_qc_tests. and 8H . Valid values from sy_orgn_mst. Description of specification. Spec_name and spec_vers must form a unique key. Valid values are I . It is populated with the spec_id from the owning gmd_specifications entity. x_spec_tests_tbl (OUT) This is a table type parameter that returns the populated specification tests.OPM Quality Specifications APIs Parameter . The spec_id is supplied. The following table explains the required columns of the row: Parameter spec_id Description The specification identified being logically deleted. Oracle Applications login. Delete Specification This procedure lets you delete mark a row in GMD_SPECIFICATIONS indicating that it is logically deleted. This is only permitted where: ■ The row is not already delete marked. Parameter . Delete Specification Tests This procedure lets you physically delete a row in GMD_SPEC_TESTS. The spec_status permits updates. ■ ■ Following is the definition of Delete Specification: Parameter p_spec p_user_name x_deleted_rows Required Y Y Y In/Out IN IN OUT Description Record Structure of Specifications. Number of Specification records deleted.p_spec (IN) This is a row type parameter that identifies the specification being logically deleted. This is only permitted where: ■ The header GMD_SPECIFICATIONS row is not already delete marked. ■ Following is the definition of Delete Specification Tests: 2-4 Oracle Process Manufacturing Quality Management API User’s Guide . The header GMD_SPECIFICATIONS row has a spec_status which permits updates. Number of Specification test records deleted. The following table explains the required columns of the table: Parameter spec_id test_id Description Spec_id is required.p_spec_tests_tbl (IN) This is a table type parameter that identifies the specification tests being physically deleted. It is a valid specification. Quality Management Inbound API Business Objects 2-5 . Parameter . Must reference a valid entry in gmd_tests.OPM Quality Specifications APIs Parameter p_spec_tests_tbl x_deleted_rows Required Y Y In/Out IN OUT Description Table Structure of Specification Tests. non-delete marked entry in gmd_ specifications. These can be of a general or specific nature. 2-6 Oracle Process Manufacturing Quality Management API User’s Guide . Create Inventory Specification Validity Rules This procedure lets you insert one or more rows into GMD_INVENTORY_SPEC_ VRS. Must be 100 (New) in a create scenario.OPM Quality Specification Validity Rules APIs OPM Quality Specification Validity Rules APIs The circumstances under which a specification is used are determined by its validity rules. Parameter . Oracle Applications username. A unique spec_vr_id is generated by the insert processing. The following table explains the required columns of the table: Parameter spec_vr_id spec_id spec_vr_status Description Must be null. Following is the definition of Create Inventory Specification Validity Rules: Parameter p_inventory_spec_vrs_ tbl p_user_name x_inventory_spec_vrs_ tbl Required Y Y Y In/Out IN IN OUT Description Input table structure for Inventory Specification Validity Rule data. Specification validity rules (SVRs) fall into the following categories that dictate the usage type: ■ Inventory WIP Supplier Customer ■ ■ ■ A single specification can have multiple validity rules both across and within the four categories. Must reference a valid. Table structure containing inserted Inventory Specification Validity Rules. The selection of a specification is controlled by the criteria particular to the validity rules.p_inventory_spec_vrs_tbl (IN) This is a table type parameter that identifies the inventory specification validity rule. Must reference a valid. Parameter . Oracle Applications username. A unique spec_vr_id is generated by the insert processing. Valid date. Quality Management Inbound API Business Objects 2-7 . Following is the definition of Create WIP Specification Validity Rules: Parameter p_wip_spec_vrs_tbl p_user_name x_wip_spec_vrs_tbl Required Y Y Y In/Out IN IN OUT Description Input table structure for WIP Specification Validity Rule data. Create WIP Specification Validity Rules This procedure lets you insert one or more rows into GMD_WIP_SPEC_VRS. The following table explains the required columns of the table: Parameter spec_vr_id spec_id spec_vr_status start_date Description Must be null. Parameter . non-delete marked entry in gmd_ specifications.x_inventory_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated inventory specification validity rule.OPM Quality Specification Validity Rules APIs Parameter start_date Description Valid date.x_wip_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated work in progress specification validity rule. Must be 100 (New) in a create scenario. Parameter .p_wip_spec_vrs_tbl (IN) This is a table type parameter that identifies the work in progress specification validity rule. Table structure containing inserted WIP Specification Validity Rules. A unique spec_vr_id is generated by the insert processing. Oracle Applications username. The following table explains the required columns of the table: Parameter spec_vr_id spec_id cust_id spec_vr_status start_date Description Must be null.x_customer_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated customer specification validity rule. Create Supplier Specification Validity Rules This procedure lets you insert one or more rows into GMD_SUPPLIER_SPEC_VRS.p_customer_spec_vrs_tbl (IN) This is a table type parameter that identifies the customer specification validity rule. Must be 100 (New) in a create scenario. Following is the definition of Create Customer Specification Validity Rules: Parameter p_customer_spec_vrs_ tbl p_user_name x_customer_spec_vrs_ tbl Required Y Y Y In/Out IN IN OUT Description Input table structure for Customer Specification Validity Rule data. Parameter .OPM Quality Specification Validity Rules APIs Create Customer Specification Validity Rules This procedure lets you insert one or more rows into GMD_CUSTOMER_SPEC_ VRS. Valid date. Following is the definition of Create Supplier Specification Validity Rules: 2-8 Oracle Process Manufacturing Quality Management API User’s Guide . Must reference a valid. Must reference a valid cust_account_id in hz_cust_accounts_all. Table structure containing inserted Customer Specification Validity Rules. Parameter . non-delete marked entry in gmd_ specifications. The following table explains the required columns of the table: Parameter spec_vr_id spec_id supplier_id spec_vr_status start_date Description Must be null. Table structure containing inserted Supplier Specification Validity Rules. Must be 100 (New) in a create scenario. validates each table entry and if found valid. Must reference a valid. non-delete marked entry in gmd_ specifications. Following is the definition of Create Monitoring Specification Validity Rules: Parameter p_monitoring_spec_ vrs_tbl Required Y In/Out IN Description Input table structure for Monitoring Specification Validity Rule data. Oracle Applications username. A unique spec_vr_id is generated by the insert processing.x_supplier_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated supplier specification validity rule. Parameter . Quality Management Inbound API Business Objects 2-9 .p_supplier_spec_vrs_tbl (IN) This is a table type parameter that identifies the supplier specification validity rule. Valid date. It accepts a table of Monitoring SpecificationValidity Rule definitions.OPM Quality Specification Validity Rules APIs Parameter p_supplier_spec_vrs_ tbl p_user_name x_supplier_spec_vrs_ tbl Required Y Y Y In/Out IN IN OUT Description Input table structure for Supplier Specification Validity Rule data. Must reference a valid vendor_id in po_vendors. Create Monitoring Specification Validity Rules This procedure creates monitoring specification validity rules. Parameter . then it inserts a corresponding row into the gmd_monitoring_spec_vrs table. Delete Inventory Specification Validity Rules This procedure lets you logically delete one or more rows in GMD_INVENTORY_ SPEC_VRS. The following table explains the required columns of the table: Parameter spec_vr_id spec_id spec_vr_status start_date Description Must be null. Parameter . Valid date. Must be 100 (New) in a create scenario. The targeted row in GMD_INVENTORY_SPEC_VRS is not already delete marked.OPM Quality Specification Validity Rules APIs Parameter p_user_name x_monitoring_spec_ vrs_tbl Required Y Y In/Out IN OUT Description Oracle Applications username. Must reference a valid. A unique spec_vr_id is generated by the insert processing. 2-10 Oracle Process Manufacturing Quality Management API User’s Guide . non-delete marked entry in gmd_ specifications. This is permitted where: ■ The header GMD_SPECIFICATIONS row is not already delete marked. Parameter .x_monitoring_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated monitoring specification validity rule.p_monitoring_spec_vrs_tbl (IN) This is a table type parameter that identifies the monitoring specification validity rule. ■ Following is the definition of Delete Inventory Specification Validity Rules: Parameter p_inventory_spec_vrs_ tbl Required Y In/Out IN Description Input table structure for Inventory Specification Validity Rule data. Table structure containing inserted Monitoring Specification Validity Rules. This refers to a valid existing spec vr id. Oracle Applications username.p_wip_spec_vrs_tbl (IN) This is a table type parameter that identifies the work in progress specification validity rule. Delete WIP Specification Validity Rules This procedure lets you logically delete one or more rows in GMD_WIP_SPEC_ VRS. non-delete marked entry in gmd_ specifications. Parameter . Number of rows deleted. ■ Following is the definition of Delete WIP Specification Validity Rules: Parameter p_wip_spec_vrs_tbl p_user_name x_deleted_rows Required Y Y Y In/Out IN IN OUT Description Input table structure for WIP Specification Validity Rule data. Parameter . Must reference a valid.p_inventory_spec_vrs_tbl (IN) This is a table type parameter that identifies the inventory specification validity rule.OPM Quality Specification Validity Rules APIs Parameter p_user_name x_deleted_rows Required Y Y In/Out IN OUT Description Oracle Applications username. This is permitted where: ■ The header GMD_SPECIFICATIONS row is not already delete marked. The targeted row in GMD_WIP_SPEC_VRS is not already delete marked. The following table explains the required columns of the table: Parameter spec_vr_id spec_id Description Cannot be NULL. The following table explains the required columns of the table: Quality Management Inbound API Business Objects 2-11 . Number of rows deleted. The targeted row in GMD_CUSTOMER_SPEC_VRS is not already delete marked. Oracle Applications username. non-delete marked entry in gmd_ specifications. Parameter . Must reference a valid. This refers to a valid existing spec vr id. This is permitted where: 2-12 Oracle Process Manufacturing Quality Management API User’s Guide . Delete Supplier Specification Validity Rules This procedure lets you logically delete one or more rows in GMD_SUPPLIER_ SPEC_VRS. The following table explains the required columns of the table: Parameter spec_vr_id spec_id Description Cannot be NULL. Delete Customer Specification Validity Rules This procedure lets you logically delete one or more rows in GMD_CUSTOMER_ SPEC_VRS. This is permitted where: ■ The header GMD_SPECIFICATIONS row is not already delete marked.p_customer_spec_vrs_tbl (IN) This is a table type parameter that identifies the customer specification validity rule. Number of rows deleted. non-delete marked entry in gmd_ specifications.OPM Quality Specification Validity Rules APIs Parameter spec_vr_id spec_id Description Cannot be NULL. This refers to a valid existing spec vr id. ■ Following is the definition of Delete Customer Specification Validity Rules: Parameter p_customer_spec_vrs_ tbl p_user_name x_deleted_rows Required Y Y Y In/Out IN IN OUT Description Input table structure for Customer Specification Validity Rule data. Must reference a valid. Following is the definition of Delete Monitoring Specification Validity Rules: Parameter p_monitoring_spec_ vrs_tbl p_user_name x_deleted_rows Required Y Y Y In/Out IN IN OUT Description Input table structure for Monitoring Specification Validity Rule data. Delete Monitoring Specification Validity Rules This procedure deletes multiple monitoring specification validity rules. ■ Following is the definition of Delete Supplier Specification Validity Rules: Parameter p_supplier_spec_vrs_ tbl p_user_name x_deleted_rows Required Y Y Y In/Out IN IN OUT Description Input table structure for Supplier Specification Validity Rule data. non-delete marked entry in gmd_ specifications. Number of rows deleted. The following table explains the required columns of the table: Parameter spec_vr_id spec_id Description Cannot be NULL.p_supplier_spec_vrs_tbl (IN) This is a table type parameter that identifies the supplier specification validity rule. Quality Management Inbound API Business Objects 2-13 . This refers to a valid existing spec vr id.OPM Quality Specification Validity Rules APIs ■ The header GMD_SPECIFICATIONS row is not already delete marked. Number of rows deleted. The targeted row in GMD_SUPPLIER_SPEC_VRS is not already delete marked. Parameter . Must reference a valid. a logical delete is performed setting the delete_mark to 1. It accepts a table of Monitoring SpecificationValidity Rule definitions and validates each table entry to ensure the corresponding row is not already delete marked. Oracle Applications username. When validation is successful. Oracle Applications username. OPM Quality Specification Validity Rules APIs Parameter . The following table explains the required columns of the table: Parameter spec_vr_id spec_id Description Cannot be NULL. Must reference a valid. This refers to a valid existing spec vr id.p_monitoring_spec_vrs_tbl (IN) This is a table type parameter that identifies the monitoring specification validity rule. non-delete marked entry in gmd_ specifications. 2-14 Oracle Process Manufacturing Quality Management API User’s Guide . OPM Quality Test APIs OPM Quality Test APIs A Quality Test is required when a sample is taken for a product. Create Tests This procedure is used to create: ■ a test header test values customer test records ■ ■ It can also be used to create test values or customer tests for a test that already exists. This routine determines what entities are required for creation based on the input parameters passed. type. or customer specific tests. as well as the unique test value id. Specify the test_ code or the unique test_id in the test_record being passed. Specify the test_id in the record being passed. DELETE_TEST_VALUES . The Delete Test API also supports the deletion of either a test header record. The values entered determine what values can be recorded for this test. You must specify the test_id in the record being passed. This logically marks the record as deleted. p_qc_tests_rec Quality Management Inbound API Business Objects 2-15 . DELETE_CUSTOMER_TESTS. and code. The delete APIs are: ■ DELETE_TEST_HEADERS . This physically deletes the records. details values.This deletes a test header record. The type is used to determine what values can be recorded for this test.This accepts one or more customer test values that must be deleted for a test. ■ ■ You must first delete the test header record before you can delete the test values or customer tests.This accepts one or more test values that must be deleted for a test. The Create Test API lets you create a new test. It also lets you create values or customer tests for a test that already exists. as well as the unique customer id. This physically deletes the records. test_values. and customer specific tests. The test must have a description. Customer values can also be recorded. Following is the definition of Create Tests: Parameter Required Y In/Out IN Description Record structure of Test Headers. Record structure of Test Headers. Table structure of Customer Tests. non delete marked row. 2-16 Oracle Process Manufacturing Quality Management API User’s Guide . The following table explains the required columns of the row: Parameter test_id Description Must be null if the requirement is to create a new row in gmd_ qc_tests. Test method ID. Must identify the parent gmd_qc_tests where this already exists. Note that there are additional fields required depending on the test type. Free format text description. Oracle Applications login. Or. p_qc_test_values_tbl p_qc_cust_tests_tbl p_user_name x_qc_tests_rec x_qc_test_values_tbl x_qc_cust_tests_tbl Parameter . The following table explains the required columns of the table: Parameter test_value_id test_id Description Must be null. Test type. A unique test_id is generated by the insert processing. Table structure of Customer Tests. then this must be null.OPM Quality Test APIs Parameter Required Y Y Y Y Y Y In/Out IN IN IN OUT OUT OUT Description Table structure of Test Values. A unique test_value_id is generated by the insert processing. then the test_id must reference a valid. If the parent gmd_qc_tests is being created in the same API call.p_qc_test_values_tbl (IN) This is a table type parameter that identifies the test values.p_qc_tests_rec (IN) This is a row type parameter that identifies the tests. test_code test_desc test_method_id test_type Parameter . A code to uniquely identify the test. if the child records are being added to an exisiting gmd_qc_ tests row. Table structure of Test Values. Parameter .OPM Quality Test APIs Parameter . Delete Test Headers This procedure is used to logically delete (set delete_mark=1) the entity test header GMD_QC_TESTS. p_qc_tests_rec p_user_name Parameter . If the parent gmd_qc_tests is being created in the same API call.x_qc_tests_rec (OUT) This is a row type parameter that returns the populated test.x_qc_cust_tests_tbl (OUT) This is a table type parameter that returns the populated customer test values. Required if test_id is NULL.p_qc_tests_rec (IN) This is a row type parameter that identifies the tests. Quality Management Inbound API Business Objects 2-17 .x_qc_test_values_tbl (OUT) This is a table type parameter that returns the populated test values.p_qc_cust_tests_tbl (IN) This is a table type parameter that identifies the customer test values. then this must be null. Following is the definition of Delete Test Headers: Parameter Required Y Y In/Out IN IN Description Record structure of Test Headers. Parameter . Oracle Applications login. cust_id Parameter . The following table explains the required columns of the row: Parameter test_id test_code Description Required if test_code is NULL. Must identify a valid cust_account_id in hz_cust_accounts_all. The following table explains the required columns of the table: Parameter test_id Description Must identify the parent gmd_qc_tests where this already exists. The following table explains the required columns of the table: Parameter test_id test_value_id Description Test ID of the test value being deleted. This is permitted where: ■ The header GMD_QC_TESTS row is not delete marked.p_qc_test_values_tbl (IN) This is a table type parameter that identifies the test values. ■ Following is the definition of Delete Customer Tests: Parameter Required Y In/Out IN Description Table structure of Test Customer Display. All targeted rows in GMD_QC_TEST_VALUES belong to the same header (GMD_QC_TESTS). p_qc_test_values_tbl x_deleted_rows Parameter . p_qc_cust_tests_tbl 2-18 Oracle Process Manufacturing Quality Management API User’s Guide . All targeted rows in GMD_CUSTOMER_TESTS belong to the same header (GMD_QC_TESTS).OPM Quality Test APIs Delete Test Values This procedure lets you physically delete one or more rows in GMD_QC_TEST_ VALUES. This is permitted where: ■ The header GMD_QC_TESTS row is not delete marked. Number of Test Value records Deleted. Delete Customer Tests This procedure lets you physically delete one or more rows in GMD_CUSTOMER_ TESTS. ■ Following is the definition of Delete Test Values: Parameter Required Y Y In/Out IN OUT Description Table structure of Test Values. Identifier of the test value. OPM Quality Test APIs Parameter Required Y In/Out OUT Description Number of Test Customer Display records deleted. Must identify a valid cust_account_id in hz_cust_accounts_all. Quality Management Inbound API Business Objects 2-19 . x_deleted_rows Parameter . The following table explains the required columns of the table: Parameter test_id cust_id Description Must identify the parent gmd_qc_tests where this already exists.p_qc_cust_tests_tbl (IN) This is a table type parameter that identifies the customer test values. A sampling event documents the need for a sample to be taken and can arise in one of the following categories: ■ Inventory WIP Supplier Customer Resource Location ■ ■ ■ ■ ■ Every sample belongs to a sampling event. Validity Rules can exist in the following areas: ■ Inventory WIP Supplier Customer Resource Location ■ ■ ■ ■ ■ For example. The sampling event which owns that sample. each test associated with the specification is attached to the sample. A sample can be taken that is not associated to a specification. If a batch is created using this recipe. also does not have a specification associated to it. Then. the specification New Recipe has a WIP validity rule which is set up for any batch using recipe R1. The Samples API can be used to: 2-20 Oracle Process Manufacturing Quality Management API User’s Guide . and any other samples created with the same source data. A specification is a group of tests that must be performed on samples associated to it. It can be drawn in response to the creation of a sampling event or simply on a standalone basis. Each specification has at least one specification validity rule used to dictate when a sampling event (business event) is generated.OPM Quality Samples APIs OPM Quality Samples APIs A sample is a representative quantity of material that undergoes analysis to record quality characteristics. then any samples taken from it can be attached to the New Recipe specification. including create or update associated sampling event. then the specification validity rules are examined to find the specification with the closest match to the supplied input data. or set up disposition records. then the disposition is changed to COMPLETE when all three samples are created. One result row is inserted for each replicate of each test in the associated specification. Where a sampling_event_id is supplied. For example. ■ ■ ■ ■ Quality Management Inbound API Business Objects 2-21 . if a test has a replicate number of two. This determines whether the sampling event should be free-standing or associated with a specification.OPM Quality Samples APIs ■ create a sample. Where no sampling_ event_id is supplied. This is necessary to record the disposition of the current instance of the sampling plan. insert a result set. parameter p_find_ matching_spec is examined. associate the sample_row GMD_SAMPLES with an existing sampling event GMD_SAMPLING_EVENT. insert a row into GMD_EVENT_SPEC_DISP. For example. ■ The following public APIs are provided in package GMD_SAMPLES_PUB to support the creation and deletion of samples: ■ CREATE_SAMPLES . Every sample belongs to a sampling event. then two result rows are inserted into the table.provides a mechanism to create the samples DELETE_SAMPLES . Therefore. or insert a new GMD_SAMPLING_EVENT. They can be input as follows: insert a row into GMD_SAMPLE_SPEC_DISP. attach result records. This is necessary to record the disposition of the current sample in terms of the results for all tests prescribed by the specification. Test results may be considered in specification or out of specification. It indicates whether all the requirements for the sampling plan have been met. which is one or more rows in GMD_RESULTS. it is assumed that the sample is being associated with this. Each row ID acts as a skeleton entry put in place for recording actual test results.supports the logical deletion of GMD_SAMPLES ■ Create Samples This procedures lets you: ■ insert a row into GMD_SAMPLES. If the parameter is set to Y. a new row is created. if the sampling plan requires three lot samples. delete a sample and update associated sampling event. Record structure for sampling events. Following is the definition of Create Samples: Parameter Required Y Y N N Y Y Y Y Y Y In/Out IN IN IN IN OUT OUT OUT OUT OUT OUT Description Record structure for samples input. it assumes that the gmd_sampling_events row must be created. the relationship between gmd_results and gmd_spec_results is one-to-one. Record structure for Event Specification Disposition. When a sample is new. Flag to ensure that sampling event has specification associated. sample_id 2-22 Oracle Process Manufacturing Quality Management API User’s Guide . non delete marked entry in gmd_sampling_events. p_qc_samples_rec p_user_name p_find_matching_ spec p_grade x_qc_samples_rec x_sampling_events_ rec x_sample_spec_disp x_event_spec_disp_ rec x_results_tab x_spec_results_tab Parameter . The following table explains the required columns of the table: Parameter sampling_event_id Description Where supplied. All data is validated prior to insert. this must reference a valid. Table structure for results. Record structure for Sample Specification Disposition. Table structure for Specification results.p_qc_samples_rec (IN) This is a table type parameter that identifies the sample records. This is a skeleton entry put in place for recording the results of testing the sample. Where a null value is supplied. A unique sample_id is generated by the insert processing.OPM Quality Samples APIs ■ insert a row into GMD_SPEC_RESULTS. Grade Record structure for samples output. Must be null. Oracle Applications login. Wip. Valid values are I Inventory.Supplier. This is permitted where the targeted row in GMD_SAMPLES is not already delete marked.x_qc_samples_rec (OUT) This is a row type parameter that returns the populated samples record.x_spec_results_tab (OUT) This is a table type parameter that returns the populated specification results for the sample.x_results_tab (OUT) This is a table type parameter that returns the populated results for the sample.Customer.x_sample_spec_disp (OUT) This is a row type parameter that returns the populated sample specification disposition. Sample type.OPM Quality Samples APIs Parameter sample_no Description Unique identifier for the sample. Parameter . Parameter . Parameter . Delete Sample This procedure lets you logically delete one or more rows in GMD_SAMPLES. Following is the definition of Delete Sample: Quality Management Inbound API Business Objects 2-23 . S . the unique identifier must be supplied. The organization code of the organization creating the sample. Otherwise. Identifies the source of the sample. Automatically generated where document numbering is in place for document type SMPL. C . Valid user_id from fnd_user. Parameter .x_event_disp_rec (OUT) This is a row type parameter that returns the populated event disposition record. Parameter . sample_organization source sample_type sampler_id Parameter . W .x_sampling_events_rec (OUT) This is a row type parameter that returns the populated sampling events record. then sample_id can be NULL. The following table explains the required columns of the table: Parameter sample_id orgn_code sample_no Description If specified. 2-24 Oracle Process Manufacturing Quality Management API User’s Guide . p_qc_samples_rec p_user_name Parameter . If specified with sample_no.p_qc_samples_rec (IN) This is a table type parameter that identifies the sample records. If specified with orgn_code. then orgn_code and sample_no can be NULL.OPM Quality Samples APIs Parameter Required Y Y In/Out IN IN Description Record structure for samples. Oracle Applications login. then sample_id can be NULL. The input result is analyzed to determine if it is considered in specification or out of specification and this information is used to update GMD_ SPEC_RESULTS. Oracle Applications username.p_results_rec (IN) This is a row type parameter that identifies the results being recorded. New tests or replications of tests can be added. a validity rule. The Add Tests to Samples API lets the result set for a sample be extended. The sample has a set of tests against which results must be recorded. The following table explains the required columns of the row: Parameter result_value result_id Description This is the value for the test result. This is a required value. Record structure for gmd_spec_results table. when the sample is created. Therefore. Identifies a specific result in a specific sample. but the detail of the test result is now put in place. a result set is also established. The Record Results API lets actual results be recorded for a particular test. It modifies the appropriate row in GMD_RESULTS which is put in place when the result set is created for a particular sample. This is required if no other values except for result_value are passed.OPM Quality Results APIs OPM Quality Results APIs Prior to documenting results. The result row already exists since it is created with the sample. Following is the definition of Record Results: Parameter p_results_rec p_user_name x_results_rec x_spec_results_rec Required Y Y Y Y In/Out IN IN OUT OUT Description Record structure for gmd_results table. and a sample. create a specification. Parameter . Record structure for gmd_results table.in_spec_ind. Record Results This procedure can be used to record actual test results. Quality Management Inbound API Business Objects 2-25 . This is required. then sample_id is not required. The ID for the test associated to a result. Parameter . This is required. sample_no. if test_ code is not defined. If specified. You can pass a date to this field. Otherwise. test_replicate_cnt ■ ■ ■ ■ Parameter .x_results_rec (OUT) This is a row type parameter that returns the results. If no date is passed. You must use the sample_id or sample_ no and orgn_code combination with the test_id or test_code and test_replicate_cnt combination.x_spec_results_rec (OUT) This is a row type parameter that returns the specification results. the system checks sample_id first. test_code. In conjunction with orgn_code.OPM Quality Results APIs Parameter sample_id Description The ID for the sample of the result. In conjunction with sample_no. must reference a valid sample in gmd_samples. Otherwise. sample_no orgn_code test_id test_code test_replicate_cnt result_date Example: The following combinations are valid: ■ result_value and result_id result_value with sample_id and test_id and test_replicate_cnt result_value with sample id and test_code with test_replicate_cnt result value with sample_no and orgn_code with test_id and test_replicate_cnt result_value with orgn_code. Used in conjunction with sample and test identifiers to determine the required row in gmd_results. 2-26 Oracle Process Manufacturing Quality Management API User’s Guide . the system checks test_id first. then it defaults to SYSDATE. Test code is used whenever test_id is not passed. if sample_ no and orgn_code are not defined. must reference a valid sample in gmd_samples. Table structure for GMD_API_Pub.p_sample_rec (IN) This is a row type parameter that identifies the sample being recorded. rows are created in GMD_RESULTS and GMD_SPEC_RESULTS which is done in preparation for recording the outcome of the testing. Table structure for Table IDs GMD_API_ Pub. After the results rows have been added. There can be multiple replications of a test. Table structure for GMD_API_Pub.number_tab Event specification disposition ID. You can pass a date to this field.OPM Quality Results APIs Add Tests to Samples This procedure lets tests be added to an existing sample.gmd_ spec_results_tab. If no date is passed. Parameter . For each test referenced. The following table explains the required columns of the row: Quality Management Inbound API Business Objects 2-27 . Oracle Applications username. Each results row references a test. then it defaults to SYSDATE.gmd_ results_tab. dispositions are set to In Progress on the following entities: ■ GMD_SAMPLES GMD_SAMPLING_EVENTS GMD_SAMPLE_SPEC_DISP GMD_EVENT_SPEC_DISP ■ ■ ■ Following is the definition of Add Tests to Samples: Parameter p_sample_rec p_user_name p_test_id_tab p_event_spec_disp_id x_results_tab x_spec_results_tab p_result_date Required Y Y Y Y Y Y Y In/Out IN IN IN IN OUT OUT IN Description Record structure for gmd_samples table. You must use the sample_id or sample_ no and orgn_code combination with the test_id or test_code combination. This is required.p_test_id_tab (IN) This is a table type parameter that identifies the test ID being recorded. must reference a valid sample in gmd_samples. sample_no orgn_code Parameter . This is required. Parameter . the system checks sample_id first. if test_ code is not defined. 2-28 Oracle Process Manufacturing Quality Management API User’s Guide . Otherwise. In conjunction with sample_no.x_spec_results_tab (OUT) This is a table type parameter that returns the specification results. the system checks test_id first. Otherwise.x_results_tab (OUT) This is a table type parameter that returns the results. if sample_ no and orgn_code are not defined.OPM Quality Results APIs Parameter sample_id Description The ID for the sample of the result. Parameter . In conjunction with orgn_code. must reference a valid sample in gmd_samples. The following table explains the required columns of the row: Parameter test_id Description The ID for the test associated to a result. This download of Quality information facilitates further analysis and reporting in an external system.3 Quality Management Outbound API Business Objects OPM provides outbound APIs to export Quality Management data to third party systems. The outbound APIs include: ■ Fetch Test Methods Fetch Tests Fetch Specifications and Validity Rules Fetch Samples Fetch Sample Groups Fetch Results Fetch Composite Results ■ ■ ■ ■ ■ ■ Quality Management Outbound API Business Objects 3-1 . defines the start value for a range-based retrieval. 3-2 Oracle Process Manufacturing Quality Management API User’s Guide . If specified. If specified. If specified. restricts the retrieval to the single resource. then a status of success is returned and the rows are returned in the output table x_test_methods_ tbl. If specified. If specified.x_test_methods_table (OUT) This is a table type parameter that returns the fetched test method information. Oracle Applications user name. If specified. If an error is encountered. Following is the definition of Fetch Test Methods: Parameter p_from_test_method_ code p_to_test_method_ code p_test_method_id p_test_kit_item_no p_test_kit_item_id p_resource p_delete_mark Required N N N N N N N In/Out IN IN IN IN IN IN IN Description If specified.Fetch Test Methods Fetch Test Methods This procedure retrieves test method data from the table GMD_TEST_METHODS. If specified. restricts the retrieval to the single test_method_id. restricts the retrieval to the single item_no. p_from_last_update_ date p_to_last_update_date p_user_name x_test_methods_table N N Y Y IN IN IN OUT Parameter . If the API is able to select one or more test methods without error. defines the end data for a range-based retrieval. defines the end value for a range-based retrieval. Record type gmd_test_methods_tab_ type. restricts the retrieval to the single item_id. then an error status is returned. retrieval is restricted to deleted rows (if specified as 1) or undeleted rows (if specified as 0). defines the start date for a range-based retrieval. If specified. Logical delete record indicator. Test kit item number. In the language of the session. Descriptive Flexfield Segments. Test duration in number of minutes. Test_qty Test_uom Delete_mark Display_precision Test_duration Days Hours Minutes Seconds Test_replicate Resources Test_kit_item_id Test_kit_item_no Text_code attribute1-30 attribute_category creation_date created_by_id created_by_user last_updated_by_id Last_updated_by_user last_update_date Test quantity. Test duration. Standard Who Column. Quality Management Outbound API Business Objects 3-3 . Test method code. Display precision. actual text comes from gmd_ test_methods_tl via gmd_test_methods_vl view. Test duration in number of hours. Test duration in number of days. Descriptive Flexfield Segment Category.Fetch Test Methods Parameter Test_method_id Test_method_code Test_method_desc Description Test method identifier. Text code. then the retrieval fails and test method data is not returned. If the descriptions do not exist in the language of the session. Standard Who Column. Test duration in number of seconds. Standard Who Column. Test unit of measure. Test kit item. Standard Who Column. Test replicate. Standard Who Column. Resources. Standard Who Column. 3-4 Oracle Process Manufacturing Quality Management API User’s Guide .Fetch Test Methods Parameter Last_update_login Description Standard Who Column. and GMD_CUSTOMER_TESTS. Testing identifier. Test identifier. Quality Management Outbound API Business Objects 3-5 . Priority Logical delete record indicator. Test class. Oracle Applications user name. Field/Column Row_id Test_id Description Row ID. Starting last update date.x_tests_table (OUT) This is a table type parameter that returns the fetched header information for the test. p_to_test_method_ N code p_test_id p_test_method_id p_test_class p_test_type p_priority p_delete_mark p_from_last_ update_date p_to_last_update_ date p_user_name x_tests_table N N N N N N N N Y Y Parameter . Starting test method code. Ending last update date. Test method identifier. Following is the definition of Fetch Tests. Parameter p_from_test_code p_to_test_code p_from_test_ method_code Required N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN OUT Description Starting test code. Ending test code.Fetch Tests Fetch Tests The Fetch Tests API retrieves tests from GMD_TEST_QC_TESTS. GMD_QC_TEST_ VALUES. Record type gmd_qc_tests_tab_type. Ending test method code. Test type. Above minimum action code. Above specification maximum. Logical delete record indicator. Test operation line ID. Test method ID. Below maximum action code. Above_max_action_code Above maximum action code. Descriptive Flexfield Segments. Test unit. Below specification minimum. Test provider code. Test type. Priority. Test description. Report precision. Expression error type. Test operation ID. Below minimum action code. Minimum value. Test classes. Above specification minimum. Expression Display_precision Report_precision Priority Test_oprn_id Delete_mark attribute1-30 attribute_category creation_date Expression Display precision. Descriptive Flexfield Segment Category.Fetch Tests Field/Column Test_Code Test_desc Test_method_id Test_oprn_line_id Test_provider_code Test_class Test_type Test_unit Min_value_num Max_value_num Exp_error_type Below_spec_min Above_spec_min Below_spec_max Above_spec_max Below_min_action_code Above_min_action_code Below_max_action_code Description Test code. Standard Who Column 3-6 Oracle Process Manufacturing Quality Management API User’s Guide . Below specification maximum. Maximum value. Record type qc_customer_test_tab. Standard Who Column. Display the label numeric range. Numeric range from value recorded in quality units specified in test_unit. Test unique identifier.x_qc_test_values_tab This is a table type parameter that returns the fetched quality test values. Varchar value for list of values or text range. Test value identifier. Test value description. Field/Column Row_id Test_value_id Test_id Min_num Max_num Display_label_numeric_ range Test_value_desc Value_char Text_range_seq Expression_ref_test_id attribute1-30 attribute_category creation_date created_by last_updated_by last_update_date Description Row identifier. ID of referenced test for expression test type. Numeric range to value recorded in quality units specified in test_unit. Descriptive Flexfield Segments Descriptive Flexfield Segment Category Standard Who Column. Quality Management Outbound API Business Objects 3-7 .Fetch Tests Field/Column created_by last_updated_by last_update_date Last_update_login x_qc_test_values_tab x_qc_customer_tests_tab Description Standard Who Column Standard Who Column Standard Who Column Standard Who Column Record type qc_tests_values_tab. Parameter . Standard Who Column. Test range sequence. Standard Who Column. Standard Who Column. Test identifier. Customer test display. Customer identifier.x_qc_customer_tests_tab This is a table type parameter that returns the fetched quality customer test information. Report precision. Parameter .Fetch Tests Field/Column Last_update_login Description Standard Who Column. Standard Who Column. 3-8 Oracle Process Manufacturing Quality Management API User’s Guide . Standard Who Column. Standard Who Column. Standard Who Column. Field/Column Row_id Test_id Cust_id Report_precision Cust_test_display Text_code creation_date created_by last_updated_by last_update_date Last_update_login Description Row identifier. Text code. Specification status. Ending specification last update date. and validity rules from GMD_SPECIFICATIONS. Test method identifier. and GMD_SUPPLIER_SPEC_VRS. Quality Management Outbound API Business Objects 3-9 . specification tests. Test code. Test method code. Ending specification name. Logical delete record indicator. Starting specification last update date. Specification identifier. Ending grade. Test identifier. GMD_CUSTOMER_SPEC_VRS. Specification version. Oracle Applications user name. Starting grade. Following is the definition of Fetch Specification Validity Rules: Parameter p_from_spec_name p_to_spec_name p_spec_id p_spec_version p_from_grade p_to_grade p_from_item_code p_to_item_code p_from_last_ update_date p_to_last_update_ date p_spec_type p_user_orgn_code p_user_name p_item_id p_spec_status p_delete_mark p_test_code p_test_id p_test_method_ code p_test_method_id Required N N N N N N N N N N N N Y N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Starting specification name. Item identifier. GMD_SPEC_TESTS.Fetch Specification Validity Rules Fetch Specification Validity Rules The Fetch Specification Validity Rules API retrieves specifications. GMD_ WIP_SPEC_VRS. Specification type. User organization code. GMD_INVENTORY_SPEC_VRS. Ending item code. Starting item code. Validity rule sampling plan. Validity rule batch identifier. Validity rule certificate of analysis type. Validity rule organization. Test priority. Record type specifications_tbl_type. Specification validity rule status.x_specifications_tbl (OUT) This is a table type parameter that returns the fetched header information for the specification. Validity rule lot identifier. Logical delete record indicator. Validity rule end date. Validity rule organization batch number. Validity rule warehouse.Fetch Specification Validity Rules Parameter p_test_uom p_test_priority p_from_test_last_ update_date p_to_test_last_ update_date p_spec_vr_status p_vr_orgn p_vr_start_date p_vr_end_date p_vr_coa_type p_vr_sampling_ plan p_vr_sampling_ plan_id p_vr_delete_mark p_vr_source p_vr_lot_no p_vr_lot_id p_vr_sublot_no p_vr_warehouse p_vr_location p_vr_orgn_batch_ no p_vr_batch_id p_vr_recipe_no x_specifications_tbl Required N N N N N N N N N N N N N N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN OUT Description Test unit of measure. Validity rule sample plan identifier. Validity rule recipe number. 3-10 Oracle Process Manufacturing Quality Management API User’s Guide . Parameter . Validity rule sublot number. Validity rule start date. Validity rule location. Starting last test update date. Ending last test update date. Validity rule lot number. Validity rule source. Fetch Specification Validity Rules Field/Column Row_id Spec_id Spec_name Spec_vers Spec_desc Spec_type Overlay_ind Base_spec_id Item_id Grade Spec_status Owner_orgn_code Owner_id Description Row identifier. Specification identification. Record type cust_spec_vrs. Specification version. Record type wip_spec_vrs. Standard Who Column. Standard Who Column. Standard Who Column. Owner ID. Standard Who Column. Base specification indicator. Text code. Grade. Specification type. Owner organization code. Specification description. Record type supl_spec_vrs. Descriptive Flexfield Segment Category. Standard Who Column. ind Delete_mark Text_code attribute1-30 attribute_category creation_date created_by last_updated_by last_update_date Last_update_login x_spec_tests x_cust_spec_vrs x_wip_spec_vrs x_supl_spec_vrs Logical delete record indicator. Specification name. Quality Management Outbound API Business Objects 3-11 . Descriptive Flexfield Segments. Record type spec_tests. Sample_inv_trans_ Transact inventory for sample. Specification status. Overlay indicator. Item ID. Fetch Specification Validity Rules Field/Column x_inv_spec_vrs x_mon_spec_vrs Description Record type inv_spec_vrs. Minimum target value for numeric range test type. Out of specification action. Use to control step. NUM = Number. Parameter test_id test_code test_method_id test_method_code seq test_qty test_uom min_value_num target_value_num max_value_num min_value_char target_value_char max_value_char test_replicate check_result_interval print_on_coa_ind use_to_control_step out_of_spec_action exp_error_type below_spec_min Description Test ID. PCT = Percent. Default value is 1. Test method ID. Test quantity. Frequency result values are checked for out-of-spec condition.x_spec_tests This is a table type parameter that returns the header information for the fetched specification tests. Minimum target value for text range test type. 3-12 Oracle Process Manufacturing Quality Management API User’s Guide . Maximum target value for numeric range test type. Target value for test when the test type is a list of values or a text range. Test code. Sequences. Parameter . Test method code. Test unit of measure. Print on certificate of analysis. Maximum target value for text range test type. Below specification minimum. The number of times a test is repeated for the same sample instance. Record type mon_spec_vrs. Test target value. Below specification maximum.high. Text code. Action code for results in the test error region specification maximum minus test error. Days. Decimal precision used to display value. and L . Action code for results in the test error region specification maximum plus test error.low. Valid values are Y . Exclude indicator. Null . Valid values are H . Print specification indicator. Minutes. Quality Management Outbound API Business Objects 3-13 . Modified indicator. To unit of measure. Indicates if a test is optional. Action code for results in the test error region specification minimum minus test error. N .No. Calculation of unit of measure conversion indicator. Decimal precision of saved value. Hours. Test display. Seconds. From base indicator. Indicates if the specification is used to retest for lot expiration.Yes. Action code for results in the test error region specification minimum plus test error. Test priority.Fetch Specification Validity Rules Parameter above_spec_min below_spec_max above_spec_max below_min_action_code above_min_action_code optional_ind display_precision report_precision test_priority retest_lot_expiry_ind print_spec_ind print_result_ind below_max_action_code above_max_action_code test_display days hours minutes seconds from_base_ind exclude_ind modified_ind calc_uom_conv_ind to_uom text_code Description Above specification minimum. Above specification maximum. Print result indicator.normal. Order line ID. 3-14 Oracle Process Manufacturing Quality Management API User’s Guide .Fetch Specification Validity Rules Parameter attribute_category attribute1-30 creation_date created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Descriptive Flexfield Segment Category. Customer identification. Specification validity rule status. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Organization code. Descriptive Flexfield Segments. Order line. Ship-to site ID. Organization ID. Standard Who Column. Standard Who Column. Parameter . Customer number. Ship-to site name. Organization name.x_cust_spec_vrs This is a table type parameter that returns the fetched customer specification validity rule information. Order ID. Order number. Parameter spec_vr_id orgn_code cust_id cust_no order_id order_number order_line order_line_id ship_to_site_id ship_to_site_name org_id org_name spec_vr_status Description Specification validity rule identifier. x_wip_spec_vrs This is a table type parameter that returns the fetched work in process specification validity rule information. Quality Management Outbound API Business Objects 3-15 . Indicates an inventory transaction is created for the sample amount. Certificate of Analysis from supplier. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Standard Who Column.No. Standard Who Column. Sampling plan name. Standard Who Column. Standard Who Column. Certificate of Analysis type. Logical delete record indicator. Start date. Valid values are Y . Sampling plan ID. Standard Who Column. Parameter . Null .Yes. Standard Who Column. Lot optional on sample.Fetch Specification Validity Rules Parameter spec_vr_status_ description start_date end_date sampling_plan_id sampling_plan_name sample_inv_trans_ind lot_optional_on_sample coa_type coa_at_ship_ind coa_at_invoice_ind coa_req_from_supl_ind delete_mark text_code attribute_category attribute1-30 creation_date created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Specification validity rule status description. Standard Who Column. Text code. End date. Descriptive Flexfield Segments. Descriptive Flexfield Segment Category. Recipe ID. 3-16 Oracle Process Manufacturing Quality Management API User’s Guide . Operation ID. Routing number. Null . Recipe version. Specification validity rule status description. Step ID. Operation number. Operation version. Start date. Batch number. Recipe number. Sampling plan name. Batch ID.No. Indicates an inventory transaction is created for the sample amount.Yes. Charges. Sampling plan ID. Step number. Routing version. Formula ID. Valid values are Y . Organization code. Specification validity rule status. Routing ID.Fetch Specification Validity Rules Parameter spec_vr_id orgn_code batch_id batch_no recipe_id recipe_no recipe_version formula_id formula_no formula_vers routing_id routing_no routing_vers step_id step_no oprn_id oprn_no oprn_vers charge spec_vr_status spec_vr_status_ description start_date end_date sampling_plan_id sampling_plan_name sample_inv_trans_ind Description Specification validity rule identifier. End date. Formula number. Formula version. No Outside specification lot status. Standard Who Column. Control batch step indicator. Text code. Quality Management Outbound API Business Objects 3-17 . Standard Who Column. Descriptive Flexfield Segment Category.WorkFlow. Standard Who Column. Standard Who Column. Standard Who Column. Certificate of Analysis invoice indicator. Parameter . In specification lot status. Standard Who Column.Auto. Certificate of Analysis type. Auto sample indicator.x_supl_spec_vrs This is a table type parameter that returns the fetched supplier specification validity rule information. Certificate of Analysis shipment indicator. Standard Who Column. Descriptive Flexfield Segments. Null . Valid values are A . W . Parameter po_header_id Description Purchase order header identification. Certificate of Analysis from supplier.Fetch Specification Validity Rules Parameter lot_optional_on_sample delayed_lot_entry auto_sample_ind control_lot_attrib_ind) out_of_spec_lot_status in_spec_lot_status coa_type control_batch_step_ind coa_at_ship_ind coa_at_invoice_ind coa_req_from_supl_ind delete_mark text_code attribute_category attribute1-30 creation_date created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Lot optional on sample. Delayed lot entry. Logical delete record indicator. Delayed lot entry. Certificate of Analysis supplier indicator.No. End date. Text code. Certificate of Analysis type. 3-18 Oracle Process Manufacturing Quality Management API User’s Guide . Supplier name. Supplier site name. Certificate of Analysis shipment indicator. Supplier site ID. Specification validity rule status description. Descriptive Flexfield Segment Category. Indicates an inventory transaction is created for the sample amount. Organization code. Logical delete record indicator. Lot optional on sample. Sampling plan name.Fetch Specification Validity Rules Parameter po_number spec_vr_id orgn_code supplier_id supplier_name supplier_site_id supplier_site_name po_line_id po_line_number spec_vr_status spec_vr_status_ description start_date end_date sampling_plan_id sampling_plan_name sample_inv_trans_ind lot_optional_on_sample delayed_lot_entry auto_sample_ind coa_type coa_at_ship_ind coa_at_invoice_ind coa_req_from_supl_ind delete_mark text_code attribute_category attribute1-30 Description Purchase order number. Start date. Sampling plan ID. Specification validity rule status. Valid values are Y . Descriptive Flexfield Segments. Auto sample indicator. Supplier ID. Purchase order line number. Specification validity rule identifier. Purchase order ID.Yes. Certificate of Analysis invoice indicator. Null . Standard Who Column. Location Specification validity rule status. Lot number. Sampling plan ID. Parameter spec_vr_id orgn_code lot_id lot_number sublot_number whse_code location spec_vr_status spec_vr_status_ description start_date end_date sampling_plan_id sampling_plan_name sample_inv_trans_ind control_lot_attrib_ind Description Specification validity rule ID. W . Standard Who Column.Fetch Specification Validity Rules Parameter creation_date created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Standard Who Column. Indicates an inventory transaction is created for the sample amount. Sublot number Warehouse code. End date. Null . Lot ID. Valid values are A . Valid values are Y . Quality Management Outbound API Business Objects 3-19 . Organization code.Auto.x_inv_spec_vrs This is a table type parameter that returns the fetched inventory specification validity rule information. Sampling plan name. Parameter . Null .WorkFlow. Start date. Standard Who Column. Standard Who Column.No.Yes. Specification validity rule status description. Standard Who Column. Standard Who Column.No. Fetch Specification Validity Rules Parameter lot_optional_on_sample delay_lot_entry auto_sample_ind in_spec_lot_status out_of_spec_lot_status control_batch_step_ind coa_type coa_at_ship_ind coa_at_invoice_ind coa_req_from_supl_ind delete_mark text_code attribute_category attribute1-30 creation_date created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Lot optional on sample. Descriptive Flexfield Segment Category. Auto sample indicator. Delayed lot entry. Certificate of Analysis suppler indicator. Standard Who Column. Logical delete record indicator. Text code. Standard Who Column.x_mon_spec_vrs This is a table type parameter that returns the fetched inventory specification validity rule information. Certificate of Analysis type. Parameter spec_vr_id spec_id Description Specification validity rule indicator. Standard Who Column. Standard Who Column. 3-20 Oracle Process Manufacturing Quality Management API User’s Guide . Control batch step indicator. Standard Who Column. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Specification ID. Descriptive Flexfield Segments. In specification lot status. Standard Who Column. Parameter . Standard Who Column. Outside specification lot status. Descriptive Flexfield Segment Category. Start date. Quality Management Outbound API Business Objects 3-21 . Descriptive Flexfield Segments. Location.Fetch Specification Validity Rules Parameter rule_type loct_orgn_code whse_code location resources resource_orgn_code resource_instance_id spec_vr_status spec_vr_status_ description start_date end_date sampling_plan_id sampling_plan_name delete_mark text_code attribute_category attribute1-30 creation_date created_by last_updated_by last_update_date last_update_login Description Rule type. Standard Who Column. Location organization code. Logical delete record indicator. Resource instance ID. Text code. Specification validity rule status description. Specification validity rule status. Resource organization code. Standard Who Column. Standard Who Column. Standard Who Column. Warehouse code. Resources. End date. Standard Who Column. Sampling plan ID. Sampling plan name. Work in process recipe identifier. Work in process recipe number. Following is the definition of Fetch Sample Groups: Parameter p_user_name p_orgn_code p_from_sample_no p_to_sample_no p_sample_event_id p_from_item_no p_to_item_no p_item_id p_from_lot_no p_to_lot_no p_from_sublot_no p_to_sublot_no p_lot_id p_disposition p_whse_code p_location p_location_id p_wip_orgn_code p_wip_batch_no p_wip_batch_id p_wip_recipe_no p_wip_recipe_vers p_wip_recipe_id Required Y N N N N N N N N N N N N N N N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Oracle Applications user name. Ending lot number. Warehouse code. Starting lot number. Work in process batch identifier. Location. Work in process recipe version. Work in process batch number. Item identifier. Ending sample number. Sample event identifier. Lot identifier. Work in process organization code. Ending item number.Fetch Sample Groups Fetch Sample Groups The Fetch Sample Groups API retrieves sample groups from the GMD_ SAMPLING_EVENTS and GMD_EVENT_SPEC_DISP tables. Starting item number. Starting sublot number. Ending sublot number. Starting sample number. Location identifier. Organization code. 3-22 Oracle Process Manufacturing Quality Management API User’s Guide . Disposition. Work in process formula line number. Work in process operation number. Work in process operation version. Customer order type. Work in process step number. Customer order identifier. Work in process routing version. Work in process step identifier. Work in process routing number.Fetch Sample Groups Parameter p_wip_formula_no p_wip_formula_ vers p_wip_formula_id Required N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Work in process formula number. Customer identifier. Work in process formula line type. Work in process routing identifier. Customer ship to location identifier. Customer. p_wip_formulaline_ N no p_wip_formulaline_ N id p_wip_formulaline_ N type p_wip_routing_no p_wip_routing_vers p_wip_routing_id p_wip_step_no p_wip_step_id p_wip_oprn_no p_wip_oprn_vers p_wip_oprn_id p_customer p_customer_id p_customer_org_id p_customer_ship_ to_location p_customer_ship_ to_location_id p_customer_order_ number p_customer_order_ id p_customer_order_ type N N N N N N N N N N N N N N N N Quality Management Outbound API Business Objects 3-23 . Customer ship to location. Customer order number. Work in process formula line identifier. Customer organization identifier. Work in process operation identifier. Work in process formula version. Work in process formula identifier. Supplier purchase order identifier. Stability study organization code. Variant identifier. Supplier purchase order line. Logical delete record indicator. Resources. Record type gmd_sampling_events_tab_ type. Supplier purchase order line identifier. Supplier purchase order number.Fetch Sample Groups Parameter p_customer_order_ line p_customer_order_ line_id p_supplier p_supplier_id p_supplier_site p_supplier_po_ number p_supplier_po_id p_supplier_po_line Required N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN OUT Description Customer order line. Starting last update date. Organization code. Stability study number. Supplier site. Stability study identifier. Time point identifier. Customer order line identifier. Supplier. Ending last update date. Instance identifier. Variant number. Supplier identifier. p_supplier_po_line_ N id p_delete_mark p_from_last_ update_date p_to_last_update_ date p_sg_orgn_code p_resources p_instance_id p_ss_id p_ss_orgn_code p_ss_no p_variant_id p_variant_no p_time_point_id x_sample_groups_ table N N N N N N N N N N N N Y 3-24 Oracle Process Manufacturing Quality Management API User’s Guide . For example. Item number. Current number of samples taken. Identifier of event triggering a sample to be taken. Sampling event ID. Parameter receipt_id receipt_number po_header_id po_number sampling_event_id original_spec_vr_id disposition sample_req_cnt sample_taken_cnt sampling_plan_id event_type_code event_id item_id item_no lot_id lot_no sublot_no whse_code location batch_id batch_no recipe_id recipe_number recipe_vers Description Receipt Identification. Sublot number. Recipe ID. Sampling plan ID. Batch number. Recipe version. Final result value. Item ID. Required number of samples to be taken.Fetch Sample Groups Parameter . Quality Management Outbound API Business Objects 3-25 . Batch ID.x_sample_groups_table (OUT) This is a row type parameter that returns the header information for the fetched sample groups. Receipt number. Lot ID. Warehouse code. Original specification validity rule ID. Purchase order header ID. Location. Recipe number. Lot number. Batch or Lot Expiration. Purchase order number. Identifies the event triggering a sample to be taken. Receipt line ID. Supplier lot number. Receipt line number. Supplier ID. Organization code. Text code. Order number. Order line number. Routing ID. Operation ID. Formula version. Purchase order line number. Customer name. Formula number. Order line ID. Order ID. Indicates if all samples for this specification are complete. Purchase order line ID. Formula line ID. 3-26 Oracle Process Manufacturing Quality Management API User’s Guide . Customer ID. Composite ID to evaluate. Formula line number. Sample identifier to evaluate. Organization ID. Charge.Fetch Sample Groups Parameter formula_id formula_no formula_vers formulaline_id formulaline_no routing_id oprn_id charge cust_id cust_name order_id order_number order_line_id order_line_no org_id organization_code supplier_id supplier_name po_line_id po_line_number receipt_line_id receipt_line_number supplier_lot_no complete_ind sample_id_to_evaluate composite_id_to_ evaluate text_code Description Formula ID. Supplier name. Step number. Sample event disposition. Supplier site name. Standard Who Column. Standard Who Column. Archive taken. Variant ID.x_sample_events_disp This is a row type parameter that returns the event disposition information for a fetched sample. Lot retest indicator. which are samples not marked for purge and not canceled. Parameter . Standard Who Column. Ship-to site name. Ship-to site ID. Number of active samples taken. Supplier site ID. Reserved taken. Time point ID. Standard Who Column. Recomposite idicator. Quality Management Outbound API Business Objects 3-27 . Step ID. Standard Who Column. Resources.Fetch Sample Groups Parameter creation_date created_by_id created_by_name last_updated_by_id last_updated_by_name last_update_date last_update_login supplier_site_id supplier_site_name ship_to_site_id ship_to_site_name step_id step_no lot_retest_ind recomposite_ind sample_active_cnt orgn_code resources instance_id time_point_id variant_id archived_taken reserved_taken x_sample_event_disps Description Standard Who Column. Standard Who Column. Organization code. Instance ID. 3-28 Oracle Process Manufacturing Quality Management API User’s Guide . Standard Who Column. Specification ID. Specification name. Specification validity rule ID. Standard Who Column. Standard Who Column. Standard Who Column. Specification used for lot attribute indicator.Fetch Sample Groups Parameter event_spec_disp_id spec_id spec_name spec_vers spec_vr_id disposition spec_used_for_lot_ attrib_ind delete_mark creation_datedate created_by_id created_by_name last_update_date last_updated_by_id last_updated_by_name last_update_login Description Event specification disposition ID. Standard Who Column. Specification version. Disposition. Standard Who Column. Standard Who Column. Logical delete record indicator. Following is the definition of Fetch Samples: Parameter p_user_name p_orgn_code p_from_sample_ no p_to_sample_no p_sample_id p_sampling_ event_id p_from_item_no p_to_item_no p_item_id p_from_lot_no p_to_lot_no p_sublot_no p_lot_id p_priority p_spec_name p_spec_vers p_spec_id p_source p_from_date_ drawn p_to_date_drawn p_from_ expiration_date Required Y N N N N N N N N N N N N N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Oracle Applications user name. Ending sample number. Starting expiration date. Quality Management Outbound API Business Objects 3-29 . Sample identifier. Starting lot number. Priority. Specification identifier. Specification version. Source. Ending item number. Lot identifier. Item identifier. Starting date drawn. Sublot number. Starting sample number. Starting item number. Ending date drawn. Sampling event identifier. Specification name.Fetch Samples Fetch Samples The Fetch Samples API retrieves sample groups from the GMD_SAMPLES and GMD_SAMPLE_SPEC_DISP tables. Ending lot number. Organization code. Fetch Samples Parameter p_to_expiration_ datedate p_source_whse p_source_location p_grade p_sample_ disposition p_storage_whse Required N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Ending expiration date. Source location. Source warehouse. Storage location. Work in process formula version. Storage warehouse. Work in process plan code. Location. Grade. Lot retest indicator. Work in process batch number. Sample. Work in process batch identifier. Quality lab organization code. External identifier. Work in process recipe number. Work in process recipe version. Warehouse code. Work in process formula line. Work in process formula number. Location identifier. Sample disposition. Work in process recipe identifier. Work in process formula identifier. p_storage_location N p_qc_lab_orgn_ code p_external_id p_sample p_lot_retest_ind p_whse_code p_location p_location_id p_wip_plant_code p_wip_batch_no p_wip_batch_id p_wip_recipe_no p_wip_recipe_ version p_wip_recipe_id p_wip_formula_ no p_wip_formula_ version p_wip_formula_id p_wip_ formulaline N N N N N N N N N N N N N N N N N 3-30 Oracle Process Manufacturing Quality Management API User’s Guide . Customer name. Work in process operation version. Customer order line. Work in process operation number. p_cust_order_line_ N id p_supplier p_supplier_id p_supplier_site_id p_supplier_po p_supplier_po_id N N N N N Quality Management Outbound API Business Objects 3-31 . Supplier identifier. Work in process line type. Supplier site identifier. Work in process batch step number. Supplier purchase order. Customer order line identifier. Work in process operation identifier. Work in process batch step identifier. Work in process routing number. Customer organization identifier. Work in process routing identifier. Supplier purchase order identifier.Fetch Samples Parameter p_wip_ formulaline_id p_wip_line_type p_wip_routing_no p_wip_routing_ vers p_wip_routing_id p_wip_batchstep_ no p_wip_batchstep_ id p_wip_oprn_no p_wip_oprn_vers p_wip_oprn_id p_cust_name p_cust_id p_cust_org_id p_cust_ship_to_ site_id p_cust_order p_cust_order_id p_cust_order_type p_cust_order_line Required N N N N N N N N N N N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Work in process formula line identifier. Supplier. Customer order type. Customer identifier. Customer order. Work in process routing version. Customer ship to site identifier. Customer order identifier. Variant identifier. Ending date received. Ending date required. Ending retrieval date. Ending last update date. Stability study organization code.Fetch Samples Parameter p_supplier_po_ line p_supplier_po_ line_id p_from_date_ received p_to_date_ received p_from_date_ required p_to_date_ required p_resources p_instance_id p_from_retrieval_ date p_to_retrieval_ date p_sample_type p_ss_id p_ss_orgn_code p_ss_no p_variant_id p_variant_no p_time_point_id p_from_last_ update_date p_to_last_update_ date p_retain_as p_delete_mark x_samples_table Required N N N N N N N N N N N N N N N N N N N N N Y In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN OUT Description Supplier purchase order line. Sample type. Instance identifier. Starting retrieval date. Variant number. Starting date received. Supplier purchase order line identifier. Retain as. 3-32 Oracle Process Manufacturing Quality Management API User’s Guide . Stability study number. Record type samples_table. Time point identifier. Starting date required. Starting last update date. Resources. Stability study identifier. Logical delete record indicator. Formula number. Item ID. Quality lab organization. Specification ID. Samples expiration date. Recipe ID.x_samples_table (OUT) This is a table type parameter that returns the header information for the fetched samples. Formula ID. Sublot number. Step ID. Plant code.Fetch Samples Parameter . Batch ID. Batch number. Recipe version. Recipe number. Sampling description. Step number. Quality Management Outbound API Business Objects 3-33 . Items lot number of sample. Warehouse location when a sample is taken from a warehouse. Item number. Parameter sampling_event_id step_no step_id sample_id sample_no sample_desc spec_id spec_name spec_vers qc_lab_orgn_code item_id item_no location expiration_date lot_id lot_no sublot_no batch_id plant_code batch_no recipe_id recipe_no recipe_version formula_id formula_no Description Sampling event ID. Specification version. Sample unique identifier. Lot ID. Sampling number. Specification name. Order type. Operation number. Sample quantity. Line type. Operation ID. 3-34 Oracle Process Manufacturing Quality Management API User’s Guide . Formula line number. Organization ID. Batch step number. Source. Customer name. Order line number. Order number. Sampler ID. Batch step ID. Charge. Formula line ID. Routing version. Operation version. Supplier number. Sample unit of measure. Routing number.Fetch Samples Parameter formula_vers formulaline_id formulaline_no line_type routing_id routing_no routing_vers oprn_id oprn_no oprn_vers batchstep_id batchstep_no charge cust_id cust_name order_id order_type order_number order_line_id order_line_number org_id org_name supplier_id supplier_no sample_qty sample_uom source sampler_id Description Formula version. Routing ID. Order line ID. Organization name. Order ID. Supplier ID. Customer ID. Purchase order number. Storage warehouse.Fetch Samples Parameter sampler date_drawn source_comment storage_whse storage_location external_id sample_approver_id inv_approver_id priority sample_inv_trans_ind supplier_site_id supplier_site whse_code orgn_code po_header_id po_number po_line_id po_line_number receipt_id receipt_no receipt_line_id receipt_line sample_disposition ship_to_site_id ship_to_location supplier_lot_no lot_retest_ind sample_instance Description Sampler. Supplier lot ID. Receipt ID. Source comments. Purchase order header identification. Organization code. Priority. Purchase order line number. External ID. Storage location. Quality Management Outbound API Business Objects 3-35 . Purchase order line identification. Warehouse code. Supplier site. Sample disposition Ship-to site ID. Date the sample was drawn. Supplier site ID. Receipt line ID. Inventory approver ID. Sample inventory transaction indicator. Receipt number. Sample approver ID. Lot retest indicator. Ship-to location. Current instance of the sample created. Receipt line. Sample type. Logical delete record indicator. Time point ID. Instance ID. Resources. Text code. Variant ID. Descriptive Flexfield Segment Category Descriptive Flexfield Segments Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Retain as. 3-36 Oracle Process Manufacturing Quality Management API User’s Guide . The date the same was received. Remaining quantity of the sample. Location where the sample quantity must be stored.Fetch Samples Parameter source_whse source_location date_received date_required resources instance_id retrieval_date sample_type time_point_id variant_id delete_mark text_code attribute_category attribute1-30 creation_date created_by created_by_name last_update_date last_updated_by last_updated_by_name last_update_login retain_as remaining_qty Description Warehouse where the sample quantity must be stored. The date the same was required. Retrieval date for the sample. Planned resource. Starting last update date. Evaluation indicator. p_qc_lab_orgn_code N p_evaluation_ind p_tester p_tester_id p_test_provider_id p_delete_mark p_from_last_ update_date p_to_last_update_ date p_planned_resource p_planned_ resource_instance p_actual_resource p_actual_resource_ instance N N N N N N N N N N N Quality Management Outbound API Business Objects 3-37 . Test identifier. Sample disposition. Ending last update date. In specification indicator. Ending sample number. Starting sample number. Logical delete record indicator. Actual resource instance. Starting result date. Planned resource instance. Following is the definition of Fetch Results: Field p_user_name p_orgn_code p_from_sample_no p_to_sample_no p_sample_id p_from_result_date p_to_result_date p_sample_ disposition p_in_spec_ind Required Y N N N N N N N N In/Out IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN IN Description Oracle Applications user name. Test provider identifier. Tester. Lab organization code. Ending result date.Fetch Results Fetch Results The Fetch Results API retrieves sample groups from the GMD_RESULTS table. Sample identifier. Organization code. Actual resource. Identifies the sample the test results is recorded. Number of times test was performed on the same sample. Reserve sample identifier. Test performed the results are recorded. 3-38 Oracle Process Manufacturing Quality Management API User’s Guide . Date result occurred. Item ID of solvent used in the testing procedure.x_results_table (OUT) This is a table type parameter that returns the fetched sample results. Ending test by date. Sample number. Solvent sublot number. Starting test by date. Quality lab organization code where the test was performed. User ID of person who performed the test. Test code. Item number of solvent used in the testing procedure. Results unique identifier. Parameter .Fetch Results Field p_from_planned_ result_date p_to_planned_ result_date p_from_test_by_ date p_to_test_by_date p_reserve_sample_ id x_results_table Required N N N N N Y In/Out IN IN IN IN IN OUT Description Starting planned result date. Record type results table. Numeric result value. Parameter update_instance_id result_id sample_id sample_no test_id test_code test_replicate_cnt qc_lab_orgn_code result_value_num result_date test_kit_item_id test_kit_item_no test_kit_lot_no test_kit_sublot_no tester Description Used to store e-signature instance identification. Ending planned result date. Solvent lot number. Evaluation indicator. planned_result_date test_by_date delete_mark text_code attribute_category attribute1-30 creation_date created_by created_by_name last_updated_by last_updated_by_name last_update_date last_update_login Planned result date. Test by date. Test provider ID. Descriptive Flexfield Segment Category Descriptive Flexfield Segments Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Standard Who Column Quality Management Outbound API Business Objects 3-39 . Test provider code. Text code. Sequence. Actual resource. actual_resource_instance Actual resource instance.Fetch Results Parameter tester_id test_provider_id ad_hoc_print_on_coa_ ind seq result_value_char test_provider_code assay_retest in_spec_ind disposition evaluation_ind planned_resource planned_resource_ instance actual_resource Description Tester ID. Logical delete record indicator. Assay retest. Ad hoc printing on Certificate of Analysis indicator. Planned resource instance. Character result value. In specification indicator. Planned resource. Disposition. Parent result ID. Test unit of measure. Test method ID. 3-40 Oracle Process Manufacturing Quality Management API User’s Guide . Reserve sample indicator.Fetch Results Parameter test_qty test_uom reserve_sample_id consumed_qty parent_result_id test_method_id Description Test quantity. Consumed quantity. Statistical mean. Ending item number. Composite result disposition. Starting item number. Sampling event identifier. Parameter composite_result_id test_id mean mode_num mode_char Description Composite results. Logical delete record indicator.Fetch Composite Results Fetch Composite Results The Fetch Composite Results API retrieves composite results from the GMD_ COMPOSITE_RESULTS. gmd_ composite_spec_disp. and GMD_ COMPOSITE_RESULT_ASSOC tables. Record type composite_results_table. GMD_COMPOSITE_SPEC_DISP. Following is the definition of Fetch Composite Results: Parameter p_user_name p_sampling_event_id p_composite_result_ disposition p_from_item_no p_to_item_no p_from_lot_id p_to_lot_id p_from_last_update_ date p_to_last_update_date p_delete_mark x_composite_results_ table Required Y N N N N N N N N N Y In/Out IN IN IN IN IN IN IN IN IN IN OUT Description Oracle Applications user name. and gmd_composite_result_assoc. Ending last update date. Test Identifier. Mode number.x_composite_results_tbl (OUT) This is a row type parameter fetched from gmd_composite_results. Starting last update date. Quality Management Outbound API Business Objects 3-41 . Ending lot identifier. Starting lot identifier. Parameter . Mode character. Sample total. Text code. Descriptive Flexfield Segments. Workflow response. 3-42 Oracle Process Manufacturing Quality Management API User’s Guide .Fetch Composite Results Parameter low_num high_num range standard_deviation sample_total sample_cnt_used non_validated_result high_char low_char median_char median_num composite_spec_disp_id in_spec_ind wf_response value_in_report_ precision disposition item_id item_no lot_id lot_no sublot_no delete_mark text_code attribute_category attribute1-30 creation_date created_by Description Lower value. Median character value. Item ID. Composite specification indicator. Higher numeric range. Standard Who Column. Report precision. Statistics standard deviation. Non-validated result. Lot number. Sublot number. Composite specification disposition identification. Highest character value. Lot ID. Item number. Median numeric value. Disposition. Sample count used. Logical delete record indicator. Lowest character value. Statistical range. Descriptive Flexfield Segment Category. Standard Who Column. Parent composite result ID. Standard Who Column. Quality Management Outbound API Business Objects 3-43 . Standard Who Column.Fetch Composite Results Parameter created_by_name last_update_date last_updated_by last_updated_by_name last_update_login parent_composite_ result_id Description Standard Who Column. Standard Who Column. Standard Who Column. Fetch Composite Results 3-44 Oracle Process Manufacturing Quality Management API User’s Guide . A Messages and Errors This appendix covers the following topics: ■ Handling Messages Interpreting Error Conditions Understanding Error Messages ■ ■ Messages and Errors A-1 . Programs calling APIs can then get the messages from this list.Gets a message from the API message list Count_Msg .Returns the number of messages in the API message list Delete .Gets the last message in the API message list Previous . Neither API developers nor API callers can access this list except by calling the API message utility routines.Gets the first message in the API message list Next . This procedure operates in the following modes: ■ First .Get.Initializes the API message list Add . The structure of the message list is not public. API callers use the procedure FND_ MSG_PUB.SET_NAME and FND_MESSAGE.Returns the number of messages in the API message list.Gets the next message in the API message list Last .SET_TOKEN to set the message name and tokens on the message dictionary stack. Messages are stored in an encoded format to let API callers find out message names using the standard functions provided by the message dictionary.Deletes one or more messages from the API message list Reset .Add to fetch the messages off the message dictionary stack and add it to the API message list. To get a message from the API message list. To add a message to the API message list. and process them. then it also returns the message data ■ ■ ■ ■ ■ ■ Refer to the Oracle Applications Coding Standards guide for complete documentation of these functions and procedures for usage information. or writing them to database tables or log files if calling the API from a batch process. use the regular message dictionary procedures FND_MESSAGE.Handling Messages Handling Messages APIs put result messages into a message list.Resets the index used in getting messages Count_And_Get . Then call FND_ MSG_PUB. This can be by issuing them to the user if calling the API from an interactive process.Gets the previous message in the API message list ■ ■ ■ A-2 Oracle Process Manufacturing Quality Management API User’s Guide .Adds a message to the API message list Get . If this number is one. The following utility functions are defined in the FND_MSG_PUB package: ■ Initialize . Understanding Error Messages ■ Specific - Gets a specific message from the API message list Interpreting Error Conditions The parameter x_return_status indicates whether the API was successful or failed. The values are as follows: ■ S for success E for error U for unknown or unexpected status Q for could not calculate the total input and output quantities ■ ■ ■ Understanding Error Messages Error messages are output to the stored procedure message file, and can be monitored through the return x_msg_count. With the x_return_status, this can be used to monitor the success or failure of the procedure call. Displaying Errors in Languages Other than English Language translation of error messages is determined by the environment variable NLS_LANGUAGE. If the message is not found in the required language, then the message is retrieved in US English. The following is a complete list of the Quality Management API error messages: Error Messages Supplier validity rule exists Error &ERROR occurred in Package &PACKAGE at &POSITION API failure while processing record for table &l_ table_name identified by column & column_ name of value &l_key_value Batch not found Batch step not found Customer validity rule exists Customer not found Message Code GMD_SUPP_VR_EXIST GMD_API_ERROR GMD_API_RECORD_IDENTIFIER GMD_BATCH_NOT_FOUND GMD_BATCH_STEP_NOT_FOUND GMD_CUST_VR_EXIST' GMD_CUSTOMER_NOT_FOUND Messages and Errors A-3 Understanding Error Messages Error Messages Customer Required Event Spec disp id is Required. Event Spec Record not found for event_spec_ disp_id &event_disp Failure to delete record in table %l_table_name identified by column %l_column_name of value %l_key_value Failure to fetch record in table %l_table_name identified by column %l_column_name of value %l_key_value Failure to insert record in table %l_table_name identified by column %l_column_name of value %l_key_value Formula line not found Formula not found GMD_INVALID_OPERATION Absolute experimental Error Value cannot be greater than &MAX_VAL INVALID test type &test_type for test values record Invalid user Item lot not found Item sublot not found Failure to lock record in table %l_table_name identified by column %l_column_name of value %l_key_value Location not found No data has been found while retrieving the row from the table &TABLE_NAME. No keys have been specified to identify the row in the table &TABLE_NAME. Message Code GMD_CUSTOMER_REQD GMD_EVENT_SPEC_DISP_NULL GMD_EVENT_SPEC_NOTFOUND GMD_FAILED_TO_DELETE_ROW GMD_FAILED_TO_FETCH_ROW GMD_FAILED_TO_INSERT_ROW GMD_FORMULA_LINE_NOT_ FOUND GMD_FORMULA_NOT_FOUND GMD_INVALID_OPERATION GMD_INVALID_SPEC_VAL_NUM GMD_INVALID_TEST_TYPE GMD_INVALID_USER_NAME GMD_ITEM_LOT_NOT_FOUND GMD_ITEM_SUBLOT_NOT_FOUND GMD_LOCKING_FAILURE GMD_LOCT_NOT_FOUND GMD_NO_DATA_FOUND GMD_NO_KEYS A-4 Oracle Process Manufacturing Quality Management API User’s Guide Understanding Error Messages Error Messages Event specification record does not exist for spec_id &spec_id and sampling_event &samp_ event For WIP sample, at least Batch No or Recipe ID is required Order line not found Order not found Organization not found Orgn Code not found Purchase Order Line not found PO not found QC Lab orgn code not found QC Lab orgn code required Recipe not found Record is already delete marked - see table %l_ table_name identified by column %l_column_ name of value %l_key_value Record locked Report precision cannot be greater then Display Precision Could not find matching result char value. Result record not found for sample_id &sample_ id, test_id &test_id and test_replicate_cnt value &test_rep_cnt Result value char required for Results Result value num required for Results Routing not found Routing Step not found Invalid sample disposition Sample already exists Message Code GMD_NO_SPEC_EVENT_FOUND GMD_NO_WIP_PARAM GMD_ORDER_LINE_NOT_FOUND GMD_ORDER_NOT_FOUND GMD_ORG_NOT_FOUND' GMD_ORGN_CODE_NOT_FOUND GMD_PO_LINE_NOT_FOUND GMD_PO_NOT_FOUND' GMD_QC_LAB_ORGN_CODE_NOT_ FOUND GMD_QC_LAB_ORGN_CODE_REQD GMD_RECIPE_NOT_FOUND GMD_RECORD_DELETE_MARKED GMD_RECORD_LOCKED GMD_REP_GRTR_DIS_PRCSN GMD_RESULT_CHAR_NOTFOUND GMD_RESULT_NOT_FOUND GMD_RESULT_VAL_CHAR_REQD GMD_RESULT_VAL_NUM_REQD GMD_ROUTING_NOT_FOUND GMD_ROUTING_STEP_NOT_FOUND GMD_SAMPLE_DISPOSITION_ INVALID GMD_SAMPLE_EXIST Messages and Errors A-5 Specification Owner Organization Code required. Specification Item required. Spec status prevents updates Specification status &STATUS not found. Specification Status required. SPEC_ID must be supplied Specification Item not found. Specification Owner not found. Spec Test ID required Message Code GMD_SAMPLE_NOT_FOUND GMD_SAMPLE_NUMBER_REQD GMD_SAMPLE_ORGN_CODE_REQD GMD_SAMPLE_QTY_REQD GMD_SAMPLE_SOURCE_INVALID GMD_SAMPLE_UOM_REQD GMD_SAMPLING_EVENT_MISSING GMD_SAMPLING_EVENT_NOT_ FOUND GMD_SHIP_TO_NOT_FOUND GMD_SOME_REF_TESTS_MISSING GMD_SPEC_ERROR_REG_NOT_APPL GMD_SPEC_ID_REQUIRED GMD_SPEC_ITEM_NOT_FOUND GMD_SPEC_ITEM_REQD GMD_SPEC_NAME_REQD GMD_SPEC_NOT_FOUND GMD_SPEC_ORGN_NOT_FOUND GMD_SPEC_ORGN_REQD GMD_SPEC_OWNER_NOT_FOUND GMD_SPEC_OWNER_REQD GMD_SPEC_STATUS_BLOCKS_ UPDATE GMD_SPEC_STATUS_NOT_FOUND GMD_SPEC_STATUS_REQD GMD_SPEC_TEST_ID_REQUIRED A-6 Oracle Process Manufacturing Quality Management API User’s Guide . Could not find matching Specification Record Specification Owner Organization &ORGN not found.Understanding Error Messages Error Messages Sample record does not exists for sample_no &sample_no and orgn_code &orgn_code Sample number required Sample requires a Orgn Code to be defined Sample quantity required Invalid source &source defined for sample Sample UOM required Sampling event missing Sampling event not found Ship to not found Reference test(s) used in the expression test is missing in the specification Cannot define Specification error region. Specification Name required. Specification Owner required. Specification Version required There is an error in effectivity date of spec validity rule SPEC_VR_ID must be supplied Effectivity start date is required for Validity rule.Understanding Error Messages Error Messages Test Sequence &SEQ already exists on the current specification. Supplier not found Supplier required Parameter : Test_id Table is empty. Insufficient data for WIP Validity Rule WIP validity rule exists Message Code GMD_SPEC_TEST_SEQ_EXIST GMD_SPEC_VERS_EXIST GMD_SPEC_VERS_INVALID GMD_SPEC_VERS_REQD GMD_SPEC_VR_EFF_DATE_ERROR GMD_SPEC_VR_ID_REQUIRED GMD_SPEC_VR_START_DATE_REQD GMD_SPEC_VR_STATUS_HIGHER GMD_SPEC_WHSE_NOT_FOUND GMD_SUPPLIER_NOT_FOUND GMD_SUPPLIER_REQD GMD_TEST_ID_TABLE_EMPTY GMD_TEST_NOT_FOUND GMD_USER_ORGN_NO_ACCESS GMD_WHSE_NOT_FOUND GMD_WIP_VR_ALL_NULL GMD_WIP_VR_EXIST Messages and Errors A-7 . Test not found User &OWNER does not have access to Organization &ORGN. Specification warehouse not found. Warehouse not found. Specification &SPEC Version &VERS exists. Specification Version must be a whole positive number. Specification Validity is higher. Understanding Error Messages A-8 Oracle Process Manufacturing Quality Management API User’s Guide . 3-9 GMD_CUSTOMER_TESTS. 3-41 GMD_COMPOSITE_RESULTS. 1-6 message list initialization. 1-4 FND_PUB_MSG. 1-6 GMD_COMPOSITE_RESULT_ASSOC. 1-2. 3-41 P p_api_version. 3-22 GMD_INVENTORY_SPEC_VRS. 3-1 Fetch Tests. 3-9 GMD_SUPPLIER_SPEC_VRS. 3-29 GMD_SAMPLES. 1-6 Index-1 . 3-9 GMD_TEST_METHODS. 3-5 GMD_RESULTS. 1-1 GMD_CUSTOMER_SPEC_VRS. 3-1 Fetch Sample Groups. 1-2 input structure. 3-1 FND_API. 1-4 formula information. 3-1 Fetch Validity Rules. 1-6 FND_MESSAGE. 1-6 G general input structure. 1-6 message list. 3-22 GMD_SPEC_TESTS. 3-37 GMD_SAMPLE_SPEC_DISP. 3-5 GMD_WIP_SPEC_VRS. 3-1 Fetch Samples.G_FALSE. 3-29 GMD_SAMPLING_EVENTS. 1-6 M message encoding. 3-9 GMD_SPECIFICATIONS. 3-5 GMD_EVENT_SPEC_DISP. 1-6 p_init_msg_list. general. 3-9 C call pass/fail status. importing. 1-6 E error.Index A API. 3-1 Fetch Results. 3-1 Fetch Specifications. 3-1 Fetch Test Methods. A-3 F Fetch Composite Results. 3-9 GMD_QC_TEST_VALUES. 1-4 FND_API. 1-2 I importing formula information. 1-6 p_commit. 3-41 GMD_COMPOSITE_SPEC_DISP. 1-6 parameters. specifying number of messages added. 3-2 GMD_TEST_QC_TESTS. 1-2. success. 1-6 x_msg_data. 1-2. call. validation. 1-6 processing standard message functions. 1-6 S standard message function processing. 1-6 PL/SQL. 1-2. 1-2. A-3 support policy. 1-3 1-6 U unexpected.pass/fail status. A-3 unknown. 1-6 X x_msg_count. 1-6 Index-2 . 1-6 x_return_status. A-3 V version compatibility.