Search Results validate_gre_data

Overview

APPS.PAY_CA_T4_CANCEL_MAG is a Canadian payroll magnetic media package responsible for generating T4 cancellation transmissions. The package produces the flat-file magnetic media output required to cancel previously submitted T4 slips, most commonly when a T4 return or amended T4 payroll action has been reversed or superseded. The source is declared with AUTHID CURRENT_USER and bears the RCS header pycat4cmag.pkh 120.0 (2011/01/10), placing it within the Canadian year-end payroll family alongside the standard T4 and CAEOY_T4_AMEND_PP report types.

The package operates within the report-generation framework driven by PAY_MAGTAPE_GENERIC, reading runtime parameters such as PAY_ACT (the payroll action being processed) and TRANSMITTER_GRE_ID (the transmitter's Canada Revenue Agency employer identifier). It selects assignments linked to the originating payroll action through PAY_ACTION_INTERLOCKS and payroll_actions processed with action_status of 'C', and formats output records in the transmitted "KEY=VALUE" parameter style used by the magnetic media writer.

Key Procedures and Functions

Thirteen documented program units make up the package. Their responsibilities are:

• GET_REPORT_PARAMETERS — resolves the report-level parameters needed by the magnetic media run.
• RANGE_CURSOR — supplies the assignment action range that the concurrent manager uses to chunk the run.
• ACTION_CREATION — creates or registers the payroll action used to drive the cancellation output.
• VALIDATE_GRE_DATA — the procedure most commonly searched for; it validates that the employer's Gross Reporting Entity (transmitter GRE) information held in HR_ORGANIZATION_INFORMATION is present and consistent before output is produced. This is the key pre-generation data check for the transmitter organization.
• GET_PARAMETER — retrieves a named run parameter through PAY_MAGTAPE_GENERIC.
• GET_ARCH_VAL — extracts archived value sets, used to resolve the tax unit name from FF_ARCHIVE_ITEMS.
• CONVERT_2_XML — converts the assembled records into XML for the magnetic media framework.
• GET_T4_PP_REGNO — returns the T4 pre-printed registration number for the reporting employer.
• T4_CANCEL_MAG_TRANSMITTER — writes the transmitter record for the cancellation file.
• END_OF_FILE — writes the closing section of the file, including totals and counts.
• T4_CANCEL_EMPLOYER_RECORD and T4_CANCEL_EMPLOYER_START — build the employer-level cancellation header and start-of-employer block, including TAX_UNIT_ID and the resolved TAX_UNIT_NAME.
• T4_CANCEL_EMPLOYEE_RECORD — emits the per-employee cancellation slip records.

Tables Accessed

The package reads payroll and HR configuration data rather than maintaining its own tables. PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS are joined to identify the action being cancelled and status 'C' payroll runs; PAY_ACTION_INTERLOCKS links the locking and locked assignment actions so the cancellation trace is complete. HR_ORGANIZATION_INFORMATION supplies the "Fed Magnetic Reporting" flag, the Canada Employer Identification context (org_information5 like '%T4%') and the transmitter GRE identifier (org_information11). HR_ALL_ORGANIZATION_UNITS provides organization-level attributes, while FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEM_CONTEXTS, FF_DATABASE_ITEMS and FF_CONTEXTS resolve archived tax-unit name values. PER_ALL_ASSIGNMENTS_F, PER_ALL_PEOPLE_F and HR_ASSIGNMENT_SET_AMENDMENTS identify the employees and assignment amendments covered by the original T4. PAY_ACTION_INFORMATION and PAY_ASSIGNMENT_ACTIONS_S provide action detail and saved action data, and DUAL is used for scalar retrieval.

Usage Notes

PAY_CA_T4_CANCEL_MAG is invoked through the Canadian year-end magnetic media process rather than called interactively. It is driven by PAY_MAGTAPE_GENERIC, which supplies parameters including PAY_ACT and TRANSMITTER_GRE_ID, and it participates in the range-cursor pattern used by the concurrent manager to partition large runs. Operators typically launch the parent magnetic media concurrent program after reversing or amending a T4 payroll action; VALIDATE_GRE_DATA then runs as the initial guard, preventing file generation when transmitter GRE data is missing or malformed. The package is referenced by zero other PL/SQL packages, so it sits at the execution end of the dependency chain and should be treated as a leaf object. Any customization should prefer wrapping the concurrent program rather than modifying the seeded package body, since the sealed seed version carries the 120.0 release lineage and is validated against EBS 12.1.1 and 12.2.2 online patching.