Oracle Install Base. API Reference Guide. Release 11i. October 2001 Part No. A

Transcription

1 Oracle Install Base API Reference Guide Release 11i October 2001 Part No. A

2 Oracle Install Base API Reference Guide, Release 11i Part No. A Copyright 2001, Oracle Corporation. All rights reserved. The Programs (which include both the software and documentation) contain proprietary information of Oracle Corporation; they are provided under a license agreement containing restrictions on use and disclosure and are also protected by copyright, patent and other intellectual and industrial property laws. Reverse engineering, disassembly or decompilation of the Programs, except to the extent required to obtain interoperability with other independently created software or as specified by law, is prohibited. The information contained in this document is subject to change without notice. If you find any problems in the documentation, please report them to us in writing. Oracle Corporation does not warrant that this document is error-free. Except as may be expressly permitted in your license agreement for these Programs, no part of these Programs may be reproduced or transmitted in any form or by any means, electronic or mechanical, for any purpose, without the express written permission of Oracle Corporation. If the Programs are delivered to the U.S. Government or anyone licensing or using the programs on behalf of the U.S. Government, the following notice is applicable: Restricted Rights Notice Programs delivered subject to the DOD FAR Supplement are "commercial computer software" and use, duplication, and disclosure of the Programs, including documentation, shall be subject to the licensing restrictions set forth in the applicable Oracle license agreement. Otherwise, Programs delivered subject to the Federal Acquisition Regulations are "restricted computer software" and use, duplication, and disclosure of the Programs shall be subject to the restrictions in FAR , Commercial Computer Software - Restricted Rights (June, 1987). Oracle Corporation, 500 Oracle Parkway, Redwood City, CA The Programs are not intended for use in any nuclear, aviation, mass transit, medical, or other inherently dangerous applications. It shall be the licensee's responsibility to take all appropriate fail-safe, backup, redundancy, and other measures to ensure the safe use of such applications if the Programs are used for such purposes, and Oracle Corporation disclaims liability for any damages caused by such use of the Programs. Oracle is a registered trademark, and Oracle8, Oracle8i, OracleMetaLink, and SQL*Plus are trademarks or registered trademarks of Oracle Corporation. Other names may be trademarks of their respective owners.

3 Contents Send Us Your Comments... v Preface... vii Audience for This Guide... Documentation Accessibility... How To Use This Guide... Other Information Sources... Do Not Use Database Tools to Modify Oracle Applications Data... About Oracle... vii vii viii viii xiii xiv 1 Oracle Install Base Public APIs 1.1 Install Base Public Packages Package CSI_ITEM_INSTANCE_PUB Create_Item_Instance Update_Item_Instance Expire_Item_Instance Get_Item_Instances Get_Item_Instance_Details Copy_Item_Instance Package CSI_INSTANCE_RELATIONSHIPS_PUB Create_Relationship Update_Relationship Expire_Relationship Get_Relationship iii

4 iv 1.4 Package CSI_SYSTEMS_PUB Create_System Update_System Expire_System Get_System Data Structure Specifications party_account_query_rec party_account_rec party_query_rec party_rec party_header_rec instance_rec instance_query_rec instance_header_rec transaction_rec party_account_query_rec system_rec ext_attrib_rec extend_attrib_values_rec pricing_attribs_rec organization_units_rec instance_asset_rec account_header_rec org_units_header_rec instance_asset_header_rec org_units_header_rec Messages and Notifications

5 Send Us Your Comments Oracle Install Base API Reference Guide, Release 11i Part No. A Oracle Corporation welcomes your comments and suggestions on the quality and usefulness of this document. Your input is an important part of the information used for revision. Did you find any errors? Is the information clearly presented? Do you need more information? If so, where? Are the examples correct? Do you need more examples? What features did you like most? If you find any errors or have any other suggestions for improvement, please indicate the document title and part number, and the chapter, section, and page number (if available). You can send comments to us by mail: CRM Content Development Manager Oracle Corporation 500 Oracle Parkway Redwood Shores, CA U.S.A. If you would like a reply, please give your name, address, telephone number, and (optionally) electronic mail address. If you have problems with the software, please contact your local Oracle Support Services. v

6 vi

7 Preface Audience for This Guide Welcome to Release 11i of the Oracle Install Base API Reference Guide. This guide assumes you have a working knowledge of the following: The principles and customary practices of your business area. If you have never used Oracle Install Base, Oracle suggests you attend one or more of the Oracle Install Base training classes available through Oracle University. The Oracle Applications graphical user interface. To learn more about the Oracle Applications graphical user interface, read the Oracle Applications User s Guide. See Other Information Sources for more information about Oracle Applications product information. Documentation Accessibility Our goal is to make Oracle products, services, and supporting documentation accessible, with good usability, to the disabled community. To that end, our documentation includes features that make information available to users of assistive technology. This documentation is available in HTML format, and contains markup to facilitate access by the disabled community. Standards will continue to evolve over time, and Oracle Corporation is actively engaged with other market-leading technology vendors to address technical obstacles so that our documentation can be accessible to all of our customers. For additional information, vii

