Results for “calc_asg_run”

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

Overview

HR_NZBAL is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that implements the New Zealand statutory balance calculation engine for Oracle Payroll. Its principal business function is to compute assignment-level Year-To-Date (YTD), Quarter-To-Date (QTD), Period-To-Date (PTD), and four-weekly balance values that satisfy New Zealand payroll reporting and legislative requirements, including holiday pay accrual and gross earnings definitions used by Inland Revenue reporting and the Holidays Act.

The package is classified in ETRM as an OTHER API, meaning it is an internal engine rather than a published, externally supported interface. It is validated and confirmed as VALID in both Oracle EBS 12.1.1 and 12.2.2. It is referenced by nine other packages, including HR_NZ_HOLIDAYS, PAY_NZ_QES_PKG, PAY_NZ_REC_PKG, and PAY_NZ_SOE_PKG, and serves as the underlying calculation layer for the PAY_NZ_BALANCES_V, PAY_NZ_BALANCES_BY_ACTION_V, PAY_NZ_BALANCES_BY_DATE_V2, PAY_NZ_BALANCES_MATRIX_V, and PAY_PAYNZBAL_VALUES_V views.

Key Procedures and Functions

ETRM documents 30 procedures and functions, organised as a consistent trio pattern: a base calculation routine, an _ACTION variant, and a _DATE variant. The core routines are:

• CALC_ALL_BALANCES — the master driver that orchestrates calculation of every New Zealand balance for an assignment.
• CALC_ASG_YTD / CALC_ASG_YTD_ACTION / CALC_ASG_YTD_DATE — compute assignment-level Year-To-Date balances, respectively for a payroll action, for a specific effective date, and as the base routine.
• CALC_ASG_PTD / CALC_ASG_PTD_ACTION / CALC_ASG_PTD_DATE — compute Period-To-Date balances for the current payroll period.
• CALC_ASG_TD_ACTION / CALC_ASG_TD_DATE — compute To-Date balances driven by an action or date context.
• CALC_ASG_FY_YTD / CALC_ASG_FY_YTD_ACTION / CALC_ASG_FY_YTD_DATE — compute Financial-Year-To-Date balances, aligned to the New Zealand tax year beginning 1 April.
• CALC_ASG_FY_QTD / CALC_ASG_FY_QTD_ACTION / CALC_ASG_FY_QTD_DATE — compute Financial-Year Quarter-To-Date balances.
• CALC_ASG_4WEEK / CALC_ASG_4WEEK_ACTION / CALC_ASG_4WEEK_DATE — compute four-weekly balances supporting the New Zealand four-weekly pay cycle convention.
• CALC_ASG_HOL_YTD / CALC_ASG_HOL_YTD_ACTION / CALC_ASG_HOL_YTD_DATE — compute holiday-pay Year-To-Date accrual and entitlement balances in support of the Holidays Act.

Tables Accessed

The package reads and derives values from the following documented tables via APPS synonyms:

• PAY_ASSIGNMENT_ACTIONS — source of payroll action records that drive the _ACTION variants.
• PAY_BALANCE_DIMENSIONS — defines the balance dimension context (assignment, period, year) used to segment results.
• PAY_DEFINED_BALANCES — identifies which defined balances feed the New Zealand calculations.
• PAY_PAYROLL_ACTIONS — supplies payroll action context and period information for action-scoped runs.
• PER_ALL_ASSIGNMENTS_F — provides assignment attributes and effective-dated employment information.
• PER_TIME_PERIODS and PER_TIME_PERIOD_TYPES — supply period boundaries used to resolve YTD, QTD, PTD, and 4-weekly windows.

Usage Notes

HR_NZBAL is typically invoked indirectly. Standard invocations occur through New Zealand payroll balance views (PAY_NZ_BALANCES_V and its variants), through the New Zealand payroll processes in PAY_NZ_QES_PKG, PAY_NZ_REC_PKG, and PAY_NZ_SOE_PKG, and through the holiday calculation package HR_NZ_HOLIDAYS. Because it is an OTHER-class API, Oracle does not support direct calls from customer code; customisations that require New Zealand balance values should query the dependent views rather than call HR_NZBAL directly. Where tight integration is unavoidable, the _DATE variants are generally preferred in custom code for deterministic point-in-time results, while the _ACTION variants are intended for invocation within payroll action processing. As with all APPS-owned packages, customer extensions should be placed in a separate custom schema to avoid patch conflicts.