Oracle Process Manufacturing

Transcription

1 Oracle Process Maufacturig Product Developmet Recipe API User s Guide Release 11i Part No. A Jauary 2005

2 Oracle Process Maufacturig Product Developmet Recipe API User s Guide, Release 11i Part No. A Copyright 2003,2005 Oracle Corporatio. All rights reserved. Primary Author: Michele-Adrea Fields Cotributors: Shyam Sitarama, Bill Stears Thomas Daiel 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 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 , Commercial Computer Software - Restricted Rights (Jue, 1987). Oracle Corporatio, 500 Oracle Parkway, Redwood City, CA 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 of Oracle Corporatio ad/or its affiliates. Other ames may be trademarks of the irrespective owers.

3 Cotets Sed Us Your Commets... vii Preface... ix Audiece for This Guide... ix How To Use This Guide... ix Documetatio Accessibility... x Other Iformatio Sources... x Olie Documetatio... x Related User s Guides... xi Guides Related to All Products... xi User Guides Related to This Product... xi Istallatio ad System Admiistratio... xvi Other Implemetatio Documetatio... xviii Traiig ad Support... xix Do Not Use Database Tools to Modify Oracle Applicatios Data... xx About Oracle... xx Your Feedback... xxi 1 Recipe API Itroductio Itroducig the Recipe APIs Recipe API Support Policy Techical Requiremets Techical Overview Iput Data Sources iii

4 Wrapper Fuctio Stored Procedure Which API Fuctios are Icluded Recipe API Bill of Materials Recipe API Usage Creatig a New Recipe Usig the Routig APIs Usig the Operatio APIs Usig Iput Parameters for Recipe APIs Techical Overview Recipe Header Structure for Recipe Header Public APIs Recipe Detail Structure for Recipe Detail Public APIs Recipe Fetch Structure for Recipe Fetch APIs Recipe Validity Rule Fetch API Structure for Recipe Validity Rule Fetch APIs Routig API Structure for Routig APIs Routig Steps API Structure for Routig Steps APIs Routig Step Depedecy API Structure for Routig Step Depedecy APIs Operatio API Structure for Operatio APIs Operatio Activity API Structure for Operatio Activity APIs Operatio Resources API Structure for Operatio Resources APIs Activity API Structure for Activity APIs Chage Status API iv

5 Stadard Parameters Value-ID Coversio Busiess Objects Recipe Header Recipe Details Recipe Fetch Recipe Validity Rule Fetch Routig Routig Steps Routig Step Depedecy Operatio Operatio Activity Operatio Resources Activity Chage Status API A Messages ad Errors Hadlig Messages... A-2 Iterpretig Error Coditios... A-5 Uderstadig Error Messages... A-5 B How to Get Your OPM Recipe APIs Ruig Idex v

6 vi

7 Sed Us Your Commets Oracle Process Maufacturig Product Developmet Recipe API User s Guide, Release 11i Part No. A 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: Att: Oracle Process Maufacturig Postal service: Oracle Corporatio Oracle Process Maufacturig 500 Oracle Parkway Redwood City, CA 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

8 viii

9 Preface Audiece for This Guide How To Use This Guide Welcome to Release 11i of the Oracle Process Maufacturig Product Developmet Recipe 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 If you have ever used Oracle Process Maufacturig Product Developmet Recipe APIs, Oracle suggests you atted oe or more of the Oracle Process Maufacturig Product Developmet Recipe APIs traiig classes available through Oracle Uiversity. 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. Chapter 1 describes the Applicatio Program Iterfaces (APIs) that support exteral iterfaces to the OPM Recipe tables. Chapter 2 describes the details of how to use the OPM Recipe APIs. Chapter 3 describes the structure of each OPM Recipe API. Chapter 4 provides the relatioships betwee the OPM Recipe API table structure ad its etities. It discusses Recipe API busiess objects, the etity relatioship diagram, busiess object iterface desig, creatig a cost ad importig cost data structures. Appedix A provides message hadlig, the iterpretatio of error coditios, ad a uderstadig of error messages. ix

10 Appedix B provides a useful guide ad examples for usig the APIs. 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 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 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 Product Developmet Recipe APIs. 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 Product Developmet Recipe APIs. 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. x

