Search Results get_current_period




Overview

APPS.BSC_BIS_WRAPPER_PUB is a public PL/SQL wrapper package in the Oracle E-Business Suite Balanced Scorecard (BSC) module, which forms part of the Daily Business Intelligence (DBI) and Enterprise Performance Management (EPM) family of applications. The package provides a simplified, externally callable interface — the "PUB" (public) layer — that shields callers from the lower-level implementation details exposed by the companion package BSC_BIS_WRAPPER_PVT (the "PVT"/private layer). Its principal business function is to resolve actual and target values for Key Performance Indicators (KPIs) and to expose the current period context associated with a KPI, a series, or the general DBI environment. The header comment ("$Header: BSCPBISB.pls 115.9 2003/02/12 …") indicates the package has been part of the codebase since the early 11i lineage and is carried forward into EBS 12.1.1 and 12.2.2. The wrapper design pattern ensures that callers depend only on the stable PUB signature, while default resolution logic (analysis options, series identifiers) is delegated internally to the PVT package.

Key Procedures and Functions

The ETRM metadata documents eight program units within this package body:

  • GET_ACTUAL_VALUE_BY_KPI — Retrieves the actual (measured) value for a KPI identified by its KPI code, resolving the required analysis option defaults and series identifier internally before delegating the calculation. It accepts user and responsibility context so that security and personalization can be applied.
  • GET_ACTUAL_VALUE — Retrieves the actual value for a KPI when the caller supplies the analysis option combination and series explicitly, bypassing the default-resolution step. This overload supports drill-down and custom reporting scenarios.
  • GET_CURRENT_PERIOD_BY_KPI — Returns the current period applicable to a specific KPI, honouring any KPI-level period definition or offset configured in the scorecard setup. This is the function most directly associated with the user search term "get_current_period".
  • GET_CURRENT_PERIOD — Returns the current period for the general scorecard context, independent of any individual KPI. It is typically used where a period label or identifier is needed before KPI-specific evaluation.
  • GET_DBI_CURRENT_PERIOD — Returns the current period as defined by the Daily Business Intelligence framework. Because DBI period logic can differ from the BSC scorecard period logic, this function provides the DBI-consistent value.
  • GET_TARGET_VALUE_BY_KPI — Returns the target value for a KPI by KPI code, again resolving analysis options and series defaults internally. The target is compared against the actual value in scorecard rendering.
  • GET_TARGET_VALUE — Returns the target value when the analysis option combination and series are supplied explicitly, mirroring the overload pattern used for actual values.
  • POPULATE_MEASURE_DATA — Populates or refreshes measure data used by the KPI engine, supporting the summarization and staging of scorecard facts.

Tables Accessed

The ETRM extraction for this object does not enumerate explicit table references; the excerpt shows all substantive data access being delegated to BSC_BIS_WRAPPER_PVT. In practice, the package indirectly reads the BSC scorecard and DBI metadata tables that store KPI definitions, analysis option configurations, series definitions, period calendars, and the staged measure/fact tables populated by POPULATE_MEASURE_DATA. Any direct table access occurs through APPS synonyms under the APPS schema, consistent with standard EBS coding standards.

Usage Notes

BSC_BIS_WRAPPER_PUB is invoked from the Balanced Scorecard and DBI user interfaces, from concurrent programs that refresh KPI and measure data, and from custom PL/SQL or BI Publisher code that needs period-aware KPI values. Because the metadata records that the package is referenced by one other package, custom integrators should treat the PUB signatures as the supported contract and avoid calling BSC_BIS_WRAPPER_PVT directly. All functions use an EXCEPTION WHEN OTHERS handler that returns the (possibly NULL) output variable rather than propagating the error, so callers must validate returned values explicitly. When porting between 12.1.1 and 12.2.2, the package requires no changes; period resolution behaviour is driven by configuration rather than release-specific code.