Search Results hr_pump_batch_headers_s

Overview

HR_PUMP_UTILS (source file hrdputil.pkb, version 120.1) is a utility package body in the APPS schema that supports the Oracle E-Business Suite Human Resources Data Pump infrastructure. Data Pump is the batch-loading framework used by HRMS to stage, validate, and transfer large volumes of person, assignment, and related records into the HR schema through a controlled set of batch headers, batch lines, and mapping rules. HR_PUMP_UTILS provides the low-level building blocks that Data Pump itself and its dependent packages rely on: creating and seeding batch headers, managing user keys on batch lines, registering mapping packages and module parameters, handling default exceptions, and maintaining session-level state that indicates whether a Data Pump run is currently in progress.

The package is classified as OTHER within the ETRM repository and is referenced by 259 other packages, underscoring its role as a shared internal utility rather than a standalone business API. It is not intended for direct end-user or customer invocation; it is consumed by the Data Pump engine and by HRMS product code that participates in Data Pump processing.

Key Procedures and Functions

• CREATE_BATCH_HEADER — Creates a Data Pump batch header record, accepting values such as batch name, business group name, reference, and atomic-link indicator, and returning a handle used by subsequent Data Pump operations.
• ADD_USER_KEY / MODIFY_USER_KEY — Maintain the user-key values associated with Data Pump batch lines, which identify records to be processed and enforce uniqueness during load.
• NAME — Returns the package name, typically used by the Data Pump framework for diagnostics and error reporting.
• SEED_ZAP, SEED_API, SEED_DFLT_EXC, SEED_PARM, SEED_MAP_PKGS — Seeding routines that populate Data Pump configuration tables: default exception handling, module parameters, and mapping-package registrations used to translate staged Data Pump rows into HRMS API calls.
• SET_CURRENT_SESSION_RUNNING / CURRENT_SESSION_RUNNING — Set and query a package global indicating whether the current database session is executing a Data Pump run.
• SET_DT_ENFORCE_FOREIGN_LOCKS / DT_ENFORCE_FOREIGN_LOCKS — Control and query whether date-track foreign-key locking is enforced during a Data Pump run.
• ANY_SESSION_RUNNING — Determines whether any session is currently running Data Pump, useful for concurrency checks and locking decisions.
• SET_MULTI_MSG_ERROR_FLAG / MULTI_MSG_ERRORS_EXIST — Track and report whether multiple-message utility errors have been raised during processing.
• POPULATE_SPREAD_LOADERS_TAB — Populates the spread-loaders table used to support Data Pump spread-sheet style loads.

Tables Accessed

• HR_PUMP_BATCH_HEADERS / HR_PUMP_BATCH_HEADERS_S — Read and written by CREATE_BATCH_HEADER and related logic to store batch header definitions and their translations.
• HR_PUMP_BATCH_LINE_USER_KEYS / HR_PUMP_BATCH_LINE_USER_KEYS_S — Maintained by ADD_USER_KEY and MODIFY_USER_KEY to hold unique user keys for batch lines.
• HR_PUMP_DEFAULT_EXCEPTIONS — Seeded and read by SEED_DFLT_EXC for default exception mapping.
• HR_PUMP_MAPPING_PACKAGES — Registered by SEED_MAP_PKGS to associate Data Pump modules with their mapping packages.
• HR_PUMP_MODULE_PARAMETERS — Seeded by SEED_PARM to supply parameters to Data Pump modules.
• HR_PUMP_REQUESTS — Tracks Data Pump request records.
• HR_PUMP_SPREAD_LOADERS — Populated by POPULATE_SPREAD_LOADERS_TAB.
• HR_API_MODULES — Read for module definitions used during seeding and mapping setup.
• PAY_ACTION_PARAMETER_VALUES — Referenced when Data Pump actions interact with payroll action parameters.

Usage Notes

HR_PUMP_UTILS is an internal utility package invoked from PL/SQL by the Data Pump engine, HRMS product code, and dependent packages rather than from a user-facing form. Its procedures are typically called in sequence during a Data Pump run: batch headers are created, user keys are added or modified, configuration is seeded, and state flags are toggled to signal that a session is running Data Pump. Concurrent programs that drive Data Pump batch loads invoke these routines indirectly. Because the package maintains session-level globals (current-session-running, date-track lock enforcement, multi-message error flags), callers should set and clear these flags consistently within the scope of a Data Pump execution. Custom code should avoid calling this package directly; doing so bypasses the Data Pump framework contracts and may leave configuration or session state inconsistent.