Search Results bsc_color_range_rec




Overview
Explore in AI Chat

Overview

The APPS.BSC_COLOR_RANGES_PUB package is an Oracle EBS public API that manages system-level color range configuration for the Balanced Scorecard (BSC) module. Its stated purpose, per the package header, is to manage System level Color properties and provide CRUD (Create, Read, Update, Delete) APIs for the BSC_COLOR_RANGES_B related tables. Color ranges are the mechanism by which scorecard KPIs and analyses are visually banded — thresholds are mapped to colors that signal performance against a target, a KPI, or a constant value. This package is the programmatic gateway for defining those bands, whether for a single KPI measure or across default/system definitions.

Key Procedures and Functions

  • CREATE_COLOR_PROP_RANGES — Creates color property ranges for a specific objective and KPI measure, accepting a color type (PERCENT_OF_TARGET, PERCENT_OF_KPI, or CONSTANT) and a set of threshold colors. Returns standard FND API return status and message outputs.
  • CREATE_DEF_COLOR_PROP_RANGES — Creates default color property ranges, establishing the system-wide baseline used when no measure-specific definition exists.
  • CREATE_PL_DEF_CLR_PROP_RANGES — Creates default color property ranges for PL (PL/SQL or private-layer) objectives, addressing the alternate handling introduced for PL objective support.
  • CREATE_COLOR_RANGES — The core creation API invoked by the higher-level create procedures to persist individual color range rows into the BSC_COLOR_RANGES table.
  • SAVE_COLOR_PROP_RANGES — Persists a complete set of color property range definitions, typically as an upsert-style operation over an existing configuration.
  • UPDATE_COLOR_PROP_RANGES — Modifies existing color range definitions, such as changing thresholds, sequence, or assigned color.
  • DELETE_COLOR_PROP_RANGES — Removes color range definitions for a given property or measure.
  • GET_NEXT_TOKEN — Returns the next sequence token, used to allocate identifiers or ordering tokens during range creation.
  • GET_COLOR_METHOD — Retrieves the color method or color type configuration associated with a color property.

The package also declares the BSC_COLOR_RANGE_OBJ record type (color_range_id, sequence, low, high, color_id, user_id) and the BSC_COLOR_RANGE_REC associative array type, along with a THRESHOLD_ARRAY type used in the create APIs.

Tables Accessed

  • BSC_COLOR_RANGES — The primary transaction table holding individual color band rows; the CRUD APIs insert, update, and delete here.
  • BSC_COLOR_RANGE_ID_S — The sequence supplying primary keys for new color range rows.
  • BSC_COLOR_TYPE_PROPS — Stores the color type property definitions that govern how ranges behave (e.g., the color method).
  • BSC_KPIS_B — The KPI base table, validated against when ranges are created for a specific KPI.
  • BSC_KPI_ANALYSIS_MEASURES_B — The analysis measure base table, referenced when ranges are scoped to a measure.
  • BSC_SYS_DATASETS_B — The system dataset base table, used for default/system-level configuration context.
  • BSC_SYS_INIT — System initialization values, consulted for defaults.
  • FND_USER — Used to resolve the current user for the user_id attribute on range records.
  • DUAL and PLITBLM — Utility/scratch objects for singleton queries and PL/SQL table operations.

Usage Notes

This package is classified as a PUB (public) API and is referenced by 10 other packages, indicating it is a foundational dependency for scorecard color rendering logic. It is typically invoked from Balanced Scorecard configuration forms when an administrator defines or edits color thresholds for a KPI or analysis measure, and from concurrent or PL/SQL programs that seed default color ranges (including PL objectives). Direct custom calls should follow the documented CRUD sequence: create or save property ranges, update as needed, and delete to remove. Callers should always pass p_commit explicitly (defaulting to FND_API.G_FALSE) and must inspect x_return_status, x_msg_count, and x_msg_data to detect and report errors, as the procedures do not raise exceptions for standard validation failures. The p_color_type parameter accepts only PERCENT_OF_TARGET, PERCENT_OF_KPI, or CONSTANT. Threshold arrays are supplied using the package's THRESHOLD_ARRAY type, and record structures should conform to BSC_COLOR_RANGE_OBJ. The package is owned by APPS and should only be invoked with that schema context or suitable synonyms/grants in place.