Search Results hr_calendar_entry_api




Overview
Explore in AI Chat

Overview

The APPS.HR_CALENDAR_ENTRY_API package is a public PL/SQL API within the Oracle E-Business Suite Human Resources (HR) module. It serves as the supported programmatic interface for creating, modifying, and removing calendar entries within the Oracle HRMS calendar framework. Calendar entries represent dated events defined against a calendar — such as public holidays, organisation-specific closures, or other defined working and non-working periods — which are subsequently consumed by scheduling, absence management, and payroll-related date calculations.

As a documented API in the ETRM repository for 12.1.1 and 12.2.2, the package is classified with an API designation, confirming that it is intended for external invocation by forms, concurrent programs, and custom extensions rather than being an internal-only utility. Its business-critical role is to enforce the business rules, validation logic, date-effectivity handling, and multi-tenant security (Business Group and legislative context) associated with the underlying PER_CALENDAR_ENTRIES entity, thereby insulating callers from direct data manipulation.

Key Procedures and Functions

The package exposes three documented procedures, together forming a complete maintenance interface for calendar entry records:

  • CREATE_CALENDAR_ENTRY — Inserts a new calendar entry. This procedure validates the supplied calendar, date, and associated qualifying criteria, then persists a new entry in the underlying calendar entry tables.
  • UPDATE_CALENDAR_ENTRY — Modifies an existing calendar entry. It applies changes to the entry attributes while respecting the API's validation and date-tracking rules.
  • DELETE_CALENDAR_ENTRY — Removes an existing calendar entry. This procedure manages the logical removal of the record in accordance with the date-tracked data model used by Oracle HRMS.

These three procedures constitute the full documented surface of the package; no additional public functions are documented in the ETRM metadata. Callers should invoke them rather than performing direct DML, ensuring that validation and audit columns are correctly populated.

Tables Accessed

The package operates against two documented tables, accessed through APPS synonyms:

  • PER_CALENDAR_ENTRIES — The primary table storing the calendar entry header information, including the parent calendar reference, the entry date, and related descriptive attributes. This is the principal target of the CREATE, UPDATE, and DELETE operations.
  • PER_CAL_ENTRY_VALUES — The detail table holding the individual values or attributes associated with each calendar entry. The API maintains these child rows in step with the parent entry to preserve data integrity across the entry-value relationship.

Because the data model is date-tracked, the package manages effective dates and audit columns on both tables as part of its standard processing.

Usage Notes

The package is referenced by the HR_CALENDAR_ENTRY_SWI package (the server-side web interface wrapper), which is the typical entry point when calendar entries are maintained from the standard Oracle HRMS forms or from web-based self-service pages. Custom code should generally call HR_CALENDAR_ENTRY_API directly through the APPS schema, supplying the appropriate Business Group and session context (such as FND_GLOBAL settings) so that security and validation rules resolve correctly.

Because the package depends on HR_API and SYS.STANDARD, callers must ensure that standard HR API error handling is observed — errors are typically raised and must be trapped by the calling program. Typical invocations include: HRMS forms for calendar administration; concurrent programs or batch interfaces that load holiday and closure calendars; and custom PL/SQL integrations that synchronise external scheduling systems with Oracle HR calendars. Direct inserts or updates to PER_CALENDAR_ENTRIES and PER_CAL_ENTRY_VALUES are not supported and should be avoided in favour of this API.