Search Results upgrade_element

Overview

APPS.PAY_GB_ENH_RETRO_PAY is a PL/SQL package that supports the United Kingdom (GB) legislation's enhanced retroactive pay functionality within Oracle E-Business Suite Release 12.1.1 and 12.2.2. Its principal purpose is to manage the migration, qualification, and upgrading of payroll elements and element sets so that they can participate in the enhanced retroactive pay processing model introduced in the GB localization. The package is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking schema rather than the defining owner, which is typical for upgrade and administrative utilities invoked from a controlled context. The header comments indicate the package is marked noship, confirming it is an internal upgrade and configuration utility rather than a shipping runtime API intended for general customer development use.

Key Procedures and Functions

The package exposes five documented procedures and functions, which together form an element conversion and retroactive-component setup toolset:

• MIGRATE_ELEMENT_SET — Drives the migration of element set definitions so that existing element sets are brought into line with the enhanced retroactive pay data model.
• QUALIFY_ELEMENT — A function that evaluates an object (identified by a generic object id) and returns a Boolean indicating whether that element qualifies for enhanced retroactive pay treatment. This is the qualification gate that determines whether an element is eligible for upgrading.
• UPGRADE_ELEMENT — Performs the upgrade of a specific element type, identified by its element type id, to the enhanced retroactive pay structure once it has been qualified.
• INSERT_RETRO_COMP_USAGES — Creates retroactive component usage records for a given business group, legislation, and retroactive component, returning the newly created usage id as an OUT parameter. Creator id is captured for audit purposes.
• INSERT_ELEMENT_SPAN_USAGES — Creates the element span usage records that link a retroactive element type to a time span and an existing retroactive component usage.

Tables Accessed

The package reads from and writes to a focused set of payroll and HR tables, accessed through APPS synonyms. Element definition and classification data are drawn from PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_ELE_CLASSIFICATION_RULES, and PAY_ELEMENT_TYPE_RULES. Element set and span configuration is handled through PAY_ELEMENT_SETS, PAY_ELEMENT_SPAN_USAGES, and PAY_ELEMENT_SPAN_USAGES_S. Retroactive component configuration is stored in and retrieved from PAY_RETRO_COMPONENTS and PAY_RETRO_COMPONENT_USAGES (with the _S intersection table for usage detail). Time span definitions come from PAY_TIME_SPANS; payroll action context is sourced from PAY_PAYROLL_ACTIONS; and business group/organization context is obtained via HR_ORGANIZATION_INFORMATION. Upgrade bookkeeping is tracked in PAY_UPGRADE_DEFINITIONS and PAY_UPGRADE_STATUS, which record which elements have been processed and their current upgrade state.

Usage Notes

Because this package is documented as an OTHER-classification, non-shipping utility with no dependent packages (referenced by 0 other packages), it is not exposed as a standard public API. In practice it is invoked during the GB enhanced retroactive pay enablement and upgrade cycle, typically from concurrent programs or one-time scripts executed by the APPS schema during localization patch application. The QUALIFY_ELEMENT function is the natural entry point for interrogation logic, allowing callers to test individual elements for eligibility before running UPGRADE_ELEMENT. Custom development should not call these procedures directly; upgrades are normally driven through Oracle-supplied concurrent programs and the PAY_UPGRADE_DEFINITIONS/PAY_UPGRADE_STATUS framework. Any direct invocation should be performed in a controlled maintenance window with a validated backup, as the procedures mutate core payroll element definitions.