Está en la página 1de 110

Oracle Process Manufacturing

Quality Management API Users Guide Release 11i


Part No. B10350-02

January 2005

Oracle Process Manufacturing Quality Management API Users 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 Users 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

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 Users 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 appsdoc@us.oracle.com 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.

vi

Preface
Audience for This Guide
Welcome to Release 11i of the Oracle Process Manufacturing Quality Management API Users Guide. This guide assumes you have a working knowledge of the following:

The principles and customary practices of your business area. Oracle Process Manufacturing (OPM) If you have never used Oracle Process Manufacturing Quality Management APIs, Oracle suggests you attend one or more of the Oracle Process Manufacturing training classes available through Oracle University.

The Oracle Applications graphical user interface. To learn more about the Oracle Applications graphical user interface, read the Oracle Applications Users Guide.

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

How To Use This Guide


This guide contains the information you need to understand and use Oracle Process Manufacturing Quality Management APIs.

Chapter 1 describes the Application Program Interfaces (APIs) that support external interfaces to the OPM Quality Management tables including: packages supplied, Quality Management API bill of material, wrapper function, stored procedures, and validating the user name. Chapter 2 provides the relationships between the Quality Management API table structure and its entities. Discusses Quality Management API business objects, the entity relationship diagram, business object interface design, 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. Discusses Quality Management API outbound business objects, the entity relationship diagram, business object interface design, creating a new formula and importing formula data structures.

vii

Appendix A provides message handling, the interpretation of error conditions, and an understanding of error messages.

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

Accessibility of Code Examples in Documentation


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

Other Information Sources


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

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

Online Help - The new features section in the HTML help describes new features in 11i. This information is updated for each new release of Oracle Process Manufacturing. The new features section also includes information about any features that were not yet available when this guide was printed. For example, if your administrator has installed software from a mini-packs an upgrade, this document describes the new features. Online help patches are available on MetaLink.

viii

11i Features Matrix - This document lists new features available by patch and identifies any associated new documentation. The new features matrix document is available on MetaLink. Readme File - Refer to the readme file for patches that you have installed to learn about new documentation or documentation patches that you can download.

Related Users Guides


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

Guides Related to All Products


Oracle Applications Users Guide
This guide explains how to enter data, query, run reports, and navigate using the graphical user interface (GUI) available with this release of Oracle Process Manufacturing Quality Management APIs (and any other Oracle Applications products). This guide also includes information on setting user profiles, as well as running and reviewing reports and concurrent processes. You can access this users guide online by choosingGetting Started with Oracle Applications from any Oracle Applications help file.

User Guides Related to This Product


Accounting Setup Users Guide
The OPM Accounting Setup application is where users set up global accounting attributes about the way financial data will be collected by OPM. These attributes include such things as account keys, financial calendars, and account segments. Since OPM is closely integrated with Oracle General Ledger (GL), much of the

ix

attributes are defined in the Oracle GL instead of OPM, and therefore, the windows are display only within OPM. The Oracle Process Manufacturing Accounting Setup Users Guide describes how to setup and use this application.

Cost Management Users Guide


The OPM Cost Management application is used by cost accountants to capture and review the manufacturing costs incurred in their process manufacturing businesses. The Oracle Process Manufacturing Cost Management Users Guide describes how to setup and use this application.

Manufacturing Accounting Controller Users Guide


The Manufacturing Accounting Controller application is where users define the impact of manufacturing events on financials. For example, event RCPT (Inventory Receipts) results in a debit to inventory, a credit to accrued accounts payable, a debit or a credit to purchase price variance, 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, however, they may also be adjusted per your business needs. The Oracle Process Manufacturing Manufacturing Accounting Controller Users Guide describes how to setup and use this application.

Oracle Financials Integration Users Guide


Since OPM is closely integrated with Oracle General Ledger, financial data that is collected about the manufacturing processes must be transferred to the Oracle Financials applications. The OPM Oracle Financials Integration application is where users define how that data is transferred. For example, users define whether data is transferred real time or batched and transferred at intervals. The Oracle Process Manufacturing Oracle Financials Integration Users Guide describes how to setup and use this application.

Inventory Management Users Guide


The OPM Inventory Management application is where data about the items purchased for, consumed during, and created as a result of the manufacturing process are tracked. The Oracle Process Manufacturing Inventory Management Users Guide includes information to help you effectively work with the Oracle Process Manufacturing Inventory application.

Physical Inventory Users Guide


Performing physical inventory count is the most accurate way to get an accounting of all material quantities purchased, manufactured, and sold, and update your onhand quantities accordingly. The OPM Physical Inventory application automates and enables the physical inventory process. The Oracle Process Manufacturing Physical Inventory Users Guide describes how to setup and use this application.

Order Fulfillment Users Guide


The OPM Order Fulfillment application automates sales order entry to reduce order cycle time. Order Fulfillment enables order entry personnel to inform customers of scheduled delivery dates and pricing. The Oracle Process Manufacturing Order Fulfillment Users Guide describes how to setup and use this application.

Purchase Management Users Guide


OPM Purchase Management and Oracle Purchasing combine to provide an integrated solution for Process Manufacturing. Purchase orders are entered in Oracle Purchasing and received in OPM. Then, the receipts entered in OPM are sent to Oracle Purchasing. The Oracle Process Manufacturing Purchase Management Users Guide describes how to setup and use this integrated solution.

Using Oracle Order Management with Process Inventory Guide


Oracle Process Manufacturing and Oracle Order Management combine to provide an integrated solution for process manufacturers. The manufacturing process is tracked and handled within Oracle Process Manufacturing, while sales orders are taken and tracked in Oracle Order Management. Process attributes, such as dual UOM and lot control, are enabled depending on the inventory organization for the item on the sales order. Order Management accepts orders entered through Oracle Customer Relationship Management (CRM). Within CRM, orders can originate from TeleSales, Sales Online, and iStore, and are booked in Order Management, making the CRM suite of products available to Process customers, through Order Management. The Oracle Order Management Users Guide and Using Oracle Order Management with Process Inventory Guide describes how to setup and use this integrated solution.

Process Execution Users Guide


The OPM Process Execution application lets you track firm planned orders and production batches from incoming materials through finished goods. Seamlessly integrated to the Product Development application, Process Execution lets you convert firm planned orders to single or multiple production batches, allocate

xi

ingredients, record actual ingredient usage, and then complete and close production batches. 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. The OPM Process Execution Users Guide presents overviews of the tasks and responsibilities for the Production Supervisor and the Production Operator. It provides prerequisite setup in other applications, and details the windows, features, and functionality of the OPM Process Execution application.

Integration with Advanced Planning and Scheduling Users 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. The integration provides for constraint-based planning, performance management, materials management by exception, mixed mode manufacturing that enables you to choose the best method to produce each of your products, and combine all of these methods within the same plant/company. The Oracle Process Manufacturing Integration with Advanced Planning and Scheduling Users Guide describes how to setup and use this application.

MPS/MRP and Forecasting Users 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. The Master Production Scheduling (MPS) application lets you shorten that view to a much narrower and immediate time horizon, and see the immediate effects of demand and supply actions. The Oracle Process Manufacturing MPS/MRP and Forecasting Users Guide describes how to setup and use this application.

Capacity Planning Users Guide


The OPM Capacity Planning User's Guide describes the setup required to use OPM with the Oracle Applications Advanced Supply Chain Planning solutions. In addition, Resource setup, used by the OPM Production Execution and New Product Development applications, is also described.

Using Oracle Process Manufacturing with Oracle Manufacturing Scheduling


Oracle Process Manufacturing integrates with Oracle Manufacturing Scheduling to manage and utilize resources and materials. Through the Process Manufacturing application, you set up manufacturing, inventory, procurement and sales order data. Through the Manufacturing Scheduling application, you can optimize the

xii

schedule based on resource and component constraints and user predefined priorities. Using different optimization objectives, you can tailor Manufacturing Scheduling to meet your needs. Using Oracle Manufacturing Scheduling helps you improve productivity and efficiency on your shop floor. By optimally scheduling shop floor jobs, and being able to quickly react to unplanned constraints, you can lower manufacturing costs, increase resource utilization and efficiency, and increase customer satisfaction through improved on-time delivery. The Using Oracle Process Manufacturing with Oracle Manufacturing Scheduling Users Guide describes how to setup and use this integrated solution.

Product Development Users Guide


The Oracle Process Manufacturing Product Development application provides features to manage formula and laboratory work within the process manufacturing operation. It lets you manage multiple laboratory organizations and support varying product lines throughout the organization. You can characterize and simulate the technical properties of ingredients and their effects on formulas. You can optimize formulations before beginning expensive laboratory test batches. Product Development coordinates each development function and enables a rapid, enterprise-wide implementation of new products in your plants. The Oracle Process Manufacturing Product Development Users Guide describes how to setup and use this application.

Quality Management Users Guide


