Search Results cst_inventory_pub




Overview
Explore in AI Chat

Overview

APPS.CST_INVENTORY_PUB is a public PL/SQL API package in the Oracle E-Business Suite Cost Management (CST) module. As indicated by the _PUB suffix and its registration as a PUB-classified API within the ETRM repository, the package exposes a stable, versioned interface intended for external invocation by other Oracle applications, forms, concurrent programs, and custom extensions. Its principal business function is the calculation of inventory valuation. The package enables callers to compute on-hand, intransit, and receiving inventory values for a given organization, cost type, and valuation date, applying a broad set of filter and inclusion criteria.

The package is present in both Oracle EBS 12.1.1 and 12.2.2. The header comment in the source ($Header: CSTPIVTB.pls 120.3.12010000.2 2010/01/08) reflects the 12.1.1 lineage of the file; the ETRM 12.2.2 metadata confirms the object remains documented and active in the later release, where it is referenced by 11 other packages.

Key Procedures and Functions

The ETRM metadata documents a single public procedure for this package:

  • CALCULATE_INVENTORYVALUE — The sole documented entry point. This procedure performs the core inventory valuation calculation. It accepts a standard FND_API parameter envelope, comprising p_api_version, p_init_msg_list, and p_commit for call compatibility, message list initialization, and transaction control, together with three OUT parameters (x_return_status, x_msg_count, x_msg_data) that return the standard FND_API result status and error message data.

Beyond the API envelope, the procedure exposes an extensive set of business parameters that define the scope of the valuation. These include an organization identifier, cost type identifier, and valuation date; value buckets for on-hand, intransit, and receiving quantities; and a wide range of optional range filters. Among these filters is p_subinventory_from, the parameter associated with the user's search, which delimits the low end of a subinventory range for the calculation. Its companion parameters allow callers to restrict results by item range, category set and category range, cost group range, subinventory range, and numerous Boolean-style inclusion flags such as zero-cost-only, zero-quantity, expense item, expense subinventory, unvalued transactions, receipt, shipment, detail, ownership, cost-enabled-only, one-time item, include-period-end, and quantity-by-revision. The exact parameter list and default semantics are defined in the package specification; the procedure performs API version compatibility checking via FND_API.Compatible_API_Call and initializes the message list through FND_MSG_PUB.Initialize before processing.

Tables Accessed

The ETRM metadata excerpt provided for this object does not enumerate the base tables accessed through APPS synonyms. By name and function, however, a valuation API of this type operates against the Cost Management and Inventory valuation tables, reading on-hand quantities and costs in order to derive the requested inventory value for the specified organization, cost type, and valuation date. Because the documented table list is unavailable, the specific table set should be confirmed by inspecting the packaged body or the ETRM table-dependency report for CST_INVENTORY_PUB.

Usage Notes

CST_INVENTORY_PUB is designed to be invoked programmatically rather than directly by end users. Typical callers include concurrent programs and reports that require inventory valuation figures, Oracle forms that display or validate inventory value, and other PL/SQL packages; the ETRM metadata records that the package is referenced by 11 other packages, confirming its role as a shared internal service.

Callers should adhere to the standard FND_API calling convention: pass a compatible p_api_version, request message list initialization as needed, control commit behavior explicitly, and inspect x_return_status after every call. The procedure returns validation errors through the FND message stack, so custom code should check the return status and extract messages via the FND_MSG_PUB utilities. When filtering by subinventory, both p_subinventory_from and p_subinventory_to should be supplied where a bounded range is intended.