Search Results pay_ca_eoy_archive




Overview
Explore in AI Chat

Overview

PAY_CA_EOY_ARCHIVE is an Oracle Payroll package in the APPS schema that supports Canadian Year-End (EOY) processing within Oracle E-Business Suite 12.1.1 and 12.2.2. Its principal business purpose is to archive payroll data that is no longer required for active processing, allowing the retention of statutory Canadian year-end records — such as T4 and RL-1 reporting data — while removing the associated transactional volume from active payroll tables. This archival approach preserves data required for auditing and government reporting obligations while maintaining payroll performance, since large accruals of historical assignment actions and action contexts can degrade the performance of payroll runs, balance feeds, and reporting.

The package is classified under ETRM as an "OTHER" API rather than a public callable interface, indicating it is intended for internal use by the payroll year-end process rather than as a supported extension point. Its dependency graph is minimal: it references only SYS.STANDARD, and it is referenced only by itself, meaning no other documented package depends on it.

Key Procedures and Functions

The documented package exposes four procedures/functions:

  • EOY_RANGE_CURSOR — Establishes the date or identifier range of payroll data eligible for year-end archiving. It defines the boundaries within which assignment actions and related contexts are selected for processing, effectively scoping the archive operation to the appropriate reporting year.
  • EOY_ACTION_CREATION — Creates the payroll action records that represent the archive operation. This ensures the archival is itself auditable and consistent with the payroll action framework, linking the archive to an action classification and its associated interlocks and contexts.
  • EOY_ARCHIVE_DATA — Performs the core archival movement of payroll data. It transfers qualifying records out of the active payroll tables into the archive structures, preserving referential integrity for subsequent year-end and statutory reporting.
  • EOY_ARCHINIT — Initializes the archive run, setting up the execution context, validating prerequisites, and preparing the session before range resolution, action creation, and data movement occur.

Tables Accessed

The package operates across several functional groups of tables accessed through APPS synonyms. Fast Formula and context tables — FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS, FF_DATABASE_ITEMS, FF_FORMULAS_F, and FF_USER_ENTITIES — are used to identify and migrate formula definitions and their context data that are tied to archived payroll results, ensuring formulas remain resolvable after archival. Payroll action tables — PAY_ACTION_CLASSIFICATIONS, PAY_ACTION_CONTEXTS, PAY_ACTION_INTERLOCKS, and PAY_ASSIGNMENT_ACTIONS (with its synonym PAY_ASSIGNMENT_ACTIONS_S) — provide the transactional payload being archived and the action framework used to register the archive run. HR tables — HR_ALL_ORGANIZATION_UNITS, HR_LOCATIONS_ALL, and HR_ORGANIZATION_INFORMATION — supply organizational and location context for the archived records. PAY_BALANCE_FEEDS_F is referenced to maintain the definition of balance feeds associated with archived assignments, so that balances continue to resolve correctly against retained or archived data.

Usage Notes

PAY_CA_EOY_ARCHIVE is not intended for direct invocation by end users. It is typically driven by the Canadian Payroll Year End process, invoked server-side through the year-end concurrent program flow or a related archival wrapper, rather than from a standard form or a customer-developed extension. Because it is classified as an "OTHER" API and is referenced by no other documented package, customizations should avoid binding directly to its procedures; instead, integrate via the supported year-end concurrent programs. In 12.1.1 and 12.2.2 the behavior is consistent, and the package status is VALID. Administrators should invoke archival only after confirming that statutory retention requirements are satisfied and that no dependent payroll processes require the data in active tables.