Search Results format_data

Overview

PAY_CA_YEER_PKG is an Oracle Application Object Library (APPS) package body that belongs to the Oracle Payroll (PAY) product family, specifically addressing Canadian legislative payroll reporting. Its documented purpose is to support the "Elements Reports," generating output files in a user-specified format. The supported output formats identified in the package header are HTML and CSV. The package derives its abbreviated name from "YEER," which in the Canadian payroll context corresponds to the Year-End Electronic Report (YEER), the reconciliation and reporting deliverable that employers must produce to satisfy Canada Revenue Agency requirements.

The business function of the package is therefore to assemble the Canadian year-end reporting data set from payroll processing results and to render that data into a structured, printable or transmittable file. The extensive change history embedded in the package body demonstrates an incremental evolution of the report content, with adjustments over time to the treatment of Canada Pension Plan (CPP) and Quebec Pension Plan (QPP) values, eligible pay periods, basic exemption amounts, multiple-jurisdiction reasons, and negative balance lines. The package is classified in ETRM as an "OTHER" API, indicating that it is not part of the published, supported PL/SQL API surface but rather an internal implementation object owned by APPS.

Key Procedures and Functions

The ETRM metadata documents two procedures or functions within this package body: PIER_YEER and VALIDATESIN.

• PIER_YEER — This is the principal entry point that produces the year-end report output. It drives the extraction, formatting, and file emission logic that yields the HTML or CSV report, applying the report conventions reflected in the package's change history (for example, omitting QPP from federal totals and printing balance names for negative balances).
• VALIDATESIN — A validation routine. Its name suggests it validates a Social Insurance Number (SIN) value supplied to the reporting process, which is consistent with the Canadian year-end reporting domain where SIN correctness is a compliance requirement.

No parameter lists are documented in the ETRM metadata and none are asserted here. Additional internal helper routines beyond these two are not enumerated in the documented metadata.

Tables Accessed

The package reads from a broad set of APPS synonyms spanning payroll archive, element, organization, and tax tables. Documented references include:

• FF_ARCHIVE_ITEMS, FF_ARCHIVE_ITEM_CONTEXTS, FF_CONTEXTS — FastFormula archive and context data holding the archived payroll calculation results used as report input.
• FF_DATABASE_ITEMS — Database item definitions referenced when resolving archived formula values.
• FND_LOOKUP_TYPES, FND_LOOKUP_VALUES — Application lookups used for code-to-meaning translation and report labeling.
• HR_ALL_ORGANIZATION_UNITS, HR_LOCATIONS_ALL, HR_ORGANIZATION_INFORMATION, HR_SOFT_CODING_KEYFLEX — Organization unit, location, organizational classification, and soft-coding key flexfield data used to identify and describe the employing entities and jurisdictions in the report.
• PAY_ACTION_INFORMATION, PAY_ASSIGNMENT_ACTIONS — Payroll action and assignment action records establishing which assignments and payroll runs are in scope.
• PAY_BALANCE_TYPES, PAY_BALANCE_TYPES_TL — Balance definitions and their translated names, used to label amounts and to identify negative balances.
• PAY_CA_EMP_FED_TAX_INFO_F — The Canadian employee federal tax information table, supplying federal tax and related legislative attributes for the reporting period.

Usage Notes

PAY_CA_YEER_PKG is not referenced by any other documented package, confirming that it is a terminal, report-oriented object rather than a reusable library. It is typically invoked in one of two ways: by a concurrent program or report in the Oracle Payroll Canadian legislative set that requires year-end output in HTML or CSV, or indirectly by the Oracle XML Publisher / BI Publisher pipeline where the package prepares the data and file content. Custom code should not call this package directly, both because it is classified as an "OTHER" API and because its parameters and internal cursors are not part of a supported interface. Integrators needing year-end Canadian payroll data should prefer the supported payroll archive and balance extraction mechanisms, and treat PAY_CA_YEER_PKG strictly as Oracle's internal implementation of the standard year-end report generation.