Search Results ibc_citem_preview_grp




Overview
Explore in AI Chat

Overview

The APPS.IBC_CITEM_PREVIEW_GRP package body is a Group-type (GRP) PL/SQL API within the Oracle E-Business Suite Content Integration (IBC) module. It provides the XML rendering layer used to generate previews of content items and their associated components. In the context of Oracle EBS 12.1.1 and 12.2.2, the IBC schema supports content management for iStore and related self-service applications, and this package is responsible for producing well-formed XML representations of a content item so that they can be reviewed, validated, or rendered before publication.

The package header comments and embedded constants (for example, G_PKG_NAME and G_FILE_NAME referencing ibcgcipb.pls) confirm it is a standard EBS API wrapper that enforces the FND_API calling conventions. It acts as a thin façade over the underlying preview logic held in IBC_CITEM_PREVIEW_PVT, adding API compatibility checks, message-list initialization, return-status management, and XML declaration construction.

Key Procedures and Functions

Two documented procedures are exposed by this group package:

  • PREVIEW_CITEM_BASIC_XML — Generates a lightweight ("basic") XML representation of a single content item. It accepts a content item identifier and version identifier, along with language and API control parameters, and returns the rendered XML as a CLOB in x_content_item_xml, together with the standard x_return_status, x_msg_count, and x_msg_data outputs. This is the procedure referenced by the search term preview_citem_basic_xml.
  • PREVIEW_CITEM_DEEP_XML — Produces a more extensive ("deep") XML representation, expanding the content item to include its associated child structure. Where the basic variant returns only the top-level item attributes, the deep variant is intended for callers that require the full nested hierarchy in the generated XML document.

Both procedures follow the FND_API standard: they invoke FND_API.Compatible_API_Call, optionally initialize the message list via FND_MSG_PUB.initialize, and initialize x_return_status to FND_API.G_RET_STS_SUCCESS before delegating to the private implementation package.

Tables Accessed

The ETRM metadata documents only DBMS_LOB as a referenced object via APPS synonyms. This is consistent with the source, which uses DBMS_LOB.CREATETEMPORARY and DBMS_LOB.WRITEAPPEND to build the returned XML CLOB. No base application tables are directly referenced by this group package; the underlying data retrieval is performed inside IBC_CITEM_PREVIEW_PVT, which queries the IBC content item, version, and component tables. The group package therefore touches the database only through the built-in DBMS_LOB package and through calls to the private preview logic.

Usage Notes

This package is typically invoked from the Content Integration administration and preview user interfaces, from concurrent programs that render content items to XML for export or validation, and from custom code that requires a structured XML snapshot of a content item. Because it is a GRP wrapper, callers gain the benefit of standardized error handling and message propagation without needing to interact directly with the private package.

The returned CLOB is a complete XML document, including the XML declaration built from IBC_UTILITIES_PVT.getEncoding(). Callers should treat the CLOB as temporary (created with CREATETEMPORARY set to TRUE) and free it after use. The package is referenced by one other package in the ETRM repository, indicating it is a shared utility rather than an entry point restricted to a single application. As with all EBS GRP APIs, callers must supply a compatible p_api_version and check x_return_status against FND_API.G_RET_STS_SUCCESS before consuming the XML output.