115gmepeapiug PDF

Oracle Process Manufacturing
Process Execution API Users Guide

Release 11i
Part No. A97388-03
July 2003
Oracle Process Manufacturing Process Execution API Users Guide, Release 11i
Part No. A97388-03
Copyright 2003 Oracle Corporation. All rights reserved.
Primary Author: Michele-Andrea Fields
Contributors: Bill Stearns, Thomas Daniel, Shrikant Nene
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, and OracleMetaLink, Oracle Store, Oracle8, Oracle8i, and SQL*Plus are
trademarks or registered trademarks of Oracle Corporation. Other names may be trademarks of their
respective owners.
Contents
Send Us Your Comments .................................................................................................................. vii
Preface............................................................................................................................................................ ix
Audience for This Guide...................................................................................................................... ix
How To Use This Guide ....................................................................................................................... ix
Documentation Accessibility ......................................................................................................... xi
Other Information Sources .................................................................................................................. xi
Online Documentation.................................................................................................................... xi
Related Users Guides.................................................................................................................... xii
Guides Related to All Products .................................................................................................... xii
User Guides Related to This Product .......................................................................................... xii
Installation and System Administration ................................................................................... xvii
Other Implementation Documentation...................................................................................... xix
Training and Support.................................................................................................................... xxi
Do Not Use Database Tools to Modify Oracle Applications Data............................................. xxi
About Oracle........................................................................................................................................ xxii
Your Feedback ..................................................................................................................................... xxiii
API Introduction
Introducing the Process Execution APIs ........................................................................................
Process Execution API Support Policy ......................................................................................
Technical Requirements ..............................................................................................................
Technical Overview......................................................................................................................
Basic Business Needs .........................................................................................................................
1-2
1-3
1-3
1-3
1-3
iii
Input Data Sources .......................................................................................................................

Wrapper Function.........................................................................................................................
Stored Procedure...........................................................................................................................
Major Features .....................................................................................................................................
Process Execution API Bill of Materials .......................................................................................
1-4
1-5
1-5
1-6
1-11
Process Execution API Usage

Calling the API Interface Code ........................................................................................................ 2-2
API Call Hints ............................................................................................................................... 2-2
API Wrapper Code - Example ........................................................................................................... 2-3
Technical Overview
Structure for Process Execution Public APIs ................................................................................. 3-2
Standard Parameters........................................................................................................................... 3-4
Value-ID Conversion.................................................................................................................... 3-5
Business Objects
Allocate Batch ......................................................................................................................................
Allocate Line ........................................................................................................................................
Cancel Batch.........................................................................................................................................
Close Batch ...........................................................................................................................................
Close Steps ...........................................................................................................................................
Complete Batch ...................................................................................................................................
Complete Steps..................................................................................................................................
Convert FPO to Batches ...................................................................................................................
Create Batch .......................................................................................................................................
Create Phantom .................................................................................................................................
Delete Batchstep Activity ................................................................................................................
Delete Batchstep Resource ..............................................................................................................
Delete Line Allocation .....................................................................................................................
Delete Material Detail Line ............................................................................................................
Delete Step .........................................................................................................................................
End Completed Resource Transaction ..........................................................................................
Incremental Backflushing ...............................................................................................................
iv
4-1
4-3
4-4
4-6
4-7
4-8
4-11
4-14
4-16
4-19
4-21
4-22
4-23
4-24
4-25
4-26
4-27
Insert Batchstep Activity .................................................................................................................

Insert Batchstep Resource ...............................................................................................................
Insert Incremental Completed Transaction .................................................................................
Insert Line Allocation ......................................................................................................................
Insert Material Detail Line..............................................................................................................
Insert Step ..........................................................................................................................................
Insert Timed Resource Transaction ...............................................................................................
Release Batch .....................................................................................................................................
Release Steps .....................................................................................................................................
Reopen Batch .....................................................................................................................................
Reopen Steps .....................................................................................................................................
Reroute Batch.....................................................................................................................................
Reschedule Batch ..............................................................................................................................
Reschedule Step ................................................................................................................................
Revert to WIP Batch..........................................................................................................................
Revert to WIP Steps..........................................................................................................................
Scale Batch..........................................................................................................................................
Start Completed Resource Transaction.........................................................................................
Theoretical Yield Batch....................................................................................................................
Unrelease Batch.................................................................................................................................
Unrelease Steps .................................................................................................................................
Update Actual Resource Usage ......................................................................................................
Update Batchstep Activity...............................................................................................................
Update Batchstep Resource.............................................................................................................
Update Line Allocations..................................................................................................................
Update Material Detail Line...........................................................................................................
4-30
4-31
4-34
4-36
4-39
4-41
4-43
4-44
4-47
4-49
4-50
4-51
4-52
4-53
4-54
4-55
4-56
4-58
4-60
4-61
4-62
4-63
4-65
4-66
4-69
4-72
Messages and Errors

Handling Messages ............................................................................................................................ A-1
Interpreting Error Conditions .......................................................................................................... A-5
Understanding Error Messages........................................................................................................ A-5
Listing of GMEPAPIS.pls
Index
vi
Send Us Your Comments

Oracle Process Manufacturing Process Execution API Users Guide, Release 11i
Part No. A97388-03
Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this
document. Your input is an important part of the information used for revision.
Did you find any errors?

Is the information clearly presented?
Do you need more information? If so, where?
Are the examples correct? Do you need more examples?
What features did you like most?
If you find any errors or have any other suggestions for improvement, please indicate the document
title and part number, and the chapter, section, and page number (if available). You can send comments to us in the following ways:
FAX: 650-506-7200 Attn: Oracle Process Manufacturing

Postal service:
Oracle Corporation
Oracle Process Manufacturing
500 Oracle Parkway
Redwood City, CA 94065
U.S.A.
Electronic mail message to [email protected]

If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address.
If you have problems with the software, please contact your local Oracle Support Services.
vii
viii
Preface
Audience for This Guide
Welcome to Release 11i of the Oracle Process Manufacturing Process Execution 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 Process Execution APIs
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 Process Execution APIs.
Chapter 1 describes how APIs are used, the basic business need of APIs, and the
different Process Execution APIs offered.
Chapter 2 describes how to use the Process Execution APIs.
Chapter 3 describes the technical aspect of the APIs.
Chapter 4 describes the business objects for each API.
Appendix A describes messages and error codes.
ix
Appendix B lists the full GMEPAPIS.pls file.
A Glossary provides definitions of terms that are used in this guide.
Documentation Accessibility
Our goal is to make Oracle products, services, and supporting documentation
accessible, with good usability, to the disabled community. To that end, our
documentation includes features that make information available to users of
assistive technology. This documentation is available in HTML format, and contains
markup to facilitate access by the disabled community. Standards will continue to
evolve over time, and Oracle Corporation is actively engaged with other
market-leading technology vendors to address technical obstacles so that our
documentation can be accessible to all of our customers. For additional information,
visit the Oracle Accessibility Program Web site at
http://www.oracle.com/accessibility/.
Accessibility of Code Examples in Documentation

