Search Results hr_abm_shd




Overview
Explore in AI Chat

Overview

APPS.HR_ABM_SHD is a shadow (seed data handler) package body in the Oracle E-Business Suite Human Resources module that supports the HR API batch messaging infrastructure. The package encapsulates the runtime logic used by the HR_ABM (HR API Batch Message) framework to manage API-layer error handling, concurrency locking, and argument conversion for batch-oriented HR processes. As a shadow package, it is generated and maintained as part of the HR API generation and upgrade process, and it operates alongside the corresponding HR_ABM package. In Oracle EBS 12.1.1 and 12.2.2, the package resides in the APPS schema and is classified under the ETRM "OTHER" API category. Its principal business function is to translate low-level Oracle database constraint violations into meaningful, user-facing HR error messages, thereby allowing concurrent programs and forms to present consistent diagnostics to end users. The embedded constraint_error procedure is the mechanism by which the API framework intercepts a constraint failure and raises an HR-standard message rather than a raw Oracle error.

Key Procedures and Functions

The package exposes four documented procedures and functions, each supporting a distinct facet of the API batch execution framework.

  • RETURN_API_DML_STATUS — A function returning a Boolean that reflects whether the calling API has performed DML within the current session. It reads the package-global g_api_dml flag, defaulting to FALSE when unset, and is used by the framework to determine commit or rollback behavior after an API invocation.
  • CONSTRAINT_ERROR — The most significant procedure in the context of the user's search. It accepts a constraint name and maps it to an HR message. When the constraint is HR_ABM_STATUS_CHECK, it raises HR error 7297 (HR_7297_API_ARG_ONLY) with tokens identifying the status argument and its permitted values (F, S). When the constraint is HR_API_BATCH_MESSAGE_LINES_PK, it raises HR error 7220 (HR_7220_INVALID_PRIMARY_KEY). Any other constraint name results in HR error 7877 (HR_7877_API_INVALID_CONSTRAINT), with the procedure name supplied as a token.
  • LCK — Provides the locking support used by the API to acquire and validate the concurrency lock on the row being processed, ensuring serialized access during batch message handling.
  • CONVERT_ARGS — Handles argument conversion for the API layer, normalizing inbound arguments before they are passed to DML operations.

Tables Accessed

The package references two objects through APPS synonyms. ALL_CONSTRAINTS is used to validate and resolve constraint names supplied to CONSTRAINT_ERROR, allowing the procedure to match a physical constraint against its known message mapping. HR_API_BATCH_MESSAGE_LINES is the primary transactional table for the HR API batch message facility; the package interacts with it to relate constraint violations to the batch message line being processed, and its primary key constraint is one of the explicitly handled error conditions.

Usage Notes

HR_ABM_SHD is not intended to be called directly by end users. It is invoked internally by the HR_ABM framework and by other HR API packages — ETRM records three dependent packages — whenever an API operation encounters a database constraint failure or requires DML status evaluation. Typical invocation paths include HR concurrent programs that process batch API messages, HR forms performing DML through the API layer, and custom extensions that call the HR_ABM APIs. When a user reports an error such as HR-7297 or HR-7220, the originating constraint mapping is resolved through CONSTRAINT_ERROR in this package. Because the object is a shadow/seed entity, it should not be modified directly; changes must be applied through the supported HR API patch and upgrade mechanism to avoid regeneration overwriting custom edits.