Search Results hr_dm_utility




Overview
Explore in AI Chat

Overview

HR_DM_UTILITY is the central utility package of the Oracle E-Business Suite Data Migration (DM) framework within the Human Resources (HR) product family. In Oracle EBS 12.1.1 and 12.2.2, the HR Data Migration framework provides a structured, restartable mechanism for loading legacy human resources data — employees, assignments, payroll elements, benefits enrollments, and related entities — into the Oracle HRMS schema through a phased, chunked, multi-threaded process. HR_DM_UTILITY supplies the shared services that all phases of this framework depend upon: logging and message handling, phase and migration state management, thread and chunk sizing, transaction control, and the extensive rollback logic required to reverse partially completed migrations.

The package body is owned by the APPS schema, is documented with a VALID status, and is classified as a non-API (OTHER) utility object. Its role is infrastructural rather than business-facing; it is invoked by the migration engine and by individual phase handlers rather than by end users directly.

Key Procedures and Functions

  • GET_PHASE_STATUS / GET_PHASE_ID — Query the current status and surrogate identifier of a migration phase, allowing the framework and concurrent request logic to determine where execution should resume after a failure or restart.
  • NUMBER_OF_THREADS / CHUNK_SIZE — Return the configured degree of parallelism and the unit of work size used when splitting a migration phase into parallel ranges.
  • SET_PROCESS — Establishes or updates the currently active migration process context so subsequent calls operate against the correct migration run.
  • ERROR / MESSAGE / MESSAGE_INIT — Provide standardized error and informational messaging, including initialization of the message buffer and output to the concurrent manager log via FND_FILE.
  • ROLLBACK / ROLLBACK_RANGE_MASTER — Remove migrated data for the current transaction or for an entire migration range, driving the master rollback sequence.
  • ROLLBACK_DOWN_AOL_MASTER / ROLLBACK_UP_AOL_MASTER — Reverse the down and up AOL (Application Object Library) migration steps, cleaning up the AOL-level artifacts created during a migration.
  • ROLLBACK_DOWNLOAD_MASTER — Reverses the download phase, purging staged legacy data extracted from the source system.
  • ROLLBACK_INIT / ROLLBACK_GENERATOR / ROLLBACK_CLEANUP / ROLLBACK_DELETE / ROLLBACK_UPLOAD — Orchestrate the full rollback lifecycle: initialization, generation of rollback statements, cleanup of residual records, deletion of migrated rows, and reversal of the upload phase.
  • UPDATE_MIGRATIONS / UPDATE_MIGRATION_RANGES — Maintain the migration and migration-range status records as each phase completes or fails, supporting restartability.

Tables Accessed

HR_DM_UTILITY reads and writes the core control tables of the DM framework: HR_DM_MIGRATIONS and HR_DM_MIGRATION_RANGES (migration run and range status), HR_DM_PHASES and HR_DM_PHASE_ITEMS (phase definitions and individual work items), HR_DM_TABLES and HR_DM_TABLE_GROUPINGS (the target tables and logical groupings processed by each phase). It references BEN_BATCH_PARAMETER when the migration touches benefits batch processing. Dependencies on HR_DM_LIBRARY, HR_GENERAL, and HR_UTILITY provide shared HR utility routines, while FND_FILE supports concurrent program logging.

Usage Notes

HR_DM_UTILITY is not intended for direct invocation by end users or custom code. It is called internally by the HR Data Migration concurrent programs and phase handler packages; the ETRM metadata confirms that it is referenced by eighteen other packages but does not itself reference any external object beyond its documented dependencies. Customizations should interact with the migration framework through its supported entry points rather than calling HR_DM_UTILITY directly, since its procedures assume an established migration and phase context. Database administrators use the GET_PHASE_STATUS and UPDATE_MIGRATIONS logic indirectly when monitoring and restarting failed migration runs.