Search Results retrieve_user_labels




Overview
Explore in AI Chat

Overview

BIS_INDICATOR_REGION_PVT is a private PL/SQL package in the APPS schema of Oracle E-Business Suite, declared with AUTHID CURRENT_USER. It supports the Oracle Balanced Scorecard / Daily Business Intelligence indicator region infrastructure, which allows users to personalize the set of key indicators displayed within a scorecard region. The package name is derived from "BIS Indicator Region," reflecting its role in managing per-user indicator selections and the labels applied to them. The "_PVT" suffix denotes that this is an internal, private API: it is not intended for direct customer invocation, and its interface is subject to change across patches and releases. The substantive business logic for indicator regions is exposed through the corresponding public package, BIS_INDICATOR_REGION_PUB, which the private package calls and from which it consumes record and table types such as Indicator_Region_Rec_Type and Indicator_Region_Tbl_Type. Bulk error reporting is handled through the shared BIS_UTILITIES_PUB.Error_Tbl_Type, and the package raises the predefined exception e_InvalidEventException when an unrecognized operation or event is encountered.

Key Procedures and Functions

  • CREATE_USER_IND_SELECTION — Creates a new indicator selection record for a user, persisting the indicator choices associated with a given region and plug.
  • RETRIEVE_USER_IND_SELECTIONS — Overloaded retrieval routine that returns indicator region selections into an Indicator_Region_Tbl_Type, either for a specific user/plug combination or filtered by target level.
  • UPDATE_USER_IND_SELECTION — Modifies an existing user indicator selection, typically when a user reconfigures the indicators shown in a region.
  • DELETE_USER_IND_SELECTIONS — Removes user indicator selections, used when a user clears personalization settings or when administrative cleanup is required.
  • RETRIEVE_USER_LABELS — Returns the set of user-defined labels for indicator selections, using the User_Label_Rec_Type structure (Ind_Selection_ID, Plug_ID, User_ID, Label).
  • VALIDATE_USER_IND_SELECTION — Performs consistency checks on a proposed indicator selection before it is persisted.
  • VALIDATE_REQUIRED_FIELDS — The routine most directly associated with the search term. It verifies that mandatory attributes required to create, update, or delete an indicator selection have been supplied, and reports any missing values through the error table mechanism. It is typically invoked internally by the create, update, and delete procedures as part of their input validation.

Tables Accessed

The package operates against the indicator configuration and personalization tables, accessed through APPS synonyms:

  • BIS_USER_IND_SELECTIONS and BIS_USER_IND_SELECTIONS_S — the primary storage for per-user indicator selections; these hold the records created, modified, retrieved, and deleted by the package.
  • BIS_INDICATORS — the indicator definition table, used to validate that selected indicators exist and to resolve indicator metadata.
  • BIS_TARGET_LEVELS — provides target level definitions used when retrieving or validating selections scoped by level.
  • FND_USER — resolves user identity, allowing selections to be identified by user_id or user_name.
  • DUAL, HTP, and PLITBLM — utility references used for single-row queries, HTML generation, and PL/SQL table manipulation respectively.

Usage Notes

Because this is a private package, it is invoked indirectly rather than by custom code. In a typical EBS 12.1.1 or 12.2.2 environment, the Balanced Scorecard / DBI user interface — implemented in Oracle Forms and related OA Framework pages — calls BIS_INDICATOR_REGION_PUB, which in turn delegates validation and persistence to BIS_INDICATOR_REGION_PVT. The package is documented as being referenced by one other package, consistent with this internal-call pattern. Customizations should target the public API surface; direct dependence on BIS_INDICATOR_REGION_PVT, including its VALIDATE_REQUIRED_FIELDS routine, is discouraged because the signature and behavior are not guaranteed across upgrades. The package header carries a 2003 source control revision, indicating that its core logic predates the 12.x releases and has been carried forward with minimal structural change.