Search Results hr_api_batch_message_lines_pk

Overview

The HR_API_BATCH_MESSAGE_LINES table, owned by the HR schema within the PER (Human Resources) product module, stores the results and messages generated during batch API processing in Oracle E-Business Suite. When HR-related APIs are executed in a batch mode — for example, during mass updates, bulk hiring, or large-scale assignment changes — the processing engine records the outcome of each invocation at the line level within this table. Each row captures a discrete message or result associated with a particular API call, its batch run, and the originating source row information, thereby providing a persistent audit and diagnostic trail for batch operations.

From a Data Vault modeling perspective, the ETRM metadata classifies this object heuristically as standalone. This classification suggests that the table is best modeled as an independent satellite or fact-like structure rather than as a hub or link, because it does not participate in clean foreign-key relationships to other business entities (the lone FK to FND_SECURITY_GROUPS being an infrastructure reference rather than a domain relationship). The table functions primarily as a message log keyed by its own surrogate identifier rather than as a connector between business keys.

Key Information Stored

The table contains nine documented columns. The surrogate primary key is LINE_ID, which is uniquely enforced by the HR_API_BATCH_MESSAGE_LINES_PK unique index. Because LINE_ID is also the sole business-key candidate documented, there is no separate natural identifier; queries resolving a specific message line should therefore rely on LINE_ID.

• LINE_ID — Surrogate primary key uniquely identifying each message line record.
• API_NAME — The name of the HR API that generated the message, allowing results to be grouped by processing routine.
• BATCH_RUN_NUMBER — Identifier tying messages to a specific batch execution, enabling retrieval of all results from one batch run.
• STATUS — Outcome indicator (for example, success or error) for the individual API invocation.
• ERROR_MESSAGE — The text of the error raised, if applicable.
• ERROR_NUMBER — The numeric error code accompanying the message.
• EXTENDED_ERROR_MESSAGE — Additional or detailed diagnostic text beyond the primary error message.
• SOURCE_ROW_INFORMATION — Descriptive information identifying the source record that triggered the API call, aiding reconciliation.
• SECURITY_GROUP_ID — Foreign key to FND_SECURITY_GROUPS, supporting the EBS security group model.

Common Use Cases and Queries

The primary use case is diagnosing and reporting on batch API outcomes. A typical query retrieves all errors from a given batch run:

• SELECT LINE_ID, API_NAME, STATUS, ERROR_NUMBER, ERROR_MESSAGE FROM HR_API_BATCH_MESSAGE_LINES WHERE BATCH_RUN_NUMBER = :p_batch AND STATUS = 'E' ORDER BY LINE_ID;
• Summarizing success versus failure counts per API: SELECT API_NAME, STATUS, COUNT(*) FROM HR_API_BATCH_MESSAGE_LINES WHERE BATCH_RUN_NUMBER = :p_batch GROUP BY API_NAME, STATUS;
• Correlating failed messages to source rows using SOURCE_ROW_INFORMATION to identify which employee or assignment records failed to process.
• Tracking recurring error codes over time to identify systemic data-quality issues across batches.
• Extracting extended diagnostics for support escalations by reading EXTENDED_ERROR_MESSAGE alongside ERROR_NUMBER.

Related Objects

The documented foreign-key relationship links this table to the security infrastructure, and related batch-processing objects extend its utility:

• FND_SECURITY_GROUPS — joined via SECURITY_GROUP_ID, providing the security grouping associated with each message line.
• HR_API_BATCH_HEADERS — the header-level companion that tracks batch runs; join on BATCH_RUN_NUMBER to obtain run context.
• HR_API_BATCH_MESSAGES — the parent message table from which line-level detail descends.
• HR_API_BATCH_MESSAGE_LINES_PK — the unique index enforcing the LINE_ID primary key.
• HR_EMPLOYEES_API and related HR APIs referenced through API_NAME — the routines whose results populate this table.
• PER_EMPLOYEES_F and PER_ALL_ASSIGNMENTS_F — commonly the source entities processed during batch runs whose outcomes are logged here.

Together these objects allow administrators to reconstruct, audit, and troubleshoot batch HR API processing at both summary and line level.