The Oracle Process Manufacturing Quality Management application provides features to test material sampled from inventory, production, or receipts from external suppliers. The application lets you enter specifications and control their use throughout the enterprise. Customized workflows and electronic record keeping automate plans for sampling, testing, and result processing. You can compare specifications to assist in regrading items, and match customer specifications. Aggregate test results and print statistical assessments on quality certificates. Several preformatted reports and inquiries help manage quality testing and reporting. The Oracle Process Manufacturing Quality Management Users Guide describes how to set up and use this application.

Regulatory Management Users Guide


The Oracle Process Manufacturing Regulatory Management application generates the Material Safety Data Sheets (MSDSs) required by authorities to accompany hazardous materials during shipping. You can create MSDSs from OPM Formula

xiii

Management with Regulatory or Production effectivities. The Oracle Process Manufacturing Regulatory Management Users Guide describes how to setup and use this application.

Implementation Guide
The Oracle Process Manufacturing Implementation Guide offers information on setup. That is, those tasks you must complete following the initial installation of the Oracle Process Manufacturing software. Any tasks that must be completed in order to use the system out-of-the-box are included in this manual.

System Administration Users Guide


Much of the System Administration duties are performed at the Oracle Applications level, and are therefore described in the Oracle Applications System Administrator's Guide. The Oracle Process Manufacturing System Administration Users Guide provides information on the few tasks that are specific to OPM. It offers information on performing OPM file purge and archive, and maintaining such things as responsibilities, units of measure, and organizations.

API Users Guides


Public Application Programming Interfaces (APIs) are available for use with different areas of the Oracle Process Manufacturing application. APIs make it possible to pass information into and out of the application, bypassing the user interface. Use of these APIs is documented in individual manuals such as the Oracle Process Manufacturing Inventory API Users Guide, Oracle Process Manufacturing Process Execution API Users Guide, Oracle Process Manufacturing Product Development Formula API User's Guide, Oracle Process Manufacturing Product Development Recipe API User's Guide, Oracle Process Manufacturing Quality Management API User's Guide, and the Oracle Process Manufacturing Cost Management API User's Guide. Additional API Users Guides are periodically added as additional public APIs are made available.

Installation and System Administration


Oracle Applications Concepts
This guide provides an introduction to the concepts, features, technology stack, architecture, and terminology for Oracle Applications Release 11i. It provides a useful first book to read before an installation of Oracle Applications. This guide

xiv

also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS), languages and character sets, and Self-Service Web Applications.

Installing Oracle Applications


This guide provides instructions for managing the installation of Oracle Applications products. In Release 11i, much of the installation process is handled using Oracle Rapid Install, which minimizes the time to install Oracle Applications, the Oracle8 technology stack, and the Oracle8i Server technology stack by automating many of the required steps. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your installation. You should use this guide in conjunction with individual product users guides and implementation guides.

Upgrading Oracle Applications


Refer to this guide if you are upgrading your Oracle Applications Release 10.7 or Release 11.0 products to Release 11i. This guide describes the upgrade process and lists database and product-specific upgrade tasks. You must be either at Release 10.7 (NCA, SmartClient, or character mode) or Release 11.0, to upgrade to Release 11i. You cannot upgrade to Release 11i directly from releases prior to 10.7.

Maintaining Oracle Applications


Use this guide to help you run the various AD utilities, such as AutoUpgrade, AutoPatch, AD Administration, AD Controller, AD Relink, License Manager, and others. It contains how-to steps, screenshots, and other information that you need to run the AD utilities. This guide also provides information on maintaining the Oracle applications file system and database.

Oracle Applications System Administrators Guide


This guide provides planning and reference information for the Oracle Applications System Administrator. It contains information on how to define security, customize menus and online help, and manage concurrent processing.

Oracle Alert Users Guide


This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data.

xv

Oracle Applications Developers Guide


This guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards for Forms-Based Products. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications.

Oracle Applications User Interface Standards for Forms-Based Products


This guide contains the user interface (UI) standards followed by the Oracle Applications development staff. 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.

Other Implementation Documentation


Oracle Applications Product Update Notes
Use this guide as a reference for upgrading an installation of Oracle Applications. It provides a history of the changes to individual Oracle Applications products between Release 11.0 and Release 11i. It includes new features, enhancements, and changes made to database objects, profile options, and seed data for this interval.

Multiple Reporting Currencies in Oracle Applications


If you use the Multiple Reporting Currencies feature to record transactions in more than one currency, use this manual before implementing Oracle Process Manufacturing Quality Management APIs. This manual details additional steps and setup considerations for implementing Oracle Process Manufacturing Quality Management APIs with this feature.

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, so you can define and support different organization structures when running a single installation of Oracle Process Manufacturing.

xvi

Oracle Workflow Guide


This guide explains how to define new workflow business processes as well as customize existing Oracle Applications-embedded workflow processes.You also use this guide to complete the setup steps necessary for any Oracle Applications product that includes workflow-enabled processes.

Oracle Applications Flexfields Guide


This guide provides flexfields planning, setup and reference information for the Oracle Process Manufacturing Quality Management APIs implementation team, as well as for users responsible for the ongoing maintenance of Oracle Applications product data. This manual also provides information on creating custom reports on flexfields data.

Oracle eTechnical Reference Manuals


Each eTechnical Reference Manual (eTRM) contains database diagrams and a detailed description of database tables, forms, reports, and programs for a specific Oracle Applications product. This information helps you convert data from your existing applications, integrate Oracle Applications data with non-Oracle applications, and write custom reports for Oracle Applications products. 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 documentation includes APIs and open interfaces found in Oracle Manufacturing.

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. This documentation includes APIs and open interfaces found in Oracle Order Management Suite.

Oracle Applications Message Reference Manual


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

xvii

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. These courses are organized into functional learning paths, so you take only those courses appropriate to your job or area of responsibility. You have a choice of educational environments. You can attend courses offered by Oracle University at any one of our many Education Centers, you can arrange for our trainers to teach at your facility, or you can use Oracle Learning Network (OLN), Oracle University's online education utility. In addition, Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. For example, you may want to use your organization structure, terminology, and data as examples in a customized training session delivered at your own facility.

Support
From on-site support to central support, our team of experienced professionals provides the help and information you need to keep Oracle Process Manufacturing Quality Management APIs working for you. This team includes your Technical Representative, Account Manager, and Oracles large staff of consultants and support specialists with expertise in your business area, managing an Oracle8i server, and your hardware and software environment.

Do Not Use Database Tools to Modify Oracle Applications Data


Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data Browser, database triggers, or any other tool to modify Oracle Applications data unless otherwise instructed. Oracle provides powerful tools you can use to create, store, change, retrieve, and maintain information in an Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your data and you lose the ability to audit changes to your data. Because Oracle Applications tables are interrelated, any change you make using Oracle Applications can update many tables at once. But when you modify Oracle Applications data using anything other than Oracle Applications, you may change a row in one table without making corresponding changes in related tables. If your

xviii

tables get out of synchronization with each other, you risk retrieving erroneous information and you risk unpredictable results throughout Oracle Applications. When you use Oracle Applications to modify your data, Oracle Applications automatically checks that your changes are valid. Oracle Applications also keeps track of who changes information. If you enter information into database tables using database tools, you may store invalid information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes.

About Oracle
Oracle Corporation develops and markets an integrated line of software products for database management, applications development, decision support, and office automation, as well as Oracle Applications, an integrated suite of more than 160 software modules for financial management, supply chain management, manufacturing, project systems, human resources and customer relationship management. Oracle products are available for mainframes, minicomputers, personal computers, network computers and personal digital assistants, allowing organizations to integrate different computers, different operating systems, different networks, and even different database management systems, into a single, unified computing and information resource. Oracle is the worlds leading supplier of software for information management, and the worlds second largest software company. Oracle offers its database, tools, and applications products, along with related consulting, education, and support services, in over 145 countries around the world.

Your Feedback
Thank you for using Oracle Process Manufacturing Quality Management APIs and this users guide. Oracle values your comments and feedback. At the end of this guide is a Readers Comment Form you can use to explain what you like or dislike about Oracle Process Manufacturing Quality Management APIs or this users guide. Mail your comments to the following address or call us directly at (650) 506-7000. Oracle Applications Documentation Manager Oracle Corporation 500 Oracle Parkway

xix

Redwood Shores, CA 94065 U.S.A. Or, send electronic mail to appsdoc_us@oracle.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

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. When you import this information, you can include all pertinent information using a friendly tool that does not have cryptic IDs and system specific information. Quality Management APIs can process virtually all information. The interface ensures that your imported information contains the same detail as those you enter manually on the OPM Quality Management window.

What Is In This Document


