Search Results p_api

Overview

The APPS.BIS_BIA_RSG_CUSTOM_API_MGMNT package body is a component of the Oracle EBS Business Intelligence System (BIS) framework, specifically associated with the Report Source Generator (RSG) and the custom API management layer used for Business Intelligence applications. In Oracle EBS 12.1.1 and 12.2.2, this package serves as a management and invocation utility that allows the BIS infrastructure to locate, parameterize, and execute customer-defined or extended APIs within the Oracle BI reporting and analytics stack. Its primary business function is to provide a controlled, standardized mechanism for invoking custom API logic while maintaining parameter state and logging execution activity, thereby supporting extensibility of the standard Oracle BI Publisher and Discoverer reporting engines without modifying base product code.

The package is classified under the "OTHER" API category within the ETRM registry, indicating that it is not a standard public API exposed for general use, but rather an internal utility supporting the RSG custom API framework. It has a VALID status in the APPS schema and is documented as not being referenced by any other database object at the dependency level, although it is reported as referenced by two other packages at the functional level.

Key Procedures and Functions

The package body documents four procedures/functions, each serving a distinct role in the custom API management lifecycle:

• INVOKE_CUSTOM_API — The central procedure responsible for executing a customer-defined API within the BI RSG framework. It dynamically resolves and calls the target custom API, passing the parameters previously captured or configured. This is the primary entry point invoked when the BIS infrastructure requires the execution of a custom report or data source extension.
• GET_PARAM — Retrieves a parameter value from the current parameter collection. This function supports the parameter-passing mechanism used by INVOKE_CUSTOM_API, allowing custom API implementations or calling code to read named parameters that were registered for the current invocation context.
• SET_PARAM — Stores or updates a named parameter value within the parameter collection. Used prior to or during API invocation to establish the input context expected by the target custom API.
• LOG — Provides diagnostic and audit logging for the custom API management operations. This procedure records invocation events, parameter states, and error conditions to support troubleshooting and traceability of custom API execution within the EBS BI environment.

Tables Accessed

The package references two database objects through APPS synonyms:

• BIS_OBJ_PROPERTIES — A BIS configuration table that stores properties and metadata relating to BI objects. This package accesses it to resolve object-level configuration and property values that influence API invocation behavior.
• PLITBLM — A PL/SQL internal table type used for in-memory collection handling. This is not a physical application table but rather a database type used to manage parameter arrays within PL/SQL memory, consistent with the use of BIS_BIA_RSG_PARAMETER_TBL and BIS_BIA_RSG_PARAMETER_REC in the package's dependent declarations.

Additional dependencies include BIS_COLLECTION_UTILITIES (for collection manipulation) and DBMS_STANDARD/STANDARD for core PL/SQL functionality.

Usage Notes

This package is typically invoked indirectly by the BIS RSG framework rather than being called directly by end users. It is not exposed through standard EBS forms or concurrent programs in a user-facing manner; instead, it operates as an internal service within the Oracle BI reporting pipeline. Custom API developers who extend the RSG functionality register their APIs, and this management package handles the lifecycle of locating, parameterizing, invoking, and logging those custom API calls. The presence of the LOG procedure suggests it is valuable during implementation and debugging phases, where execution traces of custom report source generators help administrators diagnose failures in BI report generation. Because it is not referenced by any other database object per the ETRM dependency report, it functions as a leaf-level utility invoked dynamically, likely through the RSG custom API registration mechanism, making it sensitive to changes in the BIS_OBJ_PROPERTIES configuration and the parameter collection structures it depends upon.