Search Results dbms_metadata




Overview
Explore in AI Chat

Overview

APPS.BIM_DBI_SCM_RSG_API_PVT is a private PL/SQL package body in the Oracle E-Business Suite APPS schema, classified as a PVT (private) API. It belongs to the Oracle Business Intelligence (BI) / Daily Business Intelligence (DBI) layer for Supply Chain Management, specifically the "RSG" (Report/Record Set Generator) family of utilities. The package provides internal implementation logic for the customizable reporting and record-set generation framework used by DBI/BI dashboards in Oracle EBS 12.1.1 and 12.2.2. It is not a public integration point; rather, it is the private backing code invoked by the corresponding package specification and by related BI management APIs.

Because the object is marked PVT, Oracle does not guarantee a stable, supported interface. The package exists to encapsulate logic that the DBI/BI framework needs but that Oracle reserves the right to change. Any customer customization should treat it as an implementation detail rather than a documented extension hook.

Key Procedures and Functions

The documented package exposes a single procedure or function named BIM_CUSTOM_API. Consistent with the PVT classification, its parameter list is not published in the ETRM metadata and should not be assumed. Based on its name and its role within the BIM_DBI_SCM_RSG_API_PVT body, BIM_CUSTOM_API serves as the private entry point through which the DBI/BI framework invokes custom record-set or custom API processing for supply chain reporting. It is the internal routine that bridges the public BI customization mechanism (represented in dependencies by BIS_BIA_RSG_CUSTOM_API_MGMNT) and the metadata-driven index and parameter infrastructure the package builds against.

Additional private helpers may exist inside the package body, but only BIM_CUSTOM_API is documented. Consultants should reference the specification BIM_DBI_SCM_RSG_API_PVT and the custom API management package to understand the supported calling convention, and should not hard-code calls to this private body.

Tables Accessed

The dependency metadata shows the package references APPS synonyms mapping to the following objects:

  • BIM_ALL_INDEXES — the BI/BIM index registry. The package consults this view to identify indexes relevant to record-set generation, likely supporting metadata extraction and validation of report data structures.
  • USER_INDEXES — the Oracle data dictionary view of indexes owned by the current schema. Used alongside BIM_ALL_INDEXES to reconcile physical index definitions with the BI metadata registry.
  • V$INSTANCE — the dynamic performance view identifying the current database instance. This is typically read to detect the instance name or environment, allowing the package to behave appropriately per instance (for example, distinguishing production from non-production).

Note that the dependency list also names DBMS_METADATA, DBMS_METADATA (SYS), and STANDARD, which are not tables but PL/SQL packages and the STANDARD function library referenced by the body. DBMS_METADATA appears both as an APPS-facing dependency and under SYS, indicating the package uses dictionary metadata extraction utilities, consistent with the user's search context of "dbms_metadata." The package generates or inspects DDL/metadata for index objects during its processing.

Usage Notes

BIM_DBI_SCM_RSG_API_PVT is invoked internally by the DBI/BI Supply Chain reporting framework rather than by end users. It is reached through the custom API management layer (BIS_BIA_RSG_CUSTOM_API_MGMNT) and the RSG parameter table (BIS_BIA_RSG_PARAMETER_TBL), which supply configuration and parameters at runtime. The package is not referenced by any other database object per the ETRM dependency record, confirming its role as a leaf-level private implementation.

Typical invocation paths include DBI dashboard generation, record-set refresh concurrent programs, and custom BI API execution configured through the BIS/BIM setup. Because it is a private body, custom code should call the documented specification or the supported customization APIs instead. The use of DBMS_METADATA and USER_INDEXES suggests the routine may be exercised during index or metadata introspection, which has performance implications on large dictionaries; such calls should be run in maintenance or batch windows rather than interactively.