This document describes the basic business needs, major features, architecture, and components for the Insert, Update, and Delete features for the Quality Management APIs. The application is divided into application-specific objects that let you link OPM functionality into your own programs. The interfaces can make use of the standard functionality and logic implemented in the Quality Management application. Quality Management APIs are written in PL/SQL that can be called by your own programs. To make use of these APIs, code the wrapper function that passes the appropriate parameters to the APIs. Your program is also responsible for connecting to a database before calling an API function, and disconnecting from the database upon return. You can also write to log files before calling and after returning from a function. If there is a problem during execution of a call, 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 Users Guide

Introducing the Quality Management API

Quality Management API Support Policy


Quality Management APIs are supported by Oracle. This means:

Oracle provides objects and libraries needed to use to the APIs and the documentation for their use. Oracle ensures that the APIs function as designed. Oracle does not support customer generated programs that use the APIs.

Quality Management API Introduction

1-3

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. This is used by the stored procedure to check valid API version number and also contains constant variables such as TRUE and FALSE. FND_MESSAGE - the standard Oracle Applications messaging function. This is used by the stored procedure to report status and error handling. FND_PUB_MSG - the standard Oracle Applications message retrieval function, used to interrogate the procedure messages.

These packages are installed as part of the current release. Refer to the Oracle Applications Coding Standards manual for additional details.

Quality Management API Bill of Materials


The following are the packages and files that are delivered with the OPM Quality Management APIs. These must be on your system for your interface to compile and link properly.
Package Name GMD_SPEC_PUB File Names GMDPSPCS.pls, GMDPSPCB.pls Description Public level package that the user defined function calls. The business API can be used for creating, modifying, or deleting a specifications. Group level specifications package containing validation procedures and functions for verifying specification and spec test data. Public level specification validity rules package supplying APIs to create or delete specifications and associated specification validity rules. Group level specification validity rules package containing validation procedures and functions for verifying specification validity rules data. Public level samples package supplying APIs to create or delete samples and associated entities.

GMD_SPEC_GRP

GMDGSPCS.pls, GMDGSPCB.pls

GMD_SPEC_VRS_PUB

GMDPSVRS.pls, GMDPSVRB.pls

GMD_SPEC_VRS_GRP

GMDGSVRS.pls, GMDGSVRB.pls

GMD_SAMPLES_PUB

GMDPSMPS.pls, GMDPSMPB.pls

1-4 Oracle Process Manufacturing Quality Management API Users Guide

Quality Management API Bill of Materials

Package Name GMD_SAMPLES_GRP

File Names GMDGSMPS.pls, GMDGSMPB.pls GMDGRESS.pls, GMDGRESB.pls GMDPRESS.pls, GMDPRESB.pls GMDPTSTS.pls, GMDPTSTB.pls

Description Group level samples package containing validation procedures and functions for verifying samples. Group level results package containing validation procedures and functions for verifying results. Public level results package supplying APIs to record results and add tests to a sample. Public level QC Tests package containing validation procedures and functions for verifying test and results data. Group level QC Tests package containing validation procedures and functions for verifying test and results data. Public level QM package containing APIs to export inoformation to third party products.

GMD_RESULTS_GRP

GMD_RESULTS_PUB

GMD_QC_TESTS_PUB

GMD_QC_TESTS_GRP

GMDGTSTS.pls, GMDGTSTB.pls

GMD_OUTBOUND_APIS_PUB

GMDOAPIS.pls, GMDOAPIB.pls

Quality Management API Introduction

1-5

Understanding the General Input Structure

Understanding the General Input Structure


All stored procedure APIs are called with PL/SQL parameters. Examination of both the x_return_status and x_msg_count indicates the pass or fail status of the call. 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. 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. Used to specify whether the message list must be initialized on entry to the API. It is an optional parameter, and if not supplied, then it defaults to FND_API.G_FALSE which means that the API does not initialize the message list. Used to specify whether the API must commit its work before returning to the calling function. If not supplied, then it defaults to FND_API.G_FALSE. For future use. 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. Returns the messages in an encoded format. These messages can then be processed by the standard message functions as defined in business object API Coding Standards Document.

p_init_msg_list

varchar2

IN

p_commit

varchar2

IN

p_validation_ level x_return_status

varchar2 varchar2

IN OUT

N N

1-6 Oracle Process Manufacturing Quality Management API Users Guide

API Hints

API Hints
For performance improvement, NOCOPY hints have been added to the OUT parameters of the APIs. When an API has the same type of parameter defined as IN and OUT, pass in different variables. For example, 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, 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, p_qc_samples_rec and x_qc_samples_rec both have the variable l_ sample. This gives an incorrect result because both the parameters cannot have the same variable. 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, check the return status of the API (generally returned through x_ return_status parameter) before looking at other OUT variables returned by the API. If the return status is not Success, then you must not use any of the OUT parameters passed back from the API.

Quality Management API Introduction

1-7

API Hints

1-8 Oracle Process Manufacturing Quality Management API Users 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

OPM Quality Specifications APIs

OPM Quality Specifications APIs


A specification defines the tests to be carried out on an item for quality control purposes. Each specification is identified by its name and version; together these form a unique key. The specification references an item and, optionally, a grade. It also has an owner and an owning organization. The specification owns one or more specification tests specifying the test procedures to be carried out against the item identified in the specification header. 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.

Create Specification
This procedure lets you:

insert a specification into GMD_SPECIFICATIONS. insert one or more specification tests into GMD_SPEC_TESTS.

All data is validated prior to insert. If an error is encountered, then an error is returned. If the API is able to insert, then a status of success 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. Table Structure of Specification tests. Oracle Applications login. Record Structure of Specifications. Table Structure of Specification tests.

Parameter - p_spec (IN) This is a row type parameter that identifies the specification header. The following table explains the required columns of the row:

2-2 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Specifications APIs

Parameter spec_id

Description Spec_id must be null when a new gmd_specifications row is being created. 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. Valid values are I - Item specification or M - Monitoring specification. Spec_name and spec_vers must form a unique key. Positive integer value. Spec_name and spec_vers must form a unique key. Description of specification. Value 100 signifies NEW. Valid values from sy_orgn_mst. Valid values from sy_orgn_usr. Specification type. Valid values are I - item and M - monitoring.

spec_type spec_name spec_vers spec_desc spec_status owner_orgn_code owner_id spec_type

Parameter - p_spec_tests_tbl (IN) This is a table type parameter that identifies the specification tests. 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. It is populated with the spec_id from the owning gmd_specifications entity. Must reference a valid entry in gmd_qc_tests. Must reference a valid entry in gmd_test_methods. Sequence of this test within the specification. Positive integer value. Duplicates not allowed within a single specification. Valid values are 5N - Normal, 1L - Low, and 8H - High. Number of test repetitions required per sample integer value greater than 0.

Parameter - x_spec (OUT) This is a row type parameter that returns the populated specification.

Quality Management Inbound API Business Objects 2-3

OPM Quality Specifications APIs

Parameter - x_spec_tests_tbl (OUT) This is a table type parameter that returns the populated specification tests.

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. The spec_status permits updates. The spec_id is supplied.

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. Oracle Applications login. Number of Specification records deleted.

Parameter - p_spec (IN) This is a row type parameter that identifies the specification being logically deleted. The following table explains the required columns of the row:
Parameter spec_id Description The specification identified being logically deleted.

Delete Specification Tests


This procedure lets you physically delete a row in GMD_SPEC_TESTS. This is only permitted where:

The header GMD_SPECIFICATIONS row is not already delete marked. The header GMD_SPECIFICATIONS row has a spec_status which permits updates.

Following is the definition of Delete Specification Tests:

2-4 Oracle Process Manufacturing Quality Management API Users Guide

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. Number of Specification test records deleted.

Parameter - p_spec_tests_tbl (IN) This is a table type parameter that identifies the specification tests being physically deleted. The following table explains the required columns of the table:
Parameter spec_id test_id Description Spec_id is required. It is a valid specification. Must reference a valid entry in gmd_tests.

Quality Management Inbound API Business Objects 2-5

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. 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. The selection of a specification is controlled by the criteria particular to the validity rules. These can be of a general or specific nature.

Create Inventory Specification Validity Rules


This procedure lets you insert one or more rows into GMD_INVENTORY_SPEC_ VRS. 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. Oracle Applications username. Table structure containing inserted Inventory Specification Validity Rules.

Parameter - p_inventory_spec_vrs_tbl (IN) This is a table type parameter that identifies the inventory specification validity rule. The following table explains the required columns of the table:
Parameter spec_vr_id spec_id spec_vr_status Description Must be null. A unique spec_vr_id is generated by the insert processing. Must reference a valid, non-delete marked entry in gmd_ specifications. Must be 100 (New) in a create scenario.

2-6 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Specification Validity Rules APIs

Parameter start_date

Description Valid date.

Parameter - x_inventory_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated inventory specification validity rule.

Create WIP Specification Validity Rules


This procedure lets you insert one or more rows into GMD_WIP_SPEC_VRS. 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. Oracle Applications username. Table structure containing inserted WIP Specification Validity Rules.

