Search Results csf_ib




Overview
Explore in AI Chat

Overview

CSF_IB is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite. It belongs to the Field Service / Install Base product family and provides the core programmatic interface for creating and maintaining customer product instances — the records that represent a specific unit of an item as it exists at a customer site. These records, often referred to as CPIDs (Customer Product Instance Definitions), form the backbone of the Install Base and support downstream processes such as service contracts, depot repair, returns, and warranty tracking.

The package is classified as an "OTHER" API, meaning it is not formally designated as a public, certified interface. It is nonetheless relied upon internally by Oracle's own forms and by other packages. The header comment dates the source to 2006, and the metadata confirms it is documented at ETRM 12.2.2 against an object that ships in 12.1.1 and 12.2.2.

The primary business purpose of CSF_IB is to abstract the logic required to instantiate an item into an installed base record under a given customer, with or without a position in a configuration hierarchy, and to maintain that record over its lifecycle. This allows order fulfillment, shipping, and service flows to register an instance without directly manipulating the underlying Install Base tables.

Key Procedures and Functions

Five procedures are documented for this package. Their purposes are as follows:

  • CREATE_BASE_PRODUCT1 — Creates a new CPID for an item that will stand alone, outside of any configuration tree. It returns the newly generated CPID and object version number to the caller. This corresponds to the "case 1" scenario described in the package source comments.
  • CREATE_BASE_PRODUCT2 — Creates a new CPID for an item that is inserted as a child within an existing tree. The new record's parent pointer is set to a supplied parent CPID. This corresponds to the "case 2" scenario.
  • REPLACE_PRODUCT — Replaces a node within an existing configuration tree. The procedure creates a new CPID for the replacement item, re-parents it to the parent of the replaced CPID, and re-assigns the children of the replaced CPID so that they now point to the newly created record. This is the object most directly associated with the user's search term "replace_product."
  • UPDATE_PRODUCT — Updates attributes of an existing product instance, such as status, quantity, or descriptive details, without altering its hierarchical position.
  • UPDATE_INSTALL_BASE — Performs broader maintenance of the install base record, typically covering fields that are not handled by UPDATE_PRODUCT.

Each procedure follows the standard EBS API signature convention, accepting an API version, returning a status, message count, and message data, and where relevant returning a CPID and object version number. Parameter lists are not reproduced here, as the documentation excerpt is truncated.

Tables Accessed

The ETRM metadata does not enumerate specific tables accessed via APPS synonyms for this package. Based on the documented behavior, the package reads and writes the Install Base instance tables that store CPID records, their hierarchical relationships, and their descriptive attributes. Because the package is a thin abstraction layer, it should be assumed to insert into and update the primary instance table and its related translation and relationship tables.

Usage Notes

CSF_IB is typically invoked from the Install Base and Field Service forms, from concurrent programs that bulk-register instances during order or shipping processing, and from custom PL/SQL when bespoke extensions must create or restructure installed base records. Because the API classification is OTHER, consumers should confirm behavior against the specific patch level in use before relying on CSF_IB in custom code. The metadata indicates the package is referenced by one other package, so direct calls should be made within the same transactional context that governs the surrounding business event.