Search Results set_ak_format_id




Overview
Explore in AI Chat

Overview

APPS.BSC_SIMULATION_VIEW_PVT is a private (PVT) PL/SQL wrapper API that supports the Simulation module of Oracle E-Business Suite's Balanced Scorecard (BSC) application. The package encapsulates the logic required to render, configure, and manipulate simulation views for scorecard KPIs, including the management of KPI tree nodes, color-coding rules, dimension groups, and shared objectives. Its header comment identifies it as the "Wrapper API for SIMULATION," and the change history reveals ongoing refinement across Releases 11i and 12.x, addressing filters and key items for the strategy map tree (Bug#5932973), a copy indicator enhancement (Enh#5943238), and prototype flag corrections (Bug#6166829). Because it is classified as PVT, the package is not intended as a public API; it is an internal implementation layer consumed by higher-level scorecard and simulation flows.

Key Procedures and Functions

The package exposes thirteen documented procedures and functions that fall into several functional groupings.

  • SET_DEFAULT_NODE — establishes the default node used when a simulation view is initialized, controlling which tree node is presented to the user by default. This is the specific program unit queried by users searching on "set_default_node."
  • DUPLICATE_SIM_METADATA and COPY_SIM_METADATA — support the duplication and copying of simulation definitions and associated metadata, enabling users to base new simulations on existing ones.
  • ADD_OR_UPDATE_YTD — manages year-to-date measure handling within a simulation.
  • SET_KPI_COLOR_FLAG and SET_KPI_COLOR_METHOD — configure the color-coding behavior applied to KPI indicators in the simulation display.
  • SET_AK_FORMAT_ID, GET_FORMAT, and COPY_AK_RECORD_TABLE — manage Oracle AK (Application Kit) region formatting and the associated record tables used by the region rendering framework.
  • HANDLE_SHARED_OBJECTIVES — coordinates the treatment of objectives that are shared across scorecards or perspectives.
  • INIT_SIM_TABLES_ARRAY — initializes the internal array structures that hold simulation table metadata.
  • COPY_DIMENSION_GROUP — duplicates dimension group definitions for reuse within a simulation.
  • SET_SIM_KEY_VALUES — populates the key values that identify a given simulation instance.

Tables Accessed

The package reads and writes a defined set of BSC and AK tables through APPS synonyms. KPI definition data is drawn from BSC_KPIS_B, BSC_KPI_PROPERTIES, BSC_KPI_CALCULATIONS, BSC_KPI_ANALYSIS_MEASURES_B, and BSC_KPI_ANALYSIS_OPTIONS_B. Tree structure and presentation are handled via BSC_KPI_TREE_NODES_B and BSC_KPI_TREE_NODES_TL. Dimension and dataset configuration uses BSC_SYS_DATASETS_B, BSC_SYS_DIM_GROUPS_TL, and BIS_DIMENSIONS, while indicator metadata comes from BIS_INDICATORS. Region and UI formatting relies on AK_REGIONS, AK_REGION_ITEMS, BIS_AK_REGION_EXTENSION, and the image mapping table BSC_SYS_IMAGES_MAP_TL. These accesses support the creation, copying, formatting, and display of simulation views and their underlying scorecard objects.

Usage Notes

BSC_SIMULATION_VIEW_PVT is typically invoked indirectly rather than called directly by end users or custom code. It is referenced by three other packages, which serve as its primary callers. Invocation occurs during Simulation module operations in the Balanced Scorecard, such as creating a simulation from an existing scorecard, initializing the strategy map tree with its default node, applying color methods to KPIs, and formatting AK regions for display. Because the package is a PVT API, Oracle does not guarantee its signature across patches or upgrades; customizations should avoid direct dependencies on it. The header timestamp (2007) and file version (120.3) indicate it remains largely stable in 12.1.1 and 12.2.2, with behavior consistent with its documented bug fixes for filters, key items, copy indicators, and prototype flags.