Results for “get_processing_element”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PAY_US_ITERATIVE_VALUES is a United States payroll helper package in Oracle E-Business Suite that supports iterative deduction processing during the payroll run. Its central purpose is to manage the repeated recalculation of certain US deductions — including retirement savings elements classified under the 401, 403 and 457 sections — until a stable, valid result is reached. Many of these deductions are subject to regulatory limits, such as maximum annual contribution thresholds, disposable income restrictions, and rules governing partial deductions. Because the correct deduction amount often depends on the results of other deductions calculated in the same run, the payroll engine must iterate: recalculating taxable balances, reapplying limits, and re-checking constraints until the amounts converge or a terminating condition is met.

The package is declared AUTHID CURRENT_USER and is owned by APPS. It exposes 18 documented procedures and functions that maintain the transient state required for this iteration. Rather than persisting all state to database tables, the package holds several PL/SQL associative arrays and record types in package-level variables (for example iter_val, iter_stop, iter_ele_type, iter_ins, and iter_amt). These structures cache per-entry iterative values, stopper flags, processing element types, inserted flags, and calculated versus passed amounts. The header reference dates to 2009 (pyusifun.pkh), reflecting long-standing behaviour carried forward into EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

• GET_STOPPER_FLAG — Returns the stopper flag stored for a given entry, indicating whether iterative processing for that payroll entry should halt.
• SET_STOPPER_FLAG — Records the stopper flag for a given entry and assignment, controlling whether further iterations proceed.
• GET_ITERATIVE_VALUE / SET_ITERATIVE_VALUE — Retrieve and store the current iterative deduction value for an entry and iteration, returning maximum and minimum deduction bounds.
• CLEAR_ITERATIVE_VALUE / CLEAR_ON_ASG — Remove cached iterative values globally or for a specific assignment, resetting state between runs.
• GET_ITER_COUNT / INC_ITER_COUNT — Read and increment the iteration counter used to bound the number of passes.
• ITERATIVE_ARREARAGE — Determines the arrears amount to apply when iterative deductions are processed.
• REDUCES_DISPOSABLE_INCOME — Identifies whether an element reduces disposable income, a key test for partial-deduction eligibility.
• PARTIAL_DEDUCTION_ALLOWED — Indicates whether a deduction may be taken partially given disposable income constraints.
• SET_PROCESSING_ELEMENT / GET_PROCESSING_ELEMENT — Track which element (including pretax elements) is currently being processed.
• SET_INSERTED_FLAG / GET_INSERTED_FLAG — Manage the inserted flag that records whether an entry has already been written.
• GET_ITER_AMT / SET_ITER_AMT — Store and retrieve calculated and passed amounts used by the 401, 403 and 457 element logic.
• CLEAR_ITER_INS — Clears the inserted-flag cache.

Tables Accessed

The package reads and writes payroll and HR data to support its calculations. PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F hold the entry-level results being iterated, while PAY_INPUT_VALUES_F, PAY_ELEMENT_TYPES_F, PAY_ELEMENT_LINKS_F and PAY_ELEMENT_CLASSIFICATIONS define element and input behaviour. PAY_BALANCE_TYPES supplies balance definitions used to evaluate disposable income and limits. PAY_TAXABILITY_RULES and PAY_TAXABILITY_RULES_DATES drive taxability determinations for pretax treatment, and HR_SOFT_CODING_KEYFLEX and PAY_US_STATES provide US-specific coding and jurisdiction context. PER_ALL_ASSIGNMENTS_F and PAY_ASSIGNMENT_ACTIONS resolve assignment and action context, and PLITBLM is the standard payroll PL/SQL table for balances.

Usage Notes

PAY_US_ITERATIVE_VALUES is invoked indirectly by the payroll run and its supporting calculation logic rather than by end users. It is called from PL/SQL routines that evaluate US retirement and iterative deductions, where GET_STOPPER_FLAG and SET_STOPPER_FLAG are the central control points for deciding whether another pass is required. The package holds no persistent state of its own; its package-level tables must therefore be cleared (via CLEAR_ITERATIVE_VALUE, CLEAR_ON_ASG and CLEAR_ITER_INS) between processing cycles to avoid stale values. The ETRM metadata records no other packages referencing it directly, so integrations should treat it as an internal engine helper. Customisations that extend iterative deduction behaviour should call the documented functions only, since internal structures may change across EBS releases.