Search Results hr_api_user_hooks




Overview
Explore in AI Chat

Overview

HR_API_USER_HOOKS is an internal Oracle E-Business Suite package owned by the APPS schema that supports the extensibility framework of the Oracle HRMS public APIs. Its business function is to generate and register user hook package bodies in the database, allowing customers and integrators to inject custom business logic into seeded HRMS API processing without modifying Oracle-owned code. User hooks are the supported extension mechanism by which sites can validate, default, or post-process data as it flows through HRMS API calls. HR_API_USER_HOOKS provides the technical plumbing that materializes a hook package body from its specification so that the API layer can subsequently discover and invoke it.

Within the ETRM classification, the package is registered as API classification OTHER. It is documented as an internal development utility rather than a callable business API, and its access status is explicitly noted as "Internal Development Use Only." The package is referenced by two other packages in the APPS schema, reflecting its role as a shared infrastructure component rather than an application-facing entry point.

Key Procedures and Functions

  • create_package_body — Creates a single API user hook package body in the database. It accepts a single input parameter, the name of the hook package, which must already exist. On success, a hook package body is created. Application-level errors encountered during processing are written to the HR_API_HOOKS and HR_API_HOOK_CALLS tables; for most such errors the procedure completes normally without raising a PL/SQL exception. Unexpected Oracle errors and serious application errors are raised as PL/SQL exceptions, in which case processing aborts. Parameter lists beyond the documented single input parameter are not reproduced here.

Tables Accessed

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

  • HR_API_HOOKS — Stores hook registration definitions and receives application error information generated during package body creation.
  • HR_API_HOOK_CALLS — Records hook call metadata and receives application error information written on failure paths.
  • HR_API_MODULES — Defines the HRMS API modules against which hooks are registered, used to validate and resolve the target hook package.
  • FND_PRODUCT_INSTALLATIONS — Used to confirm product installation status, ensuring the hook infrastructure operates only where the relevant products are installed.
  • USER_SOURCE — Read by the package to inspect the source of the hook package specification and to derive the body content to be created.
  • DBMS_DESCRIBE and DBMS_SQL — Supplied PL/SQL packages (not tables) used to describe the hook package interface and to execute the dynamically constructed DDL that creates the package body.

Usage Notes

HR_API_USER_HOOKS is not intended for direct invocation from Oracle Forms, concurrent programs, or customer-written business logic. Because its access status is restricted to internal development use, it is invoked by Oracle's own HRMS API infrastructure and by the small set of companion packages that reference it. The typical invocation sequence is that a hook package specification is deployed first, and then create_package_body is called with the hook package name to generate the corresponding body in the database.

Custom implementations that extend HRMS APIs normally interact with the hook framework through the documented user hook interfaces and registration data in HR_API_HOOKS, not through this package. Administrators and developers should treat HR_API_USER_HOOKS as a sealed Oracle-owned utility: it may be referenced for diagnostic purposes when investigating hook registration or package body generation failures, but it should not be modified or called directly. Behavior is consistent across EBS 12.1.1 and 12.2.2, and the header indicates the source has been stable since an early ship release.