Search Results type_mv_threshold

Overview

BIS_BIA_RSG_CUSTOM_API_MGMNT is an Oracle EBS Applications (APPS) PL/SQL package that forms part of the Business Intelligence System (BIS) infrastructure supporting the Balanced Scorecard/Enterprise Performance Foundation (BIA) module. Its principal business function is to provide a controlled, extensible framework through which customer-defined ("custom") APIs can be registered, invoked, and monitored during materialized view (MV) maintenance and refresh operations. The package sits between the standard BIS MV management routines and site-specific customization logic, allowing implementers to inject bespoke behavior into the refresh cycle without modifying Oracle-owned code.

The package is declared with AUTHID CURRENT_USER, meaning that privileges are evaluated according to the invoking schema rather than the definer, which is a deliberate design choice that allows the custom API routines to execute with the caller's authority. It exposes a set of public constants—such as PARA_API_TYPE, PARA_MODE, PARA_OBJECT_NAME, PARA_OBJECT_TYPE, PARA_MV_REFRESH_METHOD, PARA_COMPLETE_STATUS, and PARA_MESSAGE—along with value constants including STATUS_SUCCESS (literal value 'SUCCESS'), STATUS_FAILURE, METHOD_COMPLETE, METHOD_FAST, and the type identifiers TYPE_MV_LOG_MGT, TYPE_MV_INDEX_MGT, TYPE_MV_THRESHOLD, and TYPE_MV_OTHER_CUSTOM.

Key Procedures and Functions

The package documents four callable units:

• INVOKE_CUSTOM_API — A procedure that dispatches to a customer-supplied API identified by the P_API argument. It accepts the API name, API type, target object name, object type, and execution mode (before/after), and returns status through the standard RTNBUF and RETCODE OUT parameters used throughout Oracle EBS concurrent and API conventions.
• GET_PARAM — A function that retrieves the value of a named parameter from the passed BIS_BIA_RSG_PARAMETER_TBL collection, returning a VARCHAR2 result. It serves as the read-side accessor for the RSG parameter framework.
• SET_PARAM — A procedure that writes or updates a named parameter value within the same parameter table structure, providing the write-side counterpart to GET_PARAM.
• LOG — A utility procedure that writes a diagnostic text message, used for tracing execution of custom APIs and MV maintenance activity.

Tables Accessed

The ETRM metadata documents two referenced objects accessed via APPS synonyms: BIS_OBJ_PROPERTIES and PLITBLM. BIS_OBJ_PROPERTIES stores property and configuration metadata about BIS objects (including materialized views and their maintenance attributes); the package reads it to determine which custom APIs apply to a given object and to resolve refresh-related characteristics. PLITBLM is the standard Oracle EBS PL/SQL table used for LOG/error message text handling, supporting the LOG procedure's messaging requirements. The parameter table structure BIS_BIA_RSG_PARAMETER_TBL is passed as an IN OUT NOCOPY argument rather than being read directly from a base table.

Usage Notes

BIS_BIA_RSG_CUSTOM_API_MGMNT is an internal infrastructure package and is not typically invoked directly by end users. It is referenced by two other packages and is called during materialized view maintenance and refresh workflows within the BIS/BIA schema, particularly when MV log management, MV index management, or threshold-based custom logic has been configured. Implementers defining a custom API register it through this package's parameter constants and the underlying BIS_OBJ_PROPERTIES configuration, then rely on INVOKE_CUSTOM_API to execute it in the correct BEFORE or AFTER phase. The STATUS_SUCCESS and STATUS_FAILURE constants are the canonical return values checked by callers to determine outcome. Because custom code executes under AUTHID CURRENT_USER, grants on any objects touched by the custom API must be issued to the invoking schema. The header comment (BISCAPIS.pls 120.1, dated 2005) indicates the package has been stable since the early 11i/12.0 era and remains present in 12.1.1 and 12.2.2.