Results for “local_w2_xml_employer_end”

12 results




Overview
Explore in AI Chat

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 in the Oracle E-Business Suite HRMS and Payroll modules that supports the generation of the United States Magnetic Media (MMREF) local tax file output. The package is responsible for producing the localized jurisdiction reporting records that accompany the federal W-2 magnetic media submission. It assembles XML-formatted local wage and tax data, computes transmitter-level header and trailer records, and writes these records to the magnetic media output stream used for electronic filing with the Social Security Administration and applicable state and local tax agencies.

The package operates within the standard Oracle Payroll balance and archive framework. It retrieves archived payroll balances, resolves employer and employee organizational information, and formats the resulting data into the record structures required by the MMREF specification. Because local jurisdictions carry their own reporting rules, the package also references state tax rules and city and school district tax configuration tables to determine the correct reporting treatment for each employee's locality.

Key Procedures and Functions

The package exposes fourteen documented procedures and functions. Their stated purposes are as follows:

  • BAL_DB_ITEM — resolves a database item definition for balance retrieval within the archive and balance framework.
  • GET_REPORT_PARAMETERS — retrieves the parameters that govern the local magnetic media report run.
  • GET_BALANCE_VALUE — returns the value of a specified payroll balance for a given assignment and context, forming the core of wage and tax figure extraction.
  • RANGE_CURSOR — defines the driving cursor over the population of assignments, actions, or archival records processed by the report.
  • CREATE_ASSIGNMENT_ACT — creates an assignment action record, tying processing to a payroll action for audit and tracking.
  • TRANSMITTER_RECORD_START and TRANSMITTER_RECORD_END — emit the opening and closing transmitter records required by the magnetic media layout.
  • LOCAL_W2_XML_EMPLOYER_START and LOCAL_W2_XML_EMPLOYER_END — build the opening and closing XML elements for employer-level local W-2 data.
  • LOCAL_W2_XML_EMPLOYEE_BUILD — constructs the XML payload for each employee's local W-2 detail.
  • WRITE_TO_MAGTAPE_LOB — writes the assembled record content into the magnetic media large object buffer.
  • GET_PARAMETER — retrieves an individual run parameter value by name.
  • LOCAL_NON_PA_EMP_DATA — obtains local tax data for employees who fall outside the standard payroll action scope.

Tables Accessed

The package reads from and writes to the following documented objects via APPS synonyms: FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS, and FF_DATABASE_ITEMS supply the FastFormula archive and balance retrieval infrastructure; HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION provide employer and organizational unit details for the transmitter and employer records; PAY_ACTION_INTERLOCKS, PAY_ASSIGNMENT_ACTIONS, and PAY_PAYROLL_ACTIONS govern payroll action context and assignment-level processing; PAY_STATE_RULES, PAY_US_CITY_SCHOOL_DSTS, and PAY_US_CITY_TAX_INFO_F provide the state, city, and school district tax configuration needed for local jurisdiction reporting; PER_ALL_ASSIGNMENTS_F and PER_ALL_PEOPLE_F supply assignment and person records for identifying employees and their tax-relevant attributes; and DUAL supports singleton queries. The package additionally depends on PAY_MAGTAPE_GENERIC and PAY_US_GET_ITEM_DATA_PKG, and the W2 generic extract package references it as a dependent.

Usage Notes

PAY_US_MMREF_LOCAL_XML is not intended for direct invocation by end users. It is called internally by the W-2 magnetic media extraction process, specifically the PAY_US_W2_GENERIC_EXTRACT package, when the United States magnetic media (MMREF) output is generated and local jurisdiction records are required. The package is archived as VALID and classified as OTHER, indicating it is a proprietary internal utility rather than a public API. Customizations should extend the invoking concurrent program or report parameters rather than modifying the package directly, since it participates in the standard payroll archiving and balance retrieval flow and draws on dependent packages such as PAY_MAGTAPE_GENERIC and PAY_US_GET_ITEM_DATA_PKG. It relies on standard Oracle dependencies, including STANDARD and PUBLIC.