Search Results tx_new_hire_record

Overview

APPS.PER_NEW_HIRE_PKG is a PL/SQL package body in Oracle E-Business Suite that supports the generation of new hire electrical (magnetic media / electronic) reporting files required by U.S. state and Canadian tax authorities. The package header comment in the source describes its purpose plainly: it "defines procedures/functions that are used for new hire electrical file." These reports are mandated under the Personal Responsibility and Work Opportunity Reconciliation Act (PRWORA) in the United States and equivalent provincial requirements in Canada, obligating employers to report newly hired and rehired employees within a defined period after the hire date.

Rather than implementing a single monolithic reporting routine, the package is organized as a collection of state- and jurisdiction-specific record builders. Each builder assembles the fixed-width field layout mandated by the respective agency, drawing employee, assignment, address, and payroll data from the Oracle HRMS base tables and their APPS synonyms. The package was created in December 2002 and has been maintained through successive EBS releases; the $Header line indicates file version 120.16.12020000.8, last modified in September 2012.

Key Procedures and Functions

The documented interface exposes 58 procedures and functions. They fall into several functional groups:

• Initialization: CHAR_SET_INIT performs package-level setup, establishing character set and delimiter conventions relied upon by the record builders.
• New hire record builders (U.S. states): AL_NEW_HIRE_RECORD, FL_NEW_HIRE_RECORD, IL_NEW_HIRE_RECORD, MI_NEW_HIRE_RECORD, OH_NEW_HIRE_RECORD, PA_NEW_HIRE_RECORD, SC_NEW_HIRE_RECORD, and TX_NEW_HIRE_RECORD each construct the employee-level reporting record for that state's format.
• Header records: SC_HEADER_RECORD and OH_HEADER_RECORD produce the file or batch header segments required by South Carolina and Ohio, respectively.
• New York State forms: NY_1A_RECORD, NY_1E_RECORD, NY_1H_RECORD, NY_1T_RECORD, and NY_1F_RECORD generate the corresponding New York form layouts (e.g., NYS-1-A and related records).
• Canadian records: CA_E4_RECORD, CA_W4_RECORD, and CA_T4_RECORD build the federal/provincial records for Canadian reporting, including the TD1 federal and provincial personal tax credit forms (W4 equivalents) and the T4-type record. TX_T4_RECORD appears in the same family, indicating a T4-related builder used for the Texas/Canadian-aligned or supplemental output.
• Other state builders: Additional state procedures (TX_T4_RECORD, and others catalogued among the 58 entries) complete the portfolio.

The historical change list in the package header documents several behavioral corrections of note: New York 1T and 1F records were adjusted from 118 to 119 characters to accommodate a blank field; hyphens are stripped from Canadian SIT numbers; commas are replaced with spaces for the A03 record; and the new hire cursor was revised to pick up the latest person name. The contact title out-parameter was restricted to 60 characters to comply with agency limits.

Tables Accessed

The package reads from the following documented tables (through APPS synonyms):

• PER_ALL_PEOPLE_F — the primary source of employee personal data (name, national identifiers, date of birth, hire date) used to populate every new hire record.
• PER_ALL_ASSIGNMENTS_F — supplies assignment-level attributes such as hire/start dates and organizational context.
• PER_ADDRESSES — provides home and mailing addresses for the employee, and historically for location addresses.
• PER_JOBS and PER_PAY_BASES — referenced for occupation and pay-rate information required by certain state layouts (for example, wage and job-title fields).
• PER_TIME_PERIOD_TYPES — supports pay-period and frequency values where a jurisdiction requires them.
• HR_SOFT_CODING_KEYFLEX — used to resolve the key flexfield combination describing the employee's assignment or costing context.
• PAY_ELEMENT_ENTRIES_F and PAY_ELEMENT_ENTRY_VALUES_F — read to derive payroll element values where a state record depends on pay input data.

Usage Notes

This package is classified as OTHER in the ETRM repository, meaning it is not a published public API but a supporting utility. It is typically invoked indirectly — for example, from a concurrent program or from the new hire reporting setup within Oracle HRMS — rather than called directly by end users. Customers extending new hire reporting for additional states or modifying existing layouts commonly call the individual record builder procedures from custom PL/SQL, passing a record or out-parameter buffer into which the formatted line is written. Because the package references date-tracked tables such as PER_ALL_PEOPLE_F and PER_ALL_ASSIGNMENTS_F, any custom caller must supply a consistent effective date when selecting assignment and person rows. The package is referenced by two other database objects, confirming its role as a shared reporting utility. When upgrading between 12.1.1 and 12.2.2, the file version noted in the header should be verified, since record lengths and delimiter handling (relevant to the g_delimiter global) have changed across patch levels and directly affect the validity of the generated files.