Search Results set_retro_leg_rule




Overview
Explore in AI Chat

Overview

PAY_AU_RETRO_UPGRADE is an Oracle Payroll (APPS schema) PL/SQL package that supports the migration of Australian payroll elements to the Enhanced Retropay functionality introduced in Oracle E-Business Suite. Enhanced Retropay restructures how retroactive payroll adjustments are calculated, replacing earlier spanning and retro-processing behaviour with event-group-driven retro definitions and span usages. Because existing Australian legislation elements and configurations predate these enhancements, the package provides a controlled upgrade path that qualifies candidate elements and reconfigures their definitions so that they participate correctly in Enhanced Retropay processing.

The package header carries an Oracle Corporation UK copyright dated 1992, with a change list recording the initial version as 120.0, created 05-JAN-2006 by ksingla. The header comment states explicitly that the procedure is used to upgrade elements for Enhanced Retropay. The documented object is therefore an upgrade/migration utility rather than a runtime payroll calculation engine. In EBS 12.1.1 and 12.2.2 the package is present in the APPS schema and classified as OTHER, indicating it is not part of the standard published HRMS API set.

Key Procedures and Functions

  • QUALIFY_ELEMENT — Evaluates an element (identified by an object identifier) and returns an output value indicating whether that element qualifies for upgrade to Enhanced Retropay. It acts as the gating check before any modification is attempted, allowing callers to identify which Australian elements are candidates for conversion.
  • UPGRADE_ELEMENT — Performs the actual conversion for a single element type. It accepts the element type identifier and applies the configuration changes required for the element to operate under Enhanced Retropay, including the associated rules, span usages and extra information.
  • SET_RETRO_LEG_RULE — Establishes the retro leg rule configuration used by the upgraded element definitions so that retroactive adjustments are processed against the correct legs.
  • CREATE_ENHANCED_RETRO_DEFN — Creates the enhanced retro definition records that Enhanced Retropay requires in order to recognise and process the upgraded elements.
  • SET_ENH_RETRO_REQUEST_GROUP — Associates the enhanced retro definitions with the appropriate request group, enabling the retro processes to be submitted through the correct concurrent request grouping.
  • ENABLE_AU_ENHANCED_RETRO — Enables Enhanced Retropay at the Australian localisation level, switching on the enhanced processing behaviour for the upgraded element population.
  • ENABLE_AU_RETRO_OVERLAP — Enables handling of retroactive overlaps for Australian elements, allowing periods that overlap prior retro calculations to be evaluated correctly.

Tables Accessed

The package operates across the core payroll element configuration model. It reads and writes element definitions and classification data through PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_ELE_CLASSIFICATION_RULES, PAY_ELEMENT_LINKS_F and PAY_ELEMENT_SETS. Spanning and retro behaviour is configured through PAY_ELEMENT_SPAN_USAGES and its _S date-tracked counterpart, together with PAY_DATED_TABLES, PAY_EVENT_GROUPS and PAY_ELEMENT_TYPE_RULES. Rule and formula logic draws on FF_FORMULAS_F and PAY_ELEMENT_TYPE_EXTRA_INFO. Balance and feed configuration is accessed through PAY_BALANCE_TYPES and PAY_BALANCE_FEEDS_F, while HR_ORGANIZATION_INFORMATION supplies organisational context (typically business group or legislation) for the upgrade. All references are resolved through APPS synonyms.

Usage Notes

This package is an upgrade utility and is normally executed as part of the Australian payroll localisation upgrade or patch cycle, not during routine payroll runs. It is not referenced by any other documented package, so it is invoked directly — historically through the HRMS upgrade driver or localisation patch scripts that call QUALIFY_ELEMENT to identify candidates and UPGRADE_ELEMENT to convert each one. Customers implementing Enhanced Retropay in an Australian environment, or migrating from legacy retro processing, may invoke these procedures from a controlled PL/SQL script after backing up element definitions. Because the procedures alter dated element configuration, execution should be restricted to a maintenance window, followed by verification of element span usages, retro definitions and request groups, and must be repeated across any environment refresh where legacy definitions persist.