Search Results pay_balance_dimension_api




Overview
Explore in AI Chat

Overview

PAY_BALANCE_DIMENSION_API is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite, classified as an Application Programming Interface (API) object. It forms part of the Oracle Payroll balance and dimension management infrastructure, which governs how payroll balances are defined and constrained against the dimensional contexts—such as assignment, organization, element, and other balance attributes—that determine how payroll results are accumulated and reported.

The package provides the programmatic entry point for creating, maintaining, and removing balance dimension definitions. Balance dimensions define the level of granularity at which a payroll balance is calculated; for example, a balance dimension may specify that a particular balance accumulates at the assignment level, the organization level, or a combination of contexts. By centralizing these operations in a single API, Oracle ensures that dimensional data is manipulated in a controlled, validated manner rather than through direct table updates. The package was designed to be invoked both by Oracle's own maintenance forms and by external or custom code that needs to extend or automate balance-dimension configuration.

Key Procedures and Functions

The documented ETRM metadata lists four callable routines within this package:

  • CREATE_BALANCE_DIMENSION — Inserts a new balance dimension definition into the payroll dimensional model. It is the primary routine for introducing a new dimension, validating the definition and registering it so that balances can be accumulated against the new context.
  • UPDATE_BALANCE_DIMENSION — Modifies an existing balance dimension definition. This routine supports maintenance of dimension attributes after initial creation, subject to the API's validation rules.
  • DELETE_BALANCE_DIMENSION — Removes a balance dimension definition. Deletion is typically constrained by dependency checks that prevent removal of dimensions still referenced by balance definitions or accumulated results.
  • RETURN_DML_STATUS — Returns the status of the most recent DML operation performed by the calling session. This is a standard pattern in Oracle EBS API packages, allowing callers to determine success or failure after invoking a create, update, or delete routine.

The metadata does not document parameter lists; callers should consult the package specification in the EBS instance for the precise signatures.

Tables Accessed

The ETRM excerpt for this object does not enumerate the underlying tables referenced through APPS synonyms; the dependency listing is limited to SYS.STANDARD plus references from a small number of dependent objects. Functionally, the package operates on the payroll balance dimension repository—the tables that hold balance dimension headers and their associated dimensional context definitions used by the Oracle Payroll balance engine. Because the API is classified as an API object and is the sole supported route for this maintenance, direct DML against the underlying tables is not recommended.

Usage Notes

PAY_BALANCE_DIMENSION_API is referenced by three dependent packages in the APPS schema, including the translated maintenance objects PAY_PBD_MNT_TL_ARD, PAY_PBD_MNT_TL_ARI, and PAY_PBD_MNT_TL_ARU. These objects indicate that the API is invoked from the balance dimension maintenance forms used to administer payroll dimensions. Custom code and data-migration scripts should invoke the four documented routines rather than performing direct inserts or updates, and should check RETURN_DML_STATUS after each DML call to confirm that the operation succeeded. This package applies to both Oracle EBS 12.1.1 and 12.2.2, as the underlying Payroll balance architecture is consistent across those releases.