Parameter - p_wip_spec_vrs_tbl (IN) This is a table type parameter that identifies the work in progress specification validity rule. 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. A unique spec_vr_id is generated by the insert processing. Must reference a valid, non-delete marked entry in gmd_ specifications. Must be 100 (New) in a create scenario. Valid date.

Parameter - x_wip_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated work in progress specification validity rule.

Quality Management Inbound API Business Objects 2-7

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. 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. Oracle Applications username. Table structure containing inserted Customer Specification Validity Rules.

Parameter - p_customer_spec_vrs_tbl (IN) This is a table type parameter that identifies the customer specification validity rule. 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. A unique spec_vr_id is generated by the insert processing. Must reference a valid, non-delete marked entry in gmd_ specifications. Must reference a valid cust_account_id in hz_cust_accounts_all. Must be 100 (New) in a create scenario. Valid date.

Parameter - 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. Following is the definition of Create Supplier Specification Validity Rules:

2-8 Oracle Process Manufacturing Quality Management API Users Guide

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. Oracle Applications username. Table structure containing inserted Supplier Specification Validity Rules.

Parameter - p_supplier_spec_vrs_tbl (IN) This is a table type parameter that identifies the supplier specification validity rule. 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. A unique spec_vr_id is generated by the insert processing. Must reference a valid, non-delete marked entry in gmd_ specifications. Must reference a valid vendor_id in po_vendors. Must be 100 (New) in a create scenario. Valid date.

Parameter - x_supplier_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated supplier specification validity rule.

Create Monitoring Specification Validity Rules


This procedure creates monitoring specification validity rules. It accepts a table of Monitoring SpecificationValidity Rule definitions, validates each table entry and if found valid, then it inserts a corresponding row into the gmd_monitoring_spec_vrs table. 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.

Quality Management Inbound API Business Objects 2-9

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. Table structure containing inserted Monitoring Specification Validity Rules.

Parameter - p_monitoring_spec_vrs_tbl (IN) This is a table type parameter that identifies the monitoring specification validity rule. 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. A unique spec_vr_id is generated by the insert processing. Must reference a valid, non-delete marked entry in gmd_ specifications. Must be 100 (New) in a create scenario. Valid date.

Parameter - x_monitoring_spec_vrs_tbl (OUT) This is a table type parameter that returns the populated monitoring specification validity rule.

Delete Inventory Specification Validity Rules


This procedure lets you logically delete one or more rows in GMD_INVENTORY_ SPEC_VRS. This is permitted where:

The header GMD_SPECIFICATIONS row is not already delete marked. The targeted row in GMD_INVENTORY_SPEC_VRS is not already delete marked.

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.

2-10 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Specification Validity Rules APIs

Parameter p_user_name x_deleted_rows

Required Y Y

In/Out IN OUT

Description Oracle Applications username. Number of rows deleted.

Parameter - p_inventory_spec_vrs_tbl (IN) This is a table type parameter that identifies the inventory specification validity rule. The following table explains the required columns of the table:
Parameter spec_vr_id spec_id Description Cannot be NULL. This refers to a valid existing spec vr id. Must reference a valid, non-delete marked entry in gmd_ specifications.

Delete WIP Specification Validity Rules


This procedure lets you logically delete one or more rows in GMD_WIP_SPEC_ VRS. 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.

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. Oracle Applications username. Number of rows deleted.

Parameter - p_wip_spec_vrs_tbl (IN) This is a table type parameter that identifies the work in progress specification validity rule. The following table explains the required columns of the table:

Quality Management Inbound API Business Objects

2-11

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. Must reference a valid, non-delete marked entry in gmd_ specifications.

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. The targeted row in GMD_CUSTOMER_SPEC_VRS is not already delete marked.

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. Oracle Applications username. Number of rows deleted.

Parameter - p_customer_spec_vrs_tbl (IN) This is a table type parameter that identifies the customer specification validity rule. The following table explains the required columns of the table:
Parameter spec_vr_id spec_id Description Cannot be NULL. This refers to a valid existing spec vr id. Must reference a valid, non-delete marked entry in gmd_ specifications.

Delete Supplier Specification Validity Rules


This procedure lets you logically delete one or more rows in GMD_SUPPLIER_ SPEC_VRS. This is permitted where:

2-12 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Specification Validity Rules APIs

The header GMD_SPECIFICATIONS row is not already delete marked. The targeted row in GMD_SUPPLIER_SPEC_VRS is not already delete marked.

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. Oracle Applications username. Number of rows deleted.

Parameter - p_supplier_spec_vrs_tbl (IN) This is a table type parameter that identifies the supplier specification validity rule. The following table explains the required columns of the table:
Parameter spec_vr_id spec_id Description Cannot be NULL. This refers to a valid existing spec vr id. Must reference a valid, non-delete marked entry in gmd_ specifications.

Delete Monitoring Specification Validity Rules


This procedure deletes multiple monitoring specification validity rules. It accepts a table of Monitoring SpecificationValidity Rule definitions and validates each table entry to ensure the corresponding row is not already delete marked. When validation is successful, a logical delete is performed setting the delete_mark to 1. 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. Oracle Applications username. Number of rows deleted.

Quality Management Inbound API Business Objects

2-13

OPM Quality Specification Validity Rules APIs

Parameter - p_monitoring_spec_vrs_tbl (IN) This is a table type parameter that identifies the monitoring specification validity rule. The following table explains the required columns of the table:
Parameter spec_vr_id spec_id Description Cannot be NULL. This refers to a valid existing spec vr id. Must reference a valid, non-delete marked entry in gmd_ specifications.

2-14 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Test APIs

OPM Quality Test APIs


A Quality Test is required when a sample is taken for a product. The test must have a description, type, and code. The type is used to determine what values can be recorded for this test. The values entered determine what values can be recorded for this test. Customer values can also be recorded. The Create Test API lets you create a new test, test_values, and customer specific tests. It also lets you create values or customer tests for a test that already exists. The Delete Test API also supports the deletion of either a test header record, details values, or customer specific tests. The delete APIs are:

DELETE_TEST_HEADERS - This deletes a test header record. Specify the test_ code or the unique test_id in the test_record being passed. This logically marks the record as deleted. DELETE_TEST_VALUES - This accepts one or more test values that must be deleted for a test. Specify the test_id in the record being passed, as well as the unique test value id. This physically deletes the records. DELETE_CUSTOMER_TESTS- This accepts one or more customer test values that must be deleted for a test. You must specify the test_id in the record being passed, as well as the unique customer id. This physically deletes the records.

You must first delete the test header record before you can delete the test values or customer tests.

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. Following is the definition of Create Tests:
Parameter Required Y In/Out IN Description Record structure of Test Headers.

p_qc_tests_rec

Quality Management Inbound API Business Objects

2-15

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. Table structure of Customer Tests. Oracle Applications login. Record structure of Test Headers. Table structure of Test Values. Table structure of Customer Tests.

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 - p_qc_tests_rec (IN) This is a row type parameter that identifies the tests. 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. A unique test_id is generated by the insert processing. Or, if the child records are being added to an exisiting gmd_qc_ tests row, then the test_id must reference a valid, non delete marked row. A code to uniquely identify the test. Free format text description. Test method ID. Test type. Note that there are additional fields required depending on the test type.

test_code test_desc test_method_id test_type

Parameter - p_qc_test_values_tbl (IN) This is a table type parameter that identifies the test values. The following table explains the required columns of the table:
Parameter test_value_id test_id Description Must be null. A unique test_value_id is generated by the insert processing. Must identify the parent gmd_qc_tests where this already exists. If the parent gmd_qc_tests is being created in the same API call, then this must be null.

2-16 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Test APIs

Parameter - p_qc_cust_tests_tbl (IN) This is a table type parameter that identifies the customer test values. 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. If the parent gmd_qc_tests is being created in the same API call, then this must be null. Must identify a valid cust_account_id in hz_cust_accounts_all.

cust_id

Parameter - x_qc_tests_rec (OUT) This is a row type parameter that returns the populated test. Parameter - x_qc_test_values_tbl (OUT) This is a table type parameter that returns the populated test values. Parameter - x_qc_cust_tests_tbl (OUT) This is a table type parameter that returns the populated customer test values.

Delete Test Headers


This procedure is used to logically delete (set delete_mark=1) the entity test header GMD_QC_TESTS. Following is the definition of Delete Test Headers:
Parameter Required Y Y In/Out IN IN Description Record structure of Test Headers. Oracle Applications login.

p_qc_tests_rec p_user_name

Parameter - p_qc_tests_rec (IN) This is a row type parameter that identifies the tests. The following table explains the required columns of the row:
Parameter test_id test_code Description Required if test_code is NULL. Required if test_id is NULL.

Quality Management Inbound API Business Objects

2-17

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. All targeted rows in GMD_QC_TEST_VALUES belong to the same header (GMD_QC_TESTS).

Following is the definition of Delete Test Values:


