Search Results hr_employee_api




Overview
Explore in AI Chat

Overview

HR_EMPLOYEE_API is the principal Oracle HRMS PL/SQL application programming interface for the creation, hiring, and rehire of employee records in the PER schema. The package body resides in the APPS schema and is classified as a public API. Its core business function is to centralize the logic required to build a complete employee record — a person row, a period of service, a primary assignment, and the associated person type usages — while enforcing the validation, date-tracked (datetrack) integrity, and security rules that govern Oracle HRMS. The package is foundational to Oracle EBS 12.1.1 and 12.2.2 because hiring is a prerequisite for nearly all downstream HR, payroll, and benefits processing. Its role as a shared service is confirmed by the dependency metadata: HR_EMPLOYEE_API is referenced by 50 other packages, making it one of the most widely consumed HR APIs in the E-Business Suite. The package name follows the HRMS product family naming conventions, and unlike the pervasive _API signature that exposes a single business entity operation, HR_EMPLOYEE_API exposes a family of related hire and rehire entry points plus internal business logic blocks (HR_EMPLOYEE_BK1 through HR_EMPLOYEE_BK4) that encapsulate the processing steps.

Key Procedures and Functions

The documented interface contains 13 procedures and functions. Their purposes are as follows:

  • CREATE_EMPLOYEE — The generic employee creation routine, used where no country-specific hire processing is required. It accepts person, assignment, and period-of-service details and delegates to the appropriate business logic blocks.
  • CREATE_GB_EMPLOYEE — The United Kingdom localized hire routine. It applies UK legislation rules and validations to the creation of an employee, including country-specific person and assignment attributes.
  • CREATE_US_EMPLOYEE — The United States localized hire routine, applying US-specific validations and defaults during employee creation.
  • RE_HIRE_EX_EMPLOYEE — Rehires a person who previously held an employee relationship that has since been terminated. It manages the supersession of the ex-employee record and creates a new period of service and assignment.
  • APPLY_FOR_INTERNAL_VACANCY — Records an application by an existing employee against an internal vacancy, creating the relevant PER_APPLICATIONS row and any associated applicant record.
  • HIRE_INTO_JOB — Creates an employee and places the person directly into a specified job, driving the assignment creation path rather than the generic hire path.
  • MANAGE_REHIRE_PRIMARY_ASGS — A helper procedure that manages primary assignment status during a rehire, ensuring reference-count and datetrack consistency across the person's assignment records.

Tables Accessed

The package reads and writes the core Oracle HRMS person and assignment tables. PER_ALL_PEOPLE_F and PER_ALL_ASSIGNMENTS_F are the primary datetracked tables for employee person rows and assignments respectively. PER_PERSON_TYPES, PER_PERSON_TYPE_USAGES_F, and the person type usage internal logic store the classification of the person (for example, Employee, Applicant, Ex-Employee). PER_PERIODS_OF_SERVICE (via PER_PERIODS_OF_SERVICE_PKG_V2) records the employee's continuous service relationship and is essential to rehire and termination logic. PER_ASSIGNMENT_STATUS_TYPES supplies valid assignment statuses, and PER_APPLICATIONS stores internal vacancy applications. PER_PHONES and HR_PHONE_API persist phone contact details captured during hire. PAY_PEOPLE_GROUPS and PAY_LEGISLATION_RULES resolve payroll group membership and legislation-specific validation rules. FND_SESSIONS provides session context (effective date, business group, security profile), which is central to HR datetrack and security processing.

Usage Notes

HR_EMPLOYEE_API is normally invoked indirectly rather than by end users. The Oracle Forms-based "Enter and Maintain" person form (PERWSEMP) and the professional-user "People" forms call the API through shared HRMS libraries to save new person and assignment records. Concurrent programs that mass-load or migrate employees, such as the Oracle HRMS dataload or open-interface processes, wrap the API in batch. Because it is a public, supported API, custom integrations and third-party interfaces should call HR_EMPLOYEE_API rather than performing direct DML against PER_ALL_PEOPLE_F or PER_ALL_ASSIGNMENTS_F, ensuring that datetrack, person type usage, and payroll group derivation remain consistent. The API must be invoked with an APPS session context so that FND_SESSIONS, HR_SECURITY, and legislation rules resolve correctly; the presence of HR_SECURITY_INTERNAL and HR_API in the dependency list confirms that business group security and row-level security checks are applied during processing. Callers passing the wrong effective date or an unpopulated business group can expect the standard HR_API error stack to be raised. As HR_EMPLOYEE_API is referenced by 50 other packages, modifications to its behavior propagate widely, reinforcing its central position in the Oracle HRMS hire and rehire architecture across releases 12.1.1 and 12.2.2.