Search Results pay_ca_archive_rules

Overview

PAY_CA_ARCHIVE_RULES is an Oracle Application Object Library package owned by the APPS schema and classified as a component of the Oracle Payroll Canadian localization. In Oracle EBS 12.1.1 and 12.2.2 it provides the business logic that governs the archiving of Canadian payroll data. Archiving in the payroll context consists of consolidating historical payroll results into a form suitable for statutory retention while removing them from the active operational tables. The package supplies the rule engine that determines which records qualify for archiving, when an archive event should be created, and which archive code should be applied to the affected payroll actions. The package is reported with a VALID status in the Enterprise Technical Reference Manual, confirming it is a compiled and supported database object at the documented release level.

Key Procedures and Functions

The ETRM metadata documents three callable components within the package body. No parameter signatures are published, so only the intended roles are described here.

• RANGE_CURSOR — A cursor-oriented routine that identifies the set, or range, of payroll records eligible for archival processing. It establishes the driving data set against which the remaining archive rules are evaluated, typically scoped by payroll action, date range, or organizational criteria.
• ACTION_CREATION — The routine responsible for creating the archive action record. It constructs and inserts the payroll action that represents the archival event, thereby registering the archive within the payroll action framework so that it can be tracked and audited like any other payroll process.
• ARCHIVE_CODE — The routine that determines or assigns the archive code associated with a payroll action. This code classifies the nature or disposition of the archival event and is used downstream to interpret the status and outcome of the archived payroll data.

Tables Accessed

The package accesses a single documented table through APPS synonyms:

• PAY_PAYROLL_ACTIONS — The core payroll action table. ACTION_CREATION writes to this table to establish the archive action, and the cursor and code routines read from it to determine which prior actions are subject to archival and what archive code they currently carry. This is consistent with the broader EBS payroll model, where every payroll run, reversal, and consolidation is represented as a row in PAY_PAYROLL_ACTIONS.

No other application tables are listed as dependencies in the supplied metadata, indicating that the package operates primarily as a rule and action-creation utility rather than as a bulk data mover.

Usage Notes

PAY_CA_ARCHIVE_RULES is an internal, non-public package. The ETRM record shows it is referenced by no other documented packages, and its only listed dependency is the SYS.STANDARD package, meaning it relies on PL/SQL built-ins and the APPS synonyms for its table access. Because no published API classification extends beyond OTHER, the package is not intended as a supported integration point for customer extensions. In practice it is invoked indirectly by the Canadian payroll archiving concurrent programs and related payroll processes rather than directly from a form. Support engineers and technical consultants typically inspect it when diagnosing archive-related payroll action anomalies. It should not be called from custom code, since its interface is undocumented and subject to change without notice between 12.1.1 and 12.2.2.