Parameter Required Y Y In/Out IN OUT Description Table structure of Test Values. Number of Test Value records Deleted.

p_qc_test_values_tbl x_deleted_rows

Parameter - p_qc_test_values_tbl (IN) This is a table type parameter that identifies the test values. 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. Identifier of the test value.

Delete Customer Tests


This procedure lets you physically delete one or more rows in GMD_CUSTOMER_ TESTS. This is permitted where:

The header GMD_QC_TESTS row is not delete marked. All targeted rows in GMD_CUSTOMER_TESTS belong to the same header (GMD_QC_TESTS).

Following is the definition of Delete Customer Tests:


Parameter Required Y In/Out IN Description Table structure of Test Customer Display.

p_qc_cust_tests_tbl

2-18 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Test APIs

Parameter

Required Y

In/Out OUT

Description Number of Test Customer Display records deleted.

x_deleted_rows

Parameter - p_qc_cust_tests_tbl (IN) This is a table type parameter that identifies the customer test values. 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. Must identify a valid cust_account_id in hz_cust_accounts_all.

Quality Management Inbound API Business Objects

2-19

OPM Quality Samples APIs

OPM Quality Samples APIs


A sample is a representative quantity of material that undergoes analysis to record quality characteristics. It can be drawn in response to the creation of a sampling event or simply on a standalone basis. 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. A specification is a group of tests that must be performed on samples associated to it. Each specification has at least one specification validity rule used to dictate when a sampling event (business event) is generated. Validity Rules can exist in the following areas:

Inventory WIP Supplier Customer Resource Location

For example, the specification New Recipe has a WIP validity rule which is set up for any batch using recipe R1. If a batch is created using this recipe, then any samples taken from it can be attached to the New Recipe specification. Then, each test associated with the specification is attached to the sample. A sample can be taken that is not associated to a specification. The sampling event which owns that sample, and any other samples created with the same source data, also does not have a specification associated to it. The Samples API can be used to:

2-20 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Samples APIs

create a sample, including create or update associated sampling event, attach result records, or set up disposition records. delete a sample and update associated sampling event.

The following public APIs are provided in package GMD_SAMPLES_PUB to support the creation and deletion of samples:

CREATE_SAMPLES - provides a mechanism to create the samples DELETE_SAMPLES - supports the logical deletion of GMD_SAMPLES

Create Samples
This procedures lets you:

insert a row into GMD_SAMPLES. associate the sample_row GMD_SAMPLES with an existing sampling event GMD_SAMPLING_EVENT, or insert a new GMD_SAMPLING_EVENT. Every sample belongs to a sampling event. Where a sampling_event_id is supplied, it is assumed that the sample is being associated with this. Where no sampling_ event_id is supplied, a new row is created. Therefore, parameter p_find_ matching_spec is examined. This determines whether the sampling event should be free-standing or associated with a specification. If the parameter is set to Y, then the specification validity rules are examined to find the specification with the closest match to the supplied input data. They can be input as follows: insert a row into GMD_SAMPLE_SPEC_DISP. This is necessary to record the disposition of the current instance of the sampling plan. It indicates whether all the requirements for the sampling plan have been met. For example, if the sampling plan requires three lot samples, then the disposition is changed to COMPLETE when all three samples are created. insert a row into GMD_EVENT_SPEC_DISP. 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. insert a result set, which is one or more rows in GMD_RESULTS. One result row is inserted for each replicate of each test in the associated specification. For example, if a test has a replicate number of two, then two result rows are inserted into the table. Each row ID acts as a skeleton entry put in place for recording actual test results.

Quality Management Inbound API Business Objects

2-21

OPM Quality Samples APIs

insert a row into GMD_SPEC_RESULTS. This is a skeleton entry put in place for recording the results of testing the sample. When a sample is new, the relationship between gmd_results and gmd_spec_results is one-to-one.

All data is validated prior to insert. 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. Oracle Applications login. Flag to ensure that sampling event has specification associated. Grade Record structure for samples output. Record structure for sampling events. Record structure for Sample Specification Disposition. Record structure for Event Specification Disposition. Table structure for results. Table structure for Specification results.

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 - p_qc_samples_rec (IN) This is a table type parameter that identifies the sample records. The following table explains the required columns of the table:
Parameter sampling_event_id Description Where supplied, this must reference a valid, non delete marked entry in gmd_sampling_events. Where a null value is supplied, it assumes that the gmd_sampling_events row must be created. Must be null. A unique sample_id is generated by the insert processing.

sample_id

2-22 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Samples APIs

Parameter sample_no

Description Unique identifier for the sample. Automatically generated where document numbering is in place for document type SMPL. Otherwise, the unique identifier must be supplied. The organization code of the organization creating the sample. Identifies the source of the sample. Valid values are I Inventory, W - Wip, C - Customer, S - Supplier. Sample type. Valid user_id from fnd_user.

sample_organization source sample_type sampler_id

Parameter - x_qc_samples_rec (OUT) This is a row type parameter that returns the populated samples record. Parameter - x_sampling_events_rec (OUT) This is a row type parameter that returns the populated sampling events record. Parameter - x_event_disp_rec (OUT) This is a row type parameter that returns the populated event disposition record. Parameter - x_sample_spec_disp (OUT) This is a row type parameter that returns the populated sample specification disposition. Parameter - x_results_tab (OUT) This is a table type parameter that returns the populated results for the sample. Parameter - x_spec_results_tab (OUT) This is a table type parameter that returns the populated specification results for the sample.

Delete Sample
This procedure lets you logically delete one or more rows in GMD_SAMPLES. This is permitted where the targeted row in GMD_SAMPLES is not already delete marked. Following is the definition of Delete Sample:

Quality Management Inbound API Business Objects

2-23

OPM Quality Samples APIs

Parameter

Required Y Y

In/Out IN IN

Description Record structure for samples. Oracle Applications login.

p_qc_samples_rec p_user_name

Parameter - p_qc_samples_rec (IN) This is a table type parameter that identifies the sample records. The following table explains the required columns of the table:
Parameter sample_id orgn_code sample_no Description If specified, then orgn_code and sample_no can be NULL. If specified with sample_no, then sample_id can be NULL. If specified with orgn_code, then sample_id can be NULL.

2-24 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Results APIs

OPM Quality Results APIs


Prior to documenting results, create a specification, a validity rule, and a sample. The sample has a set of tests against which results must be recorded. Therefore, when the sample is created, a result set is also established. The Record Results API lets actual results be recorded for a particular test. The result row already exists since it is created with the sample, but the detail of the test result is now put in place. The Add Tests to Samples API lets the result set for a sample be extended. New tests or replications of tests can be added.

Record Results
This procedure can be used to record actual test results. It modifies the appropriate row in GMD_RESULTS which is put in place when the result set is created for a particular sample. 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.in_spec_ind. 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. Oracle Applications username. Record structure for gmd_results table. Record structure for gmd_spec_results table.

Parameter - p_results_rec (IN) This is a row type parameter that identifies the results being 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. Identifies a specific result in a specific sample. This is required if no other values except for result_value are passed.

Quality Management Inbound API Business Objects

2-25

OPM Quality Results APIs

Parameter sample_id

Description The ID for the sample of the result. This is required, if sample_ no and orgn_code are not defined. Otherwise, the system checks sample_id first. 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. In conjunction with orgn_code, must reference a valid sample in gmd_samples. If specified, then sample_id is not required. In conjunction with sample_no, must reference a valid sample in gmd_samples. The ID for the test associated to a result. This is required, if test_ code is not defined. Otherwise, the system checks test_id first. Test code is used whenever test_id is not passed. Used in conjunction with sample and test identifiers to determine the required row in gmd_results. You can pass a date to this field. If no date is passed, then it defaults to SYSDATE.

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, sample_no, test_code, test_replicate_cnt

Parameter - x_results_rec (OUT) This is a row type parameter that returns the results. Parameter - x_spec_results_rec (OUT) This is a row type parameter that returns the specification results.

2-26 Oracle Process Manufacturing Quality Management API Users Guide

OPM Quality Results APIs

Add Tests to Samples


This procedure lets tests be added to an existing sample. For each test referenced, rows are created in GMD_RESULTS and GMD_SPEC_RESULTS which is done in preparation for recording the outcome of the testing. Each results row references a test. There can be multiple replications of a test. After the results rows have been added, 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. Oracle Applications username. Table structure for Table IDs GMD_API_ Pub.number_tab Event specification disposition ID. Table structure for GMD_API_Pub.gmd_ results_tab. Table structure for GMD_API_Pub.gmd_ spec_results_tab. You can pass a date to this field. If no date is passed, then it defaults to SYSDATE.

Parameter - p_sample_rec (IN) This is a row type parameter that identifies the sample being recorded. The following table explains the required columns of the row:

Quality Management Inbound API Business Objects

2-27

OPM Quality Results APIs

Parameter sample_id

