Search Results get_report_parameters

Overview

APPS.PAY_CA_MAG_ROE is a Canadian localization package body within the Oracle E-Business Suite Payroll module. Its purpose is to support the generation of the Record of Employment (ROE), a statutory document that Canadian employers must issue to employees upon interruption of earnings. The package encapsulates the data-extraction and parameter-resolution logic required by the ROE concurrent program, insulating the report from the underlying HRMS payroll data model. It resolves legislative parameters, user entities, and assignment populations for the specified payroll action, then exposes those values to the calling report. The header comment (pycaremg.pkb 120.0) indicates the package has been stable since the 11i era and is carried forward unchanged into EBS 12.1.1 and 12.2.2.

Key Procedures and Functions

The ETRM metadata documents two callable units, though the source excerpt also reveals the supporting logic they depend upon.

• GET_REPORT_PARAMETERS — The procedure most commonly associated with the search term "get_report_parameters." It accepts a payroll action identifier and returns the reporting period boundaries, the person identifier, and the assignment set for which the ROE is being produced. It queries PAY_PAYROLL_ACTIONS for the action and decodes the legislative parameter string using PAY_CORE_UTILS.GET_PARAMETER to extract PERSON_ID and ASSIGNMENT_SET values.
• RANGE_CURSOR — A cursor construct used to drive the population of assignments included in the ROE run, working in conjunction with population range definitions.
• CREATE_ASSIGNMENT_ACT — Creates assignment action rows, writing the assignment-level records that the ROE process subsequently consumes.

The body additionally defines FUN_USER_ENTITY_ID, a helper that returns the FF_USER_ENTITIES identifier for a given user entity name restricted to legislation code 'CA'.

Tables Accessed

• PAY_PAYROLL_ACTIONS — Source of the payroll action being reported, including start/effective dates and the legislative parameters string.
• PAY_ASSIGNMENT_ACTIONS / PAY_ASSIGNMENT_ACTIONS_S — Read and written to establish and retrieve the assignment-level actions belonging to the run.
• PAY_ACTION_INTERLOCKS — Governs processing order and linkage between related payroll actions.
• PAY_POPULATION_RANGES — Defines the population ranges used to select assignments.
• FF_USER_ENTITIES — Provides the Canadian user entity identifier.
• FF_ARCHIVE_ITEMS — Supports archival of the ROE output.
• DUAL — Used for trivial single-row evaluations.

Usage Notes

PAY_CA_MAG_ROE is invoked indirectly. The ROE concurrent program calls GET_REPORT_PARAMETERS to obtain its runtime parameters before executing the report query. Assignment action creation is triggered as part of the normal payroll action lifecycle for Canadian payrolls, ensuring the ROE dataset is materialized. Because the package is classified as OTHER rather than a public API, and because the ETRM metadata records zero referencing packages, direct invocation from custom code is discouraged. Customers extending ROE behavior should prefer supported payroll APIs; any direct call must supply a valid payroll_action_id and handle the NOCOPY OUT parameters correctly. The package is legislation-specific and should never be called against non-Canadian business groups.