JAWS, a Windows screen reader, may not always correctly read the code examples
in this document. The conventions for writing code require that closing braces
should appear on an otherwise empty line; however, JAWS may not always read a
line of text that consists solely of a bracket or brace.
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 System Administration.
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 System Administration. 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 OracleMetaLink.
xi
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 OracleMetaLink.
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 Process Execution APIs share 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
Process Execution APIs.
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 System Administration (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 choosing Getting 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.
xii
Since OPM is closely integrated with Oracle General Ledger (GL), much of the
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.
xiii
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
xiv
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.
Using Oracle Advanced Planning and Scheduling with Oracle Process

Manufacturing
Oracle Process Manufacturing and Oracle Advanced Planning and Scheduling
(APS) combine to provide a solution for process manufacturers that can help
increase planning efficiency. This solution 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
Using Oracle Advanced Planning and Scheduling with Oracle Process Manufacturing
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
xv
data. Through the Manufacturing Scheduling application, you can optimize the
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.
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
xvi
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
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
xvii
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.
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.
xviii
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 System Administration. This manual details additional steps and
setup considerations for implementing Oracle Process Manufacturing System
Administration with this feature.
Multiple Organizations in Oracle Applications

This guide describes how to set up and use Oracle Process Manufacturing System
Administration 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 System Administration.
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 System Administration implementation team, as well
as for users responsible for the ongoing maintenance of Oracle Applications
xix
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 OracleMetaLink.
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.
Training and Support

Training
Oracle offers a complete set of training courses to help you and your staff master
Oracle Process Manufacturing Process Execution 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
xx
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
Process Execution 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
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
xxi
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.
xxii
Your Feedback
Thank you for using Oracle Process Manufacturing Process Execution 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 Process Execution 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
Redwood Shores, CA 94065
U.S.A.
Or, send electronic mail to [email protected].
xxiii
xxiv
1
API Introduction
This document describes the Application Program Interfaces (APIs) that support
external interfaces to Oracle Process Manufacturing (OPM) Process Execution
application. The topics discussed in this chapter are:
n
Introducing the Process Execution APIs
Basic Business Needs
Major Features
Process Execution API Bill of Materials
API Introduction
1-1

Process Execution APIs let you import information from another system into the
OPM Process Execution tables. When you import this information you can include
all pertinent information using a tool that does not have cryptic IDs and system
specific information. The interface ensures that your imported data contain the
same detail as those you enter manually on the OPM Process Execution windows.
This document describes the usage of the business objects that are stored as
PL/SQL packages within the OPM database schema, such as:
n
Stored procedures used within these packages

Parameters that these procedures accept and the values that return to the calling
program
Multilingual support
Error handling methodology
What Is In This Document

This document describes the basic business needs, major features, architecture, and
components for the Process Execution APIs insert, update, and delete features. 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 Process Execution application.
Process Execution APIs are written in PL/SQL that can be called by your own
programs. To make use of these APIs, code your wrapper function that passes the
appropriate parameters to the APIs. Your program is responsible for connecting to a
database before calling an API function, and disconnecting from the database upon
return. You can choose to write 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:
n
S for success
E for error
U for unknown or unexpected status
N for item requiring a location
V for inventory shortage exists
I for incomplete manual transactions exist
G for over allocation exists
1-2 Oracle Process Manufacturing Process Execution API Users Guide
Process Execution API Support Policy

Process Execution APIs are supported by Oracle. This means:
n
Oracle provides objects and libraries needed to use 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.
Technical Requirements
Process Execution APIs make use of the following standard Oracle Applications
packages:
n
FND_API - the standard Oracle Applications API version checking function.

This is used by the stored procedure to check for a 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 search the procedure messages.
These packages are installed as part of the current release. Refer to the Oracle
Applications Coding Standards manual for additional details.
Technical Overview
Process Execution APIs are designed to operate in an OPM 11i environment only.
They offer the following basic API functionality:
n
Creating, updating, and deleting information.
Proper encapsulation.
Synchronous processing following the business hierarchy.
Detailed and translatable error messages.

These APIs let you feed information from shop floor equipment or Manufacturing
Execution Systems (MES) directly into OPM Process Execution.
API Introduction
1-3
In addition, these APIs serve as a central place to insert, update, or delete batch
records in OPM from any source.
Following are some of the important characteristics for these APIs:
Code Reuse
You can maximize code reuse from all application development tools, including
PL/SQL, Oracle Forms, and Oracle Reports.
Ease of Integration
You can integrate APIs into other applications and enabling technology, such as
Oracle Workflow Server, Oracle Internet Commerce & Oracle WebSystem, and
Oracle EDI Gateway.
Insulation from Changes

You can encapsulate the structure of schema to prevent changing schema structures
from affecting other applications.
Consistent Behavior
You can hide Object logic specific to an application from other applications, and to
ensure that this logic is correctly invoked by other applications and customers.
Robust Validation
You can validate all incoming information into Oracle Applications.
Input Data Sources

Flat File
Input data to the user wrapper function comes from a flat file source. This is
processed by the wrapper and header information, passed as parameters, to the
stored procedure in a synchronous mode. However, along with the standard
parameters, the header information is passed as a PL/SQL table. In this mode, the
calling function monitors the success or failure (return code) from the called
procedure. It also provides an option to COMMIT work done by the procedure.
Batch File
Input data to the user wrapper function comes from a batch file. This is processed
by the wrapper and header information passed, as parameters, to the stored
procedure in an asynchronous mode. In this mode, the calling function does not
monitor the success or failure of each individual record. The Oracle Message FND_
PUB_MSG functionality is used to audit the calls.
Online User Interface (UI)

Input data to the user wrapper function comes from a window or another user
interface. This is processed by the UI and the details passed, as parameters, to the
stored procedure in a synchronous mode. In this mode, the UI calling function
monitors the success or failure (return code) from the called procedure. It also
provides an option to COMMIT work done by the procedure.
Wrapper Function
Windows are generally used as wrapper functions.
The wrapper function is responsible for collating the details required as input
parameters to the stored procedure and forwarding these in the call and monitoring
the return code.
The stored procedure returns three possible return code:
n
S for success
E for error
Based on the return, the wrapper function searches the Oracle Messages File for the
stored procedure to determine a COMMIT of the transaction or not.
Stored Procedure
The stored procedure is called with the appropriate parameters forwarded in a
PL/SQL table format. The procedure validates each record from this table and then
processes the appropriate functional logic as required. The procedure writes
appropriate messages to the Oracle Messages table. These are informational as
determined by the logic. These can be interrogated by the calling wrapper function
through the GET MESSAGES functionality.
API Introduction
1-5
Major Features
The stored procedure calls other validation procedures in the course of its
execution; a modular approach has been adopted. Functions called by these
procedures do not use IN/OUT parameters as these have been removed from the
Oracle 8 coding standards.
On successful completion of the procedure, a success unit is in place that can be
optionally COMMITTED. The decision as to whether a COMMIT is issued on
successful completion is under the control of the calling code and deliberately
outside the scope of the API procedures.
Major Features
In order to support the requirements mentioned in the Basic Business Needs
topic, the new APIs support the following functionality:
Allocate Batch
The Allocate Batch API autoallocates a batch and all the phantom batches.
Allocate Line
The Allocate Line API autoallocates the material detail line.
Cancel Batch
The Cancel Batch API is a business object that nullifies a batch. The batch remains in
the database for audit purposes, but it has a specific status of cancelled and any
effect it has on inventory is reversed.
Close Batch
The Close Batch API is a business object that closes the batch. Closing a batch
prevents further editing of a batch, and makes it available for use by Actual
Costing.
Close Steps
The Close Step API is a business object that closes the batch step. Closing a batch
step prevents further editing.
Complete Batch
The Complete Batch, or certify batch, API is a business object that completes the
batch. Completing a batch indicates that the batch has been completed and the
Major Features
products and byproducts have been yielded. Completing a batch lets adjustments to
ingredient, product, and byproduct quantities.
Complete Steps
The Complete Step, or certify batch step, API is a business object that completes a
single batch step or multiple batch steps based on certain criteria. Completing a step
is how output quantities are specified, or defaulted, for items yielded in the step.
Resource usage for all activities is also calculated. If this is the final step, then
completing it results in a batch completion when the GME:Step Control Batch Status
profile option is set to Yes.
Convert FPO to Batches

The Convert FPO to Batches API is used to convert the firm planned order to one or
more batches.
Create Batch
The Create Batch API is a business object that creates batches, lab batches, and Firm
Planned Orders (FPOs) in OPM.
Create Phantom
The Create Phantom API creates phantom batches based on the validity rule passed.
Delete Batchstep Activity

This Delete Batchstep Activity API deletes the batchstep activity of a step in batch.
A batchstep activity can be deleted for the pending step of a pending batch only.
Delete Batchstep Resource

An existing resource can be deleted for an activity of a step. A resource can be
deleted for a pending step only.
Delete Line Allocations

The Delete Line Allocation API deletes the current allocation. If the transaction is
pending, then it is marked for delete. If the transaction has been completed, then it
is reversed by adding a new allocation for the line with an equal, but opposite
quantity. This done with the Create Transaction API.
API Introduction
1-7
Major Features
Delete Material Detail Line

The Delete Material Detail Line API deletes the material line in the batch.
Delete Step
The Delete Step API deletes the step in the batch.
End Completed Resource Transaction

The End Completed Resource Transaction API is a business object that lets you
create completed resource transactions for a specified end date.
Incremental Backflushing
The Incremental Backflushing, or partial certification, API is a business object that
lets you incrementally record product yield and have ingredient usage backflushed.
Insert Incremental Completed Transaction

The Insert Incremental Completed Transaction API is a business object that lets you
create completed resource transactions for the usage specified in addition to
existing resource transactions.
Insert Batchstep Activity

The Insert Batchstep Activity API adds a batchstep activity to the step of a batch. A
batchstep activity can be added to a step only if the step status is pending, work in
process, or completed. If ASQC is on, the batchstep activity cannot be added for a
step status of work in process. Based on the step status and ASQC, all the input
data is validated.
Insert Batchstep Resource

A resource can be added for an activity of a step. A resource can be added for a step
in pending, WIP, and completed step status only. If ASQC is on, then the resource
cannot be added in WIP status since the process quantity cannot be inserted. Based
on the step status and ASQC, all the input data is validated.
Insert Line Allocation

The Insert Line Allocation API lets you create pending or complete allocations for a
given detail line in a given batch. The batch can be in a pending, WIP, or certified
state and the material detail line can have any release type.
Major Features
Insert Material Detail Line

The Insert Material Detail Line API is used to insert the material line into the batch.
Insert Step
The Insert Step API inserts the new step to the batch.
Insert Timed Resource Transaction

The Insert Timed Resource Transaction API is a business object that lets you create
completed resource transactions for the specified start and end dates, and calculate
the usage from in the resource usage unit of measure from this information.
Release Batch
The Release Batch API is a business object that converts pending batches to work in
process (WIP) batches in OPM.
Release Steps
The Release Step API is a business object that can release a single batch step or
multiple batch steps based on certain criteria. If the profile option GME:Step
Control Batch Status is set to Yes, then it will also release the batch.
Reopen Batch
The Reopen Batch API changes the status of the batch from closed to completed.
Reopen Steps
The Reopen Steps API changes the status of the step from closed to completed.
Reroute Batch
The Reroute Batch API is a business object that reroutes a batch to a different recipe
with the same formula. The batch or firm planned order is only rerouted in pending
status.
Reschedule Batch
The Reschedule Batch API is a business object that reschedules a batch or firm
planned order to a different date. The batch is only rescheduled while in pending or
WIP status. The firm planned order is only rescheduled when in a pending state.
API Introduction
1-9
Major Features
Reschedule Step
The Reschedule Step API reschedules the step and all subsequent steps.
Scale Batch
The Scale Batch API scales batches up or down, as well as all the phantom batches.
Start Completed Resource Transaction

The Start Completed Resource Transaction API is a business object that lets you
create completed resource transactions for a specified start date. The end date is
populated with the start date.
Theoretical Yield Batch

The Theoretical Yield Batch API calculates theoretical yield for the batch, and
updates the quantities for the product lines.
Revert to WIP Batch

The Revert to WIP Batch, or uncertify batch, API is a business object that
uncompletes the batch. Reverting a batch to WIP can set completed product and
byproduct transactions to pending, and put the batch status back to WIP from
completed.
Revert to WIP Steps

The Revert to WIP Steps, or uncertify batch steps, API is a business object that
changes a batch step from completed to WIP.
Unrelease Batch
The Unrelease Batch API removes the completed allocations for the ingredient lines.
Unreleasing a batch sets the batch status to pending.
Unrelease Steps
The Unrelease Step API is a business object that unreleases a batch step based on
certain criteria. Unreleasing a step sets the step to pending status.
Update Actual Resource Usage

The Update Actual Resource Usage API is a business object that lets you create
completed resource transactions for the usage specified, and deletes all existing
transactions.
Update Batchstep Activity

The Update Batchstep Activity API updates the batchstep activity of a step. A
batchstep activity can be updated for a step in the status pending, work in process,
and completed. Based on the step status and ASQC, all the input data is validated
before the batchstep activity gets updated. Depending on the step status, different
fields of the batchstep activity can be updated.
Update Batchset Resource

An existing resource can be updated for an activity of a step. A resource can be
updated for a step in pending, WIP, and completed step status only. Based on the
step status and ASQC, all the input data is validated before the resource in updated.
Based on the step status, different fields of the resource can be updated.
Update Line Allocations

The Update Allocation API lets you update pending or complete allocations for a
given detail line in a given batch. The batch can be in a pending, WIP, or completed
state and the material detail line can have any release type. In some cases, it
disregards some values being passed in.
Update Material Detail Line

The Update Material Detail Line API updates the material line in the batch.

The following are packages and files that are delivered with the OPM Process
Execution APIs. These must be on your system for your interface to compile and
link properly.
n
GMEGAPIS.pls: GME_API_GRP
GMEGTXNS.pls: GME_TRANS_ENGINE_GRP
GMEMATLS.pls: GME_API_MATERIAL_DETAILS
GMEPAPIS.pls: GME_API_PUB
GMEUDBGS.pls: GME_DEBUG
GMEUTXNS.pls: GME_TRANS_ENGINE_UTIL
GMEVALBS.pls: GME_API_ALLOCATE_BATCH_PVT
GMEVALLS.pls: GME_API_ALLOCATE_LINE_PVT
API Introduction 1-11
GMEVCCBS.pls: GME_CANCEL_BATCH_PVT
GMEVCCSS.pls: GME_CANCEL_STEP_PVT
GMEVCFPS.pls: GME_API_CONVERT_FPO
GMEVCLBS.pls: GME_API_CLOSE_BATCH
GMEVCLSS.pls: GME_API_CLOSE_STEP
GMEVCRBS.pls: GME_API_CREATE_BATCH
GMEVCRSS.pls: GME_API_CREATE_STEP
GMEVCTBS.pls: GME_API_CERTIFY_BATCH
GMEVCTSS.pls: GME_API_CERTIFY_BATCH_STEP
GMEVDBSS.pls: GME_API_DELETE_BATCH_STEP
GMEVGBHS.pls: GME_BATCH_HEADER_DBL
GMEVGBSS.pls: GME_BATCH_STEPS_DBL
GMEVGHSS.pls: GME_BATCH_HISTORY_DBL
GMEVGITS.pls: GME_INV_TXNS_GTMP_DBL
GMEVGLBS.pls: GME_LAB_BATCH_LOTS_DBL
GMEVGMDS.pls: GME_MATERIAL_DETAILS_DBL
GMEVGRGS.pls: GME_RESOURCE_TXNS_GTMP_DBL
GMEVGRTS.pls: GME_RESOURCE_TXNS_DBL
GMEVGSAS.pls: GME_BATCH_STEP_ACTIVITIES_DBL
GMEVGSDS.pls: GME_BATCH_STEP_DEPEND_DBL
GMEVGSIS.pls: GME_BATCH_STEP_ITEMS_DBL
GMEVGSOS.pls: GME_BATCH_SALES_ORDERS_DBL
GMEVGSRS.pls: GME_BATCH_STEP_RESOURCES_DBL
GMEVGSTS.pls: GME_BATCH_STEP_TRANSFERS_DBL
GMEVINSS.pls: GME_API_INSERT_STEP
GMEVPCBS.pls: GME_API_PARTIAL_CERT
GMEVPHBS.pls: GME_API_PHANTOM
GMEVRLBS.pls: GME_API_RELEASE_BATCH
GMEVRLSS.pls: GME_API_RELEASE_BATCH_STEP
GMEVROBS.pls: GME_REOPEN_BATCH_PVT
GMEVROSS.pls: GME_REOPEN_STEP_PVT
GMEVRRBS.pls: GME_API_REROUTE_BATCH
GMEVRSBS.pls: GME_API_RESCHEDULE_BATCH
GMEVRSSS.pls: GME_API_RESCHEDULE_BATCH_STEP
GMEVRXNS.pls: GME_RESOURCE_ENGINE_PVT
GMEVSCBS.pls: GME_API_SCALE_BATCH AUTHID CURRENT_USER
GMEVTSTS.pls: GME_API_TEST
GMEVTXNS.pls: GME_TRANS_ENGINE_PVT
GMEVTXTS.pls: GME_TEXT_DBL
GMEVUCBS.pls: GME_API_UNCERTIFY_BATCH
GMEVUCSS.pls: GME_API_UNCERTIFY_BATCH_STEP
GMEVURBS.pls: GME_API_UNRELEASE_BATCH
GMEVURSS.pls: GME_API_UNRELEASE_STEP
GMEVUSQS.pls: GME_API_UPDATE_STEP_QTY
GMDPRDTS.pls: GMD_RECIPE_DATA_PUB
GMDPCOMS.pls: GMD_COMMON_VAL
GMDSTEPS.pls: GMD_AUTO_STEP_CALC
GMDVSCLS.pls: GMD_COMMON_SCALE
GMDPOPNS.pls: GMD_FETCH_OPRN
GMDPRCFS.pls: GMD_RECIPE_FETCH_PUB
GMDPVRFS.pls: GMD_FETCH_VALIDITY_RULES
GMDPVRDS.pls: GMD_VAL_DATA_PUB
GMDPRVRS.pls: GMD_VALIDITY_RULES
GMDPRTVS.pls: GMDRTVAL_PUB
GMAGMETS.pls: GMA_GME_TEXT_TBL_PKG
GMEPTXNB.pls: UPDATE_LINE_ALLOCATION
API Introduction 1-13
GMEPTXNB.pls: DELETE_LINE_ALLOCATION
GMEVACBS.pls:GME_INSERT_BATCHSTEP
GMEVACBS.pls:GME_DELETE_BATCHSTEP
GMEVACBS.pls:GME_UPDATE_BATCHSTEP
GMEVACTS.pls:INSERT_BATCHSTEP_ACTIVITY
GMEVACTS.pls:UPDATE_BATCHSTEP_ACTIVITY
GMEVACTS.pls:DELETE_BATCHSTEP_ACTIVITY
2
Process Execution API Usage
The Process Execution APIs are written in PL/SQL. To use these APIs, you must
code your interface or wrapper. Your program is responsible for connecting to a
database before calling an API function. You can write log files before calling and
after returning from an API function. Each function returns an error code in the
parameter x_return_status that indicates whether the API was successful or failed.
The values are:
n
S for success
E for error
The topics discussed in this chapter are:

n
Calling the API Interface Code
API Wrapper Code - Example
Process Execution API Usage 2-1

The following are part of a sample wrapper, and are used to test the API code.
Wrappers are written as PL/SQL packages. Wrappers can be written for each API
and call the APIs directly. The source of data for the wrapper comes from an ASCII
flat file in this example. You can write a similar type of wrapper to call the API code.
These wrappers have the following parameters:
Standard Input Parameters

p_api_version
IN
NUMBER
p_validation_level
IN
NUMBER
p_init_msg_list
IN
BOOLEAN
p_commit
IN
BOOLEAN
Standard Output Parameters

x_message_count
OUT NUMBER
x_message_list
OUT VARCHAR2
x_return_status
OUT VARCHAR2
API Call 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, you must pass in different variables. In addition, you must 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.
For example, the Update_material_line API contains p_material_detail and x_
material_detail:
PROCEDURE update_material_line (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
NUMBER := gme_api_pub.api_version
NUMBER := gme_api_pub.max_errors
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
,x_return_status
,p_material_detail
,p_values_tab
,p_scale_phantom
,x_material_detail
OUT NOCOPY VARCHAR2

IN
gme_material_details%ROWTYPE
IN
gme_api_pub.field_values_tab
IN
BOOLEAN := FALSE
OUT NOCOPY gme_material_details%ROWTYPE);
Therefore, the call can be set up to read:

gme_api_main.update_material_line(p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_material_detail
,p_values_tab
,p_scale_phantom
,x_material_detail
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
p_api_version
p_validation_level
FALSE
p_commit
x_message_count
x_message_list
x_return_status
l_material_detail
p_values_tab
p_scale_phantom
l_material_detail);
In this example, p_material_detail and x_material_detail both have the variable l_

material_detail. This gives an incorrect result because both the parameters cannot
have the same variable.
You must set the call up so that p_material_detail and x_material_detail have
different variables:
gme_api_main.update_material_line(p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_material_detail
,p_values_tab
,p_scale_phantom
,x_material_detail
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
=>
p_api_version
p_validation_level
FALSE
p_commit
x_message_count
x_message_list
x_return_status
l_material_detail_in
p_values_tab
p_scale_phantom
l_material_detail_out);

--+==========================================================================+
--| PROCEDURE NAME
|
--| Create_Batch
|
--|
|
--| TYPE
|
--| Public
|
--|
|
--| USAGE
|
--| Create_Batch
|
--|
|
--| DESCRIPTION
|
--| This is a PL/SQL wrapper function to call the Create Batch API.
|
--|
|
--| REQUIREMENTS
|
--|
This wrapper assumes that the user has initialized the application
|
--|
user variables. To do this the procedure fnd_global.apps_initialize
|
--|
needs to be invoked with the appropriate user id and responsibility
|
--|
|
--|
The user has to supply the following required values
|
--|
p_batch_type
0 - Batch, 10 - Firm Planned Order
|
--|
p_orgn_code
Plant in which the batch is created
|
--|
p_creation_mode
PRODUCT, RECIPE, OUTPUT or INPUT
|
--|
p_batch_size
The size of the batch to be created
|
--|
p_batch_size_uom
The Unit of measure code of the batch size|
--|
p_recipe_validity_rule_id The recipe validity rule ID with which the|
--|
batch has to be created. This field could |
--|
be omitted if any of the following combi- |
--|
nations are provided
|
--|
p_recipe_id or
|
--|
p_recipe_no, p_recipe_version or
|
--|
p_product_id (Item_Id) or
|
--|
p_product_no (Item_No)
|
--|
p_batch_no
This is required if the plant is set for |
--|
manual document ordering
|
--|
Out Variables
|
--+==========================================================================+
PROCEDURE create_batch
( p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,P_batch_type
,p_orgn_code
,p_creation_mode
,p_batch_size
,p_batch_size_uom
IN
IN
IN
IN
NUMBER
NUMBER
BOOLEAN
BOOLEAN
IN
IN
IN
IN
IN
NUMBER
VARCHAR2
VARCHAR2
NUMBER
VARCHAR2
DEFAULT
DEFAULT
DEFAULT
DEFAULT
gme_api_pub.api_version
gme_api_pub.max_errors
FALSE
FALSE
,p_plan_start_date
,p_plan_cmplt_date
,p_due_date
,p_update_inventory_ind
IN
IN
IN
IN
DATE
DATE
DATE
VARCHAR2
DEFAULT
DEFAULT
DEFAULT
DEFAULT
SYSDATE
SYSDATE
SYSDATE
'Y'
,p_recipe_validity_rule_id IN
NUMBER
DEFAULT NULL
,p_recipe_id
,p_recipe_no
,p_recipe_version
,p_product_no
,p_product_id
,p_batch_no
IN
IN
IN
IN
IN
IN
NUMBER
DEFAULT NULL
VARCHAR2 DEFAULT NULL
NUMBER
DEFAULT NULL
NUMBER
DEFAULT NULL
,p_ignore_qty_below_cap
,p_ignore_shortages
IN
IN
BOOLEAN
BOOLEAN
,x_batch_header
,x_unallocated_material
OUT
OUT
gme_batch_header%ROWTYPE
gme_api_pub.unallocated_materials_tab
,x_message_count
,x_message_list
,x_return_status
OUT
OUT
OUT
NUMBER
VARCHAR2
VARCHAR2 ) IS
DEFAULT TRUE
DEFAULT TRUE
l_batch_headerGME_BATCH_HEADER%ROWTYPE;
l_msg_index_outNUMBER;
BEGIN
/* Enable The Buffer */
DBMS_OUTPUT.ENABLE(1000000);
/* Let us build the batch row type variable with the input values */
l_batch_header.plant_code := p_orgn_code;
l_batch_header.batch_type := p_batch_type;
l_batch_header.batch_no:= p_batch_no;
l_batch_header.plan_start_date := p_plan_start_date;
l_batch_header.plan_cmplt_date := p_plan_cmplt_date;
l_batch_header.due_date := p_due_date;
l_batch_header.update_inventory_ind := p_update_inventory_ind;
IF p_recipe_validity_rule_id IS NOT NULL THEN
l_batch_header.recipe_validity_rule_id := p_recipe_validity_rule_id;
END IF;
gme_api_pub.create_batch(
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
=>
=>
=>
=>
p_api_version
p_validation_level
p_init_msg_list
p_commit
,x_message_count
,x_message_list
,x_return_status
=>
=>
=>
x_message_count
x_message_list
x_return_status
,p_batch_header
,x_batch_header
=>
=>
l_batch_header
x_batch_header
,p_batch_size
,p_batch_size_uom
,p_creation_mode
,p_recipe_id
,p_recipe_no
,p_recipe_version
,p_product_no
,p_product_id
=> p_batch_size
=> p_batch_size_uom
=> p_creation_mode
=> p_recipe_id
=> p_recipe_no
=> p_recipe_version
=> p_product_no
=> p_product_id
,p_ignore_shortages
=>
=>
p_ignore_qty_below_cap
p_ignore_shortages
=>
x_unallocated_material );
IF x_return_status <> FND_API.g_ret_sts_success THEN

IF X_message_count = 1 THEN
DBMS_OUTPUT.PUT_LINE('Error:'||X_message_list);
ELSE
FOR i IN 1..x_message_count LOOP
FND_MSG_PUB.get (p_msg_index
=> i
,p_data
=> X_message_list
,p_msg_index_out => l_msg_index_out);
DBMS_OUTPUT.PUT_LINE('Error:'||X_message_list);
END LOOP;
END IF;
ELSE
DBMS_OUTPUT.PUT_LINE(' A new batch '||x_batch_header.batch_no||' has been
created ');
IF x_unallocated_material.count > 0 THEN
DBMS_OUTPUT.PUT_LINE(' Items failing auto allocation:');
FOR i IN 1..x_unallocated_material.COUNT LOOP
DBMS_OUTPUT.PUT_LINE(' Line Type:'||x_unallocated_material(i).line_
type||' Line No:'||x_unallocated_material(i).line_no||
' Item:'||x_unallocated_material(i).item_no||'
Allocated:'||x_unallocated_material(i).alloc_qty||
' Unalloc:'||x_unallocated_material(i).unalloc_
qty||' UOM:'||x_unallocated_material(i).alloc_uom);
END LOOP;
END IF;
END IF;
EXCEPTION
WHEN OTHERS THEN
x_return_status := FND_API.g_ret_sts_unexp_error;
x_message_count := 1;
x_message_list := SQLERRM;
dbms_output.put_line('Error '||TO_CHAR(SQLCODE)||': '||SQLERRM);
END Create_Batch;
3
Technical Overview
The public Process Execution APIs perform all validations necessary on input data
supplied in order to prevent the flow of invalid data into OPM. If any validation
errors occur, then that particular row is skipped and the process continues to the
next record. If the insert fails, then none of the detail records for the item in process
are inserted. After finishing validations on input data, the public API performs the
required function by calling the necessary routines.
The topics discussed in this chapter are:
n
Structure for Process Execution Public APIs
Standard Parameters
Technical Overview
3-1

According to API standards, the following are the files, packages, and procedures
for the public APIs.
Object Type
Name
Package Specification File
GMEPAPIS.pls
Package Body File
GMEPAPIB.pls
Package
gme_api_pub
Procedure - Allocate Batch
allocate_batch
Procedure - Allocate Line
allocate_line
Procedure - Cancel Batch
cancel_batch
Procedure - Close Batch
close_batch
Procedure - Close Batch Steps
close_step
Procedure - Complete Batch
certify_batch
Procedure - Complete Batch Steps
certify_batch_step
Procedure - Convert FPO to Batches
convert_fpo
Procedure - Create Batch
create_batch
Procedure - Create Phantom
create_phantom
Procedure - Delete Batchstep Activity
delete_batchstep
Procedure - Delete Batchstep Resource
delete_batchstepresource
Procedure - Delete Line Allocation
delete_line_allocation
Procedure - Delete Material Line Detail
delete_material_line
Procedure - Delete Step
delete_step
Procedure - Incremental Backflushing
partial_cert_batch
Procedure - End Completed Resource

Transaction
end_cmplt_actual_rsc_txn
Procedure - Insert Batchstep Activity
insert_batchstep
Procedure - Insert Batchstep Resource
insert_batchstepresource
Procedure - Insert Incremental Completed

Transaction
insert_incr_actual_rsrc_txn
Object Type
Name
Procedure - Insert Line Allocation
insert_allocation
Procedure - Insert Material Line Detail
insert_material_line
Procedure - Insert Step
insert_step
Procedure - Insert Timed Resource

Transaction
insert_timed_actual_rsrc_txn
Procedure - Release Batch
release_batch
Procedure - Release Batch Steps
release_step
Procedure - Reopen Batch
reopen_batch
Procedure - Reopen Batch Steps
reopen_step
Procedure - Reroute Batch
reroute_batch
Procedure - Reschedule Batch
reschedule_batch
Procedure - Reschedule Batch Step
reschedule_step
Procedure - Scale Batch
scale_batch
Procedure - Start Completed Resource

Transaction
start_cmplt_actual_rsrc_txn
Procedure - Theoretical Yield Batch
theoretical_yield_batch
Procedure - Revert to WIP Batch
uncertify_batch
Procedure - Revert to WIP Batch Steps
uncertify_batch_step
Procedure - Unrelease Batch
unrelease_batch
Procedure - Unrelease Batch Steps
unrelease_step
Procedure - Update Actual Resource Usage
update_actual_resource_usage
Procedure - Update Batchstep Activity
update_batchstep
Procedure - Update Batchset Resource
update_batchstepresource
Procedure - Update Line Allocation
update_line_allocation
Procedure - Update Material Detail Line
update_material_line
Technical Overview
3-3
Standard Parameters
Standard Parameters
API standard parameters are a collection of parameters that are common to most
APIs. The following paragraphs explain the standard parameters used in APIs and
their interpretation.
Some of the standard parameters apply to all APIs regardless of the nature of the
business function they perform. For example, p_api_version and x_return_status
are included in all APIs.
Some parameters are applicable for certain types of APIs and not applicable for
other types. For example, p_commit is applicable for APIs that change the database
state, and not applicable for read APIs.
Standard parameters are included in all APIs whenever applicable.
Standard IN parameters:
n
p_api_version
p_init_msg_list
p_commit
p_validation_level
Standard OUT parameters:

n
x_return_status
x_msg_count
x_msg_data
Parameter
Type
IN/OUT
Required
Validation
p_api_
version
varchar2
IN
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.
Standard Parameters
Parameter
Type
IN/OUT
Required
Validation
p_init_msg_
list
boolean
IN
Used to specify whether the message list

is initialized on entry to the API. It is an
optional parameter, and if not supplied,
defaults to FND_API.G_ FALSE which
means that the API does not initialize the
message list. If multiple APIs are called
in same session, then you must pass this
as TRUE, otherwise messages accumulate
on the stack.
p_commit
boolean
IN
Used to specify whether the API commits

its work before returning to the calling
function. If not supplied, then it defaults
to FALSE. Ensure that the save_batch
procedure is called before performing
any commits manually (if p_commit
parameter is passed as FALSE).
x_return_
status
varchar2
OUT
Specifies whether the API was successful

or failed. Valid values are S for
successful, E for failed due to expected
error, or U for failed due to unexpected
error.
x_msg_
count
number
OUT
Specifies the number of messages added

to message list.
x_msg_data
varchar2
OUT
Returns the messages in an encoded

format. These messages are processed by
the standard message functions as
defined in the Business Object API
Coding Standards Document.
Value-ID Conversion
IDs are usually used to represent primary and foreign entity keys, and for internal
processing of attributes. They are not meaningful and are hidden. Besides IDs,
attributes have values that represent them. Those values are meaningful and are
used for display purposes. In general, APIs operate only on IDs.
For example, an item is represented by an ID, the number column item_id. This ID
is its primary key and is used for all internal processing of the item. Besides this ID,
an item is represented by a value, the varchar2 column item_no. This value is
displayed when you choose an item. Therefore, an item can be identified by either
its ID or value, in this case item_no.
Technical Overview
3-5
Standard Parameters
The following set of rules are for the conversion process:

n
Either ID or value, or both can be passed to an API. But, when both values are
passed, ID based parameters take precedence over value based parameters. For
example, if both parameters are passed, the value based parameter is ignored
and the ID based parameter is used.
When both the value and ID of an attribute are passed to an API, a message
informs the API caller that some of the input has been ignored.
This message is not an error message. The API continues with its regular
processing.
Each value has to resolve into one ID. Failure to resolve a value into an ID is an
error and is associated with an error message. The API aborts processing and
returns with a return status of error.
4
Business Objects
Allocate Batch
This procedure autoallocates ingredients in a batch and all phantom batches.
Following is the definition of Allocate Batch:
Parameter
Required
In/Out
Description
p_allocate_type
IN
For internal use. Always set to 9.
p_release_type
IN
p_batch_header
IN
The batch header row to identify the

batch.
x_batch_header
OUT
The batch header that is returned, with

all the data.
p_del_exist_alloc
IN
Delete existing allocations before

autoallocating. Default value is False.
OUT
Table of materials, unallocated items

exist.
x_unallocated_material Y
Parameter - p_batch_header (IN)

This is a row type parameter that identifies the batch header. The following table
explains the required columns of the row:
Parameter
Description
batch_id
Unique identifier for batches.
batch_no
Batch number for the batch. Batch_no, plant_code, and batch_

type are required if batch_id is not set.
Business Objects 4-1
Allocate Batch
Parameter
Description
plant_code
Organization for which the batch was created. Batch_no, plant_

code, and batch_type are required if batch_id is not set.
batch_type
Type of batch. Values include 0=batch, 10=firm planned order.

Batch_no, plant_code, and batch_type are required if batch_id is
not set.
Parameter - x_batch_header (OUT)

This is a row type parameter that returns the populated batch header for the
allocated batch.
Parameter - x_unallocated_material (OUT)
This is a table type parameter that holds the information of the unallocated
material, inventory shortage, or incomplete manual allocations. The following table
explains how these IDs are returned:
Parameter
Description
batch_id
Unique identifier for batches to firm planned order or batch.
batch_no
Batch or firm planned order number.
material_detail_id
Unique identifier for a batch or firm planned order line.
line_type
Valid values are -1 = Ingredient, 1 = Product; The product on

Line 1 is the primary product, 2 = Byproduct
line_no
Sequential line number for each line type in a batch or firm

planned order.
item_id
FK to the item that is a product, ingredient, or byproduct.
item_no
Item Number.
alloc_qty
Quantity that is allocated.
unalloc_qty
The unallocated quantity.
alloc_uom
Unit of measure for ALLOC_QTY and UNALLOC_QTY also the

material lines ITEM_UM.
Allocate Line
Allocate Line
The Allocate Line API refers to specifying the lots and locations of items used for a
batch. Allocation can be performed automatically by OPM or manually.
This API provides a way to autoallocate a particular ingredient line of batch.
Following is the definition of Allocate Line:
Parameter
Required
In/Out
Description
p_material_details
IN
The material detail row to identify the

material.
p_allocate_type
IN
p_del_exist_alloc
IN
Delete existing allocations before

autoallocating. Default value is False.
Parameter - p_material_details (IN)

This is a row type parameter that identifies the material detail. The following table
Parameter
Description
material_detail_id
Cancel Batch
Cancel Batch
In OPM, batches and firm planned orders (FPOs) are created whenever a
production run for one or more products of a given recipe need to be manufactured.
After creation they are progressed through the various stages of the manufacturing
cycle:
n
Firm planned orders are converted to batches of the required size, number, or size and
number.
Batches are progressed from pending through WIP, completed and closed.
This is the normal business sequence, but there are times when it is necessary to go
back a stage in the cycle.
Once a firm planned order has been converted to batches, it is not possible to
unconvert the batches to a firm planned order. However, it is possible to cancel a
pending batch so that it is annulled.
Firm planned orders can also be cancelled in an identical manner to pending
batches. If the firm planned order is partially converted, for example a 2000kg firm
planned order has so far only been converted to batches totalling 1000kg, then the
unconverted residue is cancelled. The batches already created by partially
converting the firm planned order remains untouched.
If the batch being cancelled contains steps, then this API cancels all steps in the
batch. There is no publicly called Cancel Step API.
If a batch or firm planned order has been cancelled, then there is no way to uncancel
it.
Following is the definition of Cancel Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.

Cancel Batch
Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

cancelled batch.
Close Batch
Close Batch
The Close Batch API is a business object that can close the batch. Closing a batch
prevents further editing.
Only a completed batch can be closed. All steps are closed at that time.
Following is the definition of Close Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.
batch_close_date
The date and time the batch was closed.

This is a row type parameter that returns the populated batch header for the closed
batch.
Close Steps
Close Steps
The Close Step API is a business object that can close the batch step. Closing a batch
step prevents further editing.
When you close a batch step, any items associated with that step, with consumption
or yield type of Automatic by Step, are not editable. Only a completed batch steps
can be closed.
The immediately prior dependent step must have a status of closed to close the
batch step. The batch step row that is passed in must contain sufficient information
to identify the step, this can be batch_id and batchstepno or batchstep_id.
Following is the definition of Close Step:
Parameter
Required
In/Out
Description
p_batch_step
IN
The batch step row to identify the batch

step.
x_batch_step
OUT
The batch step that is returned, with all

the data.
p_delete_pending
IN
Deletes the pending allocations for the

material lines associated with the step.
Parameter - p_batch_step (IN)

This is a row type parameter that identifies the batch step. The following table
Parameter
Description
batchstep_id
Unique identifier for batch steps.
batch_id
ID of the batch. Batch_id and batchstep_no are required if

batchstep_id is not set.
batchstep_no
Step number. Batch_id and batchstep_no are required if

step_close_date
Entered at the time the step is closed. Can be entered by you or

current system date.
Parameter - x_batch_step (OUT)

This is a row type parameter that returns the populated batch step for the closed
step.
Complete Batch
Complete Batch
The complete batch API is a business object that can complete the batch.
Completing a batch indicates that the batch has been completed and the products
and byproducts have been yielded. Completed batches still let adjustments to
ingredient, product, and byproduct quantities.
If any of the ingredients, products, or byproducts are not allocated, then the
complete batch routine returns back the unallocated material lines in the
unallocated materials structure.
Only batches in pending or WIP status can be certified. All steps are also certified at
this time. The batch header that is passed in must contain sufficient information to
identify the batch (firm planned orders are not eligible for certifying).
Following is the definition of Complete Batch:
Parameter
Required
In/Out
Description
p_del_incomplete_
manual
IN
Delete incomplete manual transactions.

Default value is False.
p_ignore_shortages
IN
If set to TRUE, it does not return x_

unallocated_material. This only takes
effect if the GMI:Allow Negative
Inventory profile options is set to 2,
Warning. Default value is False.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
OUT
Table of materials, if inventory shortage

exists, or incomplete manual
transactions exist, or unallocated items
exist.

Parameter
Description
batch_id
Complete Batch
Parameter
Description
batch_no

plant_code

batch_type

not set.
actual_start_date
Actual start date and time for batch. Entered in complete batch
only if the batch was pending. Defaults to current system date.
actual_cmplt_date
Actual completion date. Entered at the time the batch is certified

completed. Can be entered by you or current system date.

completed batch.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
Quantity that is unallocated.
Complete Batch
Parameter
Description
alloc_uom

Complete Steps
Complete Steps
The complete batch step API is a business object that can complete a single batch
step or multiple batch steps based on certain criteria. Completing a step is the way
that output quantities are specified (or defaulted) for items yielded in the step.
Actual resource usage for all the resources is also calculated. The API operates on
steps that have a status of WIP or pending. If this is the final step, then completing
it completes the batch if the GME:Step Controls Batch Status profile options is set to
Yes.
If any of the ingredients, products, or byproducts associated with the step that have
a consumption or yield type of Automatic by Step are not allocated, then the
complete batch step routine returns the unallocated material lines, or incomplete
manual in the unallocated materials structure.
Following is the definition of Complete Step:
Parameter
Required
In/Out
Description
p_del_incomplete_
manual
IN
Delete incomplete manual transactions.

p_ignore_shortages
IN

Warning. Default value is False.
p_batch_step
IN
The batch step row to identify the step.
p_override_quality
IN
If you have access to the function

GMESTPED_COMPLETE_WITHOUT_
QC_F, this parameter enables you to
override the quality status and
complete the step, even though quality
has not been approved. This is done by
passing the value TRUE. The default
value is FALSE.
x_batch_step
OUT

the data.
OUT

exist.
Complete Steps

Parameter
Description
batch_id

batchstep_no

batchstep_id
actual_start_date
Actual start date and time for batch step. Entered in complete
step only if the step was pending. Defaults to current system
date.
actual_cmplt_date
Actual completion date. Entered at the time the batch is

completed. Can be entered by you or current system date.

This is a row type parameter that returns the populated batch step for the
completed step.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
Complete Steps
Parameter
Description
alloc_qty
unalloc_qty
Quantity that was unallocated.
alloc_uom


The Convert FPO to Batches API is used to convert the firm planned order to a
batch.
When you partially convert a firm planned order to a batch, the firm planned order
is scaled down to contain only the remaining quantity.
Following is the definition of Convert FPO to Batches:
Parameter
Required
In/Out
Description
p_enforce_vldt_check
IN
For internal use. Always set to FALSE.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_batch_size
IN
The size of the batch to be created.
p_num_batches
IN
Number of batches to be created. This

must be greater than or equal to one.
p_validity_rule_id
IN
If use_for_all is true, or if you are only

converting one batch, then this
parameter is required.
p_validity_rule_tab
IN
This is used only if a firm planned order

is converted to multiple batches with
different validity rules.
p_leadtime
IN
The duration of the batch.
p_batch_offset
IN
If there are multiple batches, then this is

the offset time between the batches.
p_offset_type
IN
The offset type. Valid values are 0 - start

to start, 1 - finish to start.
p_plan_start_date
IN
The start date of the batch. Defaults to

system date, but can be overridden.
p_plan_cmplt_date
IN
The completion date of the batch.
p_use_for_all
IN
Use the same validity rule for all

batches. Default value is True.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

completed batch.
Parameter - p_validity_rule_tab (IN)
Parameter
Description
validity_rule_id
Validity Rule ID
Create Batch
Create Batch
The Create Batch API is a publicly callable stored procedure that creates batches, lab
batches, and firm planned orders in OPM.
Batch creation is affected by calling the API with a set of parameters that indicates
the following:
n
Which recipe to use for the batch (lab batch or firm planned order).
How it can be created (total input, total output).
The batch quantity or unit of measure.
An indication of whether the batch creation can proceed in the presence of

inventory shortages for those ingredients that are allocated automatically.
If the batch, lab batch, or firm planned order is created successfully, then the API
returns with a status of S. If errors occur, then the return status is E for errors that
are normal but prevent the batch from being created, and U for errors that are
unexpected and prevent the batch from being created, such as database errors.
On successful creation, a fully populated batch header is returned to the caller with
any values that were not filled in, so that the caller has immediate knowledge of the
surrogates allocated.
Following is the definition of Create Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_batch_size
IN
Batch size equalling total input, total

output, or product quantity.
p_batch_size_uom
IN
Unit of measure for batch size.
p_creation_mode
IN
How the batch is created. Valid values

are RECIPE, PRODUCT, TOTAL_
OUTPUT, and TOTAL_INPUT.
p_ignore_shortages
IN

Warning.
Create Batch
Parameter
Required
In/Out
Description
p_recipe_id
IN
The recipe ID for the batch to be

created. Default value is Null.
p_recipe_no
IN
The recipe number and recipe version

for the batch to be created. Default
value is Null.
p_recipe_version
IN
The version of the recipe for the batch

to be created. Default value is Null.
p_product_no
IN
Item number for the batch to be created.

Default value is Null.
p_product_id
IN
The product ID for the batch to be

created.
p_ignore_qty_below_
cap
IN
Indicates whether the batch is to be

created or not, when resource quantity
goes down below the minimum
capacity of the resource. Default value
is True.
OUT

exists, or unallocated items exist.

Parameter
Description
batch_no
Batch number for the batch if it is being created in a plant with

manual document ordering. Batch_no, plant_code, and batch_
type are required.
plant_code

batch_type

not set.
plan_start_date
Planned start date and time for batch. Defaults to system date,
but can be overridden.
plan_cmplt_date
Planned completion date. If a routing is used, or if production

rules are set up, these are used to calculate the planned
completion.
Create Batch
Parameter
Description
due_date
Required batch completion date and time.
recipe_validity_rule_id
Surrogate key to the Recipe Validity Rule Id the batch or FPO is

based on.
wip_whse_code
Warehouse used to cost production activity.

This is a row type parameter that returns the populated batch header for the created
batch.
This is a table type parameter that holds the information of the unallocated material
or inventory shortage. The following table explains how these IDs are returned:
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
alloc_uom

Create Phantom
Create Phantom
The Create Phantom API creates phantom batches based on the validity rule passed.
Following is the definition of Create Phantom:
Parameter
Required
In/Out
Description
p_material_details
IN

material.
x_material_details
OUT
The material detail that is returned,

with all the data.
p_validity_rule_id
IN
Validity rule to use for creating a

phantom batch.
p_ignore_shortages
IN

Warning.
OUT

exist.
p_batch_no
IN
If the organization is set for manual

document ordering, then you must pass
in this parameter. If the organization is
set to be automatic document
numbering, then this parameter is
ignored.
Parameter - p_material_details (IN)

This is a row type parameter that identifies the material details. The following table
Parameter
Description
batch_id
To identify the batch. Batch_id, line_type and line_no are used if

material_detail_id is not set.
line_type

line_no

planned order.
Create Phantom
Parameter
Description
material_detail_id
Parameter - x_material_details (OUT)

This is a row type parameter that returns the populated material details for the
created phantom.
This is a table type parameter that holds the information of the unallocated material
or inventory shortage. The following table explains how these IDs are returned:
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
alloc_uom


This Delete Batchstep Activity API deletes the batchstep activity of a step in batch.
A batchstep activity can be deleted for the pending step of a pending batch only.
Following is the definition of Delete Batchstep Activity:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_batchstep_activity_
id
IN
Batchstep activity ID.
p_batchstep_no
IN
Step number.
p_activity
IN
Batchstep activity name.

An existing resource can be deleted for an activity of a step. A resource can be
deleted for a pending step only.
Following is the definition of Delete Batchstep Resource:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_resource
IN
Resource name.
p_batchstep_no
IN
Step number.
p_activity
IN
Activity name.
p_batchstep_resource_
id
IN
Batchstep resource ID.
Delete Line Allocation
Delete Line Allocation

The Delete Line Allocation API deletes the current allocation. If the transaction is
pending, then it is marked for delete. If the transaction has been completed, then it
is reversed by adding a new allocation for the line with an equal, but opposite,
quantity. This is done with the Create Transaction API.
Following is the definition of Delete Line Allocation:
Parameter
Required
In/Out
Description
p_trans_id
IN
The transaction ID requested for deletion.
p_scale_phantom
IN
If there are any changes to the material

line quantities, then it is backflushed to
the phantom batch. This parameter is
only valid for phantom ingredients.
Default value is FALSE.
x_material_detail
OUT
This is the updated material line row. The

possible updates can be the plan_qty,
wip_plan_qty, actual_qty, and alloc_ind
depending on the batch status and the
allocation change.
x_def_tran_row
OUT
This is the default transaction row for the

material line, with the changes to the
quantities based on the deleted
allocation.

The Delete Material Detail Line API deletes the material line in the batch.
Following is the definition of Delete Material Detail Line:
Parameter
Required
In/Out
Description
p_material_detail
IN
The material detail row to be deleted.
Parameter - p_material_detail (IN)

Parameter
Description
material_detail_id
Unique identifier for a batch or firm planned order line. If this is

not passed, then line_no, line_type, and batch_id must be
passed.
line_no

planned order.
line_type
Valid values are -1 = Ingredient, 1 = Product; the product on

Line 1 is the primary product, 2 = Byproduct.
batch_id
Batch Identifier FK to the GME_BATCH_HEADER table.
Delete Step
Delete Step
The Delete Step API deletes a step in the batch.
Following is the definition of Delete Step:
Parameter
Required
In/Out
Description
p_batch_step
IN
x_batch_step
OUT

the data.

Parameter
Description
batchstep_id
Batch step Identifier. Batch routing step number, defaults from

fm_rout_dtl. If this is not passed, then batch_id and batchstep_
no are required.
batch_id
Unique identifier for batches to FPO or batch.
batchstep_no
Batch step identifier. Batch routing step number, defaults from

fm_rout_dtl.

The End Completed Resource Transaction API sets the end date and resource usage
for a transaction that was created using the Start Completed Resource Transaction
API. This API cannot be used on a transaction that was not created with the Start
Completed Resource Transaction API. This can only be done for a step that is in a
work in process or completed state. The End Completed Resource Transaction API
passes in the resource transaction ID, where a transaction is already started, and the
end_date. The API can end only those transactions that have a value of 0 for the
transaction usage, and end_date and start_date is same. This is done so that
transactions cannot be ended more than once. This API cannot be run against a WIP
step for a batch that has the Calculate Step Quantity indicator checked. You cannot
use this API on a resource transaction that was automatically generated by the
Automatic Step Quantity Calculation functionality.
Following is the definition of End Completed Resource Transaction:
Parameter
Required
In/Out
Description
p_poc_trans_id
IN
To uniquely identify resource

transactions to be ended.
p_end_date
IN
End date of resource transactions.
p_reason_code
IN
Reason code to create a completed

transaction.
p_instance_id
IN
Instance ID for the transactions.
p_instance_no
IN
Instance number for the transactions.
p_trans_date
IN
The date on which the transaction is

booked for financial purposes.
The Incremental Backflushing API is a business object that lets you incrementally
record production yield as it occurs and have ingredient consumption backflushed.
It can only be done on WIP or completed batches off of items with a yield or
consumption type of manual or incremental. You can not drive incremental
backflushing off of an item that has yield or consumption type of Automatic or
Automatic by Step. If any of the ingredients, products, or byproducts are not
allocated, then the incremental backflushing routine returns back the unallocated
material lines in the unallocated materials structure.
If batch_id is provided for the batch_header row and the material_details row, then
the batch_id provided in material_details is used. Subsequently, if the material_
detail_id is provided for the material_details row, then all batch_ids are ignored,
and the batch_id is calculated from the specified material_detail_id.
Following is the definition of Incremental Backflushing:
Parameter
Required
In/Out
Description
p_material_details
IN

material line.
p_qty
IN
The quantity to apply incrementally.
p_trans_date
IN
Transaction date for the incremental

backflushing transactions
p_qty_type
IN
Valid values are 0 - by increment qty, 1 new actual qty, and 2 - percentage of
plan.
p_backflush_phantoms
IN
Backflush the quantities to the

phantoms associated.
p_ignore_shortages
IN

Inventory profile option is set to 2,
Warning.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_adjust_cmplt
IN
Adjust completed batches.
Parameter
Required
In/Out
Description
OUT

exist.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set. Incremental backflushing can not be used with firm
planned orders.

batch.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

Parameter
Description
line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
Quantity to be allocated.
alloc_uom


The Insert Batchstep Activity API adds a batchstep activity to the step of a batch. A
batchstep activity can be added to a step only if the step status is pending, work in
process, or completed. If ASQC is on, the batchstep activity cannot be added for a
step status of work in process. Based on the step status and ASQC, all the input
data is validated.
Following is the definition of Insert Batchstep Activity:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_ignore_qty_below_
cap
IN
This is set to True to ignore if the process

quantity defined for the resource is less
than the minimum capacity of the
resource.
p_batchstep_no
IN
Step number.
p_batchstep_activity
IN
Row type for the batchstep activity.
p_batchstep_
resource_tab
IN
This table contains resources.
x_batchstep_
activity
OUT
This is the batchstep activity row type.

A resource can be added for an activity of a step. A resource can be added for a step
in pending, WIP, and completed step status only. If ASQC is on, then the resource
cannot be added in WIP status since the process quantity cannot be inserted. Based
on the step status and ASQC, all the input data is validated.
Following is the definition of Insert Batchstep Resource:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_batchstep_no
IN
Step number.
p_activity
IN
Activity name.
p_ignore_qty_below_
cap
IN
This is set to True to ignore if the

process quantity defined for the
resource is less than the minimum
capacity of the resource.
rec
IN
Row type parameter that identifies

the batchstep resource row
information.
x_batchstep_resource_
rec
OUT
Row type parameter that returns

information.
Parameter - p_batchstep_resource_rec (IN)

This is a row type parameter that identifies the batchstep resource row information.
The following table explains the required columns of the row:
Parameter
Description
batchstep_resource_id
For update and delete APIs, this field uniquely identifies a

resource. You can either provide this field or a combination of
plant_code and batch_no parameters to identify a resource. This
ID is generated for insert resource API.
batchstep_activity_id
This is used in insert API if the combination to identify an

activity is not provided through plant_code, batch_no, step_no,
and activity. This is not required for update API.
cost_analysis_code
Cost analysis code for resource.
Parameter
Description
cost_cmpntcls_id
Cost component class ID.
prim_rsrc_ind
Primary resource indicator.
scale_type
Scale type.
plan_rsrc_count
Plan resource count is used only for pending or work in process

batches.
actual_rsrc_count
Actual resource count is used only for work in process or

completed step.
resource_qty_uom
Resource quantity unit of measure.
capacity_uom
Minimum or maximum capacity unit of measure.
plan_rsrc_usage
Used only for pending or work in process step.
actual_rsrc_usage
Used only for work in process or completed step.
plan_rsrc_qty
actual_rsrc_qty
usage_uom
Unit of measure for resource usage fields.
plan_start_date
Required only for pending step.
actual_start_date
Required for work in process step.
plan_cmplt_date
Required for pending step.
actual_cmplt_date
Required for complete step.
Parameter - x_batchstep_resource_rec (OUT)

This is a row type parameter that returns the batchstep resource row information.
All fields in the row are appropriately populated in the API and returned to the
caller for plan and actual resource quantity. If ASQC is ON, then you cannot do an
update. The following table explains the required columns of the row:
Parameter
Description

Parameter
Description

cost_analysis_code
cost_cmpntcls_id
prim_rsrc_ind
scale_type
Scale type.
plan_rsrc_count

batches.
actual_rsrc_count

completed step.
resource_qty_uom
capacity_uom
plan_rsrc_usage
actual_rsrc_usage
plan_rsrc_qty
actual_rsrc_qty
usage_uom
plan_start_date
actual_start_date
plan_cmplt_date
actual_cmplt_date

An actual resource transaction can be posted for a particular resource of an activity
of a step. This can only be done for a step that is in a work in process or completed
state. The Insert Incremental Completed Transaction API passes in trans_date, start_
date, end_date, and resource usage along with the specification for the resource
where a transaction needs to be added. This API adds the transaction, in addition to
all previous resource transactions present for the resource. This API cannot be run
against a WIP step for a batch that has the Calculate Step Quantity indicator
checked.
Following is the definition of Insert Incremental Completed Transaction:
Parameter
Required
In/Out
Description
p_batchstep_rsrc_id
IN
To uniquely identify resource row for

the transactions to be posted.
p_plant_code
IN
Plant where the batch exists. If you do

not use p_batchstep_rsrc_id, then you
must use p_plant_code, p_batch_no, p_
batchstep_no, p_activity, and p_
resource.
p_batch_no
IN
Batch for the resource transactions to be

written.
p_batchstep_no
IN
Step number for the specific activity.
p_activity
IN
Activity for the specified resource.
p_resource
IN
Resource for the transactions to be

posted.
p_trans_date
IN
Date the transaction was posted on.
p_start_date
IN
Start date of actual transaction. Must be

within resource dates.
p_end_date
IN
End date of actual transaction. Must be

within resource dates and greater than
p_start_date.
p_usage
IN
Resource usage can be equal to end_

date. Start_date is converted in HRS.
p_reason_code
IN

transaction.
p_instance_id
IN
Parameter
Required
In/Out
Description
x_poc_trans_id
OUT

transactions.
p_instance_no
IN

Material lines in a batch can be set up for automatic allocation (ingredients) or
manual (all types) and these allocations can be edited. The status of the batch or
step, together with the release type of a line determines which quantities, planned
or actual, are updated when the allocations are changed.
The Insert Line Allocation API lets you create pending or complete allocations for a
given detail line in a given batch. The batch can be in a pending, WIP, or completed
state and the material detail line can have any release type.
Following is the definition of Insert Line Allocation:
Parameter
Required
In/Out
Description
p_tran_row
IN
The transaction row for creating the

allocation.
p_lot_no
IN
If the lot id is not passed, then the system

would use the p_lot_no to generate the
lot id.
p_sublot_no
IN
If the lot id is not passed, then the system

would use the p_lot_no, p_sublot_no to
generate the lot id.
p_create_lot
IN
If the lot has to be created on the fly. Only

valid for products, byproducts and
phantom ingredients. Default is FALSE
p_ignore_shortage
IN
If any shortages should be ignored. This

value will only be used if the GMI: Allow
negative inventory profile is set to 2.
Default value is FALSE.
p_scale_phantom
IN
If any changes to the material line

quantities should be backflushed to the
phantom batch. This parameter is only
valid for phantom ingredients. Default
value is FALSE.
x_material_detail
OUT
This is the updated material line row. The

possible updates could be the plan_qty,
wip_plan_qty and alloc_ind depending
on the batch status and the allocation
made.
x_tran_row
OUT
This is the updated transaction row.
Parameter
Required
In/Out
Description
x_def_tran_row
OUT
This is the default transaction row for the

material line, with the changes to the
quantities based on the new allocation.
Parameter - p_tran_row (IN)

This is a row type parameter that identifies the transaction row information. The
following table explains the required columns of the row:
Parameter
Description
batch_id
The unique identifier for the batch where the allocation is being
added.
material_detail_id
The unique identifier for the material line where the allocation
is being added.
lot_id
The lot where the allocation is being added. Required for lot
controlled items. If the Lot ID is not passed, then the API uses
the p_lot_no and p_sublot_no to derive the lot_id.
whse_code
The warehouse code where the allocation is being added.
location
The location in the warehouse where the allocation is being

added. Required if the item and warehouse are location
controlled.
alloc_qty
The quantity allocated in the material lines UOM. If the

allocated quantity is not passed in, then the API uses the trans_
qty to derive the alloc_qty. If the trans quantity is NULL, the
item is a dual UOM controlled 1 or 2 type of item, and the
trans_qty2 is passed in, then the API uses the trans_qty2 to
calculate the alloc_qty. Note the quantity passed in must be
positive.
trans_qty
The quantity allocated in the items primary UOM. This quantity

is ignored if the alloc_qty is passed in.
trans_qty2
The quantity allocated in the items secondary UOM. If it is not

passed in, then the alloc_qty is used to derive it for dual UOM 1
or 2 type of items.
completed_ind
Valid values are 0 - for creating pending allocation, 1 - for

creating completed allocation. This field is only used if the
material release type is manual or incremental.
Parameter
Description
trans_date
The transaction date for the allocation. If the trans_date is not

passed, then the system uses the default rules based on the
batch status or step status, line type, and release type to
determine the trans_date.
reason_code
The reason code associated with the allocation.
Parameter - x_material_detail (OUT)

This is a row type parameter that returns the updated material line information.
Parameter - x_tran_row (OUT)
This is a row type parameter that returns the updated transaction row information.
Parameter - x_def_tran_row (OUT)
This is a row type parameter that returns the default transaction row information
with any adjustments.

The Insert Material Detail Line API is used to insert ingredients, products, or
byproducts into a batch.
Following is the definition of Insert Material Detail Line:
Parameter
Required
In/Out
Description
p_material_detail
IN
The material detail row to insert the

material line.
p_batchstep_no
IN
The batch step that the material line is

associated to, if any. Default value is
NULL.
x_material_detail
OUT
Inserted material line.

This is a row type parameter that identifies the material detail. The following table
Parameter
Description
batch_id
Batch identifier foreign key to the GME_BATCH_HEADER

table.
line_no

planned order.
item_id
line_type
Valid values are -1 = Ingredient, 1 = Product; the product on

plan_qty
The quantity that this line was planned to produce or consume,

in the batch UOM (item_um column). This is only valid if the
batch is in pending status, otherwise the value must be NULL.
item_um
UOM in which planned and actual quantity is entered on the

batch.
actual_qty
Sum (trans_qty) of completed transactions for line in the batch

UOM. This is only valid for lab batches without inventory.
Parameter
Description
release_type
Release (Consumption for ingredients and yield for product)

type. Profile option determines the default value, the profile
defaults to Automatic. Valid values are 0 = Automatic release
(completion aka certification), 1 = Manual release (completion
aka certification), 2 = Incremental release, 3 = Automatic by
Step.
scrap_factor
Scrap factor decimal used to a trans_qty that allows for scrap.

This is only passed in for ingredient lines.
scale_type
Valid values are 0 = Fixed, 1 = Proportional, 2 = Scale by

increment.
phantom_type
Phantom indicator. Valid values are 0 = not a phantom, 1 =

automatic phantom replacement, 2 = manual phantom.
cost_alloc
For products, fraction of cost allocated to this product.
text_code
ID which joins any rows of text in the table to the text table for
this application.
rounding_direction
Determines whether to round up or round down to the nearest

SCALE_MULTIPLE. Valid values are 0 = UP, 1 = DOWN, 2 =
EITHER. Only meaningful when scale_type equals 2.
scale_rounding_variance Percentage plus or minus of the scaled quantity variance

allowed when scaling; default is zero. Only meaningful when
scale_type equals 2.
scale_multiple
The multiples of the batch uom (scale_uom) for scaling. Only

meaningful when scale_type equals 2.
contribute_yield_ind
Indicates if the ingredients contribute to yield. If the item is

defined as a packaging item, then the item cannot contribute to
yield. Therefore, the value is N, No. Valid values are Y = The
item contributes to yield, Default, N = No, the item does not
contributes to yield.
contribute_step_qty_ind
Indicates if the ingredients contribute to step quantity. If item is

the step quantity. Therefore, the value is N, No. Valid values are
Y= The item contributes to step quantity, Default value, N = No,
the item does not contributes to step quantity.
wip_plan_qty
This quantity is used in place of PLAN_QTY, if the batch status

is WIP or above. This is required if the batch is in WIP status.

This is a row type parameter that returns the material detail for the inserted line.
Insert Step
Insert Step
The Insert Step API inserts a new step into a batch. To insert a step, you must pass
in an operation.
Following is the definition of Insert Step:
Parameter
Required
In/Out
Description
p_batch_step
IN
x_batch_step
OUT

the data.
p_batch_header
IN
The batch header associated to the

batch step.

Parameter
Description
batch_id
Unique identifier for batches to FPO or batch.
batchstep_no
Batch step identifier. Batch routing step number, defaults from

fm_rout_dtl.
oprn_id
Foreign key to the operation GMD_OPERATIONS, defaults

from fm_rout_dtl. Stored for all batch steps. If a routing step is
added to batch not originally defined to the recipe, the oprn_id
is stored. Stored for steps not defined in routing.
plan_step_qty
If scaling and auto-calculate step quantity equals On and

formula is scalable, then first you scale materials, then
recalculate step quantity using step material association. If this
exists, then GMD_ calculation function is used. If step
dependencies exist, then consider what has flowed through
from previous step. If auto-calculate step quantity is Off, then
scale routing step quantities. Note that if the planned quantity
in batch is changed, then the plan_step_qty is recalculated.
actual_step_qty
The actual is not stored when the step is created. Either a Null
or zero is stored; will store the value stored today.
plan_start_date
Derived from GMD_OPERATIONS; stored here since the

operation uom can change after the routing is created and
associated with a recipe and batch.
Insert Step
Parameter
Description
actual_start_date
Updated at the time the step is released; defaults to system date

but can be overridden. This validates the actual_start_date is
batch start date; and after any step it is dependent on, provides
a warning.
due_date
Required step completion date and time.
plan_cmplt_date
Based on the step planned start date and plus the time required
for step to complete.
actual_cmplt_date
Updated at the time the system is completed. Defaults to system

date and time and can be overridden.
step_close_date
Updated at the time the step is closed; Defaults to system date

and time and can be overridden.
step_status
Valid values are 1 = Pending, 2 = WIP, 3 = Completed

(Certified), 4 = Closed, 5 = Cancelled.
steprelease_type
Defaults from routing. Valid values are 1 - Manual, 2 Automatic.
text_code
The ID that joins any rows of text in this table to the Text Table
for this application.

This is a row type parameter that returns the populated batch step for the inserted
step.

state. The Insert Timed Resource Transaction API passes in trans_date, start_date,
and end_date, along with the specification for the resource where a transaction
needs to be added. This API calculates the resource usage based on the difference of
p_end_date and p_start_date converted in the resource unit of measure.
Following is the definition of Insert Timed Resource Transaction:
Parameter
Required
In/Out
Description
p_batchstep_rsrc_id
IN

which transactions need to be posted.
p_plant_code
IN

resource.
p_batch_no
IN

written.
p_batchstep_no
IN
p_activity
IN
p_resource
IN

posted.
p_trans_date
IN
p_start_date
IN

p_end_date
IN

p_start_date.
p_reason_code
IN

transaction.
p_instance_id
IN
p_instance_no
IN
x_poc_trans_id
OUT

transactions.
Release Batch
Release Batch
The Release Batch API is a business object that converts pending batches to work in
process (WIP) batches in OPM.
Batch release is affected by calling the API with a set of parameters that indicate
which batch to release and also an indication of whether the release can proceed in
the presence of inventory shortages.
The API applies equally to batches and lab batches, but any attempt to release a
firm planned order is rejected, as are attempts to release batches or lab batches that
have a status other than pending.
If the batch or lab batch is released successfully, then the API returns with a status
of S. If errors occur, then the return status is E for errors that are normal but prevent
the batch from being released, and U for errors that are unexpected and also prevent
the batch from being released, such as database errors.
On successful release, an updated batch header is returned to the caller with various
values updated (batch_status, actual_start_date) so there is immediate knowledge
of the new data.
Following is the definition of Release Batch:
Parameter
Required
In/Out
Description
p_ignore_shortages
IN

Warning.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
OUT

p_ignore_unalloc
IN
Proceed with the release even if there

are unallocated ingredients with a
consumption type of automatic.
Unallocated quantities will not be
consumed.
Release Batch

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.
actual_start_date
Actual start date and time for batch. If no date is passed in, it
defaults to the current system date and time.

released batch.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type
Valid values are -1 = Ingredient, 1 = Product, 2 = Byproduct
line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
Release Batch
Parameter
Description
unalloc_qty
alloc_uom

Release Steps
Release Steps
The Release Step API is a business object that can release a single batch step or
multiple batch steps based on certain criteria. Releasing a step is how input
quantities are specified, or defaulted, for items used in the step. The API operates
on steps that have a status of pending and if prior steps are release type of
automatic, then these steps in the dependency chain are released before the selected
step is released. If the batch is pending and the GME:Step Controls Batch Status
profile option is set to Yes, then the batch is released prior to releasing the step.
If an ingredient is associated to the step and has a consumption type of Automatic
by Step, then that ingredient line is released. If that ingredient is not allocated, then
there is an attempt to allocate. Unallocated items and inventory shortages are
reported at this time.
Only batch steps in pending can be released. The batch step that is passed in must
contain sufficient information to identify the batch step (either batch_id and
batchstep_no or batchstep_id).
Following is the definition of Release Step:
Parameter
Required
In/Out
Description
p_ignore_shortages
IN

Warning.
p_batch_step
IN
The batch step row to identify the batch.
x_batch_step
OUT

the data.
OUT

p_ignore_unalloc
IN
Do not check for the item requiring

allocations.

Release Steps
Parameter
Description
batchstep_id
batch_id

batchstep_no

actual_start_date
Actual start date and time for batch step. If no date is passed in,
it defaults to the current system date and time.

completed step.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
Quantity to be allocated.
alloc_uom

Reopen Batch
Reopen Batch
Reopening a batch changes the status of the batch from closed to complete.
Only batches in a closed state can be reopened. The batch header that is passed in
must contain sufficient information to identify the batch (firm planned orders are
not eligible for reopening). You cannot reopen a batch where the transactions have
been purged, the batch has been migrated, the actual cost has been run and frozen,
or the GL posting is complete.
Following is the definition of Reopen Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_reopen_steps
IN
Reopen all the steps. Default value is

False.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

reopened batch.
Reopen Steps
Reopen Steps
Reopening a batch step changes the status of the step from close to completed and
updates the step_close_date to Null.
This API only reopens the specified batch step (passed parameter).
Reopening a batch step can be done only on a batch that is not closed. The batch
step that is passed in must contain sufficient information to identify at least batch_
step_id.
Following is the definition of Reopen Step:
Parameter
Required
In/Out
Description
p_batch_step
IN

step.
x_batch_step
OUT

the data.

Parameter
Description
batchstep_id
batch_id

batchstep_no


This is a row type parameter that returns the populated batch step for the reopened
step.
Reroute Batch
Reroute Batch
The Reroute Batch API is a business object that can reroute a batch or firm planned
order to a different recipe with the same formula. Batches can only be rerouted in
pending status.
Following is the definition of Reroute Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_validity_rule_id
IN
Recipe validity rule ID for the new

recipe.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

rerouted batch.
Reschedule Batch
Reschedule Batch
The Reschedule Batch API is a business object that can reschedule a batch or firm
planned order to different date. A batch can only be rescheduled while in pending
or WIP state. A firm planned order can only be rescheduled when in a pending
state.
Following is the definition of Reschedule Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.
plan_start_date
New planned start date and time for batch. This is passed in by
you, and can only be specified if the batch is pending.
plan_cmplt_date
New planned completion date and time for batch. This is passed
in by you.

rescheduled batch.
Reschedule Step
Reschedule Step
The Reschedule Step API reschedules the step and all subsequent steps, if
requested.
Following is the definition of Reschedule Step:
Parameter
Required
In/Out
Description
p_batch_step
IN
x_batch_step
OUT

the data.
p_reschedule_other
IN
Determines whether to reschedule other

steps in a step dependency chain.

Parameter
Description
batch_id

batchstep_no

batchstep_id
plan_start_date
New planned start date and time for step. This is passed in by
you, and can only be specified if the step is pending.
plan_cmplt_date
New planned completion date and time for step. This is passed
in by you.

rescheduled step.
Revert to WIP Batch
Revert to WIP Batch

The Revert to WIP Batch, or uncertify batch, API is a business object that can
uncomplete the batch. Reverting a batch to WIP changes transactions from
completed back to pending for products and byproducts with a yield type of
Automatic, and changes the batch status back to WIP.
Only batches in completed state can be reverted to QIP. The batch header that is
passed in must contain sufficient information to identify the batch. Firm planned
orders are not eligible for completing or reverting to WIP.
Following is the definition of Uncertify Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

batch.
Revert to WIP Steps
Revert to WIP Steps

The Revert to WIP Steps, or uncertify batch steps, API is a business object that can
uncomplete a batch step based on certain criteria. Reverting a step to WIP puts the
step back to WIP status and posts pending transactions after posting reversing
completed transactions for the product lines associated with the step and with a
consumption type of Automatic by Step.
To revert a step to WIP, any steps that are dependent on this step and have a step
release type of Automatic are pending or WIP.
Only batch steps in the status of complete can be reverted to WIP. Also, the batch
can be in pending or WIP status.
Following is the definition of Uncertify Step:
Parameter
Required
In/Out
Description
p_batch_step
IN

step.
x_batch_step
OUT

the data.

Parameter
Description
batch_id

batchstep_no

batchstep_id

completed step.
Scale Batch
Scale Batch
The Scale Batch API scales batches up or down, including phantom batches.
Following is the definition of Scale Batch:
Parameter
Required
In/Out
Description
p_scale_factor
IN
How much to scale. Scale multiplier to

make twice as much quantity, scale
factor = 2, to reduce quantity to half
scale factor = -0.5.
p_primaries
IN
Scaling based on products or

ingredients. Valid values are INPUT =
ingredients, OUTPUT = products.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
x_over_allocations
OUT
Tables of material lines, trying to scale

down the batch, and the quantities are
going below allocations.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.
Scale Batch

This is a row type parameter that returns the populated batch header for the scaled
batch.
Parameter
Description
batch_id
batch_no
material_detail_id
line_type

line_no

planned order.
item_id
item_no
Item Number.
alloc_qty
unalloc_qty
alloc_uom


The Start Completed Resource Transaction API is used in conjunction with the End
Completed Resource Transaction API. An actual resource transaction can be posted
for a particular resource of an activity of a step with the start date of the transaction.
This can only be done for a step that is in a work in process or completed state. The
Start Completed Resource Transaction API passes in trans_date, and start_date,
along with the specification for the resource where the transaction needs to be
added. This API puts the start_date value as the end_date. Therefore, usage for the
resource transaction is 0. When the End Completed Resource Transaction API is
run, the usage is calculated based on the difference between the start date and the
end date. This API cannot be run against a WIP step for a batch that has the
Calculate Step Quantity indicator checked. It also passes the poc_trans_id that gets
generated. This ID can be for the End Completed Resource Transaction API for
ending the same transaction.
Following is the definition of Start Completed Resource Transaction:
Parameter
Required
In/Out
Description
p_batchstep_rsrc_id
IN
To uniquely identify resource row for the

transaction to be posted.
p_plant_code
IN
Plant in which the batch exists. If you do

batchstep_no, p_activity, and p_resource.
p_batch_no
IN
Batch for the resource transaction to be

written.
p_batchstep_no
IN
Step number for the activity to be

specified.
p_activity
IN
Activity for the resource to be specified.
P_trans_date
IN
P_start_date
IN

within resource dates. Same date is put in
end_date.
P_reason_code
IN

transaction.
P_instance_id
IN
Instance ID for the transaction.
P_instance_no
IN
Instance number for the transaction.
Parameter
Required
In/Out
Description
x_rsrc_txn_id
OUT
To uniquely identify resource transaction

to be posted with an end date.
x_poc_trans_id
OUT

transactions.

The Theoretical Yield Batch API calculates theoretical yield for the batch, and
updates the quantities for the product lines.
Following is the definition of Theoretical Yield Batch:
Parameter
Required
In/Out
Description
p_scale_factor
IN
Theoretical yield in fractions. For

example, to set a 90% yield, set the scale
factor to.9.
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

theoretical yield batch.
Unrelease Batch
Unrelease Batch
The Unrelease Batch API reverses the completed transactions for the ingredient
lines. Unreleasing a batch sets the batch status to pending.
Only batches in WIP state can be unreleased. The batch header that is passed in
must contain sufficient information to identify the batch. Firm planned orders are
not eligible for unreleasing.
Following is the definition of Unrelease Batch:
Parameter
Required
In/Out
Description
p_batch_header
IN

batch.
x_batch_header
OUT

all the data.
p_preserve_allocations
IN
Preserve lot allocations.

Parameter
Description
batch_id
batch_no

plant_code

batch_type

not set.

released batch.
Unrelease Steps
Unrelease Steps
The Unrelease Steps API is a business object that can unrelease a batch step based
on certain criteria. Unreleasing a step sets the step back to pending status, and
reverses completed transactions for any ingredients consumed in the step that have
a consumption type of Automatic by Step.
Following is the definition of Unrelease Step:
Parameter
Required
In/Out
Description
p_batch_step
IN
x_batch_step
OUT

the data.
p_preserve_allocations
IN
Preserve lot allocations.

Parameter
Description
batch_id

batchstep_no

batchstep_id

This is a row type parameter that returns the populated batch step for the released
step.

state. The Update Actual Resource Usage API passes in trans_date, start_date, end_
date, and resource usage, along with the specification for the resource where a
transaction needs to be added. This API removes all other resource transactions
present for the resource.
Following is the definition of Update Actual Resource Usage:
Parameter
Required
In/Out
Description
p_batchstep_rsrc_id
IN

the transactions to be posted.
p_plant_code
IN

resource.
p_batch_no
IN

written.
p_batchstep_no
IN
p_activity
IN
p_resource
IN

posted.
p_trans_date
IN
p_start_date
IN

p_end_date
IN

p_start_date.
p_usage
IN
Resource usage can be equal to end_

date. Start_date is converted in HRS.
p_reason_code
IN

transaction.
p_instance_id
IN
p_instance_no
IN
Parameter
Required
In/Out
Description
x_poc_trans_id
OUT

transactions.

The Update Batchstep Activity API updates the batchstep activity of a step. A
batchstep activity can be updated for a step in the status pending, work in process,
and completed. Based on the step status and ASQC, all the input data is validated
before the batchstep activity gets updated. Depending on the step status, different
fields of the batchstep activity can be updated.
Following is the definition of Update Batchstep Activity:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_batchstep_no
IN
Step number.
p_batchstep_activity
IN
Row type for the batchstep activity.
x_batchstep_
activity
OUT
This is the batchstep activity row type.
Update Batchstep Resource

An existing resource can be updated for an activity of a step. A resource can be
updated for a step in pending, WIP, and completed step status only. Based on the
step status and ASQC, all the input data is validated before the resource in updated.
Based on the step status, different fields of the resource can be updated.
If any column must be updated to NULL, then you must pass in FND_API.G_
MISS_CHAR, FND_API.G_MISS_NUM, or FND_API.G_MISS_DATE variables to
the API column values to update the column to NULL in the database.
Following is the definition of Update Batchstep Resource:
Parameter
Required
In/Out
Description
p_batch_no
IN
Batch number.
p_plant_code
IN
Organization code.
p_batchstep_no
IN
Step number.
p_activity
IN
Activity name.
p_resource
IN
Resource name.
p_ignore_qty_below_
cap
IN
This is set to True to ignore if the

process quantity defined for the
resource is less than the minimum
capacity of the resource.
rec
IN
Row type parameter that identifies

information.
x_batchstep_resource_
rec
OUT
Row type parameter that returns

information.
Parameter - p_batchstep_resource_rec (IN)

This is a row type parameter that identifies the batchstep resource row information.
The following table explains the required columns of the row:
Parameter
Description


cost_analysis_code
cost_cmpntcls_id
prim_rsrc_ind
scale_type
Scale type.
plan_rsrc_count

batches.
actual_rsrc_count

completed step.
resource_qty_uom
capacity_uom
plan_rsrc_usage
actual_rsrc_usage
plan_rsrc_qty
actual_rsrc_qty
usage_uom
plan_start_date
actual_start_date
plan_cmplt_date
actual_cmplt_date
Parameter - x_batchstep_resource_rec (OUT)

This is a row type parameter that returns the batchstep resource row information.
All fields in the row are appropriately populated in the API and returned to the
caller for plan and actual resource quantity. If ASQC is ON, then you cannot do an
update. The following table explains the required columns of the row:
Parameter
Description


cost_analysis_code
cost_cmpntcls_id
prim_rsrc_ind
scale_type
Scale type.
plan_rsrc_count

batches.
actual_rsrc_count

completed step.
resource_qty_uom
capacity_uom
plan_rsrc_usage
actual_rsrc_usage
plan_rsrc_qty
actual_rsrc_qty
usage_uom
plan_start_date
actual_start_date
plan_cmplt_date
actual_cmplt_date

The Update Allocation API lets you update pending or complete allocations for a
given detail line in a given batch. The batch can be in a pending, work in process, or
completed state and the material detail line can have any release type. In some
cases, it disregards some values being passed in.
Following is the definition of Update Line Allocation:
Parameter
Required
In/Out
Description
p_tran_row
IN
The transaction row requested for

update.
p_lot_no
IN
If the lot id is not passed, then the

system uses p_lot_no to generate the lot
id.
p_sublot_no
IN
If the lot id is not passed, then the

system uses p_lot_no, p_sublot_no to
generate the lot id.
p_create_lot
IN
If the lot has to be created dynamically.

Only valid for products, byproducts,
and phantom ingredients. Default is
FALSE
p_ignore_shortage
IN
This is used if any shortages must be

ignored. This value is used if the GMI:
Allow Negative Inventory profile
option is set to 2. Default value is
FALSE. If a shortage is found, and
profile value is set to ignore it, then a
warning message is put on the message
stack.
p_scale_phantom
IN
If there are any changes to the material

line quantities, then they must be
backflushed to the phantom batch. This
parameter is only valid for phantom
ingredients. Default value is FALSE.
x_material_detail
OUT
This is the updated material line row.

The possible updates are the plan_qty,
wip_plan_qty, actual_qty, and alloc_ind
depending on the batch status and the
allocation change.
Parameter
Required
In/Out
Description
x_tran_row
OUT
This is the updated transaction row.

Trans_id is necessary from here when
there are changes to a completed batch
which creates a reversal and a new
completed transaction.
x_def_tran_row
OUT
This is the default transaction row for

the material line, with the changes to
the quantities based on the updated
allocation.
Parameter - p_tran_row (IN)

This is a row type parameter that identifies the line allocation. The following table
Field
Description
trans_id
The unique identifier for the allocation line that is being

changed.
lot_id
The lot_id of the lot/sublot that you want to change to.
whse_code
The warehouse code that you want to change to. If the whse_
code is changed, then the location must be revalidated.
location
The location in the warehouse to which the allocation is being

changed.
alloc_qty
The quantity to be allocated in the material lines unit of

measure. The quantity passed in must be positive.
trans_qty
The quantity to be allocated in the items primary unit of

measure. If specified, then this quantity is ignored if the alloc_
qty is passed in. The quantity passed in must be positive.
trans_qty2
The quantity to be allocated in the items secondary unit of

measure. The quantity passed in must be positive.
completed_ind
Valid values are 0 - for creating pending allocation, 1 - for

creating completed allocation.
Trans_Date
The transaction date for the allocation. This must be in a valid

and open inventory calendar period. Completed transactions
cannot accept trans_date in the future.
Reason_Code
The reason code to be associated with the allocation.
Parameter - x_tran_row (OUT)

This is a row type parameter that returns updated transaction for the allocated line.
Parameter - x_def_tran_row (OUT)
This is a row type parameter that returns updated default transaction for the
allocated line.
This is a row type parameter that returns the updated material detail line.

The Update Material Detail Line API updates the material line in the batch.
Following is the definition of Update Material Detail Line:
Parameter
Required
In/Out
Description
p_material_detail
IN
The material detail row to insert the

material line.
x_material_detail
OUT
The updated material detail row.
p_values_tab
IN
The columns in the material line which

can be updated.
p_scale_phantom
IN
Indicates if the quantity must be

backflushed to the phantom batch.

Parameter
Description
material_detail_id
batch_id
Batch identifier foreign key to the GME_BATCH_HEADER

table.
plan_qty
The quantity that this line was planned to produce or consume,

in the batch UOM (item_um column). This is used only if the
batch is pending.
actual_qty
Sum (trans_qty) of completed transactions for line in the batch

UOM. This is used only for lab batches without inventory.
release_type
Release (Consumption for ingredients and yield for product)

type. Profile option determines the default value, the profile
defaults to Automatic. Valid values are 0 = Automatic release
(completion aka certification), 1 = Manual release (completion
aka certification), 2 = Incremental release, 3 = Automatic by
Step. This is valid only if the batch is pending.
scrap_factor
Scrap factor decimal used to a trans_qty that allows for scrap.

Updated only if the batch is pending, and valid only for
ingredients.
Parameter
Description
scale_type
Valid values are 0 = Fixed, 1 = Proportional, 2 = Scale by

increment.
phantom_type
Phantom indicator. Valid values are 0 = not a phantom, 1 =

automatic phantom replacement, 2 = manual phantom. This is
valid only if the batch is pending and the phantom is not
exploded.
cost_alloc
For products, fraction of cost allocated to this product.
text_code
ID which joins any rows of text in the table to the text table for
this application.
rounding_direction
Determines whether to round up or round down to the nearest

SCALE_MULTIPLE. Valid values are 0 = UP, 1 = DOWN, 2 =
EITHER. This is meaningful only if scale_type equals 2.
scale_rounding_variance Percentage plus or minus of the scaled quantity variance

allowed when scaling; default is zero. This is meaningful only if
scale_type equals 2.
scale_multiple
The multiples of the batch uom (scale_uom) for scaling. This is

meaningful only if scale_type equals 2.
contribute_yield_ind
Indicates if the item (product or ingredient) contributes to yield.

If the item is defined as a packaging item, then the item cannot
contribute to yield. Therefore, the value is N, No. Valid values
are Y = The item contributes to yield, Default, N = No, the item
does not contributes to yield.
contribute_step_qty_ind
Indicates if the item contributes to step quantity. If item is

the step quantity. Therefore, the value is N, No. Valid values are
Y= The item contributes to step quantity, Default value, N = No,
the item does not contributes to step quantity.
wip_plan_qty
This quantity is used in place of PLAN_QTY, if the batch status

is WIP or above.

This is a row type parameter that returns the populated batch step for the updated
line.
A
Messages and Errors
Handling Messages
APIs put result messages into a message list. Programs calling APIs can then get the
messages from the list and process them by either issuing them, loading them in a
database table, or writing them to a log file. Messages are stored in an encoded
format to enable API callers to find out message names by using the standard
functions provided by the message dictionary. It also stores these messages in
database tables and reports off these tables in different languages. The structure of
the message list is not public. Neither API developers nor API callers can access this
list except through calling the API message utility routines mentioned below.
The following utility functions are defined in the FND_MSG_PUB package, in the
file AFASMSGS.pls:
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.
Messages and Errors A-1
Handling Messages
To add a message to the API message list, developers can 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. They
can 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 can use the procedure FND_
MSG_PUB.Get. This procedure operates in five 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
Specific Gets a specific message from the API message list
For overall better performance and reduction in the number of calls a program
needs to make in order to execute an API, it is recommended that APIs provide
their callers with the following information:
n
message count
message data
The message count holds the number of messages in the API message list. If this
number is one, then the message data holds the message in an encoded format.
x_msg_count
x_msg_data
OUT
OUT
NUMBER
VARCHAR2
Example:
PROCEDURE allocate_line (
p_material_details
IN
,p_alloc_type
IN
,p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_del_exist_alloc
IN
NUMBER DEFAULT 9
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := FALSE) IS
A-2 Oracle Process Manufacturing Process Execution API Users Guide
Handling Messages
l_api_name
CONSTANT VARCHAR2 (30)
l_material_details
gme_material_details%ROWTYPE;
l_batch_hdr
GME_BATCH_HEADER%ROWTYPE;
BEGIN
gme_debug.log_initialize('AllocateLine');
-- Initialize message list and count if needed
IF p_init_msg_list THEN
fnd_msg_pub.initialize;
gme_api_pub.error_count := 0;
END IF;
:= 'ALLOCATE_LINE';
IF NOT gme_api_pub.setup_done THEN

gme_api_pub.setup_done := gme_api_pub.setup;
IF NOT gme_api_pub.setup_done THEN
RAISE FND_API.g_exc_error;
END IF;
END IF;
-- Make sure we are call compatible
IF NOT FND_API.compatible_api_call (
gme_api_pub.api_version
,p_api_version
,l_api_name
,'gme_api_allocate_line') THEN
gme_api_pub.log_message (l_package_name||'.'||l_api_
name||':'||'INVALID_VERSION');
END IF;
gme_api_grp.set_timestamp;
l_material_details := p_material_details;
gme_api_allocate_line_pvt.allocate_line (
p_gme_material_details => p_material_details
,p_alloc_type
=> p_alloc_type
,x_gme_material_details => l_material_details
,x_return_status => x_return_status
,p_del_exist_alloc => p_del_exist_alloc);
gme_debug.put_line(l_package_name||'.'||l_api_name||':'||'Return status
from private allocate_line is '||x_return_status);
IF x_return_status = FND_API.G_RET_STS_SUCCESS THEN
IF p_commit = TRUE THEN
gme_debug.put_line (l_package_name||'.'||l_api_name||':'||'Calling
Handling Messages
Save_batch');
l_batch_hdr.batch_id := p_material_details.batch_id;
save_batch(l_batch_hdr, x_return_status);
IF x_return_status = FND_API.G_RET_STS_SUCCESS THEN
COMMIT;
ELSE
gme_api_pub.log_message ('BATCH_SAVE_FAILED');
END IF;
END IF;
IF error_count = 0 THEN
log_message ('GME_API_LINE_ALLOCATED');
END IF;
END IF;
gme_debug.put_line('Completed '||l_api_name ||' at '||to_
char(sysdate,'MM/DD/YYYY HH24:MI:SS'));
fnd_msg_pub.count_and_get (
p_count => x_message_count
,p_data => x_message_list);
EXCEPTION
WHEN FND_API.g_exc_error THEN
x_return_status := FND_API.G_RET_STS_ERROR;
p_encoded => FND_API.g_false
,p_count => x_message_count
WHEN FND_API.g_exc_unexpected_error THEN
WHEN OTHERS THEN
fnd_msg_pub.add_exc_msg (l_package_name, l_api_name);
END allocate_line;
Understanding Error Messages
Interpreting Error Conditions

The parameter x_return_status indicates whether the API was successful or failed.
The values are:
n
S for success
E for error

These error messages are output to the stored procedure message file, and can be
monitored through the return x_msg_count. In conjunction 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 Process Execution API Error Messages. Note that
a message that is preceded with Warning is not an API error, just a warning, and a
message preceded with Error is an API error.
Any uppercase word preceded by an apersand (&) is a token, or placeholder, for an
actual value that is populated at runtime.
Message Text
Message Name
Batch is already saved.
BATCH_ALREADY_SAVED
Batch status is not updated.
BATCH_STATUS_NOT_UPDATED
Activity &activity was not found for

step &STEP.
GME_ACTIVITY_NOT_FOUND
Actual dates for the BATCHSTEP

ACTIVITY do not fall in the range of
batch step actual dates.
GME_ACTV_DATES_NOT_ALLOWED
Planned dates for the BATCHSTEP

ACTIVITY are not in the range of the
parent planned dates.
GME_ACTV_PLAN_DATE
Message Text
Message Name
All material lines that contribute to step

quantity can be associated with a step
when automatically.
GME_ALL_MATL_STEP_NOT_ASSOC
Quantity entered creates a negative actual

quantity.
GME_API_ACTUAL_CANT_GO_NEG
Actual costing has been run for this batch.
GME_API_ACTUAL_COST_DONE_ERROR
Autoallocation was successful.
GME_API_BATCH_ALLOCATED
Batch has been cancelled.
GME_API_BATCH_CANCELLED
Batch has been completed.
GME_API_BATCH_CERTIFIED
Batch has been closed.
GME_API_BATCH_CLOSED
Batch has been created.
GME_API_BATCH_CREATED
Batch cannot be found with information

supplied.
GME_API_BATCH_FETCH_ERROR
Batch Header Update Error.
GME_API_BATCH_HEADER_UPD_ERROR
Batch material lines cannot be locked.
GME_API_BATCH_LINES_LOCKED
Batch has been released.
GME_API_BATCH_RELEASED
Batch has been reopened.
GME_API_BATCH_REOPENED
Batch has been rerouted.
GME_API_BATCH_REROUTED
Cannot load the batch step with step

details supplied.
GME_API_BATCH_STEP_FETCH_ERR
Cannot lock the batch step.
GME_API_BATCH_STEP_LINE_LCK
Error Reopening Batch Steps.
GME_API_BATCH_STEP_REOPEN_ERR
Cannot update the batch step.
GME_API_BATCH_STEP_UPD_ERR
Batch has been reverted to WIP status.
GME_API_BATCH_UNCERTIFIED
Batch has been unreleased.
GME_API_BATCH_UNRELEASED
Batch step is already closed.
GME_API_CLOSE_STEP_STATUS
Completion date is outside the valid range. GME_API_CMPLT_OUT_VALIDITY

Cannot reopen the batch. The costing
period for the calendar is closed.
GME_API_COST_PERIOD_CLOSED
Batch has been costed and period is open.

Please run the actual cost process again.
GME_API_COST_PERIOD_OPEN
Message Text
Message Name
Unable to create the batch for the

requested product quantity.
GME_API_CREATE_BY_PROD_FAIL
Cannot close batch step. Previous steps are

not closed.
GME_API_DEP_STEP_N_CLS
Cannot reopen the batch step. One or more

dependent steps are closed. You must
reopen these steps before you can open
this batch step.
GME_API_DEP_STEP_REOPEN
Cannot revert batch step to WIP.

Succeeding step must have a status of
pending or WIP.
GME_API_DEP_STEP_WIP
Cannot reopen the batch. It has been

posted to subledger.
GME_API_GL_POSTED
Pending allocations exist for manual

release items.
GME_API_INCOMP_MANUAL_TRANS
Batch step cannot be completed. Batch

must have a status of WIP to complete the
batch step.
GME_API_INV_BATCH_CERT_STEP
Cannot close batch step. Batch must have a

status of WIP or completed.
GME_API_INV_BATCH_CLOSE_STEP
Batch details cannot be edited. Current

step status is invalid.
GME_API_INV_BATCH_EDIT_STEP
Batch step cannot be released. Batch must

have a status of WIP to release the batch
step.
GME_API_INV_BATCH_REL_STEP
Batch cannot be rescheduled. Batch must

have a status of pending or WIP to be
rescheduled.
GME_API_INV_BATCH_RESCHED
Cannot perform incremental backflushing.

Batch must have WIP or completed status.
GME_API_INV_BATCH_STATUS_PC
Cannot reopened batch step. Batch must

have a status of WIP or Completed.
GME_API_INV_BATCH_STATUS_REOP
You cannot reopen firm planned order.
GME_API_INV_BATCH_TYPE
Batch step cannot be reverted to WIP.

Batch must have a status of WIP.
GME_API_INV_BATCH_UNCERT_STEP
Message Text
Message Name
Cannot unrelease batch step. Batch step

must have a status of WIP to be
unreleased.
GME_API_INV_BATCH_UNRELE_STEP
Current step cannot be unreleased. The

steps that follow this step must have a
status of pending.
GME_API_INV_DEP_STEP_UNRELE
Planned quantity must be greater than

zero to perform incremental backflushing.
GME_API_INV_PLAN_QTY_PC
Cannot drive incremental backflushing

from an automatic release item, or from an
automatic by step.
GME_API_INV_RELEASE_TYPE
Batch step cannot be completed. Batch step

must have a status of pending or WIP to be
completed.
GME_API_INV_STAT_STEP_CERT
Batch step cannot be closed. Batch step

must have a status of completed to be
closed.
GME_API_INV_STAT_STEP_CLS
Batch step cannot be cancelled. Batch step

must have a status of pending to be
cancelled.
GME_API_INV_STAT_STEP_CNCL
Step details cannot be updated. Current

step status is invalid.
GME_API_INV_STAT_STEP_EDIT
Batch step cannot be released. Batch step

must have a status of pending to be
released.
GME_API_INV_STAT_STEP_REL
Batch step cannot be rescheduled. Batch

step must have a status of pending.
GME_API_INV_STEP_STAT_RESCH
Batch step cannot be reverted to WIP. Step

must have a status of completed.
GME_API_INV_STEP_STAT_UNCERT
Cannot unrelease batch step. Batch step

must have a status of WIP to be
unreleased.
GME_API_INV_STEP_STAT_UNRELE
Cannot reopen batch step. Batch step must

have a status of closed to be reopened.
GME_API_INV_STEP_STATUS_REOP
Batch cannot be cancelled. Batch must

have a status of pending to be cancelled.
GME_API_INVALID_BATCH_CANCEL
Message Text
Message Name
Batch cannot be completed. Batch must

have a status of WIP to be completed.
GME_API_INVALID_BATCH_CERTIFY
Batch cannot be released. Batch must have

a status of pending to be released.
GME_API_INVALID_BATCH_REL
Batch cannot be rerouted. Batch must have

a status of pending.
GME_API_INVALID_BATCH_REROUTE
Batch cannot be reverted to WIP. Batch

must have a status of completed.
GME_API_INVALID_BATCH_UNCERT
Batch cannot be unreleased. Batch must

have a status of WIP to be unreleased.
GME_API_INVALID_BATCH_UNREL
Cannot create the batch. Formula supplied

is not valid.
GME_API_INVALID_FORMULA
QTY_TYPE parameter must be 0 for

incremental, 1 for percentage, or 2 for
actual.
GME_API_INVALID_INCR_TYPE
Validity rule is not valid.
GME_API_INVALID_RULE
Cannot unrelease batch. All the steps must

have a status of WIP or pending.
GME_API_INVALID_STEP_UNREL
Validity rule was not found.
GME_API_INVALID_VALIDITY
Autoallocation was successful.
GME_API_LINE_ALLOCATED
Cannot lock inventory.
GME_API_LOCKING_FAILURE
This batch is marked for deletion.
GME_API_MARKED_FOR_DELETION
Batch material line cannot be found with

information supplied.
GME_API_MATL_DTL_FETCH_ERROR
Material detail line cannot be created.
GME_API_MATL_DTL_SETUP_FAILURE
Batch material detail line cannot be

updated.
GME_API_MATL_DTL_UPD_ERROR
Incremental backflush was successful.
GME_API_PARTIAL_CERTIFIED
Quantity entered must be greater than

zero.
GME_API_QTY_CANT_BE_ZERO
Actual start date of the step cannot be in

the future.
GME_API_REL_STEP_FUTURE_DATE
Message Text
Message Name
You must enter a date to reschedule a

batch.
GME_API_RESCH_NO_DATES_PASSED
Dates entered for rescheduling the batch

step are the same as those currently
entered for the step.
GME_API_RESCH_STEP_NO_DATE_CHG
Dates entered in for rescheduling the batch

step cannot be NULL.
GME_API_RESCH_STEP_NO_DATES
Process quantities of &RESOURCES fall

below the minimum capacity.
GME_API_RSRC_QTY_BELOW_CAP
The validity rule selected is the same as the

current validity rule.
GME_API_SAME_VALIDITY_RULE
Setup failed.
GME_API_SETUP_FAILURE
Start date is outside valid range.
GME_API_START_OUT_VALIDITY
Cannot load Batchstep activity details

for the step.
GME_API_STEP_ACTV_FTCH_ERR
Cannot update activities for the

current step.
GME_API_STEP_ACTV_UPD_ERR
Step is deleted.
GME_API_STEP_DELETE
Batch step has been reopened.
GME_API_STEP_REOPENED
Batch steps cannot be updated.
GME_API_STEP_UPD_ERROR
Cannot reopen the batch. Batch

transactions have been purged.
GME_API_TRANSACTIONS_PURGED
Unable to retrieve the constant

&CONSTANT_NAME.
GME_API_UNABLE_TO_GET_CONSTANT
All material lines are not allocated.
GME_API_UNALLOC_MATERIALS
The validity rule selected has a different

formula. To reroute batch, you must select
a validity rule that has the same formula.
GME_API_VALIDITY_DIFF_FORM
The warehouse &WHSE_CODE is closed

for the date &TRANS_DATE. Please
reenter the date to proceed.
GME_API_WHSE_CLOSED
Plant Warehouse relationship is not

defined for all items in the batch.
GME_API_WSHE_LOOKUP_FAILURE
Error retrieving the recipe data.
GME_BAD_RECIPE_RETRIEVAL
Message Text
Message Name
Batch is locked by another user.
GME_BATCH_IN_USE
The batch &BATCH_NO does not have

any inventory transactions.
GME_BATCH_NON_INVENTORY
Batch step completed successfully.
GME_BATCH_STEP_CERTIFIED
Batch step has been closed.
GME_BATCH_STEP_CLOSED
Batch step not found for step id &STEP_

ID.
GME_BATCH_STEP_NOT_FOUND
Batch step has been released.
GME_BATCH_STEP_RELEASED
Batch step has been successfully reverted

to WIP.
GME_BATCH_STEP_UNCERTIFIED
Batch step has been unreleased.
GME_BATCH_STEP_UNRELEASED
Charges cannot be calculated for step

&STEP_NO.
GME_CALC_CHARGE_CONV_ERROR
Transaction date &TRANS_DATE falls

in closed period for Work In Progress
Warehouse.
GME_DATE_IN_CLSD_PRD
The planned start and planned completion

dates are not within the validity rule dates.
GME_DATES_EXCEED_VALDTY_RULE
Manual document ordering is set for this

plant. Please supply document number.
GME_DOC_NUM_NOT_PASSED
This batch already exists. Please enter

another batch number.
GME_DUP_BATCH
Cannot insert Activity for Firm

Planned Order Step.
GME_FIRM_PLAN_STEP_ACT
Cannot change the formula ID for the

current batch.
GME_FORMID_CHG_NOT_ALLOWED
Cannot create firm planned order for Lab

Organization.
GME_FPO_NO_CREATE
Insufficient validity rules data supplied.
GME_INSUF_VAL_RULE
The cost allocation must be zero for

inserting the material line.
GME_INV_COST_ALLOC_INS
Invalid option for updating the cost

allocation.
GME_INV_COST_UPD_OPT
Messages and Errors
A-11
Message Text
Message Name
Cannot insert the material line. The

formula line ID must be NULL to insert a
material line.
GME_INV_FORMULALINE
You cannot drive Inventory quantity

negative.
GME_INV_NEG_NOT_ALLOW
The yield type of the phantom product

cannot be changed.
GME_INV_PHANT_UPD_REL
Invalid value for phantom type.
GME_INV_PHANTOM_TYPE
Inventory shortages found for the batch.
GME_INV_SHORT_EXISTS
Invalid batch status for updating the

phantom type.
GME_INV_STAT_UPD_PHANTOM_TYPE
Invalid batch status for updating planned

quantity.
GME_INV_STAT_UPD_PLAN_QTY

release type.
GME_INV_STAT_UPD_REL
Invalid batch status for updating the scrap

factor.
GME_INV_STAT_UPD_SCRAP
Invalid batch status for updating the WIP

planned quantity.
GME_INV_STAT_UPD_WIP_PLAN
Invalid batch status for inserting a step.
GME_INV_STATUS_INSERT_STEP
Cannot edit resource transaction if

step status is released and Automatic
step quantity calculation is selected.
GME_INV_STEP_STATUS_ASQC
The actual start date or the actual

completion date is not within the validity
rule dates.
GME_INVAL_VAL_RULE_DATES
Invalid API version.
GME_INVALID_API_VERSION
Batch status is not valid for &PROCESS.
GME_INVALID_BATCH_STATUS
Invalid batch type. The batch type must be

0 or 10.
GME_INVALID_BATCH_TYPE
&DATE1 cannot be earlier than &DATE2.
GME_INVALID_DATE_RANGE
Instance ID &INSTANCE_ID is not

found in GMP_RESOURCE_
INSTANCES table.
GME_INVALID_INSTANCE_ID
Message Text
Message Name
Instance number &INSTANCE_NO is

not found in GMP_RESOURCE_
INSTANCES table.
GME_INVALID_INSTANCE_NO
Invalid line number.
GME_INVALID_LINE_NO
Invalid value for Line Type.
GME_INVALID_LINE_TYPE
Invalid value for planned quantity.
GME_INVALID_PLAN_QTY
Organization code supplied is not a

manufacturing plant or laboratory.
GME_INVALID_PLANT
Invalid value for scale type.
GME_INVALID_SCALE_TYPE
Invalid value for the scrap factor.
GME_INVALID_SCRAP_FACTOR
Invalid value for the field text_code.
GME_INVALID_TEXT_CODE
Invalid value for WIP planned quantity.
GME_INVALID_WIP_PLAN_QTY
Updating the item ID is not allowed for the

current batch.
GME_ITEMID_CHG_NOT_ALLOWED
Updating the line number is not allowed

for the current batch.
GME_LINE_NO_CHG_NOT_ALLOWED
Updating the line type is not allowed for

the current batch.
GME_LINE_TYPE_CHG_NOT_ALLOWED
Invalid batch status for deleting the

material detail line.
GME_MATL_DEL_INV_STAT
Invalid batch status for inserting the

GME_MATL_INS_INV_STAT

GME_MATL_UPD_INV_STAT
Maximum step capacity is not defined for

GME_MAX_CAP_NOT_MASS_VOL_ERR
&MASS &VOLUME unit of measure types.
The automatic step quantity calculation
requires a minimum of one material line
that contributes to step quantity.
GME_MISS_LINES_CONT_STEP
Negative resource usage is not

allowed.
GME_NEG_USAGE_NT_ALWD
Activities are not defined for step &STEP_

NO
GME_NO_ACTIVITIES
Messages and Errors
A-13
Message Text
Message Name
No data found while retrieving the row

from table &TABLE_NAME.
GME_NO_DATA_FOUND
Cannot delete a phantom ingredient.
GME_NO_DEL_PHANT_ING
Cannot delete a phantom product.
GME_NO_DEL_PHANT_PROD
No keys specified to identify the rows in

the table &TABLE_NAME.
GME_NO_KEYS
No operation defined. Please define the

operation.
GME_NO_OPRN_DEFINED
No Plant code defined.
GME_NO_PLANT_CODE_DEFINED
Resources are not defined for activity

&ACTIVITY
GME_NO_RESOURCES
Step was not passed to the retrieve

unallocated items routine.
GME_NO_STEP_FETCH_UNALL
At least one ingredient and one product

are required.
GME_ONE_ING_PROD_REQD
At least one step required.
GME_ONE_STEP_REQD
Cannot update the material line to Not a

Phantom, since a phantom batch already
exists.
GME_PHANT_BATCH_EXISTS
Enter the value for Planned Activity

Factor.
GME_PLAN_ACTIVITY_REQD
Enter the value for Planned Resource

Usage.
GME_PLAN_RSRC_REQD
The primary product line of a batch cannot

be deleted.
GME_PRIM_PROD_DEL_ERR
The quantity entered does not match the

material allocated. To enter a different
quantity, click Line Allocations button.
GME_QTY_UNMATCH_ALLOC
&KEY Record of &TABLE_NAME is

locked by another user.
GME_RECORD_LOCKED
At least one resource is required for

this Batchstep activity.
GME_RESOURCE_NOT_ATTACH
Resource Actual Dates must be within the

parent actual dates (&START_DATE &END_DATE).
GME_RSRC_ACTUAL_DATE
Message Text
Message Name

Count.
GME_RSRC_COUNT_REQD
Resource &RESOURCE was not found

for activity &ACTIVITY.
GME_RSRC_NOT_FOUND
Resource Planned Dates are not within the

range of activity planned dates (&START_
DATE - &END_DATE)
GME_RSRC_PLAN_DATE

Quantity.
GME_RSRC_QTY_REQD
Cannot compute resource usage as

GMP: UOM for Hours - &SY_UOM
cannot be converted to resource usage
unit of measure &RSRC_USG_UOM.
GME_RSRC_USG_NT_CNV_SYUOM
Batch step resource ID

&BATCHSTEP_RSRC_ID was not
found in GME_BATCH_STEP_
RESOURCES table.
GME_RSRCID_NOT_FOUND
Resource transaction cannot be added

for firm planned order.
GME_RTXN_FOR_FPO_NT_ALWD
Resource transaction cannot be added

for a lab batch that cannot have its
inventory updated.
GME_RTXN_FOR_UPDINV_NT_ALWD
Enter the value for Planned Start Date.
GME_START_DATE_REQD
Activity &ACTIVITY is not defined

for step &STEP_NO.
GME_STEP_ACTIVITY_NOT_FOUND
Batch step cannot be deleted. Batch must

have a status of pending to delete batch
step.
GME_STEP_NOT_PENDING
Cannot reschedule steps. A step timing

conflict was detected.
GME_STEP_OVERLAP_ERROR
Planned step quantity cannot be less than

zero.
GME_STEP_QTY_LTHAN_ZERO
Enter the value for &FIELDREQ.
GME_STEP_REQD
Required field missing for the transaction

row.
GME_TRANS_REQD_FLD_MISSING
Messages and Errors
A-15
Message Text
Message Name
Dates are not updated for allocations
GME_TRANS_UPD_DATE
Unexpected &ERROR occurred.
GME_UNEXPECTED_ERROR
A resource cannot be entered when

the Batchstep activity factor is zero.
GME_ZERO_ACT_FACT
ERROR in &PROC - Input parameters are

missing.
INPUT_PARMS_MISS
Firm planned order steps cannot be closed.
INVALID_BATCH_TYPE_CLS_STEP
Default lot cannot be found.
NO_DEFAULT_LOT_FOUND
Invalid Batch Step Number
PC_INV_BATCHSTEP_NO
End Date cannot be less than the Start

Date.
PM_BADENDDATE
Starting Date cannot be greater than the

End Date.
PM_BADSTARTDATE
No Transactions found.
PM_DEFAULT_TRANS_LOST
This indivisible lot has already been

allocated elsewhere.
PM_INDIV_ALREADY_ALLOCD
Invalid item.
PM_INVALID_ITEM
Invalid action for phantom batches.
PM_INVALID_PHANTOM_ACTION
Lot is indivisible. Allocate entire available

qty or select another lot/sublot.
PM_LOT_INDIV
Missing or Invalid Allocation Class.
PM_NO_ALLOC_CLASS
This is not a Phantom Ingredient.
PM_NOTAPHANTOM
Item is not lot/location controlled.
PM_NOTLOT_LOCT
Phantom Batch already exists for this Item.
PM_PHANTOM_EXISTS
Unexploded Phantoms Exist.
PM_UNEXPLODED_PHANTOMS
Setup Error.
SETUP_ERROR
The date entered cannot be in the

future.
SY_NOFUTUREDATE
Unable To Load UOM.
UNABLE_TO_LOAD_UOM
B
REM dbdrv: sql ~PROD ~PATH ~FILE none none none package &phase=pls \
REM dbdrv: checkfile:~PROD:~PATH:~FILE
SET VERIFY OFF
WHENEVER SQLERROR EXIT FAILURE ROLLBACK;
REM **********************************************************************
REM *
*
REM * FILE:
GMEPAPIS.pls
*
REM * PURPOSE: Package Specification for the GME PUBLIC API routines
*
REM * AUTHOR: Paul J Schofield, OPM Development
*
REM * DATE:
February 1st 2001
*
REM * HISTORY:
*
REM * ========
*
REM * 01FEB01 P.J.Schofield
*
REM *
Created
*
REM * 21MAR01 Thomas Daniel
*
REM *
Added unallocated materials record type definition
*
REM * 07MAY01 Thomas Daniel
*
REM *
Added Certify_Step, Uncertify_Step, Theoretical_Yield,
*
REM *
Reroute_Batch and Resource Consolidation routines
*
REM *
Created
*
REM * 08MAY01 Bharati Satpute
*
REM *
Added Close Batch, Close Steps routines Created
*
REM * 15MAY01 Shikha Nagar
*
REM *
Added Partial Certification Routines
*
*
REM *
Added insert step routine
*
REM * 23MAY01 Bharati Satpute
*
REM *
Added Unrelease step routine
*
*
REM *
Added Reschedule step routine
*
REM * 31MAY01 Olivier Daboval
*
REM *
Added Reopen_batch routine
*
B-1
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
REM
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
*
06JUN01
06JUN01
18JUN01
14AUG01
21AUG01
27AUG01
07JAN02
25APR02
03MAY02
21MAY02
11JUL02
29JUL02
22AUG02
5NOV02
26JAN03
15FEB03
25FEB03
19MAR03
22APR02
Olivier Daboval
*
Added reopen_step routine
*
Shrikant Nene
*
Changed gme_text_tbl to gme_text_table
*
Shrikant Nene
*
Added release_step routine
*
Thomas Daniel
*
Added call to material line APIs.
*
Pawan Kumar
*
Added call to convert_fpo APIs.
*
Pawan Kumar
*
Added call to scale_batch and theoretical_yield_batch.
*
BUG 2159185 - Added parameter
*
p_update_batch to determine if the batch planned end
*
date should be updated if the rescheduling goes past the *
batch's planned end date or if an error message should
*
be returned. Modified procedure reschedule_step.
*
BUG 2342448 - Thomas Daniel
*
Removed the word batch in the name of the procedures
*
certify_step and uncertify_step. Also removed the out
*
parameter from the delete_material_line procedure.
*
*
Added the new insert_line_allocation API.
*
*
Added the parameter p_delete_pending for close step.
*
Bug 2404032 - Shrikant Nene
*
Removed 2 parameters p_batch_size_uom ,p_schedule_method *
From convert_fpo procedure
*
Bug#2386578 - Shrikant Nene
*
Added new parameter p_batch_no to create_phantom procedure*
BUG 2498487 - Shrikant Nene
*
p_instance_id and p_instance_no
*
parameters are made optional in all the resource txn apis *
Also p_trans_date parameter is made optional in all the
*
end_cmplt_actual_rsrc_txn procedure
Bharati Satpute Added nocopy changes
Pawan Kumar
Bug - 2761758 - Added parameter p_trans_date *
to procedure partial_cert_batch
*
Shikha Nagar Bug2426663 Added update and delete procedures *
for line allocations
Shikha Nagar Bug2767914 - Added new procedures for rsrc API*
insert_resource update_resource and delete_resource
*
Antonia Newbury Bug2770619 - Added new procedures for
*
activity API - insert, update and delete
*
Pawan Kumar bug 2912743 added poc_trans_id to procedures
B-2 Oracle Process Manufacturing Process Execution API Users Guide
REM *
insert_timed_actual_rsrc_txn ,insert_incr_actual_rsrc_txn,
REM *
start_cmplt_actual_rsrc_txn, update_actual_resource_usage
REM **********************************************************************
/*************************************************************************
* This file contains the headers for the Process Execution (GME) APIs in *
* Oracle Process Manufacturing (OPM). Each procedure has a common set of *
* parameters to which API-specific parameters are appended.
*
*************************************************************************/
CREATE OR REPLACE PACKAGE gme_api_pub AS
/* $Header: GMEPAPIS.pls 115.60 2003/04/23 15:52:17 pxkumar noship $ */
api_version
CONSTANT NUMBER
:= 1;
max_errors
CONSTANT NUMBER
:= 100;
inv_short_err
:= 'V';
unalloc_items_err
:= 'N';
incomp_man_alloc_err
:= 'I';
negative_inventory
:= 'G';
setup_done
BOOLEAN
:=
FALSE;
user_name
VARCHAR2 (240);
user_ident
NUMBER;
login_id
NUMBER;
default_lot
VARCHAR2 (240);
default_loct
VARCHAR2 (240);
yield_type
VARCHAR2 (240);
yield_uom
VARCHAR2 (240);
allow_neg_inv
VARCHAR2 (240);
step_control
VARCHAR2 (240);
error_count
NUMBER
DEFAULT
0;
co_code
VARCHAR2 (4);
plant_code
VARCHAR2 (4);
copy_routing_text
VARCHAR2 (4);
copy_formula_text
VARCHAR2 (4);
TIMESTAMP
DATE;
release_type
NUMBER;
auto_release
CONSTANT NUMBER (5)
:= 0;
manual_release
CONSTANT NUMBER (5)
:= 1;
incremental_release
CONSTANT NUMBER (5)
:= 2;
step_release
CONSTANT NUMBER (5)
:= 3;
auto_auto_alloc
CONSTANT NUMBER (5)
:= 1;
user_auto_alloc
CONSTANT NUMBER (5)
:= 0;
epsilon
NUMBER;
batch_scale_factor
NUMBER;
routing_scale_factor
NUMBER;
B-3
warn_message
VARCHAR2 (240);
TYPE number_tab IS TABLE OF NUMBER

INDEX BY BINARY_INTEGER;
TYPE material_details_tab IS TABLE OF gme_material_details%ROWTYPE
TYPE item_masters_tab IS TABLE OF ic_item_mst%ROWTYPE
TYPE transactions_tab IS TABLE OF gme_inventory_txns_gtmp%ROWTYPE
TYPE real_inv_trans_tab IS TABLE OF ic_tran_pnd%ROWTYPE
TYPE inv_trans_rec_tab IS TABLE OF gmi_trans_engine_pub.ictran_rec
TYPE real_res_trans_tab IS TABLE OF gme_resource_txns%ROWTYPE
TYPE text_tab IS TABLE OF gme_text_table%ROWTYPE
TYPE resource_transactions_tab IS TABLE OF gme_resource_txns_gtmp%ROWTYPE
TYPE unallocated_items_tab IS TABLE OF gme_unallocated_items_gtmp%ROWTYPE
TYPE p_field IS RECORD (p_value VARCHAR2 (50));
TYPE field_values_tab IS TABLE OF p_field
TYPE recipe_validity_rule_tab IS TABLE OF gmd_recipe_validity_rules%ROWTYPE
--Buffers for recipe upload

routings
routing_materials
steps
gmd_recipe_fetch_pub.recipe_rout_tbl;
gmd_recipe_fetch_pub.recipe_rout_matl_tbl;
gmd_recipe_fetch_pub.recipe_step_tbl;
step_dependencies
activities
resources
materials
return_code
recipe_id
gmd_recipe_fetch_pub.routing_depd_tbl;
gmd_recipe_fetch_pub.oprn_act_tbl;
gmd_recipe_fetch_pub.oprn_resc_tbl;
gmdfmval_pub.formula_detail_tbl;
NUMBER;
NUMBER;
TYPE unallocated_materials_tab IS TABLE OF gme_unallocated_items_gtmp%ROWTYPE

/*==============================================================================
==
Procedure
log_message
Description
This procedure is used accross all the procedures to log a message to the
message stack.
Parameters
p_mesage_code (R)
The message which is being put onto the stack.
p_token1_name (R)
The name of the token1 in the message if any.
p_token1_value (R)
The value of the token1 in the message if it exists.
p_token2_name (R)
p_token2_value (R)
p_token3_name (R)
p_token3_value (R)
================================================================================
*/
PROCEDURE log_message (
p_message_code
IN
,p_token1_name
IN
,p_token1_value
IN
,p_token2_name
IN
,p_token2_value
IN
,p_token3_name
IN
,p_token3_value
IN
VARCHAR2
VARCHAR2
VARCHAR2
VARCHAR2
VARCHAR2
VARCHAR2
VARCHAR2
:=
:=
:=
:=
:=
:=
NULL
NULL
NULL
NULL
NULL
NULL);
/*==============================================================================
==
FUNCTION
setup
Description
B-5
This function is used accross all the procedures to setup the profile
values
and constants. This function returns FALSE if any of the constants or
profiles
are not set properly.
Return Values
TRUE
If the setup is done successfully.
FALSE
If their are any errors in the setup.
================================================================================
*/
FUNCTION setup
RETURN BOOLEAN;
/*==============================================================================
==
Procedure
save_batch
Description
This procedure is used to consolidate all the transactions from the
temporary
tables and write them to the main tables.
Parameters
p_batch_header (R)
The batch header row to identify the batch
Following columns are used from this row.
batch_id (R) OR
plant_code (R)
batch_type (R)
batch_no (R)
x_return_status
outcome of the API call
S - Success
E - Error
U - Unexpected Error
p_commit Indicates whether to commit. This is defaulted to FALSE
so that all current code works as is.
================================================================================
*/
PROCEDURE save_batch
p_batch_header
,x_return_status
,p_commit
(
IN
OUT NOCOPY
IN
VARCHAR2
BOOLEAN := FALSE);
/*==============================================================================
==
Procedure
create_batch
Description
This procedure creates batch, then check for Items failing allocation and
inventory shortages.
Parameters
p_batch_header (R)
plant_code (R)
recipe_validity_rule_id (R)
batch_type (R)
update_inventory_ind (R)
batch_no (R In case of manual document ordering)
plan_start_date (O)
plan_cmplt_date (O)
due_date (O)
wip_whse_code (O)
p_batch_size (R)
Batch Size (Total input, total output or product
quantity)
p_batch_size_uom (R)
UOM for p_batch_size
p_ignore_shortages (R)
Do not check for the inventory shortages
p_creation_mode (R)
How the batch is created
RECIPE
PRODUCT
TOTAL_OUTPUT
TOTAL_INPUT
p_recipe_id (O)
Recipe_id for which the batch is to be created.
p_recipe_no (O)
Recipe number along with recipe_version for
which the
batch is to be created.
p_recipe_version (O)
Version of the recipe for which the batch is t
be created.
p_product_no (O)
Item number for which the batch is to be
created.
p_product_id (O)
Item ID for which the batch is to be created.
p_ignore_qty_below_cap (O)Whether the batch is to be created or not, when
resource
quantity goes below minimum capacity of the
resource.
True (Default)
False
B-7
x_batch_header
The batch header that is returned, with all the
x_unallocated_material
Table of materials, if auto allocation failed or

inventory shortage exists
S - Success
E - Error
N - Items failed auto allocation
V - Inventory shortage exists
data
x_return_status
================================================================================
*/
PROCEDURE create_batch (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,x_batch_header
,p_batch_size
,p_batch_size_uom
,p_creation_mode
,p_recipe_id
,p_recipe_no
,p_recipe_version
,p_product_no
,p_product_id
,p_ignore_shortages
tab);
IN
IN
IN
IN
OUT
OUT
OUT
IN
OUT
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
NUMBER
VARCHAR2
VARCHAR2
NUMBER := NULL
VARCHAR2 := NULL
NUMBER := NULL
VARCHAR2 := NULL
NUMBER := NULL
BOOLEAN := TRUE
BOOLEAN
gme_api_pub.unallocated_materials_
/*==============================================================================
==
Procedure
create_phantom
Description
This procedure creates phantom batch based on the validity rule passsed
Parameters
p_material_details (R)
p_batch_no
(O)
p_validity_rule_id (R)
x_material_details
the data
x_return_status
The material detail row to identify the material

material_detail_id (R)
Batch no, in case of manual document ordering
validity rule to use for creating phantom batch
The material detail that is returned, with all
S - Success
E - Error
================================================================================
*/
PROCEDURE create_phantom (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_material_detail
,p_batch_no
,x_material_detail
,p_validity_rule_id
,p_ignore_shortages
tab);
IN
IN
IN
IN
OUT
OUT
OUT
IN
IN
OUT
IN
IN
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
NUMBER
BOOLEAN
/*==============================================================================
==
Procedure
release_batch
Description
This procedure releases batch and all the phantom batches
Before releaseing the batch, it tries to auto-allocate batch, check
for inventory shortages.
B-9
Parameters
p_batch_header (R)
p_ignore_unalloc (R)

batch_id (R)
actual_start_date (O)
Do not check for the item requiring allocations
x_batch_header

S - Success
E - Error
N - Items require allocation
data
x_return_status
================================================================================
*/
PROCEDURE release_batch (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,x_batch_header
,p_ignore_shortages
,p_ignore_unalloc
IN
IN
IN
IN
OUT
OUT
OUT
IN
OUT
IN
OUT
IN
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN
BOOLEAN DEFAULT FALSE);
/*==============================================================================
==
Procedure
release_step
Description
This procedure releases step. If the batch is not in WIP state already and
the
GME: Step control batch status is set to true, this procedure will call
release_batch.
Before releaseing the step, it tries to auto-allocate batch, check
for inventory shortages.
Parameters
p_batch_step (R)
p_ignore_unalloc (R)
The batch step row to identify the step

batchstep_id (R)
actual_start_date (O)
Do not check for the item requiring allocations
x_batch_step

S - Success
E - Error
N - Items require allocation
data
x_return_status
================================================================================
*/
PROCEDURE release_step (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,p_batch_step
,x_message_count
,x_message_list
,x_return_status
,x_batch_step
,p_ignore_shortages
,p_ignore_unalloc
IN
IN
IN
IN
IN
OUT
OUT
OUT
OUT
OUT
IN
IN
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
gme_batch_steps%ROWTYPE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := FALSE
BOOLEAN := FALSE);
/*==============================================================================
==
Procedure
Listing of GMEPAPIS.pls B-11
unrelease_batch
Description
This procedure unreleases batch and all the phantom batches
Parameters
p_batch_header (R)

batch_id (R)
p_preserve_allocations (R)Do not delete pending allocations
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE unrelease_batch (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_header
IN
,x_batch_header
OUT
,p_preserve_allocations
IN
BOOLEAN := FALSE
BOOLEAN := FALSE
NOCOPY NUMBER
NOCOPY VARCHAR2
NOCOPY VARCHAR2
NOCOPY gme_batch_header%ROWTYPE
BOOLEAN);
/*==============================================================================
==
Procedure
unrelease_step
Description
This procedure unreleases step.
Parameters
p_batch_step (R)

batchstep_id (R)
p_preserve_allocations (R)Do not delete pending allocations

x_batch_step
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE unrelease_step (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_step
,x_batch_step
,p_preserve_allocations
IN
IN
IN
IN
OUT
OUT
OUT
IN
OUT
IN
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN);
/*==============================================================================
==
Procedure
certify_batch
Description
This procedure completes (certifies) batch and all the phantom batches.
It also certifies all the steps.
While completing the batch, checks for inventory shortages.
Parameters
p_batch_header (R)

batch_id (R)
actual_start_date (O) (In case of direct
completion)
actual_cmplt_date (O)
p_del_incomplete_manual (R) Delete incomplete manual transactions
x_batch_header
data
exists, or
x_return_status

incomplete manual transactions exist
S - Success
E - Error
N - Items require allocations
I - Incomplete manual transactions exists
================================================================================
*/
PROCEDURE certify_batch (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_del_incomplete_manual
,p_ignore_shortages
,p_batch_header
,x_batch_header
tab);
IN
IN
IN
IN
OUT
OUT
OUT
IN
IN
IN
OUT
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := FALSE
BOOLEAN := FALSE
/*==============================================================================
==
Procedure
certify_step
Description
This procedure completes (certifies) step. If this is the last step and
GME: Step controls Batch status is set then It also calls complete_batch.
While completing the step, checks for inventory shortages.
Parameters
p_batch_step (R)

batchstep_id (R)
completion)
p_del_incomplete_manual (R) Delete incomplete manual transactions
x_batch_step
The batch step that is returned, with all the
data
exists, or
x_return_status

incomplete manual transactions exist
S - Success
E - Error
N - Items require allocations
I - Incomplete manual transactions exists
================================================================================
*/
PROCEDURE certify_step (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_step
,x_batch_step
,p_del_incomplete_manual
,p_ignore_shortages
,p_override_quality
IN
IN
IN
IN
OUT
OUT
OUT
IN
OUT
OUT
IN
IN
IN
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := FALSE
BOOLEAN := FALSE
BOOLEAN := FALSE);
/*==============================================================================
==
Procedure
uncertify_batch
Description
This procedure reverts a completed batch to WIP and all the phantom
batches.
Parameters
p_batch_header (R)

batch_id (R)
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE uncertify_batch (
p_api_version
IN
,p_validation_level IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
,x_return_status
OUT NOCOPY
,p_batch_header
IN
,x_batch_header
OUT NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
gme_batch_header%ROWTYPE);
/*==============================================================================
==
Procedure
uncertify_step
Description
This procedure reverts a step to WIP.
Parameters
p_batch_step (R)

batchstep_id (R)
completion)
x_batch_step
x_return_status
data
S - Success
E - Error
================================================================================
*/
PROCEDURE uncertify_step (
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_step
IN
,x_batch_step
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
gme_batch_steps%ROWTYPE);
/*==============================================================================
==
Procedure
close_batch
Description
This procedure closes batch and all the phantom batches.
It also closes all the steps.
Parameters
p_batch_header (R)

batch_id (R)
batch_close_date (O)
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE close_batch (
p_api_version
IN
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,x_batch_header
IN
IN
IN
OUT
OUT
OUT
IN
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
/*==============================================================================
==
Procedure
close_step
Description
This procedure closes step.
Parameters
p_batch_step (R)
p_delete_pending (R)

batchstep_id (R)
step_close_date (O)
Delete the pending allocations if any for the
material lines associated with the step.
x_batch_step
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE close_step (
p_api_version
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
OUT NOCOPY VARCHAR2
,p_batch_step
IN
,p_delete_pending IN
BOOLEAN := FALSE
,x_batch_step
OUT NOCOPY
/*==============================================================================
==
Procedure
cancel_batch
Description
This procedure cancels batch and all the phantom batches.
It also cancels all the steps.
Parameters
p_batch_header (R)

batch_id (R)
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE cancel_batch
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,x_batch_header
(
IN
IN
IN
IN
OUT
OUT
OUT
IN
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
/*==============================================================================
==
Procedure
reopen_batch
Description
This procedure reopens batch and all the phantom batches.
It also reopens all the steps, if requested so.
Parameters
p_batch_header (R)
p_reopen_steps (O)

batch_id (R)
Reopen all the steps.
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE reopen_batch (
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_header
IN
,p_reopen_steps
IN
,x_batch_header
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := FALSE
/*==============================================================================
==
Procedure
reopen_step
Description
This procedure reopens step.
Parameters
p_batch_step (R)

batchstep_id (R)
x_batch_header
x_return_status
data
S - Success
E - Error
================================================================================
*/
PROCEDURE reopen_step (
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_step
IN
,x_batch_step
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
/*==============================================================================
==
Procedure
reroute_batch
Description
This procedure reroutes batch (typically change the route associated with
the batch).
Parameters
p_batch_header (R)

batch_id (R)
Recipe validity rule id for the new recipe.
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE reroute_batch (
p_api_version
IN
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,p_validity_rule_id
,x_batch_header
IN
IN
IN
OUT
OUT
OUT
IN
IN
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
NUMBER
/*==============================================================================
==
Procedure
reschedule_batch
Description
This procedure reschedules batch and all the phantom batches.
It also reschedules all the steps, if requested so.
Parameters
p_batch_header (R)

batch_id (R)
plan_start_date (R)
plan_cmplt_date (R)
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE reschedule_batch
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_header
IN
(
BOOLEAN := FALSE
BOOLEAN := FALSE
NOCOPY NUMBER
NOCOPY VARCHAR2
NOCOPY VARCHAR2
,x_batch_header
OUT NOCOPY gme_batch_header%ROWTYPE);
/*==============================================================================
==
Procedure
reschedule_step
Description
This procedure reschedules step and all the subsequent steps, if requested
so.
Parameters
p_batch_step (R)
p_reschedule_other (O)
x_batch_step

batchstep_id (R)
plan_start_date (R)
plan_cmplt_date (R)
Whether to reschedule subsequent steps.
data
x_return_status

S - Success
E - Error
================================================================================
*/
PROCEDURE reschedule_step (
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
,x_return_status
OUT NOCOPY
,p_batch_step
IN
,p_reschedule_other IN
,x_batch_step
OUT NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
BOOLEAN := TRUE
/*==============================================================================
==
Procedure
scale_batch
Description
This procedure scaless batch up or down and all the phantom batches.
Parameters
p_batch_header (R)
p_scale_factor (R)
p_primaries (R)
p_qty_type (O)
quantities

batch_id (R)
How much to scale. (scale multiplier;
to make the twice as much quantity,
scale factor = 2; to reduce quantity to
half scale factor = -0.5.
Scaling based on product or Ingredients
INPUT - Ingredients
OUTPUT - Products
Whether to use formula quantities or batch
0 - Formula
1 - Batch
(Default)
x_batch_header
x_over_allocations
Tables of material lines, where trying to scale
data
down
the batch, and the quantities are going below
allocations
x_return_status

S - Success
E - Error
G - Over allocation exists
================================================================================
*/
PROCEDURE scale_batch (
p_api_version
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,x_over_allocations OUT
,p_batch_header
IN
,x_batch_header
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
,p_scale_factor
,p_primaries
,p_qty_type
IN
IN
IN
NUMBER
VARCHAR2
NUMBER DEFAULT 1);
/*==============================================================================
==
Procedure
theoretical_yield_batch
Description
This procedure calculates theoretical yield for the batch, and updates the
quantities for the product lines.
Parameters
p_batch_header (R)
p_scale_factor (R)

batch_id (R)
Theoretical yield in fractions
x_batch_header
x_return_status

S - Success
E - Error
data
================================================================================
*/
PROCEDURE theoretical_yield_batch
p_api_version
IN
,p_init_msg_list
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
,p_commit
IN
,x_return_status
OUT NOCOPY
,p_batch_header
IN
,p_scale_factor
IN
(
BOOLEAN := FALSE
NUMBER
VARCHAR2
BOOLEAN := FALSE
VARCHAR2
NUMBER);
/*==============================================================================
==
Procedure
allocate_batch
Description
This procedure auto-allocates batch and all the phantom batches.
Parameters
p_batch_header (R)

batch_id (R)
Whether to allocate lines with the
p_alloc_type (O)
auto-allocation
or user-initiated allocations class

0 - User initiated allocation class
1 - Auto allocation class
9 - All of the above (Default)
Whether to allocate lines with consumption type
of auto, manual etc.
0 - Automatic
1 - Manual
2 - Incremental
3 - by Step
p_release_type (O)
p_del_exist_alloc (O)
allocationg.
Delete existing allocations before, auto

True
False (Default)
x_batch_header
Table of materials, if some of the lines did not
data
get
allocated.
S - Success
E - Error
x_return_status
================================================================================
*/
PROCEDURE allocate_batch (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
BOOLEAN := FALSE
BOOLEAN := FALSE
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,p_release_type
,p_alloc_type
,p_del_exist_alloc
OUT
OUT
OUT
IN
OUT
IN
IN
IN
NOCOPY NUMBER
NOCOPY VARCHAR2
NOCOPY VARCHAR2
NOCOPY gme_api_pub.unallocated_materials_tab
NUMBER DEFAULT 9
NUMBER DEFAULT 9
BOOLEAN DEFAULT FALSE);
/*==============================================================================
==
Procedure
allocate_line
Description
This procedure auto-allocates material detail line.
Parameters
p_alloc_type (O)
auto-allocation
p_del_exist_alloc (O)
allocationg.

Whether to allocate lines with the
or user-initiated allocations class
0 - User initiated allocation class
1 - Auto allocation class
Delete existing allocations before, auto
True
False (Default)
get
x_return_status
allocated.
S - Success
E - Error
================================================================================
*/
PROCEDURE allocate_line (
p_material_details
,p_alloc_type
,p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_del_exist_alloc
IN
IN
NUMBER DEFAULT 9
IN
IN
IN
BOOLEAN := FALSE
IN
BOOLEAN := FALSE
OUT NOCOPY NUMBER
OUT NOCOPY VARCHAR2
OUT NOCOPY VARCHAR2
IN
BOOLEAN := FALSE);
/*==============================================================================
==
Procedure
convert_fpo
Description
This procedure is used to convert the firm planned order to one of many
batches.
Parameters
p_batch_header (R)
p_batch_size (R)
p_num_batches (R)
The FPO row to identify the FPO

batch_id (R)
The size of the batch to be created.
Number of batches to be created.
The validity rule to be used to create the batch
(if
converting to 1 batch or p_use_for_all is set to
True)
p_validity_rule_tab (O)
multiple batches)
p_leadtime (O)
p_batch_offset (O)
p_offset_type (O)
p_plan_start_date (R)
p_plan_cmplt_date (O)
p_use_for_all
(O)
x_return_status
The validity rules tab (if converting to

The batch duration in case routing data or
production rules does not exists.
The offset time between batches.
The offset type.
0 - Start to start
1 - Finish to start
The start date of the first batch
The completion date of the last batch
Use the same validity rule for all the batches.
S - Success
E - Error
V - Inventory shortages exist
================================================================================
*/
PROCEDURE convert_fpo (
p_api_version
,p_validation_level
,p_init_msg_list
,p_commit
,x_message_count
,x_message_list
,p_enforce_vldt_check
,x_return_status
,p_batch_header
,x_batch_header
,p_batch_size
,p_num_batches
,p_validity_rule_id
,p_validity_rule_tab
,p_leadtime
,p_batch_offset
,p_offset_type
,p_plan_start_date
,p_plan_cmplt_date
,p_use_for_all
IN
IN
IN
IN
OUT
OUT
IN
OUT
IN
OUT
IN
IN
IN
IN
IN
IN
IN
IN
IN
IN
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
BOOLEAN
VARCHAR2
NUMBER
NUMBER
NUMBER
gme_api_pub.recipe_validity_rule_tab
NUMBER DEFAULT 0
NUMBER DEFAULT 0
NUMBER DEFAULT 0
gme_batch_header.plan_start_date%TYPE
gme_batch_header.plan_cmplt_date%TYPE
BOOLEAN := TRUE);
/*==============================================================================
==
Procedure
delete_step
Description
This procedure deletes the step associated with the batch
Parameters
p_batch_step (R)
x_return_status

batchstep_id (R)
S - Success
E - Error
================================================================================
*/
PROCEDURE delete_step (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
OUT NOCOPY VARCHAR2
,p_batch_step
IN
/*==============================================================================
==
Procedure
insert_step
Description
This procedure inserts the new step to the batch
Parameters
p_batch_step (R)
x_batch_step
data
x_return_status
The batch step row to insert to the batch.

S - Success
E - Error
================================================================================
*/
PROCEDURE insert_step (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
,p_batch_header
IN
,p_batch_step
IN
,x_batch_step
OUT
NOCOPY
NOCOPY
NOCOPY
NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
/*==============================================================================
==
Procedure
partial_cert_batch
Description
This procedure is used to incrementally backflush the qty to the material
line.
Parameters
p_batch_header (R)

batch_id (R)
line.
p_qty (R)
p_qty_type (R)
p_backflush_phantoms (R)
associated

The quantity to apply incrementally.
0 - By increment qty
1 - New actual qty
2 - % of Plan
Backflush the quantities to the phantoms
p_adjust_cmplt (R)
with the batch.

Ignore any inventory shortages.
Adjust completed batches.
get
x_return_status
allocated.
S - Success
E - Error
V - Inventory shortages
================================================================================
*/
PROCEDURE partial_cert_batch (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
,x_message_count
,x_message_list
,x_return_status
,p_batch_header
,p_material_details
,p_qty
,p_qty_type
,p_trans_date
,p_backflush_phantoms
,p_ignore_shortages
,p_adjust_cmplt
tab);
IN
OUT
OUT
OUT
IN
IN
IN
IN
IN
IN
IN
IN
OUT
BOOLEAN := FALSE
NOCOPY NUMBER
NOCOPY VARCHAR2
NOCOPY VARCHAR2
NUMBER
NUMBER
DATE
BOOLEAN DEFAULT FALSE
BOOLEAN DEFAULT TRUE
NOCOPY gme_api_pub.unallocated_materials_
/*==============================================================================
==
Procedure
insert_material_line
Description
This procedure is used to insert the material line to the batch.
Parameters
p_material_detail (R)
line.
p_batchstep_no (O)
be associated.
x_material_detail
assigned.
x_return_status
The material detail row to insert the material

The batch step to which the material line should
The material detail row with all the data
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_material_line (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
,x_return_status
,p_material_detail
,p_batchstep_no
,x_material_detail
OUT NOCOPY VARCHAR2

IN
IN
NUMBER DEFAULT NULL
OUT NOCOPY gme_material_details%ROWTYPE);
/*==============================================================================
==
Procedure
update_material_line
Description
This procedure is used to update the material line in the batch.
Parameters
update.
p_values_tab (R)
updated.
p_scale_phantom (O)
x_material_detail
assigned.
x_return_status
The material detail row with the values to

The columns in the material line which should be
The material detail row with all the data

S - Success
E - Error
================================================================================
*/
PROCEDURE update_material_line (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
,x_return_status
OUT NOCOPY
,p_material_detail
IN
,p_values_tab
IN
,p_scale_phantom
IN
,x_material_detail
OUT NOCOPY
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
gme_api_pub.field_values_tab
BOOLEAN := FALSE
gme_material_details%ROWTYPE);
/*==============================================================================
==
Procedure
delete_material_line
Description
This procedure is used to delete the material line in the batch.
Parameters
x_return_status
The material detail row to be deleted

S - Success
E - Error
================================================================================
*/
PROCEDURE delete_material_line (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
,p_commit
IN
,x_message_count
OUT NOCOPY
,x_message_list
OUT NOCOPY
,x_return_status
OUT NOCOPY
,p_material_detail
IN
BOOLEAN := FALSE
BOOLEAN := FALSE
NUMBER
VARCHAR2
VARCHAR2
gme_material_details%ROWTYPE);
/*==============================================================================
==
Procedure
insert_line_allocation
Description
This procedure is used to insert a pending or complete line allocation for
an
existing batch material line.
Parameters
p_tran_row (R)
p_lot_no (O)
The transaction row to be inserted.

The lot no for the transaction
(Required if the item is lot controlled and lot
id
p_sublot_no (O)
is not passed in)

The sublot no for the transaction
id
is not passed in)
p_create_lot (O)TRUE, if the lot has to be created on fly.

p_ignore_shortage (O)
TRUE, if any shortages have to be ignored.
p_scale_phantom (O)
TRUE, if the allocation is for phantom and it
has
x_material_detail
x_tran_row
x_def_tran_row
adjustments.
x_return_status
to be scaled.
The updated material line.
The updated transaction row.
The default transaction row with any
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_line_allocation (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_tran_row
IN
gme_inventory_txns_gtmp%ROWTYPE
,p_lot_no
IN
,p_sublot_no
IN
,p_create_lot
IN
,p_ignore_shortage
IN
,p_scale_phantom
IN
,x_material_detail
OUT NOCOPY gme_material_details%ROWTYPE
,x_tran_row
OUT NOCOPY gme_inventory_txns_gtmp%ROWTYPE
,x_def_tran_row
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
OUT NOCOPY VARCHAR2);
/*==============================================================================
==
Procedure
update_actual_rsrc_usage
Description
This procedure is used to insert a complete resource txn allocation for a
resource.This procedure removes all the existing resource txn for the
specified
resource.This API can be used only for a WIP or Complete step.
Parameters
p_batchstep_rsrc_id (O)
p_plant_code (R)
p_batch_no (R)
p_batchstep_no (R)
p_activity (R)
p_resource (R)
p_trans_date (R)
p_start_date (R)
p_end_date (R)
p_usage (R)
p_reason_code (R)
p_instance_id (O)
p_instance_no (O)
x_return_status

Plant code of the batch.
Batch no.
Batch Step no .
Activity.
Resource.
Transaction date
start date of txn
end date of txn.
resource txn usage in resource usage UOM .
reason code for adding a completed txn
instance id - for WPS use
instance no - for WPS use
S - Success
E - Error
================================================================================
*/
PROCEDURE update_actual_rsrc_usage (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_rsrc_id IN
NUMBER
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER := NULL
,p_activity
IN
VARCHAR2 := NULL
,p_resource
IN
VARCHAR2 := NULL
,p_trans_date
IN
DATE
,p_start_date
IN
DATE
,p_end_date
IN
DATE
,p_usage
IN
NUMBER
,p_reason_code
IN
VARCHAR2
,p_instance_id
IN
NUMBER := NULL
,p_instance_no
IN
NUMBER := NULL
,x_poc_trans_id
OUT NOCOPY
NUMBER
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
/*==============================================================================
==
Procedure
insert_incr_actual_rsrc_txn
Description
This procedure is used to incrementally insert a complete resource txn
allocation for a
resource.This API can be used only for a WIP or Complete step.
Parameters
p_batchstep_rsrc_id (R)
p_plant_code (O)
p_batch_no (O)
p_batchstep_no (O)
p_activity (O)
p_resource (O)
p_trans_date (R)
p_start_date (R)
p_end_date (R)
p_usage (R)
p_reason_code (R)
p_instance_id (O)
p_instance_no (O)
x_return_status

Batch no.
Batch Step no .
Activity.
Resource.
Transaction date
start date of txn
end date of txn.
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_incr_actual_rsrc_txn (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
NUMBER
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER := NULL
,p_activity
IN
VARCHAR2 := NULL
,p_resource
IN
VARCHAR2 := NULL
,p_trans_date
IN
DATE
,p_start_date
IN
DATE
,p_end_date
IN
DATE
,p_usage
,p_reason_code
,p_instance_id
,p_instance_no
,x_poc_trans_id
,x_message_count
,x_message_list
,x_return_status
IN
NUMBER
IN
VARCHAR2
IN
NUMBER := NULL
IN
NUMBER := NULL
OUT NOCOPY
NUMBER
OUT NOCOPY NUMBER
OUT NOCOPY VARCHAR2
/*==============================================================================
==
Procedure
insert_timed_actual_rsrc_txn
Description
This procedure is used to insert a complete resource txn allocation for a
resource.usage is calculated from txn dates supplied.
This API can be used only for a WIP or Complete step.
Parameters
p_plant_code (O)
p_batch_no (O)
p_batchstep_no (O)
p_activity (O)
p_resource (O)
p_trans_date (R)
p_start_date (R)
p_end_date (R)
p_reason_code (R)
p_instance_id (O)
p_instance_no (O)
x_return_status
batch step resource id of resource

Batch no.
Batch Step no .
Activity.
Resource.
Transaction date
start date of txn
end date of txn.
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_timed_actual_rsrc_txn (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
NUMBER
,p_plant_code
,p_batch_no
,p_batchstep_no
,p_activity
,p_resource
,p_trans_date
,p_start_date
,p_end_date
,p_reason_code
,p_instance_id
,p_instance_no
,x_poc_trans_id
,x_message_count
,x_message_list
,x_return_status
IN
VARCHAR2 := NULL
IN
VARCHAR2 := NULL
IN
NUMBER := NULL
IN
VARCHAR2 := NULL
IN
VARCHAR2 := NULL
IN
DATE
IN
DATE
IN
DATE
IN
VARCHAR2
IN
NUMBER := NULL
IN
NUMBER := NULL
OUT NOCOPY
NUMBER
OUT NOCOPY NUMBER
OUT NOCOPY VARCHAR2
/*==============================================================================
==
Procedure
start_cmplt_actual_rsrc_txn
Description
This procedure is used to start a complete resource txn for a resource.
usage of the txn is 0 as the txn has just started.end_cmplt_actual_rsrc_
txn
API is used to complete a started txn
Parameters
batch step resource id of a resoure
p_plant_code (O)
p_batch_no (O)
Batch no.
p_batchstep_no (O)
Batch Step no .
p_activity (O)
Activity.
p_resource (O)
Resource.
p_trans_date (R)
Transaction date
p_start_date (R)
start date of txn
p_reason_code (R)
p_instance_id (O)
p_instance_no (O)
x_return_status
S - Success
E - Error
================================================================================
*/
PROCEDURE start_cmplt_actual_rsrc_txn (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
NUMBER
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER := NULL
,p_activity
IN
VARCHAR2 := NULL
,p_resource
IN
VARCHAR2 := NULL
,p_trans_date
IN
DATE
,p_start_date
IN
DATE
,p_reason_code
IN
VARCHAR2
,p_instance_id
IN
NUMBER := NULL
,p_instance_no
IN
NUMBER := NULL
,x_poc_trans_id
OUT NOCOPY
NUMBER
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
/*==============================================================================
==
Procedure
end_cmplt_actual_rsrc_txn
Description
This procedure is used to end a rsrc txn that was started earlier using
start_cmplt_actual_rsrc_txn API. The usage of specified txn must be 0.
Parameters
p_poc_trans_id (R)
p_trans_date (O)
p_end_date (R)
p_usage (R)
p_reason_code (R)
p_instance_id (O)
p_instance_no (O)
x_return_status
poc_trans_id to identify a rsrc txn uniquely

Transaction date
end date of txn.
S - Success
E - Error
================================================================================
*/
PROCEDURE end_cmplt_actual_rsrc_txn (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_poc_trans_id
IN
NUMBER
,p_trans_date
IN
DATE := NULL
,p_end_date
IN
DATE
,p_reason_code
IN
VARCHAR2
,p_instance_id
IN
NUMBER := NULL
,p_instance_no
IN
NUMBER := NULL
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
/*==============================================================================
==
Procedure
update_line_allocation
Description
This procedure is used to update a pending or complete line allocation for
an
Parameters
p_tran_row (R)
required
p_lot_no (O)
The transaction row to be updated.trans_id is

The lot no for the transaction
id
p_sublot_no (O)
is not passed in)

The sublot no for the transaction
id
is not passed in)
p_create_lot (O)TRUE, if the lot has to be created on fly for
prod/by-prod.
p_ignore_shortage (O)
TRUE, if any shortages have to be ignored.
p_scale_phantom (O)
has
to be scaled.
x_material_detail
x_tran_row
The updated transaction row.
x_def_tran_row
adjustments.
x_return_status

S - Success
E - Error
================================================================================
*/
PROCEDURE update_line_allocation (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_tran_row
IN
gme_inventory_txns_gtmp%ROWTYPE
,p_lot_no
IN
,p_sublot_no
IN
,p_create_lot
IN
,p_ignore_shortage
IN
,p_scale_phantom
IN
,x_material_detail
,x_tran_row
,x_def_tran_row
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
/*==============================================================================
==
Procedure
delete_line_allocation
Description
This procedure is used to delete a pending or complete line allocation for
an
Parameters
p_trans_id (R)
p_scale_phantom
(O)
The trans_id of the transaction to be deleted

has
x_material_detail
x_def_tran_row
adjustments.
x_return_status
to be scaled.
S - Success
E - Error
================================================================================
*/
PROCEDURE delete_line_allocation (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_trans_id
IN
NUMBER
,p_scale_phantom
IN
,x_material_detail
,x_def_tran_row
,x_message_count
OUT NOCOPY NUMBER
,x_message_list
OUT NOCOPY VARCHAR2
,x_return_status
/*==============================================================================
==
Procedure
insert_batchstep_resource
Description
This procedure is used to insert a resource for an activity of a step
Parameters
p_batchstep_resource (R)
p_plant_code (O)
p_batch_no (O)
p_batchstep_no(O)
p_activity (O)
p_ignore_qty_below_cap (R)
capacity
x_batchstep_resource (O)
update etc
x_return_status
rsrc to be inserted for an activity

organization code
batch number
batch step number
batch step activity
controls - allow rsrc_qty going below rsrc
newly inserted rsrc row, can be used for
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_batchstep_resource (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_resource_rec IN
GME_BATCH_STEP_RESOURCES%ROWTYPE
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER
:= NULL
,p_activity
IN
VARCHAR2 := NULL
,p_ignore_qty_below_cap IN
BOOLEAN
,x_batchstep_resource_rec
OUT
,x_message_count
OUT
NUMBER
,x_message_list
OUT
VARCHAR2
,x_return_status
OUT
VARCHAR2);
/*==============================================================================
==
Procedure
update_batchstep_resource
Description
This procedure is used to update an existing resource of an activity of a
step
Parameters
p_batchstep_resource (R)
rsrc to be updated for an activity
p_plant_code (O)
organization code
p_batch_no (O)
batch number
p_batchstep_no(O)
batch step number
p_activity (O)
batch step activity
p_ignore_qty_below_cap (R) controls - allow rsrc_qty going below rsrc
capacity
x_batchstep_resource (O)
newly updated rsrc row, can be used for update
etc
x_return_status
S - Success
E - Error
================================================================================
*/
PROCEDURE update_batchstep_resource (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_resource_rec
IN
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
,p_activity
,x_batchstep_resource_rec
,x_message_count
OUT
,x_message_list
OUT
,x_return_status
OUT
IN
IN
IN
OUT
NUMBER := NULL
VARCHAR2 := NULL
BOOLEAN
NUMBER
VARCHAR2
VARCHAR2);
/*==============================================================================
==
Procedure
delete_batchstep_resource
Description
This procedure is used to delete an existing resource of an activity of a
step
Parameters
p_batchstep_resource_id (R) uniquely identifies a rsrc
p_plant_code (O)
organization code
p_batch_no (O)
batch number
p_batchstep_no(O)
batch step number
p_activity (O)
batch step activity
p_reosurce (O)
batch step activity resource
x_return_status
S - Success
E - Error
================================================================================
*/
PROCEDURE delete_batchstep_resource (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_resource_id IN
NUMBER
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER := NULL
,p_activity
IN
VARCHAR2 := NULL
,p_resource
IN
VARCHAR2 := NULL
,x_message_count
OUT
NUMBER
,x_message_list
OUT
VARCHAR2
,x_return_status
OUT
VARCHAR2);
/*==============================================================================
==
Procedure
insert_batchstep_activity
Description
This procedure is used to insert an activity for a step
Parameters
p_batchstep_activity (R)
activity to be inserted for a step
p_batchstep_resource_tab (R) one or more resources to be inserted for the
activity
p_plant_code (O)
organization code
p_batch_no (O)
batch number
p_batchstep_no(O)
batch step number
p_ignore_qty_below_cap (R) controls - allow rsrc_qty going below rsrc
capacity
x_batchstep_activity
newly inserted activity row, can be used for
update etc
x_return_status
S - Success
E - Error
================================================================================
*/
PROCEDURE insert_batchstep_activity (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_activity IN
GME_BATCH_STEP_ACTIVITIES%ROWTYPE
,p_batchstep_resource_tab IN
gme_api_create_step.resources_tab
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER
:= NULL
IN
BOOLEAN
,x_batchstep_activity OUT GME_BATCH_STEP_ACTIVITIES%ROWTYPE
,x_message_count
OUT
NUMBER
,x_message_list
OUT
VARCHAR2
,x_return_status
OUT
VARCHAR2 );
/*==============================================================================
==
Procedure
update_batchstep_activity
Description
This procedure is used to update an activity for a step
Parameters
p_batchstep_activity (R)
p_plant_code (O)
p_batch_no (O)
p_batchstep_no(O)
x_batchstep_activity
x_return_status
activity to be updated
organization code
batch number
batch step number
updated activity row
S - Success
E - Error
================================================================================
*/
PROCEDURE update_batchstep_activity (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_activity IN
GME_BATCH_STEP_ACTIVITIES%ROWTYPE
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER
:= NULL
,x_batchstep_activity OUT GME_BATCH_STEP_ACTIVITIES%ROWTYPE
,x_message_count
OUT
NUMBER
,x_message_list
OUT
VARCHAR2
,x_return_status
OUT
VARCHAR2 );
/*==============================================================================
==
Procedure
delete_batchstep_activity
Description
This procedure is used to delete an activity from a step. Note that
either the
activity_id must be provided or the combination of plant_code, batch_no,
batchstep_no,
and activity in order to uniquely identify an activity to be deleted.
Parameters
p_batchstep_activity_id (O) activity_id to be deleted

p_plant_code (O)
organization code
p_batch_no (O)
batch number
p_batchstep_no(O)
batch step number
p_activity(O)
activity
x_return_status
S - Success
E - Error
================================================================================
*/
PROCEDURE delete_batchstep_activity (
p_api_version
IN
,p_validation_level
IN
,p_init_msg_list
IN
BOOLEAN := FALSE
,p_commit
IN
BOOLEAN := FALSE
,p_batchstep_activity_id IN
NUMBER := NULL
,p_plant_code
IN
VARCHAR2 := NULL
,p_batch_no
IN
VARCHAR2 := NULL
,p_batchstep_no
IN
NUMBER
:= NULL
,p_activity
IN
VARCHAR2 := NULL
,x_message_count
OUT
NUMBER
,x_message_list
OUT
VARCHAR2
,x_return_status
OUT
VARCHAR2 );
END gme_api_pub;
/
COMMIT ;
EXIT;
Glossary
Application Programming Interface (API)
A documented, supported method for communicating within or between modules.
Business Object
An independent item of significance in the business world. An example of a
business object is a sales order.
Business Process API
An API that performs a transaction for the calling module, e.g., to hire an employee,
enter an order, or cost a material movement transaction.
Entity
An item of significance in the business world, that has no meaning without
reference to a business object. An example of an entity is a sales order header. A
Sales Order Header is an entity of the business object sales order.
Group API
An API intended for use by other authorized Oracle Applications.
Module
A module is a collection of one or more business objects and the associated
transactions. A module publishes APIs for other modules and accesses other
modules through their published APIs. An example of a module is Oracle
Inventory.
Public API
An API intended for use by all applications.
Glossary-1
Private API
An API intended for use by the owning module only.
Glossary-2
Index
A
AFASMSGS.pls, A-1
Allocate Batch, 1-6, 4-1
Allocate Line, 1-6, 4-3
allocate_batch, 3-2
allocate_line, 3-2
API Wrapper Code, 2-3
Application Programming Interface (API), 1
B
Batch File, 1-4
Business Object, 1
Business Objects, 4-1
Business Process API, 1
C
Cancel Batch, 1-6, 4-4
cancel_batch, 3-2
certify_batch, 3-2
certify_batch_step, 3-2
Close Batch, 1-6, 4-6
Close Steps, 1-6, 4-7
close_batch, 3-2
close_step, 3-2
Code Re-Use, 1-4
Complete Batch, 1-6, 4-8
Complete Steps, 1-7, 4-11
Consistent Behavior, 1-4
Convert FPO to Batches, 1-7, 4-14
convert_fpo, 3-2
Create Batch, 1-7, 4-16
Create Phantom, 1-7, 4-19

create_batch, 3-2
create_phantom, 3-2
D
Delete Batch, 1-7
Delete Batchstep Activity, 1-7, 4-21
Delete Batchstep Resource, 4-22
Delete Line Allocation, 4-23
Delete Line Allocations, 1-7
Delete Material Detail Line, 1-8, 4-24
Delete Step, 1-8, 4-25
delete_batchstep, 3-2
DELETE_BATCHSTEP_ACTIVITY, 1-14
delete_batchstepresource, 3-2
delete_line_allocation, 1-14, 3-2
delete_material_line, 3-2
delete_step, 3-2
E
Ease of Integration, 1-4
End Completed Resource Transaction, 1-8, 4-26
end_cmplt_actual_rsc_txn, 3-2
Entity, 1
Error Messages, A-5
F
FND_API, 1-3
FND_MESSAGE, 1-3
FND_MSG_PUB, A-1
FND_PUB_MSG, 1-3
Index-1
formula information, importing, 1-2
G
GET MESSAGES, 1-5
GMA_GME_TEXT_TBL_PKG, 1-13
GMD_AUTO_STEP_CALC, 1-13
GMD_COMMON_SCALE, 1-13
GMD_COMMON_VAL, 1-13
GMD_FETCH_OPRN, 1-13
GMD_FETCH_VALIDITY_RULES, 1-13
GMD_RECIPE_DATA_PUB, 1-13
GMD_RECIPE_FETCH_PUB, 1-13
GMD_VAL_DATA_PUB, 1-13
GMD_VALIDITY_RULES, 1-13
GMDRTVAL_PUB, 1-13
GME_API_ALLOCATE_BATCH_PVT, 1-11
GME_API_ALLOCATE_LINE_PVT, 1-11
GME_API_CERTIFY_BATCH, 1-12
GME_API_CERTIFY_BATCH_STEP, 1-12
GME_API_CLOSE_BATCH, 1-12
GME_API_CLOSE_STEP, 1-12
GME_API_CONVERT_FPO, 1-12
GME_API_CREATE_BATCH, 1-12
GME_API_CREATE_STEP, 1-12
GME_API_DELETE_BATCH_STEP, 1-12
GME_API_GRP, 1-11
GME_API_INSERT_STEP, 1-12
GME_API_MATERIAL_DETAILS, 1-11
GME_API_PARTIAL_CERT, 1-12
GME_API_PHANTOM, 1-12
GME_API_PUB, 1-11
gme_api_pub, 3-2
GME_API_RELEASE_BATCH, 1-12
GME_API_RELEASE_BATCH_STEP, 1-13
GME_API_REROUTE_BATCH, 1-13
GME_API_RESCHEDULE_BATCH, 1-13
GME_API_RESCHEDULE_BATCH_STEP, 1-13
GME_API_SCALE_BATCH, 1-13
GME_API_TEST, 1-13
GME_API_UNCERTIFY_BATCH, 1-13
GME_API_UNCERTIFY_BATCH_STEP, 1-13
GME_API_UNRELEASE_BATCH, 1-13
GME_API_UNRELEASE_STEP, 1-13
GME_API_UPDATE_STEP_QTY, 1-13
Index-2
GME_BATCH_HEADER_DBL, 1-12
GME_BATCH_HISTORY_DBL, 1-12
GME_BATCH_SALES_ORDERS_DBL, 1-12
GME_BATCH_STEP_ACTIVITIES_DBL, 1-12
GME_BATCH_STEP_DEPEND_DBL, 1-12
GME_BATCH_STEP_ITEMS_DBL, 1-12
GME_BATCH_STEP_RESOURCES_DBL, 1-12
GME_BATCH_STEP_TRANSFERS_DBL, 1-12
GME_BATCH_STEPS_DBL, 1-12
GME_CANCEL_BATCH_PVT, 1-12
GME_CANCEL_STEP_PVT, 1-12
GME_DEBUG, 1-11
GME_DELETE_BATCHSTEP, 1-14
GME_INSERT_BATCHSTEP, 1-14
GME_INV_TXNS_GTMP_DBL, 1-12
GME_LAB_BATCH_LOTS_DBL, 1-12
GME_MATERIAL_DETAILS_DBL, 1-12
GME_REOPEN_BATCH_PVT, 1-13
GME_REOPEN_STEP_PVT, 1-13
GME_RESOURCE_ENGINE_PVT, 1-13
GME_RESOURCE_TXNS_DBL, 1-12
GME_RESOURCE_TXNS_GTMP_DBL, 1-12
GME_TEXT_DBL, 1-13
GME_TRANS_ENGINE_GRP, 1-11
GME_TRANS_ENGINE_PVT, 1-13
GME_TRANS_ENGINE_UTIL, 1-11
GME_UPDATE_BATCHSTEP, 1-14
GMEPAPIS.pls, B-1
GMFPCSTB.pls, 3-2
GMFPCSTS.pls, 3-2
Group API, 1
I
importing formula information, 1-2
Incremental Backflushing, 1-8, 4-27
Insert Batchstep Activity, 1-8, 4-30
Insert Batchstep Resource, 1-8, 4-31
Insert Incremental Completed Transaction, 1-8,
4-34
Insert Line Allocation, 1-8, 4-36
Insert Material Detail Line, 1-9, 4-39
Insert Step, 1-9, 4-41
Insert Timed Resource Transaction, 1-9, 4-43
insert_allocation, 3-3
insert_batchstep, 3-2
INSERT_BATCHSTEP_ACTIVITY,
insert_batchstepresource, 3-2
insert_incr_actual_rsrc_txn, 3-2
insert_material_line, 3-3
insert_step, 3-3
insert_timed_actual_rsrc_txn, 3-3
Insulation from Changes, 1-4
Item Cost
Structure, 3-2
N
NLS_LANGUAGE, A-5
O
Online User Interface (UI),
Oracle Messages, 1-5
reroute_batch, 3-3
Reschedule Batch, 1-9, 4-52
Reschedule Step, 1-10, 4-53
reschedule_batch, 3-3
reschedule_step, 3-3
Revert to WIP Batch, 1-10, 4-54
Revert to WIP Steps, 1-10, 4-55
Robust Validation, 1-4
S
Scale Batch, 1-10, 4-56
scale_batch, 3-3
Standard Input Parameters, 2-2
Start Completed Resource Transaction, 1-10, 4-58
start_cmplt_actual_rsrc_txn, 3-3
Stored procedures, 1-2
support policy, 1-3
M
Module,
1-14
T
1-5
Technical Overview, 3-1

Theoretical Yield Batch, 1-10, 4-60
theoretical_yield_batch, 3-3
P
p_api_version, 2-2, 3-4
p_commit, 2-2, 3-5
p_init_msg_list, 2-2, 3-5
p_validation_level, 2-2
partial_cert_batch, 3-2
PL/SQL, 1-2
Private API, 2
Public API, 1
R
Release Batch, 1-9, 4-44
Release Steps, 1-9, 4-47
release_batch, 3-3
release_step, 3-3
Reopen Batch, 1-9, 4-49
Reopen Steps, 1-9, 4-50
reopen_batch, 3-3
reopen_step, 3-3
Reroute Batch, 1-9, 4-51
U
uncertify_batch, 3-3
uncertify_batch_step, 3-3
Unrelease Batch, 1-10, 4-61
Unrelease Steps, 1-10, 4-62
unrelease_batch, 3-3
unrelease_step, 3-3
Update Actual Resource Usage, 1-10, 4-63
Update Batchset Resource, 1-11
Update Batchstep Activity, 1-11, 4-65
Update Batchstep Resource, 4-66
Update Line Allocations, 1-11, 4-69
Update Material Detail Line, 1-11, 4-72
update_actual_resource_usage, 3-3
update_batchstep, 3-3
UPDATE_BATCHSTEP_ACTIVITY, 1-14
update_batchstepresource, 3-3
update_line_allocation, 1-13, 3-3
update_material_line, 3-3
Index-3
X
x_message_count, 2-2
x_message_list, 2-2
x_msg_count, 3-5
x_msg_data, 3-5
x_return_status, 2-2, 3-5
Index-4

115gmepeapiug PDF

Uploaded by

Copyright:

Available Formats

115gmepeapiug PDF

Uploaded by

Document Information

Original Title

Copyright

Available Formats

Share this document

Share or Embed Document

Sharing Options

Did you find this document useful?

Is this content inappropriate?

Copyright:

Available Formats

115gmepeapiug PDF

Uploaded by

Copyright:

Available Formats

Oracle Process Manufacturing

Process Execution API Users Guide

Input Data Sources .......................................................................................................................

Process Execution API Usage

Insert Batchstep Activity .................................................................................................................

Messages and Errors

Send Us Your Comments

Did you find any errors?

FAX: 650-506-7200 Attn: Oracle Process Manufacturing

Electronic mail message to [email protected]

The principles and customary practices of your business area.

Oracle Process Manufacturing Process Execution APIs

The Oracle Applications graphical user interface.

How To Use This Guide

Chapter 2 describes how to use the Process Execution APIs.

Chapter 3 describes the technical aspect of the APIs.

Chapter 4 describes the business objects for each API.

Appendix A describes messages and error codes.

Appendix B lists the full GMEPAPIS.pls file.

A Glossary provides definitions of terms that are used in this guide.

Accessibility of Code Examples in Documentation

Other Information Sources

Related Users Guides

Guides Related to All Products

User Guides Related to This Product

Cost Management Users Guide

Manufacturing Accounting Controller Users Guide

Oracle Financials Integration Users Guide

Inventory Management Users Guide

Physical Inventory Users Guide

Order Fulfillment Users Guide

Purchase Management Users Guide

Using Oracle Order Management with Process Inventory Guide

Process Execution Users Guide

Using Oracle Advanced Planning and Scheduling with Oracle Process

MPS/MRP and Forecasting Users Guide

Capacity Planning Users Guide

Using Oracle Process Manufacturing with Oracle Manufacturing Scheduling

Product Development Users Guide

Quality Management Users Guide

System Administration Users Guide

API Users Guides

Installation and System Administration

Installing Oracle Applications

Upgrading Oracle Applications

Maintaining Oracle Applications

Oracle Applications System Administrators Guide

Oracle Alert Users Guide

Oracle Applications Developers Guide

Oracle Applications User Interface Standards for Forms-Based Products

Other Implementation Documentation

Multiple Reporting Currencies in Oracle Applications

Multiple Organizations in Oracle Applications

Oracle Workflow Guide

Oracle Applications Flexfields Guide

Oracle eTechnical Reference Manuals

Oracle Manufacturing APIs and Open Interfaces Manual

Oracle Order Management Suite APIs and Open Interfaces Manual

Oracle Applications Message Reference Manual