Search Results pay_retro_utils_pkg




Overview
Explore in AI Chat

Overview

PAY_RETRO_UTILS_PKG is a utility package in the Oracle EBS Payroll (PAY) application, owned by the APPS schema. It provides shared helper logic used across the retroactive pay processing subsystem. Retroactive pay (retropay) recalculates prior payroll results when an element entry, rate, or assignment change is backdated, and the resulting adjustments must be applied to the correct periods, assignments, and elements. This package centralizes the low-level tasks that support that recalculation — resolving component identifiers, testing whether retropay is scheduled, inserting retroactive entries into the working tables, and creating or maintaining the retroactive assignment records that drive the retro processing engine.

In the 12.2.2 metadata the package is classified as API classification OTHER, status VALID, and is referenced by three other payroll packages: PAY_RETRO_NOTIF_PKG, PAY_RETRO_PKG, and PAY_RETRO_STATUS_INTERNAL, as well as by itself. Its only external dependency is the SYS.STANDARD package. This places it squarely in the retro processing call stack rather than being an entry-point API in its own right.

Key Procedures and Functions

Eight documented procedures/functions are exposed:

  • GET_USER — resolves the current application user identity, typically used to stamp audit columns or to seed processing context in retro transactions.
  • IS_RETROPAY_SCHEDULED — returns a status indicator reporting whether a retropay run is currently scheduled or in progress, allowing callers to short-circuit unnecessary work.
  • CC_REQD — determines whether a cost-collection (or equivalent "CC") step is required for the retro context being evaluated.
  • CC_PERFORM — executes the associated processing action when CC_REQD indicates it is needed.
  • RETRO_ENT_TAB_INSERT — inserts rows into the retroactive entries collection, feeding the temporary results table used by the retro calculation engine.
  • CREATE_SUPER_RETRO_ASG — creates the "super" retroactive assignment record that groups or represents a retroactive assignment for processing purposes.
  • MAINTAIN_RETRO_ASG — inserts, updates, or otherwise maintains retroactive assignment rows in the persistent retro assignment tables.
  • GET_RETRO_COMPONENT_ID — resolves the surrogate key (component ID) for a retro component, used to link retro entries and usages back to their defining component.

Tables Accessed

Access is via APPS synonyms. The principal payroll tables are:

Usage Notes

PAY_RETRO_UTILS_PKG is not normally invoked by end users. It is called internally by the retro processing stack — notably PAY_RETRO_PKG, PAY_RETRO_NOTIF_PKG, and PAY_RETRO_STATUS_INTERNAL — during retropay submission, recalculation, and notification. In 12.1.1 and 12.2.2 the retropay flow is driven by concurrent programs (for example, the Retropay and Retropay Enhanced processes) and by the assignment-level retro actions invoked from payroll forms. Custom code should treat these procedures as internal utilities and avoid direct reliance on them, since the supported extension points for retro behavior are the element/component configuration and the supported payroll APIs rather than this utility package.