11 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 shares 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 Product Developmet Recipe 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 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 Product Developmet Recipe APIs (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. xi

12 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. xii

13 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 xiii

14 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 xiv

15 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 xv

16 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 xvi

17 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 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. xvii

18 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. This maual details additioal steps ad setup cosideratios for implemetig Oracle Process Maufacturig with this feature. Multiple Orgaizatios i Oracle Applicatios This guide describes how to set up ad use Oracle Process Maufacturig 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. 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 implemetatio team, as well as for users resposible for the ogoig maiteace of Oracle Applicatios product data. This maual also provides iformatio o creatig custom reports o flexfields data. xviii

19 Traiig ad Support 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 Product Developmet Recipe 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 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. xix

20 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 Product Developmet Recipe 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 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. xx

21 Your Feedback 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. Thak you for usig Oracle Process Maufacturig Product Developmet Recipe 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 Product Developmet Recipe APIs or this user s guide. Mail your commets to the followig address or call us directly at (650) Oracle Applicatios Documetatio Maager Oracle Corporatio 500 Oracle Parkway Redwood Shores, CA U.S.A. Or, sed electroic mail to appsdoc_us@oracle.com. xxi

22 xxii

23 1 Recipe API Itroductio This documet describes the Applicatio Program Iterfaces (APIs) that support exteral iterfaces to Oracle Process Maufacturig Product Developmet applicatios. The topics discussed i this chapter are: Itroducig the Recipe APIs Oracle Applicatios Packages Supplied Recipe API Bill of Materials Recipe API Itroductio 1-1

24 Itroducig the Recipe APIs Itroducig the Recipe APIs Recipe APIs are busiess objects that ca create, modify, or validate the recipe iformatio. 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 Multi-Ligual support Error hadlig methodology A Recipe is a etity that cotais the miimum set of iformatio that uiquely defies the maufacturig requiremets for a specific product. Recipes provide a way to describe products ad how these products are produced. What Is I This Documet This documet describes the basic busiess eeds, major features, architecture, ad compoets for the Recipe APIs. Much of the applicatio is divided ito applicatio-specific objects that lets you lik OPM fuctioality ito your ow programs. The iterfaces ca make use of the stadard fuctioality ad logic implemeted i the Product Developmet applicatio. Recipe APIs are curretly 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 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 1-2 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

25 Itroducig the Recipe APIs Recipe API Support Policy Techical Requiremets Recipe 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. Recipe APIs are desiged to operate i a OPM 11i eviromet oly. The procedure makes 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 part of the 11i Oracle Applicatios istallatio. Refer to the Oracle Applicatios Codig Stadards guide for further details. Techical Overview Recipe APIs are iteded to be ivoked from a user wrapper callig fuctio with recipe related attributes passed to the procedure through a table or record format. The wrapper fuctio is resposible for coectig to the database as a appropriate user with the ecessary privileges. It passes the appropriate parameters ito the stored procedure ad is resposible for hadlig the retur code from the procedure. OPM applicatios use widows as a wrapper fuctio to call Recipe APIs. Recipe APIs have the followig procedures: Creatio of ew Recipe Header Creatio of ew Recipe Details, such as Recipe Customer details, Recipe Routig Step Details, Recipe Validity Rule details Recipe API Itroductio 1-3

26 Itroducig the Recipe APIs Fetch of Recipe ad Validity Rules Modificatio of Recipe Header iformatio Modificatio of Recipe Detail iformatio Recipe validatio package Creatio of ew activity Modificatio of activity Deletio of activity Creatio of ew operatio (header ad detail data) Modificatio of operatio (header ad detail data) Deletio of operatio (header ad detail data) These stored procedures are called from a user wrapper fuctio that executes the procedure ad deals with the retur status ad messages from the executio. Iput Data Sources 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 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 other 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 1-4 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

27 Itroducig the Recipe APIs moitors the success or failure (retur code) from the called procedure. It also provides a optio to COMMIT work doe by the procedure. Recipe API Itroductio 1-5

28 Itroducig the Recipe APIs Wrapper Fuctio Stored 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, 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 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 (success) or error as determied by the logic. These ca be iterrogated by the callig wrapper fuctio through the GET MESSAGES fuctioality. 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. 1-6 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

29 Itroducig the Recipe APIs Which API Fuctios are Icluded The followig are the Recipe API fuctios, the busiess object ame, ad a brief explaatio of each fuctio: Fuctio Busiess Object Name Descriptio Recipe Create GMD_RECIPE_HEADER Creates or modifies Recipe Header. Recipe Detail GMD_RECIPE_DETAIL Creates or modifies the Recipe Detail iformatio. Recipe Fetch GMD_RECIPE_FETCH_PUB Retrieves recipe details. Recipe Validity Rule Fetch GMD_FETCH_VALIDITY_ RULES Retrieves recipe validity rule details. Routig GMD_ROUTINGS_PUB Creates, modifies, or deletes routig header ad detail iformatio. Ca be used for modificatio of the routig header iformatio. Routig Steps GMD_ROUTING_STEPS_PUB Creates, modifies, or deletes the routig step iformatio. Routig Step Depedecy GMD_STEP_DEPENDENCY_ PUB Creates, modifies, or deletes the step depedecy iformatio. Operatio GMD_OPERATIONS_PUB Creates operatio header ad detail iformatio. Ca be used for modificatio ad deletio of the operatio header iformatio. Operatio Activity Operatio Resources GMD_OPERATION_ ACTIVITIES_PUB GMD_OPERATION_ RESOURCES_PUB Creates, modifies, or deletes the operatio detail iformatio. Creates, modifies, or deletes the operatio resource iformatio. Activity GMD_ACTIVITIES_PUB Creates, modifies, or deletes activity iformatio. Modify Status GMD_STATUS_PUB Modifies the status for routigs, operatios, recipes, ad validity rules. Recipe API Itroductio 1-7

30 Itroducig the Recipe APIs Recipe API Bill of Materials The followig is a list of packages ad files that are delivered with the OPM Recipe API. These must be o your system for your iterface to compile ad lik properly. Package Name File Names Descriptio GMD_RECIPE_HEADER GMD_RECIPE_DETAIL GMD_RECIPE_FETCH_PUB GMD_FETCH_VALIDITY_ RULES GMD_ROUTINGS_PUB GMD_ROUTING_STEPS_PUB GMD_STEP_DEPENDENCY_ PUB GMD_OPERATIONS_PUB GMDPRCHS.pls, GMDPRCHB.pls GMDPRCDS.pls, GMDPRCDB.pls GMDPRCFS.pls, GMDPRCFB.pls GMDPVRFS.pls, GMDPVRFB.pls GMDPROUS.pls, GMDPROUB.pls GMDPRTSS.pls, GMDPRTSB.pls GMDPRTSS.pls, GMDPRTSB.pls GMDPOPSS.pls, GMDPOPSB.pls Public Recipe API that the user defied fuctio calls. Public Recipe API that the user defied fuctio calls. Public Recipe API that Recipe Header ad Recipe Detail APIs call. Public Recipe API that Recipe Header ad Recipe Detail APIs call. Public Routig package that the user defied fuctio calls. The busiess API is used for creatig, modifyig, or deletig a routig header. Public Routig package that the user defied fuctio calls. The busiess API is used for creatig or modifyig routig steps associated to the routig header. Public Routig package that the user defied fuctio calls. The busiess API is used for creatig or modifyig routig step depedecy iformatio associated to the routig steps. Public Operatio package that the user defied fuctio calls. The busiess API is used for creatig, modifyig, or deletig a operatio header. Whe creatig a operatio header, the API also creates activities ad resources associated with this header. 1-8 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

31 Itroducig the Recipe APIs Package Name File Names Descriptio GMD_OPERATION_ ACTIVITIES_PUB GMD_OPERATION_ RESOURCES_PUB GMD_ACTIVITY_PUB GMD_STATUS_PUB GMDPOPAS.pls, GMDPOPAB.pls GMDPOPRS.pls, GMDPOPRB.pls GMDPACTS.pls, GMDPACTB.pls GMDPSTSB.pls, GMDPSTSS.pls Public Operatio Activities package that the wrapper or user defied fuctio calls. The busiess API is used for creatig, modifyig, or deletig operatio activities. Whe creatig a operatio activity, the API also creates operatio resources associated with this operatio activity. Public Operatio Resources package that the wrapper or user defied fuctio calls. The busiess API is used for creatig, modifyig, or deletig operatio resources. Public Activity package that the user defied fuctio calls. The busiess API is used for creatig, modifyig, or deletig activity iformatio. Public API that modifies the status for routigs, recipes, operatios, ad validity rules. Recipe API Itroductio 1-9

32 Itroducig the Recipe APIs 1-10 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

33 2 Recipe API Usage This topic describes how to use the Recipe APIs, icludig the steps to create a ew recipe. The topics discussed i this chapter are: Create a New Recipe Usig the Routig APIs Usig the Operatio APIs Usig Iput Parameters for Recipe APIs Creatig a New Recipe I order to use the recipe busiess object APIs effectively, follow these steps: Step 1: Collate Recipe data ito a PL/SQL table format Recipe APIs are called through differet types of sources. For example, you use a iterface like Oracle Forms, or optioally create a wrapper fuctio that calls these APIs. However, esure that relevat recipe iformatio is structured i a PL/SQL table format before passig it as a parameter to these APIs. The APIs also require certai stadard parameters such as API versio ad API ame that eed to be passed by the wrapper fuctio. After performig the appropriate tasks, the APIs retur the status code. Depedig o this status code, the callig fuctio decides to commit the work. If the retur code is a error, the the fuctio retrieves the error message text from the error stack. Creatig a PL/SQL table - Example PROCEDURE o_isert IS X_hdr_tbl gmd_recipe_header.recipe_tbl; X_hdr_flex gmd_recipe_header.recipe_flex; Recipe API Usage 2-1

34 Creatig a New Recipe X_status VARCHAR2(30); X_msg_ct NUMBER; X_msg_dat VARCHAR2(30); X_row NUMBER := 1; BEGIN FND_GLOBAL.APPS_INITIALIZE(user_id,resp_id,resp_appl_id); X_hdr_tbl(X_row).recipe_id := :gmd_recipes.recipe_id; X_hdr_tbl(X_row).recipe_descriptio := :gmd_recipes.recipe_descriptio; X_hdr_tbl(X_row).recipe_o := :gmd_recipes.recipe_o; X_hdr_tbl(X_row).recipe_versio := :gmd_recipes.recipe_versio; X_hdr_tbl(X_row).user_id := :gmd_recipes.created_by; X_hdr_tbl(X_row).calculate_step_quatity := :gmd_recipes.calculate_step_quatity; X_hdr_tbl(X_row).ower_org_code :=:gmd_recipes.ower_org_code; X_hdr_tbl(X_row).creatio_org_code :=:gmd_recipes.creatio_org_code; X_hdr_tbl(X_row).formula_id := :gmd_recipes.formula_id; X_hdr_tbl(X_row).formula_o := :gmd_recipes.formula_o; X_hdr_tbl(X_row).formula_vers := :gmd_recipes.formula_vers; X_hdr_tbl(X_row).routig_id := :gmd_recipes.routig_id; X_hdr_tbl(X_row).routig_o := :gmd_recipes.routig_o; X_hdr_tbl(X_row).routig_vers := :gmd_recipes.routig_vers; X_hdr_tbl(X_row).project_id := :gmd_recipes.project_id; X_hdr_tbl(X_row).recipe_status := :gmd_recipes.recipe_status; X_hdr_tbl(X_row).plaed_process_loss := :gmd_recipes.plaed_process_loss; X_hdr_tbl(X_row).ower_lab_type := :gmd_recipes.ower_lab_type; X_hdr_tbl(X_row).text_code := :gmd_recipes.text_code; X_hdr_tbl(X_row).delete_mark := :gmd_recipes.delete_mark; X_hdr_tbl(X_row).creatio_date := :gmd_recipes.creatio_date; X_hdr_tbl(X_row).created_by := :gmd_recipes.created_by; X_hdr_tbl(X_row).last_updated_by := :gmd_recipes.last_updated_by; X_hdr_tbl(X_row).last_update_date := :gmd_recipes.last_update_date; X_hdr_tbl(X_row).last_update_logi := :gmd_recipes.last_update_logi; X_hdr_tbl(X_row).ower_id := :gmd_recipes.ower_id; X_hdr_flex(X_row).attribute_category := :gmd_recipes.attribute_category; X_hdr_flex(X_row).attribute1 := :gmd_recipes.attribute1; X_hdr_flex(X_row).attribute2 := :gmd_recipes.attribute2; X_hdr_flex(X_row).attribute3 := :gmd_recipes.attribute3; X_hdr_flex(X_row).attribute4 := :gmd_recipes.attribute4; X_hdr_flex(X_row).attribute5 := :gmd_recipes.attribute5; X_hdr_flex(X_row).attribute6 := :gmd_recipes.attribute6; X_hdr_flex(X_row).attribute7 := :gmd_recipes.attribute7; X_hdr_flex(X_row).attribute8 := :gmd_recipes.attribute8; X_hdr_flex(X_row).attribute9 := :gmd_recipes.attribute9; X_hdr_flex(X_row).attribute10 := :gmd_recipes.attribute10; X_hdr_flex(X_row).attribute11 := :gmd_recipes.attribute11; 2-2 Oracle Process Maufacturig Product Developmet Recipe API User s Guide

35 Creatig a New Recipe X_hdr_flex(X_row).attribute12 := :gmd_recipes.attribute12; X_hdr_flex(X_row).attribute13 := :gmd_recipes.attribute13; X_hdr_flex(X_row).attribute14 := :gmd_recipes.attribute14; X_hdr_flex(X_row).attribute15 := :gmd_recipes.attribute15; X_hdr_flex(X_row).attribute16 := :gmd_recipes.attribute16; X_hdr_flex(X_row).attribute17 := :gmd_recipes.attribute17; X_hdr_flex(X_row).attribute18 := :gmd_recipes.attribute18; X_hdr_flex(X_row).attribute19 := :gmd_recipes.attribute19; X_hdr_flex(X_row).attribute20 := :gmd_recipes.attribute20; X_hdr_flex(X_row).attribute21 := :gmd_recipes.attribute21; X_hdr_flex(X_row).attribute22 := :gmd_recipes.attribute22; X_hdr_flex(X_row).attribute23 := :gmd_recipes.attribute23; X_hdr_flex(X_row).attribute24 := :gmd_recipes.attribute24; X_hdr_flex(X_row).attribute25 := :gmd_recipes.attribute25; X_hdr_flex(X_row).attribute26 := :gmd_recipes.attribute26; X_hdr_flex(X_row).attribute27 := :gmd_recipes.attribute27; X_hdr_flex(X_row).attribute28 := :gmd_recipes.attribute28; X_hdr_flex(X_row).attribute29 := :gmd_recipes.attribute29; X_hdr_flex(X_row).attribute30 := :gmd_recipes.attribute30; gmd_recipe_header.create_recipe_header(p_api_versio => 1.0, p_iit_msg_list => 'F', p_commit => 'F', p_called_from_forms => 'NO', x_retur_status => X_status, x_msg_cout => X_msg_ct, x_msg_data => X_msg_dat, p_recipe_header_tbl => X_hdr_tbl, p_recipe_header_flex => X_hdr_flex); Step 2: Call the Public API - Mai validatio performed a. The API checks for the existece of a appropriate User ID i the FND_USR table. If there is o valid user, the the API puts error messages i a error stack, ad prevets the creatio of a recipe. b. The API checks for valid recipe umber ad versio. For all updates or chages to the Recipe Header iformatio, the recipe ID, or the recipe ame ad recipe versio eed to be provided. For chages to Recipe Detail, the recipe ID must be provided. c. After the Recipe Header is created successfully, Recipe Details are created. d. No chages or updates are performed for ay recipes that have fial cost updates doe o them. Recipe API Usage 2-3

36 Usig the Routig APIs Usig the Routig APIs Step 3: Review ay error messages The API returs the status code as oe of its parameters after it is executed. The status code represets S for success, E for error, or U for Uexpected or Ukow status. If a error E occurs, the the callig fuctio or wrapper fuctio aalyzes the errors from the message stack. For more iformatio o error messages, refer to Appedix A. Step 4: Check if relevat recipe iformatio has bee created After executig these APIs successfully, ad committig the work, the recipe iformatio eeds to be tested usig a differet user iterface. For example, after the recipe header ad detail are created, commit the work, ad ru the appropriate Oracle applicatio to test whether or ot a ew recipe is actually created. A routig is a sequeced set of operatios, orgaized i steps, that must be performed to complete a productio batch. A routig must iclude at least oe routig step, or operatio. The Routig APIs are busiess objects that create or chage the routig iformatio. This iformatio is comprised of: A header providig the routig umber, versio, descriptio, status, routig class ad descriptio, valid from ad to dates, quatity, uit of measure, plaed loss percetage, ower, ad ower orgaizatio. Oe or more detail lies for each header. Each detail lie provides the routig step umber, operatio, operatio versio, operatio descriptio, step quatity, uit of measure, ad release type. Routig step depedecy iformatio ca be set up to create ad modify relatioships betwee routig steps. This iformatio icludes previous step, depedecy type, stadard delay, ad trasfer percet data. Prerequisite data: Operatios, Activities, Resources These actios are permissable o routigs: Isert Routig (header ad detail) Update Routig (header ad detail) Delete Routig (header ad detail) 2-4 Oracle Process Maufacturig Product Developmet Recipe API User s Guide