Search Results hr_entry_api




Overview
Explore in AI Chat

Overview

APPS.HR_ENTRY_API is a server-side PL/SQL package body that provides the programmatic interface for creating, maintaining, and validating Oracle Payroll element entries for assignments. Element entries represent the individual pay and benefit instructions attached to an assignment—such as earnings, deductions, and employer contributions—and are the primary transactional records against which payroll runs are processed. Within Oracle E-Business Suite 12.1.1 and 12.2.2, this package encapsulates the business rules governing element entry creation and maintenance so that forms, concurrent processes, and custom code do not write directly to the underlying Payroll tables.

The package is classified as an API in the ETRM 12.2.2 repository and holds a VALID status in the APPS schema. Its dependency list includes both Payroll and non-Payroll components, notably BEN_BENEFIT_CLASSIFICATIONS and BEN_BENEFIT_CONTRIBUTIONS_F, confirming its role in bridging benefits and payroll element processing. It also depends on formula execution and flexfield infrastructure, including FF_EXEC, FND_FLEX_DSC_API, and HR_DFLEX_UTILITY.

Key Procedures and Functions

The ETRM metadata documents fourteen procedures and functions. The principal entry-maintenance routines are:

  • INSERT_ELEMENT_ENTRY — creates a new element entry for an assignment, applying validation and business rules before the record is written to PAY_ELEMENT_ENTRIES_F.
  • UPDATE_ELEMENT_ENTRY — modifies an existing element entry, maintaining the date-tracked entry values and link contexts.
  • DELETE_ELEMENT_ENTRY — removes or end-dates an element entry, preserving the historical integrity of payroll results.
  • VALIDATE_ENTRY_VALUE — validates a single entry value against the input value definition, formula, or lookup rules associated with the element.
  • GET_LINK — resolves the element link applicable to an assignment, taking eligibility and link criteria into account.
  • SET_FORMULA_CONTEXTS — establishes the formula context values required when a validation or calculation formula is executed for an element entry.
  • CONV_ENTRY_VALUES_TO_TABLE and CONV_TABLE_TO_TABLE — convert entry value data between the internal PL/SQL table structure and the tabular formats used by the API and its callers.

These routines collectively support the complete entry lifecycle, from link resolution through value validation to insert, update, and delete.

Tables Accessed

The package reads and writes the core Payroll element tables through APPS synonyms. PAY_ELEMENT_ENTRIES_F stores the element entry header rows; PAY_ELEMENT_ENTRY_VALUES_F stores the associated entry values; PAY_ELEMENT_LINKS_F and PAY_ELEMENT_TYPES_F supply link and element definition context; and PAY_INPUT_VALUES_F, together with PAY_INPUT_VALUES_PKG and PAY_LINK_INPUT_VALUES_F, provide the input value definitions used during validation. PAY_ELEMENT_CLASSIFICATIONS and PAY_LEGISLATION_RULES drive classification-specific and legislative behavior.

Assignment and assignment-action context is drawn from PER_ALL_ASSIGNMENTS_F, PER_ASSIGNMENTS_F, PAY_ASSIGNMENT_ACTIONS, PAY_ASSIGNMENT_LINK_USAGES_F, and PER_PERIODS_OF_SERVICE. Costing and payment-related tables include PAY_COST_ALLOCATION_KEYFLEX and PAY_PERSONAL_PAYMENT_METHODS_F. Benefits integration relies on BEN_BENEFIT_CLASSIFICATIONS and BEN_BENEFIT_CONTRIBUTIONS_F, while PAY_GROSSUP_BAL_EXCLUSIONS, PAY_QUICKPAY_INCLUSIONS, and PAY_QUICKPAY_EXCLUSIONS support grossup and quickpay processing. Supporting references include HR_COMMENTS, HR_LOOKUPS, FND_SESSIONS, PER_BUSINESS_GROUPS, and PER_TIME_PERIODS.

Usage Notes

HR_ENTRY_API is invoked by the element entry and element entry value forms within the Payroll responsibility, by benefits processing logic, and by custom PL/SQL that must create or amend element entries in a controlled manner. Because element entries participate in date-tracked payroll processing, callers should invoke the API rather than performing direct DML, so that validation, formula context, and audit requirements are honored. The package is referenced by seventy-nine other database objects, indicating widespread internal dependence; changes to its behavior therefore carry broad regression risk. Consistent with standard Oracle EBS API conventions, callers should initialize the session through the appropriate HR_API and FND_SESSIONS routines, supply effective dates explicitly, and check the returned API status and error table before committing. The presence of PAY_RUN_RESULTS and PAY_PAYROLL_ACTIONS in the dependency list also indicates that the API guards against modifying entries already processed by a payroll run.