Results for “pay_balance_pkg”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.PAY_BALANCE_PKG is a core Oracle Payroll database package that encapsulates the runtime logic governing how payroll balances are defined, created, and retrieved. Balances represent the accumulated monetary or numeric results of payroll processing—such as gross earnings, taxable wages, or deductions—that accumulate against an assignment, a group of assignments, or a payroll run. In Oracle EBS 12.1.1 and 12.2.2, this package acts as the engine behind balance creation and the calculation of context-sensitive balance values that feed defined balances, reports, and downstream payroll processes.

The package body is marked VALID in the ETRM repository, is owned by the APPS schema, and is classified under API classification OTHER. It is one of the more heavily consumed payroll packages, referenced by 320 other database objects, reflecting its role as foundational infrastructure rather than a narrow utility.

Key Procedures and Functions

The documented package exposes 41 procedures and functions. The most significant include:

• AND — a helper construct supporting conditional balance logic used internally by other routines.
• GET_PERIOD_TYPE_START — determines the starting period for a given period type, supporting balance accumulation across defined time periods.
• CHK_CONTEXT / GET_CONTEXT / GET_CONTEXT_INTERNAL / SET_CONTEXT / FIND_CONTEXT — the context management group. These routines resolve and validate balance contexts (the dimensional qualifiers such as assignment, organization, or payroll that determine which balance value applies), using the Fast Formula context infrastructure.
• RUN_DB_ITEM — executes a database item through the Fast Formula route framework, allowing formula-driven balance values to be evaluated.
• CHECK_BAL_EXPIRY — validates whether a balance has expired, ensuring stale balance values are not reused.
• GET_VALUE / GET_VALUE_LOCK — retrieve a balance value, with the locked variant providing controlled concurrent access during retrieval.
• INVALIDATE_RUN_BALANCES — marks run-level balance records as invalid so they are recalculated when next accessed.
• REMOVE_ASG_CONTRIBS / CREATE_ASG_BALANCE / CREATE_RR_ASG_BALANCES / CREATE_SET_ASG_BALANCE / CREATE_ALL_ASG_BALANCES — the assignment balance creation family. These create balance rows for individual assignments, set-based groups, and all assignments, and manage contribution removal.
• CREATE_GROUP_BALANCE / CREATE_SET_GROUP_BALANCE / CREATE_ALL_GROUP_BALANCES — the parallel group balance family, aggregating balance values across balance groups.

Tables Accessed

The package reads and writes a broad set of payroll and Fast Formula tables. Balance definition and value tables include PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, PAY_BALANCE_ATTRIBUTES, PAY_BALANCE_DIMENSIONS, PAY_BALANCE_CONTEXT_VALUES, PAY_LATEST_BALANCES, PAY_ASSIGNMENT_LATEST_BALANCES, PAY_PERSON_LATEST_BALANCES, and PAY_RUN_BALANCES. Run data is drawn from PAY_RUN_RESULTS and PAY_RUN_RESULT_VALUES, and assignment context from PER_ALL_ASSIGNMENTS_F and HR_ORGANIZATION_INFORMATION. The Fast Formula route and context infrastructure—FF_CONTEXTS, FF_DATABASE_ITEMS, FF_ROUTES, FF_ROUTE_CONTEXT_USAGES, FF_ROUTE_PARAMETERS, FF_ROUTE_PARAMETER_VALUES, and FF_USER_ENTITIES—supplies the metadata required to resolve context and evaluate database items. Action and route configuration tables such as PAY_ACTION_CLASSIFICATIONS, PAY_ACTION_INTERLOCKS, and PAY_DIMENSION_ROUTES complete the dependency set.

Usage Notes

PAY_BALANCE_PKG is not intended for direct invocation by end users. It is called primarily by the payroll run engine and by other payroll packages during balance calculation, balance retrieval, and period rollover. Because it is referenced by 320 objects, customizations that call it directly should do so only where a supported public entry point is unavailable, and should account for the concurrent locking behavior implied by GET_VALUE_LOCK and INVALIDATE_RUN_BALANCES. Typical indirect invocation surfaces include payroll concurrent programs, balance initialization and upgrade processes, and Fast Formula database item evaluation during payroll runs.