Search Results ibc_citem_preview_pvt




Overview
Explore in AI Chat

Overview

The APPS.IBC_CITEM_PREVIEW_GRP package is a Group (GRP) classified PL/SQL package within the Oracle E-Business Suite Internet Business Center (IBC) module. It supports the "Customer Item" functionality and works in conjunction with the IBC_CITEM_PREVIEW_PVT package to render preview output of customer item definitions. The package is documented as VALID in the APPS schema and forms part of the ETRM (E-Business Suite Technical Reference Manual) repository.

Its primary business function is the generation of XML representations of customer item data for preview purposes. This enables users of Oracle iStore and related IBC components to view how a customer item or its attributes will appear before publishing, saving, or otherwise committing those definitions. The "PREVIEW" semantics indicate that the package is read-only with respect to persistent customer item data; it produces formatted output appropriate for on-screen inspection rather than transactional updates.

The package relies on the FND_API package for standard Oracle EBS API patterns, including message handling, return status conventions, and error reporting. This dependency confirms that the package follows the standard EBS API architecture, returning a status code (typically success, error, or unexpected error) along with an FND message stack when problems are encountered.

Key Procedures and Functions

The ETRM metadata documents two procedures within the package:

  • PREVIEW_CITEM_BASIC_XML — Produces a basic XML preview of a customer item definition. This routine generates a lightweight XML document containing the core attributes of the customer item, suitable for rapid on-screen display where full detail is not required.
  • PREVIEW_CITEM_DEEP_XML — Produces a deep or expanded XML preview of a customer item definition. This routine includes additional nested details, such as related attribute groups or child records associated with the customer item, providing a comprehensive XML representation for detailed inspection.

The distinction between "basic" and "deep" reflects two levels of XML detail, allowing the calling application to trade off performance against richness of output depending on the user context. Parameter lists are not documented in the ETRM excerpt and are therefore not enumerated here.

Tables Accessed

The documented table reference via APPS synonyms is DBMS_LOB. This is the Oracle built-in package for large object manipulation, and its presence indicates that the preview routines construct or manipulate CLOB (Character Large Object) values to hold the generated XML. XML output can easily exceed the VARCHAR2 limit, so DBMS_LOB procedures such as DBMS_LOB.WRITEAPPEND or DBMS_LOB.CREATETEMPORARY are used to assemble the complete XML document in a temporary or session-scoped LOB locator.

No base customer item tables are listed directly in the documented dependency excerpt; the underlying data retrieval is delegated to the sibling package IBC_CITEM_PREVIEW_PVT, which the metadata shows as referencing IBC_CITEM_PREVIEW_GRP and vice versa. This private/group package pair architecture is a common EBS pattern in which the PVT package performs the actual query logic and the GRP package exposes the public preview procedures.

Usage Notes

IBC_CITEM_PREVIEW_GRP is typically invoked from Oracle iStore or Internet Business Center UI flows where a user wishes to preview a customer item before publication. The XML generated by PREVIEW_CITEM_BASIC_XML or PREVIEW_CITEM_DEEP_XML is rendered by the calling application, often via XSLT transformation, to produce the visual preview. Because the package depends on FND_API, callers should standardly check the returned FND_API.G_RET_STS_SUCCESS status and inspect FND_MSG_PUB for any accumulated messages.

The metadata indicates that IBC_CITEM_PREVIEW_GRP is referenced by one other package, confirming it is a supporting unit rather than a top-level entry point. Customizations should not modify this package directly; instead, the supported preview APIs should be called from custom code, and any enhancement should be implemented through extension or wrapper patterns consistent with Oracle EBS extensibility guidelines. Version applicability spans both 12.1.1 and 12.2.2, and the package remains VALID in the APPS schema across those releases.