Search Results bim_custom_api




Overview
Explore in AI Chat

Overview

The APPS.BIM_DBI_SCM_RSG_API_PVT package is a private (PVT-classified) PL/SQL package within the Oracle E-Business Suite Release 12.1.1 and 12.2.2 environment. It resides in the APPS schema and is declared with AUTHID CURRENT_USER, meaning its procedures execute with the privileges of the invoking user rather than the defining schema. The package belongs to the Oracle Business Intelligence (BI) / Daily Business Intelligence (DBI) family of components — indicated by the BIM and DBI_SCM naming prefixes — and specifically relates to the Supply Chain Management (SCM) reporting subsystem. The RSG segment of the name refers to the Report Summary Generator / reporting summary infrastructure used by DBI dashboards. Its single documented procedure, BIM_CUSTOM_API, exposes a customization hook through which the reporting summary generation layer can invoke customer- or implementation-specific logic.

Key Procedures and Functions

The package exposes one documented procedure:

  • BIM_CUSTOM_API — A customization entry point invoked by the DBI SCM reporting framework. It accepts a BIS_BIA_RSG_PARAMETER_TBL collection parameter passed as IN OUT NOCOPY, allowing the procedure to both inspect and modify the parameter set supplied by the calling report-generation process. Because the collection type is shared with the broader BIS/BIA reporting layer, BIM_CUSTOM_API serves as the sanctioned extension point for injecting custom parameter handling into the standard reporting summary pipeline without modifying Oracle-owned code.

The procedure is intentionally minimal in its delivered form; Oracle ships it as a stub intended for customer extension.

Tables Accessed

The documented tables and views referenced through APPS synonyms are:

  • BIM_ALL_INDEXES — A BIM-owned repository of index definitions used by the reporting summary generator to determine appropriate indexing for summary tables.
  • DBMS_METADATA — The Oracle supplied metadata extraction package, used here to obtain DDL or structural metadata during processing.
  • USER_INDEXES — The data dictionary view listing indexes owned by the current schema, used for validation of existing index structures.
  • V$INSTANCE — The dynamic performance view providing instance-level information, typically consulted to confirm database identity or configuration before executing customization logic.

These references suggest the procedure participates in the creation, validation, or management of indexes supporting the DBI SCM summary generation process.

Usage Notes

This is a private package, so it is not a supported direct-call interface for external customizations. It is invoked internally by the DBI SCM reporting summary generation framework when a customization hook is registered. The header comment, dated 2004, indicates the package predates the current release and has been carried forward unchanged.

Because the ETRM metadata records that this package is referenced by zero other packages, its invocation occurs through the reporting infrastructure rather than through cross-package PL/SQL calls. Although the user search term was bim_custom_api, the actual object is the enclosing package BIM_DBI_SCM_RSG_API_PVT; implementers customizing DBI SCM reporting should modify the body of BIM_CUSTOM_API rather than calling it directly. Any customization should preserve the IN OUT NOCOPY semantics of the parameter to avoid altering standard framework behavior.