Search Results hr_comm_api




Overview
Explore in AI Chat

Overview

HR_COMM_API is a PL/SQL package body owned by the APPS schema in Oracle E-Business Suite releases 12.1.1 and 12.2.2. It is classified in the ETRM repository as an API, and its object status is VALID. The package encapsulates the business logic required to create, maintain, and remove comment records associated with Human Resources entities. Comments in Oracle HRMS provide free-text annotations that can be attached to persons, assignments, and other HR objects, and HR_COMM_API centralizes the data manipulation logic so that direct inserts, updates, and deletes against the underlying comment tables are avoided. By exposing a controlled interface, the API enforces the standard HRMS API conventions—such as row locking, validation, and coordination with audit or date-tracked storage—that would otherwise have to be reimplemented by every calling module.

Key Procedures and Functions

The documented metadata lists four procedures or functions, plus a locking routine, for a total of seven entries. Their names follow the standard HRMS API naming convention, and each serves a distinct operation against the comment data:

  • LCK — The locking procedure. It acquires a row-level lock on the target comment record so that a subsequent update or delete can proceed without contention from concurrent sessions. Locking is a prerequisite step in the HRMS API pattern, ensuring that the caller reads and modifies a stable version of the row.
  • INS — The insert procedure. It creates a new comment row, populating the mandatory columns and performing the validation and derivations expected of the comments entity before the record is committed.
  • UPD — The update procedure. It modifies the attributes of an existing comment record after the row has been locked, applying the same validation and consistency rules as insertion.
  • DEL — The delete procedure. It removes a comment record, typically after the caller has performed the lock step, respecting the referential and business rules that govern comment removal.

Because the ETRM excerpt documents only the procedure names and not their parameter signatures, parameter lists are intentionally not reproduced here; callers should reference the package specification in the APPS schema for the authoritative interface.

Tables Accessed

The package references two application tables through APPS synonyms: HR_COMMENTS and HR_COMMENTS_S. HR_COMMENTS holds the primary comment data, and the insert, update, delete, and lock operations all act upon it. HR_COMMENTS_S is the shadow or date-tracked counterpart table, populated when the associated business group or installation enables date-tracked (datetrack) functionality for comments; the API writes to it in step with HR_COMMENTS to preserve the historical record. The package body also depends on HR_API for shared API infrastructure and on HR_UTILITY for common helper routines, with DUAL and STANDARD supplying the base SQL and PL/SQL environment.

Usage Notes

HR_COMM_API is a low-level internal API rather than an end-user entry point. It is invoked indirectly by Oracle HRMS forms, by other HRMS APIs, and by concurrent or batch processes that need to record or amend comments on HR entities. The ETRM metadata notes that the package is referenced by 32 other database objects, confirming its role as a shared dependency within the HRMS code base. Because the metadata records no objects referencing it in the reverse direction beyond those dependents, customizations should call the API rather than the base tables, and callers should follow the standard pattern of invoking LCK before UPD or DEL. This preserves data integrity, date-tracked history, and upgrade safety across 12.1.1 and 12.2.2.