Search Results create_archive_dbi

Overview

PAY_ARCHIVE_UTILS is an Oracle Payroll utility package owned by the APPS schema and declared with AUTHID CURRENT_USER. Its documented purpose is to create Database Items (DBIs) within the Oracle Fast Formula framework so that payroll data can be extracted, evaluated, and archived. Database Items are the named data elements that Fast Formula uses to read values from underlying tables; the archive utilities package programmatically generates those items and binds them to routes, contexts, and parameters used during payroll archive and purge processing. The package is classified as OTHER in the ETRM API classification, meaning it is not a public, supported business API but an internal technical utility invoked by product code.

The header comment (pyarcutl.pkh 115.1, dated 2001) indicates the package has been stable since the early Oracle HRMS/Payroll releases and is carried forward into 12.1.1 and 12.2.2 without structural change.

Key Procedures and Functions

The package exposes two overloaded versions of a single documented procedure, CREATE_ARCHIVE_DBI. Both overloads register archive-related Database Items and their supporting metadata; they differ in how the target DBI is identified.

• CREATE_ARCHIVE_DBI (route-based overload) — Creates a DBI identified by a live DBI name, with optional archive route name and optional secondary context name. This form is used when the DBI must be associated with a named archive route and, where applicable, an additional context dimension.
• CREATE_ARCHIVE_DBI (extract-item overload) — Creates a DBI identified by an extract item name together with a route identifier, data type, and legislation code, and with flags controlling whether null values and not-found results are permitted. This form targets legislation-specific extract items and gives the caller explicit control over data typing and null/not-found handling.

Because both signatures share the procedure name, callers must supply arguments that unambiguously match one overload. No other procedures or functions are documented for this package.

Tables Accessed

The package reads and writes the Fast Formula configuration tables that define Database Items, routes, and contexts:

• FF_DATABASE_ITEMS — the repository of Database Item definitions created or validated by the procedure.
• FF_CONTEXTS — context definitions that scope a DBI, referenced when a secondary context name is supplied.
• FF_ROUTES, FF_ROUTES_S — archive route definitions and their translated/secure rows.
• FF_ROUTE_CONTEXT_USAGES — links routes to the contexts in which they participate.
• FF_ROUTE_PARAMETERS, FF_ROUTE_PARAMETERS_S, FF_ROUTE_PARAMETER_VALUES — route parameter definitions, secure rows, and parameter values bound to the created DBI.
• FF_USER_ENTITIES, FF_USER_ENTITIES_S — user entity definitions required to make the DBI visible to Fast Formula.
• DUAL — used for single-row queries and validity checks.

All access is through APPS synonyms, consistent with the package's AUTHID CURRENT_USER declaration and its role inside the APPS processing stack.

Usage Notes

PAY_ARCHIVE_UTILS is not a general-purpose integration API. It is invoked by Oracle Payroll archive and extract setup logic when a Database Item must be created for an archive route rather than maintained manually through the Fast Formula DBI form. Typical invocation paths are Payroll archive configuration forms and concurrent programs that prepare legislation-specific extract items prior to an archive or purge run.

Custom code should call this package only when replicating that setup behavior, and always after the target route, context, and user entity already exist, since the procedure binds the DBI to those existing definitions. ETRM records zero packages referencing PAY_ARCHIVE_UTILS, confirming there are no supported downstream dependents. Environments upgrading from 12.1.1 to 12.2.2 retain the same two-overload interface; the package header has not changed. Because the API classification is OTHER, Oracle Support treats defects here as internal product code rather than a published interface.