Search Results pay_ca_group_level_bal_pkg




Overview
Explore in AI Chat

Overview

The APPS.PAY_CA_GROUP_LEVEL_BAL_PKG package body is a Canadian localization component within the Oracle EBS Payroll (PAY) module. Its business purpose is to compute and retrieve group-level (aggregate) balance values for Canadian payroll balances, providing the calculation engine behind Canadian statutory and payroll reporting balances that are defined in terms of a group of assignments rather than a single assignment.

The package is classified as a valid PL/SQL package body owned by the APPS schema. Its principal role is to resolve group-level balance definitions for Canadian balances by evaluating assignment-level balances and defined-balance formulas, applying the appropriate balance dimensions, and returning the aggregated result to the calling process. It is referenced by four other packages, indicating its use as a shared utility within the Canadian payroll balance architecture.

Key Procedures and Functions

The documented package exposes three program units:

  • CA_GROUP_LEVEL_BALANCE — The primary entry point that calculates or returns a Canadian group-level balance value for a given balance definition and group context. It determines the eligible assignments in the group and aggregates the underlying balance values.
  • CA_GROUP_LEVEL_BALANCE_RB — A run-balance variant of the group-level balance routine, used when the balance must be resolved from run-balance data (PAY_RUN_BALANCES) rather than latest-balance data, allowing recalculation against a specific payroll run or balance run.
  • GET_DEFINED_BALANCE — Returns the defined-balance value, resolving the balance through the defined-balance framework (PAY_DEFINED_BALANCES) so that group-level aggregation can be applied consistently with standard balance definitions.

These units operate together to provide balance resolution that is aware of Canadian payroll balance rules, balance dimensions, and group membership.

Tables Accessed

The package reads and writes through APPS synonyms. Balance data is sourced from PAY_ASSIGNMENT_LATEST_BALANCES, PAY_RUN_BALANCES, PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, and PAY_BALANCE_DIMENSIONS. Payroll context is established via PAY_ALL_PAYROLLS_F, PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_ACTION_CONTEXTS. Assignment and organizational data are obtained from PER_ALL_ASSIGNMENTS_F, PER_PAY_BASES, HR_ALL_ORGANIZATION_UNITS, and HR_ORGANIZATION_INFORMATION. Flexfield context resolution uses FF_CONTEXTS and HR_SOFT_CODING_KEYFLEX.

Usage Notes

This package is normally invoked indirectly. It is called by other payroll packages (it is referenced by four dependent objects) and supports Canadian balance reporting and group-level balance calculations surfaced through the Standard Balance Views and Canadian localization balance processing. It is not referenced by any database object other than its dependents, so direct invocation is uncommon.

Custom code requiring Canadian group-level aggregates should call the documented entry points rather than querying underlying balance tables directly, because the package applies balance dimensions, defined-balance logic, and group scoping consistently. Callers should supply a valid balance context and payroll action context; incorrect context resolution or missing flexfield context data may result in null or incomplete balance values.