Results for “hr_api_modules_pk”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

HR_API_MODULES is a Human Resources (PER) table in the Oracle E-Business Suite database, owned by the HR schema. It holds details of business processes and their associated row handlers, functioning as a central registry that identifies each HR datapump or business-process module by type and name. Within the HR architecture, the table acts as a reference or lookup entity: process definitions, routing rules, batch loaders, hooks, and datapump configuration rows all resolve the specific business process they operate against by pointing at a row in HR_API_MODULES.

The documented primary key is HR_API_MODULES_PK, defined on API_MODULE_ID (with the ZD_EDITION_NAME column present in the 12.2.2 editioned definition). A secondary unique constraint, HR_API_MODULES_UK1, is defined on the API_MODULE_TYPE and MODULE_NAME pair, establishing the natural business key. In a Data Vault modeling context, the mined foreign-key structure classifies this table as hub-leaning: it holds a stable, uniquely identified business entity (a business process or module) that multiple other tables reference through API_MODULE_ID or API_MODULE_NAME. This classification is a heuristic modeling suggestion rather than a documented data model designation.

Key Information Stored

The table is documented with twelve columns. The most significant are:

• API_MODULE_ID — the surrogate primary key, a system-generated identifier for each business process or module row. This is the value most foreign keys carry.
• API_MODULE_TYPE — the category of the module, distinguishing among the classes of process or handler registered. Together with MODULE_NAME it forms the unique business key HR_API_MODULES_UK1.
• MODULE_NAME — the functional name of the business process or row handler, used both in the unique key and in name-based references such as PER_RI_CONFIG_DEFAULTS.API_MODULE_NAME.
• MODULE_PACKAGE — identifies the PL/SQL package that implements the processing logic for the module, providing the code-level binding for the row handler.
• LEGISLATION_CODE — the legislation (country/regional) context to which the module applies, allowing locale-specific process definitions.
• DATA_WITHIN_BUSINESS_GROUP — a flag or indicator controlling how data visibility or ownership is scoped relative to the business group.
• ZD_EDITION_NAME — the editioning column introduced in the 12.2 edition-based redefinition model, present in both unique indexes.
• Audit columns — CREATED_BY, CREATION_DATE, LAST_UPDATED_BY, LAST_UPDATE_DATE, and LAST_UPDATE_LOGIN, standard Who columns recording row creation and modification.

Distinguishing the surrogate key (API_MODULE_ID) from the business key (API_MODULE_TYPE plus MODULE_NAME) is important when loading or reconciling the table, since downstream tables reference one or the other.

Common Use Cases and Queries

Typical uses include resolving module names to identifiers for joins, listing all modules of a given type, and mapping modules to their implementing packages. A representative lookup resolves a module name to its ID for downstream joins:

SELECT api_module_id, api_module_type, module_name, module_package
FROM hr.hr_api_modules
WHERE module_name = :p_module_name;

A second pattern enumerates modules by type within a legislation context, useful for configuration and impact reporting:

SELECT api_module_id, module_name, legislation_code
FROM hr.hr_api_modules
WHERE api_module_type = :p_type
AND (legislation_code IS NULL OR legislation_code = :p_leg);

The table also supports troubleshooting and auditing of datapump and routing failures: joining HR_PUMP_BATCH_LINES or HR_API_HOOKS back to HR_API_MODULES on API_MODULE_ID identifies which business process produced a given batch line or hook invocation. Reporting on module-to-package mappings assists in upgrade and patch analysis, since it reveals which custom or seeded logic is attached to each process.

Related Objects

Numerous HR tables depend on HR_API_MODULES. The most significant, per documented foreign keys and referencing relationships, are:

• HR_API_HOOKS — references HR_API_MODULES via HR_API_HOOKS.API_MODULE_ID; defines hook points for a module.
• HR_PUMP_BATCH_LINES — references via HR_PUMP_BATCH_LINES.API_MODULE_ID; batch lines processed by a module.
• PER_RI_CONFIG_DEFAULTS — references via PER_RI_CONFIG_DEFAULTS.API_MODULE_NAME; configuration defaults keyed by module name.
• HR_H2PI_MESSAGE_LINES — references via HR_H2PI_MESSAGE_LINES.API_MODULE_ID.
• HR_DU_COLUMN_MAPPINGS — references via HR_DU_COLUMN_MAPPINGS.API_MODULE_ID; datapump column mapping definitions.
• HR_PUMP_SPREAD_LOADERS — references via HR_PUMP_SPREAD_LOADERS.API_MODULE_ID.
• HR_DU_UPLOAD_HEADERS — references via HR_DU_UPLOAD_HEADERS.API_MODULE_ID; upload header records for a module.

These relationships confirm the table's role as a hub-like reference point for HR business-process handling.