Description The ID for the sample of the result. This is required, if sample_ no and orgn_code are not defined. Otherwise, the system checks sample_id first. You must use the sample_id or sample_ no and orgn_code combination with the test_id or test_code combination. In conjunction with orgn_code, must reference a valid sample in gmd_samples. In conjunction with sample_no, must reference a valid sample in gmd_samples.

sample_no orgn_code

Parameter - p_test_id_tab (IN) This is a table type parameter that identifies the test ID being recorded. The following table explains the required columns of the row:
Parameter test_id Description The ID for the test associated to a result. This is required, if test_ code is not defined. Otherwise, the system checks test_id first.

Parameter - x_results_tab (OUT) This is a table type parameter that returns the results. Parameter - x_spec_results_tab (OUT) This is a table type parameter that returns the specification results.

2-28 Oracle Process Manufacturing Quality Management API Users Guide

3
Quality Management Outbound API Business Objects
OPM provides outbound APIs to export Quality Management data to third party systems. This download of Quality information facilitates further analysis and reporting in an external system. 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

Fetch Test Methods

Fetch Test Methods


This procedure retrieves test method data from the table GMD_TEST_METHODS. If an error is encountered, then an error status is returned. If the API is able to select one or more test methods without error, then a status of success is returned and the rows are returned in the output table x_test_methods_ tbl. 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, defines the start value for a range-based retrieval. If specified, defines the end value for a range-based retrieval. If specified, restricts the retrieval to the single test_method_id. If specified, restricts the retrieval to the single item_no. If specified, restricts the retrieval to the single item_id. If specified, restricts the retrieval to the single resource. If specified, retrieval is restricted to deleted rows (if specified as 1) or undeleted rows (if specified as 0). If specified, defines the start date for a range-based retrieval. If specified, defines the end data for a range-based retrieval. Oracle Applications user name. Record type gmd_test_methods_tab_ type.

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 - x_test_methods_table (OUT) This is a table type parameter that returns the fetched test method information.

3-2 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Test Methods

Parameter Test_method_id Test_method_code Test_method_desc

Description Test method identifier. Test method code. In the language of the session, actual text comes from gmd_ test_methods_tl via gmd_test_methods_vl view. If the descriptions do not exist in the language of the session, then the retrieval fails and test method data is not returned.

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 unit of measure. Logical delete record indicator. Display precision. Test duration. Test duration in number of days. Test duration in number of hours. Test duration in number of minutes. Test duration in number of seconds. Test replicate. Resources. Test kit item. Test kit item number. Text code. Descriptive Flexfield Segments. Descriptive Flexfield Segment Category. 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-3

Fetch Test Methods

Parameter Last_update_login

Description Standard Who Column.

3-4 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Tests

Fetch Tests
The Fetch Tests API retrieves tests from GMD_TEST_QC_TESTS, GMD_QC_TEST_ VALUES, and GMD_CUSTOMER_TESTS. 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. Starting test method code. Ending test method code. Testing identifier. Test method identifier. Test class. Test type. Priority Logical delete record indicator. Starting last update date. Ending last update date. Oracle Applications user name. Record type gmd_qc_tests_tab_type.

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 - x_tests_table (OUT) This is a table type parameter that returns the fetched header information for the test.
Field/Column Row_id Test_id Description Row ID. Test identifier.

Quality Management Outbound API Business Objects 3-5

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. Test description. Test method ID. Test operation line ID. Test provider code. Test classes. Test type. Test unit. Minimum value. Maximum value. Expression error type. Below specification minimum. Above specification minimum. Below specification maximum. Above specification maximum. Below minimum action code. Above minimum action code. Below maximum action code.

Above_max_action_code Above maximum action code. Expression Display_precision Report_precision Priority Test_oprn_id Delete_mark attribute1-30 attribute_category creation_date Expression Display precision. Report precision. Priority. Test operation ID. Logical delete record indicator. Descriptive Flexfield Segments. Descriptive Flexfield Segment Category. Standard Who Column

3-6 Oracle Process Manufacturing Quality Management API Users Guide

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. Record type qc_customer_test_tab.

Parameter - x_qc_test_values_tab This is a table type parameter that returns the fetched quality test values.
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. Test value identifier. Test unique identifier. Numeric range from value recorded in quality units specified in test_unit. Numeric range to value recorded in quality units specified in test_unit. Display the label numeric range. Test value description. Varchar value for list of values or text range. Test range sequence. ID of referenced test for expression test type. Descriptive Flexfield Segments Descriptive Flexfield Segment Category Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

Quality Management Outbound API Business Objects 3-7

Fetch Tests

Field/Column Last_update_login

Description Standard Who Column.

Parameter - x_qc_customer_tests_tab This is a table type parameter that returns the fetched quality customer test information.
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. Test identifier. Customer identifier. Report precision. Customer test display. Text code. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

3-8 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Specification Validity Rules

Fetch Specification Validity Rules


The Fetch Specification Validity Rules API retrieves specifications, specification tests, and validity rules from GMD_SPECIFICATIONS, GMD_SPEC_TESTS, GMD_ WIP_SPEC_VRS, GMD_CUSTOMER_SPEC_VRS, GMD_INVENTORY_SPEC_VRS, and GMD_SUPPLIER_SPEC_VRS. 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. Ending specification name. Specification identifier. Specification version. Starting grade. Ending grade. Starting item code. Ending item code. Starting specification last update date. Ending specification last update date. Specification type. User organization code. Oracle Applications user name. Item identifier. Specification status. Logical delete record indicator. Test code. Test identifier. Test method code. Test method identifier.

Quality Management Outbound API Business Objects 3-9

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. Test priority. Starting last test update date. Ending last test update date. Specification validity rule status. Validity rule organization. Validity rule start date. Validity rule end date. Validity rule certificate of analysis type. Validity rule sampling plan. Validity rule sample plan identifier. Logical delete record indicator. Validity rule source. Validity rule lot number. Validity rule lot identifier. Validity rule sublot number. Validity rule warehouse. Validity rule location. Validity rule organization batch number. Validity rule batch identifier. Validity rule recipe number. Record type specifications_tbl_type.

Parameter - x_specifications_tbl (OUT) This is a table type parameter that returns the fetched header information for the specification.

3-10 Oracle Process Manufacturing Quality Management API Users Guide

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. Specification name. Specification version. Specification description. Specification type. Overlay indicator. Base specification indicator. Item ID. Grade. Specification status. Owner organization code. Owner ID.

Sample_inv_trans_ Transact inventory for sample. 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. Text code. Descriptive Flexfield Segments. Descriptive Flexfield Segment Category. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Record type spec_tests. Record type cust_spec_vrs. Record type wip_spec_vrs. Record type supl_spec_vrs.

Quality Management Outbound API Business Objects

3-11

Fetch Specification Validity Rules

Field/Column x_inv_spec_vrs x_mon_spec_vrs

Description Record type inv_spec_vrs. Record type mon_spec_vrs.

Parameter - x_spec_tests This is a table type parameter that returns the header information for the fetched specification tests.
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. Test code. Test method ID. Test method code. Sequences. Test quantity. Test unit of measure. Minimum target value for numeric range test type. Test target value. Maximum target value for numeric range test type. Minimum target value for text range test type. Target value for test when the test type is a list of values or a text range. Maximum target value for text range test type. The number of times a test is repeated for the same sample instance. Default value is 1. Frequency result values are checked for out-of-spec condition. Print on certificate of analysis. Use to control step. Out of specification action. NUM = Number, PCT = Percent. Below specification minimum.

3-12 Oracle Process Manufacturing Quality Management API Users Guide

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. Below specification maximum. Above specification maximum. Action code for results in the test error region specification minimum minus test error. Action code for results in the test error region specification minimum plus test error. Indicates if a test is optional. Valid values are Y - Yes, Null - No. Decimal precision of saved value. Decimal precision used to display value. Test priority. Valid values are H - high, N - normal, and L - low. Indicates if the specification is used to retest for lot expiration. Print specification indicator. Print result indicator. Action code for results in the test error region specification maximum minus test error. Action code for results in the test error region specification maximum plus test error. Test display. Days. Hours. Minutes. Seconds. From base indicator. Exclude indicator. Modified indicator. Calculation of unit of measure conversion indicator. To unit of measure. Text code.

Quality Management Outbound API Business Objects

3-13

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. Descriptive Flexfield Segments. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

Parameter - x_cust_spec_vrs This is a table type parameter that returns the fetched customer specification validity rule information.
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. Organization code. Customer identification. Customer number. Order ID. Order number. Order line. Order line ID. Ship-to site ID. Ship-to site name. Organization ID. Organization name. Specification validity rule status.

3-14 Oracle Process Manufacturing Quality Management API Users Guide

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. Start date. End date. Sampling plan ID. Sampling plan name. Indicates an inventory transaction is created for the sample amount. Valid values are Y - Yes, Null - No. Lot optional on sample. Certificate of Analysis type. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Certificate of Analysis from supplier. Logical delete record indicator. Text code. 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.

