Search Results format_sqwl_ru_record
Overview
PAY_US_MMRF_SQWL_FORMAT_RECORD is an Oracle Application Object Library (APPS) package that supports the quarterly wage reporting (SQWL) process for US legislative requirements. Its stated purpose, per the package header, is "to format record to support the generation of SQWL magnetic tape for US legislative requirements." SQWL refers to the State Quarterly Wage Listing, the electronic submission format required by US state agencies for unemployment insurance and wage reporting.
The package operates as a formatting utility layer within the Oracle Payroll reporting stack. Rather than querying data directly, it receives field values from a calling package — documented as pay_us_reporting_utils_pkg — and returns them formatted to the fixed-width, record-type-specific layouts required for magnetic tape (or magnetic media) file generation. The ETRM classification for the object is OTHER, with no public API designation.
The user search term "dat_validation" maps directly to this package. The package comments state that the length-determination function "is being referenced from DAT_VALIDATION function in package pay_us_reporting_utils_pkg." Data validation therefore occurs in the calling utility package, which delegates field length derivation and record formatting to this package.
Key Procedures and Functions
The package exposes ten documented subprograms, grouped by the record types they emit for the SQWL file:
- SET_REQ_FIELD_LENGTH — Determines and validates the required length for fields across the various data records. It accepts a report type, format, report qualifier, record name, and up to five input values, returning a NUMBER. This is the function referenced by DAT_VALIDATION.
- FORMAT_SQWL_CONTACT_PRSN_INFO — Formats contact person information used for SQWL reporting, covering name, phone, extension, e-mail, fax, and separate first/middle/last name components, with an exclude-from-output flag.
- FORMAT_SQWL_RA_RECORD — Formats the RA (report/address header) record type.
- FORMAT_SQWL_RE_RECORD — Formats the RE record type.
- FORMAT_SQWL_RS_RECORD — Formats the RS record type.
- FORMAT_SQWL_RT_RECORD — Formats the RT record type.
- FORMAT_SQWL_RSSUMM_RECORD — Formats the RS summary record; added in version 115.3 (fix 3830050) per the package history.
- FORMAT_SQWL_RST_RECORD — Formats the RST record type.
- FORMAT_SQWL_RU_RECORD — Formats the RU record type.
- FORMAT_SQWL_RF_RECORD — Formats the RF (final/trailer) record type.
Each formatting routine receives p_report_qualifier, p_record_name, and p_validate parameters along with IN OUT record field values, allowing in-place transformation and truncation to layout-defined widths.
Tables Accessed
The only documented table referenced through APPS synonyms is PAY_US_FEDERAL_TAX_INFO_F, the federal tax information entity for US payroll. This table supplies employer identification and related federal tax attributes needed for header and summary records in the SQWL file. The package is otherwise a pure formatting utility: it does not appear to write to application tables, and its principal data dependency is on values passed in by the caller.
Usage Notes
This package is referenced by two other packages, with PAY_US_REPORTING_UTILS_PKG identified as the primary caller. In practice it is invoked indirectly during submission of the US SQWL magnetic media reporting concurrent program, which calls the reporting utilities package; that package performs DAT_VALIDATION, delegating field length computation and record formatting to PAY_US_MMRF_SQWL_FORMAT_RECORD.
Because the package is not a documented public API, direct invocation from forms, custom concurrent programs, or bespoke code is not recommended. Customizations should extend or wrap the reporting utilities package rather than call the formatting routines directly, thereby preserving record layout and validation behavior defined by Oracle. The package has been stable since the 12.1.1 codebase (header revision 120.0.12010000.1) and is shipped unchanged in 12.2.2.