Search Results hr_in_location_api




Overview
Explore in AI Chat

Overview

HR_IN_LOCATION_API is a public PL/SQL API package owned by the APPS schema in Oracle E-Business Suite. It provides the supported programmatic interface for creating and maintaining location records within the Human Resources (HR) module of Oracle EBS 12.1.1 and 12.2.2. Location records are foundational HR entities that describe physical work sites — addresses, geographic identifiers, and associated descriptive attributes — used throughout Oracle HRMS by employees, organizations, business groups, and payroll processing.

The package is classified in ETRM as an API object and holds a VALID status. Its documented dependencies include the APPS.HR_API package, which supplies common HR API utilities such as validation, date-handling, and message routines, and the SYS.STANDARD package. HR_IN_LOCATION_API is referenced by two other packages: HRDPP_CREATE_IN_LOCATION and HRDPP_UPDATE_IN_LOCATION, both of which act as dependent wrappers or data-pump style handlers for the same operations. This layered dependency structure confirms that HR_IN_LOCATION_API is intended to be the single point of access for inserting and updating location data, with higher-level routines delegating to it.

Key Procedures and Functions

The ETRM metadata documents two callable programs within this package:

  • CREATE_IN_LOCATION — Creates a new location record in the HR location tables. It accepts caller-supplied location attributes, performs standard HR validation and business rule enforcement, and inserts the validated record.
  • UPDATE_IN_LOCATION — Modifies an existing location record. It accepts identification of the target location plus the attributes to be amended, applies validation, and updates the record in place.

Parameter lists are not enumerated in the provided documentation and are therefore not reproduced here. Both routines are invoked through the standard HR API pattern, meaning callers should expect mandatory business group context, effective dating semantics, and an output parameter structure for returning status and error information to the calling program.

Tables Accessed

The supplied ETRM excerpt does not enumerate specific tables accessed directly by HR_IN_LOCATION_API; the documented table reference list is empty. The package does, however, reference the APPS.HR_API package, which is the shared HR API library that encapsulates much of the underlying DML against HR tables. By convention within Oracle HRMS, location maintenance through this API ultimately touches the core HR location table and its associated address and geography structures, with HR_API handling validation against those reference entities. Because the metadata does not confirm individual table names, direct table access should be regarded as indirect and performed largely via the HR_API dependency rather than through explicit statements declared in the package metadata.

Usage Notes

HR_IN_LOCATION_API is a server-side API and is not an end-user interface. It is typically invoked from:

  • Custom PL/SQL programs and concurrent programs that must create or update HR locations as part of a larger data load or integration.
  • The dependent packages HRDPP_CREATE_IN_LOCATION and HRDPP_UPDATE_IN_LOCATION, which drive the same operations in a data pump or bulk-processing context.
  • Migrated or wrapped logic where a calling application requires location maintenance without direct DML against HR tables.

Direct INSERT or UPDATE statements against HR location tables are strongly discouraged because they bypass the validation, effective dating, and business group security logic enforced by the API. The presence of the HRDPP dependencies further indicates that Oracle's own data pump routines rely on this package, reinforcing it as the supported entry point for location creation and maintenance across releases 12.1.1 and 12.2.2. Any custom invocation should commit only after checking the error status returned by the API.