Parameter - 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

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. Organization code. Batch ID. Batch number. Recipe ID. Recipe number. Recipe version. Formula ID. Formula number. Formula version. Routing ID. Routing number. Routing version. Step ID. Step number. Operation ID. Operation number. Operation version. Charges. Specification validity rule status. Specification validity rule status description. Start date. End date. Sampling plan ID. Sampling plan name. Indicates an inventory transaction is created for the sample amount. Valid values are Y - Yes, Null - No.

3-16 Oracle Process Manufacturing Quality Management API Users Guide

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. Auto sample indicator. Valid values are A - Auto, W - WorkFlow, Null - No Outside specification lot status. In specification lot status. Certificate of Analysis type. Control batch step indicator. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Certificate of Analysis from supplier. Logical delete record indicator. Text code. 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.

Parameter - x_supl_spec_vrs This is a table type parameter that returns the fetched supplier specification validity rule information.
Parameter po_header_id Description Purchase order header identification.

Quality Management Outbound API Business Objects

3-17

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. Specification validity rule identifier. Organization code. Supplier ID. Supplier name. Supplier site ID. Supplier site name. Purchase order ID. Purchase order line number. Specification validity rule status. Specification validity rule status description. Start date. End date. Sampling plan ID. Sampling plan name. Indicates an inventory transaction is created for the sample amount. Valid values are Y - Yes, Null - No. Lot optional on sample. Delayed lot entry. Auto sample indicator. Certificate of Analysis type. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Certificate of Analysis supplier indicator. Logical delete record indicator. Text code. Descriptive Flexfield Segment Category. Descriptive Flexfield Segments.

3-18 Oracle Process Manufacturing Quality Management API Users Guide

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. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

Parameter - x_inv_spec_vrs This is a table type parameter that returns the fetched inventory specification validity rule information.
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. Organization code. Lot ID. Lot number. Sublot number Warehouse code. Location Specification validity rule status. Specification validity rule status description. Start date. End date. Sampling plan ID. Sampling plan name. Indicates an inventory transaction is created for the sample amount. Valid values are Y - Yes, Null - No. Valid values are A - Auto, W - WorkFlow, Null - No.

Quality Management Outbound API Business Objects

3-19

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. Delayed lot entry. Auto sample indicator. In specification lot status. Outside specification lot status. Control batch step indicator. Certificate of Analysis type. Certificate of Analysis shipment indicator. Certificate of Analysis invoice indicator. Certificate of Analysis suppler indicator. Logical delete record indicator. Text code. 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.

Parameter - x_mon_spec_vrs This is a table type parameter that returns the fetched inventory specification validity rule information.
Parameter spec_vr_id spec_id Description Specification validity rule indicator. Specification ID.

3-20 Oracle Process Manufacturing Quality Management API Users Guide

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. Location organization code. Warehouse code. Location. Resources. Resource organization code. Resource instance ID. Specification validity rule status. Specification validity rule status description. Start date. End date. Sampling plan ID. Sampling plan name. Logical delete record indicator. Text code. Descriptive Flexfield Segment Category. Descriptive Flexfield Segments. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

Quality Management Outbound API Business Objects

3-21

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. 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. Organization code. Starting sample number. Ending sample number. Sample event identifier. Starting item number. Ending item number. Item identifier. Starting lot number. Ending lot number. Starting sublot number. Ending sublot number. Lot identifier. Disposition. Warehouse code. Location. Location identifier. Work in process organization code. Work in process batch number. Work in process batch identifier. Work in process recipe number. Work in process recipe version. Work in process recipe identifier.

3-22 Oracle Process Manufacturing Quality Management API Users Guide

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. Work in process formula version. Work in process formula identifier. Work in process formula line number. Work in process formula line identifier. Work in process formula line type. Work in process routing number. Work in process routing version. Work in process routing identifier. Work in process step number. Work in process step identifier. Work in process operation number. Work in process operation version. Work in process operation identifier. Customer. Customer identifier. Customer organization identifier. Customer ship to location. Customer ship to location identifier. Customer order number. Customer order identifier. Customer order type.

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

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. Customer order line identifier. Supplier. Supplier identifier. Supplier site. Supplier purchase order number. Supplier purchase order identifier. Supplier purchase order line. Supplier purchase order line identifier. Logical delete record indicator. Starting last update date. Ending last update date. Organization code. Resources. Instance identifier. Stability study identifier. Stability study organization code. Stability study number. Variant identifier. Variant number. Time point identifier. Record type gmd_sampling_events_tab_ type.

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 Users Guide

Fetch Sample Groups

Parameter - x_sample_groups_table (OUT) This is a row type parameter that returns the header information for the fetched sample groups.
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. Receipt number. Purchase order header ID. Purchase order number. Sampling event ID. Original specification validity rule ID. Final result value. Required number of samples to be taken. Current number of samples taken. Sampling plan ID. Identifies the event triggering a sample to be taken. For example, Batch or Lot Expiration. Identifier of event triggering a sample to be taken. Item ID. Item number. Lot ID. Lot number. Sublot number. Warehouse code. Location. Batch ID. Batch number. Recipe ID. Recipe number. Recipe version.

Quality Management Outbound API Business Objects

3-25

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. Formula number. Formula version. Formula line ID. Formula line number. Routing ID. Operation ID. Charge. Customer ID. Customer name. Order ID. Order number. Order line ID. Order line number. Organization ID. Organization code. Supplier ID. Supplier name. Purchase order line ID. Purchase order line number. Receipt line ID. Receipt line number. Supplier lot number. Indicates if all samples for this specification are complete. Sample identifier to evaluate. Composite ID to evaluate. Text code.

3-26 Oracle Process Manufacturing Quality Management API Users Guide

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. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Supplier site ID. Supplier site name. Ship-to site ID. Ship-to site name. Step ID. Step number. Lot retest indicator. Recomposite idicator. Number of active samples taken, which are samples not marked for purge and not canceled. Organization code. Resources. Instance ID. Time point ID. Variant ID. Archive taken. Reserved taken. Sample event disposition.

Parameter - x_sample_events_disp This is a row type parameter that returns the event disposition information for a fetched sample.

Quality Management Outbound API Business Objects

3-27

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. Specification ID. Specification name. Specification version. Specification validity rule ID. Disposition. Specification used for lot attribute indicator. Logical delete record indicator. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column. Standard Who Column.

3-28 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Samples

Fetch Samples
The Fetch Samples API retrieves sample groups from the GMD_SAMPLES and GMD_SAMPLE_SPEC_DISP tables. 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. Organization code. Starting sample number. Ending sample number. Sample identifier. Sampling event identifier. Starting item number. Ending item number. Item identifier. Starting lot number. Ending lot number. Sublot number. Lot identifier. Priority. Specification name. Specification version. Specification identifier. Source. Starting date drawn. Ending date drawn. Starting expiration date.

Quality Management Outbound API Business Objects

3-29

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 warehouse. Source location. Grade. Sample disposition. Storage warehouse. Storage location. Quality lab organization code. External identifier. Sample. Lot retest indicator. Warehouse code. Location. Location identifier. Work in process plan code. Work in process batch number. Work in process batch identifier. Work in process recipe number. Work in process recipe version. Work in process recipe identifier. Work in process formula number. Work in process formula version. Work in process formula identifier. Work in process formula line.

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 Users Guide

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. Work in process line type. Work in process routing number. Work in process routing version. Work in process routing identifier. Work in process batch step number. Work in process batch step identifier. Work in process operation number. Work in process operation version. Work in process operation identifier. Customer name. Customer identifier. Customer organization identifier. Customer ship to site identifier. Customer order. Customer order identifier. Customer order type. Customer order line. Customer order line identifier. Supplier. Supplier identifier. Supplier site identifier. Supplier purchase order. Supplier purchase order identifier.

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

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. Supplier purchase order line identifier. Starting date received. Ending date received. Starting date required. Ending date required. Resources. Instance identifier. Starting retrieval date. Ending retrieval date. Sample type. Stability study identifier. Stability study organization code. Stability study number. Variant identifier. Variant number. Time point identifier. Starting last update date. Ending last update date. Retain as. Logical delete record indicator. Record type samples_table.

3-32 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Samples

Parameter - x_samples_table (OUT) This is a table type parameter that returns the header information for the fetched samples.
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. Step number. Step ID. Sample unique identifier. Sampling number. Sampling description. Specification ID. Specification name. Specification version. Quality lab organization. Item ID. Item number. Warehouse location when a sample is taken from a warehouse. Samples expiration date. Lot ID. Items lot number of sample. Sublot number. Batch ID. Plant code. Batch number. Recipe ID. Recipe number. Recipe version. Formula ID. Formula number.

Quality Management Outbound API Business Objects

