Search Results hr_api_modules

Overview

The HR_API_MODULES table is a core metadata repository within the Oracle E-Business Suite Human Resources (PER) module. It functions as a central registry for business processes and row handlers, which are the programmatic units that manage data operations for specific HRMS entities. This table is critical for the extensibility and customization framework of Oracle HRMS, providing a structured mechanism to identify and invoke specific API logic for data validation, derivation, and processing. Its existence underpins key architectural components, including the HRMS Data Pump and the HRMS API Hook system, by defining the available modules that can be called during data loads or business events.

Key Information Stored

The table's structure is designed to uniquely identify and categorize each API module. The primary key is the API_MODULE_ID, a unique numeric identifier. A unique key constraint also exists on the combination of API_MODULE_TYPE and MODULE_NAME, ensuring no duplicate module definitions for a given type. While the full column list is not detailed in the provided metadata, based on its described purpose, the table typically stores columns such as MODULE_NAME (the internal name of the process or handler, e.g., 'PER_EMPLOYEE_API'), API_MODULE_TYPE (categorizing the module, such as 'PROCESS' or 'ROW_HANDLER'), and potentially descriptive columns like MODULE_DISPLAY_NAME or version information. The MODULE_NAME is the key identifier used by other systems to reference a specific module.

Common Use Cases and Queries

This table is primarily referenced for system configuration, troubleshooting, and understanding API dependencies. Common scenarios include identifying all registered API modules for a specific entity or process type, and investigating Data Pump or API Hook behavior by tracing the module being invoked. A typical query would retrieve module details for analysis or validation.

Sample Query: To list all registered API modules, one might execute:
SELECT api_module_id, module_name, api_module_type
FROM hr.hr_api_modules
ORDER BY module_name;
Another practical use is verifying the existence of a module before it is referenced in a hook or configuration:
SELECT 'Module Found'
FROM hr.hr_api_modules
WHERE module_name = 'PER_EMPLOYEE_API';

Related Objects

As indicated by the foreign key constraints, the HR_API_MODULES table is a parent to several key integration and extension tables. The HR_API_HOOKS table references it via API_MODULE_ID, linking custom user exit logic to specific business processes. The HR_PUMP_BATCH_LINES table references it, associating Data Pump batch lines with the specific row handler API module responsible for processing that data type. Furthermore, the PER_RI_CONFIG_DEFAULTS table references the MODULE_NAME column (API_MODULE_NAME), linking Rapid Implementation configuration defaults to their corresponding API modules. These relationships highlight its role as a foundational metadata table for HRMS data processing frameworks.