8 How To Use This Guide visit the Oracle Accessibility Program Web site at Accessibility of Code Examples in Documentation JAWS, a Windows screen reader, may not always correctly read the code examples in this document. The conventions for writing code require that closing braces should appear on an otherwise empty line; however, JAWS may not always read a line of text that consists solely of a bracket or brace. Accessibility of Links to External Web Sites in Documentation This documentation may contain links to Web sites of other companies or organizations that Oracle Corporation does not own or control. Oracle Corporation neither evaluates nor makes any representations regarding the accessibility of these Web sites. This document contains the information you need to use Oracle Install Base application programming interfaces (APIs). Chapter 1 provides the Oracle Install Base APIs and associated messages. Other Information Sources You can choose from many sources of information, including online documentation, training, and support services, to increase your knowledge and understanding of Oracle Install Base. If this guide refers you to other Oracle Applications documentation, use only the Release 11i versions of those guides. Online Documentation All Oracle Applications documentation is available online (HTML or PDF). Online help patches are available on MetaLink. Related Documentation Oracle Install Base shares business and setup information with other Oracle Applications products. Therefore, you may want to refer to other product documentation when you set up and use Oracle Install Base. You can read the documents online by choosing Library from the expandable menu on your HTML help window, by reading from the Oracle Applications Document viii

9 Library CD included in your media pack, or by using a Web browser with a URL that your system administrator provides. If you require printed guides, you can purchase them from the Oracle Store at Documents Related to All Products Oracle Applications User s Guide This guide explains how to enter data, query, run reports, and navigate using the graphical user interface (GUI) available with this release of Oracle Install Base (and any other Oracle Applications products). This guide also includes information on setting user profiles, as well as running and reviewing reports and concurrent processes. You can access this user s guide online by choosing "Getting Started with Oracle Applications" from any Oracle Applications help file. Documents Related to This Product Oracle Install Base Implementation Guide Refer to this guide for information about installing the application. Oracle Install Base Concepts and Procedures This guide provides information about using the application. Oracle Enterprise Install Base Implementation Guide Refer to this guide to understand the implementation of a closely related application. Installation and System Administration Oracle Applications Concepts This guide provides an introduction to the concepts, features, technology stack, architecture, and terminology for Oracle Applications Release 11i. It provides a useful first book to read before an installation of Oracle Applications. This guide also introduces the concepts behind Applications-wide features such as Business Intelligence (BIS), languages and character sets, and Self-Service Web Applications. ix

10 Installing Oracle Applications This guide provides instructions for managing the installation of Oracle Applications products. In Release 11i, much of the installation process is handled using Oracle Rapid Install, which minimizes the time to install Oracle Applications, the Oracle8 technology stack, and the Oracle8i Server technology stack by automating many of the required steps. This guide contains instructions for using Oracle Rapid Install and lists the tasks you need to perform to finish your installation. You should use this guide in conjunction with individual product user s guides and implementation guides. Oracle Applications Supplemental CRM Installation Steps This guide contains specific steps needed to complete installation of a few of the CRM products. The steps should be done immediately following the tasks given in the Installing Oracle Applications guide. Upgrading Oracle Applications Refer to this guide if you are upgrading your Oracle Applications Release 10.7 or Release 11.0 products to Release 11i. This guide describes the upgrade process and lists database and product-specific upgrade tasks. You must be either at Release 10.7 (NCA, SmartClient, or character mode) or Release 11.0, to upgrade to Release 11i. You cannot upgrade to Release 11i directly from releases prior to Maintaining Oracle Applications Use this guide to help you run the various AD utilities, such as AutoUpgrade, AutoPatch, AD Administration, AD Controller, AD Relink, License Manager, and others. It contains how-to steps, screenshots, and other information that you need to run the AD utilities. This guide also provides information on maintaining the Oracle applications file system and database. Oracle Applications System Administrator s Guide This guide provides planning and reference information for the Oracle Applications System Administrator. It contains information on how to define security, customize menus and online help, and manage concurrent processing. Oracle Alert User s Guide This guide explains how to define periodic and event alerts to monitor the status of your Oracle Applications data. x

