Search Results pay_za_tys_processes_s




Overview

APPS.PAY_ZA_UPDATE_PKG is a PL/SQL package body in the Oracle E-Business Suite Payroll (PAY) schema that supports the South African localization for payroll tax year processing. Its principal business function is to manage the records held in the PAY_ZA_TYS_PROCESSES table, which stores the South African tax year start (TYS) processing data used to roll payroll element entries forward at the beginning of a new tax year. The package provides controlled mechanisms to validate whether a payroll is eligible to be updated, to apply updates to tax year start process records, and to reverse (roll back) those updates when payroll must be restored to its original state.

The package is classified as an OTHER API within the Oracle E-Business Suite 12.1.1 and 12.2.2 environments. It is declared VALID in the APPS schema. Documentation indicates that it is referenced by one other database object, though no object in the ETRM dependency listing references it directly by name — consistent with typical payroll localization utilities invoked through concurrent programs or client-side logic rather than from other database packages.

Key Procedures and Functions

The package body implements ten documented procedures and functions that together handle the tax year start update and rollback lifecycle:

  • PAYROLL_UPDATEBLE — Determines whether a given payroll is eligible for the tax year start update process, acting as a gate before any data modification.
  • PAYROLL_ROLLBACKABLE — The counterpart check, determining whether a payroll that has already been updated can be rolled back.
  • GET_TAX_YEAR — Retrieves the tax year associated with the update context.
  • GET_TAX_YEAR_END — Retrieves the tax year end value, used to bound the processing period.
  • ENTRY_VALID — Validates an element entry against the rules governing the tax year start update.
  • UPDATE_THIS_RECORD — Applies the update to an individual record, encapsulating per-record update logic.
  • UPDATE_TYSP_TABLE — Drives the update process across the PAY_ZA_TYS_PROCESSES table for the affected scope.
  • DELETE_TYSP_TABLE — Removes records from the tax year start processes table, typically as part of cleanup or reversal.
  • GET_ORIGINAL_VALUE — Captures or returns the pre-update value of a record so that changes can be reversed accurately.
  • ROLLBACK_THIS_RECORD — Restores an individual record to its original state using the value obtained by GET_ORIGINAL_VALUE.

Tables Accessed

The package touches the following tables through APPS synonyms, all essential to payroll element entry manipulation:

The package additionally depends on seeded APIs HR_API, HR_ENTRY_API, and HR_UTILITY for date and element-entry handling, and on PAY_ZA_TAX_YEAR_START_PKG, the localization package with which it collaborates during tax year start processing.

Usage Notes

PAY_ZA_UPDATE_PKG is a South African localization utility that is not typically called directly from other database packages; the ETRM metadata lists no dependent objects referencing it. It is most commonly invoked through Oracle Payroll concurrent programs or South African localization forms that drive tax year start processing for a payroll. Custom extensions should call the package's public procedures — validating with PAYROLL_UPDATEBLE or PAYROLL_ROLLBACKABLE before invoking the update or rollback routines — rather than manipulating PAY_ZA_TYS_PROCESSES directly, to preserve integrity of element entry values across the tax year transition. Because the package relies on date-effective element and assignment tables, it should be run within the correct payroll period context to avoid affecting records outside the intended tax year.