Search Results rollback_upload

Overview

APPS.BEN_DM_UTILITY is the internal utility package for Oracle E-Business Suite's Benefits Data Migration (DM) framework, part of the Advanced Benefits (BEN) module. Its header was authored in 2006 and shipped under the standard EBS naming convention (benfdmutil.pkh). The package provides the housekeeping, status-tracking, rollback, and seeding logic that underpins the migration of benefits configuration and enrollment data between database environments. It is not a business-facing API; rather, it is the plumbing used by the BEN_DM_* family of tables that persist migration definitions, phases, phase items, column mappings, and table ordering.

The naming suffix "DM" refers to Data Migration, and BEN_DM_UTILITY acts as the shared library of low-level services consumed by the driver and worker packages of the migration toolkit. Any reference in user searches to a "flip tool" relates to migration tooling terminology rather than to this specific object.

Key Procedures and Functions

• ROLLBACK, ROLLBACK_DOWNLOAD_MASTER, ROLLBACK_INIT, ROLLBACK_GENERATOR, ROLLBACK_UPLOAD — a set of rollback procedures that reverse a migration or a specific phase. ROLLBACK accepts phase, master/slave indicator, migration ID, and phase item ID; the remaining four are phase-specific entry points for the download-master, initialization, generator, and upload stages.
• NUMBER_OF_THREADS — returns the number of concurrent threads configured for a given business group, supporting parallel migration processing.
• GET_PHASE_STATUS, GET_PHASE_ID — lookup functions returning the current status or the internal ID for a named phase within a migration.
• ERROR — central error handler accepting SQL code, procedure name, extra text, and a rollback flag.
• MESSAGE, MESSAGE_INIT — message output utilities; MESSAGE_INIT initialises the message buffer or file handle, and MESSAGE writes a typed message at a given position.
• UPDATE_MIGRATIONS, UPDATE_PHASE_ITEMS, UPDATE_PHASES — status maintenance routines setting a new status against a migration, phase item, or phase record.
• GET_TABLE_ID, SEED_COLUMN_MAPPING, SEED_TABLE_ORDER, INS_HIR — metadata seeding routines. They resolve a table name to its ID, populate the column mapping and table ordering seed data, and insert hierarchy (parent/child) relationships between tables.

Tables Accessed

The package reads and writes the core DM repository tables via APPS synonyms. BEN_DM_MIGRATIONS, BEN_DM_PHASES, and BEN_DM_PHASE_ITEMS hold the migration header, phase, and phase-item records whose statuses are updated and queried. BEN_DM_COLUMN_MAPPINGS and its _S shadow table store field-level mapping definitions seeded by SEED_COLUMN_MAPPING. BEN_DM_TABLES identifies migration-relevant tables, BEN_DM_TABLE_ORDER and BEN_DM_TABLE_ORDER_S define processing sequence, and BEN_DM_HIERARCHIES / BEN_DM_HIERARCHIES_S store parent-child relationships created by INS_HIR. BEN_DM_ENTITY_RESULTS captures per-entity outcomes referenced during rollback. BEN_BATCH_PARAMETER supplies runtime batch/thread parameters. DUAL is used for singleton lookups, and UTL_FILE handles file I/O during export and import stages.

Usage Notes

BEN_DM_UTILITY is invoked indirectly: the Benefits Data Migration concurrent programs and their driver packages call these routines to initialise migrations, seed metadata, report status, and perform rollbacks. It is referenced by 15 other packages in the EBS schema, confirming its role as a shared internal library. Because it is declared AUTHID CURRENT_USER and is not an approved public API, it should not be called from customer customisations; any direct dependency risks breakage across patches. Database administrators may see it in error stacks when a Benefits migration fails, in which case the ROLLBACK procedures are the supported mechanism for cleanup.