Search Results format_record

Overview

APPS.PAY_US_REPORTING_UTILS_PKG is a United States statutory reporting utility package in Oracle EBS Payroll. It centralizes the shared logic used to calculate wages, validate data, and format fixed-length reporting records for US year-end and regulatory submissions, including W-2, W-2C, 1099-R, and Magnetic Media Reporting (MMREF) formats. The package is owned by the APPS schema and is registered as VALID in the ETRM repository for release 12.2.2, with the same dependency footprint observed in 12.1.1.

The object follows a utility-package design pattern: formatting and validation routines are consolidated here rather than duplicated in each report-specific program. Its principal public entry points span fifteen documented procedures and functions, and it is referenced by eleven other packages, most of them reporting format implementations.

Key Procedures and Functions

• GET_WAGES, GET_TOTAL_WAGES, GET_SUI_WAGES, CALCULATE_WAGES, CALCULATE_BALANCE — the wage aggregation layer. These routines resolve balance values and derive the wage figures required by federal and state reporting forms.
• GET_LIVE_EE_CONTRIB — returns live employee contribution amounts, typically for retirement or benefit reporting lines.
• GET_ITEM_DATA — retrieves a discrete data item value for record assembly, providing the interface consumed by PAY_US_GET_ITEM_DATA_PKG.
• DATA_VALIDATION, CHARACTER_CHECK, FORMULA_CHECK — validation routines that verify compliance of a value before it is written to a reporting record.
• FORMAT_RECORD, PRINT_RECORD_HEADER — control the physical layout of fixed-width output, including record headers.
• GET_TERRITORY_VALUES — supplies territory-specific constants and codes used by state and territorial reporting.
• GET_FILE_NAME — constructs the output file name for the reporting submission.
• GET_FF_ARCHIVE_VALUE — reads archived FastFormula results from the FF archive tables.
• GET_EMPLOYEE_COUNT, GET_EMPLOYEE_COUNT_MONTHWISE — derive employee headcounts, including month-by-month counts required by MMREF reporting.

Tables Accessed

The package reads through APPS synonyms and does not own data. Payroll balance and calculation data is drawn from PAY_BALANCE_TYPES, PAY_DEFINED_BALANCES, and PAY_BALANCE_FEEDS_F for CALCULATE_WAGES, CALCULATE_BALANCE, and the GET_WAGES family. FastFormula archive values come from FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS, FF_DATABASE_ITEMS, FF_FORMULAS_F, and FF_USER_ENTITIES. PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS provide action and assignment context. PAY_MAGNETIC_BLOCKS and PAY_MAGNETIC_RECORDS support magnetic media record construction. HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION resolve organization and territory information for GET_TERRITORY_VALUES.

Usage Notes

This package is not an end-user API. It is invoked internally from US year-end concurrent programs and their associated format packages, including PAY_US_1099R_UDFS, PAY_US_CUSTOM_SQWL_FORMAT_REC, PAY_US_MMRF2_W2C_FORMAT_RECORD, PAY_US_MMRF_SQWL_FORMAT_RECORD, PAY_US_MMRF_W2_FORMAT_RECORD, PAY_US_REPORT_DATA_VALIDATION, PAY_US_W2C_IN_MMREF2_FORMAT, and PAY_US_W2_GENERIC_EXTRACT. Customers extending US statutory reporting should call these routines rather than reimplementing wage calculations or record formatting, since the dependent format packages assume their behavior. The single inbound dependency is on SYS.STANDARD, confirming the package is self-contained with respect to database privileges. Verification that the package is VALID should precede any year-end run, particularly following patches or a 12.1.1 to 12.2.2 upgrade.