11 Oracle Applications Developer s Guide This guide contains the coding standards followed by the Oracle Applications development staff. It describes the Oracle Application Object Library components needed to implement the Oracle Applications user interface described in the Oracle Applications User Interface Standards for Forms-Based Products. It also provides information to help you build your custom Oracle Forms Developer 6i forms so that they integrate with Oracle Applications. Oracle Applications User Interface Standards for Forms-Based Products This guide contains the user interface (UI) standards followed by the Oracle Applications development staff. It describes the UI for the Oracle Applications products and how to apply this UI to the design of an application built by using Oracle Forms. Other Implementation Documentation Multiple Reporting Currencies in Oracle Applications If you use the Multiple Reporting Currencies feature to record transactions in more than one currency, use this manual before implementing Oracle Install Base. This manual details additional steps and setup considerations for implementing Oracle Install Base with this feature. Multiple Organizations in Oracle Applications This guide describes how to set up and use Oracle Install Base with Oracle Applications Multiple Organization support feature, so you can define and support different organization structures when running a single installation of Oracle Install Base. Oracle Workflow Guide This guide explains how to define new workflow business processes as well as customize existing Oracle Applications-embedded workflow processes.you also use this guide to complete the setup steps necessary for any Oracle Applications product that includes workflow-enabled processes. Oracle Applications Flexfields Guide This guide provides flexfields planning, setup and reference information for the Oracle Install Base implementation team, as well as for users responsible for the ongoing maintenance of Oracle Applications product data. This manual also provides information on creating custom reports on flexfields data. xi

12 Oracle etechnical Reference Manuals Each etechnical Reference Manual (etrm) contains database diagrams and a detailed description of database tables, forms, reports, and programs for a specific Oracle Applications product. This information helps you convert data from your existing applications, integrate Oracle Applications data with non-oracle applications, and write custom reports for Oracle Applications products. Oracle etrm is available on Metalink Oracle Manufacturing APIs and Open Interfaces Manual This manual contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems. This documentation includes APIs and open interfaces found in Oracle Manufacturing. Oracle Order Management Suite APIs and Open Interfaces Manual This manual contains up-to-date information about integrating with other Oracle Manufacturing applications and with your other systems. This documentation includes APIs and open interfaces found in Oracle Order Management Suite. Oracle Applications Message Reference Manual This manual describes Oracle Applications messages. This manual is available in HTML format on the documentation CD-ROM for Release 11i. Oracle CRM Application Foundation Implementation Guide Many CRM products use components from CRM Application Foundation. Use this guide to correctly implement CRM Application Foundation. Training and Support Training Oracle offers training courses to help you and your staff master Oracle Install Base and reach full productivity quickly. You have a choice of educational environments. You can attend courses offered by Oracle University at any one of our many Education Centers, you can arrange for our trainers to teach at your facility, or you can use Oracle Learning Network (OLN), Oracle University s online education utility. In addition, Oracle training professionals can tailor standard courses or develop custom courses to meet your needs. For example, you may want to use your organization s structure, terminology, and data as examples in a customized training session delivered at your own facility. xii

