Search Results pay_ip_expiry_support




Overview
Explore in AI Chat

Overview

PAY_IP_EXPIRY_SUPPORT is a PL/SQL package owned by the APPS schema in Oracle E-Business Suite. It is classified as an "OTHER" API, meaning it is not a public, supported extension interface such as an Open Interface or a business API, but an internal utility used by Oracle Payroll processing logic. The package is documented as VALID in both EBS 12.1.1 and 12.2.2 and its metadata is catalogued in the E-Business Suite Technical Reference Manual (ETRM).

The name of the package indicates its role: "IP" refers to Indirect Payroll (involvement processing of payroll elements such as balances and dimensions), and "EXPIRY" refers to the expiry or end-dating mechanisms applied to payroll elements, balance dimensions, and related definition records. In Oracle Payroll, balance dimensions, balance feeds, and element eligibility relationships carry effective start and end dates. The expiry support utility encapsulates the logic that determines whether a given balance dimension or payroll definition record is within its effective date range at a point in time. This supports processing of payroll runs, balance calculations, and retroactive adjustments, where it is essential to know which definition records were active as of a particular effective date.

Key Procedures and Functions

The ETRM metadata for PAY_IP_EXPIRY_SUPPORT documents two callable objects in total. One is a function named DATE_EC, which by naming convention returns an effective-date or end-date check value — typically a date or boolean indicator used to determine whether a record is currently effective or has expired relative to a supplied effective date. The second entry is a package-level construct (private or unrelated to the public interface) and does not expose a documented parameter signature.

Because the package is classified as OTHER and is a private Payroll internal utility, detailed parameter lists are not published. No parameter lists are reproduced here. DATE_EC is invoked by other Payroll code to test expiry conditions; EXTRA_EC and similar internal helpers, where present, remain private to the package body and are not part of any supported interface.

Tables Accessed

The package references four tables through APPS synonyms:

  • HR_ORGANIZATION_INFORMATION — holds the business group and organization-level setup attributes that influence payroll processing scope.
  • PAY_BALANCE_DIMENSIONS — defines the balance dimensions used by Payroll, including their effective dates and expiry behaviour.
  • PAY_PAYROLL_ACTIONS — records payroll run actions; the package uses action context to determine whether a dimension or element is effective for the run being processed.
  • PER_TIME_PERIODS — defines payroll time periods; used to resolve the effective date against the payroll period calendar.

Together these tables allow the package to establish the effective context (business group, payroll, period, and action) against which balance dimension expiry is evaluated.

Usage Notes

PAY_IP_EXPIRY_SUPPORT is not intended for direct invocation from forms, concurrent programs, or customer extensions. It is referenced only within Oracle's own Payroll code, principally by the package PAY_IP_EXPIRY_SUPPORT (body) and the internal payroll processing stack. No other packages are documented as referencing it, confirming its status as a low-level internal helper.

Because the package is a private internal object, customizations should not call DATE_EC or any other member directly. Any custom logic requiring expiry evaluation should instead use supported public Payroll APIs and views, such as those built on PAY_BALANCE_DIMENSIONS and PER_TIME_PERIODS. The package must never be modified; upgrades and patches in 12.1.1 and 12.2.2 may regenerate it without notice.