Search Results pay_magtape_extract




Overview
Explore in AI Chat

Overview

PAY_MAGTAPE_EXTRACT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified under the Oracle ETRM (E-Business Suite Technical Reference Manual) as an OTHER-type API rather than a public, supported interface. Its name and dependency footprint identify it as the legacy magnetic tape extraction engine used by Oracle Payroll for jurisdictions that still require the production, archiving, and reporting of payroll data on magnetic media formats. In releases 12.1.1 and 12.2.2 the object remains VALID and is retained primarily for backward compatibility with earlier payroll reporting and archival flows.

The package is a component of the U.S. payroll magnetic media subsystem. Its primary consumer is PAY_US_MAGTAPE_REPORTING, which drives the creation of magnetic media files and the associated reporting structures. The ETRM also records a self-referencing dependency, indicating that the package invokes its own procedures internally during multi-phase archive processing. Functionally, the package assembles payroll action data, magnetic block and record definitions, and message lines into a format suitable for tape-oriented output, while coordinating with the Oracle FastFormula archival framework through the FF_ARCHIVE_ITEMS family of tables.

Key Procedures and Functions

The documented interface exposes two procedures, both concerned with archive lifecycle management rather than the extraction logic itself:

  • ARCH_MAIN — The primary driver procedure for the archive operation. It orchestrates the insertion and maintenance of archive item records, resolving contexts and database item usages required to capture the payroll data set for magnetic media output.
  • ARCH_ROLBK — The companion rollback procedure. It performs the compensating action for ARCH_MAIN, removing or reversing archive records when the parent operation fails or is deliberately backed out, ensuring the archive tables remain consistent.

An associated reporting package, PAY_US_MAGTAPE_REPORTING, calls into PAY_MAGTAPE_EXTRACT to initiate these operations. No additional public functions are documented in the ETRM metadata; the balance of the package body consists of internal helpers that are not exposed.

Tables Accessed

The documented table references divide into three logical groups. The archive framework group comprises FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEMS_S, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS, FF_DATABASE_ITEMS, FF_FDI_USAGES_F, FF_ROUTE_CONTEXT_USAGES, and FF_USER_ENTITIES; these store the definition, context routing, and usage metadata that ARCH_MAIN and ARCH_ROLBK write and maintain. The payroll data group includes PAY_ASSIGNMENT_ACTIONS, PAY_MAGNETIC_BLOCKS, PAY_MAGNETIC_RECORDS, PAY_MESSAGE_LINES, PAY_MESSAGE_LINES_S, and PAY_PAYROLL_ACTIONS; these supply the assignment-level action records, the magnetic block and record layout definitions, and the message text emitted to the media file. Finally, FND_SESSIONS is referenced to obtain session context for the running extraction. Access is made through APPS synonyms, consistent with the package's APPS ownership.

Usage Notes

PAY_MAGTAPE_EXTRACT is not intended for direct invocation by end users or by custom code. In normal operation it is called indirectly by the U.S. magnetic media reporting concurrent programs and by PAY_US_MAGTAPE_REPORTING, which supply the payroll action and assignment context. The presence of paired main and rollback procedures indicates a transactional archival pattern in which a failed extraction is cleanly reversed before the concurrent request terminates. Because the package is classified as OTHER and is undocumented as a public API, customers should treat it as internal implementation and avoid building dependencies on it; Oracle may alter or retire it without a public interface commitment. Sites that have already extended magnetic media output should confine customizations to the supported reporting layer rather than modifying this package.