Search Results pay_ca_archive_utils




Overview
Explore in AI Chat

Overview

PAY_CA_ARCHIVE_UTILS is a PL/SQL package body owned by the APPS schema that supports the archival of Canadian payroll data within Oracle E-Business Suite releases 12.1.1 and 12.2.2. Its principal business function is to provide utility logic that determines how payroll action records are archived, and specifically how archived payroll values and archive template configurations are resolved during archival and purge processing. The package operates within the Oracle Payroll action lifecycle, where payroll runs, assignment actions, and their associated action interlocks must be preserved, moved, or purged according to statutory and internal retention policies.

The package is classified as OTHER rather than as a public or private API, indicating that it is intended primarily for internal consumption by other Oracle Payroll components rather than as a customer-facing integration point. It is referenced by nineteen other database objects, confirming its role as a shared utility within the payroll archival subsystem.

Key Procedures and Functions

The ETRM metadata documents four procedures and functions within this package. Two are explicitly named:

  • GET_ARCHIVE_VALUE — Returns an archive value for a given archival context. It is used during archive processing to determine the value that should be stored for an archived item, drawing on the configured archive item and context definitions.
  • GET_ENABLE_TEMPLATE_FLAG — Returns the flag indicating whether an archive template is enabled. This allows archival processing to honour template-level enablement settings before attempting to archive associated data.

The remaining two documented subprograms are not individually named in the available metadata. Based on the package name and its dependencies, they are presumed to provide supporting utility logic for archive item resolution and context handling. No parameter lists are asserted here, as the documented metadata does not expose them.

Tables Accessed

The package reads and writes several core tables and views through APPS synonyms. PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS hold the assignment-level and payroll-level action records that are the subjects of archival. PAY_ACTION_INTERLOCKS stores interlock relationships between action records, which must be respected to preserve referential integrity during archive and purge. FF_ARCHIVE_ITEMS and FF_ARCHIVE_ITEM_CONTEXTS define the archive items and their context values, forming the configuration substrate that GET_ARCHIVE_VALUE and related logic consult. FF_CONTEXTS supplies context definitions, and FF_DATABASE_ITEMS identifies the database items involved in archival. DUAL is used for single-row evaluations.

Usage Notes

PAY_CA_ARCHIVE_UTILS is not referenced by any database object, meaning it is a leaf dependency invoked by the nineteen packages and forms that call it rather than a dependency of them. It is typically invoked by Oracle Payroll archive and purge concurrent programs and by related payroll administration forms during the archival of Canadian payroll actions. Because the metadata describes only four documented procedures and the package is classified as OTHER, custom code should avoid direct invocation; developers requiring archive value or template enablement information should use supported APIs where available, or treat this package as an internal implementation detail subject to change between releases. All accesses occur in the APPS schema context, so any grants or synonyms should follow standard EBS APPS security conventions.