Search Results run_magtape

Overview

PAY_US_MAGTAPE_REPORTING is an Oracle E-Business Suite PL/SQL package owned by the APPS schema that supports the generation of United States magnetic tape reports required by federal and state legislative mandates. Its scope covers federal and state W-2 forms as well as State Quarterly Wage Listings (SQWL). The package header declares AUTHID CURRENT_USER, meaning that its unqualified references to database objects resolve against the privileges of the invoking user rather than the package owner. The header source carries the identifier pyusmrep.pkh 115.26, with the earliest revision traced to 1995, confirming the package is an established component of the Oracle Payroll US legislative reporting infrastructure.

Documentation within the package body describes report generation as a deliberate two-stage process. In the first stage, the system creates a payroll action that identifies the magnetic tape report being generated and populates a corresponding set of assignment actions, each identifying an individual to be included in the report. In the second stage, a request is submitted to run the generic magnetic tape process, which drives off the data created in the first stage. The outcome is a structured ASCII file suitable for transfer to magnetic tape and submission to the relevant tax authority. Because of this design, callers are expected to orchestrate multiple steps rather than invoking a single self-contained routine.

Key Procedures and Functions

The package exposes five documented program units. Each is listed below with its purpose as reflected in the ETRM documentation metadata.

• RUN_MAGTAPE — The central entry point associated with the user search term "run_magtape." It drives the generic magnetic tape generation process, producing the structured ASCII output file from the assignment action data established during the first stage of the two-stage report creation model. The package header history records that RUN_MAGTAPE was made public on 11 Feb 1996, indicating it is intended for external invocation rather than internal-only use.
• LOOKUP_FORMAT — Performs format resolution for magnetic tape reporting. Like RUN_MAGTAPE, it was made public in the 11 Feb 1996 revision. Its presence suggests it maps report identifiers or format codes to the formatting metadata used to lay out the output file.
• BAL_DB_ITEM — Relates to defined balance database items. The header history confirms BAL_DB_ITEM was made public specifically to support the resubmission routine, implying it retrieves or evaluates balance item values needed when a report is regenerated.
• REDO — Supports resubmission of magnetic tape reports, allowing a previously processed report to be regenerated. Its reliance on BAL_DB_ITEM reflects the need to reconstruct balance values at resubmission time.
• RUN — A companion execution routine within the package that participates in the overall report generation flow.

Earlier revision notes reference a transition from pre_payment_id to chunk_number, then to serial number, and finally to tax_unit_id, reflecting the evolution of the package's internal identification scheme. No parameter lists are documented in the available metadata and none are asserted here.

Tables Accessed

The package references a broad set of Payroll and HR tables through APPS synonyms. PAY_PAYROLL_ACTIONS and PAY_PAYROLL_ACTIONS_S store the payroll action created in stage one that identifies the magnetic tape report; PAY_ASSIGNMENT_ACTIONS holds the per-person assignment action rows that determine report inclusion. PAY_REPORT_FORMAT_MAPPINGS_F supplies the format definitions used to lay out the structured ASCII output. PAY_DEFINED_BALANCES, PAY_ELEMENT_ENTRIES_F, PAY_ELEMENT_ENTRY_VALUES_F, PAY_ELEMENT_LINKS_F, PAY_ELEMENT_TYPES_F, and PAY_INPUT_VALUES_F provide the element, entry, and balance data from which reported amounts are derived. FF_DATABASE_ITEMS and FF_USER_ENTITIES support the FastFormula database item layer, while HR_SOFT_CODING_KEYFLEX supplies soft coding key flexfield values and PAY_STATE_RULES provides state-specific legislative reporting rules. All access occurs through APPS synonyms under definer's-rights-equivalent resolution governed by AUTHID CURRENT_USER.

Usage Notes

PAY_US_MAGTAPE_REPORTING is typically invoked indirectly through Oracle Payroll's US legislative reporting concurrent programs, which perform stage one action creation before calling RUN_MAGTAPE to produce the output file. REDO supports resubmission scenarios, such as when a report must be regenerated after correction. Because the documented procedures are public, custom code may call them directly, but callers must ensure the prerequisite payroll action and assignment action data exist before invoking RUN_MAGTAPE. The package is referenced by three other packages, confirming it functions as a shared service within the Payroll reporting layer. In EBS 12.1.1 and 12.2.2 the package resides in the APPS schema and is classified as OTHER rather than a public API, so direct custom invocation should be undertaken with appropriate regression testing.