Oracle® Advanced Service Online · Chapter 2 presents the basic functions of ASO. Chapter 3 presents detailed instructions explaining how to implement ASO. Appendix A is a listing

Oracle® Advanced Service Online

Implementation Guide

Release 11i

October 2001

Part No. A95226-01

Oracle Advanced Service Online Implementation Guide, Release 11i

Part No. A95226-01

Copyright © 1996, 2001 Oracle Corporation. All rights reserved.

Primary Author: Dennis Cathey

Contributing Authors: Vo Le, Andy Bender, Reshmi Alex

The Programs (which include both the software and documentation) contain proprietary information ofOracle Corporation; they are provided under a license agreement containing restrictions on use anddisclosure and are also protected by copyright, patent, and other intellectual and industrial propertylaws. Reverse engineering, disassembly, or decompilation of the Programs is prohibited.

The information contained in this document is subject to change without notice. If you find any problemsin the documentation, please report them to us in writing. Oracle Corporation does not warrant that thisdocument is error free. Except as may be expressly permitted in your license agreement for thesePrograms, no part of these Programs may be reproduced or transmitted in any form or by any means,electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation.

If the Programs are delivered to the U.S. Government or anyone licensing or using the programs onbehalf of the U.S. Government, the following notice is applicable:

Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercialcomputer software" and use, duplication, and disclosure of the Programs, including documentation,shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement.Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computersoftware" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR52.227-19, Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500Oracle Parkway, Redwood City, CA 94065.

The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherentlydangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup,redundancy, and other measures to ensure the safe use of such applications if the Programs are used forsuch purposes, and Oracle Corporation disclaims liability for any damages caused by such use of thePrograms.

The Oracle CRM software contains applications that you may not have ordered and for which you do nothave a license. If that is the case, those applications are Restricted Use Programs. The following statementprovides information as to the use of Restricted Use Programs:

Restricted Use Programs shall include other software programs that are delivered with the Oracle CRMPrograms licensed by Customer ("CRM Programs") and which are required to install and/or enableintegration of the CRM programs. Restricted Use Programs are limited to use solely in conjunction withand in support of the CRM Programs. Customer may not use the Restricted Use Programs for generaldata processing purposes or for any purpose other than specified in the previous sentence.

Oracle is a registered trademark, and Oracle Financials, SQL*Loader, SQL* Plus, Oracle ApplicationObject Library, Oracle Applications, Oracle Applications Window Manager, Oracle General Ledger,Oracle Inventory, Oracle Manufacturing, Oracle MRP, Oracle Order Entry, Oracle Payables, OraclePurchasing, Oracle Receivables, and Oracle7 are trademarks or registered trademarks of OracleCorporation.

Contents

Send Us Your Comments ................................................................................................................... ix

Preface............................................................................................................................................................ xi

1 Overview of Oracle Advanced Service Online

1.1 What is Oracle ASO?............................................................................................................. 1-11.2 Why Use Oracle ASO?.......................................................................................................... 1-21.3 Key Features of ASO............................................................................................................. 1-31.3.1 Document Index ............................................................................................................. 1-41.3.2 Route Management........................................................................................................ 1-41.3.3 Master Configuration .................................................................................................... 1-51.3.4 Unit Configuration......................................................................................................... 1-51.4 Business Process .................................................................................................................... 1-51.4.1 Managing Maintenance Documents............................................................................ 1-61.4.2 Managing Maintenance Routes.................................................................................... 1-61.4.3 Managing Master Configuration Records .................................................................. 1-71.4.4 Managing Unit Configuration Records ...................................................................... 1-71.5 Business Needs Solutions..................................................................................................... 1-81.5.1 At the Library.................................................................................................................. 1-81.5.2 At the Maintenance Facility.......................................................................................... 1-81.5.3 On the Production Floor................................................................................................ 1-91.6 Integration with Other Oracle Applications...................................................................... 1-91.6.1 Oracle Counters .............................................................................................................. 1-91.6.2 Oracle Installed Base...................................................................................................... 1-9

iii

1.6.3 Oracle Inventory............................................................................................................. 1-91.7 Information Sources ............................................................................................................ 1-101.7.1 Online Documentation ................................................................................................ 1-101.7.2 Related Documentation ............................................................................................... 1-10

2 Basics of Oracle Advanced Service Online

2.1 Accessing Oracle Advanced Service Online...................................................................... 2-12.2 Document Index .................................................................................................................... 2-22.3 Master Configuration............................................................................................................ 2-32.4 Unit Configuration ................................................................................................................ 2-32.5 Route Management ............................................................................................................... 2-4

3 Implementing Advanced Service Online

3.1 Implementation Overview ................................................................................................... 3-23.1.1 Implementing Checklist ................................................................................................ 3-23.2 Implementing Steps .............................................................................................................. 3-43.2.1 Step 1: Set Up System Administrator .......................................................................... 3-43.2.2 Step 2: Confirm Setup of Employees ........................................................................... 3-43.2.3 Step 3: Confirm Setup of Resources............................................................................. 3-53.2.4 Step 4: Confirm Setup of Inventory ............................................................................. 3-53.2.5 Step 5: Confirm Setup of Counters .............................................................................. 3-63.2.6 Step 6: Confirm Setup of Installed Base ...................................................................... 3-63.2.7 Step 7: Confirm Setup of Spares Management........................................................... 3-83.3 Setting Up Advanced Service Online ................................................................................. 3-93.3.1 Setting up Resource Relations .................................................................................... 3-103.3.2 Assigning Territories to Planner Groups.................................................................. 3-173.3.3 Generating Shift Tasks................................................................................................. 3-173.3.4 Resources Subinventories Assignment ..................................................................... 3-203.3.5 Defining Material Justification Codes ....................................................................... 3-213.3.6 Defining Labor Justification Codes............................................................................ 3-233.3.7 Defining Expense Justification Codes ....................................................................... 3-243.3.8 Profile Options .............................................................................................................. 3-26

iv

A Document Index Public APIs

A.1 Document Index Public Packages....................................................................................... A-1A.2 Package Ahl_Di_Doc_Index_Pub ....................................................................................... A-4A.2.1 Create_Document........................................................................................................... A-4A.2.2 Modify_Document ......................................................................................................... A-6A.3 Package Ahl_Di_Subscription_Pub .................................................................................... A-8A.3.1 Create_Subscriptions ..................................................................................................... A-9A.3.2 Modify_Subscriptions.................................................................................................. A-10A.4 Package Ahl_Di_Revision_Pub ......................................................................................... A-12A.4.1 Create_Revisions .......................................................................................................... A-12A.4.2 Modify_Revisions ........................................................................................................ A-14A.5 Package Ahl_Di_Pro_Type_Aso_Pub .............................................................................. A-16A.5.1 Create_Association....................................................................................................... A-17A.5.2 Modify_Doc_Type_Assoc ........................................................................................... A-19A.6 Package Ahl_Di_Pro_Type_Aso_Pub .............................................................................. A-21A.6.1 Create_Association....................................................................................................... A-21A.6.2 Modify_Association ..................................................................................................... A-23A.7 Data Structure Specifications............................................................................................. A-25A.7.1 Doc_Rec ......................................................................................................................... A-26A.7.2 Supplier_Rec ................................................................................................................. A-27A.7.3 Recipient_Rec................................................................................................................ A-28A.7.4 Subscription_Rec .......................................................................................................... A-29A.7.5 Revision_Rec ................................................................................................................. A-30A.7.6 Doc_Type_Assoc_Rec.................................................................................................. A-32A.7.7 Association_Rec............................................................................................................ A-33A.7.8 Document_tbl ............................................................................................................... A-34A.7.9 Supplier_tbl ................................................................................................................... A-34A.7.10 Recipient_tbl ................................................................................................................. A-34A.7.11 Subscription_tbl............................................................................................................ A-34A.7.12 Revision_tbl................................................................................................................... A-35A.7.13 Doc_Type_Assoc_tbl ................................................................................................... A-35A.7.14 Association_tbl ............................................................................................................. A-35A.8 Messages and Notifications ............................................................................................... A-35A.8.1 Common Messages ...................................................................................................... A-36A.8.2 Ahl_Di_Doc_Index_Pub.............................................................................................. A-36

v

A.8.3 Ahl_Di_Subscription_Pub........................................................................................... A-38A.8.4 Ahl_Di_Revision_Pub.................................................................................................. A-39A.8.5 Ahl_Di_Pro_Type_Aso_Pub....................................................................................... A-39A.8.6 Ahl_Di_Asso_Doc_Aso_Pub ...................................................................................... A-40

B Route Management Public APIs

B.0.1 Work Card/Route Authoring ...................................................................................... B-1B.0.2 Production Planning Information................................................................................ B-1B.0.3 Resource Requirements Information........................................................................... B-2B.0.4 Sign-Off Requirements .................................................................................................. B-2B.0.5 Resource Collection Check Points................................................................................ B-2B.1 Route Management Public Packages.................................................................................. B-2B.1.1 List of public Packages .................................................................................................. B-2B.1.2 Process_material ........................................................................................................... B-30B.1.3 Data Structure Specifications...................................................................................... B-32B.2 Messages and Notifications ............................................................................................... B-37B.2.1 Common Messages ...................................................................................................... B-37B.2.2 AHL_RM_ASSOICATIONS_PUB ............................................................................. B-40

C Master Configuration Public APIs

C.1 Define Allowable Configuration ......................................................................................... C-1C.2 Provide a Configuration Template for Unit Configuration ............................................ C-1C.3 Attach applicable maintenance requirements................................................................... C-2C.4 Provide a checklist for the user............................................................................................ C-2C.5 Master Configuration Public Packages .............................................................................. C-2C.5.1 List of packages:.............................................................................................................. C-2C.5.2 Data Structure Specifications..................................................................................... C-10C.5.3 Messages and Notifications ....................................................................................... C-17

D Unit Configuration Public APIs

D.1 Manage Equipment As-Installed Configurations............................................................. D-1D.1.1 Track Utilization of a Unit............................................................................................. D-1D.1.2 Closed Loop Asset Management ................................................................................. D-2D.1.3 Track Unit Specific Business Information................................................................... D-2D.1.4 Unit Configuration Public Packages............................................................................ D-2D.1.5 Data Structure Specifications........................................................................................ D-5

vi

Send Us Your Comments

Oracle Advanced Service Online Implementation Guide, Release 11i

Part No. A95226-01

Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of thispublication. Your input is an important part of the information used for revision.

■ Did you find any errors?■ Is the information clearly presented?■ Do you need more information? If so, where?■ Are the examples correct? Do you need more examples?■ What features did you like most about this manual?

If you find any errors or have any other suggestions for improvement, please indicate the chapter,section, and page number (if available). You can send comments to us in the following ways:

■ E-mail - [email protected]■ FAX - (650) 654-6211 Attn: Oracle CRM Documentation■ Postal service:

Oracle CorporationOracle CPG Documentation500 Oracle Parkway, M/S 5op8Redwood Shores, CA 94065U.S.A.

If you would like a reply, please give your name, address, and telephone number below.

If you have problems with the software, please contact your local Oracle Support Services.

ix

x

Preface

Audience for This GuideWelcome to Release 11i of the Oracle Advanced Service Online ImplementationGuide.

This guide assumes you have a working knowledge of the following:

■ The principles and customary practices of your business area.

■ Advanced Service Online (ASO)

If you have never used ASO, Oracle suggests you attend one or more of theASO training classes available through Oracle University.

■ The Oracle Applications graphical user interface.

To learn more about the Oracle Applications graphical user interface, read theOracle Applications User’s Guide.

See Other Information Sources for more information about Oracle Applicationsproduct information.

How To Use This GuideThis document contains the information you need to understand and use ASO.

■ Chapter 1 presents an overview of Advanced Service Online.

■ Chapter 2 presents the basic functions of ASO.

■ Chapter 3 presents detailed instructions explaining how to implement ASO.

■ Appendix A is a listing and explanation of the Document Index module publicAPIs.

xi

■ Appendix B is a listing and explanation of the Route Management modulepublic APIs.

■ Appendix C is a listing and explanation of the Master Configuration modulepublic APIs.

■ Appendix D is a listing and explanation of the Unit Configuration modulepublic APIs.

Documentation AccessibilityOur goal is to make Oracle products, services, and supporting documentationaccessible, with good usability, to the disabled community. To that end, ourdocumentation includes features that make information available to users ofassistive technology. This documentation is available in HTML format, and containsmarkup to facilitate access by the disabled community. Standards will continue toevolve over time, and Oracle Corporation is actively engaged with othermarket-leading technology vendors to address technical obstacles so that ourdocumentation can be accessible to all of our customers. For additional information,visit the Oracle Accessibility Program Web site athttp://www.oracle.com/accessibility/.

Accessibility of Code Examples in DocumentationJAWS, a Windows screen reader, may not always correctly read the code examplesin this document. The conventions for writing code require that closing bracesshould appear on an otherwise empty line; however, JAWS may not always read aline of text that consists solely of a bracket or brace.

Other Information SourcesYou can choose from many sources of information, including onlinedocumentation, training, and support services, to increase your knowledge andunderstanding of ASO.

If this guide refers you to other Oracle Applications documentation, use only theRelease 11i versions of those guides.

Online DocumentationAll Oracle Applications documentation is available online (HTML or PDF). Onlinehelp patches are available on MetaLink.

xii

Related DocumentationASO shares business and setup information with other Oracle Applicationsproducts. Therefore, you may want to refer to other product documentation whenyou set up and use ASO.

You can read the documents online by choosing Library from the expandable menuon your HTML help window, by reading from the Oracle Applications DocumentLibrary CD included in your media pack, or by using a Web browser with a URLthat your system administrator provides.

If you require printed guides, you can purchase them from the Oracle Store athttp://oraclestore.oracle.com.

Documents Related to All Products

Oracle Applications User’s GuideThis guide explains how to enter data, query, run reports, and navigate usingthe graphical user interface (GUI) available with this release of ASO (and any otherOracle Applications products). This guide also includes information on setting userprofiles, as well as running and reviewing reports and concurrent processes.

You can access this user’s guide online by choosing ”Getting Started with OracleApplications” from any Oracle Applications help file.

Documents Related to This Product

Oracle Applications ConceptsThis guide provides an introduction to the concepts, features, technology stack,architecture, and terminology for Oracle Applications Release 11i. It provides auseful first book to read before an installation of Oracle Applications. This guidealso introduces the concepts behind Applications-wide features such as BusinessIntelligence (BIS), languages and character sets, and Self-Service Web Applications.

Installing Oracle ApplicationsThis guide provides instructions for managing the installation of OracleApplications products. In Release 11i, much of the installation process is handledusing Oracle Rapid Install, which minimizes the time to install Oracle Applications,the Oracle8 technology stack, and the Oracle8i Server technology stack byautomating many of the required steps. This guide contains instructions for usingOracle Rapid Install and lists the tasks you need to perform to finish your

xiii

installation. You should use this guide in conjunction with individual productuser’s guides and implementation guides.

Oracle Applications Supplemental CRM Installation StepsThis guide contains specific steps needed to complete installation of a few of theCRM products. The steps should be done immediately following the tasks given inthe Installing Oracle Applications guide.

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

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

Oracle Applications System Administrator’s GuideThis guide provides planning and reference information for the Oracle ApplicationsSystem Administrator. It contains information on how to define security, customizemenus and online help, and manage concurrent processing.

Oracle Alert User’s GuideThis guide explains how to define periodic and event alerts to monitor the status ofyour Oracle Applications data.

Oracle Applications Developer’s GuideThis guide contains the coding standards followed by the Oracle Applicationsdevelopment staff. It describes the Oracle Application Object Library componentsneeded to implement the Oracle Applications user interface described in the OracleApplications User Interface Standards for Forms-Based Products. It also providesinformation to help you build your custom Oracle Forms Developer 6i forms so thatthey integrate with Oracle Applications.

xiv

Oracle Applications User Interface Standards for Forms-Based ProductsThis guide contains the user interface (UI) standards followed by the OracleApplications development staff. It describes the UI for the Oracle Applicationsproducts and how to apply this UI to the design of an application built by usingOracle Forms.

Other Implementation Documentation

Multiple Reporting Currencies in Oracle ApplicationsIf you use the Multiple Reporting Currencies feature to record transactions inmore than one currency, use this manual before implementing ASO. This manualdetails additional steps and setup considerations for implementing ASO with thisfeature.

Multiple Organizations in Oracle ApplicationsThis guide describes how to set up and use ASO with Oracle Applications' MultipleOrganization support feature, so you can define and support different organizationstructures when running a single installation of ASO.

Oracle Workflow GuideThis guide explains how to define new workflow business processes as well ascustomize existing Oracle Applications-embedded workflow processes.You also usethis guide to complete the setup steps necessary for any Oracle Applicationsproduct that includes workflow-enabled processes.

Oracle Applications Flexfields GuideThis guide provides flexfields planning, setup and reference information for theASO implementation team, as well as for users responsible for the ongoingmaintenance of Oracle Applications product data. This manual also providesinformation on creating custom reports on flexfields data.

Oracle eTechnical Reference ManualsEach eTechnical Reference Manual (eTRM) contains database diagrams and adetailed description of database tables, forms, reports, and programs for a specificOracle Applications product. This information helps you convert data from yourexisting applications, integrate Oracle Applications data with non-Oracleapplications, and write custom reports for Oracle Applications products. OracleeTRM is available on Metalink

xv

Oracle Manufacturing APIs and Open Interfaces ManualThis manual contains up-to-date information about integrating with other OracleManufacturing applications and with your other systems. This documentationincludes APIs and open interfaces found in Oracle Manufacturing.

Oracle Order Management Suite APIs and Open Interfaces ManualThis manual contains up-to-date information about integrating with other OracleManufacturing applications and with your other systems. This documentationincludes APIs and open interfaces found in Oracle Order Management Suite.

Oracle Applications Message Reference ManualThis manual describes Oracle Applications messages. This manual is available inHTML format on the documentation CD-ROM for Release 11i.

Oracle CRM Application Foundation Implementation GuideMany CRM products use components from CRM Application Foundation. Use thisguide to correctly implement CRM Application Foundation.

Training and Support

TrainingOracle offers training courses to help you and your staff master ASO and reach fullproductivity quickly. You have a choice of educational environments. You canattend courses offered by Oracle University at any one of our many EducationCenters, you can arrange for our trainers to teach at your facility, or you can useOracle Learning Network (OLN), Oracle University's online education utility. Inaddition, Oracle training professionals can tailor standard courses or developcustom courses to meet your needs. For example, you may want to use yourorganization’s structure, terminology, and data as examples in a customizedtraining session delivered at your own facility.

SupportFrom on-site support to central support, our team of experienced professionalsprovides the help and information you need to keep ASO working for you. Thisteam includes your Technical Representative, Account Manager, and Oracle’s largestaff of consultants and support specialists with expertise in your business area,managing an Oracle8i server, and your hardware and software environment.

xvi

