Search Results pay_gb_retro_upgrade




Overview
Explore in AI Chat

Overview

The APPS.PAY_GB_RETRO_UPGRADE package is a United Kingdom localization utility within the Oracle Payroll (PAY) application. Its stated business purpose, taken from the package header, is to upgrade legislative element definitions so that they are compatible with Enhanced Retropay. Enhanced Retropay is the Oracle EBS payroll feature that recalculates prior period results when a retroactive change occurs, and it depends on specific metadata being present on element definitions — including retro component assignments, span usages, and classification rules. Payroll elements created before Enhanced Retropay was introduced, or elements defined with incomplete retro configuration, cannot participate correctly in retro processing until their definitions are upgraded.

The package header identifies it as source revision 120.0, dated 23-Sep-2005, with the original body derived from an earlier header file (paygbretroupg.pkh, version 115.0, 19-Jul-2005). The copyright notice names Oracle Corporation UK Ltd., Chertsey, England, confirming its UK legislative scope. The package is classified as OTHER in the ETRM API classification, meaning it is an internal upgrade utility rather than a supported public API.

Key Procedures and Functions

  • QUALIFY_ELEMENT — Accepts an object identifier and returns a qualification flag. Its role is to evaluate whether a given payroll element (or related definition object) meets the criteria required for Enhanced Retropay participation, so that UPGRADE_ELEMENT is applied only to elements that require conversion.
  • UPGRADE_ELEMENT — Takes an element type identifier and performs the actual upgrade of that element's definition, establishing the retro components, span usages, and related rules needed by Enhanced Retropay.

Both procedures are declared in the package specification without defaulted or overloaded signatures in the documented source. No functions are exposed. Callers must supply a valid element type identifier or qualification context; the package performs no element lookup of its own at the specification level.

Tables Accessed

The package operates across the core payroll element definition model. It reads and writes PAY_ELEMENT_TYPES_F as the primary element definition table, and consults PAY_ELEMENT_CLASSIFICATIONS, PAY_ELE_CLASSIFICATION_RULES, and PAY_LEGISLATION_RULES to evaluate UK legislative classification. Retro configuration is created in PAY_RETRO_COMPONENTS, PAY_RETRO_COMPONENT_USAGES, and its _S dated-table counterpart. Time-span behaviour is recorded through PAY_ELEMENT_SPAN_USAGES, PAY_ELEMENT_SPAN_USAGES_S, and PAY_TIME_SPANS. Supporting metadata is drawn from PAY_ELEMENT_TYPE_RULES, PAY_LEGISLATIVE_FIELD_INFO, PAY_ELEMENT_SETS, PAY_PAYROLL_ACTIONS, and HR_ORGANIZATION_INFORMATION. The presence of the _S date-tracked tables indicates the upgrade writes effective-dated rows.

Usage Notes

This package is an internal upgrade utility and is not a general-purpose payroll API. It is referenced by no other documented packages, so it is invoked in a standalone manner — typically from a one-off upgrade or patch script executed by a DBA or implementation consultant during the transition to Enhanced Retropay for a UK payroll, or through a related concurrent program or diagnostic. Because it is undocumented for customer use and carries no supported API classification, direct invocation from custom PL/SQL is not recommended; the supported route is to run the Oracle-supplied upgrade process that calls it. A full backup of element definitions is advisable before execution, since the package mutates effective-dated element metadata. The same logic is applicable to both 12.1.1 and 12.2.2 environments, as the referenced tables remain consistent across those releases.