3-33

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. Formula line ID. Formula line number. Line type. Routing ID. Routing number. Routing version. Operation ID. Operation number. Operation version. Batch step ID. Batch step number. Charge. Customer ID. Customer name. Order ID. Order type. Order number. Order line ID. Order line number. Organization ID. Organization name. Supplier ID. Supplier number. Sample quantity. Sample unit of measure. Source. Sampler ID.

3-34 Oracle Process Manufacturing Quality Management API Users Guide

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. Date the sample was drawn. Source comments. Storage warehouse. Storage location. External ID. Sample approver ID. Inventory approver ID. Priority. Sample inventory transaction indicator. Supplier site ID. Supplier site. Warehouse code. Organization code. Purchase order header identification. Purchase order number. Purchase order line identification. Purchase order line number. Receipt ID. Receipt number. Receipt line ID. Receipt line. Sample disposition Ship-to site ID. Ship-to location. Supplier lot ID. Lot retest indicator. Current instance of the sample created.

Quality Management Outbound API Business Objects

3-35

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. Location where the sample quantity must be stored. The date the same was received. The date the same was required. Resources. Instance ID. Retrieval date for the sample. Sample type. Time point ID. Variant ID. Logical delete record indicator. Text code. 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. Remaining quantity of the sample.

3-36 Oracle Process Manufacturing Quality Management API Users Guide

Fetch Results

Fetch Results
The Fetch Results API retrieves sample groups from the GMD_RESULTS table. 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. Organization code. Starting sample number. Ending sample number. Sample identifier. Starting result date. Ending result date. Sample disposition. In specification indicator. Lab organization code. Evaluation indicator. Tester. Test identifier. Test provider identifier. Logical delete record indicator. Starting last update date. Ending last update date. Planned resource. Planned resource instance. Actual resource. Actual resource instance.

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

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. Ending planned result date. Starting test by date. Ending test by date. Reserve sample identifier. Record type results table.

Parameter - x_results_table (OUT) This is a table type parameter that returns the fetched sample results.
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. Results unique identifier. Identifies the sample the test results is recorded. Sample number. Test performed the results are recorded. Test code. Number of times test was performed on the same sample. Quality lab organization code where the test was performed. Numeric result value. Date result occurred. Item ID of solvent used in the testing procedure. Item number of solvent used in the testing procedure. Solvent lot number. Solvent sublot number. User ID of person who performed the test.

3-38 Oracle Process Manufacturing Quality Management API Users Guide

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. Test provider ID. Ad hoc printing on Certificate of Analysis indicator. Sequence. Character result value. Test provider code. Assay retest. In specification indicator. Disposition. Evaluation indicator. Planned resource. Planned resource instance. Actual resource.

actual_resource_instance Actual resource instance. 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. Logical delete record indicator. Text code. 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

Fetch Results

Parameter test_qty test_uom reserve_sample_id consumed_qty parent_result_id test_method_id

Description Test quantity. Test unit of measure. Reserve sample indicator. Consumed quantity. Parent result ID. Test method ID.

3-40 Oracle Process Manufacturing Quality Management API Users Guide

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. 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. Sampling event identifier. Composite result disposition. Starting item number. Ending item number. Starting lot identifier. Ending lot identifier. Starting last update date. Ending last update date. Logical delete record indicator. Record type composite_results_table.

Parameter - x_composite_results_tbl (OUT) This is a row type parameter fetched from gmd_composite_results, gmd_ composite_spec_disp, and gmd_composite_result_assoc.
Parameter composite_result_id test_id mean mode_num mode_char Description Composite results. Test Identifier. Statistical mean. Mode number. Mode character.

Quality Management Outbound API Business Objects

3-41

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. Higher numeric range. Statistical range. Statistics standard deviation. Sample total. Sample count used. Non-validated result. Highest character value. Lowest character value. Median character value. Median numeric value. Composite specification disposition identification. Composite specification indicator. Workflow response. Report precision. Disposition. Item ID. Item number. Lot ID. Lot number. Sublot number. Logical delete record indicator. Text code. Descriptive Flexfield Segment Category. Descriptive Flexfield Segments. Standard Who Column. Standard Who Column.

3-42 Oracle Process Manufacturing Quality Management API Users Guide

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. Standard Who Column. Standard Who Column. Parent composite result ID.

Quality Management Outbound API Business Objects

3-43

Fetch Composite Results

3-44 Oracle Process Manufacturing Quality Management API Users Guide

A
Messages and Errors
This appendix covers the following topics:

Handling Messages Interpreting Error Conditions Understanding Error Messages

Messages and Errors A-1

Handling Messages

Handling Messages
APIs put result messages into a message list. Programs calling APIs can then get the messages from this list, and process them. This can be by issuing them to the user if calling the API from an interactive process, or writing them to database tables or log files if calling the API from a batch process. Messages are stored in an encoded format to let API callers find out message names using the standard functions provided by the message dictionary. The structure of the message list is not public. Neither API developers nor API callers can access this list except by calling the API message utility routines. The following utility functions are defined in the FND_MSG_PUB package:

Initialize - Initializes the API message list Add - Adds a message to the API message list Get - Gets a message from the API message list Count_Msg - Returns the number of messages in the API message list Delete - Deletes one or more messages from the API message list Reset - Resets the index used in getting messages Count_And_Get - Returns the number of messages in the API message list. If this number is one, 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. To add a message to the API message list, use the regular message dictionary procedures FND_MESSAGE.SET_NAME and FND_MESSAGE.SET_TOKEN to set the message name and tokens on the message dictionary stack. Then call FND_ MSG_PUB.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, API callers use the procedure FND_ MSG_PUB.Get. This procedure operates in the following modes:

First - Gets the first message in the API message list Next - Gets the next message in the API message list Last - Gets the last message in the API message list Previous - Gets the previous message in the API message list

A-2 Oracle Process Manufacturing Quality Management API Users Guide

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 Users 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

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. SPEC_ID must be supplied Specification Item not found. Specification Item required. Specification Name required. Could not find matching Specification Record Specification Owner Organization &ORGN not found. Specification Owner Organization Code required. Specification Owner not found. Specification Owner required. Spec status prevents updates Specification status &STATUS not found. Specification Status required. 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 Users Guide

Understanding Error Messages

Error Messages Test Sequence &SEQ already exists on the current specification. Specification &SPEC Version &VERS exists. Specification Version must be a whole positive number. 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. Specification Validity is higher. Specification warehouse not found. Supplier not found Supplier required Parameter : Test_id Table is empty. Test not found User &OWNER does not have access to Organization &ORGN. Warehouse not found. 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

Understanding Error Messages

A-8 Oracle Process Manufacturing Quality Management API Users Guide

Index
A
API, 1-1 GMD_CUSTOMER_SPEC_VRS, 3-9 GMD_CUSTOMER_TESTS, 3-5 GMD_EVENT_SPEC_DISP, 3-22 GMD_INVENTORY_SPEC_VRS, 3-9 GMD_QC_TEST_VALUES, 3-5 GMD_RESULTS, 3-37 GMD_SAMPLE_SPEC_DISP, 3-29 GMD_SAMPLES, 3-29 GMD_SAMPLING_EVENTS, 3-22 GMD_SPEC_TESTS, 3-9 GMD_SPECIFICATIONS, 3-9 GMD_SUPPLIER_SPEC_VRS, 3-9 GMD_TEST_METHODS, 3-2 GMD_TEST_QC_TESTS, 3-5 GMD_WIP_SPEC_VRS, 3-9

C
call pass/fail status, 1-6

E
error, 1-2, A-3

F
Fetch Composite Results, 3-1 Fetch Results, 3-1 Fetch Sample Groups, 3-1 Fetch Samples, 3-1 Fetch Specifications, 3-1 Fetch Test Methods, 3-1 Fetch Tests, 3-1 Fetch Validity Rules, 3-1 FND_API, 1-4 FND_API.G_FALSE, 1-6 FND_MESSAGE, 1-4 FND_PUB_MSG, 1-4 formula information, importing, 1-2

I
importing formula information, 1-2 input structure, general, 1-6

M
message encoding, 1-6 message list initialization, 1-6 message list, specifying number of messages added, 1-6

G
general input structure, 1-6 GMD_COMPOSITE_RESULT_ASSOC, 3-41 GMD_COMPOSITE_RESULTS, 3-41 GMD_COMPOSITE_SPEC_DISP, 3-41

P
p_api_version, 1-6 p_commit, 1-6 p_init_msg_list, 1-6 parameters, 1-6

Index-1

pass/fail status, call, 1-6 PL/SQL, 1-2, 1-6 processing standard message functions, 1-6

S
standard message function processing, success, 1-2, A-3 support policy, 1-3 1-6

U
unexpected, 1-2, A-3 unknown, 1-2, A-3

V
version compatibility, validation, 1-6

X
x_msg_count, 1-6 x_msg_data, 1-6 x_return_status, 1-6

Index-2

También podría gustarte