OracleMetaLinkOracleMetaLink is your self-service support connection with web, telephone menu,and e-mail alternatives. Oracle supplies these technologies for your convenience,available 24 hours a day, 7 days a week. With OracleMetaLink, you can obtaininformation and advice from technical libraries and forums, download patches,download the latest documentation, look at bug details, and create or update TARs.To use MetaLink, register at (http://metalink.oracle.com).

Alerts: You should check OracleMetaLink alerts before you begin to install orupgrade any of your Oracle Applications. Navigate to the Alerts page as follows:Technical Libraries/ERP Applications/Applications Installation andUpgrade/Alerts.

Self-Service Toolkit: You may also find information by navigating to theSelf-Service Toolkit page as follows: Technical Libraries/ERPApplications/Applications Installation and Upgrade.

Do Not Use Database Tools to Modify Oracle Applications DataOracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle DataBrowser, database triggers, or any other tool to modify Oracle Applicationsdata unless otherwise instructed.

Oracle provides powerful tools you can use to create, store, change, retrieve, andmaintain information in an Oracle database. But if you use Oracle tools such asSQL*Plus to modify Oracle Applications data, you risk destroying the integrityof your data and you lose the ability to audit changes to your data.

Because Oracle Applications tables are interrelated, any change you make usingOracle Applications can update many tables at once. But when you modifyOracle Applications data using anything other than Oracle Applications, youmay change a row in one table without making corresponding changes inrelated tables. If your tables get out of synchronization with each other, you riskretrieving erroneous information and you risk unpredictable results throughoutOracle Applications.

When you use Oracle Applications to modify your data, Oracle Applicationsautomatically checks that your changes are valid. Oracle Applications also keepstrack of who changes information. If you enter information into database tablesusing database tools, you may store invalid information. You also lose the abilityto track who has changed your information because SQL*Plus and otherdatabase tools do not keep a record of changes.

xvii

About OracleOracle Corporation develops and markets an integrated line of softwareproducts for database management, applications development, decisionsupport, and office automation, as well as Oracle Applications, an integratedsuite of more than 160 software modules for financial management, supplychain management, manufacturing, project systems, human resources andcustomer relationship management.

Oracle products are available for mainframes, minicomputers, personalcomputers, network computers and personal digital assistants, allowingorganizations to integrate different computers, different operating systems,different networks, and even different database management systems, into asingle, unified computing and information resource.

Oracle is the world’s leading supplier of software for information management, andthe world’s second largest software company. Oracle offers its database, tools, andapplications products, along with related consulting, education, and supportservices, in over 145 countries around the world.

xviii

Overview of Oracle Advanced Service O

1
Overview of Oracle Advanced Service
Online

This section provides an overview of Advanced Service Online (ASO) and itscomponents. It explains the key concepts, features, and functions of Oracle ASO.This chapter covers the following topics:

■ What is Oracle ASO?

■ Why Use Oracle ASO?

■ Key Features of ASO

■ ASO Business Needs Solutions

■ Business Process

■ Integration with Other Oracle Applications

■ Information Sources

1.1 What is Oracle ASO?Advanced Service Online (ASO) is a class of electromechanical systemsmaintenance applications. The direction of ASO development is toward themaintenance, repair, and overhaul industry (MRO) for both commercial andmilitary organizations. The design of ASO has been carefully considered so as to besuitable for a wide range of heavy to light electromechanical systems includingcommercial and military aircraft, trucks, military land vehicles, public transitvehicles, construction equipment, ships, submarines, railway rolling stock, pipelinepump stations, electrical power generation systems, and medical diagnosticsystems.

nline 1-1

Why Use Oracle ASO?

Oracle ASO is an integrated, Web-enabled, software application suite designed toempower complex equipment maintenance organizations. Oracle ASO supportstypical maintenance processes, such as scheduled and unscheduled maintenancevisits, component monitoring, job scheduling and routing, labor time collection,cost collection, inventory management, and maintenance document management.

Oracle ASO reveals maintenance practice improvement opportunities, andopportunities to improve fleet readiness. It provides models for electromechanicalsystems and defines rules for assembling units. It also records unit-specificinformation, allowing quick access to the maintenance history of a productcomponent. It provides maintenance organizations a means to reduce operationalcosts, and thereby to yield improved profitability.

Oracle ASO is comprised of the following four modules:

■ Document Index

■ Route Management

■ Master Configuration

■ Unit Configuration

1.2 Why Use Oracle ASO?Transport organizations are generally in a race against time to keep up withcustomer demands for services. For example, consider the air transport industry.With harried passengers as concerned about on-time departure as they are aboutcompetitive fares, airlines maintenance operations are now in competiton with eachother to ensure the highest aircraft dispatch rates possible. Without cost-effectivefleet maintenance, a commercial airline cannot remain in business for too long.Airlines earn revenue when their aircraft fleets are in the air, carrying passengersand cargo. Lost revenue due to equipment-related flight cancellations is very costly.Maintaining the operational readiness of fleets is therefore of highest concern.

The maintenance of electromechanical systems such as aircraft is different from themanufacture of these systems. For example, the demand for parts in amanufacturing organization is derived from the rate at which products areassembled, and hence is easier to forecast. The demand for parts in a maintenanceorganization must be derived by statistical methods, and is difficult to predict inmost cases. This reflects the need for a dedicated maintenance managementapplication in such organizations comprising the Maintenance, Repair, andOverhaul (MRO) industry. Maintenance organizations face the challenge ofmanaging a variety of maintenance activities that include:

1-2 Oracle Advanced Service Online Implementation Guide

Key Features of ASO

■ Maintenance visits

■ Job scheduling and routing

■ Labor time collection

■ Cost collection

■ Component monitoring

■ Inventory management

■ Maintenance document management

The logistics operations to maintain spare parts, fuel, consumable supplies,scheduling, and human resources require the use of integrated information systemsdesigned to connect all of the enterprise with a powerful Web-enabled architecture.Oracle ASO is the ideal tool for complex equipment maintenance organizationsconcerned about improving the efficiency of maintenance operations. Theintegration of Oracle ASO with the Oracle E-Business suite enables maintenanceorganizations to implement a powerful set of applications to streamline and reducethe complexity of their operations.

1.3 Key Features of ASOOracle ASO enables maintenance organizations to meet the expectations ofcustomers and draw maximum benefit by improving their fleets’ operationalreadiness. ASO enables organizations to:

■ Streamline maintenance operations

■ Meet the demands for transport and service

■ Improve profitability

As previously mentioned, Oracle ASO is comprised of the following four modules.

■ Document Index




Overview of Oracle Advanced Service Online 1-3

Key Features of ASO

1.3.1 Document IndexDocument Index provides an online catalog of documents used in MRO operations,and supports the reception, distribution, and revision of technical documentation.

The main features of Document Index include:

■ Documents registration

■ Centralized revision control

■ Distribution information

■ Subscription information

■ Supplier information

■ Catalog of documents

1.3.2 Route ManagementRoute Management is the central repository for step-by-step instructions formaintenance tasks. In preventive maintenance, the term “route” or “work card”refers to a maintenance procedure. Route management consists of developing andmaintaining validated service procedures and identifying the resourcerequirements, such as spare parts, special tools, materials, and required expertise.

The main features of Route Management include:

■ Step-by-step instructions for work cards

■ Create Operations

■ Create Routes

■ Associate Operations with Routes

■ Associate Product Types with Work Zones and Sub Zones

■ Resource information for the following

■ Person-hours

■ Skills and Skill levels

■ Materials

■ Tooling

■ Documents

■ Machines


Business Process

1.3.3 Master ConfigurationMaster Configuration provides a template of the structure of an electromechanicalsystem assembly, with rules for component selection. A Master Configuration doesnot, in itself, have any parts attached, but it indicates the allowable parts of eachposition. For example, the master configuration of a car has four positions forwheels: left-front, right-front, left-rear, and right-rear. An instance of a MasterConfiguration will model the general characteristics of a unit.

The main features of Master Configuration include:

■ Definition of positions of tracked parts, within an assembly

■ Addition of configurations to a position

■ Addition of information to positions

■ Definition of parent-child relationships

■ Definition of alternate parts for a position

■ Definition of documents for a position

1.3.4 Unit ConfigurationUnit Configuration represents the current “as installed” configuration of a specificunit. During the maintenance process, the part information in the unit configurationis embellished to include additional information, including the disposition results,times and cycles, and individual part serial numbers, where applicable. The unitconfiguration is constantly changing.

The main features of Unit Configuration include:

■ Unit creation with Master Configuration validation

■ Unit update with Master Configuration validation

■ Utilization tracking

■ Parent-child history of components

1.4 Business ProcessThe following discussion explains the business process associated with Oracle ASO.


Business Process

1.4.1 Managing Maintenance DocumentsThe Document Index module in Oracle ASO is the central place for managing allmaintenance documents. Maintenance personnel can access an online catalog ofdocuments used in maintenance, repair, and overhaul operations. The DocumentIndex allows personnel to receive, distribute, and control revisions in technicaldocumentation. Maintenance personnel can:

■ Search the database to quickly refer to a document

■ Create new documents or document revisions in the system

■ Associate subtypes to document types for easy identification

■ Add subscription, supplier, and distribution details of documents

Maintenance document management involves tracking documents and theirrevisions, validating document references from multiple levels of maintenanceoperations, and making them easily accessible to the maintenance personnel.

1.4.2 Managing Maintenance RoutesThe Route Management module in Oracle ASO provides a single interface formanaging all maintenance tasks. The maintenance personnel can prepare andmaintain work instructions. Route Management also manages the grouping ofscheduled and unscheduled maintenance tasks in one work package. Using thismodule, maintenance personnel can:

■ Search the database for a specific operation either for reference purposes, or forediting purposes

■ Create an operation or define instructions for carrying out a maintenance task

■ Search for maintenance routes for reference, or for editing route information

■ Create a maintenance route

■ Associate major and sub-zones in a system to a product type, to facilitatetracking of maintenance operations on complex electromechanical systems

■ Associate Operations to a route

The intuitive user interface of the Oracle ASO is designed to enable maintenancepersonnel to handle operational needs as effortlessly as possible, in the minimumamount of time necessary to achieve the desired result.


Business Process

1.4.3 Managing Master Configuration RecordsThe Master Configuration module in Oracle ASO provides models ofelectromechanical system assemblies. A master configuration model will form thebasis of a fleet unit in combination with business rules that specify the systems andsubsystems that may be included in the assembled fleet unit. The MasterConfiguraion module simplifies the development of routes for maintenance byproviding master configuration records to which service route definitions areattached. By using this module, maintenance personnel can:

■ Search the database for the master configuration of an electromechanical systemassembly

■ Create the master configuration of a newly-created system assembly

■ Search for alternate parts that may be used in place of specified components inan assembly

■ Add configuration, revision, position ratio, and documents to a position

Oracle ASO allows personnel to create a service route once, and connect the route tothe template of an assembly, instead of creating duplicate service routes. Thisstrategy greatly aids organizations in planning their maintenance operationsefficiently.

1.4.4 Managing Unit Configuration RecordsThe Unit Configuration module in Oracle ASO allows organizations to describe thestructure of an assembled electromechanical system. The as-constructedconfiguration of an assembly will determine the specific maintenance programrequired to ensure the operational readiness of that unit. Maintenance personnelcan easily initiate proper maintenance activities to resolve issues. Using thismodule, maintenance personnel can:

■ Create unit configurations from existing master configurations

■ Create unit configurations manually using the interface

■ Search for a product to edit product details

■ Search for a unit for reference or editing purposes

The Unit Configuration module in Oracle ASO is a key feature that enablesmaintenance organizations to determine services required. Even if two units havethe same part number, or belong to the same product family, their configurationsare normally different due to the operation and maintenance history of each unit.Unit Configuration provides models of individual tracked parts to supportunit-specific information.


Business Needs Solutions

1.5 Business Needs SolutionsThe following discussion explains how some typical business scenarios might besupported by Oracle ASO.

1.5.1 At the LibraryThe librarian receives and registers a document transmittal using the DocumentIndex screen. The document transmittal may be the maintenance manual for newequipment, a revision to an existing manual, or, in the case of the aircraft industry, amaintenance requirement notification from regulatory authorities such as theFederal Aviation Administration (FAA). The librarian initiates an impact analysisprocess if required and then releases the transmittal, making it the valid version ofthe document for production use. If the transmittal was an update to an existingdocument, the previously-valid version is retired (marked as not usable forproduction).

The release of a document makes it visible to other modules, and maintenancepersonnel can refer to this documentation from multiple levels during themaintenance operation.

1.5.2 At the Maintenance FacilityRegulatory authorities or other maintenance needs impose maintenancerequirement on an equipment. The concerned department uses the RouteManagement interface to create work cards that can be associated to one or moreroutes. Each work card contains instructions to perform a task, and productionplanning information including work center, zone, process, skill, estimated workhours and resources. The department also defines sign off requirements for eachwork card. The user creates re-usable routes from re-usable work cards, and groupsroutes that can be assigned to specific fleet or product composition.

Department personnel access the technical documentation and configurationrecords (provided by the Master Configuration and Unit Configuration modules)related to the concerned equipment while preparing work cards and routes. Afterthe work card is ready, the department issues it to production in the form of a workorder.


Integration with Other Oracle Applications

1.5.3 On the Production FloorThe production personnel receives the work order and performs the tasks listed.Production personnel may verify versions of technical documentation used asreference for a work order. Production personnel may also access the configurationrecords of assemblies they work on and also may need to access the historical repairinformation associated with repair of a unit such as defect types, applicable repairs,and resources required.

1.6 Integration with Other Oracle ApplicationsOracle ASO uses modules from the following Oracle applications.

1.6.1 Oracle CountersOrganizations perform maintenance operations on an electromechanical system tomaximize the service life of that asset. Maintenance operations require that theservice life of a system, or the components comprising it, be measured. Timers andcounters therefore become important. Your car’s odometer, for example, is a type ofcounter. Meters used to record the operating hours of power plants on aircraft,boats etc. are timers. Maintenance is typically performed periodically, based onelapsed operating time. Oracle ASO meets these needs through its integration withthe Oracle Counters application.

1.6.2 Oracle Installed BaseMaintenance organizations gain many advantages by modeling a template forelectromechanical system assemblies, as well as individual fleet units. After anOracle ASO user completes the definition of a master configuraion, a frameworkexists that describes the general characterisitics of the system, including theengineering rules for assembly. The user can then create a unit configuration.

Oracle ASO will invoke the Installed Base methods to populate the database with atransaction representing the as-operated, or unit configuration, of anelectromechanical system.

1.6.3 Oracle InventoryMaintenance organizations can greatly improve operational efficiency by planningtheir material requirements for maintenance purposes. The Master Configurationmodule of Oracle ASO provides a template of the structure of an electromechanicalsystem, and lists the components that are allowable in the different positions of a


Information Sources

system configuration. The Unit Configuration module describes the as-installedconfiguration of a specific fleet unit. This helps organizations predict to an extent,the material needed to maintain the operational readiness of fleet units.

An Oracle ASO user will use instances of Oracle Inventory when defining theallowable parts in a master configuration for an electromechanical system, andwhen describing the components in a unit configuration. Oracle ASO invokesOracle Inventory methods to populate the database with information on allowablecomponents in a configuration, and the components actually available to create aunit configuration.

1.7 Information SourcesA variety of information sources, including online documentation, training, andsupport services, are available for exploring the full capabilities of Oracle ASO.

1.7.1 Online DocumentationAll Oracle Applications User’s Guides and Concepts and Procedures Guides areavailable online in HTML and PDF formats. Further, technical reference guides mayalso be available in an electronic format. The HTML version of Oracledocumentation is optimized for on-screen reading. You can use it to followhypertext links for easy access to other HTML guides in the library.

■ You can use the Search feature to search by words or phrases.

■ You can use the expandable menu to search for topics in the menu structure weprovide. The Library option on the menu expands to show all OracleApplications HTML documentation.

You can view HTML help in the following ways:

■ From an application window, use the help icon or the help menu to open a newWeb browser and display help about that window.

■ Use the documentation CD.

■ Use a URL provided by your system administrator.

1.7.2 Related DocumentationOracle ASO shares business and setup information with other Oracle Applicationsproducts. Therefore, you may want to refer to these guides when you set up and useOracle ASO.


Information Sources

1.7.2.1 Oracle Applications ConceptsThis guide provides an introduction to the concepts, features, technology stack,architecture, and terminology for Oracle Applications Release 11i.

1.7.2.2 Oracle Applications User GuideThis guide explains how to navigate the system, enter data, and query information,and introduces other basic features of the User Interface available with this releaseof Oracle Advanced Service Online.

1.7.2.3 Oracle Advanced Service Online Implementation GuideThis guide explains how to set up Oracle ASO.

1.7.2.4 Oracle Installed Base Concepts and Procedures GuideThis guide provides an introduction to the concepts, and explains how to navigatethe system, enter data, and query information in the Oracle Installed Base interfacethat forms part of the Oracle ASO suite of applications.


Information Sources


Basics of Oracle Advanced Service O

2
Basics of Oracle Advanced Service Online
Oracle ASO provides maintenance organizations a means to quickly accesstechnical documentation, details of maintenance routes, master configurations ofcomplex system assemblies, and unit specific information critical to maintaining theoperational readiness of fleet units.

This chapter describes the distinct regions in the Oracle ASO suite of applications,and the functions these regions will enable you to perform.

2.1 Accessing Oracle Advanced Service OnlineYou can access Oracle ASO with an up-to-date Web browser. Oracle recommendsNetscape Communicator 4.78 or later, or Microsoft Internet Explorer 5.5 or later.Your systems administrator will provide you with a username and password toaccess Oracle ASO.

To access Oracle ASO:

1. Using the path provided by your System Administrator, navigate to theWelcome to Oracle eBusiness Suite page.

2. If you have not already obtained a registered and approved login, click RegisterHere to register.

3. After you have an approved login, in the Welcome to Oracle eBusiness Suitepage, enter your User ID and Password.

4. Click Go. Oracle ASO Home page appears.

Oracle ASO Home page provides tabs to access each of its modules:

■ Document Index


nline 2-1

Document Index



Sub-tabs in each of these modules allow you to quickly search for, and accessrelevant information. Oracle ASO provides a means for the various business areasin maintenance organizations to remain well connected and informed aboutproceedings in maintenance operations.

2.2 Document IndexThe Document Index provides maintenance personnel instant access tomaintenance documents. The Document Index module allows you to search fordocuments, and provides access create new or revised document titles, andassociate predefined document sub types to document types.

You can access the following sub tabs from the Document Index module:

Search Document This sub tab launches the Search Document page that allowsyou to search for documents indicating the designated search criteria based onchosen document attributes. The document attributes include document source,number, title, type, sub type, operator, product type and subscription status. Theresults displays the document name and the associated revision detail information.You can then select a document to edit the document, or to edit a revision, or tocreate a new revision.

Create Document This sub tab launches the Create Document page that helps youcreate a new document reference with all of its related information. Relatedinformation include document information, supplier information, subscriptioninformation, distribution information, and information updates if any. This creates arecord of all information related to a document reference in your database.

Associate Type This sub tab launches the Associate Document Sub Type ToDocument Type page that allows you to associate a sub type to a document type,and also to search for a document to which a sub type is associated. Sub Type refersthe maintenance document category that describes the nature of the informationcontained in the document that you are defining.


Unit Configuration

2.3 Master ConfigurationThe Master Configuration module provides maintenance personnel access toinformation related to the configuration of an electromechanical system assembly,and the rules for component selection and component location. Maintenancepersonnel can search for master configurations based on which to create unitconfigurations, create new master configurations, and find the alternate parts thatare allowable in an assembly.

You can access the following sub tabs from the Master Configuration page:

Search This sub tab launches the Search Master Configuration page that allowsyou to search for a master configuration indicating the designated search criteria.The master configuration attributes include name, position and description. Thelower half of the screen displays a list of master configuration references with itsattributes. You can select a master configuration to edit the configuration, or toremove it from the database.

Create This sub tab launches the Create Master Configuration page where you canadd a master configuration to the database. The attributes needed to create a masterconfiguration include name, description, and status indicating whether the masterconfiguration record is a draft or a completed version.

Alternate Parts This sub tab launches the Search Alternate Parts page where youcan search for parts that can be used alternatively in place of specified components.You can execute a search based on group name and description. The search resultsdisplay the alternate parts with their group names and descriptions. You can selecta part to edit the information. You can also add alternate parts using the Createbutton on this page.

2.4 Unit ConfigurationThe Unit Configuration module provides maintenance personnel access tounit-specific information such as tracking configuration changes of a unit,maintenance requirements of a unit, utilization or aging of a unit and themaintenance event history of a unit. Maintenance personnel can create unitconfigurations from master configurations, or directly using the Unit Configurationinterface. You can also search the database for unit configurations that you want toedit or remove, and update unit configuration information manually.

You can access the following sub tabs from the Unit Configuration page:

Basics of Oracle Advanced Service Online 2-3

Route Management

Search Unit This sub tab launches the Search Unit Configuration page that allowsyou to search for a unit configuration. You can execute the search specifying thename and serial number attributes of the unit configuration. The search resultsappear in the form of a list of unit configurations. You can select a configuration toedit the configuration, or to remove it from the database.

Create from Master Configuration This sub tab allows you to search for masterconfigurations indicating the designated search criteria. The master configurationattributes include Name, Position and Description. When you execute a search, thescreen displays a list of master configurations that match the search criteria. You canthen select the master configuration based on which you want to create a unitconfiguration.

Search Product

Create Product

2.5 Route ManagementThe Route Management module provides maintenance personnel access toinformation required for managing maintenance operations. The RouteManagement tab provides access to create work cards or routes, search for routes toperform a maintenance job, and to record information about the zones in a system,on which the maintenance operation is performed.

You can access the following sub tabs from the Route Management page:

Search Operation This sub tab launches the Search Operation page that allowsyou to search for an operation. The interface provides fields where you can specify anumber of operation attributes to retrieve the operation record. Once you retrievethe operation record, you can select the operation to edit the information. Theinterface leads you through successive screens where you can edit each attribute ofthe operation.

Create Operation This sub tab launches the Create Operation page that allows youto create an operation. The input required to create an operation include documentreference, operation identity, start date, and operation description. You can inputmore information related to the operation such as operator, product type, zone orposition, skill level, and category of maintenance while creating an operation. Thisfunctionality lets you record in your database, the details of an operation carriedout for a specific maintenance need.


Route Management

Search Route This sub tab launches the Search Route page that allows you tosearch for a maintenance route. The attributes you can specify to execute a searchinclude route number, product type, work center, major zone to which themaintenance route applies, category, system to which the route applies, status,operator, skill type, process such as cleaning, inspection etc., and the route type.Once you retrieve the pertinent route, you can edit the route, or associate otheroperations to the route. This functionality allows you to use existing informationabout maintenance solutions as reference for similar maintenance operations.

Create Route This sub tab launches the Create Route page that allows you tocreate maintenance route references. Information that is mandatory to create amaintenance route reference include route number, title of the route, status, andstart date of the maintenance route operations. Other information that you canrecord about the maintenance route includes operator, product type, major zone ofoperation, work center, major skill type, route category, route type, process, thesystem to which the route applies, and the end date of maintenance routeoperations.

Associate Major Zone This sub tab launches the Associate Major Zone To ProductType page where you can select the product type, and the major zone in theelectromechanical system to which a route applies. You can also specify the startand end dates of the maintenance operation, which will help you record the detailsof operations performed on a specific zone in an electromechanical system.

Associate Sub Zone This sub tab launches the Associate Sub Type to ProductType page where you can select the major zone, and the sub zone that you want toassociate with a product type, along with the start and end dates of the operation.This enables you, for management purposes, to retrieve details of maintenanceoperations performed on a sub zone or major zone within an electromechanicalsystem.

Basics of Oracle Advanced Service Online 2-5

Route Management


Implementing Advanced Service O

3
Implementing Advanced Service Online
This chapter provides general and detailed descriptions of the setup andconfiguration tasks required to implement the Advanced Service Online (ASO)application successfully.

Topics covered are:

■ Implementation Overview

■ Implementing Steps

■ Setting Up Advanced Service Online

■ Implementing Checklist

■ Setting Up Resource Relations

■ Assigning Territories to Planner Groups

■ Resources Subinventories Assignment

■ Generating Shift Tasks

■ Define Material Justification Code

■ Define Expense Justification Code

■ Define Labor Justifications Code

■ Profile Options

nline 3-1

Implementation Overview

3.1 Implementation OverviewBefore setting up Advanced Service Online, you must install and fully implementthese Oracle applications or components:

■ Oracle Inventory

■ Oracle Service

■ Charges

■ Installed Base

■ Counters

■ Oracle CRM Foundation

■ Assignment Manager

■ Resource Manager

■ Territory Manager

■ Tasks

■ Calendar

For information regarding the installation and implementation of these applicationsand components, see the appropriate documentation for each product.

The implementation steps described here are tasks that are necessary to use theadditional functionality included with Advanced Service Online.

3.1.1 Implementing ChecklistWhile you can implement Advanced Service Online in many different ways, thefollowing checklist shows the recommended order. Complete the followingimplementation steps in sequential order.

Step Required Step Title

1. Yes Setup Sys Admin

2. Yes Confirm Setup of Employees

3. Yes Confirm Setup of Resource Manager

4. Yes Confirm Setup of Inventory


Implementation Overview

5. Yes Confirm Setup of Charges

6. Yes Confirm Setup of Knowledge Base

7. Yes Confirm Setup of Counters

8. Yes Confirm Setup of Installed Base

9. Optional Confirm Setup of Contracts Core

10. Optional Confirm Setup of Service Core

11. Yes Confirm Setup of Calendar

12. Yes Setup Advanced Service Online

13. Yes Setup Advanced Service Online Report

Implementing Advanced Service Online 3-3

Implementing Steps

3.2 Implementing StepsPerform the following implementation steps in sequential order:

3.2.1 Step 1: Set Up System AdministratorTo fully implement Oracle ASO, and set up the system across all applications (CRMand ERP), you need the System Administrator responsibility. Please see OracleApplications System Administrator’s Guide for more information.

The Oracle ASO application comes with the following seeded responsibilities:

■ To define additional responsibilities, please see Oracle Applications SystemAdministrator’s Guide.

■ Set up printers (optional). For more information, see: Setting Up Your Printers,Oracle Applications System Administrator’s Guide.

3.2.2 Step 2: Confirm Setup of EmployeesThe setup of Employees is required. You setup Employees in Oracle HumanResources.

Steps1. Switch to the HR (Human Resource) Super User responsibility.

2. Navigate to People > Enter and Maintain.

3. Setup employees.

Responsibility Description

ASO Administrator Allowed to perform all administrative tasks within CRMService, such as Setup.

ASO Manager Access to all applications and windows within CRMService.

Limited setup possibilities, such as creating task types.

ASO Dispatcher Access to all applications within CRM Service.

ASO Representative Access to a limited set of windows from the applicationswithin CRM Service.


Implementing Steps

■ Please refer to the appropriate section in Oracle Human Resource ManagementSystems to enter and maintain employees.

The Setup of Employees is also addressed in more detail in Setup Resource Relationas part of Setting Up Advanced Service Online.

3.2.3 Step 3: Confirm Setup of ResourcesMake sure you implement Resource Manager as described in Implementing OracleResource Manager in Oracle CRM Foundation Implementation Guide.

The Advanced Service Online specific setup of Resource Manager involves thefollowing:

■ Setup service representatives. In Resource Manager assign role ’MaintenanceRepresentative’ to a resource to make it visible in the Control Tower.

A maintenance representative does not have to be defined as an employee anddoes not have to be an Oracle Applications User.

■ Setup planners. A planner does not need a specific role assigned. You can assignthe role ’Maintenance Dispatcher’ in Resource Management.

A planner needs to be defined as an employee and assigned an OracleApplications User. Define the planner as an employee and import the employeeinto Resource Management to define it as a resource. It is then automaticallyassigned an Oracle Applications User.

■ Create planner groups by creating resource groups with only planners assignedto it. The planner groups are used to assign groups of service representativescreated in Territory Management to.

The Setup of Resources is also addressed in more detail in Setup Resource Relationas part of Setting Up Advanced Service Online.

3.2.4 Step 4: Confirm Setup of InventoryThe implementation of Inventory is required for two purposes:

■ To define the units of measurement (UOM) required by Advanced ServiceOnline.

■ To report on items used taken down on the ASO Report.

Set up Inventory as described in Overview of Setting Up in Oracle Inventory User’sGuide. Ensure that all the following required steps have been reviewed andcompleted as necessary:


Implementing Steps

■ Create items.

■ Make sure that on Master Item level the Serviceable Product flag is checked forthe organization.

■ Define Sub-inventories. A standard setup is required for each sub-inventory.

The following ASO-specific setup step is necessary.

■ Define Unit of Measurement

3.2.4.1 Define Unit of Measurement (UOM)You need to define the UOM for Hour and Minute. Two profile options in ASOmake use of these UOM’s. It is used to define a planned start and end time whencreating a task.

Steps1. Switch to the Inventory Super User responsibility.

2. Navigate to Setup > Units of Measure.

3. Make sure the unit of measure for Hour and Minute is defined.

For setup details please refer to Oracle Inventory User’s Guide for moreinformation.

3.2.5 Step 5: Confirm Setup of CountersThe setup of Counters is required to be able to report counter readings whenperforming an ASO visit.

Please refer to the appropriate section from Oracle Service Implementation Guide forCounters setup.

No additional ASO-specific setup steps are necessary.

3.2.6 Step 6: Confirm Setup of Installed BaseThe Installed Base is a repository that contains vital information and details of aservice provider’s customers, products, and services. The service provider updatesall data contained in the Installed Base.

Note: The Unit of Measure for Hours is pre-defined for use on theAdvanced Service Online Report.


Implementing Steps

Installed Base is a component of Oracle Service, it consolidates information forcustomer products in the Installed Base. Each customer product includes thefollowing:

■ Customer name and number

■ Bill-to location code, address, and contact

■ Ship-to location code, address, and contact

■ Installation location, address, and technical and administrative contact

■ Service Provider

■ Any other user-defined contacts

Use the Installed Base to track your serviceable and customer products.

Make sure you set up Installed Base as described in Oracle Service ImplementationGuide:

■ Confirm the ERP setup.

■ Confirm status of customer products setup.

■ Confirm customer product types (optional).

■ Confirm system types setup.

■ Confirm transaction billing types setup.

■ Confirm split process reasons setup.

■ Confirm business processes setup.

■ Confirm customer product configuration types setup.

■ Confirm profile options setup:

■ Many service options

■ Options to access HTML windows

■ Options for the Installed Base Interface concurrent program

■ Confirm System Administration menu setup.

■ Confirm inventory item setup.

■ Test the Installed Base Interface concurrent program.

Once the Installed base has been set up you maintain it using the ASO Report toreport on installed base transactions and update Installed Base from it.


Implementing Steps

3.2.7 Step 7: Confirm Setup of Spares ManagementThe implementation of Spares Management is required for two purposes.

■ To be able to locate spare parts (material) from the Advanced Service OnlineControl Tower.

■ To maintain the level of material in the subinventories. This could bewarehouses and service representatives vehicles.

Please refer to Implementing Oracle Spares Management for Spares Managementsetup.

No additional ASO specific setup steps are necessary.


Setting Up Advanced Service Online

3.3 Setting Up Advanced Service OnlineSetting up the Advanced Service Online application includes the following setupsteps. Perform the steps, listed in the following table, in sequential order.

Step Description

1. Setting Up ResourceRelations

In order to launch the ASO Control Tower you need to setupresources: ASO dispatchers and ASO representatives.

2. Assigning Territoriesto Planner Groups

Use this ASO setup screen to relate territories of servicerepresentatives to ASO dispatcher groups. Once setup this isthe default group of service representatives shown to the ASOdispatcher in the ASO Control Tower.

3. ResourcesSubinventoriesAssignment

Use this setup screen in ASO > Spares Management to relatesub inventories to service representatives.

4. Generating ShiftTasks

Use this ASO concurrent program to create departure andarrival tasks for ASO representatives based on their shifts.These tasks are used for scheduling.

5. Define MaterialJustification Code

Define justification lookup codes when reporting on materialfor the ASO Report.

6. Define ExpenseJustification Code

Define justification lookup codes when reporting on expensefor the ASO Report.

7. Define LaborJustifications Code

Define justification lookup codes when reporting on labor forthe ASO Report.

8. Profile Options Set all the ASO specific profile options.

Additionally set the following profile options:

■ TCF: HOST

■ TCF: PORT



3.3.1 Setting up Resource RelationsIn order to launch the Advanced Service Online Control Tower as a dispatcher withthe right ASO representatives (resources) assigned, and to be able to assign tasks tothese service representatives, you need to do the following:

■ Create Application Users with the ASO Dispatcher Role

■ Create Employees ( ASO dispatchers, optionally ASO representatives)

■ Assign the ASO Representative Role to Employees

■ Create Resources with the ASO Representative Role

■ Assign a Human Resource to an Applications user ( ASO dispatcher)

■ Assign an Applications User to a Resource ( ASO dispatcher)

■ Create Dispatcher Groups

■ Create Territories (of ASO representatives)

■ Create Territories (of qualifiers)

■ Generate Territory Packages

■ Assign Territories (of ASO representatives) to a Dispatcher Group

3.3.1.1 Create Application Users with the ASO Dispatcher RoleIn order for a ASO dispatcher to access the Advanced Service Online ControlTower create it in Applications with the following values:

Steps1. Switch to the System Administrator responsibility.

2. Navigate to Security > User > Define.

3. Enter the Applications User Name and Password.

4. Make sure that on the responsibilities tab ASO Dispatcher is selected from thelist of values at Responsibility.

5. For more information on setup please refer to Oracle Applications SystemAdministrator’s Guide.

3.3.1.2 Create EmployeesYou need to define your ASO dispatchers as employees (human resources). It isoptional to define service representatives as employees. However you must define



service representatives as resources in order to assign tasks to them but they do notnecessarily have to be employees. This described in Create Resources with the ASORepresentative Role. There are two options for creating employees.

■ From Human Resources

■ From Resource Manager

When Human Resources is installed you cannot create employees from theResource Manager. However you will be able to maintain your employees fromResource Manager once they have been created in Human Resources.

Steps1. Switch to the ASO Administrator responsibility.

2. Navigate to CRM Foundation > Resource Manager > Maintain Employee >Employee. When Human Resource is installed, this will fail.

3. Switch to the HR Super User responsibility.

4. Navigate to People > Enter and Maintain.

5. For both applications you need to at least supply the following information:

■ Last Name: Last name of resource

■ Gender: Select from list of values

■ Type: select employee form list of values

■ Social Security: Social security number

■ Employee number

■ Birth Date

For set up details please refer to Oracle CRM Foundation Implementation Guide orOracle Human Resource Management Systems to enter and maintain employees.

6. To synchronize modifications made to the employee data in Human Resources,you need to run a concurrent program: Synchronize Employees. The changesmade in either Human Resources or Resource Manager are synchronized whenthey originate from the Human Resources application.

3.3.1.3 Assign the ASO Representative Role to EmployeesWhen you have defined your ASO representatives as employees, they need to beassigned the ASO representative role to show up in the ASO Control Tower. Usethe following procedure to assign the ASO representative role.




2. Navigate to CRM Foundation > Resource Manager > Maintain Resources >Import Resources.

3. At Resource Category select Employee.

4. Enter search criteria in the Resource Category region.

5. Click Search. The results are shown in the Search Results region.

6. Check the resource and click Create. The Default Values window is opened.

7. At Role select ASO Representative from the list of values.

8. Click OK.

9. Click Save Resource. A transaction number is displayed upon saving.

For additional set up details please refer to Oracle CRM FoundationImplementation Guide.

3.3.1.4 Create Resources with the ASO Representative RoleWhen you are working with ASO representatives that aren’t employees of yourcompany use this procedure. The ASO representatives need to be defined asresources with the ASO representative role assigned to show up in the ASO ControlTower.


2. Navigate to CRM Foundation > Resource Manager > Maintain Resources >Resources.

3. Click New.

4. Enter all the appropriate information. For set up details please refer to OracleCRM Foundation Implementation Guide.

5. On the Roles tab make sure the ASO Representative Role Type and Role areselected.

3.3.1.5 Assign a Human Resource to an Applications User ( ASO Dispatcher)The ASO dispatcher needs to be assigned his Application user account. Use eitherthis procedure or the next to establish this. We have already created a ASO



dispatcher Application user at the beginning and defined the ASO dispatcher as anemployee in human resources.


2. Navigate to Security > User > Define.

3. Search for the relevant Applications User Name.

4. At Person choose the human resource name from the list of values.

5. Save your work.

3.3.1.6 Assign an Applications User to a Resource ( ASO Dispatcher)When you haven’t used the previous procedure to assign the ASO dispatcher hisapplications user name use this procedure in Resource Management. We havealready created a ASO dispatcher Application user at the beginning and becausewe defined him as an employee he automatically is also defined as a resource.


2. Navigate to CRM Foundation > Resource Manager > Maintain Resources >Resources.

3. In the Resource region select Employee from the Category list of values.Optionally choose the ASO dispatchers Name.

4. Click Find. The Resource Search results window is opened.

5. Select the ASO dispatcher and click Resource Details. The Resource window isopened.

6. At User Name select the appropriate Applications user name from the list ofvalues.

7. Optionally you can assign the ASO Dispatcher Role Type and Role on the Rolestab. This is not mandatory for ASO dispatchers.

8. Save your work.

3.3.1.7 Create ASO Dispatcher GroupsCreate ASO dispatchers groups. These groups are used to assign territories ofservice representatives to. Once a territory of service representatives is assigned to a



dispatcher group it is shown to the ASO dispatcher in the ASO Control Tower. Adispatcher group can have one or more ASO dispatchers.


2. Navigate to CRM Foundation > Resource Manager > Maintain Resources >Groups.

3. At Name enter a name for the dispatcher group you are creating.

4. Enter a Description.

5. On the Members tab, select Employee from the Category list of values.

6. Enter the employee number for the ASO dispatcher you want to add to thisdispatcher group.

For set up details please refer to Oracle CRM Foundation Implementation Guide

7. Save your work.

3.3.1.8 Create Territories (of ASO Representatives)You need to create territories with ASO representatives assigned to them to be ableto connect to the dispatcher groups. Use this procedure to create territories of ASOrepresentatives.

Steps1. Change to the ASO Administrator responsibility.

2. Navigate to CRM Foundation > Territory Manager > TerritoryAdministration.

3. From the menu bar choose Administration > Define Territory.

4. On the Overview tab select Oracle Service from the list of values at Usage.

5. Enter a territory Name and Description.

6. At Transaction Type choose Service Request and Task from the list of values.

7. Select the Resources tab.

8. Enter all the ASO representatives you want to add to this territory.

For more information on setup please refer to Oracle CRM FoundationImplementation Guide.



9. Save your work.

3.3.1.9 Create Territories (of Qualifiers)Here you create territories to be used by the Assignment Manager and OracleScheduler to assign a task to a ASO representative in the most effective way.

To create territories that can be used by Advanced Service Online for schedulingpurposes you need to do the following:


2. Navigate to CRM Foundation > Territory Manager > TerritoryAdministration.

3. From the menu bar choose Administration > Define Territory.

4. On the Overview tab select Oracle Service from the list of values at Usage.

5. Enter a territory Name and Description.

6. At Transaction Type choose Service Request and Task from the list of values.

7. Navigate to the Transaction Qualifiers tab or Resource Qualifiers tab

For more information on setup please refer to Oracle CRM FoundationImplementation Guide.

3.3.1.10 Generate Territory PackagesWhen you have created territories you need to generate territory packages.


2. Navigate to Other > View Requests.

3. Check the All My Requests radio button.

4. Click Submit a New Request. The Submit a New Request window is opened.

5. Click Single Request. The Submit Request window is opened.

6. At Name select the Generate Territory Packages from the list of values.

7. At Parameters enter the following:

■ Usage: Oracle Service



■ Qualifier Type: Service Request and Task

■ Debug flag: Y

■ SQL Trace: Y

8. Click OK.

9. Click Submit.

10. To verify whether the Territory packages have been generated navigate to Other> View Requests.

11. Select All My Requests and click Find.

An overview is shown with the progress of the generating process. When thegeneration was successful it reads Completed.

3.3.1.11 Assign Territories to the Dispatcher GroupNavigate to the following page for details:

■ Assign Territories to Planner Groups



3.3.2 Assigning Territories to Planner GroupsThis setup screen is used to assign territories to planner groups. Planner groups area group of resources ( ASO dispatchers) dedicated to planning and are setup inResource Management. Territories consist of service representatives and are setup inTerritory Management. Once this is setup this is the default group of territories thatis shown to a planner group in the Control Tower.

PrerequisitesCreate a resource group with ASO dispatcher(s) assigned to it in ResourceManagement. Create a territory with service representatives assigned to it inTerritory Management.


2. Navigate to Setup > Assign Territories to Planner Groups. The Select PlannerGroup window is prompted.

3. Select the resource group that represents the planner group you want to assignterritories to from the list of values.

4. Click OK. The Assign Territories to Planner Groups window is opened.

5. Select a territory from the list of values you want to add to the planner group.You can add multiple territories to a planner group.

6. Save your work.

3.3.3 Generating Shift TasksGenerate Shift Tasks is a concurrent program used to create departure and arrivaltasks for each service representative. The departure and arrival tasks are used byScheduler to schedule tasks in between and calculate the travel time and distance inthe complete trip. These departure and arrival tasks are created based on the shiftsdefined for each service representative in Calendar, and normally use the servicerepresentatives home address for departure and arrival location.

Run this program for a specific period or choose to run it every night. Whenrunning this program for a specific period the Scheduler profile option CSR:Planscope is used to determine the length of the period for which the tasks arecreated in days. When running this program every night the profile optiondetermines how many days in advance the tasks are created.



Perform the following tasks:

■ Define an executable

■ Setup Concurrent Program

■ Generate Shift Tasks

3.3.3.1 Define an executable

Steps1. Logon with the ASO Administrator responsibility.

2. Navigate to Concurrent > Program > Executable.

3. Enter the following values into the fields:

4. Click Save.

3.3.3.2 Set Up Concurrent program


2. Navigate to Concurrent > Program > Define.

3. Enter the following values into the fields:

Field Value

Executable Generate Shift Tasks

Short Name CSFVGST

Description Free, e.g. Generates departure and arrival tasks for ASOrepresentatives within a specific time frame.

Execution Method PL/SQL Stored Procedure

Execution File Name CSF_SHIFT_TASKS_PVT.Generate_Shift_Tasks

Field Value

Program Generate Shift Tasks



4. Click Save.

3.3.3.3 Generate Shift Tasks

PrerequisitesSetup of shifts in CRM Foundation Calendar.

Steps1. From the Navigator, choose Setup.

2. Open Generate Shift Tasks. The Parameters screen is opened.

3. Enter the Start date of time frame if you want to run the program for a specificperiod. Clear the Start date of time frame field if you want to run the programevery night.

4. Click Ok. The Generate Shift Tasks setup screen is opened.

5. The Parameters field contains the entered start date of time frame or is emptywhen running the program every night.

6. Click Languages to change the language of the created tasks.

7. Click Schedule. The Schedule screen is opened.

8. Click Apply a Saved Schedule to use the settings of a previous saved schedule.

9. Choose one of the options at Run the Job.

10. Click Help for assistance.

11. Click OK when finished.

12. Click the Options button. The Upon Completion screen is opened.

Short Name CSFVGST

Application ASO

Description Free, e.g. Generates departure and arrival tasks for ASOrepresentatives within a specific time frame.

Executable Name CSFVGST

Executable Output format Text

Field Value



13. Click Help for assistance.

14. Click Submit when you have finished.

3.3.4 Resources Subinventories AssignmentThe resources to subinventories assignment screen is used to relate ASOrepresentatives to subinventories. For now resources will be service representatives,in future other type of resources might be available. When entering a materialtransaction in the ASO Report the subinventories for the service representative areshown.


2. Navigate to Spares Management > Resources Subinventories Assignment.

3. Enter the following values into the fields, perform these steps in sequentialorder.

Note: When the setup screen is opened you will be prompted toselect the code that applies for your organization. Make sure youchoose the right organization code because you will not be able tochange this once you have selected it.

Note: Updating a record results in the creation of a new record, requery to make the record visible. You cannot delete a record.

Step Field Value

1. Organization: Code This field is populated with the code that was selected atthe prompt the setup screen was opened.

2. Organization: Name The name of the organization will automatically bepopulated once the code of the organization is selected.

3. Resource Type Select a resource type from the list of values.

4. Resource Select a service representative from the list of values.

5. Subinventory Select the subinventory you want to assign to the servicerepresentative.



4. Click Save.

3.3.5 Defining Material Justification CodesMaterial Justification codes are setup for ASO Report. These justification codes areoffered to the user from the Reason list of values when creating a materialtransaction line on the ASO Report Materials tab.

PrerequisitesNone.


2. Navigate to ASO Report > Define Material Justification Codes.

The Application Object Library: CSF _MATERIAL_REASON Lookups screen isopened.

3. The Type field is defaulted.

4. The User Name is displayed. It is used by loader programs.

5. The Application is defaulted.

6. In the Description field a description is given. You can modify this description.

7. In the Access Level region it is defined what changes are possible to a lookuptype.

■ User: You can change any lookup code.

6. Default Select IN for good subinventory, OUT for bad subinventoryand nothing for all other subinventories.

7. Startdate Select the start date for the assignment to be effective.

8. Enddate Select the end date for the assignment to be effective.

Note: Please don’t confuse with the Return Reason field on theMaterial tab from ASO Report.

Step Field Value



■ Extensible: New lookup codes can be added. However, you cannot modifyseeded lookup codes.

■ System: No changes to the lookup codes are allowed.

8. Create material justification lookup lines by entering the following informationin the lower region on the window:

9. Check Enabled for each line you want to activate.

10. The double brackets ([ ]) identify a descriptive flexfield that you can use to adddata fields to this window without programming.

11. Click Save.

Field Value

Code Enter the code value for your Lookup. You can define amaximum of 250 Lookups for a single Lookup type. When youenter a valid Lookup meaning into a displayed window field,Lookups stores this code into a corresponding hidden field. Forexample, the Lookup “Y” displays the meaning “Yes” but storesthe code value “Y” in a hidden field.

You cannot change the values in this field after committingthem. To remove an obsolete Lookup you can either disable thecode, enter an end date, or change the meaning and descriptionto match a replacement code.

Meaning When you enter a valid Lookup meaning into a displayedwindow field, Lookups stores the corresponding code into ahidden field. Lookups automatically displays the meaning inyour Lookups field whenever you query your window. Forexample, the Lookup “Y” displays the meaning “Yes” but storesthe code value “Y” in a hidden field.

Description You can display the description along with the meaning to givemore information about your Lookup.

Tag Optionally enter in a tag to describe your lookup. The tag can beused to categorize lookup values.

From and To Enter the dates between which this Lookup becomes active. Ifyou do not enter a start date, your Lookup is valid immediately.

Once a Lookup expires, users cannot insert additional recordsusing the Lookup, but can query records that already use theLookup. If you do not enter an end date, your Lookup is validindefinitely.



3.3.6 Defining Labor Justification CodesLabor Justification codes are setup for ASO Report. These justification codes areoffered to the user from the Reason list of values when creating a labor transactionline on the ASO Report Labor tab.

PrerequisitesNone.


2. Navigate to ASO Report > Define Labor Justification Codes.

The Application Object Library: CSF _LABOR_REASON Lookups screen isopened.









8. Create labor justification lookup lines by entering the following information inthe lower region on the window:





11. Click Save.

3.3.7 Defining Expense Justification CodesExpense Justification codes are setup for ASO Report. These justification codes areoffered to the user from the Justification list of values when creating an expensetransaction line on the ASO Report Expense tab.

Field Value










PrerequisitesNone.


2. Navigate to ASO Report > Define Expense Justification Codes.

The Application Object Library: CSF _EXPENSE_REASON Lookups screen isopened.









8. Create expense justification lookup lines by entering the following informationin the lower region on the window:

Field Value







11. Click Save.

3.3.8 Profile OptionsThe following profile options are unique to Advanced Service Online.


2. Navigate to Profile > System. The Find System Profile screen is opened.

3. Check Site.






Note: The profile options numbered 1 to 4 regarding task statuseshave seeded values. There is no immediate need to set these updifferently. When a new status flow is implemented these profileoptions need to be changed to match the change in state transitions.

Field Value



4. At Profile enter CSF%.

5. Click Find.

You can set the profile options described in the following table in any sequence.

Profile Option Description

1. CSF: Default New tasksstatus

Default status that is assigned to a new task.

2. CSF: Default “In planning”task status

Default status that is assigned to tasks that are set to“In planning” in the ASO Control Tower.

3. CSF: Default Assigned taskstatus

Default status that is assigned to tasks that are set to“Assigned” in the ASO Control Tower.

4. CSF: Default Cancelledtasks status

Default status that is assigned to tasks that are set to“Canceled” in the ASO Control Tower.

5. CSF: Address of theDatabase machine

Enter the address of the hosting database machine.

6. CSF: Address of the Mapserver

Enter the address of the MapXtreme server.

7. CSF: Return Reason Used to default a Return Reason on the ASO Reportwindow for a material line created. Select which oneshould be defaulted from the list of values. It’s amandatory field for Order Management. Especiallyuse this profile option when working with one of themobile applications.

8. CSF: Default StatusResponsibility

Choose a default responsibility to define which statetransition rule is used. This profile option is set forthe users from the mobile applications.

9. CSF: Database port toreceive data

Enter the port number of the hosting database.

10. CSF: Default travel distancefor Time Distance Server

If no geocode exist for a task the value is used as thedefault travel distance between two tasks.

Note: When a value is entered this is always usedto indicate travel distance and overrules thecapability to calculate it with the Time DistanceServer.



11. CSF: Default travelduration for Time DistanceServer

If no geocode exist for a task the value is used as thedefault travel duration between two tasks.

Note: When a value is entered this is always usedto indicate travel duration and overrules thecapability to calculate it with the Time DistanceServer.

12. CSF: History_L Define the number of days for data to remain onField Service/Laptop without editing it. When thenumber of days has expired it is removed from theField Service/Laptop by the CRM Gateway forMobile Devices.

13. CSF: History_M Define the number of days for data to remain onField Service/PalmTM Devices without editing it.When the number of days has expired it is removedfrom the Field Service/PalmTM Devices by the CRMGateway for Mobile Devices.

14. CSF: InstalledBaseProduct_L

Define what information from the Installed Base youwant to send to Field Service/Laptop:

■ 1 for just the product related to the ServiceRequest.

■ 2 for the product related to the Service Requestand the parent products.

■ 3 for the product related to the Service Request,the children, and parent products.

15. CSF: InstalledBaseProduct_M

Define what information from the Installed Base youwant to send to Field Service/PalmTM Devices:

■ 1 for just the product related to the ServiceRequest.

■ 2 for the product related to the Service Requestand the parent products.

16. CSF: Last used service areaon the map

This value is set automatically to store the last usedservice area on the map.

17. CSF: Location FinderInstalled

Value set to check if the location finder is installed. Itis launched when a location for a task is missing, seeprofile option CSR: Create location.

18. CSF: Map Left TopX-coordinate

The top left x-coordinate of the shown area on theASO Map. This value is set automatically.




19. CSF: Map Left TopY-coordinate

The top left y-coordinate of the shown area on theASO Map. This value is set automatically.

20. CSF: Map Move Factor(between 0.1 and 1)

Define how much you want the ASO Map to movewhen using the navigation left/right and up/downarrows. Choose a value between 0.1 and 1.0(centimeters).

21. CSF: Map Right BottomX-coordinate

The bottom right x-coordinate of the shown area onthe ASO Map. This value is set automatically.

22. CSF: Map Right BottomY-coordinate

The bottom right y-coordinate of the shown area onthe ASO Map. This value is set automatically.

23. CSF: Replicate_Categories_L

Define if you want to replicate item categories toField Service/Laptop:

■ 1 is Yes.

■ 2 is No.

24. CSF: Resource progressdelay margin

Add a value for the period of time, minutes, aresource is allowed to be late in his trip before it isescalated. This affects the instant shown status of theresources on the ASO Map.

25. CSF: SID of the database Enter the database name.

26. CSF: Selected territories This value is set automatically to store the territoriesselected and show them to the planner when thecontrol tower is started.

27. CSF: Web server addresswhere the images are storedfor the map

Enter the address of the web server where the imagesare stored. The images are used to show instant statusof the resource on the ASO Map.

28. CSF: Time distance cacheradius

Leave empty.

29. CSF: Time distance servercalculation factor

If the factor is set the Time Distance Server calculatestravel distance and duration faster but less accurate.

30. CSF: The unit of measurefor hour

The setting of the unit of measure for hours must beentered and correspond with the MTL_UNITS_OFMEASURE. Default setting is HRS (hours).

31. CSF: The unit of measurefor minutes

The setting of the unit of measure for minutes mustbe entered and correspond with the MTL_UNITS_OFMEASURE. Default setting is MIN (minutes).





Document Index Public

A
Document Index Public APIs
Documentation is required to support various functions in MRO Industry. To Sharethe document information between various business objects, the documents mustbe registered in one area which is maintained by Document Index module.

Document Index consists of several external documents that are provided bysuppliers on a subscription basis. These documents may consists of various formatswhich should be tracked. Document information should be upto date and accurate.To keep track of document Information it supports revision control features

Document Index module maintains new document information along withsuppliers, recipients and will be able to update the document information It alsosupports adding new suppliers and distribution of documents.

Document index module maintains the status of subscription of a document for anassociated supplier. This also maintains document revision information accurateand up to date.

Document Index module also defines which document and revision relate to anASO Object such as Route, Operation or Master Config etc

A.1 Document Index Public PackagesAhl_Di_Doc_Index_Pub consists of create document and modify documentprocedures. These are required to validate some of input data, in order to preventthe flow of invalid data. Value -ID conversion is the first step in both the proceduresor vice versa, which depends on calling program. Once all the value basedparameters are converted into their equivalent IDs then it calls the ahl_di_doc_index_pvt Api to create new document record, if required supplier and distributionas well.

APIs A-1

Document Index Public Packages

The modify document procedure also validates input data and does the value-to- Idconversion, if necessary calls ahl_di_doc_index_pvt API to update documentinformation, if nessasry supplier and recipient

Ahl_Di_Subscription_Pub consists of create subscriptions and modify subscriptionsprocedures. These are required to validate some of input data, inorder to preventthe flow of invalid data. Value -ID conversion is the first step in both the proceduresor vice versa, which depends on calling program. Once all the value basedparameters are converted into their equivalent Ids then it calls the ahl_di_subscription_pvt Api to create new subscription record for an associated document.

Modify subscriptions procedure also validates input data and does the value to Idconversion, if necessary calls ahl_di_subscription_pvt Api to update subscriptioninformation for an associated document

Ahl_Di_Revision_Pub consists of create revisions and modify revisions procedures.These are required to validate some of input data, inorder to prevent the fllow ofinvalid data. Value -ID conversion is the first step in both the procedures or viceversa, which depends on calling program. Once all the value based parameters areconverted into their equivalent Ids then it calls the ahl_di_revision_pvt Api to createnew revision control record for an associated document.

Modify revision procedure also validates input data and does the value to Idconversion, if necessary calls ahl_di_revision_pvt Api to update revisioninformation for the given specifications

Ahl_Di_Pro_Type_Aso_Pub consists of create doc type assoc and modify doc typeassoc procedures. These are required to validate some of input data, inorder toprevent the fllow of invalid data. Value -ID conversion is the first step in both theprocedures or vice versa, which depends on calling program. Once all the valuebased parameters are converted into their equivalent Ids then it calls the ahl_di_pro_type_aso_pvt Api to create new document type and document sub typeassociation record for the given specifications.

Modify doc type assoc procedure also validates input data and does the value to Idconversion if necessary, then calls ahl_di_pro_type_aso_pvt Api to update orremove any association between document type and socument sub type for thegiven specifications

Ahl_Di_Asso_Doc_Aso_Pub consists of create association and modify associationprocedures. These are required to validate some of input data, inorder to preventthe fllow of invalid data. Value -ID conversion is the first step in both theprocedures or vice versa, which depends on calling program. Once all the valuebased parameters are converted into their equivalent Ids then it calls the ahl_di_

A-2 Product Title/BookTitle as a Variable

Document Index Public Packages

asso_doc_aso_pvt Api to create document title association record for an aso objectlike Route , Master Config or Operation.

Modify association procedure also validates input data and does the value to Idconversion, if necessary and calls ahl_di_asso_doc_aso_pvt Api to updatedocument title association information for the given specifications

■ AHL_DI_DOC_INDEX_PUB, see Table 1-1, “Document Index APIs”

■ AHL_DI_SUBSCRIPTION_PUB, see Table 1-2, “Subscription APIs”

■ AHL_DI_REVISION_PUB, see Table 1-3, “Revision APIs”

■ AHL_DI_PRO_TYPE_ASO_PUB, see Table 1-4, “Doc Type Assos APIs”

■ AHL_DI_ASSO_DOC_ASO_PUB, see Table 1-5, “Document Title Assos APIs”

The following tables describe the public APIs discussed in this chapter.

Table1-1 AHL_DI_DOC_INDEX_PUB APIs

Table1-2 AHL_DI_SUBSCRIPTION_PUB APIs

Table1-3 AHL_DI_REVISION_PUB APIs

Name Description

CreateDocument

This procedure creates a Document with the given specifications. It also creates theSuppliers and Recipients.

ModifyDocument

This procedure updates a Document with the given specifications. It also updates andRemoves Suppliers and Recipients for the associated Document

Name Description

CreateSubscriptions

This procedure creates a Subscription for an associated document with the givenspecifications.

ModifySubscriptions

This procedure updates the Subscription for an associated document.

Name Description

CreateRevisions

This procedure creates a Revision with the given specifications for an associateddocument.

Document Index Public APIs A-3

Package Ahl_Di_Doc_Index_Pub

Table1-4 AHL_DI_PRO_TYPE_ASO_PUB APIs

Table1-5 AHL_DI_ASSO_DOC_ASO_PUB APIs

A.2 Package Ahl_Di_Doc_Index_Pub■ Create_Document

■ Modify_Document

A.2.1 Create_DocumentThis is used to register document index record and its associated suppliers andrecipients

Procedure Specification

PROCEDURE Create_Document

(

p_api_version in number,

p_init_msg_list in varcahr2 default fnd_api.g_true,

p_commit in varchar2 default fnd_api.g_false,

ModifyRevisions

This procedure updates a Revision with the given specifications

Name Description

Create Doc Type Assoc This procedure creates a Document Type Associations with the given specifications.

Modify Doc TypeAssoc

This procedure updates a Document Type Associations for any given specifications.It also Removes Document Type Associatiions, If the type is not associated withdocument index

Name Description

CreateAssociation

This procedure creates a Document title association with the given specifications forRoute and Master Config.

ModifyAssociation

This procedure updates and Removes Document title association with the givenspecifications for Route and Master Config.



p_validate_only in varchar2 default fnd_api.g_true,

p_validation_level in number default fnd_api.g_valid_level_full,

p_x_document_tbl in out nocopy document_tbl,

p_x_supplier_tbl in out nocopy supplier_tbl,

p_x_recipient_tbl in out nocopy recipient_tbl,

p_module_type in varchar2,

x_return_status out varchar2,

x_msg_count out number,

x_msg_data out varchar2

);

Current Version

1.0

Parameter DescriptionsThe following table describes the IN parameters associated with this API.

Table 2-1-1 Create_Document IN Parameters

Parameter Data Type Required Descriptions and Validations

p_api_version NUMBER Yes Standard IN Parameter. This parameter is used by the API tocompare the version numbers of incoming calls to its currantversion number, and return an unexcepted error if they areincompatible

p_init_msg_list VARCHAR2 No Standard IN Parameter. This allows initialization of themessage list

p_commit VARCHAR2 No Standard IN Parameter. This parameter is used to committhe data changes after performing its function, if it is set totrue

p_valid_only VARCHAR2 No Standard IN Parameter. This parameter is used to defineintermediate levels as needed Value should fall between thenumbers 0 and 100.

p_validation_level

NUMBER No Standard IN Parameter. This parameter is used to determinewhich validation steps should be executed. Main reason toavoid duplicating some of validations



The following table describes the IN OUT parameters associated with this API

Table2-1-2 Create_Document In Out Parameters

The following table describes the OUT parameters associated with this API

Table2-1-3 Create_Document Out Parameters

A.2.2 Modify_DocumentThis is used to update document information for the given specifications. It alsoupdates and removes supplier and distributions for an associated document.


PROCEDURE Modify_Document

(

p_module_type VARCHAR2 Yes Indicates Front End Form Interface.If its JSP, this will nullfyID values and validations are done using Meaning(forinternal only)

Parameter Data Type Descriptions

p_x_document_tbl DOCUMENT_TBL Document table is defined based on document record, which holds allattributes of document index object

p_x_supplier_tbl SUPPLIER_TBL Supplier table is defined based on supplier reocrd, which holds allattributes belongs to supplier object

p_x_recipient_tbl RECIPIENT_TBL Recipient table is defined based on recipient record, which holds allattributes belongs to recipient object


x_return_status

VARCHAR2

Standard OUT Parameter. This parameter represents the result of all theoperations performed by the API with the following values

‘S’ Success, ‘E’ Error, or ‘U, Unexpected Error

x_msg_count NUMBER Standard OUT Parameter. This parameter holds the number of messages inthe API message list

x_msg_data VARCHAR2

Standard OUT Parameter. This parameter holds the message data, if themessage number is one or more








p_x_document_tbl in out nocopy document_tbl,

p_x_supplier_tbl in out nocopy supplier_tbl,

p_x_recipient_tbl in out nocopy recipient_tbl,





);

Current Version1.0


Table 2-2-1 Modify_Document IN Parameters


p_api_version NUMBER Yes Standard IN Parameter. This parameter is used by the APIto compare the version numbers of incoming calls to itscurrant version number, and return an unexcepted error ifthey are incompatible

p_init_msg_list VARCHAR2

No Standard IN Parameter. This allows initialization of themessage list

p_commit VARCHAR2

No Standard IN Parameter. This parameter is used to committhe data changes after performing its function, if it is set totrue

p_valid_only VARCHAR2

No Standard IN Parameter. This parameter is used to defineintermediate levels as needed Value should fall betweenthe numbers 0 and 100.


Package Ahl_Di_Subscription_Pub

The following table describes the IN OUT parameters associated with this API.

Table 2-2-2 Modify_Document In Out Parameters

The following table describes the OUT parameters associated with this API.

Table2-2-3 Modify_Document Out Parameters

A.3 Package Ahl_Di_Subscription_Pub■ Create_Subscriptions

■ Modify_Subscriptions

p_validation_level

NUMBER No Standard IN Parameter. This parameter is used todetermine which validation steps should be executed. Mainreason to avoid duplicating some of validations

p_module_type VARCHAR2

Yes Indicates Front End Form Interface.If its JSP, this willnullfy ID values and validations are done usingMeaning(for internal only)


p_x_document_tbl

DOCUMENT_TBL

Document table is defined based on document record, which holdsall attributes of document index object

p_x_supplier_tbl SUPPLIER_TBL Supplier table is defiend based on supplier record type, whichcollects all attributes of supplier object

p_x_recipient_tbl RECIPIENT_TBL Recipient table is based on recipient record type, which collects allattributes of recipient object


x_return_status VARCHAR2




x_msg_data VARCHAR2




A.3.1 Create_SubscriptionsThis is used to create subscription information for an associated document, for thegiven specifications


PROCEDURE Create_Subscriptions

(






p_x_subscription_tbl in out nocopy subscription_tbl,





);

Current Version

1.0

Parameter Descriptions

The following table describes the IN parameters associated with this API

Table3-2-1 Create_Subscriptions IN Parameters








Table3-1-2 Create_Subscriptions In Out Parameters


Table3-1-3 Create_Subscriptions Out Parameters

A.3.2 Modify_SubscriptionsThis procedure is used to update the subscription info for the given specifications

p_commit VARCHAR2



No Standard IN Parameter. This parameter is used to defineintermediate levels as needed Value should fall between thenumbers 0 and 100.

p_validation_level



Yes Indicates Front End Form Interface.If its JSP, this will nullfyID values and validations are done using Meaning(forinternal only)


p_x_subscription_tbl

SUBSCRIPTION_TBL

Subscription table is defined based on subscription record type,which holds all attributes of subscription object


x_return_status

VARCHAR2




x_msg_data VARCHAR2





PROCEDURE Modify_Subscriptions

(






p_x_subscription_tbl in out nocopy subscription_tbl,





);

Current Version

1.0


Table3-2-1 Modify_Subscriptions IN Parameters





p_commit VARCHAR2

No Standard IN Parameter. This parameter is used to commit thedata changes after performing its function, if it is set to true




Package Ahl_Di_Revision_Pub


Table3-2-1 Modify_Subscriptions In Out Parameters


Table3-2-2 Modify_Subscriptions Out Parameters

A.4 Package Ahl_Di_Revision_Pub■ Create_Revisions

■ Modify_Revisions

A.4.1 Create_RevisionsThis procedure creates a Revision with the given specifications for an associateddocument.

p_validation_level





p_x_subscription_tbl

SUBSCRIPTION_TBL

Subscription table is defined based on subscription record type,which holds all attributes of subscription object


x_return_status

VARCHAR2




x_msg_data VARCHAR2





PROCEDURE Create_Revisions

(





p_validation_level in number default

fnd_api.g_valid_level_full,

p_x_revision_tbl in out nocopy revision_tbl,





);

Current Version

1.0


Table4-1-1 Create_Revisions IN Parameters


p_api_version NUMBER Yes Standard IN Parameter. This parameter is used by the APIto compare the version numbers of incoming calls to itscurrant version number, and return an unexcepted error ifthey are incompatible



p_commit VARCHAR2





Table4-1-2 Create_Revisions In Out Parameters


Table4-1-3 Create_Revisions Out Parameters

A.4.2 Modify_RevisionsThis procedure updates the Revision record with the given specifications for anassociated document.



p_validation_level





p_x_revision_tbl

REVISION_TBL

Revision table is defined based on revision record type, which holds allattributes belongs to revision object


x_return_status VARCHAR2 Standard OUT Parameter. This parameter represents the result of all theoperations performed by the API with the following values


x_msg_count NUMBER Standard OUT Parameter. This parameter holds the number of messages in theAPI message list

x_msg_data VARCHAR2 Standard OUT Parameter. This parameter holds the message data, if themessage number is one or more



A.4.2.1 Procedure SpecificationPROCEDURE Modify_Revisions

(





p_validation_level in number default

fnd_api.g_valid_level_full,

p_x_revision_tbl in out nocopy revision_tbl,





);

Current Version

1.0


Table4-2-1 Modify_Revisions IN Parameters



p_init_msg_list VARCHAR2 No Standard IN Parameter. This allows initialization of themessage list

p_commit VARCHAR2 No Standard IN Parameter. This parameter is used to commit thedata changes after performing its function, if it is set to true


Package Ahl_Di_Pro_Type_Aso_Pub


Table4-2-2 Modify_Revisions In Out Parameters


Table4-2-3 Modify_Revisions Out Parameters

A.5 Package Ahl_Di_Pro_Type_Aso_Pub■ Create_Association

■ Modify_Association

p_valid_only VARCHAR2 No Standard IN Parameter. This parameter is used to defineintermediate levels as needed Value should fall between thenumbers 0 and 100.

p_validation_level NUMBER No Standard IN Parameter. This parameter is used to determinewhich validation steps should be executed. Main reason toavoid duplicating some of validations

p_module_type VARCHAR2 Yes Indicates Front End Form Interface.If its JSP, this will nullfyID values and validations are done using Meaning(for internalonly)


p_x_revision_tbl

REVISION_TBL

Revision table is defined based on revision record type, which holds allattributes belongs to revision object


x_return_status

VARCHAR2




x_msg_data VARCHAR2




A.5.1 Create_AssociationThis procedure creates a Document Type and Document Subtype associations withthe given specifications


PROCEDURE Create_Doc_Type_Assoc

(






p_x_doc_type_assoc_tbl in out nocopy doc_type_assoc_tbl,





);

Current Version

1.0


Table5-1-1 Create_Doc_Type_Assoc IN Parameters

Parameter Data Type Required

Descriptions and Validations



No Standard IN Parameter. This allows initialization of the messagelist




Table5-1-2 Create_Doc_Type_Assoc In Out Parameters


Table5-1-3 Create_Doc_Type_Assoc Out Parameters

p_commit VARCHAR2




p_validation_level



Yes Indicates Front End Form Interface.If its JSP, this will nullfy IDvalues and validations are done using Meaning(for internalonly)


p_x_doc_type_assoc_tbl

DOC_TYPE_ASSOC_TBL

Document type associations is defined based on doc typeassociation record, which holds all attributes belongs to doctype and sub type associations


x_return_status

VARCHAR2




x_msg_data VARCHAR2




A.5.2 Modify_Doc_Type_AssocThis procedure updates and removes a Document Type and Document Subtypeassociations, if the associate type doesnt exist for a document


PROCEDURE Modify_Doc_Type_Assoc

(






p_x_doc_type_assoc_tbl in out nocopy doc_type_assoc_tbl,





);

Current Version

1.0


The following table describes the IN parameters associated with this API.

Table5-2-1 Modify_Doc_Type_Assoc IN Parameters









Table5-2-2 Modify_Doc_Type_Assoc In Out Parameters


Table5-2-3 Modify_Doc_Type_Assoc Out Parameters

p_commit VARCHAR2




p_validation_level





p_x_doc_type_assoc_tbl

DOC_TYPE_ASSOC_TBL

Document type associations is defined based on doc typeassociation record, which holds all attributes belongs to doctype and sub type associations


x_return_status

VARCHAR2




x_msg_data VARCHAR2




A.6 Package Ahl_Di_Pro_Type_Aso_Pub■ Create_Association

■ Modify_Association

A.6.1 Create_AssociationThis procedure creates a Document title association with the given specifications foran ASO object like Route, Operations and Master Config.


PROCEDURE Create_Association

(






p_x_association_tblin out nocopy association_tbl,





);

Current Version

1.0





Table6-1-1 Create_Association IN Parameters


Table6-1-2 Create_Association In Out Parameters





p_commit VARCHAR2




p_validation_level





p_x_association_tbl

ASSOCIATION_TBL

Association table is defined based on document title associationrecord, which holds all attributes belongs to title association




Table6-1-3 Create_Association Out Parameters

A.6.2 Modify_AssociationThis procedure updates and deltes a Document title association with the givenspecifications for an Aso object like Route, Operations and Master Config.


PROCEDURE Modify_Association

(






p_x_association_tblin out nocopy association_tbl,





);

Current Version

1.0


x_return_status

VARCHAR2




x_msg_data VARCHAR2





Table6-2-1 Modify_Association IN Parameters


Table6-2-2 Modify_Association In Out Parameters


Table6-2-3 Modify_Association Out Parameters





p_commit VARCHAR2




p_validation_level





p_x_association_tbl

ASSOCIATION_TBL

Association table is defined based on document title associationrecord, which holds all attributes belongs to title association



Data Structure Specifications

A.7 Data Structure SpecificationsThe following data structures are used in AHL_DI_DOC_INDEX_PUB:

■ Doc_rec

■ Supplier_rec

■ Recipient_rec

■ Document_tbl

■ Supplier_tbl

■ Recipient_tbl

The following data structures are used in AHL_DI_SUBSCRIPTION_PUB:

Subscription_rec

Subscription_tbl

The following data structures are used in AHL_DI_REVISION_PUB:

■ Revision_rec

■ Revision_tbl

The following data structures are used in AHL_DI_PRO_TYPE_ASO_PUB:

■ Doc_type_assoc_rec

■ Doc_type_assoc_tbl

The following data structures are used in AHL_DI_ASSO_DOC_ASO_PUB:

■ Association_rec

■ Association_tbl

x_return_status

VARCHAR2




x_msg_data VARCHAR2




A.7.1 Doc_RecDefines reocrd type for document index

Record Specification

TYPE doc_rec IS RECORD

(

document_id number := fnd_api.g_miss_num,

source_party_id number := fnd_api.g_miss_num,

source_party_name varchar2(80) := fnd_api.g_miss_char,

doc_type_code varchar2(30) := fnd_api.g_miss_char,

doc_type_desc varchar2(80) := fnd_api.g_miss_char,

doc_sub_type_code varchar2(30) := fnd_api.g_miss_char,

doc_sub_type_desc varchar2(80) := fnd_api.g_miss_char,,

document_no varchar2(30) := fnd_api.g_miss_char,

operator_code varchar2(30) := fnd_api.g_miss_char,

operator_desc varchar2(80) := fnd_api.g_miss_char,

product_type_code varchar2(30) := fnd_api.g_miss_char,

product_type_desc varchar2(80) := fnd_api.g_miss_char,

subscribe_avail_flag varchar2(1) := fnd_api.g_miss_char,

subscribe_to_flag varchar2(1) := fnd_api.g_miss_char,

document_title varchar2(80) := fnd_api.g_miss_char,

language varchar2(4) := fnd_api.g_miss_char,

source_lang varchar2(4) := fnd_api.g_miss_char,

security_group_id number := fnd_api.g_miss_num,

object_version_number number := fnd_api.g_miss_num,

attribute_category varchar2(30) := fnd_api.g_miss_char,

attribute1 varchar2(150) := fnd_api.g_miss_char,

















delete_flag varchar2(1) := 'n',

process_flag varchar2(1) := 'y'

);

A.7.2 Supplier_RecDefines record type for supplier


TYPE supplier_rec IS RECORD

(

supplier_document_id number := fnd_api.g_miss_num,

supplier_id number := fnd_api.g_miss_num,

supplier_name varchar2(80) := fnd_api.g_miss_char,


preference_code varchar2(30) := fnd_api.g_miss_char,

preference_desc varchar2(80) := fnd_api.g_miss_char,






















);

A.7.3 Recipient_RecDefines record type for recipient


TYPE recipient_rec IS RECORD

(

recipient_document_id number := fnd_api.g_miss_num,

recipient_party_id number := fnd_api.g_miss_num,

recipient_party_name varchar2(80) := fnd_api.g_miss_char,























);

A.7.4 Subscription_RecDefines record type for subscription


TYPE subscription_rec IS RECORD

(

subscription_id number := fnd_api.g_miss_num,


status_code varchar2(80) := fnd_api.g_miss_char,

status_desc varchar2(80) := fnd_api.g_miss_char,

requested_by_party_id number := fnd_api.g_miss_num,

requested_by_pty_name varchar2(80) := fnd_api.g_miss_char,

quantity number := fnd_api.g_miss_num,

frequency_code varchar2(30) := fnd_api.g_miss_char,

frequency_desc varchar2(80) := fnd_api.g_miss_char,

subscribed_frm_party_id number := fnd_api.g_miss_num,

subscribed_frm_pty_name varchar2(80) := fnd_api.g_miss_char,

start_date date := fnd_api.g_miss_date,

end_date date := fnd_api.g_miss_date,

purchase_order_no varchar2(20) := fnd_api.g_miss_char,

subscription_type_code varchar2(30) := fnd_api.g_miss_char,

subscription_type_desc varchar2(80) := fnd_api.g_miss_char,

media_type_code varchar2(30) := fnd_api.g_miss_char,

media_type_desc varchar2(80) := fnd_api.g_miss_char,






















);

A.7.5 Revision_RecDefines record type for revision


TYPE revision_rec IS RECORD

(

doc_revision_id number := fnd_api.g_miss_num,


revision_no varchar2(80) := fnd_api.g_miss_char,

revision_type_code varchar2(30) := fnd_api.g_miss_char,

revision_type_desc varchar2(80) := fnd_api.g_miss_char,

revision_status_code varchar2(30) := fnd_api.g_miss_char,

revision_status_desc varchar2(80) := fnd_api.g_miss_char,



revision_date date := fnd_api.g_miss_date,

approved_by_party_id number := fnd_api.g_miss_num,

approved_by_pty_name varchar2(80) := fnd_api.g_miss_char,

approved_date date := fnd_api.g_miss_date,

effective_date date := fnd_api.g_miss_date,

obsolete_date date := fnd_api.g_miss_date,

issue_date date := fnd_api.g_miss_date,

received_date date := fnd_api.g_miss_date,

url varchar2(240) := fnd_api.g_miss_char,

media_type_code varchar2(30) := fnd_api.g_miss_char,

media_type_desc varchar2(80) := fnd_api.g_miss_char,

volume varchar2(150) := fnd_api.g_miss_char,

issue varchar2(30) := fnd_api.g_miss_char,

issue_number number := fnd_api.g_miss_num,

language varchar2(4) := fnd_api.g_miss_char,


comments varchar2(2000) := fnd_api.g_miss_char,






















);

A.7.6 Doc_Type_Assoc_RecDefines record type for document type and sub types


TYPE doc_type_assoc_rec IS RECORD

(

document_sub_type_id number := fnd_api.g_miss_num,

doc_type_code varchar2(30) := fnd_api.g_miss_char,

doc_type_desc varchar2(80) := fnd_api.g_miss_char,

doc_sub_type_code varchar2(30) := fnd_api.g_miss_char,

doc_sub_type_desc varchar2(80) := fnd_api.g_miss_char,






















);

A.7.7 Association_RecDefines record type for document title associations for aso object route and masterconfig


TYPE association_rec IS RECORD

(

doc_title_asso_id number := fnd_api.g_miss_num,


document_no varchar2(80) := fnd_api.g_miss_char,

doc_revision_id number := fnd_api.g_miss_num,

revision_no varchar2(30) := fnd_api.g_miss_char,

use_latest_rev_flag varchar2(1) := fnd_api.g_miss_char,

aso_object_type_code varchar2(30) := fnd_api.g_miss_char,

aso_object_desc varchar2(80) := fnd_api.g_miss_char,

aso_object_id number := fnd_api.g_miss_num,

serial_no varchar2(30) := fnd_api.g_miss_char,


chapter varchar2(30) := fnd_api.g_miss_char,

section varchar2(30) := fnd_api.g_miss_char,

subject varchar2(240) := fnd_api.g_miss_char,

page varchar2(5) := fnd_api.g_miss_char,

figure varchar2(30) := fnd_api.g_miss_char,

note varchar2(2000):= fnd_api.g_miss_char,






















);

A.7.8 Document_tblThis table contains records with attributes of a Document

Table Specification

TYPE document_tbl IS TABLE OF doc_rec INDEX BY BINARY_INTEGER

A.7.9 Supplier_tblThis table contains records with attributes of a Supplier for a document

Table Specification

TYPE supplier_tbl IS TABLE OF supplier_rec INDEX BY BINARY_INTEGER

A.7.10 Recipient_tblThis table contains records with attributes of a Recipient for a document

Table Specification

TYPE recipient_tbl IS TABLE OF recipient_rec INDEX BY BINARY_INTEGER

A.7.11 Subscription_tblThis table contains records with attributes of a Subscription for a document

Table Specification


Messages and Notifications

TYPE subscription_tbl IS TABLE OF subscription_rec INDEX BY BINARY_INTEGER

A.7.12 Revision_tblThis table contains records with attributes of a Revision for a document

Table Specification

TYPE revision_tbl IS TABLE OF revision_rec INDEX BY BINARY_INTEGER

A.7.13 Doc_Type_Assoc_tblThis table contains records with attributes of a document type and Sub type

Table Specification

TYPE doc_type_assoc_tbl IS TABLE OF doc_type_assoc_rec INDEX BY BINARY_INTEGER

A.7.14 Association_tblThis table contains records with attributes of a document title association for anyASO object like Route, Master configuration or Operation

Table Specification

TYPE association_tbl IS TABLE OF association_rec INDEX BY BINARY_INTEGER

A.8 Messages and NotificationsThe status messages associated with the Document Index public APIs are:

■ Common Messages

■ Messages used in AHL_DI_DOC_INDEX_PUB

■ Messages used in AHL_DI_SUBSCRIPTION_PUB

■ Messages used in AHL_DI_REVISION_PUB

■ Messages used in AHL_DI_PRO_TYPE_ASO_PUB

■ Messages used in AHL_DI_ASSO_DOC_ASO_PUB



A.8.1 Common MessagesThe following table describes a lists of common error messages and notificationsthat the Document Index API can generate. Note that not all messages are returnedby all APIs.

A.8.1.1 Common API Messages

A.8.2 Ahl_Di_Doc_Index_PubError messages for ahl_di_doc_index_pub.

A.8.2.1 API Messages

Number Type Name Text

399394 E AHL_DI_ISSUENO_FOR Issue Number must be an integer!

399395 E AHL_DI_QUANTITY_FOR Quantity must be an integer!

399396 E AHL_DI_NO_DOC_SEL No Document is selected. please select aDocument

399397 E AHL_DI_SAVE_PROMPT Please save your changes to proceed

399398 E AHL_DI_NO_TYPE_SEL Please select document type for association

399399 E AHL_DI_NO_ROW_SEL_DEL

No row is selected to be removed


399355 E AHL_DI_SOURCE_ID_NOT_EXISTS Source is invalid

399354 E AHL_DI_SOURCE_ID_INVALID Source is invalid

399332 E AHL_DI_OPERATOR_CODE_NOT_EXIST

Operator code is invalid

399335 E AHL_DI_PRODTYPE_CODE_NOT_EXIST

Product Type is invalid

399322 E AHL_DI_DOC_TYPE_CODE_NOT_EXIST

Document Type is invalid

399318 E AHL_DI_DOC_SUBT_COD_NOT_EXIST Document SubType is invalid



399358 E AHL_DI_SUPPL_ID_NOT_EXIST Supplier is invalid

399349 E AHL_DI_SUPP_ID_INVALID Supplier is invalid

399329 E AHL_DI_SUPPLIER_PREF_TYPE Supplier Preference is invalid

399326 E AHL_DI_SUP_PREF_TYPE_NOT_EXIST Supplier Preference is mandatory

399339 E AHL_DI_RECIPIENT_ID_NOT_EXIST Recipient Number is invalid

399317 E AHL_DI_SOURCE_PARTY_ID_NULL Source is mandatory

399341 E AHL_DI_RECIP_PTY_ID_INVALID Recipient is invalid

399323 E AHL_DI_DOC_TYPE_CODE_NULL Document Type is mandatory

399310 E AHL_DI_DOCUMENT_NO_NULL Document number is mandatory

399360 E AHL_DI_SUBSC_AVAIL_FLAG_NULL Subscription Available is mandatory

399362 E AHL_DI_SUBSC_TO_FLAG_NULL Subscribed To is mandatory

399307 E AHL_DI_DOCUMENT_DUP_RECORD Document already exists

399366 E AHL_DI_SUPPLIER_ID_NULL Supplier is mandatory

399334 E AHL_DI_PREF_CODE_NOT_EXIST Preference Code is invalid

399313 E AHL_DI_DOC_ID_NOT_EXISTS Document is invalid

399367 E AHL_DI_SUPPLIER_DUP_RECORD Supplier already exists

399333 E AHL_DI_PREFERENCE_CODE_NULL Preference Code is mandatory

399359 E AHL_DI_SUPPLIER_REC_INVALID Supplier Document is invalid

399331 E AHL_DI_SUPP_RECORD_CHANGED Record has been modified by another user

399357 E AHL_DI_SUBC_REC_EXISTS Subscription exists for this supplier, you can’tremove this record

399340 E AHL_DI_RECIPIENT_PTY_ID_NULL Recipient is mandatory

399309 E AHL_DI_DOCUMENT_ID_NULL Document is mandatory


399338 E AHL_DI_RECIPIENT_DUP_RECORD Recipient already exists

399342 E AHL_DI_RECIP_RECORD_INVALID Recipient is invalid



A.8.3 Ahl_Di_Subscription_PubError messages for ahl_di_subscription_pub.


399343 E AHL_DI_RECIP_REC_CHANGED Record has been modified by another user


399345 E AHL_DI_REQ_BY_PTY_ID_NOT_EXISTS

Request By Party is invalid

399346 E AHL_DI_REQ_PTY_ID_NULL Requested By is mandatory

399365 E AHL_DI_SUB_PTY_ID_NOT_EXISTS Subscription By Party isinvalid

399330 E AHL_DI_MEDTYP_CODE_NOT_EXISTS

Media Type is invalid

399363 E AHL_DI_SUBTYP_CODE_NOT_EXISTS Subscription Type is invalid

399325 E AHL_DI_FREQCY_CODE_NOT_EXISTS

Frequency is invalid


399356 E AHL_DI_STATUS_CODE_NULL Status Code is mandatory

399337 E AHL_DI_QUANTITY_NULL Quantity is mandatory

399344 E AHL_DI_REQUES_BY_PARTY_ID_NULL

Request By is mandatory

399336 E AHL_DI_QUANTITY_INVALID Quantity is invalid

399308 E AHL_DI_DOCUMENT_ID_NOT_EXIST Document number doesntexist

399314 E AHL_DI_STATUS_CODE_NOT_EXISTS Status is invalid

399327 E AHL_DI_INVALID_DATE Invalid Date

399361 E AHL_DI_SUBSC_DUP_RECORD Record already exists



A.8.4 Ahl_Di_Revision_PubError messages for ahl_di_revision_pub.


A.8.5 Ahl_Di_Pro_Type_Aso_PubError messages for ahl_di_pro_type_aso_pub.


399364 E AHL_DI_SUB_PTY_ID_INVALID Supplier doesnt exist

399314 E AHL_DI_STATUS_CODE_NOT_EXISTS Invalid Status


399300 E AHL_DI_APP_BY_PTY_ID_NOT_EXIST Approved by is invalid

399352 E AHL_DI_REV_TYPE_CODE_NOT_EXIST

Revision type is invalid

399330 E AHL_DI_MEDTYP_CODE_NOT_EXISTS Media Type is invalid

399351 E AHL_DI_REV_STAT_CODE_NOT_EXIST Revision Status is invalid


399348 E AHL_DI_REVISION_NO_NULL Revision Number is mandatory

399350 E AHL_DI_REV_STATUS_CODE_NULL Revision Status is mandatory

399308 E AHL_DI_DOCUMENT_ID_NOT_EXISTS Document Number doesnt exist

399328 E AHL_DI_ISSUE_NUM_INVALID Issue Number is invalid

399353 E AHL_DI_REV_TYPE_CODE_NULL Revision Type is mandatory

399347 E AHL_DI_REVISION_DUP_RECORD Revision already exists




sts

A.8.6 Ahl_Di_Asso_Doc_Aso_PubError messages for ahl_di_asso_doc_aso_pub.


399322 E AHL_DI_DOC_TYPE_CODE_NOT_EXIST

Document Type is invalid

399323 E AHL_DI_DOC_TYPE_CODE_NULL Document Type is mandatory

399316 E AHL_DI_DOC_SUB_CODE_NOT_EXIST

Sub Type &SUBTYPE is invalid

399318 E AHL_DI_DOC_SUBT_COD_NOT_EXISTS

Document Sub Type is invalid

399321 E AHL_DI_DOC_SUB_TYPE_CODE_NULL

Document Sub Type is mandatory

399306 E AHL_DI_DOCSUB_DUP_RECORD Document Subtype &DUPRECORD already exi

399324 E AHL_DI_DOCSUB_REC_NOT_FOUND Document Subtype is invalid

399320 E AHL_DI_DOC_SUB_REC_CHANGED Record has been modified by another user

399315 E AHL_DI_DOC_REC_EXISTS Association type exists in documents, cantremove this record


399312 E AHL_DI_DOC_ID_INVALID Document id is invalid


399319 E AHL_DI_DOC_REV_ID_INVALID Document Revision is invalid

399304 E AHL_DI_ASO_OBJ_TYPE_NOT_EXISTS Aso Object Type is invalid

399302 E AHL_DI_ASO_OBJECT_TYPE_NULL Aso Object Type is mandatory


399308 E AHL_DI_DOCUMENT_ID_NOT_EXISTS Document number doesnt exist



399311 E AHL_DI_DOC_ASSOS_DUP_RECORD Document &DUPRECORD alreadyexists

399305 E AHL_DI_DOC_TL_REC_INVALID Document Title is invalid

399301 E AHL_DI_ASO_OBJECT_ID_NULL Aso Object is mandatory

399303 E AHL_DI_DOC_TL_REC_CHANGED Record has been modified by anotheruser




Route Management Public

B
Route Management Public APIs
Oracle Route Management is a key module of ASO, which is designed to supporttechnical operations by generating task instructions in order to accomplishscheduled or unscheduled work.

B.0.1 Work Card/Route AuthoringAllows the user to use a work card (also known as a task card, route, or router) inorder to accomplish scheduled or unscheduled work. The work card consists ofdetailed step by step work instructions. Route Management provides the followingfunctions:

■ Creation of new work card

■ Modification of existing work card by adding, skipping, or deleting steps

■ Work card revision control (Requires Document Index Module)

B.0.2 Production Planning InformationProvides operational data in order to facilitate the successful accomplishment of amaintenance requirement. This data is often used in determining how work cardsare grouped. Typical examples of operational data are:

■ System – Hydraulic, Electrical, Pneumatic, etc.

■ Zone – Upper Deck, Cargo Compartment, Numeric Code, etc.

■ Work Center – Engine Shop, Machine Shop, Paint Booth, etc.

■ Process – Inspection, Cleaning, Functional Test, etc.

■ Skill/Specialty – Avionics, Sheet Metal, Painter, etc.

■ Significant Task – Aircraft on Jack, Hydraulic Power On , Drain Fuel Tank, etc.

APIs B-1

Route Management Public Packages

B.0.3 Resource Requirements InformationProvides functional data in order to facilitate the successful accomplishment of amaintenance requirement. This data is used in determining when and where workneeds to be accomplished. Typical examples of functional data are:

■ Labor Estimates – How many man hours are required for task accomplishment.

■ Material – Part Number, Description, Quantity

■ Tooling – Part Number, Description, Quantity

■ Reference Documents – IPC, Blueprint, Repair Scheme, etc.

B.0.4 Sign-Off RequirementsOnce completed by production each step/operation of a work card may require asign-off to be considered closed. Sign-off requirements are defined for each workcard. Route Management provides the following functions:

■ No sign-off

■ Single/Multiple sign-off at step/operation level.

■ Grouping of work card steps/operations for single/multiple sign-off.

■ Grouping of work cards for single/multiple sign-off.

B.0.5 Resource Collection Check Points■ Check points can be used to group consecutive operations in a route. Each

check point will be issued to production as a job for labor collection andprogress reporting.

B.1 Route Management Public PackagesThe packages enumerated below are used to insert,update and delete records intothe route management tables. These packages accept the data for a particular entityin route management and perform validation and insert update or delete thepertinent records.

B.1.1 List of public Packages■ Public Package AHL_RM_OPERATIONS_PUB.

B-2 Product Title/BookTitle as a Variable


This Package is used to create and modify operations. It validates the operation databefore doing any data manipulation.

■ Public Package AHL_RM_ROUTE_PUB.

■ This Package is used to create and modify routes. It validates the route databefore doing any data manipulation.

■ Public Package AHL_RM_PROD_ZONE_AS_PUB.

■ This Pakage is used to create and modify and delete associations betweenproduct type,zones and sub zones. It validates the association data beforedoing any data manipulation.

■ Public Package AHL_RM_ASSOCIATIONS_PUB.

■ This Package is used to create and modify and delete associations between aroute or a operation and Entities such as sign off, materials,machines,tools andlabor. It validates the assoication data before doing any data manuplation.


Table 1.1 APIs for Public Package AHL_RM_OPERATIONS_PUB

Table 1.2 APIs for Public Package AHL_RM_ROUTE_PUB

Name Description

Process_operation

This procedure creates and updates operations with the given specifications.This APIaccepts scalar variables. It accepts both name or Identifier for a attribute and convertsname to Identifier if name is specified. It validates the attributes that are passed beforedoing any data manuplation.

Name Description

Process_Route

This procedure creates and updates routes with the given specifications. This API acceptsscalar variables. It accepts both name or Identifier for a attribute and converts name toIdentifier if name is specified. It validates the attributes that are passed before doing anydata manuplation

Route Management Public APIs B-3


Table 1.3 APIs for Public Package AHL_RM_PROD_ZONE_AS_PUB

Table 1.4 APIs for Public Package AHL_ASSOCIATIONS_PUB

B.1.1.1 Package AHL_RM_OPERATION_PUB

Process_operationThis procedure creates and updates operations with the given specifications. Thisprocedure creates and updates operations with the given specifications.This APIaccepts scalar variables. It accepts both name and Identifier for a attribute and

Name Description

Process_prodtype_zone

This procedure creates and updates associations between prodtype,zones and subzones. This API accepts PLSQL table. It accepts both name or Identifier for aattribute and converts name to Identifier if name is specified. It validates theattributes that are passed before doing any data manuplation.

Name Description

Process_sign_off

This procedure creates ,updates,and deletes sign off records required in a route or aoperation. This API accepts PLSQL table as a parameter. It accepts both name andIdentifier for a attribute and converts name to Identifier if name is specified. It validatesthe attributes that are passed before doing any data manuplation.

Process_labor This procedure creates ,updates,and deletes labor records required in a route or aoperation. This API accepts PLSQL table as a parameter. It accepts both name or Identifierfor a attribute and converts name to Identifier if name is specified. It validates theattributes that are passed before doing any data manuplation.

Process_material

This procedure creates ,updates,and deletes material records required in a route or aoperation. This API accepts PLSQL table as a parameter. It accepts both name or Identifierfor a attribute and converts name to Identifier if name is specified. It validates theattributes that are passed before doing any data manuplation.

Process_machine

This procedure creates ,updates,and deletes machine records required in a route or aoperation. This API accepts PLSQL table as a parameter. It accepts both name or Identifierfor a attribute and converts name to Identifier if name is specified. It validates theattributes that are passed before doing any data manuplation.

Process_phase

This procedure creates ,updates,and deletes phase records required in a route or aoperation. This API accepts PLSQL table as a parameter. It accepts both name or Identifierfor a attribute and converts name to Identifier if name is specified. It validates theattributes that are passed before doing any data manuplation.



converts name to Identifier if name is specified. It validates the attributes that arepassed before doing any data manuplation

Procedure SpecificationPROCEDURE PROCESS_OPERATION

(

p_api_version IN NUMBER := 1.0,

p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE,

p_commit IN VARCHAR2 := FND_API.G_FALSE,

p_validate_only IN VARCHAR2 := FND_API.G_TRUE ,

p_validation_level IN NUMBER :=FND_API.G_VALID_LEVEL_FULL,

p_api_version IN NUMBER := '1.0',



p_validate_only IN VARCHAR2 := FND_API.G_TRUE,

p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,

p_operation_id IN OUT NUMBER,

p_segment1 IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_segment1_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,













p_product_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_product_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,



p_zone_code IN VARCHAR2 :=FND_API.G_MISS_CHAR

p_zone_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_sub_zone_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_sub_zone_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_standard_operation_flag IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_revision_number IN NUMBER :=FND_API.G_MISS_NUM,

p_revision_status_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_revision_status_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_category_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_category_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_work_center_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_work_center_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_system_code1 IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_system_code1_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,





p_process_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_process_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operator_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operator_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_remarks IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_description IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_oprprim_skill_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_oprprim_skill_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_active_start_date IN DATE :=FND_API.G_MISS_DATE,

p_active_end_date IN DATE :=FND_API.G_MISS_DATE,

p_note IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_object_version_number IN NUMBER :=FND_API.G_MISS_NUM,

p_module_type IN VARCHAR2,



x_return_status OUT VARCHAR2,

x_msg_count OUT NUMBER,

x_msg_data OUT VARCHAR2);

Current Version1.0

Parameter DescriptionsThe following table describes the IN parameters associated with this API.T

Table 2.1.1 Process_operation IN Parameters


p_api_version NUMBER Yes Api version Number


No Flag to indicate if API does the initialization ofthe message list.

p_commit VARCHAR2

No Is used by API caller to ask API to commit.

p_validate_only VARCHAR2

No Call API in validate only mode no DML isperformed.

p_validation_level VARCHAR2

No Determines which validation to perform andwhich to skip.

p_segment1 VARCHAR2

No User defined attribute to identify a operation

Validate if the identifier exists.

Validate if the code combination used to identifythe operation is unique.

Depending on the user extension this attributemay be mandatory for standard operation andmust be null for a non-standard operation.



p_segment1_desc VARCHAR2

No User defined description of a attribute toidentify a operation.



Depending on the user extension this attributemay be mandatoy for standard operation andmust be null for a non-standard operation.

p_segment2 VARCHAR2










p_segment3 VARCHAR2












p_segment4 VARCHAR2










p_segment5 VARCHAR2

No User defined attribute to identify a operation.











p_segment6 VARCHAR2










p_segment7 VARCHAR2

No User defined attribute to identify a operation.











p_product_type_code VARCHAR2

No Identifier of a product type.

Validate if identifier exists.

This attribute is mandatory if zone is entered.

p_product_type_desc VARCHAR2

No Description of a product type.



p_zone_code VARCHAR2

No Identifier of a zone.


Validate if zone is associated with product type.

p_zone_desc VARCHAR2

No Description of a zone.



p_sub_zone_code VARCHAR2

No Identifier of a sub zone.


Validate if zone is associated with product typeand sub zone.

p_sub_zone_desc VARCHAR2

No Description of a sub zone.


Validate if zone is associated with product typeand sub zone.

p_standard_operation_flag

VARCHAR2

No Flag inidcating if a operation is standard on not.

It is a mandatory attribute.

Valid values are ‘Y’ or ‘N’.

Value cannot be changed from ‘Y’ to ‘N’.



p_revision_number NUMBER No Version number of the operation which indicateshow many times an operation was modified.

p_revision_status_code VARCHAR2

No This attribute indicates the status of theoperation, Whether it is current, draft, orarchived.



p_revision_status_desc VARCHAR2

No This attribute indicates the description of astatus of the operation, Whether it is current,draft, or archived.



p_operation_category_code

VARCHAR2

No Identifier of the category of the operation..


p_operation_category_desc

VARCHAR2

No Description of the category of the operation.


p_operation_type_code VARCHAR2

No Identifier of the type of the operation.


p_operation_type_desc VARCHAR2

No Description of the type of the operation.


p_work_center_code VARCHAR2

No This is a production planning parameterindicating the work center.


p_work_center_desc VARCHAR2

No This is a production planning parameterindicating the work center description..


p_system_code1 VARCHAR2

No This is a production planning parameterindicating the system code.


p_system_code1_desc VARCHAR2

No This is a production planning parameterindicating the system description..
















p_process_code VARCHAR2

No This is a production planning parameterindicating the Process code.


p_process_desc VARCHAR2

No This is a production planning parameterindicating the process description..


p_operator_code VARCHAR2

No This attribute stores the Operator of the product.


p_operator_desc VARCHAR2

No This attribute stores the Operator description ofthe product.


p_remarks VARCHAR2

No This attribute has the remarks of a operation.

p_operation_description

VARCHAR2

No This attribute stores the operation description.

Operation description is mandatory.

p_oprprim_skill_type_code

VARCHAR2

No This attributes indicates the primary skillrequired in a operation.


p_oprprim_skill_type_desc

VARCHAR2

No This attributes indicates the primary skilldescription required in a operation.





Table 2.1.2 Process_operation IN OUT Parameters


Table 2.1.3 Process_ operation Out Parameters

p_active_start_date DATE No This attribute indicates the date from which theoperation will be activated.

This atttribute is mandatory.

Start date should be less then end date.

p_active_end_date DATE No This attribute indicates the date from which theoperation will be deactivated.


p_note VARCHAR2

No Store a remark specifying why the operationwas changed.

p_object_version_number

NUMBER No Stores locking sequence number


No This variable contain the value of the modulewhich is calling th API. For internal use only.


p_operation_id number No Identifier of the operation


x_return_staus

VARCHAR2

Report the API overall return status i.e. Error success etc.

x_msg_count

VARCHAR2

Count of number of error messages.



Package AHL_RM_ROUTE_PUB

■ Process_route

3.1.Process_routeThis Procedure creates and updates routes with the given specifications. This APIaccepts scalar variables. It accepts both name and Identifier for a attribute andconverts name to Identifier if name is specified. It validates the attributes that arepassed before doing any data manuplation


PROCEDURE PROCESS_ROUTE

(

p_api_version IN NUMBER := 1.0,

p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE ,



p_validation_lev IN NUMBER := FND_API.G_VALID_LEVEL_FULL,

p_route_id IN OUT NUMBER,

p_route_no IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_product_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_product_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_zone_code IN VARCHAR2 :=FND_API.G_MISS_CHAR

p_zone_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_revision_number IN NUMBER :=FND_API.G_MISS_NUM,

p_revision_status_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_revision_status_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_route_category_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_route_category_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

x_msg_data VARCHAR2

If the count of errror messages is one this parameter contains the messagedata.



p_route_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_route_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_work_center_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_work_center_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,







p_process_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_process_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operator_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operator_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_title IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_operation_description IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_oprprim_skill_type_code IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_oprprim_skill_type_desc IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_active_start_date IN DATE :=FND_API.G_MISS_DATE,

p_active_end_date IN DATE :=FND_API.G_MISS_DATE,

p_note IN VARCHAR2 :=FND_API.G_MISS_CHAR,

p_object_version_number IN NUMBER :=FND_API.G_MISS_NUM,





Current Version1.0




Table 3.1.1 Process_route IN Parameters

Parameter Data TypeRequired Descriptions and Validations



No Flag to indicate if API does the initialization of themessage list.

p_commit VARCHAR2



No Call API in validate only mode no DML is done.

p_validation_level VARCHAR2

No Determines which validation to perform and whichto skip.

P_route_no VARCHAR2

No User defined attribute to identify a route.

This is a mandatory attribute.

Validate if this attribute is unique.

P_product_type_code VARCHAR2

No Identifier of a product type.



p_product_type_desc VARCHAR2

No Description of a product type.



p_zone_code VARCHAR2

No Identifier of a zone.



.

p_zone_desc VARCHAR2

No Description of a zone.





p_revision_number NUMBER No Version number of the operation which indicateshow many times an operation was modified.

p_revision_status_code VARCHAR2

No This attribute indicates the status of the operation,Whether it is current, draft, or archived.



p_revision_status_desc VARCHAR2

No This attribute indicates the description of a status ofthe operation, Whether it is current, draft, orarchived.



p_route_category_code VARCHAR2

No Identifier of the category of the route..


p_route_category_desc VARCHAR2

No Description of the category of the route.


p_route_type_code VARCHAR2

No Identifier of the type of the route.


p_route_type_desc VARCHAR2

No Description of the type of the route.


p_work_center_code VARCHAR2

No This is a production planning parameter indicatingthe work center.


p_work_center_desc VARCHAR2

No This is a production planning parameter indicatingthe work center description..



No This is a production planning parameter indicatingthe system code.



No This is a production planning parameter indicatingthe system description..
















p_process_code VARCHAR2

No This is a production planning parameter indicatingthe Process code.


p_process_desc VARCHAR2

No This is a production planning parameter .indicatingthe process description..


p_operator_code VARCHAR2

No This attribute stores the Operator of the product.


p_operator_desc VARCHAR2

No This attribute stores the Operator description of theproduct.


P_Title VARCHAR2

No This attribute has the title of a route.

This is a mandatory attribute.

P_oprprim_skill_type_code

VARCHAR2

No This attributes indicates the primary skill requiredin a route.


P_oprprim_skill_type_desc

VARCHAR2

No This attributes indicates the primary skilldescription required in a route.





Table 3.1.2 Process_ route Out Parameters


Table 3.1.3 Process_route IN OUT Parameters

P_active_start_date DATE No This attribute indicates the date from which theroute will be activated.

This atttribute is mandatory.


P_active_end_date DATE No This attribute indicates the date from which theroute will be deactivated.


P_note VARCHAR2

No Store a remark specifying why the route waschanged.

P_object_version_number

NUMBER No Stores locking sequence number


No This variable contain the value of the modulewhich is calling th API. For internal use only.


x_return_staus

VARCHAR2


x_msg_count VARCHAR2


x_msg_data VARCHAR2



p_route_id number No Identifier of the route.



B.1.1.2 Package AHL_RM_PRODZONE_AS_PUB

■ Process_prodtype_zone.

4.1. Process_prodtype_zoneThis procedure creates and updates associations between prodtype,zones and sub zones. ThisAPI accepts PLSQL table as a parameter. It accepts both name and Identifier for a attribute andconverts name to Identifier if name is specified. It validates the attributes that are passed beforedoing any data manuplation.


PROCEDURE process_prodtype_zone

(


p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE ,

p_commit IN VARCHAR2 := FND_API.G_FALSE ,


p_validation_level IN NUMBER:=

FND_API.G_VALID_LEVEL_FULL,

p_prodtype_zone_tbl IN OUT NOCOPY prodtype_zone_tbl ,


x_return_status OUT VARCHAR2 ,

x_msg_count OUT NUMBER ,


Current Version1.0


Table 4.1.1 Process_ prodtype_ zone IN Parameters






Table 4.1.2 Process_prodtype_ zone Out Parameters


Table 4.1.3 Process_prodtype_ zone IN Out Parameters



No flag to indicate if API does the initialization of the messagelist.

p_commit VARCHAR2




p_validation_level

VARCHAR2

No Determines which validation to perform and which to skip.


x_return_staus

VARCHAR2




x_msg_data VARCHAR2




p_prodtyp_zone_tbl

prodtype_zone_tbl

Yes This table contains the attributes of a associationbetween product type, zone and a sub zone.



5. Package AHL_RM_ASSOCIATIONS_PUB

■ Process_sign_off.

■ Process_phase.

■ Process_labor.

■ Process_material.

■ Process_machine.

5.1. Process_sign_offThis procedure creates ,updates,and deletes sign off records required in a route or a operation.This API accepts PLSQL table as a parameter. It accepts both name and Identifier for a attributeand converts name to Identifier if name is specified. It validates the attributes that are passedbefore doing any data manuplation.


PROCEDURE process_sign_off(p_api_version IN NUMBER := '1.0',p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE,p_commit IN VARCHAR2 := FND_API.G_FALSE,p_validate_only IN VARCHAR2 := FND_API.G_TRUE,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,p_sign_off_tbl IN OUT NOCOPY sign_off_tbl ,p_module_type IN VARCHAR2,x_return_status OUT VARCHAR2 ,x_msg_count OUT NUMBER ,x_msg_data OUT VARCHAR2);

Current Version1.0


Table 5.1.1 Process_ sign_ off IN Parameters




Table 5.1.2 Process_ sign_ off Out Parameters


Table 5.1.3 Process_ sign_ off IN OUT Parameters





No Flag to indicate if API does the initialization of the messagelist.

p_commit VARCHAR2




p_validation_level

VARCHAR2



x_return_staus

VARCHAR2




x_msg_data VARCHAR2




p_sign_off_tbl

sign_off_tbl

Yes This table contains the attributes of sign off requirements for aoperation or a route.



5.2. Process_phaseThis procedure creates and updates records of phase requirements for a operation or a route. ThisAPI accepts PLSQL table as a parameter . It accepts both name and Identifier for a attribute andconverts name to Identifier if name is specified. It validates the attributes that are passed beforedoing any data manuplation.


PROCEDURE process_phase(p_api_version IN NUMBER := '1.0',p_init_msg_list IN VARCHAR2 := FND_API.G_TRUE,p_commit IN VARCHAR2 := FND_API.G_FALSE,p_validate_only IN VARCHAR2 := FND_API.G_TRUE,p_validation_level IN NUMBER := FND_API.G_VALID_LEVEL_FULL,p_phase_tbl IN OUT NOCOPY phase_tbl ,p_module_type IN VARCHAR2,x_return_status OUT VARCHAR2 ,x_msg_count OUT NUMBER ,x_msg_data OUT VARCHAR2);

Current Version1.0


Table 5.2.1 Process_ phase IN Parameters





p_commit VARCHAR2







Table 5.2.2 Process_ phase Out Parameters


Table 5.2.3 Process_ phase IN Out Parameters

5.3. Process_laborThis procedure creates and updates records of labor requirements for a operation or a route. ThisAPI accepts PLSQL table as a parameter . It accepts both name and Identifier for a attribute andconverts name to Identifier if name is specified. It validates the attributes that are passed beforedoing any data manuplation.


PROCEDURE process_labor

(


p_validation_level

VARCHAR2



x_return_staus

VARCHAR2




X_msg_data VARCHAR2


Parameter DataType

Required


p_phase_tbl

phase_tbl

Yes This table contains the attributes of a phase requirements for a operationor route.







p_labor_tbl IN OUT NOCOPY labor_tbl ,





Current Version1.0


Table 5.3.1 Process_ labor IN Parameters


Table 5.3.2 Process_ labor Out Parameters






p_commit VARCHAR2




p_validation_level

VARCHAR2






Table 5.3.3 Process_ labor IN OUT Parameters

5.4. Process_machineThis procedure creates and updates records of machine requirements for a operation or a route.This API accepts PLSQL table as a parameter . It accepts both name and Identifier for a attributeand converts name to Identifier if name is specified. It validates the attributes that are passedbefore doing any data manuplation.


PROCEDURE process_machine

(






p_machine_tbl IN OUT NOCOPY machine_tbl ,



x_return_staus

VARCHAR2




x_msg_data VARCHAR2


Parameter

DataType

Required


p_labor_tbl

labor_tbl Yes This table contains the attributes of a labor requirements for a operationor route.





Current Version1.0


Table 5.4.1 Process_ machine IN Parameters


Table 5.4.2 Process_ machine OUT Parameters





No flag to indicate if API does the initialization of the messagelist.

p_commit VARCHAR2




p_validation_level

VARCHAR2



x_return_staus

VARCHAR2




x_msg_data VARCHAR2





Table 5.4.3 Process_ machine IN OUT Parameters

B.1.2 Process_materialThis procedure creates and updates records of material requirements for aoperation or a route. This API accepts PLSQL table as a parameter . It accepts bothname and Identifier for a attribute and converts name to Identifier if name isspecified. It validates the attributes that are passed before doing any datamanuplation.


PROCEDURE process_material

(






p_material_tbl IN OUT NOCOPY material_tbl ,

p_module_type IN VARCHAR2 ,




Current Version1.0



p_machine_tbl

machine_tbl

Yes This table contains the attributes of a machine requirements for aoperation or route.




Table 5.5.1 Process_ material IN Parameters


Table 5.5.2 Process_ material Out Parameters


Table 5.5.3 Process_ material IN OUT Parameters





Yes flag to indicate if API does the initialization of the message list.

p_commit VARCHAR2

Yes Is used by API caller to ask API to commit.



p_validation_level

VARCHAR2


p_material_tbl material_tbl

Yes This table contains the attributes of a material requirements fora operation or route.


x_return_staus

VARCHAR2




x_msg_data VARCHAR2




B.1.3 Data Structure SpecificationsThe following data structures are used in route management API’s

■ Sign_off_rec

■ Phase_rec

■ Machine_rec

■ Material_rec

■ Labor_rec

■ Prodtype_zone_rec

■ Sign_off_tbl

■ Phase_tbl

■ Machine_tbl

■ Material_tbl

■ Labor_tbl

■ Prodtype_zone_tbl

B.1.3.1 6.1.Sign_off_recThis record contains the attributes of a sign off requirements for a operation orroute.

Record SpecificationTYPE sign_Off_rec IS RECORD

(

RTOP_SNOFF_SKILL_ID NUMBER := FND_API.G_MISS_NUM,

association_type_code VARCHAR2(30) := FND_API.G_MISS_CHAR,

OBJECT_ID NUMBER := FND_API.G_MISS_NUM,



p_material_tbl

material_tbl

Yes This record contains the attributes of a material requirements for aoperation or route.



SKILL_TYPE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

SKILL_TYPE_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

SKILL_LEVEL_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

SKILL_LEVEL_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

REVISION_NUMBER NUMBER := FND_API.G_MISS_NUM,

OBJECT_VERSION_NUMBER NUMBER := FND_API.G_MISS_NUM,

DELETE_FLAG VARCHAR2(1) := 'N'

);

B.1.3.2 6.2.Phase_recThis record contains the attributes of a phase requirements for a operation or route.

Record SpecificationTYPE phase_rec IS RECORD

(

OPERATION_PHASE_ID NUMBER := FND_API.G_MISS_NUM,

OPERATION_ID NUMBER := FND_API.G_MISS_NUM,

PHASE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

PHASE_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,




);

B.1.3.3 6.3.Machine_recThis record contains the attributes of a machine requirements for a operation orroute.

Record SpecificationTYPE machine_rec IS RECORD

(

RT_OPER_MACHINE_ID NUMBER := FND_API.G_MISS_NUM,





MACHINE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

MACHINE_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

MACHINE_TYPE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

MACHINE_TYPE_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

QUANTITY NUMBER := FND_API.G_MISS_NUM,

DURATION NUMBER := FND_API.G_MISS_NUM,




);

B.1.3.4 6.4.Material_recThis record contains the attributes of a material requirements for a operation orroute.

Record SpecificationTYPE material_rec IS RECORD

( RT_OPER_MATERIAL_ID NUMBER := FND_API.G_MISS_NUM, association_type_code VARCHAR2(30) := FND_API.G_MISS_CHAR,


rec_type_code VARCHAR2(30) := FND_API.G_MISS_CHAR,

INVENTORY_ITEM_ID NUMBER := FND_API.G_MISS_NUM,

INVENTORY_ORG_ID NUMBER := FND_API.G_MISS_NUM,

CONCATENATED_SEGMENTS VARCHAR2(2000) := FND_API.G_MISS_CHAR,


UOM_code VARCHAR2(30) := FND_API.G_MISS_CHAR,




);

6.5.Labor_rec

This record contains the attributes of a labor requirements for a operation or route.



Record SpecificationTYPE labor_rec IS RECORD

(

RT_OPER_LABOR_ID NUMBER := FND_API.G_MISS_NUM,



SKILL_TYPE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

SKILL_TYPE_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

SKILL_LEVEL_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

SKILL_LEVEL_DESC VARCHAR2(80) := FND_API.G_MISS_CHAR,

HEADCOUNT NUMBER := FND_API.G_MISS_NUM,

DURATION NUMBER := FND_API.G_MISS_NUM,




);

B.1.3.5 6.6.Sign_off_tblThis table contains records with attributes of a sign off requirements for a operationor route.

Table SpecificationTYPE sign_off_tbl IS TABLE OF sign_off_rec INDEX BY BINARY_INTEGER;

B.1.3.6 6.7.Phase_tblThis table contains records with attributes of a phase requirements for a operationor route.

Table SpecificationTYPE phase_tbl IS TABLE OF phase_rec INDEX BY BINARY_INTEGER;

B.1.3.7 6.8.Machine_tblThis table contains records with attributes of a machine requirements for aoperation or route.



Table SpecificationTYPE machine_tbl IS TABLE OF machine_rec INDEX BY BINARY_INTEGER;

B.1.3.8 6.9.Material_tblThis table contains records with attributes of a material requirements for a operationor route.

Table SpecificationTYPE machine_tbl IS TABLE OF material_rec INDEX BY BINARY_INTEGER;

B.1.3.9 6.10.Labor_tblThis table contains records with attributes of a Labor requirements for a operationor route.

Table SpecificationTYPE labor_tbl IS TABLE OF labor_rec INDEX BY BINARY_INTEGER;

The following data structures are used in AHL_RM_PROD_ZONE_AS_PUB

B.1.3.10 6.11.Prodtype_zone_recThis record contains the attributes of a machine requirements for a operation orroute.

Record SpecificationTYPE prodtype_zone_rec IS RECORD

(

PRODTYPE_ZONE_ID NUMBER := FND_API.G_MISS_NUM,

PRODUCT_TYPE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

PRODUCT_TYPE_DESC VARCHAR2(30) := FND_API.G_MISS_CHAR,

ZONE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

ZONE_DESC VARCHAR2(30) := FND_API.G_MISS_CHAR,

SUB_ZONE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

SUB_ZONE_DESC VARCHAR2(30) := FND_API.G_MISS_CHAR,

ACTIVE_START_DATE DATE := FND_API.G_MISS_DATE,

ACTIVE_END_DATE DATE := FND_API.G_MISS_DATE,




REC_TYPE VARCHAR2(30) := FND_API.G_MISS_CHAR,


);

6.12.prodtype_zone_tbl

This record contains the attributes of a machine requirements for a operation orroute.

Record SpecificationTYPE prodtype_zone_tbl IS TABLE OF prodtype_zone_rec INDEX BY BINARY_INTEGER;

B.2 Messages and NotificationsThe status messages associated with the Route Management public APIs aredivided into the following sections

■ Common Messages

■ Messages used in specific API’s

B.2.1 Common MessagesThe following table describes a lists of common error messages that the are used inRoute Management API’s.

Table 7.1.1 Common API Messages


399158 E AHL_RM_START_ACTIVE_DATE_NULL

Start date is mandatory.

399106 E AHL_RM_INVALID_DATE_RANGE Start date cannot be less than end date.

399128 E AHL_RM_PROD_TYPE_NOT_EXISTS Product Type does not exist.

399173 E AHL_RM_ZONE_NULL Zone is mandatory.

399127 E AHL_RM_PRODUCT_TYPE_NULL Product Type is mandatory.



B.2.1.1 AHL_RM_OPERATIONS_PUBError messages for procedure PROCESS_OPERATION.

Table 7.2.1 AHL_RM_OPERATIONS_PUB.PROCESS_OPERATION Messages

399129 E AHL_RM_PROD_ZONE_NOT_EXISTS Product Type and zone assoication doesnot exist.

399133 E AHL_RM_REV_STATUS_NOT_EXISTS Revision Status does not exist.

399120 E AHL_RM_OP_CAT_NOT_EXISTS Operation Category does not exist.

399122 E AHL_RM_OP_TYPE_NOT_EXISTS Operation Type does not exist.

399176 E AHL_RM_WORK_CENTER_NOT_EXISTS

Work Center does not exist.

399163 E AHL_RM_SYSTEM_CODE1_NOT_EXISTS

System Code One does not exist.


System Code Two does not exist.


System Code Three does not exist.

399126 E AHL_RM_PROCESS_CODE_NOT_EXISTS

Process Code does not exist.

399118 E AHL_RM_OPERATOR_NOT_EXISTS Operator does not exist.

399156 E AHL_RM_SKILL_TYPE_NOT_EXISTS Skill Type does not exist.

399132 E AHL_RM_REVISION_STATUS_NULL Revision Status is mandatory.

399101 E AHL_RM_DUP_REC &ENTITY already exists.

399403 E AHL_COM_RECORD_CHANGED Record has been modified by anotheruser.


399121 E AHL_RM_OP_CHANGE_INVALID Operation cannot change from standard to nonstandard.



B.2.1.2 AHL_RM_ROUTE_PUBError messages for procedure PROCESS_ROUTE.

Table 7.3.1 AHL_RM_ROUTE_PUB.PROCESS_ROUTE Messages

399174 E AHL_RM_OPERATION_DESC_NULL

Operation description is mandatory.

399141 E AHL_RM_SEG1_NOT_EXISTS Segment One does not exist.

399142 E AHL_RM_SEG2_NOT_EXISTS Segment Two does not exist.

399143 E AHL_RM_SEG3_NOT_EXISTS Segment Three does not exist.

399144 E AHL_RM_SEG4_NOT_EXISTS Segment Four does not exist.

399145 E AHL_RM_SEG5_NOT_EXISTS Segment Five does not exist.

399146 E AHL_RM_SEG6_NOT_EXISTS Segment Six does not exist.

399147 E AHL_RM_SEG7_NOT_EXISTS Segment Seven does not exist.

399160 E AHL_RM_STD_OP_FLAG_NULL Standard operation flag is mandatory.

399120 E AHL_RM_OP_CAT_NOT_EXISTS Operation Category does not exist.

399122 E AHL_RM_OP_TYPE_NOT_EXISTS Operation Type does not exist.

399159 E AHL_RM_STD_OP_FLAG_INVALID Invalid Standard.


399180 E AHL_RM_TITLE_NULL Title is mandatory.

399138 E AHL_RM_ROUTE_NUMBER_EXISTS Route Number already exist.

399136 E AHL_RM_ROUTE_NO_CANNOT_CHANGE

Route Number cannot be changed.

399160 E AHL_RM_STD_OP_FLAG_NULL Standard is mandatory.

399133 E AHL_RM_REV_STATUS_NOT_EXISTS Revision Status does not exist.

399134 E AHL_RM_ROUTE_CAT_NOT_EXISTS Route category does not exist.

399140 E AHL_RM_ROUTE_TYPE_NOT_EXISTS Route Type does not exist.



B.2.1.3 AHL_RM_ASSOICATIONS_PUBError messages for procedure PROCESS_SIGN_OFF.

Table 7.4.1 AHL_RM_ASSOICATIONS_PUB.PROCESS_SIGN_OFF Messages

B.2.2 AHL_RM_ASSOICATIONS_PUBError messages for procedure PROCESS_LABOR.

Table 7.5.1 AHL_RM_ASSOICATIONS_PUB.PROCESS_LABOR Messages

399176 E AHL_RM_WORK_CENTER_NOT_EXISTS Work Center does not exist.

399163 E AHL_RM_SYSTEM_CODE1_NOT_EXISTS System Code One does not exist.

399164 E AHL_RM_SYSTEM_CODE2_NOT_EXISTS System Code Two does not exist.

399165 E AHL_RM_SYSTEM_CODE3_NOT_EXISTS System Code Three does not exist.

399126 E AHL_RM_PROCESS_CODE_NOT_EXISTS Process Code does not exist.

399118 E AHL_RM_OPERATOR_NOT_EXISTS Operator does not exist.

399156 E AHL_RM_SKILL_TYPE_NOT_EXISTS Skill Type does not exist.


399157 E AHL_RM_SKILL_TYPE_NULL Skill Type is mandatory.

399156 E AHL_RM_SKILL_TYPE_NOT_EXISTS Skill Type &SKILLTYPE does not exist.

399155 E AHL_RM_SKILL_LEVEL_NOT_EXISTS

Skill Type &SKILLLEVEL does not exist for&SKILLTYPE.

399100 E AHL_RM_AS_TYPE_NOT_EXISTS Association Type does not exist.

399112 E AHL_RM_OBJECT _NOT_EXISTS Route or operation does not exist.



399157 E AHL_RM_SKILL_TYPE_NULL Skill Type is mandatory.



B.2.2.1 AHL_RM_ASSOICATIONS_PUBError messages for procedure PROCESS_MATERAIL.

Table 7.6.1 AHL_RM_ASSOICATIONS_PUB.PROCESS_MATERIAL Messages

399103 E AHL_RM_DURATION_NULL Duration is mandatory for &ENTITY.

399105 E AHL_RM_HEADCOUNT_NULL Headcount is mandatory for &ENTITY.

399102 E AHL_RM_DURATION_LESS_ZERO Duration cannot be less than or equal toZzerofor &ENTITY.

399104 E AHL_RM_HEADCOUNT_LESS_ZERO

Headcount cannot be less than or equal to Zerofor &ENTITY.

399156 E AHL_RM_SKILL_TYPE_NOT_EXISTS Skill type &SKILLTYPE does not exist.

399155 E AHL_RM_SKILL_LEVEL_NOT_EXISTS

Skill type &SKILLLEVEL does not exist for&SKILLTYPE.





399108 E AHL_RM_ITEM _NULL Material or tool identifier is mandatory.

399175 E AHL_RM_UOM_NULL Unit of measure is mandatory for &ENTITY.

399123 E AHL_RM_ORGANIZATION_NULL

Organization is mandatory for &ENTITY.

399131 E AHL_RM_QUANTITY_NULL Quantiy is mandatory for &ENTITY.

399102 E AHL_RM_QUANTIY_LESS_ZERO Quantity cannot be less than or equal to zero for&ENTITY.

399107 E AHL_RM_ITEM _NOT_EXISTS Inventory item &ITEM does not exists.

399169 E AHL_RM_UOM _NOT_EXISTS Unit of measure &ENTITY1 does not exist for&ENTITY2.





B.2.2.2 AHL_RM_ASSOICATIONS_PUBError messages for procedure PROCESS_MACHINE.

Table 7.7.1 AHL_RM_ASSOICATIONS_PUB.PROCESS_MACHINE Messages

B.2.2.3 AHL_RM_ASSOICATIONS_PUBError messages for procedure process phase.

Table 7.8.1 AHL_RM_ASSOICATIONS_PUB.PROCESS_PHASE Messages



399171 E AHL_RM_MACHINE_TYPE_NULL Machine Type is mandatory for&MACHINECODE.

399170 E AHL_RM_MACHINE_NULL Machine is mandatory.

399103 E AHL_RM_DURATION_NULL Duration is mandatory for &ENTITY.

399131 E AHL_RM_QUANTITY_NULL Quantiy is mandatory for &ENTITY.

399102 E AHL_RM_QUANTIY_LESS_ZERO Quantity cannot be less than or equal tozero for &ENTITY.

399102 E AHL_RM_DURATION_LESS_ZERO Duration cannot be less than or equal tozero for &ENTITY

399109 E AHL_RM_MACHINECODE_NOT_EXISTS

Machine Code &MACHINECODE does notexist.

399156 E AHL_RM_MACHINE_TYPE_NOT_EXISTS

Skill Type &MACHINETYPE does not existfor &MACHINECODE.







B.2.2.4 AHL_RM_PROD_ZONE_AS_PUBError messages for procedure PROCESS_PRODTYPE_ZONE.

Table 7.9.1 AHL_RM_PROD_ZONE_AS_PUB.PROCESS_PRODTYPE_ZONE Messages

399125 E AHL_RM_PHASE_CODE_NULL Phase is mandatory.

399124 E AHL_RM_PHASE_CODE_NOT_EXISTS

Phase &PHASECODE does not exist.





399127 E AHL_RM_PRODUCT_TYPE _NULL Product Type is mandatory.

399173 E AHL_RM_ZONE_NULL Zone is mandatory.

399176 E AHL_RM_SUB_ZONE_NULL_TOK Sub Zone is mandatory for &ENTITY.

399131 E AHL_RM_PROD_ZONE_AS_NO_CHANGE

Cannot change product type,zone,sub zoneattributes for &ENTITY.

399182 E AHL_RM_ZONE_NOT_EXISTS_TOKEN

Zone &ENTITY1 does not exist for&ENTITY2.

399181 E AHL_RM_ZONE_NOT_EXISTS_TOKEN

Zone &ENTITY1 does not exist for&ENTITY2.

399184 E AHL_RM_ST_ACTIVE_DATE_NULL_TOK

Start date is mandatory for &ENTITY1.

399185 E AHL_RM_INVALID_DATE_RANGE_TOK

Start date cannot be greater then end date for&ENTITY1.





Master Configuration Public

C
Master Configuration Public APIs
Master Configuration is designed to work with Unit Configurations, by providingpart number level information regarding alternate parts and shop floor businessrules. These part number level information will be used as a guide to validate thecompleteness and correctness of Unit Configurations.

The functional areas addressed are:

C.1 Define Allowable ConfigurationA Master Configuration is a tree structure representing an assembly. Each node ofthe tree represents a position where a tracked part can be installed. Each MasterConfiguration represents a possible configuration of a unit. The alternate parts ofeach position are defined, the constraints reason for each alternate is identified (onlya note in phase 1), and the documents to support the allowable configuration aredefined.

C.2 Provide a Configuration Template for Unit ConfigurationInstead of building a Unit Configuration from scratch, it’s structure can be replicatedfrom a master configuration. The counters, events, documents, alternate parts,constraints, and counter ratios form Master Configuration will be applicable to theUnit Configuration.

APIs C-1

Attach applicable maintenance requirements

C.3 Attach applicable maintenance requirementsA position in a Master Configuration can have multiple maintenance requirements.Master Configuration provides the template for maintenance requirements that arerelationship dependent. When a unit is associated to a configuration, it inherits therequirements from Master Configuration.

C.4 Provide a checklist for the userThe user will have the capability to print a Master Configuration providing themwith an empty on / off item checklist or log. The Master Configuration will beprinted with the applicable alternate part list per node allowing the user to check anincoming or outgoing configuration

C.5 Master Configuration Public PackagesThis module provides public packages to manipulate item groups, item associationsand build master configuration.

C.5.1 List of packages:Public AHL_MC_ItemGroup_Pub.

This package provides API’s to manipulate item groups and item associations.

Public AHL_MC_MasterConfig_Pub.

This package provides API’s to build/modify/delete master configuration.


Table1-1 AHL_MC_ItemGroup_PUB APIs

Name Description

Create_Item_Group This procedure creates an item group and the associated alternateitems with the given specification.

Modify_Item_Group This procedure updates the item group attibutes oraddes/deletes/modifies alternates items associated to this itemgroup with the given specifications.

C-2 Product Title/BookTitle as a Variable

Master Configuration Public Packages

Table 1-2 AHL_MC_MasterConfig_PUB APIs

C.5.1.1 Package AHL_MC_ItemGroup_PUB

API’s defined in this package are:

Create_Item_Group

Modify_Item_Group

C.5.1.2 Create_Item_Group

This procedure will create a new item group and the alternate parts associated to thisitem group.

Procedure SpecificationPROCEDURE Create_Item_group (

p_api_version IN NUMBER,

p_init_msg_list IN VARCHAR2 := FND_API.G_FALSE,



p_module_type IN VARCHAR2 := null,

p_x_item_group_rec IN OUT NOCOPY AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type,

p_x_items_tbl IN OUT NOCOPY AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_Type,



x_msg_data OUT VARCHAR2 )

Name Description

Process_Master_Config This procedure performs the create/update/modify opera-tions on a master configuration with the given specifica-tions.

Master Configuration Public APIs C-3


Current Version

1.0

C.5.1.3 Parameter Descriptions


2-1-1 Create_Item_Group IN Parameters


2-1-2 Create_Item_Group IN Out Parameters



p_api_version NUMBER Yes Version of the api. Must be 1.0

p_init_msg_list VARCHAR2 Optional

Initialises the error message stack if this value isset to FND_API.G_TRUE. The default value isFND_API.G_FALSE.

p_commit VARCHAR2 Optional

If this is set to FND_API.G_TRUE then the APIcommits the transaction before it exits. Defaultvalue is FND_API.G_FALSE.

p_validation_level NUMBER Optional

This value indicates the level of validation thatthe API will perform. Irrespective of its value,this API will perform full validation.

P_module_type VARCHAR2 Optional

Its value should always be NULL.






2-1-3 Create_Item_Group Out Parameters

C.5.1.4 Modify_Item_GroupThis procedure will modify an existing item group and the alternate parts associatedto this item group.

p_x_item_group_rec AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type

Yes Datastructure containing the item group recordspecifications.

p_x_items_tbl AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_Type

Yes Datastructure containing the item associationrecord specifications. This is a table of recordswhich are of type AHL_MC_ItemGroup_PVT.Item_Associations_Rec_Type.


x_return_status VARCHAR2 The return status of the operation performed by the API. Itsvalid values are:

FND_API.G_RET_STS_SUCCESS (Operation is successful)

FND_API.G_RET_STS_ERROR (Operation had errors).

FND_API.G_RET_STS_UNEXP_ERROR (API encountered anunexpected error it did not expect.)

x_msg_count NUMBER Number of messages in the error message stack.

x_msg_data VARCHAR2 The message text if there is only one message on the error stack.



Procedure SpecificationPROCEDURE Modify_Item_group (





p_module_type IN VARCHAR2 := null,

p_item_group_rec IN AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type,

p_x_items_tbl IN OUT NOCOPY AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_Type,



x_msg_data OUT VARCHAR2 )

Current Version

1.0



2-2-1 Create_Item_Group IN Parameters



p_init_msg_list VARCHAR2 Optional Initialises the error message stack if this value isset to FND_API.G_TRUE. The default value isFND_API.G_FALSE.

p_commit VARCHAR2 Optional If this is set to FND_API.G_TRUE then the APIcommits the transaction before it exits. Defaultvalue is FND_API.G_FALSE.

p_validation_level NUMBER Optional This value indicates the level of validation thatthe API will perform. Irrespective of its value,this API will perform full validation.




2-2-2 Create_Item_Group IN Out Parameters


2-2-3 Create_Item_Group Out Parameters

p_module_type VARCHAR2 Optional Its value should always be NULL. This parame-ter is for internal use only.

p_item_group_rec AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type

Yes Datastructure containing the modified itemgroup record specifications.



p_x_items_tbl AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_Type

Yes Datastructure containing the item associationrecord specifications. This is a table of recordswhich are of type AHL_MC_ItemGroup_PVT.Item_Associations_Rec_Type.


x_return_status VARCHAR2 The return status of the operation performed by theAPI. Its valid values are:

FND_API.G_RET_STS_SUCCESS (Operation issuccessful)

FND_API.G_RET_STS_ERROR (Operation haderrors).

FND_API.G_RET_STS_UNEXP_ERROR (APIencountered an unexpected error it did not expect.)



C.5.1.5 Package AHL_MC_MasterConfig_PUB:

API’s defined in this package are:

Process_MasterConfig

C.5.1.6 Process_MasterConfig

This procedure will process the master configuration as defined in the specifications.It will perform create, update and delete operations on a master configuration.

Procedure SpecificationPROCEDURE Process_MasterConfig (





p_module_type IN VARCHAR2 := NULL,

p_x_master_config_tbl IN OUT NOCOPY AHL_MC_MasterConfig_PVT.Nodes_Tbl_Type,

p_x_counter_rules_tbl IN OUT NOCOPY

AHL_MC_MasterConfig_PVT.Counter_Rules_Tbl_Type,

p_x_events_tbl IN OUT NOCOPY

AHL_MC_MasterConfig_PVT.Events_Tbl_Type,





x_msg_data VARCHAR2 The message text if there is only one message onthe error stack.



Current Version

1.0


3-1-1 Process_MasterConfig IN Parameters


3-1-2 Process_MasterConfig IN Out Parameters




p_init_msg_list VARCHAR2 Optional

Initialises the error message stack if this value isset to FND_API.G_TRUE. The default value isFND_API.G_FALSE.

p_commit VARCHAR2 Optional

If this is set to FND_API.G_TRUE then the APIcommits the transaction before it exits. Defaultvalue is FND_API.G_FALSE.

p_validation_level NUMBER Optional

This value indicates the level of validation thatthe API will perform. Irrespective of its value,this API will perform full validation.

P_module_type VARCHAR2 Optional

Its value should always be NULL. This parame-ter is for internal use only.



p_x_master_config_tbl

AHL_MC_MasterConfig_PVT.Nodes_Tbl_Type

Yes Datastructure containing the node details. Thisis a table of records which are of type AHL_MC_MasterConfig_PVT.Node_Rec_Type.




3-1-3 Process_MasterConfig Out Parameters

C.5.2 Data Structure SpecificationsThe following data structures are used in Create_Item_Group/Modify_ItemGroupAPI’s defined in package AHL_MC_ItemGroup_PUB:

■ AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type

■ AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_Type

p_x_counter_rules_tbl

AHL_MC_MasterConfig_PVT.Counter_Rules_Tbl_Type

Yes Datastructure containing the counter specifica-tions associated to a node. This is a table ofrecords which are of type AHL_MC_MasterConfig_PVT.Counter_Rule_Rec_Type.

p_x_events_tbl AHL_MC_MasterConfig_PVT.Events_Tbl_Type

Yes Datastructure containing the event specifica-tions associated to a node. This is a table ofrecords which are of type AHL_MC_MasterConfig_PVT.Events_Rec_Type.

THIS IS FOR FUTURE USE.







x_msg_data VARCHAR2 The message text if there is only one message on the error stack.



■ AHL_MC_ITEMGROUP_PVT.Item_Association_Rec_Type

The following data structures are used in Process_MasterConfig API defined inpackage AHL_MC_MasterConfig_PUB:

■ AHL_MC_MasterConfig_PVT.Node_Tbl_Type.

■ AHL_MC_MasterConfig_PVT.Counter_Rule_Tbl_Type.

■ AHL_MC_MasterConfig_PVT.Events_Tbl_Type.

■ AHL_MC_MasterConfig_PVT.Node_Rec_Type.

■ AHL_MC_MasterConfig_PVT.Counter_Rule_Rec_Type.

■ AHL_MC_MasterConfig_PVT.Events_Rec_Type.

C.5.2.1 AHL_MC_ITEMGROUP_PVT.Item_Group_Rec_Type

This record structure holds all the data attributes for the Item Group record.


TYPE Item_group_Rec_Type IS RECORD (

ITEM_GROUP_ID NUMBER := FND_API.G_MISS_NUM,

LANGUAGE VARCHAR2(4) := FND_API.G_MISS_CHAR,

NAME VARCHAR2(80) := FND_API.G_MISS_CHAR,

DESCRIPTION VARCHAR2(240) := FND_API.G_MISS_CHAR,

SOURCE_LANG VARCHAR2(4) := FND_API.G_MISS_CHAR,

SECURITY_GROUP_ID NUMBER := FND_API.G_MISS_NUM,


ATTRIBUTE_CATEGORY VARCHAR2(30) := FND_API.G_MISS_CHAR,

ATTRIBUTE1 VARCHAR2(150) := FND_API.G_MISS_CHAR,

















LAST_UPDATE_DATE DATE := FND_API.G_MISS_DATE,

LAST_UPDATED_BY NUMBER := FND_API.G_MISS_NUM,

CREATION_DATE DATE := FND_API.G_MISS_DATE,

CREATED_BY NUMBER := FND_API.G_MISS_NUM,

LAST_UPDATE_LOGIN NUMBER := FND_API.G_MISS_NUM,

OPERATION_FLAG VARCHAR2(1));


The following table describes the parameters associated with this data structure.

4-1 -1 Parameters

C.5.2.2 AHL_MC_ITEMGROUP_PVT.Item_Association_Tbl_TypeThis table structure is a table of records of the type:

AHL_MC_ITEMGROUP_PVT.Item_Association_Rec_Type.

C.5.2.3 AHL_MC_ITEMGROUP_PVT.Item_Association_Rec_Type

This record structure holds all the data attributes for the Item Association record.

Parameter Data Type Description




TYPE Item_Association_Rec_Type IS RECORD (

ITEM_ASSOCIATION_ID NUMBER := FND_API.G_MISS_NUM,

ITEM_GROUP_NAME VARCHAR2(80) := FND_API.G_MISS_CHAR,


INVENTORY_ORG_CODE VARCHAR2(3) := FND_API.G_MISS_CHAR,


INVENTORY_ITEM_NAME VARCHAR2(2000) := FND_API.G_MISS_CHAR,


REVISION VARCHAR2(3) := FND_API.G_MISS_CHAR,

PRIORITY NUMBER := FND_API.G_MISS_NUM,

UOM_CODE VARCHAR2(3) := FND_API.G_MISS_CHAR,


INTERCHANGE_TYPE_MEANING VARCHAR2(80) :=FND_API.G_MISS_CHAR,

INTERCHANGE_TYPE_CODE VARCHAR2(30) :=FND_API.G_MISS_CHAR,

INTERCHANGE_REASON_MEANING VARCHAR2(80) :=

FND_API.G_MISS_CHAR,

INTERCHANGE_REASON_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

ITEM_TYPE_MEANING VARCHAR2(80) := FND_API.G_MISS_CHAR,

ITEM_TYPE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,


























OPERATION_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR

);

C.5.2.4 AHL_MC_MasterConfig_PVT.Node_Tbl_Type

This table structure is a table of records of the type:

AHL_MC_MasterConfig_PVT.Node_Rec_Type.

C.5.2.5 AHL_MC_MasterConfig_PVT.Node_Rec_Type

This record structure holds all the data attributes for the Node record.


TYPE Node_Rec_Type IS RECORD (

RELATIONSHIP_ID NUMBER := FND_API.G_MISS_NUM,

LANGUAGE VARCHAR2(4) := FND_API.G_MISS_CHAR,


POSITION_REF_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

POSITION_REF_MEANING VARCHAR2(80) := FND_API.G_MISS_CHAR,

DESCRIPTION VARCHAR2(240) := FND_API.G_MISS_CHAR,

CONFIG_STATUS_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

CONFIG_STATUS_MEANING VARCHAR2(80) := FND_API.G_MISS_CHAR,





PARENT_RELATIONSHIP_ID NUMBER := FND_API.G_MISS_NUM,


ITEM_GROUP_NAME VARCHAR2(80) := FND_API.G_MISS_CHAR,

COUNTER_GROUP_ID NUMBER := FND_API.G_MISS_NUM,

DISPLAY_ORDER NUMBER := FND_API.G_MISS_NUM,

SIBLING_RULES_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,

COUNTER_RULE_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,



SOURCE_LANG VARCHAR2(4) := FND_API.G_MISS_CHAR,


























OPERATION_FLAG VARCHAR2(1) := null,

PARENT_NODE_REC_INDEX NUMBER := FND_API.G_MISS_NUM

);

C.5.2.6 AHL_MC_MasterConfig_PVT.Counter_Rules_Tbl_TypeThis table structure is a table of records of the type:

AHL_MC_MasterConfig_PVT.Counter_Rules_Rec_Type.

C.5.2.7 AHL_MC_MasterConfig_PVT.Counter_Rules_Rec_TypeThis record structure holds all the data attributes for the Node record.


TYPE Counter_Rule_Rec_Type IS RECORD (

CTR_UPDATE_RULE_ID NUMBER := FND_API.G_MISS_NUM,

RELATIONSHIP_ID NUMBER := FND_API.G_MISS_NUM,


RULE_CODE VARCHAR2(30) := FND_API.G_MISS_CHAR,

RULE_MEANING VARCHAR2(80) := FND_API.G_MISS_CHAR,

RATIO NUMBER := FND_API.G_MISS_NUM,



























NODE_TBL_INDEX NUMBER := FND_API.G_MISS_NUM

);

C.5.2.8 AHL_MC_MasterConfig_PVT.Events_Tbl_TypeThis table structure is a table of records of the type:

AHL_MC_MasterConfig_PVT.Events_Rec_Type.

C.5.2.9 AHL_MC_MasterConfig_PVT.Events_Rec_TypeThis record structure holds all the data attributes for the Node record.


TYPE Events_Rec_Type IS RECORD (

NODE_TBL_INDEX NUMBER,

OPERATION_FLAG VARCHAR2(1)

);

C.5.3 Messages and NotificationsThe status messages associated with the Master Configuration public APIs aredivided into the following sections:

Common Messages



Messages from specific API’s.

C.5.3.1 Common Messages

The following table describes a lists of common error messages and notifications thatthe Master Configuration API can generate. Note that not all messages are returnedby all APIs.

5.1.1 Common Task API Messages

C.5.3.2 Public AHL_MC_ItemGroup_PUB:

Error messages for AHL_MC_ItemGroup_PUB -

5.2.1 API Messages

Num-ber

Type

Name Text

399404

E AHL_COM_RECORD_DELETED

Record has been deleted.

399401

E AHL_COM_KEY_NOUPDATE Primary key cannot be updated.

399403

E AHL_COM_RECORD_CHANGED

Record has been modified. Pleasere-query.


399001 E AHL_MC_ITEMGRP_NULL Item Group is mandatory.

399002 E AHL_MC_ITEMGRP_INVALID Item Group &ITEM_GRP is invalid.

399003 E AHL_MC_ITEMGRP_MISMATCH Item Association Group &ASSO_GRP does notmatch Item Group &ITEM_GRP record.

399004 E AHL_MC_ORG_INVALID Inventory Organization Code (&ORG) is invalid.

399005 E AHL_MC_INV_NULL Inventory Item is mandatory.



399006 E AHL_MC_INV_INVALID Inventory Item (&INV_ITEM) is invalid.

390007 E AHL_MC_INV_TRACK Inventory Item (&INV_ITEM) is not trackable.

399008 E AHL_MC_INTER_INVALID Interchangeability code (&INTER_CODE) for Item(&INV_ITEM) is invalid.

399009 E AHL_MC_REASON_INVALID Intechangeability Reason Code (&REASON_CODE) for Item (&INV_ITEM) invalid.

399010 E AHL_MC_ITEM_TYPE_INVALID Item Type (&ITEM_CODE) for inventory item(&INV_ITEM) is invalid.

399011 E AHL_MC_INVREVI_INVALID Inventory revision (&REVISION) for item (&INV_ITEM) is invalid.

399012 E AHL_MC_ITEM_ASSOC_DUP Inventory Item (&INV_ITEM) already exists in ItemGroup (&GRP_NAME).

399013 E AHL_MC_PRIORITY_INVALID Priority (&PRIORITY) for item (&INV_ITEM) isinvalid.

399014 E AHL_MC_PRIORITY_NULL Priority for item (&INV_ITEM) is mandatory.

399015 E AHL_MC_INVQTY_INVALID Quantity (&QUANTITY) for item (&INV_ITEM) isinvalid.

399016 E AHL_MC_INVUOM_INVALID UOM (&UOM_CODE) for item (&INV_ITEM) isinvalid.

399017 E AHL_MC_INVUOM_NULL UOM for item (&INV_ITEM) is mandatory.

399018 E AHL_MC_ITEMGRP_EXISTS Item Group (&ITEM_GRP) already exists.

399019 E AHL_MC_ORG_NULL Organization Code is mandatory.

399020 E AHL_MC_ASSOC_NULL Association ID is missing.

399052 E AHL_MC_ITEMGRP_NAME_NULL

Group name is mandatory.



C.5.3.3 Public AHL_MC_MasterConfig_PUB:Error messages for AHL_MC_MasterConfig_PUB -

Num-ber

Type Name Text

399021 E AHL_MC_TL_MISSING TL record missing for relationship ID (&RSHIP).

399022 E AHL_MC_CPYPARENT_NULL Error during Copy Configuration: Parent relation-ship is mandatory.

399023 E AHL_MC_CPYPARENT_INVALID

Error during Copy Configuration: Parent Relation-ship ID(&RSHIP) is invalid.

399024 E AHL_MC_CPYMASTER_NULL Error during Copy Configuration: Master Configu-ration ID is null.

399025 E AHL_MC_CPYMASTER_INVALID

Error during Copy Configuration: Master Configu-ration ID(&RSHIP) is invalid.

399026 E AHL_MC_CPYMASTER_TOPN-ODE

Error during Copy Configuration: Master Configu-ration ID(&RSHIP) is invalid.

399027 E AHL_MC_POSREF_INVALID Position reference (&POSREF) is invalid.

399028 E AHL_MC_RATIO_INVALID Counter rule Ratio (&RATIO) for position reference(&POSREF) is invalid.

399029 E AHL_MC_RNAME_EXISTS Master Configuration name (&RNAME) alreadyexists.

399030 E AHL_MC_POSREF_NULL Position Reference is mandatory.

399031 E AHL_MC_STATUS_INVALID Master Configuration Status (&CODE) for position(&POSREF) is invalid.

399032 E AHL_MC_STATUS_NULL Master Configuration status is mandatory.

399033 E AHL_MC_RSHIP_INVALID Relationship ID (&RSHIP) for position reference(&POSREF) is invalid.

399034 E AHL_MC_RCODE_INVALID Rule code (&RULE_CODE) is invalid.



399035 E AHL_MC_RCODE_NULL Rule code for (&POSREF) is mandatory.

399036 E AHL_MC_DATE_INVALID Start Date (&SDATE) must be less than or equal toEnd Date (&EDATE).

399037 E AHL_MC_QUANTITY_INVALID Quantity(&QUANTITY) for position reference(&POSREF) is invalid.

399038 E AHL_MC_DISPORD_INVALID Display Order (&DISP_ORD) for position reference(&POSREF) is invalid.

399039 E AHL_MC_PARENT_INVALID Parent relationship ID not found for position refer-ence (&POSREF).

399040 E AHL_MC_PARCHD_INVALID Position reference (&CHILD) already exists for par-ent (&PARENT).

399041 E AHL_MC_UOM_NULL UOM for position reference (&POSREF) is manda-tory.

399042 E AHL_MC_UOM_INVALID UOM (&UOM_CODE) for position reference(&POSREF) is invalid.

399043 E AHL_MC_RNAME_NOUPDATE Master Configuration name cannot be updated.

399044 E AHL_MC_CTR_RSHIP_NULL Relationship ID for Position reference (&POSREF) ismandatory.

399045 E AHL_MC_CTR_RSHIP_INVALID Relationship ID for position reference (&POSREF) isinvalid

399046 E AHL_MC_CTRRULE_EXISTS Counter rule (&UOM_CODE) already exists forposition (&POSREF).

399047 E AHL_MC_NAME_INVALID Master Configuration name for position reference(&POSREF) is mandatory.

399053 E AHL_MC_PCTRID_INVALID Counter Rule ID for &UOM_RULE is missing.




Unit Configuration Public

D
Unit Configuration Public APIs
A Unit Configuration is a logical model of a unit, that is, all the tracked partsphysically attached together, in a parent-child manner.

A “unit” is a tracked part, which can have a hierarchy of child parts attached.

In the Maintenance, Repair and Overhaul (MRO) industry, the two major factorsthat determine maintenance actions are “as-installed” configuration andmaintenance requirements of a unit. As installed configuration of a unit means allthe tracked parts that are currently installed to a unit. Not all the parts requiremaintenance action. Unit Configuration is designed to track those parts that requirespecial attention because they have impact on maintenance actions.

The functional areas addressed are in this phase are:

D.1 Manage Equipment As-Installed ConfigurationsWhen a product is in service, some components may need replacement formaintenance and modification / upgrade purposes. Knowing the current(as-installed) configuration is critical to plan the required maintenance actions. UnitConfiguration provides the following functions :

■ Track as-installed configuration of a complex assembly.

■ Track installation and removal (part to position relationship) and history.

D.1.1 Track Utilization of a UnitThe utilization of a unit is a major factor determining the maintenance required.When an assembly is made up of different components, which may require differentparameters to measure utilization and aging , the resulting maintenance forecastprocess can be complicated. Unit Configuration will precisely track the utilization of

APIs D-1

Manage Equipment As-Installed Configurations

each individual component within an assembly by providing the followingfunctions :

■ Track current utilization of units, such as age, odometer reading, flight hourssince overhaul, etc. The appropriate unit of measured will be applied to suitdifferent types of utilization / aging.

■ Track utilization history of a unit

D.1.2 Closed Loop Asset ManagementA unit and it’s vital business information are likely to be tracked by multiplesystems throughout its service life. To build a continuous “cradle-to-grave” eventhistory of a unit may require great efforts. The concept of Unit Configuration toprovide an anchor to tie all the transactions required to build the full history of aunit :

■ Track all transactions associated to location and status (serviceable /unserviceable) changes of a unit.

D.1.3 Track Unit Specific Business InformationSome critical business information are resided at the individual unit level, and willrequire special attention and tracking. Unit Configuration provides a platform totrack the “unit-specific” information.

■ Track unit specific business information such as ownership.

■ Inquiry.

D.1.4 Unit Configuration Public PackagesThis module provides public packages to build unit configurations and replaceparts with alternates.

List of Packages■ Public AHL_UC_UnitConfig_PUB.

■ This package provides an API to build, modify and delete unit configurations.


Table 1-1 AHL_UC_UnitConfig_PUB APIs

D-2 Product Title/BookTitle as a Variable


D.1.4.1 Package AHL_UC_UnitConfig_PUBThis package provides for operations to build/modify/remove a configuration orparts thereof that is based on a master configuration. It contains the following API.

■ Process_Unit_Configuration.

D.1.4.2 Process_Unit_Configuration


PROCEDURE Process_Unit_Configuration (





p_module_type IN VARCHAR2 := NULL,

p_x_uc_header_rec IN OUT NOCOPY AHL_UC_UnitConfig_PVT.UC_Header_Rec_Type,

p_x_uc_instance_tbl IN OUT NOCOPY AHL_UC_UnitConfig_PVT.UC_Instance_Tbl_Type,




Current Version1.0


2-1 Process_Unit_Configuration IN Parameters

Name Description

Process_Unit_Configuration This procedure performs the create/update/modify operations ona unit configuration with the given specifications.

Unit Configuration Public APIs D-3



2-2 Process_Unit_Configuration IN OUT Parameters


2-3 Process_Unit_Configuration OUT Parameters



p_init_msg_list VARCHAR2 Optional Initialises the error message stack if this value is setto FND_API.G_TRUE. The default value is FND_API.G_FALSE.

p_commit VARCHAR2 Optional If this is set to FND_API.G_TRUE then the APIcommits the transaction before it exits. Default valueis FND_API.G_FALSE.

p_validation_level NUMBER Optional This value indicates the level of validation that theAPI will perform. Irrespective of its value, this APIwill perform full validation.

P_module_type VARCHAR2 Optional Its value should always be NULL. This parameter isfor internal use only.


p_x_uc_header_rec AHL_UC_UnitConfig_PVT.UC_Header_Rec_Type,

Yes Datastructure containing the unit configurationheader specifications.

p_x_uc_instance_tbl AHL_UC_UnitConfig_PVT.UC_Instance_Tbl_Type

Yes Datastructure containing specifications for theindividual units/parts associated to the headerrecord. This is a table of records which are of typeAHL_UC_UnitConfig_PVT.UC_Instance_Rec_Type.




D.1.5 Data Structure Specifications

The following data structures are used in Process_Unit_Configuration API definedin package AHL_UC_UnitConfig_PUB package.

■ AHL_UC_UnitConfig_PVT.UC_Header_Rec_Type

■ AHL_UC_UnitConfig_PVT.UC_Instance_Tbl_Type

■ AHL_UC_UnitConfig_PVT.UC_Instance_Rec_Type

D.1.5.1 AHL_UC_UnitConfig_PVT.UC_Header_Rec_TypeThis record structure holds all details for manipulating the Unit ConfigurationHeader record.


TYPE UC_Header_Rec_Type IS RECORD (

UNIT_CONFIG_HEADER_ID NUMBER := FND_API.G_MISS_NUM,


MASTER_CONFIG_ID NUMBER := FND_API.G_MISS_NUM,

MASTER_CONFIG_NAME VARCHAR2(80) := FND_API.G_MISS_CHAR,

PARTY_TYPE VARCHAR2(30) := FND_API.G_MISS_CHAR,






x_msg_data VARCHAR2 The message text if there is only one message on the errorstack.



OWNER_NUMBER VARCHAR2(30) := FND_API.G_MISS_CHAR,

OWNER_ID NUMBER := FND_API.G_MISS_NUM,

OWNER_SITE_NUMBER VARCHAR2(30) := FND_API.G_MISS_CHAR,

OWNER_SITE_ID NUMBER := FND_API.G_MISS_NUM,

UNIT_CONFIG_STATUS_CODE VARCHAR2(15) := FND_API.G_MISS_CHAR,

UNIT_CONFIG_STATUS_MEANING VARCHAR2(80) :=

FND_API.G_MISS_CHAR,

CSI_ITEM_INSTANCE_ID NUMBER := FND_API.G_MISS_NUM,

CSI_INSTANCE_NUM VARCHAR2(30) := FND_API.G_MISS_CHAR,

CSI_TRANSACTION_ID NUMBER := FND_API.G_MISS_NUM,



























CSI_OBJECT_VERSION_NUMBER NUMBER := FND_API.G_MISS_NUM,

CSI_PARTY_OBJECT_VERSION_NUM NUMBER := FND_API.G_MISS_NUM,


OPERATION_FLAG VARCHAR2(1) := null

);

D.1.5.2 AHL_UC_UnitConfig_PVT.UC_Instance_Tbl_TypeThis table structure is a table of records of the type:

AHL_UC_UnitConfig_PVT.UC_Instance_Rec_Type.

D.1.5.3 AHL_UC_UnitConfig_PVT.UC_Instance_Rec_TypeThis record structure holds all the data attributes for the item instances.


TYPE UC_Instance_Rec_Type IS RECORD (

MC_RELATIONSHIP_ID NUMBER := FND_API.G_MISS_NUM,


INVENTORY_ITEM_NAME VARCHAR2(2000) := FND_API.G_MISS_CHAR,

INVENTORY_ORG_CODE VARCHAR2(3) := FND_API.G_MISS_CHAR,


SERIAL_NUMBER VARCHAR2(30) := FND_API.G_MISS_CHAR,

SERIALNUM_TEMP_FLAG VARCHAR2(1) := FND_API.G_MISS_CHAR,



REVISION VARCHAR2(3) := FND_API.G_MISS_CHAR,

MFG_DATE DATE := FND_API.G_MISS_DATE,

LOT_NUMBER VARCHAR2(30) := FND_API.G_MISS_CHAR,

CSI_PARENT_INSTANCE_NUM VARCHAR2(30) := FND_API.G_MISS_CHAR,

CSI_PARENT_INSTANCE_ID NUMBER := FND_API.G_MISS_NUM,

CSI_INSTANCE_NUM VARCHAR2(30) := FND_API.G_MISS_CHAR,



CSI_ITEM_INSTANCE_ID NUMBER := FND_API.G_MISS_NUM,

CSI_OBJECT_VERSION NUMBER := FND_API.G_MISS_NUM,

CSI_NEW_INSTANCE_NUM VARCHAR2(30) := FND_API.G_MISS_CHAR,

CSI_NEW_INSTANCE_ID NUMBER := FND_API.G_MISS_NUM,

CSI_NEW_OBJECT_VERSION NUMBER := FND_API.G_MISS_NUM,

CSI_II_RELATIONSHIP_ID NUMBER := FND_API.G_MISS_NUM,

CSI_II_OBJECT_VERSION NUMBER := FND_API.G_MISS_NUM,

CONTEXT VARCHAR2(30) := FND_API.G_MISS_CHAR,






















PARENT_NODE_REC_INDEX NUMBER := FND_API.G_MISS_NUM

);

4. Messages and NotificationsThe status messages associated with the Master Configuration public APIs are



divided into the following sections:

Common Messages

Messages from specific modules.

D.1.5.4 Common MessagesThe following table describes a lists of common error messages and notificationsthat the Unit Configuration API can generate. Note that not all messages arereturned by all APIs.

5.1.1 Common Task API Messages

D.1.5.5 AHL_UC_UnitConfig_PUBError messages for Public AHL_UC_UnitConfig_PUB in same format as CommonMessages.

5.2.1 API Messages


399404 E AHL_COM_RECORD_DELETED

Record has been deleted.

399401 E AHL_COM_KEY_NOUPDATE Primary key cannot be updated.

399403 E AHL_COM_RECORD_CHANGED

Record has been modified by another user.

399405 E AHL_COM_REQD_PARAM_MISSING

Required parameter is missing.


399100 AHL_UC_PTYPE_INVALID Unit Configuration party type (&PARTY_TYPE)is invalid.

399101 AHL_UC_OWNER_INVALID Unit Configuration owner (&OWNER) is invalid.

399102 AHL_UC_OWNER_NULL Unit Configuration owner is null.

399103 AHL_UC_LOCATION_INVALID Unit Configuration location (&LOCATION) isinvalid.



399104 AHL_UC_LOCATION_NULL Unit Configuration location is null.

399105 AHL_UC_NAME_MISSING Unit Configuration name(&NAME) not found.

399106 AHL_UC_NAME_NULL Unit Configuration name is null."

399107 AHL_UC_TXN_CODE_INVALID Transaction type (&CODE) not setup in InstalledBase.

399108 AHL_UC_INVGRP_MISMATCH Inventory item does not exist in Item group forposition (&POSN_REF).

399109 AHL_UC_POSNQTY_MISMATCH Quantity(&QTY) does not match the quantitydefined at position(&POSN_REF) level.

399110 AHL_UC_ITEMQTY_MISMATCH Quantity(&QTY) does not match quantitydefined at Item level for position(&POSN_REF).

399111 AHL_UC_REVISION_NULL Revision is null. For items under revision control,revision is mandatory.

399112 AHL_UC_REVISION_MISMATCH Revision(&REV) does not match the revisiondefined at Item level for position(&POSN_REF).

399113 AHL_UC_SERIAL_NULL Serial number is mandatory.

399114 AHL_UC_SERIAL_INVALID Serial number(&SERIAL) for inventoryitem(&INV_ITEM) is invalid.

399115 AHL_UC_SRLQTY_MISMATCH For serialized item(&INV_ITEM)quantity(&QTY) must be 1.

399116 E AHL_UC_SERIAL_NOTNULL For non-serialized item(&INV_ITEM) serialnumber(&SERIAL) must be null.

399117 E AHL_UC_QTY_NULL Quantity for item(&INV_ITEM) is null.

399118 E AHL_UC_QTY_INVALID Quantity(&QTY) for item(&INV_ITEM) isinvalid.

399119 AHL_UC_UOM_INVALID UOM(&UOM) for item(&INV_ITEM) is invalid

399120 AHL_UC_LOT_NULL Lot number for item(&INV_ITEM) is null.

399121 AHL_UC_LOT_INVALID Lot number(&LOT) for item(&INV_ITEM) isinvalid.

399122 AHL_UC_LOT_NOTNULL Lot number(&LOT) for item(&INV_ITEM) mustbe null.



399123 AHL_UC_REV_NULL Revision for item(&INV_ITEM) is null.

399124 AHL_UC_REV_INVALID Revision(&REV) for item(&INV_ITEM) isinvalid.

399125 AHL_UC_REV_NOTNULL Revision(&REV) for item(&INV_ITEM) is notnull.

399126 AHL_UC_INVITEM_NULL Inventory item is null for position(&POSN_REF).

399127 AHL_UC_INVITEM_INVALID Inventory item(&INV_ITEM) is invalid forposition(&POSN_REF).

399128 AHL_UC_TMPSERIAL_INVALID Temporary serial number flag(&FLAG) foritem(&INV_ITEM) must be 'Y' or 'N'.

399129 AHL_UC_MFGDATE_INVALID Manufacturing date(&DATE) for item(&INV_ITEM) must be less than today.

399131 AHL_UC_ATTRIB_CODE_MISSING

Extended Attribute code(&CODE) has not beensetup in Installed Base.

399133 AHL_UC_II_RELN_NOTFOUND Instance relationship record not found forinstance(&INSTANCE_ID) andposition(&POSN_REF).

399134 AHL_UC_RSHIP_NOTFOUND Relationship(&RSHIP) not found for the MasterConfiguration.

399135 AHL_UC_RSHIP_NULL Relationship is mandatory.

399136 AHL_UC_PARSTAT_INVALID Parent Instance status(&STATUS) forposition(&POSN_REF) is invalid.

399137 AHL_UC_TOP_NODE Cannot add item to top node.

399138 AHL_UC_PARINST_NOTFOUND Parent instance record not found forposition(&POSN_REF).

399139 AHL_UC_ITEM_NOTASSIGNED Item has not been assigned to thisposition(&POSN_REF).

399140 AHL_UC_ITEMTYPE_INVALID Item type(&ITYPE) for non-serialized parentitem(&INV_ITEM) must be either an ATO or aPTO.

399141 AHL_UC_PARQTY_INVALID Quantity(&QTY) for parent item(&INV_ITEM)must be 1.



399142 AHL_UC_CHILD_INSTANCE The item instance(&INSTANCE_ID) is not a topnode or unit instance.

399143 AHL_UC_PARTY_INVALID Unit Configuration party(&PARTY_ID) isinvalid.

399144 AHL_UC_PRTYLOC_INVALID Location is invalid for selected owner name.

399145 AHL_UC_STATUS_NULL Unit Configuration status is null.

399146 AHL_UC_STATUS_INVALID Unit Configuration status(&STATUS) is invalid.

399147 AHL_UC_STARTDATE_NULL Start Date is null.

399148 AHL_UC_DATES_INVALID Start date must be less than End date.

399149 AHL_UC_RSHIP_NODE Master Configuration ID(&RSHIP) is not the topnode.

399150 AHL_MC_STATUS_DRAFT The status of Master Configuration is draft.

399151 AHL_UC_CLOSED Unit Configuration is closed.

399152 AHL_UC_INST_STATUS_INVALID

Instance status(&STATUS) for position(&POSN_REF) is invalid.

399153 AHL_UC_ENDDATE_INVALID End date(&EDATE) must be greater than today.

399154 AHL_UC_PTYPE_NULL Party Type is null.

399155 AHL_UC_CHILD_DELETED Child Instance(&CHILD) has been deleted.

399156 AHL_UC_II_SUBJECT_MISMATCH

Subject ID(&SUBJECT) and InstanceID(&INSTANCE_ID) do not match forposition(&POSN_REF).

399157 AHL_UC_MCID_MISMATCH Position Reference(&II_POSN) and relationshipID(&MCID) do not match for position(&POSN_REF).

399158 AHL_UC_PARENT_INST_MISMATCH

Parent Instance ID's do not match forposition(&POSN_REF).

399159 AHL_UC_INST_NOTFOUND Instance(&INSTANCE_ID) record forposition(&POSN_REF) not found in InstalledBase.

399160 AHL_UC_ITEM_ASSIGNED Item has already been assigned to thisposition(&POSN_REF).



399161 AHL_UC_PARINST_INVALID Parent Instance(&INSTANCE_ID) passed toValidate_CSIParent routine does not exist.

399162 AHL_UC_PARINST_NULL Parent Instance parameter is required.

399163 AHL_UC_NAME_DUPLICATE Unit Configuration already exists for thisname(&NAME).

399164 AHL_UC_HEADER_NULL Unit Configuration header ID is mandatory.

399165 AHL_UC_STATUS_DRAFT Cannot change the status back to draft


