Search Results pay_defined_balances_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_DEFINED_BALANCES_PKG is the core PL/SQL package body that encapsulates the business logic for maintaining defined balances within the Oracle Payroll (PAY) application of Oracle E-Business Suite. A defined balance is the fundamental building block of payroll processing: it is the named accumulation against which payroll run results, element input values, and assignment-level calculations are stored and subsequently consumed by balance feeds, reports, and downstream processes. The package therefore sits at the intersection of payroll configuration and payroll runtime data.

In the EBS 12.1.1 and 12.2.2 releases the package is registered as a VALID object owned by APPS, and the ETRM metadata classifies its API type as OTHER, indicating that it is an internal repository package invoked by the Payroll forms and by other payroll packages rather than a publicly documented integration API. The ETRM metadata records that PAY_DEFINED_BALANCES_PKG is referenced by twelve other database objects, confirming its role as a shared dependency used across payroll balance maintenance.

The package depends on APP_EXCEPTION, FND_MESSAGE, FND_SESSIONS, HR_UTILITY, and STANDARD, which indicates that it follows standard Oracle Applications coding conventions for error raising, message retrieval, session context, and utility handling, and that it raises exceptions through APP_EXCEPTION rather than raw SQL errors.

Key Procedures and Functions

The ETRM documentation lists nine procedures and functions within the package. Their documented purpose is as follows:

  • CHK_DELETE_DEFINED_BALANCE — Validates whether a defined balance may be deleted, enforcing referential and configuration constraints before removal.
  • SET_SAVE_RUN_BALS_FLAG — Sets the flag controlling whether run balances should be saved for the balance definition.
  • VERIFY_SAVE_RUN_BAL_FLAG_UPD — Verifies the state of the save-run-balances flag before permitting an update.
  • INSERT_DEFAULT_ATTRIB_WRAPPER — Wrapper routine that orchestrates insertion of default balance attributes.
  • INSERT_DEFAULT_ATTRIBUTES — Inserts the default attribute rows associated with a defined balance.
  • INSERT_ROW — Performs the insert of a defined balance record.
  • LOCK_ROW — Acquires a row-level lock prior to modification, supporting concurrent maintenance.
  • UPDATE_ROW — Applies updates to an existing defined balance record.
  • DELETE_ROW — Deletes a defined balance record once validation succeeds.

Tables Accessed

The package reads and writes through APPS synonyms. Its principal maintenance target is PAY_DEFINED_BALANCES and its translated/denormalized companion PAY_DEFINED_BALANCES_S. Configuration context is drawn from PAY_BALANCE_TYPES, PAY_BALANCE_CATEGORIES_F, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_ATTRIBUTES, PAY_BALANCE_VALIDATION, PAY_BAL_ATTRIBUTE_DEFAULTS, and PAY_BAL_ATTRIBUTE_DEFINITIONS. Run- and assignment-level balance data is touched through PAY_RUN_BALANCES, PAY_PERSON_LATEST_BALANCES, and PAY_ASSIGNMENT_LATEST_BALANCES. Additional dependencies include PAY_BACKPAY_RULES, PAY_ORG_PAYMENT_METHODS_F, PER_BUSINESS_GROUPS, FND_SESSIONS, and DUAL.

Usage Notes

PAY_DEFINED_BALANCES_PKG is typically invoked from the Payroll defined-balance maintenance forms and from other payroll packages during balance definition setup, rather than being called directly from custom concurrent programs. Because the package is referenced by twelve objects and depends on HR_UTILITY, FND_MESSAGE, and APP_EXCEPTION, customers customizing payroll should treat it as an internal package: callers should expect APP_EXCEPTION-based error handling and session context from FND_SESSIONS, and should not assume parameter signatures. When extending or troubleshooting defined-balance setup on 12.1.1 or 12.2.2, reviewing the dependency chain recorded in ETRM is advisable, since the package’s lock, insert, update, and delete routines operate in close coordination with the balance attribute and validation tables listed above.