Search Results bsc_periods_utility_pkg




Overview
Explore in AI Chat

Overview

APPS.BSC_PERIODICITIES_PUB is the public application programming interface for the Balanced Scorecard (BSC) periodicity infrastructure in Oracle E-Business Suite. Periodicity is the mechanism by which ETRM defines the recurring time intervals — day, week, month, quarter, year, and customer-defined variants — against which KPI targets are measured, scores are computed, and calendar rollups are generated. The package does not store transactional business data directly; instead it maintains the metadata records that describe each periodicity, its localized display names, and its relationship to the system calendar and dimensional groupings.

As a PUB-classified API, BSC_PERIODICITIES_PUB constitutes the supported entry point for external callers. Validation, thin wrapper logic, and error handling follow the standard FND_API conventions, while the heavy lifting is delegated to the private package BSC_PERIODICITIES_PVT. The metadata confirms that the package body compiles against the APPS schema, references FND_API and the STANDARD library, and is currently in VALID status. It is referenced by four other packages, indicating that periodicity management is a shared service consumed across the ETRM calendar and utility layers rather than by a single subsystem.

Key Procedures and Functions

  • CREATE_PERIODICITY — Creates a new periodicity definition, including its base interval type and associated descriptors.
  • UPDATE_PERIODICITY — Modifies an existing periodicity record, such as its name, description, or interval attributes.
  • DELETE_PERIODICITY — Removes a periodicity definition, subject to any referential constraints imposed by dependent KPI definitions.
  • RETRIEVE_PERIODICITY — Fetches the attributes of a single periodicity for use by calling modules.
  • VALIDATE_PERIODICITY — Performs pre-write consistency checks on a periodicity record before it is persisted.
  • POPULATE_PERIODICITY_RECORD — Loads a record structure with periodicity column values, typically ahead of an insert or update.
  • POPULATE_PERIOD_METADATA — Populates period-level metadata used downstream when periods are generated or reconciled.
  • GET_INCR_CHANGE — Returns incremental change information associated with a periodicity, supporting delta-style comparisons.
  • TRANSLATE_PERIODICITY — Manages translated (localized) periodicity names in the _TL table for the languages defined in FND_LANGUAGES.
  • LOAD_PERIODICITY — Bulk loads periodicity definitions, commonly used during setup or data migration.
  • NAME — Utility function that resolves or returns the name of a periodicity.

Tables Accessed

  • BSC_SYS_PERIODICITIES and BSC_SYS_PERIODICITIES_TL — Base and translated stores of periodicity definitions; the primary tables read and written.
  • BSC_SYS_PERIODS — Period records associated with a periodicity; read during metadata population.
  • BSC_KPI_PERIODICITIES — Links periodicity to KPI definitions; validated before deletes.
  • BSC_SYS_CALENDARS_B — System calendar base table, used to align periodicities to calendars.
  • BSC_SYS_DIM_GROUPS_TL — Dimension group translated names, referenced for grouped periodicity behavior.
  • BIS_LEVELS and BIS_LEVELS_TL — Level definitions and translations inherited from the BIS foundation tables.
  • FND_LANGUAGES — Source of installed languages driving translation rows.

Usage Notes

BSC_PERIODICITIES_PUB is typically invoked indirectly. Setup forms for ETRM periodicity maintenance, the concurrent programs that load or refresh periodicity metadata, and the wrapper and utility packages — BSC_PERIODICITIES_WRAPPER, BSC_PERIODICITIES_PVT, and notably BSC_PERIODS_UTILITY_PKG — all call into this API rather than manipulating the BSC_SYS_PERIODICITIES tables directly. Custom integrations that must create or maintain periodicity definitions should likewise call the PUB procedures to benefit from FND_API validation and message handling. Because BSC_PERIODS_UTILITY_PKG appears in the reference list, searches for that utility package frequently surface this object as its upstream dependency. Direct DML against the underlying tables is unsupported.