Search Results create_kpi_properties

Overview

APPS.BSC_KPI_PVT is the private implementation package of the Oracle Balanced Scorecard (BSC) KPI framework in Oracle E-Business Suite 12.1.1 and 12.2.2. It encapsulates the core create, retrieve, update, and delete (CRUD) logic for Key Performance Indicators, their default settings, presentation properties, analysis definitions, and periodicity configurations. As a PVT-classified package, it is not a public API intended for direct external invocation; instead it provides the internal engine consumed by the public partner package APPS.BSC_KPI_PUB and by a broader set of scorecard subsystem packages. The package status is VALID in the APPS schema, and the ETRM metadata documents 64 procedures and functions within the package body.

Key Procedures and Functions

The documented entry points follow a consistent naming convention that mirrors the entity each routine manages. KPI master data is handled by CREATE_KPI, RETRIEVE_KPI, UPDATE_KPI, and DELETE_KPI. A parallel set of routines governs KPI defaults: CREATE_KPI_DEFAULTS, RETRIEVE_KPI_DEFAULTS, UPDATE_KPI_DEFAULTS, and DELETE_KPI_DEFAULTS. Presentation metadata is managed through CREATE_KPI_PROPERTIES, RETRIEVE_KPI_PROPERTIES, UPDATE_KPI_PROPERTIES, and DELETE_KPI_PROPERTIES.

• KPI analysis routines — CREATE_KPI_ANALYSIS, RETRIEVE_KPI_ANALYSIS, UPDATE_KPI_ANALYSIS, and DELETE_KPI_ANALYSIS maintain the analytical definitions that link KPIs to measures, options, and groups.
• DELETE_OBJECTIVE_COLOR_DATA — removes color-coding data associated with objectives, supporting the red/amber/green status presentation used across scorecard views.
• Periodicity routines — CREATE_KPI_PERIODICITY, RETRIEVE_KPI_PERIODICITY, and UPDATE_KPI_PERIODICITY define and maintain the time intervals at which KPI values are collected and evaluated.

All routines delegate infrastructure concerns such as error handling and savepoint management to FND_API, consistent with the Oracle Application Object Library PL/SQL API standard.

Tables Accessed

The package operates against the BSC base and translation tables through APPS synonyms. KPI header data resides in BSC_KPIS_B with translated attributes in BSC_KPIS_TL. Analysis configuration is spread across BSC_KPI_ANALYSIS_GROUPS, BSC_KPI_ANALYSIS_MEASURES_B and its BSC_KPI_ANALYSIS_MEASURES_TL translation table, BSC_KPI_ANALYSIS_OPTIONS_B and BSC_KPI_ANALYSIS_OPTIONS_TL, and BSC_KPI_ANALYSIS_OPT_USER, which stores user-specific analytical overrides.

Calculation and relationship data is stored in BSC_KPI_CALCULATIONS plus the user-specific BSC_KPI_CALCULATIONS_USER, and in BSC_KPI_CAUSE_EFFECT_RELS, which captures cause-and-effect linkages between indicators. Supplementary tables include BSC_KPI_COMMENTS for annotation text, BSC_KPI_DATA_TABLES for source data table registration, BSC_KPI_DEFAULTS_B for default values, and AK_REGIONS for the region metadata used by the HTML-based scorecard user interface. These tables collectively support the KPI definition lifecycle from creation through deployment and periodic measurement.

Usage Notes

Because BSC_KPI_PVT is a private package, direct invocation from custom code is not supported. The package is referenced by nine other packages, including BSC_KPI_PUB, which serves as the sanctioned public entry point, and by subsystem packages such as BSC_ANALYSIS_OPTION_PVT, BSC_BIS_KPI_CRUD_PUB, BSC_BIS_KPI_MEAS_PUB, BSC_COPY_INDICATOR_PUB, BSC_KPI_COLOR_PROPERTIES_PUB, BSC_PMF_UI_WRAPPER, BSC_SIMULATION_VIEW_PVT, and BSC_UPGRADES. This dependency pattern confirms its role as a shared internal service layer reached through OAF-based scorecard pages, concurrent upgrade processing, indicator copy utilities, and simulation views. Customizations that require KPI creation or maintenance should call BSC_KPI_PUB rather than this package, preserving upgrade safety across 12.1.1 and 12.2.2 releases.