Search Results retrieve_required_dimension

Overview

APPS.BIS_DIMENSION_PUB is the public PL/SQL API for managing dimensions and dimension levels within the Oracle E-Business Suite Key Performance Framework (KPF), which underpins the Business Intelligence System (BIS) and Enterprise Data Warehouse (EDW) reporting infrastructure. The package provides the canonical programmatic interface for creating, loading, updating, translating, and removing dimension definitions that drive performance measurement and analytical reporting. As reflected in its header history, the package was first created in December 1998 and has been continuously maintained through a series of enhancements and bug fixes, including addition of the required dimension API (1999), separation of IN and OUT local variables (Bug#2758428), dimension name validations (Bug#4172055), data-definition seeding by product teams (Enh#4172034), seed data compatibility work (Bug#4437121), and the ability to hide dimensions and dimension objects (Enh#4739401). The package body was last revised in January 2006 and is classified as a PUB API, meaning it is a supported integration point intended for use by both Oracle applications and customer extensions.

Key Procedures and Functions

The package exposes 13 documented procedures and functions:

• RETRIEVE_REQUIRED_DIMENSION — Added in February 1999, this procedure returns the set of dimensions that are mandatory (required) for the KPF. It is the object most commonly located by the search term referenced here and is typically called during setup and validation flows where the framework must confirm that all required dimensions have been defined before allowing further configuration. No parameter lists are documented in the supplied metadata; only its purpose as the required-dimension retrieval API is confirmed.
• RETRIEVE_DIMENSIONS — Returns multiple dimension definitions, supporting list-oriented retrieval.
• RETRIEVE_DIMENSION — Returns a single dimension definition.
• TRANSLATE_DIMENSION — Performs translation of a dimension into a target language.
• TRANSLATE_DIM_BY_GIVEN_LANG — Translates a dimension for an explicitly supplied language.
• TRANSLATE_DIMENSION_WRAPPER — Wrapper entry point around the dimension translation logic.
• LOAD_DIMENSION — Loads or seeds a dimension definition into the repository.
• LOAD_DIMENSION_WRAPPER — Wrapper entry point for dimension loading.
• LOAD_DIMENSION_GROUP — Loads a dimension group; per the header history, this was later modified to delegate key logic to the BSC API (BSC_DIMENSION_GROUPS_PUB.ret_dimgrpid_fr_shname).
• CREATE_DIMENSION — Creates a new dimension, added February 2003.
• UPDATE_DIMENSION — Updates an existing dimension, added February 2003.
• DELETE_DIMENSION — Removes a dimension, added February 2003.
• UPDATE_DIMENSION_OBSOLETE_FLAG — Sets or clears the obsolete flag on a dimension, supporting lifecycle management and the hide-dimension enhancement.

Tables Accessed

The package operates against the following tables via APPS synonyms:

• BIS_DIMENSIONS — The base dimension repository; the principal read/write target for retrieval, creation, update, and delete operations.
• BIS_DIMENSIONS_TL — The translated (language-specific) dimension table, accessed by the translation routines to store and retrieve localized dimension names and descriptions.
• BSC_SYS_DIM_LEVELS_B — The system dimension levels base table belonging to the Balanced Scorecard schema; accessed to resolve dimension level and group relationships, particularly through the LOAD_DIMENSION_GROUP flow.
• PLITBLM — The standard PL/SQL character table type, used for passing multi-row string collections between routines.

Usage Notes

BIS_DIMENSION_PUB is invoked both by Oracle's own setup and seeding infrastructure and by custom integrations requiring programmatic dimension maintenance. Product teams use LOAD_DIMENSION and related wrapper routines to seed dimension data definitions during installation and upgrade. Administrative forms and concurrent programs that configure the Key Performance Framework call the RETRIEVE_* functions to populate dimension lists and to validate that required dimensions exist before permitting performance framework activation. The translation procedures are typically executed from language-installation or localization flows. Because the package is referenced by at least 12 other packages, its entry points are also reached indirectly through higher-level BIS and BSC APIs. Custom code should invoke only the documented public procedures and should avoid direct DML against BIS_DIMENSIONS and BIS_DIMENSIONS_TL, since the package encapsulates the validation, translation, and obsolete-flag logic required for data integrity across EBS releases 12.1.1 and 12.2.2.