Oracle Process Maufacturig Process Executio API User s Guide Release 11i Part No. A97388-03 July 2003
Oracle Process Maufacturig Process Executio API User s Guide, Release 11i Part No. A97388-03 Copyright 2003 Oracle Corporatio. All rights reserved. Primary Author: Michele-Adrea Fields Cotributors: Bill Stears, Thomas Daiel, Shrikat Nee The Programs (which iclude both the software ad documetatio) cotai proprietary iformatio of Oracle Corporatio; they are provided uder a licese agreemet cotaiig restrictios o use ad disclosure ad are also protected by copyright, patet ad other itellectual ad idustrial property laws. Reverse egieerig, disassembly or decompilatio of the Programs, except to the extet required to obtai iteroperability with other idepedetly created software or as specified by law, is prohibited. The iformatio cotaied i this documet is subject to chage without otice. If you fid ay problems i the documetatio, please report them to us i writig. Oracle Corporatio does ot warrat that this documet is error-free. Except as may be expressly permitted i your licese agreemet for these Programs, o part of these Programs may be reproduced or trasmitted i ay form or by ay meas, electroic or mechaical, for ay purpose, without the express writte permissio of Oracle Corporatio. If the Programs are delivered to the U.S. Govermet or ayoe licesig or usig the programs o behalf of the U.S. Govermet, the followig otice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplemet are "commercial computer software" ad use, duplicatio, ad disclosure of the Programs, icludig documetatio, shall be subject to the licesig restrictios set forth i the applicable Oracle licese agreemet. Otherwise, Programs delivered subject to the Federal Acquisitio Regulatios are "restricted computer software" ad use, duplicatio, ad disclosure of the Programs shall be subject to the restrictios i FAR 52.227-19, Commercial Computer Software - Restricted Rights (Jue, 1987). Oracle Corporatio, 500 Oracle Parkway, Redwood City, CA 94065. The Programs are ot iteded for use i ay uclear, aviatio, mass trasit, medical, or other iheretly dagerous applicatios. It shall be the licesee's resposibility to take all appropriate fail-safe, backup, redudacy, ad other measures to esure the safe use of such applicatios if the Programs are used for such purposes, ad Oracle Corporatio disclaims liability for ay damages caused by such use of the Programs. Oracle is a registered trademark, ad OracleMetaLik, Oracle Store, Oracle8, Oracle8i, ad SQL*Plus are trademarks or registered trademarks of Oracle Corporatio. Other ames may be trademarks of their respective owers.
Cotets Sed Us Your Commets... vii Preface... ix Audiece for This Guide... ix How To Use This Guide... ix Documetatio Accessibility... xi Other Iformatio Sources... xi Olie Documetatio... xi Related User s Guides... xii Guides Related to All Products... xii User Guides Related to This Product... xii Istallatio ad System Admiistratio... xvii Other Implemetatio Documetatio... xix Traiig ad Support... xxi Do Not Use Database Tools to Modify Oracle Applicatios Data... xxi About Oracle... xxii Your Feedback... xxiii 1 API Itroductio Itroducig the Process Executio APIs... 1-2 Process Executio API Support Policy... 1-3 Techical Requiremets... 1-3 Techical Overview... 1-3 Basic Busiess Needs... 1-3 iii
Iput Data Sources... 1-4 Wrapper Fuctio... 1-5 Stored Procedure... 1-5 Major Features... 1-6 Process Executio API Bill of Materials... 1-11 2 Process Executio API Usage Callig the API Iterface Code... 2-2 API Call Hits... 2-2 API Wrapper Code - Example... 2-3 3 Techical Overview Structure for Process Executio Public APIs... 3-2 Stadard Parameters... 3-4 Value-ID Coversio... 3-5 4 Busiess Objects Allocate Batch... 4-1 Allocate Lie... 4-3 Cacel Batch... 4-4 Close Batch... 4-6 Close Steps... 4-7 Complete Batch... 4-8 Complete Steps... 4-11 Covert FPO to Batches... 4-14 Create Batch... 4-16 Create Phatom... 4-19 Delete Batchstep Activity... 4-21 Delete Batchstep Resource... 4-22 Delete Lie Allocatio... 4-23 Delete Material Detail Lie... 4-24 Delete Step... 4-25 Ed Completed Resource Trasactio... 4-26 Icremetal Backflushig... 4-27 iv
Isert Batchstep Activity... 4-30 Isert Batchstep Resource... 4-31 Isert Icremetal Completed Trasactio... 4-34 Isert Lie Allocatio... 4-36 Isert Material Detail Lie... 4-39 Isert Step... 4-41 Isert Timed Resource Trasactio... 4-43 Release Batch... 4-44 Release Steps... 4-47 Reope Batch... 4-49 Reope Steps... 4-50 Reroute Batch... 4-51 Reschedule Batch... 4-52 Reschedule Step... 4-53 Revert to WIP Batch... 4-54 Revert to WIP Steps... 4-55 Scale Batch... 4-56 Start Completed Resource Trasactio... 4-58 Theoretical Yield Batch... 4-60 Urelease Batch... 4-61 Urelease Steps... 4-62 Update Actual Resource Usage... 4-63 Update Batchstep Activity... 4-65 Update Batchstep Resource... 4-66 Update Lie Allocatios... 4-69 Update Material Detail Lie... 4-72 A Messages ad Errors Hadlig Messages... A-1 Iterpretig Error Coditios... A-5 Uderstadig Error Messages... A-5 B Listig of GMEPAPIS.pls Idex v
vi
Sed Us Your Commets Oracle Process Maufacturig Process Executio API User s Guide, Release 11i Part No. A97388-03 Oracle Corporatio welcomes your commets ad suggestios o the quality ad usefuless of this documet. Your iput is a importat part of the iformatio used for revisio. Did you fid ay errors? Is the iformatio clearly preseted? Do you eed more iformatio? If so, where? Are the examples correct? Do you eed more examples? What features did you like most? If you fid ay errors or have ay other suggestios for improvemet, please idicate the documet title ad part umber, ad the chapter, sectio, ad page umber (if available). You ca sed commets to us i the followig ways: FAX: 650-506-7200 Att: Oracle Process Maufacturig Postal service: Oracle Corporatio Oracle Process Maufacturig 500 Oracle Parkway Redwood City, CA 94065 U.S.A. Electroic mail message to appsdoc_us@oracle.com If you would like a reply, please give your ame, address, telephoe umber, ad (optioally) electroic mail address. If you have problems with the software, please cotact your local Oracle Support Services. vii
viii
Preface Audiece for This Guide How To Use This Guide Welcome to Release 11i of the Oracle Process Maufacturig Process Executio API User s Guide. This guide assumes you have a workig kowledge of the followig: The priciples ad customary practices of your busiess area. Oracle Process Maufacturig Process Executio APIs The Oracle Applicatios graphical user iterface. To lear more about the Oracle Applicatios graphical user iterface, read the Oracle Applicatios User s Guide. See Other Iformatio Sources for more iformatio about Oracle Applicatios product iformatio. This guide cotais the iformatio you eed to uderstad ad use Oracle Process Maufacturig Process Executio APIs. Chapter 1 describes how APIs are used, the basic busiess eed of APIs, ad the differet Process Executio APIs offered. Chapter 2 describes how to use the Process Executio APIs. Chapter 3 describes the techical aspect of the APIs. Chapter 4 describes the busiess objects for each API. Appedix A describes messages ad error codes. ix
Appedix B lists the full GMEPAPIS.pls file. A Glossary provides defiitios of terms that are used i this guide. x
Documetatio Accessibility Our goal is to make Oracle products, services, ad supportig documetatio accessible, with good usability, to the disabled commuity. To that ed, our documetatio icludes features that make iformatio available to users of assistive techology. This documetatio is available i HTML format, ad cotais markup to facilitate access by the disabled commuity. Stadards will cotiue to evolve over time, ad Oracle Corporatio is actively egaged with other market-leadig techology vedors to address techical obstacles so that our documetatio ca be accessible to all of our customers. For additioal iformatio, visit the Oracle Accessibility Program Web site at http://www.oracle.com/accessibility/. Accessibility of Code Examples i Documetatio JAWS, a Widows scree reader, may ot always correctly read the code examples i this documet. The covetios for writig code require that closig braces should appear o a otherwise empty lie; however, JAWS may ot always read a lie of text that cosists solely of a bracket or brace. Other Iformatio Sources Olie Documetatio You ca choose from may sources of iformatio, icludig olie documetatio, traiig, ad support services, to icrease your kowledge ad uderstadig of Oracle Process Maufacturig System Admiistratio. If this guide refers you to other Oracle Applicatios documetatio, use oly the Release 11i versios of those guides. All Oracle Applicatios documetatio is available olie (HTML or PDF). Olie Help - The ew features sectio i the HTML help describes ew features i 11i. This iformatio is updated for each ew release of Oracle Process Maufacturig System Admiistratio. The ew features sectio also icludes iformatio about ay features that were ot yet available whe this guide was prited. For example, if your admiistrator has istalled software from a mii-packs a upgrade, this documet describes the ew features. Olie help patches are available o OracleMetaLik. xi
Related User s Guides 11i Features Matrix - This documet lists ew features available by patch ad idetifies ay associated ew documetatio. The ew features matrix documet is available o OracleMetaLik. Readme File - Refer to the readme file for patches that you have istalled to lear about ew documetatio or documetatio patches that you ca dowload. Oracle Process Maufacturig Process Executio APIs share busiess ad setup iformatio with other Oracle Applicatios products. Therefore, you may wat to refer to other user s guides whe you set up ad use Oracle Process Maufacturig Process Executio APIs. You ca read the guides olie by choosig Library from the expadable meu o your HTML help widow, by readig from the Oracle Applicatios Documet Library CD icluded i your media pack, or by usig a Web browser with a URL that your system admiistrator provides. If you require prited guides, you ca purchase them from the Oracle Store at http://oraclestore.oracle.com. Guides Related to All Products Oracle Applicatios User s Guide This guide explais how to eter data, query, ru reports, ad avigate usig the graphical user iterface (GUI) available with this release of Oracle Process Maufacturig System Admiistratio (ad ay other Oracle Applicatios products). This guide also icludes iformatio o settig user profiles, as well as ruig ad reviewig reports ad cocurret processes. You ca access this user s guide olie by choosig Gettig Started with Oracle Applicatios from ay Oracle Applicatios help file. User Guides Related to This Product Accoutig Setup User s Guide The OPM Accoutig Setup applicatio is where users set up global accoutig attributes about the way fiacial data will be collected by OPM. These attributes iclude such thigs as accout keys, fiacial caledars, ad accout segmets. xii
Sice OPM is closely itegrated with Oracle Geeral Ledger (GL), much of the attributes are defied i the Oracle GL istead of OPM, ad therefore, the widows are display oly withi OPM. The Oracle Process Maufacturig Accoutig Setup User s Guide describes how to setup ad use this applicatio. Cost Maagemet User s Guide The OPM Cost Maagemet applicatio is used by cost accoutats to capture ad review the maufacturig costs icurred i their process maufacturig busiesses. The Oracle Process Maufacturig Cost Maagemet User s Guide describes how to setup ad use this applicatio. Maufacturig Accoutig Cotroller User s Guide The Maufacturig Accoutig Cotroller applicatio is where users defie the impact of maufacturig evets o fiacials. For example, evet RCPT (Ivetory Receipts) results i a debit to ivetory, a credit to accrued accouts payable, a debit or a credit to purchase price variace, etc. These impacts are predefied i the Maufacturig Accoutig Cotroller applicatio so users may begi usig OPM to collect fiacial data out-of-the-box, however, they may also be adjusted per your busiess eeds. The Oracle Process Maufacturig Maufacturig Accoutig Cotroller User s Guide describes how to setup ad use this applicatio. Oracle Fiacials Itegratio User s Guide Sice OPM is closely itegrated with Oracle Geeral Ledger, fiacial data that is collected about the maufacturig processes must be trasferred to the Oracle Fiacials applicatios. The OPM Oracle Fiacials Itegratio applicatio is where users defie how that data is trasferred. For example, users defie whether data is trasferred real time or batched ad trasferred at itervals. The Oracle Process Maufacturig Oracle Fiacials Itegratio User s Guide describes how to setup ad use this applicatio. Ivetory Maagemet User s Guide The OPM Ivetory Maagemet applicatio is where data about the items purchased for, cosumed durig, ad created as a result of the maufacturig process are tracked. The Oracle Process Maufacturig Ivetory Maagemet User s Guide icludes iformatio to help you effectively work with the Oracle Process Maufacturig Ivetory applicatio. xiii
Physical Ivetory User s Guide Performig physical ivetory cout is the most accurate way to get a accoutig of all material quatities purchased, maufactured, ad sold, ad update your ohad quatities accordigly. The OPM Physical Ivetory applicatio automates ad eables the physical ivetory process. The Oracle Process Maufacturig Physical Ivetory User s Guide describes how to setup ad use this applicatio. Order Fulfillmet User s Guide The OPM Order Fulfillmet applicatio automates sales order etry to reduce order cycle time. Order Fulfillmet eables order etry persoel to iform customers of scheduled delivery dates ad pricig. The Oracle Process Maufacturig Order Fulfillmet User s Guide describes how to setup ad use this applicatio. Purchase Maagemet User s Guide OPM Purchase Maagemet ad Oracle Purchasig combie to provide a itegrated solutio for Process Maufacturig. Purchase orders are etered i Oracle Purchasig ad received i OPM. The, the receipts etered i OPM are set to Oracle Purchasig. The Oracle Process Maufacturig Purchase Maagemet User s Guide describes how to setup ad use this itegrated solutio. Usig Oracle Order Maagemet with Process Ivetory Guide Oracle Process Maufacturig ad Oracle Order Maagemet combie to provide a itegrated solutio for process maufacturers. The maufacturig process is tracked ad hadled withi Oracle Process Maufacturig, while sales orders are take ad tracked i Oracle Order Maagemet. Process attributes, such as dual UOM ad lot cotrol, are eabled depedig o the ivetory orgaizatio for the item o the sales order. Order Maagemet accepts orders etered through Oracle Customer Relatioship Maagemet (CRM). Withi CRM, orders ca origiate from TeleSales, Sales Olie, ad istore, ad are booked i Order Maagemet, makig the CRM suite of products available to Process customers, through Order Maagemet. The Oracle Order Maagemet User s Guide ad Usig Oracle Order Maagemet with Process Ivetory Guide describes how to setup ad use this itegrated solutio. Process Executio User s Guide The OPM Process Executio applicatio lets you track firm plaed orders ad productio batches from icomig materials through fiished goods. Seamlessly itegrated to the Product Developmet applicatio, Process Executio lets you covert firm plaed orders to sigle or multiple productio batches, allocate xiv
igrediets, record actual igrediet usage, ad the complete ad close productio batches. Productio iquiries ad preformatted reports help you optimize ivetory costs while maitaiig a high level of customer satisfactio with o-time delivery of high quality products. The OPM Process Executio User s Guide presets overviews of the tasks ad resposibilities for the Productio Supervisor ad the Productio Operator. It provides prerequisite setup i other applicatios, ad details the widows, features, ad fuctioality of the OPM Process Executio applicatio. Usig Oracle Advaced Plaig ad Schedulig with Oracle Process Maufacturig Oracle Process Maufacturig ad Oracle Advaced Plaig ad Schedulig (APS) combie to provide a solutio for process maufacturers that ca help icrease plaig efficiecy. This solutio provides for costrait-based plaig, performace maagemet, materials maagemet by exceptio, mixed mode maufacturig that eables you to choose the best method to produce each of your products, ad combie all of these methods withi the same plat/compay. The Usig Oracle Advaced Plaig ad Schedulig with Oracle Process Maufacturig User s Guide describes how to setup ad use this applicatio. MPS/MRP ad Forecastig User s Guide The Oracle Process Maufacturig Material Requiremets Plaig (MRP) applicatio provides log-term "views" of material demads ad projected supply actios to satisfy those demads. The Master Productio Schedulig (MPS) applicatio lets you shorte that view to a much arrower ad immediate time horizo, ad see the immediate effects of demad ad supply actios. The Oracle Process Maufacturig MPS/MRP ad Forecastig User s Guide describes how to setup ad use this applicatio. Capacity Plaig User s Guide The OPM Capacity Plaig User's Guide describes the setup required to use OPM with the Oracle Applicatios Advaced Supply Chai Plaig solutios. I additio, Resource setup, used by the OPM Productio Executio ad New Product Developmet applicatios, is also described. Usig Oracle Process Maufacturig with Oracle Maufacturig Schedulig Oracle Process Maufacturig itegrates with Oracle Maufacturig Schedulig to maage ad utilize resources ad materials. Through the Process Maufacturig applicatio, you set up maufacturig, ivetory, procuremet ad sales order xv
data. Through the Maufacturig Schedulig applicatio, you ca optimize the schedule based o resource ad compoet costraits ad user predefied priorities. Usig differet optimizatio objectives, you ca tailor Maufacturig Schedulig to meet your eeds. Usig Oracle Maufacturig Schedulig helps you improve productivity ad efficiecy o your shop floor. By optimally schedulig shop floor jobs, ad beig able to quickly react to uplaed costraits, you ca lower maufacturig costs, icrease resource utilizatio ad efficiecy, ad icrease customer satisfactio through improved o-time delivery. The Usig Oracle Process Maufacturig with Oracle Maufacturig Schedulig User s Guide describes how to setup ad use this itegrated solutio. Product Developmet User s Guide The Oracle Process Maufacturig Product Developmet applicatio provides features to maage formula ad laboratory work withi the process maufacturig operatio. It lets you maage multiple laboratory orgaizatios ad support varyig product lies throughout the orgaizatio. You ca characterize ad simulate the techical properties of igrediets ad their effects o formulas. You ca optimize formulatios before begiig expesive laboratory test batches. Product Developmet coordiates each developmet fuctio ad eables a rapid, eterprise-wide implemetatio of ew products i your plats. The Oracle Process Maufacturig Product Developmet User s Guide describes how to setup ad use this applicatio. Quality Maagemet User s Guide The Oracle Process Maufacturig Quality Maagemet applicatio provides features to test material sampled from ivetory, productio, or receipts from exteral suppliers. The applicatio lets you eter specificatios ad cotrol their use throughout the eterprise. Customized workflows ad electroic record keepig automate plas for samplig, testig, ad result processig. You ca compare specificatios to assist i regradig items, ad match customer specificatios. Aggregate test results ad prit statistical assessmets o quality certificates. Several preformatted reports ad iquiries help maage quality testig ad reportig. The Oracle Process Maufacturig Quality Maagemet User s Guide describes how to set up ad use this applicatio. Implemetatio Guide The Oracle Process Maufacturig Implemetatio Guide offers iformatio o setup. That is, those tasks you must complete followig the iitial istallatio of the Oracle xvi
Process Maufacturig software. Ay tasks that must be completed i order to use the system out-of-the-box are icluded i this maual. System Admiistratio User s Guide Much of the System Admiistratio duties are performed at the Oracle Applicatios level, ad are therefore described i the Oracle Applicatios System Admiistrator's Guide. The Oracle Process Maufacturig System Admiistratio User s Guide provides iformatio o the few tasks that are specific to OPM. It offers iformatio o performig OPM file purge ad archive, ad maitaiig such thigs as resposibilities, uits of measure, ad orgaizatios. API User s Guides Public Applicatio Programmig Iterfaces (APIs) are available for use with differet areas of the Oracle Process Maufacturig applicatio. APIs make it possible to pass iformatio ito ad out of the applicatio, bypassig the user iterface. Use of these APIs is documeted i idividual mauals such as the Oracle Process Maufacturig Ivetory API User s Guide, Oracle Process Maufacturig Process Executio API User s Guide, Oracle Process Maufacturig Product Developmet Formula API User's Guide, Oracle Process Maufacturig Product Developmet Recipe API User's Guide, Oracle Process Maufacturig Quality Maagemet API User's Guide, ad the Oracle Process Maufacturig Cost Maagemet API User's Guide. Additioal API User s Guides are periodically added as additioal public APIs are made available. Istallatio ad System Admiistratio Oracle Applicatios Cocepts This guide provides a itroductio to the cocepts, features, techology stack, architecture, ad termiology for Oracle Applicatios Release 11i. It provides a useful first book to read before a istallatio of Oracle Applicatios. This guide also itroduces the cocepts behid Applicatios-wide features such as Busiess Itelligece (BIS), laguages ad character sets, ad Self-Service Web Applicatios. Istallig Oracle Applicatios This guide provides istructios for maagig the istallatio of Oracle Applicatios products. I Release 11i, much of the istallatio process is hadled usig Oracle Rapid Istall, which miimizes the time to istall Oracle Applicatios, the Oracle8 techology stack, ad the Oracle8i Server techology stack by xvii
automatig may of the required steps. This guide cotais istructios for usig Oracle Rapid Istall ad lists the tasks you eed to perform to fiish your istallatio. You should use this guide i cojuctio with idividual product user s guides ad implemetatio guides. Upgradig Oracle Applicatios Refer to this guide if you are upgradig your Oracle Applicatios Release 10.7 or Release 11.0 products to Release 11i. This guide describes the upgrade process ad lists database ad product-specific upgrade tasks. You must be either at Release 10.7 (NCA, SmartCliet, or character mode) or Release 11.0, to upgrade to Release 11i. You caot upgrade to Release 11i directly from releases prior to 10.7. Maitaiig Oracle Applicatios Use this guide to help you ru the various AD utilities, such as AutoUpgrade, AutoPatch, AD Admiistratio, AD Cotroller, AD Relik, Licese Maager, ad others. It cotais how-to steps, screeshots, ad other iformatio that you eed to ru the AD utilities. This guide also provides iformatio o maitaiig the Oracle applicatios file system ad database. Oracle Applicatios System Admiistrator s Guide This guide provides plaig ad referece iformatio for the Oracle Applicatios System Admiistrator. It cotais iformatio o how to defie security, customize meus ad olie help, ad maage cocurret processig. Oracle Alert User s Guide This guide explais how to defie periodic ad evet alerts to moitor the status of your Oracle Applicatios data. Oracle Applicatios Developer s Guide This guide cotais the codig stadards followed by the Oracle Applicatios developmet staff. It describes the Oracle Applicatio Object Library compoets eeded to implemet the Oracle Applicatios user iterface described i the Oracle Applicatios User Iterface Stadards for Forms-Based Products. It also provides iformatio to help you build your custom Oracle Forms Developer 6i forms so that they itegrate with Oracle Applicatios. xviii
Oracle Applicatios User Iterface Stadards for Forms-Based Products This guide cotais the user iterface (UI) stadards followed by the Oracle Applicatios developmet staff. It describes the UI for the Oracle Applicatios products ad how to apply this UI to the desig of a applicatio built by usig Oracle Forms. Other Implemetatio Documetatio Oracle Applicatios Product Update Notes Use this guide as a referece for upgradig a istallatio of Oracle Applicatios. It provides a history of the chages to idividual Oracle Applicatios products betwee Release 11.0 ad Release 11i. It icludes ew features, ehacemets, ad chages made to database objects, profile optios, ad seed data for this iterval. Multiple Reportig Currecies i Oracle Applicatios If you use the Multiple Reportig Currecies feature to record trasactios i more tha oe currecy, use this maual before implemetig Oracle Process Maufacturig System Admiistratio. This maual details additioal steps ad setup cosideratios for implemetig Oracle Process Maufacturig System Admiistratio with this feature. Multiple Orgaizatios i Oracle Applicatios This guide describes how to set up ad use Oracle Process Maufacturig System Admiistratio with Oracle Applicatios' Multiple Orgaizatio support feature, so you ca defie ad support differet orgaizatio structures whe ruig a sigle istallatio of Oracle Process Maufacturig System Admiistratio. Oracle Workflow Guide This guide explais how to defie ew workflow busiess processes as well as customize existig Oracle Applicatios-embedded workflow processes.you also use this guide to complete the setup steps ecessary for ay Oracle Applicatios product that icludes workflow-eabled processes. Oracle Applicatios Flexfields Guide This guide provides flexfields plaig, setup ad referece iformatio for the Oracle Process Maufacturig System Admiistratio implemetatio team, as well as for users resposible for the ogoig maiteace of Oracle Applicatios xix
Traiig ad Support product data. This maual also provides iformatio o creatig custom reports o flexfields data. Oracle etechical Referece Mauals Each etechical Referece Maual (etrm) cotais database diagrams ad a detailed descriptio of database tables, forms, reports, ad programs for a specific Oracle Applicatios product. This iformatio helps you covert data from your existig applicatios, itegrate Oracle Applicatios data with o-oracle applicatios, ad write custom reports for Oracle Applicatios products. Oracle etrm is available o OracleMetaLik. Oracle Maufacturig APIs ad Ope Iterfaces Maual This maual cotais up-to-date iformatio about itegratig with other Oracle Maufacturig applicatios ad with your other systems. This documetatio icludes API s ad ope iterfaces foud i Oracle Maufacturig. Oracle Order Maagemet Suite APIs ad Ope Iterfaces Maual This maual cotais up-to-date iformatio about itegratig with other Oracle Maufacturig applicatios ad with your other systems. This documetatio icludes API s ad ope iterfaces foud i Oracle Order Maagemet Suite. Oracle Applicatios Message Referece Maual This maual describes all Oracle Applicatios messages. This maual is available i HTML format o the documetatio CD-ROM for Release 11i. Traiig Oracle offers a complete set of traiig courses to help you ad your staff master Oracle Process Maufacturig Process Executio APIs ad reach full productivity quickly. These courses are orgaized ito fuctioal learig paths, so you take oly those courses appropriate to your job or area of resposibility. You have a choice of educatioal eviromets. You ca atted courses offered by Oracle Uiversity at ay oe of our may Educatio Ceters, you ca arrage for our traiers to teach at your facility, or you ca use Oracle Learig Network (OLN), Oracle Uiversity's olie educatio utility. I additio, Oracle traiig professioals ca tailor stadard courses or develop custom courses to meet your xx
eeds. For example, you may wat to use your orgaizatio structure, termiology, ad data as examples i a customized traiig sessio delivered at your ow facility. Support From o-site support to cetral support, our team of experieced professioals provides the help ad iformatio you eed to keep Oracle Process Maufacturig Process Executio APIs workig for you. This team icludes your Techical Represetative, Accout Maager, ad Oracle s large staff of cosultats ad support specialists with expertise i your busiess area, maagig a Oracle8i server, ad your hardware ad software eviromet. Do Not Use Database Tools to Modify Oracle Applicatios Data About Oracle Oracle STRONGLY RECOMMENDS that you ever use SQL*Plus, Oracle Data Browser, database triggers, or ay other tool to modify Oracle Applicatios data uless otherwise istructed. Oracle provides powerful tools you ca use to create, store, chage, retrieve, ad maitai iformatio i a Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle Applicatios data, you risk destroyig the itegrity of your data ad you lose the ability to audit chages to your data. Because Oracle Applicatios tables are iterrelated, ay chage you make usig Oracle Applicatios ca update may tables at oce. But whe you modify Oracle Applicatios data usig aythig other tha Oracle Applicatios, you may chage a row i oe table without makig correspodig chages i related tables. If your tables get out of sychroizatio with each other, you risk retrievig erroeous iformatio ad you risk upredictable results throughout Oracle Applicatios. Whe you use Oracle Applicatios to modify your data, Oracle Applicatios automatically checks that your chages are valid. Oracle Applicatios also keeps track of who chages iformatio. If you eter iformatio ito database tables usig database tools, you may store ivalid iformatio. You also lose the ability to track who has chaged your iformatio because SQL*Plus ad other database tools do ot keep a record of chages. Oracle Corporatio develops ad markets a itegrated lie of software products for database maagemet, applicatios developmet, decisio support, ad office xxi
automatio, as well as Oracle Applicatios, a itegrated suite of more tha 160 software modules for fiacial maagemet, supply chai maagemet, maufacturig, project systems, huma resources ad customer relatioship maagemet. Oracle products are available for maiframes, miicomputers, persoal computers, etwork computers ad persoal digital assistats, allowig orgaizatios to itegrate differet computers, differet operatig systems, differet etworks, ad eve differet database maagemet systems, ito a sigle, uified computig ad iformatio resource. Oracle is the world s leadig supplier of software for iformatio maagemet, ad the world s secod largest software compay. Oracle offers its database, tools, ad applicatios products, alog with related cosultig, educatio, ad support services, i over 145 coutries aroud the world. xxii
Your Feedback Thak you for usig Oracle Process Maufacturig Process Executio APIs ad this user s guide. Oracle values your commets ad feedback. At the ed of this guide is a Reader s Commet Form you ca use to explai what you like or dislike about Oracle Process Maufacturig Process Executio APIs or this user s guide. Mail your commets to the followig address or call us directly at (650) 506-7000. Oracle Applicatios Documetatio Maager Oracle Corporatio 500 Oracle Parkway Redwood Shores, CA 94065 U.S.A. Or, sed electroic mail to appsdoc_us@oracle.com. xxiii
xxiv
1 API Itroductio This documet describes the Applicatio Program Iterfaces (APIs) that support exteral iterfaces to Oracle Process Maufacturig (OPM) Process Executio applicatio. The topics discussed i this chapter are: Itroducig the Process Executio APIs Basic Busiess Needs Major Features Process Executio API Bill of Materials API Itroductio 1-1
Itroducig the Process Executio APIs Itroducig the Process Executio APIs Process Executio APIs let you import iformatio from aother system ito the OPM Process Executio tables. Whe you import this iformatio you ca iclude all pertiet iformatio usig a tool that does ot have cryptic IDs ad system specific iformatio. The iterface esures that your imported data cotai the same detail as those you eter maually o the OPM Process Executio widows. This documet describes the usage of the busiess objects that are stored as PL/SQL packages withi the OPM database schema, such as: Stored procedures used withi these packages Parameters that these procedures accept ad the values that retur to the callig program Multiligual support Error hadlig methodology What Is I This Documet This documet describes the basic busiess eeds, major features, architecture, ad compoets for the Process Executio APIs isert, update, ad delete features. The applicatio is divided ito applicatio-specific objects that let you lik OPM fuctioality ito your ow programs. The iterfaces ca make use of the stadard fuctioality ad logic implemeted i the Process Executio applicatio. Process Executio APIs are writte i PL/SQL that ca be called by your ow programs. To make use of these APIs, code your wrapper fuctio that passes the appropriate parameters to the APIs. Your program is resposible for coectig to a database before callig a API fuctio, ad discoectig from the database upo retur. You ca choose to write log files before callig ad after returig from a fuctio. If there is a problem durig executio of a call, the the APIs retur oe of the followig status codes: S for success E for error U for ukow or uexpected status N for item requirig a locatio V for ivetory shortage exists I for icomplete maual trasactios exist G for over allocatio exists 1-2 Oracle Process Maufacturig Process Executio API User s Guide
Basic Busiess Needs Process Executio API Support Policy Techical Requiremets Techical Overview Basic Busiess Needs Process Executio APIs are supported by Oracle. This meas: Oracle provides objects ad libraries eeded to use the APIs ad the documetatio for their use. Oracle esures that the APIs fuctio as desiged. Oracle does ot support customer geerated programs that use the APIs. Process Executio APIs make use of the followig stadard Oracle Applicatios packages: FND_API - the stadard Oracle Applicatios API versio checkig fuctio. This is used by the stored procedure to check for a valid API versio umber ad also cotais costat variables such as TRUE ad FALSE. FND_MESSAGE - the stadard Oracle Applicatios messagig fuctio. This is used by the stored procedure to report status ad error hadlig. FND_PUB_MSG - the stadard Oracle Applicatios message retrieval fuctio used to search the procedure messages. These packages are istalled as part of the curret release. Refer to the Oracle Applicatios Codig Stadards maual for additioal details. Process Executio APIs are desiged to operate i a OPM 11i eviromet oly. They offer the followig basic API fuctioality: Creatig, updatig, ad deletig iformatio. Proper ecapsulatio. Sychroous processig followig the busiess hierarchy. Detailed ad traslatable error messages. These APIs let you feed iformatio from shop floor equipmet or Maufacturig Executio Systems (MES) directly ito OPM Process Executio. API Itroductio 1-3
Basic Busiess Needs Iput Data Sources I additio, these APIs serve as a cetral place to isert, update, or delete batch records i OPM from ay source. Followig are some of the importat characteristics for these APIs: Code Reuse You ca maximize code reuse from all applicatio developmet tools, icludig PL/SQL, Oracle Forms, ad Oracle Reports. Ease of Itegratio You ca itegrate APIs ito other applicatios ad eablig techology, such as Oracle Workflow Server, Oracle Iteret Commerce & Oracle WebSystem, ad Oracle EDI Gateway. Isulatio from Chages You ca ecapsulate the structure of schema to prevet chagig schema structures from affectig other applicatios. Cosistet Behavior You ca hide Object logic specific to a applicatio from other applicatios, ad to esure that this logic is correctly ivoked by other applicatios ad customers. Robust Validatio You ca validate all icomig iformatio ito Oracle Applicatios. Flat File Iput data to the user wrapper fuctio comes from a flat file source. This is processed by the wrapper ad header iformatio, passed as parameters, to the stored procedure i a sychroous mode. However, alog with the stadard parameters, the header iformatio is passed as a PL/SQL table. I this mode, the callig fuctio moitors the success or failure (retur code) from the called procedure. It also provides a optio to COMMIT work doe by the procedure. Batch File Iput data to the user wrapper fuctio comes from a batch file. This is processed by the wrapper ad header iformatio passed, as parameters, to the stored 1-4 Oracle Process Maufacturig Process Executio API User s Guide
Basic Busiess Needs Wrapper Fuctio Stored Procedure procedure i a asychroous mode. I this mode, the callig fuctio does ot moitor the success or failure of each idividual record. The Oracle Message FND_ PUB_MSG fuctioality is used to audit the calls. Olie User Iterface (UI) Iput data to the user wrapper fuctio comes from a widow or aother user iterface. This is processed by the UI ad the details passed, as parameters, to the stored procedure i a sychroous mode. I this mode, the UI callig fuctio moitors the success or failure (retur code) from the called procedure. It also provides a optio to COMMIT work doe by the procedure. Widows are geerally used as wrapper fuctios. The wrapper fuctio is resposible for collatig the details required as iput parameters to the stored procedure ad forwardig these i the call ad moitorig the retur code. The stored procedure returs three possible retur code: S for success E for error U for ukow or uexpected status N for item requirig a locatio V for ivetory shortage exists I for icomplete maual trasactios exist G for over allocatio exists Based o the retur, the wrapper fuctio searches the Oracle Messages File for the stored procedure to determie a COMMIT of the trasactio or ot. The stored procedure is called with the appropriate parameters forwarded i a PL/SQL table format. The procedure validates each record from this table ad the processes the appropriate fuctioal logic as required. The procedure writes appropriate messages to the Oracle Messages table. These are iformatioal as determied by the logic. These ca be iterrogated by the callig wrapper fuctio through the GET MESSAGES fuctioality. API Itroductio 1-5
Major Features Major Features The stored procedure calls other validatio procedures i the course of its executio; a modular approach has bee adopted. Fuctios called by these procedures do ot use IN/OUT parameters as these have bee removed from the Oracle 8 codig stadards. O successful completio of the procedure, a success uit is i place that ca be optioally COMMITTED. The decisio as to whether a COMMIT is issued o successful completio is uder the cotrol of the callig code ad deliberately outside the scope of the API procedures. I order to support the requiremets metioed i the Basic Busiess Needs topic, the ew APIs support the followig fuctioality: Allocate Batch The Allocate Batch API autoallocates a batch ad all the phatom batches. Allocate Lie The Allocate Lie API autoallocates the material detail lie. Cacel Batch The Cacel Batch API is a busiess object that ullifies a batch. The batch remais i the database for audit purposes, but it has a specific status of cacelled ad ay effect it has o ivetory is reversed. Close Batch The Close Batch API is a busiess object that closes the batch. Closig a batch prevets further editig of a batch, ad makes it available for use by Actual Costig. Close Steps The Close Step API is a busiess object that closes the batch step. Closig a batch step prevets further editig. Complete Batch The Complete Batch, or certify batch, API is a busiess object that completes the batch. Completig a batch idicates that the batch has bee completed ad the 1-6 Oracle Process Maufacturig Process Executio API User s Guide
Major Features products ad byproducts have bee yielded. Completig a batch lets adjustmets to igrediet, product, ad byproduct quatities. Complete Steps The Complete Step, or certify batch step, API is a busiess object that completes a sigle batch step or multiple batch steps based o certai criteria. Completig a step is how output quatities are specified, or defaulted, for items yielded i the step. Resource usage for all activities is also calculated. If this is the fial step, the completig it results i a batch completio whe the GME:Step Cotrol Batch Status profile optio is set to Yes. Covert FPO to Batches The Covert FPO to Batches API is used to covert the firm plaed order to oe or more batches. Create Batch The Create Batch API is a busiess object that creates batches, lab batches, ad Firm Plaed Orders (FPOs) i OPM. Create Phatom The Create Phatom API creates phatom batches based o the validity rule passed. Delete Batchstep Activity This Delete Batchstep Activity API deletes the batchstep activity of a step i batch. A batchstep activity ca be deleted for the pedig step of a pedig batch oly. Delete Batchstep Resource A existig resource ca be deleted for a activity of a step. A resource ca be deleted for a pedig step oly. Delete Lie Allocatios The Delete Lie Allocatio API deletes the curret allocatio. If the trasactio is pedig, the it is marked for delete. If the trasactio has bee completed, the it is reversed by addig a ew allocatio for the lie with a equal, but opposite quatity. This doe with the Create Trasactio API. API Itroductio 1-7
Major Features Delete Material Detail Lie The Delete Material Detail Lie API deletes the material lie i the batch. Delete Step The Delete Step API deletes the step i the batch. Ed Completed Resource Trasactio The Ed Completed Resource Trasactio API is a busiess object that lets you create completed resource trasactios for a specified ed date. Icremetal Backflushig The Icremetal Backflushig, or partial certificatio, API is a busiess object that lets you icremetally record product yield ad have igrediet usage backflushed. Isert Icremetal Completed Trasactio The Isert Icremetal Completed Trasactio API is a busiess object that lets you create completed resource trasactios for the usage specified i additio to existig resource trasactios. Isert Batchstep Activity The Isert Batchstep Activity API adds a batchstep activity to the step of a batch. A batchstep activity ca be added to a step oly if the step status is pedig, work i process, or completed. If ASQC is o, the batchstep activity caot be added for a step status of work i process. Based o the step status ad ASQC, all the iput data is validated. Isert Batchstep Resource A resource ca be added for a activity of a step. A resource ca be added for a step i pedig, WIP, ad completed step status oly. If ASQC is o, the the resource caot be added i WIP status sice the process quatity caot be iserted. Based o the step status ad ASQC, all the iput data is validated. Isert Lie Allocatio The Isert Lie Allocatio API lets you create pedig or complete allocatios for a give detail lie i a give batch. The batch ca be i a pedig, WIP, or certified state ad the material detail lie ca have ay release type. 1-8 Oracle Process Maufacturig Process Executio API User s Guide
Major Features Isert Material Detail Lie The Isert Material Detail Lie API is used to isert the material lie ito the batch. Isert Step The Isert Step API iserts the ew step to the batch. Isert Timed Resource Trasactio The Isert Timed Resource Trasactio API is a busiess object that lets you create completed resource trasactios for the specified start ad ed dates, ad calculate the usage from i the resource usage uit of measure from this iformatio. Release Batch The Release Batch API is a busiess object that coverts pedig batches to work i process (WIP) batches i OPM. Release Steps The Release Step API is a busiess object that ca release a sigle batch step or multiple batch steps based o certai criteria. If the profile optio GME:Step Cotrol Batch Status is set to Yes, the it will also release the batch. Reope Batch The Reope Batch API chages the status of the batch from closed to completed. Reope Steps The Reope Steps API chages the status of the step from closed to completed. Reroute Batch The Reroute Batch API is a busiess object that reroutes a batch to a differet recipe with the same formula. The batch or firm plaed order is oly rerouted i pedig status. Reschedule Batch The Reschedule Batch API is a busiess object that reschedules a batch or firm plaed order to a differet date. The batch is oly rescheduled while i pedig or WIP status. The firm plaed order is oly rescheduled whe i a pedig state. API Itroductio 1-9
Major Features Reschedule Step The Reschedule Step API reschedules the step ad all subsequet steps. Scale Batch The Scale Batch API scales batches up or dow, as well as all the phatom batches. Start Completed Resource Trasactio The Start Completed Resource Trasactio API is a busiess object that lets you create completed resource trasactios for a specified start date. The ed date is populated with the start date. Theoretical Yield Batch The Theoretical Yield Batch API calculates theoretical yield for the batch, ad updates the quatities for the product lies. Revert to WIP Batch The Revert to WIP Batch, or ucertify batch, API is a busiess object that ucompletes the batch. Revertig a batch to WIP ca set completed product ad byproduct trasactios to pedig, ad put the batch status back to WIP from completed. Revert to WIP Steps The Revert to WIP Steps, or ucertify batch steps, API is a busiess object that chages a batch step from completed to WIP. Urelease Batch The Urelease Batch API removes the completed allocatios for the igrediet lies. Ureleasig a batch sets the batch status to pedig. Urelease Steps The Urelease Step API is a busiess object that ureleases a batch step based o certai criteria. Ureleasig a step sets the step to pedig status. Update Actual Resource Usage The Update Actual Resource Usage API is a busiess object that lets you create completed resource trasactios for the usage specified, ad deletes all existig trasactios. 1-10 Oracle Process Maufacturig Process Executio API User s Guide
Process Executio API Bill of Materials Update Batchstep Activity The Update Batchstep Activity API updates the batchstep activity of a step. A batchstep activity ca be updated for a step i the status pedig, work i process, ad completed. Based o the step status ad ASQC, all the iput data is validated before the batchstep activity gets updated. Depedig o the step status, differet fields of the batchstep activity ca be updated. Update Batchset Resource A existig resource ca be updated for a activity of a step. A resource ca be updated for a step i pedig, WIP, ad completed step status oly. Based o the step status ad ASQC, all the iput data is validated before the resource i updated. Based o the step status, differet fields of the resource ca be updated. Update Lie Allocatios The Update Allocatio API lets you update pedig or complete allocatios for a give detail lie i a give batch. The batch ca be i a pedig, WIP, or completed state ad the material detail lie ca have ay release type. I some cases, it disregards some values beig passed i. Update Material Detail Lie The Update Material Detail Lie API updates the material lie i the batch. Process Executio API Bill of Materials The followig are packages ad files that are delivered with the OPM Process Executio APIs. These must be o your system for your iterface to compile ad lik properly. 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 Itroductio 1-11
Process Executio API Bill of Materials 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 1-12 Oracle Process Maufacturig Process Executio API User s Guide
Process Executio API Bill of Materials 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 Itroductio 1-13