Search Results rollback_api
Overview
APPS.BSC_PERIODS_UTILITY_PKG is a utility package within the Oracle EBS Balanced Scorecard (BSC) product family. Its stated purpose, drawn from the package header comments, is to serve as a "Utility file for Calendar and Periodicities and TIME integration modules (designer)." In practice, the package centralizes the low-level logic that the Balanced Scorecard designer requires in order to create, retrieve, update, and delete calendars and their associated periodicities — the time dimensions against which scorecard measures are evaluated.
The package was authored in 2005 and carries the header identifier BSCUPERS.pls, revision 120.8. It defines a fixed set of DML action constants — C_CREATE, C_UPDATE, C_RETRIEVE, and C_DELETE — together with naming constants such as G_PKG_NAME and C_CUSTOM_DB_COL_PREFIX, indicating that it is invoked as a supporting layer by higher-level calendar and periodicity APIs rather than being called directly by end users. It is formally classified under ETRM as an "OTHER" API, meaning it is not part of a published, externally supported public interface, and it is referenced by nine other packages in the application.
Key Procedures and Functions
The ETRM metadata documents twenty-seven procedures and functions. These fall into several functional groups:
- Calendar lookups: GET_CALENDAR_NAME and GET_CALENDAR_SHORT_NAME return identifying attributes for a given calendar, while GET_NEXT_CALENDAR_ID supplies the next surrogate key from the calendar sequence.
- Periodicity resolution: GET_PERIODICITY_NAME, GET_PERIODICITY_SHORT_NAME, GET_PERIODICITY_SOURCE, and GET_UNIQUE_SHORT_NAME retrieve descriptive and source information for a periodicity definition. IS_PERIODICITY_IN_CALENDAR verifies membership of a periodicity within a calendar.
- Custom periodicity management: GET_CUST_PER_CNT_BY_CALENDAR returns the count of custom periodicities attached to a calendar, GET_NEXT_CUST_PERIOD_DB_COLUMN and GET_NEXT_PERIODICITY_ID allocate new custom periodicity identifiers and column names, and C_MAX_CUSTOM_PERIODICITIES fixes the upper bound at twenty.
- Period and date arithmetic: GET_START_PERIOD_DATE, GET_END_PERIOD_DATE, GET_QUARTER_DATE_LABEL, GET_PERIODS_IN_BASE_PERIOD, GET_FISCALYEAR_BY_CALENDAR, and IS_BASE_PERIODICITY_DAILY derive date and fiscal attributes from stored calendar definitions.
- Validation and diagnostics: IS_PERIOD_NAME_UNIQUE enforces uniqueness of period names; CHECK_ERROR_MESSAGE and PRINT_PERIOD_METADATA produce diagnostic output for message logging.
- Rollback: ROLLBACK_API, the procedure matching the search term, provides the rollback path used when a create, update, or delete operation on a calendar or periodicity fails partway through and the transaction must be unwound.
Tables Accessed
The package reads and writes the core Balanced Scorecard calendar schema through APPS synonyms. BSC_SYS_CALENDARS_B and BSC_SYS_CALENDARS_TL hold the calendar base and translated rows; BSC_SYS_CALENDAR_ID_S supplies calendar identifiers. BSC_SYS_PERIODICITIES and BSC_SYS_PERIODICITY_ID_S store periodicity definitions and their keys. BSC_DB_CALENDAR holds the database-level calendar representation, while BIS_LEVELS and BIS_LEVELS_TL are consulted for time-level hierarchy information. BSC_MESSAGE_LOGS captures diagnostic messages emitted by the package, and DUAL and DBMS_UTILITY are used for scalar evaluation and built-in utility routines.
Usage Notes
BSC_PERIODS_UTILITY_PKG is an internal support package, not an end-user entry point. It is typically invoked from the Balanced Scorecard administration and designer forms when a user defines or modifies a calendar, and from concurrent or programmatic processes that create periodicities in bulk. Custom code should treat it as unsupported, as its classification is OTHER and its procedures are not published with documented parameter contracts. Releasing 12.1.1 and 12.2.2, the package remains resident in the APPS schema; callers should target the wrapper APIs of the calling modules rather than this utility directly.