Search Results hr_user_init_earn




Overview
Explore in AI Chat

Overview

APPS.HR_USER_INIT_EARN is a PL/SQL package in the Oracle EBS Payroll (HR/PY) module that supports initialization of user-defined earnings elements and their associated payroll definitions. The package is declared AUTHID CURRENT_USER, meaning that its SQL statements execute with the privileges of the invoking user rather than the package owner, which makes it sensitive to the schema context in which it is called. Its source header (pyusuiet.pkh) traces back to 1993 and carries historical change records documenting fixes for deduction processing, separate-check decoupling, overtime base rate calculation, associated balance handling during deletions, and the introduction of a termination rule parameter.

The package participates in the lifecycle of earnings and deduction element templates. It creates, locks, and removes the underlying configuration rows — element types, input values, formula result rules, balance feeds, and compiled formula references — that must exist before a payroll element can be processed. In practice it is a supporting utility rather than a transactional payroll engine.

Key Procedures and Functions

  • DO_INSERTIONS — Creates the supporting rows required to instantiate a user-defined earnings element. Based on the package comments, the data inserted depends on the selected calculation method, and the procedure is intended to be bundled with related calls so that a logically complete set of element definitions is created in one operation.
  • LOCK_TEMPLATE_ROWS — Acquires locks on template-related rows, added in version 1.1 of the package ("Added in locking and deletion procedures"). Locking protects the template definition from concurrent modification while insertions or deletions are in progress.
  • DO_DELETIONS — Removes the configuration rows previously created for a user-defined earnings element. The change history shows this procedure was revised on 15-JUN-95 to use "associated balance" identifiers when deleting balances, and that it gained new parameters at that time. A later revision added the parameter p_termination_rule and a p_reduce_regular parameter was introduced in 1996. Because deletions cascade across element, input value, balance, and formula metadata, this is the procedure most commonly referenced when developers search for "do_deletions".

Tables Accessed

The package reads and writes the payroll configuration tables exposed through APPS synonyms. Element definition data resides in PAY_ELEMENT_TYPES_F, PAY_ELEMENT_CLASSIFICATIONS, and PAY_ELEMENT_CLASSIFICATIONS-derived lookups. Input value definitions are stored in PAY_INPUT_VALUES_F, while PAY_FORMULA_RESULT_RULES_F and PAY_STATUS_PROCESSING_RULES_F govern how results and statuses are written back during payroll processing. Balance-related activity touches PAY_BALANCE_TYPES, PAY_BALANCE_CLASSIFICATIONS, and PAY_BALANCE_FEEDS_F, consistent with the historical note about deleting balances via associated balance identifiers. Fast Formula definitions and their compiled representations involve FF_FORMULAS_F, FF_FORMULAS_S, FF_COMPILED_INFO_F, and FF_FDI_USAGES_F. Collectively these accesses confirm the package operates on element, formula, and balance metadata rather than on payroll run results.

Usage Notes

HR_USER_INIT_EARN is an internal support package and is not a documented public API. In standard EBS 12.1.1 and 12.2.2 installations it is invoked indirectly by the Payroll element and earnings setup forms — the header references client-side PAYSUDEE.fmb — and by concurrent or batch processes that initialize user-defined earnings. It is also referenced by three other packages within the APPS schema, which call its insertion, locking, and deletion procedures as part of broader element maintenance flows. Custom code should generally avoid calling DO_DELETIONS directly, since removing element metadata without the corresponding form-level validation can leave dangling balance feeds or formula result rules. Where extension is required, the correct approach is to wrap the packaged procedures in a controlled setup script and to respect the same locking order (LOCK_TEMPLATE_ROWS before insertions or deletions) that the product code follows.