Search Results seed_api

Overview

APPS.HR_DM_SEED_DP is a private Oracle E-Business Suite package body belonging to the Data Pump (DM) infrastructure used by Oracle Human Resources. Its documented purpose is to register the metadata that describes an API module with the Data Pump framework. In Oracle EBS terminology, a "module" is the logical unit of data movement handled by an API package; before the Data Pump can invoke an API to upload or download records, it must know the module name, the class of module, the business group scope, and any legislation restriction. HR_DM_SEED_DP supplies that registration information through a single public entry point, seed_api, referred to in the ETRM metadata by its documented procedure classification, MAIN. The header comment in the source explicitly states the intent: "Create API module information. This tells the data pump that this is the API which will be used for uploading." The package is an infrastructure-level utility delivered under the APPS schema and is classified in ETRM as OTHER, reflecting its role as supporting machinery rather than a functional business API.

Key Procedures and Functions

The package exposes one documented program unit, seed_api, together with the package-level initialisation section (an implicit block) that constitutes the MAIN classification. seed_api performs a conditional registration of an API module: it inserts a row into the module registry only when no module with the same name and module type already exists, thereby making the procedure idempotent and safe to run repeatedly during installation or upgrade. The procedure accepts the module name, the module type, the package that implements the module, an indicator controlling whether the data is scoped within a business group, and an optional legislation code. It writes trace messages on entry and exit via the Data Pump logging utility, recording all supplied values at differing verbosity levels, and it wraps its work in an exception handler that routes errors to the same utility with the offending parameter values for diagnosis. No further procedures or functions are documented for this package.

Tables Accessed

The package reads and writes the registry table HR_API_MODULES, using the HR_API_MODULES_S sequence to obtain the primary key value for each new module row. The existence check is executed against HR_API_MODULES itself by matching module name and module type, so the table serves both as the target of the insert and the source of the duplicate test. The ETRM metadata additionally lists HR_PUMP_MODULE_PARAMETERS and PLITBLM among the objects referenced, indicating that module parameter definitions and PL/SQL table structures used by the Data Pump logging and messaging utilities are touched during execution. Together these objects constitute the persistence layer that the Data Pump consults when deciding which API package to call for a given module.

Usage Notes

HR_DM_SEED_DP is not intended for end-user or application-level invocation. It is called from setup, installation, and patch scripts — typically from data pump seed scripts shipped by Oracle HR product teams — to declare the APIs that the Data Pump may subsequently use for upload or download operations. The procedure may also be invoked from custom code where a customer has developed a bespoke Data Pump API and needs to register it, but such use should follow Oracle's seed script conventions. The ETRM metadata records that the package is referenced by one other package, confirming its position as a dependency of the Data Pump seeding layer rather than a top-level entry point. Because registration is conditional, repeated execution in a patched environment does not create duplicate module definitions. Callers should be aware that successful execution depends on the session having the privileges of the APPS schema or equivalent access to HR_API_MODULES and the Data Pump utility packages.