Search Results get_ff_archive_value

Overview

PAY_US_ARCHIVE_UTIL is a utility package in the APPS schema of Oracle E-Business Suite, classified as a UTIL API. Its business purpose is to provide a programmatic means of retrieving values that have been archived by the Oracle Payroll and Oracle HRMS FastFormula archival process. As payroll runs and assignment actions are processed over time, the FastFormula values that were resolved at the moment of processing are written to archive tables rather than retained in the live formula result set. The archival mechanism preserves the historical calculation context so that prior results remain auditable and reproducible even after configuration, balances, or formula definitions change. PAY_US_ARCHIVE_UTIL exposes that archived data to callers that need to reconstruct or report on the values that were in effect at a given processing point.

The package header originated in 2004 and its header record reflects a short but instructive evolution. Version 115.1 (bug 3180532) introduced a function named get_ff_archive_value. Version 115.2 removed that function and relocated it to PAY_US_REPORTING_UTILS_PKG for extract-related reasons, leaving PAY_US_ARCHIVE_UTIL with a single documented entry point, GET_ARCHIVE_VALUE. This history is relevant to users searching for get_ff_archive_value: the identifier is not exposed by PAY_US_ARCHIVE_UTIL in the shipped 12.1.1 / 12.2.2 code and must be located in PAY_US_REPORTING_UTILS_PKG instead.

Key Procedures and Functions

The package exposes one documented function:

• GET_ARCHIVE_VALUE — Returns the archived value associated with a particular action identifier. The action may be either an assignment action or a payroll action, and the caller may optionally restrict the lookup by jurisdiction code as well as by tax unit and user entity. The function returns the archived value as a character string. Its parameters encompass the action identifier, the user entity name, the tax unit, and an optional jurisdiction code; the return is a scalar value suitable for further formatting or reporting by the caller.

The header also declares two PL/SQL types, user_entity_record and user_entity_tabrec, together with a package-level variable of that table type. These support internal caching or lookup of user entity definitions used during archive retrieval.

Tables Accessed

The package reads from several archive and context tables through APPS synonyms:

• FF_ARCHIVE_ITEMS and FF_ARCHIVE_ITEM_CONTEXTS — the core archive stores holding the archived formula item values and the context combinations under which each value was captured.
• FF_CONTEXTS — supplies the context definitions that qualify archived values.
• FF_USER_ENTITIES — identifies the user entity (such as assignment or payroll) against which archived values are keyed.
• PLITBLM — the PL/SQL item table used to pass or resolve item data during value retrieval.

These tables are read-only from the perspective of this utility; the package does not write archive data.

Usage Notes

PAY_US_ARCHIVE_UTIL is an internal utility and is not exposed as a user-facing form or concurrent program. It is invoked by other PL/SQL code, and ETRM records it as referenced by seven other packages in the applications schema. Typical callers are payroll reporting and audit routines that must reproduce the value of a formula item as of a specific assignment action or payroll action, and custom code written to produce regulatory or historical extracts. Jurisdiction-sensitive lookups should pass the jurisdiction code; callers that omit it should expect the function to resolve the value using the remaining qualifiers. Because the package depends on the FastFormula archival tables being populated, callers should ensure that archival has been enabled and that the action in question was processed while archiving was active.