Search Results purge_old_data




Overview
Explore in AI Chat

Overview

APPS.PAY_IP_EMPLOYEE_BALANCES is a PL/SQL package in Oracle E-Business Suite Payroll (PAY) that supports the Employee Balances self-service page. As documented in the ETRM metadata and the package header, it is used by the Employee Balances SS Page and the Employee Balances form to retrieve earning and deduction balance values for employees. The package populates PL/SQL tables with balance values for different earnings and non-tax deduction elements, and those tables are then passed back to the calling form or page for display.

The package is declared with AUTHID CURRENT_USER, meaning that its SQL statements execute with the privileges of the invoking user rather than the package owner. Its source header records creation in January 2012 (version 120.0), addition of a new function definition for VALIDATE_ASSIGNMENT in March 2012 (version 120.1, Bug 13827477), and removal of unnecessary columns in the PL/SQL tables in April 2012 (version 120.2, Bug 13902938). The final header revision recorded is 120.2.12020000.1, dated 29-Aug-2012. Functionally, the package is a read-oriented data provider for balance inquiry, not a payroll processing engine. It is classified under API classification OTHER and is not referenced by any other package in the documented metadata.

Key Procedures and Functions

  • PURGE_OLD_DATA — The procedure most directly relevant to the user search term "purge_old_data." It clears or removes stale balance data held by the package, typically the contents of the PL/SQL tables populated by POPULATE_ELEMENT_INFO, so that subsequent invocations begin from a clean state and do not display or re-use previously cached balance values.
  • VALIDATE_ASSIGNMENT — Added in version 120.1 (Bug 13827477). It validates the assignment supplied by the caller before balances are retrieved, ensuring that the package is invoked against a legitimate employee assignment.
  • POPULATE_ELEMENT_INFO — Fetches balance values for earnings and non-tax deduction elements and populates the PL/SQL table that is passed to the Employee Balances form or self-service page. This is the core data retrieval routine described in the package header.

Specific parameter lists are not documented in the metadata provided and are therefore not reproduced here.

Tables Accessed

The package references the following tables through APPS synonyms:

These tables supply the element definitions, balance definitions, assignment context, and payroll run results from which the package derives earnings and deduction balance figures for display on the Employee Balances page.

Usage Notes

PAY_IP_EMPLOYEE_BALANCES is invoked in the context of the Employee Balances self-service page and the corresponding form, acting as the server-side data provider. PURGE_OLD_DATA is typically called before or after a retrieval cycle to clear previously populated PL/SQL table contents, while VALIDATE_ASSIGNMENT is used to confirm the assignment context. Because the package is classified as OTHER and is not referenced by any other package, it is not intended as a general-purpose integration API. Oracle EBS 12.1.1 and 12.2.2 deployments should treat it as an internal component supporting the delivered Employee Balances UI. Custom code should avoid direct invocation on this package, and changes to its behavior should be confined to Oracle-provided patches, which are identified in the header by bug numbers 13827477 and 13902938.