Search Results bsc_metadata_optimizer_pkg




Overview
Explore in AI Chat

Overview

APPS.BSC_MO_DOC_PKG is a member of the Oracle Balanced Scorecard (BSC) metadata optimizer family of packages, delivered in the APPS schema as part of the E-Business Suite 12.1.1 and 12.2.2 codebase. Its primary business function is documentation and introspection support for the metadata optimizer infrastructure. The package exposes utilities that examine the repository of Balanced Scorecard database objects, dimension definitions, and periodicity configurations, and it renders documentation about those objects for administrative and diagnostic purposes. The package is classified as OTHER in the ETRM API classification, indicating that it is not a public, supported integration API but rather an internal helper invoked by sibling packages. It is currently VALID in the data dictionary.

The object is directly relevant to searches for bsc_metadata_optimizer_pkg because the two packages are tightly coupled: BSC_MO_DOC_PKG references BSC_METADATA_OPTIMIZER_PKG, and BSC_METADATA_OPTIMIZER_PKG in turn references BSC_MO_DOC_PKG. This bidirectional dependency reflects a design in which documentation routines and optimizer routines share repository metadata.

Key Procedures and Functions

The ETRM documentation records six callable units within the package. No parameter lists are published, so only functional intent is described.

  • DOCUMENTATION — The principal entry point. It generates descriptive documentation for the Balanced Scorecard metadata objects under consideration, drawing on the repository tables and dictionary views the package accesses.
  • STRFIX — A string-formatting helper. It normalizes or reformats textual content, most likely for consistent rendering of generated documentation output.
  • GETPERIODICITYNAME — Returns the display name associated with a defined periodicity, resolving the identifier held in the periodicity setup table to a readable label.
  • GETMAXPERIOD — Returns the maximum period value defined for a given periodicity, used when determining the widest time horizon available to a Scorecard object.
  • GETMAXSUBPERIODUSR — Returns the maximum user-defined sub-period for a periodicity, supporting finer-grained time breakdowns within a period.
  • GETPERIODICITYCALENDARNAME — Returns the calendar name linked to a periodicity, tying the time definition to its underlying calendar.

Collectively, four of the six procedures are dedicated to periodicity resolution, revealing that a significant portion of the package's purpose is to translate stored periodicity identifiers into human-readable calendar, period, and sub-period information for documentation and reporting.

Tables Accessed

The package reads and writes through APPS synonyms. Repository structure is inspected via BSC_DB_TABLES_COLS and BSC_DB_TABLES_RELS, which describe Balanced Scorecard database tables, their columns, and the relationships between them; these drive the introspection performed by DOCUMENTATION. Dimension hierarchies are obtained from BSC_KPI_DIM_LEVELS_B. Periodicity definitions and their limits come from BSC_SYS_PERIODICITIES, which underpins the four periodicity getters.

Data dictionary views supply runtime catalog information: ALL_MVIEWS for materialized views, ALL_TABLES for table definitions, ALL_TAB_COLUMNS for column metadata, and USER_OBJECTS for object resolution. Dynamic SQL is executed through the DBMS_SQL built-in, and PLITBLM (the PL/SQL integer table type) is used for array-style parameter passing. The SYS.STANDARD package reference reflects core PL/SQL language support.

Usage Notes

BSC_MO_DOC_PKG is an internal package and is not intended for direct invocation from custom code. It is referenced by three other application packages — BSC_METADATA_OPTIMIZER_PKG, BSC_MO_INDICATOR_PKG, and BSC_MO_UI_PKG — and by itself. The dependency on BSC_MO_UI_PKG indicates that documentation generated by this package can surface through the Balanced Scorecard administrative user interface, while the dependency on BSC_METADATA_OPTIMIZER_PKG indicates it is exercised during optimizer processing, typically when an administrator deploys or refreshes Balanced Scorecard metadata.

In EBS 12.1.1 and 12.2.2, such optimizer activity is normally initiated through the Balanced Scorecard administrator responsibility or via concurrent programs that invoke the optimizer chain. Because the package is classified as OTHER and performs dictionary introspection, it should be treated as Oracle-internal; modifications to dependent objects, particularly the BSC repository tables, may invalidate it. Status should be verified after patching or upgrades using the standard dependency and invalidation reports.