Search Results turn_off_report_dimension

Overview

The APPS.PAY_CA_BALANCE_PKG package is a Canadian payroll localization utility within the Oracle E-Business Suite Payroll (PAY) module. Its principal business function is the retrieval and evaluation of payroll balance values that are required for Canadian statutory calculations, tax reporting, and payroll processing. Balances in Oracle Payroll represent accumulated year-to-date or period-to-date values such as gross earnings, taxable wages, CPP contributions, and EI premiums. The package exposes these values to dependent payroll routines through a controlled API layer rather than direct table access.

The package is declared with AUTHID CURRENT_USER and resides in the APPS schema, relying on APPS synonyms to reach the underlying PAY and FF tables. Its header history shows an evolution from an initial balance-retrieval utility to a broader set of functions covering current balance access, jurisdiction-aware lookups, and performance-tuning controls.

The object is referenced by approximately twenty other packages, indicating that it functions as a shared service for balance resolution across the Canadian payroll stack. The search term payments_balance_required corresponds directly to a documented function added in version 115.6, copied from the pre-existing pyustxbv.pkb package body.

Key Procedures and Functions

• CALL_CA_BALANCE_GET_VALUE — The core retrieval routine. It accepts a balance name and related context identifiers and returns the corresponding balance value. An overloaded variant accepting a source identifier (p_source_id) was introduced in version 110.4. Earlier versions also carried a tax unit parameter, later replaced by a jurisdiction code.
• GET_CURRENT_BALANCE — Returns the current (as-of-now) value of a balance, supporting real-time payroll processing where a balance has not yet been aggregated into its final stored form. A PRAGMA associated with this function was removed in version 115.11.
• PAYMENTS_BALANCE_REQUIRED — Determines whether a payments-related balance is required for a given payroll context. This function gates downstream processing so that balance queries are only issued when actually needed, which reduces processing overhead during payroll runs. It was added in version 115.6 and ported from pyustxbv.pkb.
• TURN_OFF_DIMENSION — A tuning function introduced in version 115.7 that disables dimension calculation within the balance framework, intended to improve performance in Startup/Open/End (SOE) view scenarios.
• TURN_OFF_REPORT_DIMENSION — The procedural companion to the above, allowing callers to suppress report-oriented dimension processing where full dimensional aggregation is unnecessary.

Tables Accessed

The package reads and writes several core payroll and FastFormula tables through APPS synonyms:

• PAY_RUN_TYPES_F and PAY_PAYROLL_ACTIONS — establish the payroll run and action context under which a balance is being evaluated.
• PAY_ASSIGNMENT_ACTIONS and PAY_ACTION_INTERLOCKS — link the assignment to the action and manage interlock sequencing during payroll processing.
• PAY_ACTION_CONTEXTS and FF_CONTEXTS — supply the dimensional context (balance dimensions such as assignment, tax unit, jurisdiction) needed to resolve the correct balance row.
• PAY_CA_PMED_ACCOUNTS — the Canadian payroll mid-end account table, reflecting the localization-specific data this package serves.

Usage Notes

PAY_CA_BALANCE_PKG is typically invoked from Canadian payroll FastFormula functions, concurrent programs performing balance aggregation or reporting, and custom PL/SQL extensions that require balance values without querying PAY_BALANCE_VALUES directly. Because it is referenced by roughly twenty packages, changes to its signatures or behavior carry wide impact and should be regression-tested against Canadian payroll cycles. The dimension-tuning entry points are appropriate during large-volume reporting or SOE view generation, where full dimensional resolution is not required.