Search Results get_enable_template_flag

Overview

PAY_CA_ARCHIVE_UTILS is an Oracle EBS Human Resources (Payroll) utility package owned by the APPS schema. It belongs to the Canadian localization layer of Oracle Payroll, a fact reflected in the "CA" segment of its name and in the header script identifier pycaroep.pkh. The package supplies the archive-retrieval logic used by the Oracle Payroll archiving framework, which captures the historical value of configuration and setup data — such as organization definitions, payroll elements, and context-driven database items — at the moment an archive action is executed. Because later statutory or business changes can alter the current value of that configuration, the archiving framework preserves point-in-time snapshots so that retroactive payroll processing, year-end reporting, and audit enquiries return the data that was in force when the original payroll run occurred.

Consistent with the ETRM classification of OTHER, the package is not a public, supported business API. It is an internal helper invoked by the payroll archiving infrastructure rather than by end users or customer-written integration code. The header comment convention (noship) confirms that the unit is supplied as part of the standard Oracle Payroll installation.

Key Procedures and Functions

ETRM documents four callable units, two of which are overloaded variants of the same name:

• GET_ARCHIVE_VALUE (archive action) — Returns the archived value associated with a given archive action identifier and database name. This overload resolves a value keyed by the archive action record.
• GET_ARCHIVE_VALUE (assignment action / context) — Returns the archived value for a specified assignment action, resolved through a supplied context and context name in addition to the database name. This overload supports the finer-grained context model used by database items whose values depend on the assignment action under which they were captured.
• GET_ENABLE_TEMPLATE_FLAG — Returns the flag indicating whether the associated archive template is enabled, allowing the archiving framework to determine whether a given template should participate in value retrieval.

Both overloads of GET_ARCHIVE_VALUE are declared with PRAGMA RESTRICT_REFERENCES(..., WNDS), asserting that the functions write no database state. This purity guarantee permits them to be called safely from SQL and from other PL/SQL constructs where read consistency must be preserved. The documented interface exposes no procedures that modify data.

An older revision of the header (120.0.12000000.1, dated 2007) shows only the two GET_ARCHIVE_VALUE overloads, indicating that GET_ENABLE_TEMPLATE_FLAG was introduced subsequently as the archiving framework evolved.

Tables Accessed

The package reads from the following tables through APPS synonyms:

• FF_ARCHIVE_ITEMS and FF_ARCHIVE_ITEM_CONTEXTS — the core archive definition and context storage from which captured values are retrieved.
• FF_CONTEXTS and FF_DATABASE_ITEMS — define the context and database item metadata that govern how a value is keyed and resolved.
• PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS — payroll action records that anchor the archived values to the payroll processing event.
• PAY_ACTION_INTERLOCKS — action relationship and sequencing data used by the payroll action model.
• DUAL — used for single-row evaluation and default value handling.

All access is read-only, consistent with the WNDS purity assertion.

Usage Notes

PAY_CA_ARCHIVE_UTILS is referenced by 19 other packages in the ETRM inventory, which identifies it as a shared dependency within the payroll archiving subsystem rather than a standalone entry point. It is invoked indirectly when the archiving framework executes archive actions — for example, during payroll run archival, retroactive processing that requires historical setup values, or audit and year-end reporting that must reconstruct the configuration in effect on a prior date.

Because it is an internal utility and not a documented public API, it should not be called directly from customer extensions. Custom code requiring archived payroll configuration values should use the supported archiving interfaces, which in turn delegate to this package. Note also that the object name is unrelated to version-control or licence-utility search terms; it exists strictly to support Oracle Payroll's Canadian localization archiving behaviour in EBS 12.1.1 and 12.2.2.