Results for “transmitter_record_start”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

APPS.PAY_US_MMREF_LOCAL_XML is a PL/SQL package body in Oracle E-Business Suite that supports the generation of XML output for the Local W-2 Generic MMREF-1 process, a United States year-end payroll tax reporting requirement. Files may be submitted to a locality via magnetic tape. The package encapsulates all cursors, procedures, and functions required to comply with Oracle Payroll's CORE multi-thread enhancement architecture, making it compatible with concurrent processing and parallel execution.

The header notes that magnetic tape report generation is a multi-stage process: (1) verify that the year-end pre-processor has run for all GREs, halting on error otherwise; (2) create a payroll action and record an assignment action against it for each reported assignment; and (3) run the "Local W-2 Generic MMREF-1 XML" process, which invokes this package. The package also provides a debug trace utility (via a flag such as g_debug) and global variables tracking procedure name, document type, and trace state. The LOCAL_W2_XML_EMPLOYEE_BUILD routine is the element most commonly referenced in searches.

Key Procedures and Functions

• GET_REPORT_PARAMETERS / GET_PARAMETER — Retrieve configuration and runtime parameters controlling report generation.
• RANGE_CURSOR — Supplies the driving cursor of assignments to be reported.
• BAL_DB_ITEM / GET_BALANCE_VALUE — Resolve payroll balance values for use in the W-2 data set.
• CREATE_ASSIGNMENT_ACT — Creates the assignment action records associated with the report's payroll action.
• LOCAL_W2_XML_EMPLOYEE_BUILD — Constructs the XML fragment for an individual employee's W-2 data. This is the central employee-level builder called during the XML emission loop.
• LOCAL_W2_XML_EMPLOYER_START / LOCAL_W2_XML_EMPLOYER_END — Emit the opening and closing employer-level XML tags surrounding the employee-level content.
• TRANSMITTER_RECORD_START / TRANSMITTER_RECORD_END — Emit the transmitter-level (MMREF-1) header and trailer records that frame the file.
• LOCAL_NON_PA_EMP_DATA — Handles employee data for non-payroll-action cases.
• WRITE_TO_MAGTAPE_LOB — Writes the assembled LOB content destined for the magnetic tape output.

Tables Accessed

The package reads and writes through APPS synonyms. Payroll and tax structures include PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_ACTION_INTERLOCKS for action lifecycle and locking; PAY_STATE_RULES, PAY_US_CITY_TAX_INFO_F, and PAY_US_CITY_SCHOOL_DSTS for locality tax and school district data. Person and assignment details come from PER_ALL_ASSIGNMENTS_F and PER_ALL_PEOPLE_F. Organization context is drawn from HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION. Fast Formula balance resolution uses FF_DATABASE_ITEMS, FF_CONTEXTS, FF_ARCHIVE_ITEMS, and FF_ARCHIVE_ITEM_CONTEXTS. DUAL is used for scalar lookups.

Usage Notes

This package is invoked by the concurrent program Local W-2 Generic MMREF-1 XML, triggered after the year-end pre-processor has completed for all GREs. It is referenced by one other package, indicating it is a supporting component rather than an entry point. The package is not intended for a single specific locality magnetic tape; it provides generic MMREF-1 XML generation. In 12.1.1 and 12.2.2 the object resides in APPS and is classified as API "OTHER," meaning it is not a public, supported PL/SQL API. Customizations should therefore avoid direct invocation; the supported path is running the associated concurrent program.