Search Results calc_max_excl_allow

Overview

PAY_FF_FUNCTIONS is a PL/SQL package in the APPS schema that provides the calculation engine supporting Oracle EBS payroll and benefits processing for U.S. tax-sheltered annuity and deferred compensation plans, specifically 403(b) and 457 arrangements. The package is declared with AUTHID CURRENT_USER, meaning that its SQL statements execute with the privileges of the invoking user rather than the definer, which is consistent with the Oracle EBS convention of granting direct execution rights on payroll calculation APIs. The header revision (pyfffunc.pkh 120.6.12010000.2) confirms that this is a 12.1.1-era artifact carried forward into 12.2.2 without functional change.

Functionally, the package consolidates the annual limit tests and deferral-eligibility rules that payroll administrators must satisfy when an employee contributes to a 403(b) or 457 plan. These include the maximum exclusion allowance, the overall elective deferral limit, the any-year and year-of-separation limits, and catch-up provisions. The presence of GET_TIME_DEFINITION among the documented functions indicates that the package also resolves time definitions from the payroll time definition repository, allowing calculations to be driven by period-based rather than purely monetary attributes.

Key Procedures and Functions

The 19 documented entry points fall into several logical groups:

• Contribution limit calculators — CALC_MAX_EXCL_ALLOW, CALC_OVERALL_LIMIT, CALC_ANY_YEAR_LIMIT, CALC_YEAR_OF_SEP_LIMIT, and CALC_ELEC_DEF_LIMIT each implement one of the statutory ceilings. They accept a payroll action identifier plus compensation and prior-contribution inputs and return the applicable limit amount.
• Service and salary resolution — CALC_LENGTH_OF_SERVICE, GET_ANNUAL_SALARY, GET_SALARY_BASIS_DETAIL, and GET_EARNINGS_CALCULATION derive the service period, annual compensation base, and salary basis used by the limit formulas.
• 457-specific logic — GET_457_ANNUAL_LIMIT, GET_457_CALC_LIMIT, GET_457_VESTED_AMT, and CALC_PREV_UNUSED handle the separate 457(b) annual deferral ceiling, the calculation limit, vested amounts, and carry-forward of unused limits.
• Eligibility and authorization — CHECK_IF_EMP_IN_403B_457_PLAN and CHECK_AUTHORIZATION_DATE verify plan participation and effective authorization dates.
• Supporting utilities — GET_PQP_LIMIT, RUN_YEAR, GET_TEMPLATE_EARNINGS, and GET_TIME_DEFINITION provide the annual context, earnings template resolution, and time definition lookup needed by the calculators.

Tables Accessed

The package reads from a broad set of payroll and benefits tables accessed through APPS synonyms. PAY_TIME_DEFINITIONS is queried directly by GET_TIME_DEFINITION. PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, PAY_ELEMENT_LINKS_F, and PAY_INPUT_VALUES_F supply element and input value metadata used to identify contribution elements. PAY_ELEMENT_ENTRIES_F, PAY_RATES, PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, and PAY_BALANCE_DIMENSIONS provide the calculated balances and rates consumed by the limit formulas, while PAY_ALL_PAYROLLS_F and PAY_US_CONTRIBUTION_HISTORY supply payroll action and historical contribution context. On the benefits side, BEN_PL_REGN_F, BEN_PRTT_ENRT_RSLT_F, and BEN_REGN_F hold plan enrollment and registration data used by the eligibility checks.

Usage Notes

PAY_FF_FUNCTIONS is normally invoked indirectly. Oracle Payroll's fast formula and payroll run architecture call these functions during the calculation of 403(b) and 457 deduction elements, and the package is referenced by one other package in the ETRM catalog. Custom code and element fast formulas may call individual functions through the APPS schema, provided the executing user holds EXECUTE privilege. Because the package is AUTHID CURRENT_USER, any custom caller must have direct grants on the underlying payroll and benefits tables or must run as a user with such grants. The package should not be modified; changes to its calculations must be applied through supported Oracle patches, since altering limit logic directly can produce incorrect year-end reporting and nondiscrimination testing output.