Search Results hr_api_hooks
Overview
The HR_API_HOOKS table is a core metadata repository within the Oracle E-Business Suite (EBS) Human Resources (HRMS) module. It functions as a central registry for all available "hook points" across the suite's HR application programming interfaces (APIs). In the context of Oracle EBS, a hook point represents a predefined location within a standard API module where custom business logic can be programmatically injected without modifying the base Oracle code. This table's primary role is to define and catalog these extensibility points, enabling the safe and supported customization of HR business processes, such as employee hires, assignments, or terminations, in versions 12.1.1 and 12.2.2.
Key Information Stored
The table stores the metadata necessary to identify and execute custom logic. Its structure, as defined by its primary and unique keys, emphasizes the uniqueness and discoverability of each hook. Key columns include:
- API_HOOK_ID: The primary key identifier for a specific hook point.
- API_MODULE_ID: A foreign key linking to the HR_API_MODULES table, identifying the parent API (e.g., a person or assignment API).
- API_HOOK_TYPE: Defines the execution phase or type of the hook (e.g., 'PRE_PROCESS', 'POST_PROCESS').
- HOOK_PACKAGE: The name of the PL/SQL package containing the custom procedure.
- HOOK_PROCEDURE: The name of the specific procedure within the package to be executed at the hook point.
Common Use Cases and Queries
This table is primarily referenced during the design and troubleshooting of customizations. A common use case is for developers to query available hooks for a specific API module to determine where to attach their logic. For example, to find all hook points for the 'Employee Assignment' API, one might execute:
SELECT h.hook_package, h.hook_procedure, h.api_hook_type
FROM hr_api_hooks h, hr_api_modules m
WHERE h.api_module_id = m.api_module_id
AND m.module_name = 'PER_ASSIGNMENTS_PKG';
Another critical use case is validation, ensuring a custom hook call is registered against a valid hook point. System administrators may also run queries to audit all customizations by joining HR_API_HOOKS with HR_API_HOOK_CALLS to see which hooks have active custom code attached.
Related Objects
The HR_API_HOOKS table sits at the center of the API hook architecture, with defined relationships to other key metadata tables.
- HR_API_MODULES: The parent table. The foreign key
HR_API_HOOKS.API_MODULE_IDreferencesHR_API_MODULES.API_MODULE_ID. This relationship ties each hook point to its originating API module. - HR_API_HOOK_CALLS: The child table. The primary key
HR_API_HOOKS.API_HOOK_IDis referenced by the foreign keyHR_API_HOOK_CALLS.API_HOOK_ID. This relationship is where the actual custom code execution entries are stored for each registered hook point.
-
Table: HR_API_HOOKS
12.1.1
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_HOOKS, object_name:HR_API_HOOKS, status:VALID, product: PER - Human Resources , description: Lists the hook points which are available in each API module. , implementation_dba_data: HR.HR_API_HOOKS ,
-
Table: HR_API_HOOKS
12.2.2
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_HOOKS, object_name:HR_API_HOOKS, status:VALID, product: PER - Human Resources , description: Lists the hook points which are available in each API module. , implementation_dba_data: HR.HR_API_HOOKS ,
-
Table: HR_API_MODULES
12.2.2
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_MODULES, object_name:HR_API_MODULES, status:VALID, product: PER - Human Resources , description: Holds details of the business processes and row handlers. , implementation_dba_data: HR.HR_API_MODULES ,
-
Table: HR_API_MODULES
12.1.1
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_MODULES, object_name:HR_API_MODULES, status:VALID, product: PER - Human Resources , description: Holds details of the business processes and row handlers. , implementation_dba_data: HR.HR_API_MODULES ,
-
Table: HR_API_HOOK_CALLS
12.2.2
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_HOOK_CALLS, object_name:HR_API_HOOK_CALLS, status:VALID, product: PER - Human Resources , description: Lists which extra logic, package procedures or formula, should be called from the API hook points. , implementation_dba_data: HR.HR_API_HOOK_CALLS ,
-
Table: HR_API_HOOK_CALLS
12.1.1
owner:HR, object_type:TABLE, fnd_design_data:PER.HR_API_HOOK_CALLS, object_name:HR_API_HOOK_CALLS, status:VALID, product: PER - Human Resources , description: Lists which extra logic, package procedures or formula, should be called from the API hook points. , implementation_dba_data: HR.HR_API_HOOK_CALLS ,