13 Support From on-site support to central support, our team of experienced professionals provides the help and information you need to keep Oracle Install Base working for you. This team includes your Technical Representative, Account Manager, and Oracle s large staff of consultants and support specialists with expertise in your business area, managing an Oracle8i server, and your hardware and software environment. OracleMetaLink OracleMetaLink is your self-service support connection with web, telephone menu, and alternatives. Oracle supplies these technologies for your convenience, available 24 hours a day, 7 days a week. With OracleMetaLink, you can obtain information 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 ( Alerts: You should check OracleMetaLink alerts before you begin to install or upgrade any of your Oracle Applications. Navigate to the Alerts page as follows: Technical Libraries/ERP Applications/Applications Installation and Upgrade/Alerts. Self-Service Toolkit: You may also find information by navigating to the Self-Service Toolkit page as follows: Technical Libraries/ERP Applications/Applications Installation and Upgrade. Do Not Use Database Tools to Modify Oracle Applications Data Oracle STRONGLY RECOMMENDS that you never use SQL*Plus, Oracle Data Browser, database triggers, or any other tool to modify Oracle Applications data unless otherwise instructed. Oracle provides powerful tools you can use to create, store, change, retrieve, and maintain information in an Oracle database. But if you use Oracle tools such as SQL*Plus to modify Oracle Applications data, you risk destroying the integrity of your data and you lose the ability to audit changes to your data. Because Oracle Applications tables are interrelated, any change you make using Oracle Applications can update many tables at once. But when you modify Oracle Applications data using anything other than Oracle Applications, you may change a row in one table without making corresponding changes in related tables. If your tables get out of synchronization with each other, you risk xiii

14 About Oracle retrieving erroneous information and you risk unpredictable results throughout Oracle Applications. When you use Oracle Applications to modify your data, Oracle Applications automatically checks that your changes are valid. Oracle Applications also keeps track of who changes information. If you enter information into database tables using database tools, you may store invalid information. You also lose the ability to track who has changed your information because SQL*Plus and other database tools do not keep a record of changes. Oracle Corporation develops and markets an integrated line of software products for database management, applications development, decision support, and office automation, as well as Oracle Applications, an integrated suite of more than 160 software modules for financial management, supply chain management, manufacturing, project systems, human resources and customer relationship management. Oracle products are available for mainframes, minicomputers, personal computers, network computers and personal digital assistants, allowing organizations to integrate different computers, different operating systems, different networks, and even different database management systems, into a single, unified computing and information resource. Oracle is the world s leading supplier of software for information management, and the world s second largest software company. Oracle offers its database, tools, and applications products, along with related consulting, education, and support services, in over 145 countries around the world. xiv

15 1 Oracle Install Base Public APIs The following PL/SQL public APIs are covered in this document : Item instance management APIs Instance-to-Instance relationships management APIs System APIs API messages 1.1 Install Base Public Packages The APIs provided for the new Install Base are organized into the following packages : CSI_DATASTRUCTURES_PUB: Contains all public datastructures exposed to Install Base API users. CSI_ITEM_INSTANCE_PUB: Contains all APIs for item instance management. CSI_INSTANCE_RELATIONSHIP_PUB: Contains all APIs to manage instance-to-instance relationships (instance configuration). CSI_SYSTEMS_PUB: Contains APIs for creating, updating and deleting the systems. The following tables describe the public APIs discussed in this chapter. Oracle Install Base Public APIs 1-1

16 Install Base Public Packages Table 1 1 CSI_ITEM_INSTANCE_PUB APIs Name Description Create_Item_instance Update_Item_Instance Expire_Item_Instance Get_Item_Instance Get_Item_Instance_Details Copy_Item_Instance This procedure creates an item instance in Install Base along with its child entities. The child entities include associated parties, accounts, organization units, extended attributes, pricing attributes, and asset associations. The child entities are optional except for the owner party and owner account if the instance is owned by an external party. This procedure updates an existing item instance and its child entities in Install Base. This procedure expires an Install Base item instance. This procedure gets a list of item instances in Install Base satisfying the query criteria provided by the calling application. This procedure get the details of an item instance and its child entities. This procedure creates a new item instance and its child entities in Install Base by copying an existing item instance. Table 1 2 CSI_II_RELATIONSHIPS_PUB APIs Name Description Create_Relationship Update_Relationship Expire_Relationship Get_Relationships This procedure creates relationship(s) between item instance. This procedure updates relationship(s) between item instance. This procedure expires relationship(s) between item instance. This procedure gets the list of relationship(s) among item instances. 1-2 Oracle Install Base API Reference Guide

17 Package CSI_ITEM_INSTANCE_PUB Table 1 3 CSI_SYSTEMS_PUB APIs Name Description Create_System Update_System Expire_System Get_Systems This procedure creates a system. This procedure updates a system. This procedure expires a system. This procedure gets systems. 1.2 Package CSI_ITEM_INSTANCE_PUB Create_Item_Instance Contains all APIs for item instance management: Create_Item_Instance Update_Item_Instance Expire_Item_Instance Get_Item_Instance Get_Item_Instance_Details Copy_Item_Instance PROCEDURE create_item_instance ( p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_instance_rec IN OUT csi_datastructures_pub.instance_rec,p_ext_attrib_values_tbl IN OUT csi_datastructures_pub.extend_attrib_values_tbl,p_party_tbl IN OUT csi_datastructures_pub.party_tbl,p_account_tbl IN OUT csi_datastructures_pub.party_account_tbl Oracle Install Base Public APIs 1-3

18 Package CSI_ITEM_INSTANCE_PUB,p_pricing_attrib_tbl IN OUT csi_datastructures_pub.pricing_attribs_tbl,p_org_assignments_tbl IN OUT csi_datastructures_pub.organization_units_tbl,p_asset_assignment_tbl IN OUT csi_datastructures_pub.instance_asset_tbl,p_txn_rec IN OUT csi_datastructures_pub.transaction_rec,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 ); Current Version 2.2 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 4 Create_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_instance_rec instance_rec Yes Instance record containing the attributes of instance to be created. p_ext_attrib_values_tbl extend_attrib_values_tbl No Extended Attributes p_party_tbl party_tbl Yes Parties to be associated with item instance. p_account_tbl party_account_tbl Yes Accounts to be associated with the parties. p_pricing_attrib_tbl pricing_attribs_tbl No Pricing attributes associated with the Item Instance. 1-4 Oracle Install Base API Reference Guide

19 Package CSI_ITEM_INSTANCE_PUB p_org_assignments_tbl organization_units_tbl No Organization ubit assignments to the item instance. p_asset_assignment_tbl instance_asset_tbl No Asset assignments to the item instance. The following table describes the OUT parameters associated with this API. Table 1 5 Create_Item_Instance Out Parameters Parameter Data Type Descriptions p_instance_rec p_ext_attrib_values_tbl p_party_tbl p_account_tbl p_pricing_attrib_tbl p_org_assignments_tbl p_asset_assignment_tbl p_txn_rec x_return_status x_msg_count x_msg_data instance_rec extend_attrib_values_tbl party_tbl party_account_tbl pricing_attribs_tbl organization_units_tbl instance_asset_tbl transaction_rec VARCHAR2 VARCHAR2 VARCHAR Update_Item_Instance PROCEDURE update_item_instance ( p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_instance_rec IN csi_datastructures_pub.instance_rec Oracle Install Base Public APIs 1-5

20 Package CSI_ITEM_INSTANCE_PUB,p_ext_attrib_values_tbl IN OUT csi_datastructures_pub.extend_attrib_values_tbl,p_party_tbl IN OUT csi_datastructures_pub.party_tbl,p_account_tbl IN OUT csi_datastructures_pub.party_account_tbl,p_pricing_attrib_tbl IN OUT csi_datastructures_pub.pricing_attribs_tbl,p_org_assignments_tbl IN OUT csi_datastructures_pub.organization_units_tbl,p_asset_assignment_tbl IN OUT csi_datastructures_pub.instance_asset_tbl,p_txn_rec IN OUT csi_datastructures_pub.transaction_rec,x_instance_id_lst OUT csi_datastructures_pub.id_tbl,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 6 Update_Item_Instance IN Parameters Parameter Data Type Requir ed Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_instance_rec instance_rec Yes Instance record containing the attributes of instance to be created. p_ext_attrib_values_tbl extend_attrib_values_tbl No Extended Attributes p_party_tbl party_tbl Yes Parties to be associated with item instance. p_account_tbl party_account_tbl Yes Accounts to be associated with the parties. 1-6 Oracle Install Base API Reference Guide

21 Package CSI_ITEM_INSTANCE_PUB p_pricing_attrib_tbl pricing_attribs_tbl No Pricing attributes associated with the Item Instance. p_org_assignments_tbl organization_units_tbl No Organization ubit assignments to the item instance. p_asset_assignment_tbl instance_asset_tbl No Asset assignments to the item instance. p_txn_rec transaction_rec Yes The following table describes the OUT parameters associated with this API. Table 1 7 Update_Item_Instance Out Parameters Parameter Data Type Descriptions p_instance_rec p_ext_attrib_values_tbl p_party_tbl p_account_tbl p_pricing_attrib_tbl p_org_assignments_tbl p_asset_assignment_tbl p_txn_rec x_return_status x_msg_count x_msg_data instance_rec extend_attrib_values_tbl party_tbl party_account_tbl pricing_attribs_tbl organization_units_tbl instance_asset_tbl transaction_rec VARCHAR2 VARCHAR2 VARCHAR Expire_Item_Instance PROCEDURE expire_item_instance Oracle Install Base Public APIs 1-7

22 Package CSI_ITEM_INSTANCE_PUB ( ); p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_instance_rec IN csi_datastructures_pub.instance_rec,p_expire_children IN VARCHAR2 := fnd_api.g_false,p_txn_rec IN OUT csi_datastructures_pub.transaction_rec,x_instance_id_lst OUT csi_datastructures_pub.id_tbl,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 8 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_instance_rec instance_rec Yes Instance record containing the attributes of instance to be created. p_expire_children VARCHAR2 No option to specify whether to expire child component instances or not. Default is fnd_api.g_false p_txn_rec transaction_rec Yes 1-8 Oracle Install Base API Reference Guide

23 Package CSI_ITEM_INSTANCE_PUB The following table describes the OUT parameters associated with this API. Table 1 9 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions p_txn_rec x_instance_id_lst x_return_status x_msg_count x_msg_data transaction_rec id_tbl VARCHAR2 VARCHAR2 VARCHAR Get_Item_Instances PROCEDURE get_item_instances ( p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_instance_query_rec IN csi_datastructures_pub.instance_query_rec,p_party_query_rec IN csi_datastructures_pub.party_query_rec,p_account_query_rec IN csi_datastructures_pub.party_account_query_rec,p_transaction_id IN NUMBER,p_resolve_id_columns IN VARCHAR2 := fnd_api.g_false,p_active_instance_only IN VARCHAR2 := fnd_api.g_true,x_instance_header_tbl OUT csi_datastructures_pub.instance_header_tbl,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 ); Oracle Install Base Public APIs 1-9

24 Package CSI_ITEM_INSTANCE_PUB Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 10 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_instance_query_rec instance_query_rec No query columns for instance p_party_query_rec party_query_rec No query columns for instance parties p_account_query_rec party_account_query_rec No query columns for party accounts p_transaction_id NUMBER No query transaction id p_resolve_id_columns VARCHAR2 No Should the foreign key columns be resolved by the API. This will slow down the processing time for the API but will resolve all the id columns. Default is fnd_ api.g_false p_active_instance_only VARCHAR2 No Query only the instances which are not-expired. Default is fnd_api.g_true. The following table describes the OUT parameters associated with this API Oracle Install Base API Reference Guide

25 Package CSI_ITEM_INSTANCE_PUB Table 1 11 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions x_instance_header_tbl instance_header_tbl table of instance headers holding information about instance fetched by the query constructed by the combination of input parameters. x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Get_Item_Instance_Details PROCEDURE get_item_instance_details ( p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_instance_rec IN OUT csi_datastructures_pub.instance_header_rec,p_get_parties IN VARCHAR2 := fnd_api.g_false,p_party_header_tbl OUT csi_datastructures_pub.party_header_tbl,p_get_accounts IN VARCHAR2 := fnd_api.g_false,p_account_header_tbl OUT csi_datastructures_pub.party_account_header_tbl,p_get_org_assignments IN VARCHAR2 := fnd_api.g_false,p_org_header_tbl OUT csi_datastructures_pub.org_unit_header_tbl,p_get_pricing_attribs IN VARCHAR2 := fnd_api.g_false,p_pricing_attrib_tbl OUT csi_datastructures_pub.pricing_attribs_tbl,p_get_ext_attribs IN VARCHAR2 := fnd_api.g_false Oracle Install Base Public APIs 1-11

26 Package CSI_ITEM_INSTANCE_PUB,p_ext_attrib_tbl OUT csi_datastructures_pub.extend_attrib_values_tbl,p_ext_attrib_def_tbl OUT csi_datastructures_pub.extend_attrib_tbl,p_get_asset_assignments IN VARCHAR2 := fnd_api.g_false,p_asset_header_tbl OUT csi_datastructures_pub.instance_asset_header_tbl,p_resolve_id_columns IN VARCHAR2 := fnd_api.g_false,p_time_stamp IN DATE,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 12 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_instance_rec instance_header_rec Yes instance id is required to pass in p_get_parties VARCHAR2 No Specify whether to fetch information about associated parties. Default is fnd_api.g_ false p_get_accounts VARCHAR2 No Specify whether to fetch information about associated parties accounts. Default is fnd_api.g_false 1-12 Oracle Install Base API Reference Guide

27 Package CSI_ITEM_INSTANCE_PUB p_get_org_assignments VARCHAR2 No Specify whether to fetch information about associated organization units. Default is fnd_api.g_false p_get_pricing_attribs VARCHAR2 No Specify whether to fetch information about instance pricing attributes. Default is fnd_api.g_false p_get_ext_attribs VARCHAR2 No Specify whether to fetch information about instance extended attributes. Default is fnd_api.g_false p_get_asset_ assignments VARCHAR2 No Specify whether to fetch information about instance asset associations. Default is fnd_api.g_false p_time_stamp DATE No The timestamp for which the snapshot of instance and its entities is required. If timestamp is SYSDATE or NULL then the latest values of attributes are fetched from the IB schema. If the timestamp is a past date then the attributes are fetched and constructed from IB history tables. If the timestamp is a future date then an exception is raised. p_account_query_rec party_account_query_rec No query columns for party accounts p_transaction_id NUMBER No query transaction id p_resolve_id_columns VARCHAR2 No Should the foreign key columns be resolved by the API. This will slow down the processing time for the API but will resolve all the id columns. Default is fnd_ api.g_false The following table describes the OUT parameters associated with this API. Oracle Install Base Public APIs 1-13

28 Package CSI_ITEM_INSTANCE_PUB Table 1 13 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions p_instance_rec instance_header_tbl table of instance headers holding information about instance fetched for the instance id provided as input. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. p_party_header_tbl party_header_tbl table of instance party headers holding information about parties associated with instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. p_account_header_tbl party_account_header_tbl table of accounts headers holding information about accounts associated with parties for the item instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. p_org_header_tbl org_unit_header_tbl table of organization units headers holding information about org units associated with the instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application Oracle Install Base API Reference Guide

29 Package CSI_ITEM_INSTANCE_PUB p_pricing_attrib_tbl pricing_attribs_tbl table of pricing attributes holding information about pricing attributes associated with the instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. p_ext_attrib_tbl extend_attrib_values_tbl table of extended attributes values headers holding information about values of extended attribute for the item instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. p_ext_attrib_def_tbl extend_attrib_tbl table of extended attributes headers holding information about the extended attribute applicable to the item instance. p_asset_header_tbl instance_asset_header_tbl table of asset headers holding information about the assets assignments for the item instance. The information may be current or constructed from history depending upon the value of timestamp passed by the calling application. x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Copy_Item_Instance Oracle Install Base Public APIs 1-15

30 Package CSI_ITEM_INSTANCE_PUB PROCEDURE copy_item_instance ( p_api_version IN NUMBER,p_commit IN VARCHAR2 := fnd_api.g_false,p_init_msg_list IN VARCHAR2 := fnd_api.g_false,p_validation_level IN NUMBER := fnd_api.g_valid_level_full,p_source_instance_rec IN csi_datastructures_pub.instance_rec,p_copy_ext_attribs IN VARCHAR2 := fnd_api.g_false,p_copy_org_assignments IN VARCHAR2 := fnd_api.g_false,p_copy_parties IN VARCHAR2 := fnd_api.g_false,p_copy_party_contacts IN VARCHAR2 := fnd_api.g_false,p_copy_accounts IN VARCHAR2 := fnd_api.g_false,p_copy_asset_assignments IN VARCHAR2 := fnd_api.g_false,p_copy_pricing_attribs IN VARCHAR2 := fnd_api.g_false,p_txn_rec IN OUT csi_datastructures_pub.transaction_rec,x_new_instance_tbl OUT csi_datastructures_pub.instance_tbl,x_return_status OUT VARCHAR2,x_msg_count OUT NUMBER,x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 14 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level 1-16 Oracle Install Base API Reference Guide

31 Package CSI_ITEM_INSTANCE_PUB p_source_instance_rec instance_rec Yes instance id is required to pass in. Other instance attributes if passed will be used to override the attributes of the target instance after it is copied from the source instance. p_copy_ext_attribs VARCHAR2 No Specify whether to copy the extended attribute values of the source instance to target instance or not. Default is fnd_api.g_false. p_copy_org_ assignments VARCHAR2 No Specify whether to copy the organization unit assignments of the source instance to target instance or not. Default is fnd_api.g_ false. p_copy_parties VARCHAR2 No Specify whether to copy the associated parties of the source instance to target instance or not. Default is fnd_api.g_false. This is applicable to all the parties except owner party. The owner party is copied regardless of the value of this flag. This is because the new instance cannot be created without an owner. After copy the ownership of the copied instance can be updated. p_copy_party_contacts VARCHAR2 No Specify whether to copy the contact parties of the source instance to target instance or not. Default is fnd_api.g_ false. Each party can have a number of contacts associated with it. A contact itself is maintained in Install Base as a party but marked as a contact in IB schema. Oracle Install Base Public APIs 1-17

32 Package CSI_ITEM_INSTANCE_PUB p_copy_accounts VARCHAR2 No Specify whether to copy the associated party accounts of the source instance to target instance or not. Default is fnd_api.g_false. This is applicable to all the account except the owner account of the owner party if it exist for the source instance. The owner account if it exist, is copied regardless of the value of this flag. p_copy_asset_ assignments VARCHAR2 No Specify whether to copy the asset assignments of the source instance to target instance or not. Default is fnd_api.g_false. p_copy_pricing_attribs VARCHAR2 Specify whether to copy the pricing attributes of the source instance to target instance or not. Default is fnd_api.g_false. p_transaction_rec transaction_rec No transaction record The following table describes the OUT parameters associated with this API. Table 1 15 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions x_new_instance_tbl instance _tbl table containing the information about the instance copied from the source instance. p_transaction_rec transaction_rec transaction record x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages 1-18 Oracle Install Base API Reference Guide

33 Package CSI_INSTANCE_RELATIONSHIPS_PUB 1.3 Package CSI_INSTANCE_RELATIONSHIPS_PUB Create_Relationship Contains all APIs for instance-to-instance relationships management. Create_Relationship Update_Relationship Expire_Relationship Get_Relationship PROCEDURE create_relationship( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_relationship_tbl IN OUT csi_datastructures_pub.ii_relationship_tbl, p_txn_rec IN OUT csi_datastructures_pub.transaction_rec, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 16 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version Oracle Install Base Public APIs 1-19

34 Package CSI_INSTANCE_RELATIONSHIPS_PUB p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_relationship_tbl ii_relationship_tbl Yes table of records for instance-to-instance relationships to be created. p_transaction_rec transaction_rec No transaction record The following table describes the OUT parameters associated with this API. Table 1 17 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions p_transaction_rec transaction_rec transaction record x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Update_Relationship PROCEDURE update_relationship ( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_relationship_tbl IN csi_datastructures_pub.ii_relationship_tbl, p_txn_rec IN OUT csi_datastructures_pub.transaction_rec, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); 1-20 Oracle Install Base API Reference Guide

35 Package CSI_INSTANCE_RELATIONSHIPS_PUB Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 18 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_relationship_tbl ii_relationship_tbl Yes table of records for instance-to-instance relationships to be updated. p_transaction_rec transaction_rec No transaction record The following table describes the OUT parameters associated with this API. Table 1 19 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions p_transaction_rec transaction_rec transaction record x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Expire_Relationship PROCEDURE expire_relationship Oracle Install Base Public APIs 1-21

36 Package CSI_INSTANCE_RELATIONSHIPS_PUB ( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_relationship_rec IN csi_datastructures_pub.ii_relationship_rec, p_txn_rec IN OUT csi_datastructures_pub.transaction_rec, x_instance_id_lst OUT csi_datastructures_pub.id_tbl, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 20 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_relationship_rec ii_relationship_rec Yes instance-to-instance relationship record to be expired. P_transaction_rec transaction_rec No transaction record The following table describes the OUT parameters associated with this API. Table 1 21 Expire_Item_Instance Out Parameters 1-22 Oracle Install Base API Reference Guide

37 Package CSI_INSTANCE_RELATIONSHIPS_PUB Parameter Data Type Descriptions x_instance_id_lst id_tbl list of instance ids affected as a result of expiring this relationship. p_transaction_rec transaction_rec transaction record x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Get_Relationship PROCEDURE get_relationships ( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_relationship_query_rec IN csi_datastructures_pub.relationship_query_rec, p_depth IN NUMBER, p_time_stamp IN DATE, p_active_relationship_only IN VARCHAR2 := fnd_api.g_false, x_relationship_tbl OUT csi_datastructures_pub.ii_relationship_tbl, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Oracle Install Base Public APIs 1-23

38 Package CSI_SYSTEMS_PUB Table 1 22 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_relationship_query_ rec relationship_query_rec Yes record containing query columns for instance-to-instance relationship record. p_depth NUMBER Yes p_time_stamp DATE No p_active_relationship_ only VARCHAR2 No The following table describes the OUT parameters associated with this API. Table 1 23 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions x_relationship_tbl ii_relationship_tbl table of instance-to-instance relationships satisfying the query criteria. x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages 1.4 Package CSI_SYSTEMS_PUB Contains all APIs for instance-to-instance relationships management Oracle Install Base API Reference Guide

39 Package CSI_SYSTEMS_PUB Create_System Create_System Update_System Expire_System Get_Systems PROCEDURE create_system( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_system_rec IN csi_datastructures_pub.system_rec, p_txn_rec IN OUT csi_datastructures_pub.transaction_rec, x_system_id OUT NUMBER, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); Current Version 1.0 Parameter Descriptions The following table describes the IN parameters associated with this API. Table 1 24 Expire_Item_Instance IN Parameters Parameter Data Type Required Descriptions and Validations p_api_version NUMBER No Current API version p_commit VARCHAR2 No Commit by API required Oracle Install Base Public APIs 1-25

40 Package CSI_SYSTEMS_PUB p_init_msg_list VARCHAR2 No Initialize message list p_validation_level NUMBER No Validation level p_system_rec system_rec Yes record containing information about the system to be created. p_transaction_rec transaction_rec No transaction record The following table describes the OUT parameters associated with this API. Table 1 25 Expire_Item_Instance Out Parameters Parameter Data Type Descriptions p_transaction_rec transaction_rec transaction record x_system_id NUMBER Id of the system created x_return_status VARCHAR2 API return status x_msg_count VARCHAR2 API output message count x_msg_data VARCHAR2 API output messages Update_System PROCEDURE update_system( p_api_version IN NUMBER, p_commit IN VARCHAR2 := fnd_api.g_false, p_init_msg_list IN VARCHAR2 := fnd_api.g_false, p_validation_level IN NUMBER := fnd_api.g_valid_level_full, p_system_rec IN csi_datastructures_pub.system_rec, p_txn_rec IN OUT csi_datastructures_pub.transaction_rec, x_return_status OUT VARCHAR2, x_msg_count OUT NUMBER, x_msg_data OUT VARCHAR2 ); 1-26 Oracle Install Base API Reference Guide