Search Results range_cursor

Overview

APPS.PAY_US_ARCHIVE_RULES is a United States legislation-specific PL/SQL package body that encapsulates the business rules used by the Oracle Payroll archiving process. Its documented purpose is to supply the rules for archiving the "Missing Assignment Report," a compliance artifact specific to US payroll legislation. The package was originally created on 24-Oct-2005 and later enhanced in version 115.1 (19-JAN-2007, Bug 4886285) to add a GRE condition within the range_cursor and to introduce the archive_code procedure alongside the existing action creation logic.

The package is registered in ETRM with the classification OTHER, indicating it is not a public API in the conventional sense but rather an internal rule provider invoked by the Payroll archiving framework. It is not referenced by any other documented packages, confirming that it is driven directly by the archiving subsystem rather than by downstream PL/SQL dependencies. The single-header comment establishes the file as payusarcyema.pkb, version 120.1, with the standard Oracle Corporation copyright and restriction notices.

Key Procedures and Functions

• RANGE_CURSOR — Produces the SQL cursor text that defines the range of records to be archived. It is an OUT NOCOPY VARCHAR2 parameter interface, with the driving payroll action identifier supplied as input. The 2007 change added a GRE (Government Reporting Entity) condition, meaning the generated cursor is constrained not only by the payroll action but also by the GRE identifier, an important control for US legislative data segregation.
• ACTION_CREATION — Handles creation of the payroll action record associated with the archiving run. It was revised in the same bug fix to incorporate the GRE condition, ensuring that the archive action is correctly scoped for the relevant government reporting entity.
• ARCHIVE_CODE — A procedure added in version 115.1 to encapsulate archiving code logic previously handled elsewhere. It complements the rule set by providing a dedicated entry point for the archiving behavior.

The body opens by declaring gv_package_name as 'pay_us_archive_rules.', which is used with hr_utility.set_location for diagnostic tracing, as seen in range_cursor at location 10.

Tables Accessed

The only documented table reference is PAY_PAYROLL_ACTIONS, accessed through its APPS synonym. This is the central table for payroll action definitions in Oracle Payroll, and the package reads it to identify and validate the payroll action being archived. The range_cursor procedure uses the action identifier to build a bounded SQL statement against this table, while action_creation and archive_code operate on the action lifecycle. No other tables are documented in the metadata.

Usage Notes

Because the object is an OTHER-classified, US-legislative rule package with zero referencing packages, it is invoked by the Oracle Payroll archiving framework rather than by customer code. Typical invocations occur through the Payroll Archive/Unarchive concurrent programs when processing US payroll data, where the framework calls range_cursor to obtain the selection SQL, then coordinates action creation and archiving. Custom code should not call these procedures directly unless replicating the archiving framework, since their behavior is coupled to PAY_PAYROLL_ACTIONS state and GRE scoping. Tracing output via hr_utility.set_location makes HR_UTILITY-based debugging available when diagnosing archiving failures.