Search Results pay_archive




Overview
Explore in AI Chat

Overview

APPS.PAY_ARCHIVE is the Oracle Payroll archive processing engine. In Oracle E-Business Suite 12.1.1 and 12.2.2 it supports the payroll archive and purge functionality, the mechanism through which historical payroll results, balance values, action records, and their associated assignment-level data are relocated to archive tables and subsequently removed from the operational tables. The package body is the implementation component of the PAY_ARCHIVE specification and carries a status of VALID in the APPS schema. It operates primarily against Oracle FastFormula and archive infrastructure rather than transactional payroll tables, driving the generation of archive items and the context records needed to reconstitute payroll data after it has been removed from live processing tables.

Functionally, PAY_ARCHIVE serves as the orchestration layer invoked by the archive concurrent processes. It initialises an archive run, resolves archive date and jurisdiction level parameters, processes data in manageable chunks, handles individual employee ranges, and performs clean-up at the end of the run. It is a component of the wider payroll year-end and data retention toolset, and its outputs feed the archive reporting and restoration facilities available to payroll administrators.

Key Procedures and Functions

The ETRM documentation records eight entry points within the package body:

  • ARCH_INITIALISE — establishes the runtime environment for an archive run, seeding the working parameters required by subsequent processing steps.
  • GET_JURSD_LEVEL — determines the jurisdiction level applicable to the archive operation, which governs the granularity at which payroll legislation and archive rules are applied.
  • DEINITIALISE — releases the resources and temporary state created at the start of an archive run.
  • PROCESS_CHUNK — processes a discrete unit of work within the overall archive job, supporting the chunked execution model that allows large payroll volumes to be archived without a single monolithic transaction.
  • PROCESS_EMPLOYEE — handles the archive of an individual employee's payroll data, invoked for each person within the current processing range.
  • SET_DBI_LEVEL — sets the database item (DBI) context level used by FastFormula archive items during processing.
  • REMOVE_REPORT_ACTIONS — removes report-related action records associated with the archived run, cleaning up action and interlock entries once processing is complete.
  • STANDARD_DEINIT — performs the standard de-initialisation sequence used by the archive framework.

Tables Accessed

The package references Oracle FastFormula archive and configuration tables through APPS synonyms: FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEMS_S, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS, FF_DATABASE_ITEMS, FF_FDI_USAGES_F, FF_ROUTES, FF_ROUTE_CONTEXT_USAGES, FF_ROUTE_PARAMETERS, FF_ROUTE_PARAMETER_VALUES, and FF_USER_ENTITIES. These provide the definitions of archiveable items and the routing and context metadata required to evaluate them. Payroll processing tables including PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, PAY_ACTION_INTERLOCKS, PAY_BALANCE_TYPES, and PAY_DEFINED_BALANCES supply the action and balance definitions that the archive routines operate against. PAY_TEMP_OBJECT_ACTIONS, PAY_MESSAGE_LINES, PAY_POPULATION_RANGES, PAY_MAGNETIC_BLOCKS, PAY_MAGNETIC_RECORDS, PAY_REPORT_FORMAT_MAPPINGS, and PAY_REPORT_FORMAT_MAPPINGS_F support temporary object handling, population range selection, messaging, and report formatting during the run. PER_BUSINESS_GROUPS provides the business group context, and HR_UTILITY supplies shared HR utility routines.

Usage Notes

PAY_ARCHIVE is not a public application programming interface and is not documented for direct invocation by custom code. It is driven by the standard Oracle Payroll archive and purge concurrent programs, which call the package's initialise, chunk-processing, employee-processing, and de-initialise routines in sequence. The package is referenced by 24 other database objects, reflecting its role as an internal dependency of the payroll archive and purge framework rather than an entry point. Implementers customising archive behaviour should extend the underlying FastFormula archive item definitions and routes rather than modifying the package body. Because the package body is VALID but the object is classified as OTHER, it should be treated as an internal Oracle-owned implementation component; direct calls risk incompatibility with patches and are not supported.