Search Results hr_hierarchy_element_api




Overview
Explore in AI Chat

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

Overview

The APPS.HR_HIERARCHY_ELEMENT_API package is a public Oracle E-Business Suite application programming interface that manages the individual elements that make up organization hierarchies in Oracle Human Resources. In Oracle EBS 12.1.1 and 12.2.2, organization hierarchies are stored as org structure versions, and each version is composed of one or more hierarchy elements. The HR_HIERARCHY_ELEMENT_API package provides the supported, business-rule-validating entry point for creating, maintaining, and removing those individual hierarchy elements.

The package is classified as an API within the APPS schema and is documented as VALID in ETRM. It exists so that callers do not have to insert, update, or delete rows in the underlying organization structure tables directly, which would bypass validation logic, date-effectivity handling, and security. The package depends on the shared HR_API library and on the SYS.STANDARD package, indicating that it leverages common HR API infrastructure such as error handling and the standard HR API return conventions.

Key Procedures and Functions

ETRM documents five procedures/functions in total, of which the following three are identified by name:

  • CREATE_HIERARCHY_ELEMENT — Creates a new hierarchy element within an organization structure version. This is the primary entry point used when adding an organization to a hierarchy definition.
  • UPDATE_HIERARCHY_ELEMENT — Modifies an existing hierarchy element, allowing attributes of an already-defined element to be changed while preserving the integrity of the parent hierarchy version.
  • DELETE_HIERARCHY_ELEMENT — Removes an existing hierarchy element from its parent organization structure version.

All three procedures operate on a single hierarchy element at a time. Parameter lists are not reproduced here; callers should reference the package specification in the EBS instance for exact signatures, as these follow standard HR API conventions (including an p_validate flag and p_effective_date where applicable).

Tables Accessed

The package reads and writes the following tables through APPS synonyms:

  • PER_ORG_STRUCTURE_ELEMENTS — The primary table holding each hierarchy element (organization) belonging to an org structure version. Create, update, and delete operations target this table.
  • PER_ORG_STRUCTURE_VERSIONS — The parent table that defines a dated version of an organization hierarchy. The API validates element operations against the appropriate version.
  • PER_SECURITY_PROFILES — Referenced for security and access validation, ensuring that hierarchy element operations respect the security profile context of the calling session.

Usage Notes

HR_HIERARCHY_ELEMENT_API is referenced by four other packages: HRDPP_CREATE_HIERARCHY_ELEMENT, HR_HIERARCHY_ELEMENT_INTERNAL, HR_HIERARCHY_ELEMENT_SWI, and PER_ORG_STRUCTURE_VERSION_API. This dependency pattern shows that the API is invoked both by higher-level hierarchy processing and by the internal/self-service wrapper layers that surround it.

Typical invocations occur when organization hierarchies are defined or maintained, whether through the standard Oracle HR forms, concurrent processes that build hierarchies from descriptive flexfield or HR data (HRDPP_CREATE_HIERARCHY_ELEMENT), or custom PL/SQL that programmatically adds organizations to a hierarchy version. Custom code should always call this API rather than writing to PER_ORG_STRUCTURE_ELEMENTS directly, because the API enforces date-effectivity, security profile validation, and referential integrity against the parent version. Because the package relies on HR_API, callers should also follow standard HR API commit and error-checking practices.