Search Results hr_dm_cleanup




Overview
Explore in AI Chat

Overview

HR_DM_CLEANUP is a PL/SQL package in the APPS schema that supports Oracle E-Business Suite's Data Migration (DM) facility for Human Resources (HR). Data migration activities involve loading legacy or external data into HR tables through staging, validation, and transformation phases, and the migration framework must dispose of the intermediate artifacts once a migration completes. HR_DM_CLEANUP provides that disposition logic: its role is to remove or reconcile the transient records generated during a migration run so that the HR tables and the Data Migration bookkeeping tables remain consistent after the load has finished. The package header is declared with AUTHID CURRENT_USER, meaning it executes with the privileges of the invoking user, and the header comment (perdmclu.pkh, version 120.0, dated 2005) indicates it is an original, shipped component of the HR Data Migration infrastructure. It is not a public end-user API; it is an internal utility invoked by the Data Migration framework itself. In the ETRM classification it is recorded as an "OTHER" API, reflecting its internal, non-business-facing character.

Key Procedures and Functions

  • MAIN — The entry point for the cleanup operation. It accepts the framework's standard concurrent-program signature (error buffer and return code out parameters), together with a migration identifier, an optional concurrent-process indicator, a last migration date, and a process number. It coordinates the cleanup run for the identified migration, driving the removal of migration data and returning completion status to the caller.
  • POST_CLEANUP_PROCESS — A secondary routine that performs follow-up processing after the main cleanup pass. It receives a migration record (the HR_DM_UTILITY.r_migration_rec structure) describing the migration being processed and executes any remaining reconciliation or housekeeping steps required to leave the migration fully closed.

No other procedures or functions are documented for this package; the header exposes only these two entry points.

Tables Accessed

The package operates against the core Data Migration bookkeeping tables, which are referenced through APPS synonyms:

  • HR_DM_MIGRATIONS — the master record for each migration definition and run; the cleanup logic reads this to determine which migration is being processed and to update its status.
  • HR_DM_MIGRATION_REQUESTS — the individual migration requests raised against a migration; these are examined and cleared as part of cleanup.
  • HR_DM_PHASE_ITEMS — the phase-level work items that track progress through the migration phases; completed phase items are the primary candidates for removal.
  • HR_DM_TABLES — the metadata describing the target and staging tables involved in a migration, used to identify the objects whose data must be cleaned.
  • HR_DM_LOADER_PARAMS — the loader configuration parameters associated with the migration, consulted to confirm which loads were executed before their residual records are purged.

Collectively, these accesses ensure that the cleanup process removes only the transient migration bookkeeping associated with the completed run and does not disturb the migrated HR business data or unrelated migrations.

Usage Notes

HR_DM_CLEANUP is invoked by the HR Data Migration framework, typically as a concurrent program or as the final programmatic step of a migration run after the main load procedures have completed. Its standard concurrent-program call signature allows it to be submitted from the concurrent manager with the migration identifier and related parameters, and POST_CLEANUP_PROCESS is called internally by the framework once the main cleanup has finished. Because the package is referenced by one other package (the Data Migration driver), it should be treated as framework-internal: customizations should not call it directly, as cleanup depends on the state of the DM tables being consistent with a completed migration. In EBS 12.1.1 and 12.2.2 the package behaves identically, running under the invoking user's privileges due to its AUTHID CURRENT_USER declaration. Organizations that have heavily customized HR data migration should verify that the DM bookkeeping tables are populated as expected before scheduling cleanup, since an interrupted migration can leave phase items in a state that the cleanup logic will not remove.