Search Results pay_us_online_w4_xml_pkg




Overview
Explore in AI Chat

Overview

APPS.PAY_US_ONLINE_W4_XML_PKG is a PL/SQL package within the Oracle E-Business Suite Oracle Payroll and HRMS footprint that supports the United States Online W-4 (Employee's Withholding Allowance Certificate) self-service process. Its documented purpose is to produce the XML extract consumed when generating the Online W4 PDF. In releases 12.1.1 and 12.2.2 the W-4 federal form and its electronic equivalent are delivered through Oracle Self-Service Human Resources (SSHR) / Employee Self-Service, and the printable output is produced by a BI Publisher (XML Publisher) template. This package supplies the structured XML payload that the template uses, translating transactional W-4 data held in the HRMS tables into a tag/value structure the template can render. The package header carries the RCS identifier $Header: pyw4xmlp.pkh 120.0.12010000.1 2008/07/28, indicating it originated in the 12.0 code line and has been carried forward unchanged into the higher releases, and is classified as an "OTHER" API rather than a public/business API.

Key Procedures and Functions

The package exposes a single documented procedure, generate_xml. Its declared purpose is to return the XML extract for the Online W4 PDF. It accepts the person identifier, a transaction step identifier, a temporary directory, an application short name, a template code, a default language, and a default territory, and returns the assembled XML document through an OUT NOCOPY VARCHAR2 parameter. The procedure is therefore the single entry point used by the W-4 reporting layer: the caller supplies the context (which person, which transaction step, which template and locale) and receives the finished XML string in return. The package also declares a record type, xml_data_rec, composed of xml_tag (up to 100 characters) and xml_data (up to 300 characters), which is used internally to accumulate the tag/data pairs that form the XML payload. No other public procedures or functions are documented.

Tables Accessed

The documented dependencies are HR_API_TRANSACTION_STEPS, HR_API_TRANSACTION_VALUES, PER_ADDRESSES, DUAL, and PLITBLM. The two HR_API_TRANSACTION_* tables sit at the heart of the HRMS date-tracked transaction framework. The p_transaction_step_id argument selects the relevant step in HR_API_TRANSACTION_STEPS, and the associated attribute values are read from HR_API_TRANSACTION_VALUES; this is how the procedure retrieves the W-4 withholding information captured during the online transaction. PER_ADDRESSES supplies address data for the employee, which is required on the W-4 output. DUAL is used for single-row evaluations and constant retrieval, and PLITBLM is the PL/SQL table-to-BLOB helper table used when materialising larger data sets. All are referenced through APPS synonyms in the ETRM metadata.

Usage Notes

The package is invoked indirectly. When an employee completes or views an Online W-4 in self-service, the W-4 printing/extract flow calls generate_xml, passing the person, the transaction step created by the W-4 transaction, the temporary directory, the owning application short name, the BI Publisher template code, and the language/territory defaults. The returned XML string is then handed to the XML Publisher engine to merge with the Online W4 PDF template. The package is not referenced by any other documented package in ETRM, confirming it is a leaf-level utility called by the reporting layer rather than by other PL/SQL APIs. Customisations should not modify the shipped package; any extension is normally achieved by copying or wrapping the standard XML Publisher template. Because the procedure surface has remained stable across 12.1.1 and 12.2.2, existing template definitions and callers continue to function without change between these releases.