Search Results pay_us_archive_rules

Overview

The APPS.PAY_US_ARCHIVE_RULES package is a PL/SQL database object that resides in the Oracle E-Business Suite Applications schema (APPS) and is classified under the OTHER API category in the E-Business Suite Technical Reference Manual (ETRM) for release 12.2.2. Its name and schema placement indicate that it belongs to the Oracle Payroll (PAY) product family, specifically to the United States localization layer, and that it encapsulates archiving rules logic used when payroll data is being consolidated, purged, or moved to archive storage. Payroll archiving is a statutory and operational requirement in many jurisdictions: employers must retain historical payroll results for audit and reporting purposes while removing obsolete transactional rows from production tables to protect performance. The package provides the discrete rules engine used to determine the boundaries, actions, and archive identifiers applied during that process. The object is reported with a status of VALID, and its dependency analysis shows it references only the SYS.STANDARD package at the schema dependency level, with table access resolved through APPS synonyms.

Key Procedures and Functions

The ETRM documents three program units within the package. Parameter signatures are not enumerated in the metadata and should be confirmed against the deployed source in each environment before use.

• RANGE_CURSOR — A cursor-based construct used to identify and iterate over the date or identifier range that defines the scope of an archive operation. It supplies the driving set of records that subsequent rule evaluation and action generation depend upon.
• ACTION_CREATION — The procedure responsible for generating the archive action entries that describe what is to be done with each qualifying record or payroll action, translating evaluated rules into concrete archive instructions.
• ARCHIVE_CODE — The program unit that determines or supplies the archive code value associated with a payroll action, effectively tagging data with the classification that governs its disposition during and after the archive run.

Tables Accessed

The documented table access is limited to PAY_PAYROLL_ACTIONS, reached through an APPS synonym. This is the controlling table for payroll runs and related actions in Oracle Payroll, holding the payroll action records that identify individual payroll processes and their identifying dates and identifiers. PAY_US_ARCHIVE_RULES reads this table to determine which payroll actions fall within the required archiving range and to associate archive codes and generated actions with them. Given the package name and its US localization scope, the package may participate in writing or updating archive-related attributes on those action rows, though the ETRM excerpt documents the table only as referenced rather than detailing read/write direction. No other tables are listed in the documented dependency set, which suggests the package operates as a focused rules component rather than a full archive execution driver.

Usage Notes

The package is referenced by zero other packages in the documented dependency map, and the dependency listing shows APPS.PAY_US_ARCHIVE_RULES referencing itself, which is typical of overloaded or recursive package constructs and confirms that it is a leaf-level component rather than a shared library. In practice, packages of this type are invoked by Oracle Payroll archive and purge concurrent programs, by the corresponding payroll archive forms, or by customer-written wrapper programs that call the package before or during an archive cycle. Because the object may be overwritten or replaced by Oracle Payroll patch and maintenance routines, customers should not modify the package body directly; any extension should be implemented through a separate custom package that calls the delivered program units. Before relying on RANGE_CURSOR, ACTION_CREATION, or ARCHIVE_CODE, verify the actual parameter lists and return types by querying ALL_ARGUMENTS or by inspecting the packaged source in the target environment, as the ETRM metadata for this object documents only the unit names and the single table dependency.