Search Results get_aopts_display_flag




Overview
Explore in AI Chat

Overview

APPS.BSC_OAF_VIEWS_PVT is a private PL/SQL package that forms part of the Oracle Balanced Scorecard (BSC) application within Oracle E-Business Suite 12.1.1 and 12.2.2. As indicated by the _PVT suffix, the package is classified as private and is not intended to be called directly by external consumers; instead, it is invoked internally by other BSC packages and by the Oracle Application Framework (OAF) presentation layer that renders the Balanced Scorecard user interface. Its principal role is to resolve, at runtime, the display characteristics and default states of KPI (Key Performance Indicator) analysis options, series, and dimension members configured in the Scorecard model. The package header carries the source control signature BSCOAFVS.pls 120.1, last shipped in 2007, reflecting a stable, long-lived code base. It is referenced by four other packages, confirming its position as a shared internal utility layer.

Key Procedures and Functions

The documented interface exposes six procedures and functions:

  • GET_AOPTS_SERIES_NAMES — Validates the uniqueness of a menu name and user menu name before insertion, returning a status indicator that distinguishes an invalid menu name, an invalid user name, or a valid combination. It accepts the indicator, three generic numeric arguments, and the series identifier.
  • GET_AOPTS_DISPLAY_FLAG — Returns a flag governing the display behaviour of an analysis option for a given indicator, series, and accompanying parameters.
  • GET_AOPTS_DEFAULT_FLAG — The function the user searched for. It returns the default flag for an analysis option, determining whether a given KPI analysis option, series, or member should be presented as the default selection when the Scorecard view is rendered. Like its sibling functions, it takes the indicator, the three generic positional arguments (x_a0, x_a1, x_a2), and the series identifier.
  • GET_LEVEL_PARENT_NAMES — Resolves the names of parent members for a hierarchy level, supporting dimensional drill-down and navigation.
  • IS_PARENT_TAB — Tests whether the currently selected tab represents a parent (aggregate) level in the dimension hierarchy, allowing the UI to conditionally enable or disable tab-level controls.
  • GET_DATASET_SOURCE — Returns the source definition of a system dataset, used to drive data retrieval for Scorecard views.

The header also documents a commented-out GET_MEASURE_COLOR function, whose pseudo-logic maps default measures, PMF measures, and non-production KPIs to either a KPI colour (via BSC_DESIGNER_PVT.GET_KPI_COLOR) or white. It remains in the source for historical reference only and is not part of the callable interface.

Tables Accessed

The package reads from the core Balanced Scorecard metadata tables through APPS synonyms. KPI definition data is sourced from BSC_KPIS_B. Analysis grouping and measure configuration rely on BSC_KPI_ANALYSIS_GROUPS, BSC_KPI_ANALYSIS_MEASURES_B, and BSC_KPI_ANALYSIS_MEASURES_TL. The analysis option records, which the GET_AOPTS_* functions directly interrogate, reside in BSC_KPI_ANALYSIS_OPTIONS_B and its translation table BSC_KPI_ANALYSIS_OPTIONS_TL. Dataset and dimension structures are read from BSC_SYS_DATASETS_B, BSC_SYS_DIM_LEVELS_TL, and BSC_SYS_DIM_LEVEL_RELS, supporting the hierarchy-resolution functions. Access is predominantly read-only, consistent with a presentation-support utility.

Usage Notes

Because BSC_OAF_VIEWS_PVT is a private package, it should not be invoked from custom code. It is called by the four dependent BSC packages and by the OAF-based Scorecard pages during view construction, typically within an entity object or view object accessor that determines which analysis option to default and how each option should be displayed. The functions are executed in the context of an active Scorecard indicator and series, and their results directly influence the default selections and colour coding presented to the user. In 12.2.2, the OAF technology stack remains unchanged for this component, so behaviour is consistent with 12.1.1. Any customisation should target supported public APIs or configuration rather than this package.