Search Results get_rl1_message

Overview

PAY_CA_RL1_REG is an Oracle EBS payroll package owned by the APPS schema, classified as a non-API (OTHER) component. Its name associates it with the Canadian legislative reporting family — specifically the RL-1 (Relevé 1) slip, the Quebec provincial year-end tax reporting form that parallels the federal T4. The package corresponds to the RL-1 register, the formatted statement output that lists each employee's RL-1 amounts at year-end.

Functionally, the package provides the procedural logic behind the generation and formatting of RL-1 register output. It composes the individual employee entries that appear on the register, resolves the message text, labels, and address or parameter data that appear on the printed form, and drives range-based selection of assignment and payroll action data. It is one element of the broader PAY_CA_* suite of Canadian payroll reporting objects, and its metadata confirms a status of VALID in both 12.1.1 and 12.2.2.

Key Procedures and Functions

ETRM documents eight procedures and functions within the package. Their documented names indicate the following purposes:

• RANGE_CURSOR — defines or exposes the cursor used to select the population or reporting range processed for the RL-1 register.
• ACTION_CREATION — creates the payroll/assignment action records associated with the RL-1 run.
• SORT_ACTION — orders or sequences the action records produced for consistent register output.
• GET_PARAMETER — retrieves a configured parameter value used during register generation.
• GET_RL1_MESSAGE — returns the RL-1 message text displayed or printed on the slip or register.
• GET_PRIMARY_ADDRESS — resolves the primary address (employee or organizational) used on the RL-1 output.
• GET_LABEL — returns the descriptive label associated with an RL-1 box or field.

Parameter lists are not documented in the ETRM extract and are deliberately not reproduced here.

Tables Accessed

The package reads and writes through APPS synonyms. Payroll and action data come from PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and PAY_ASSIGNMENT_ACTIONS_S; range definitions come from PAY_POPULATION_RANGES. Employee and assignment context is drawn from PER_ADDRESSES, PER_PERIODS_OF_SERVICE, HR_ASSIGNMENT_SET_AMENDMENTS, and HR_ORGANIZATION_INFORMATION. Reference and configuration data are read from FND_LOOKUP_VALUES, FF_DATABASE_ITEMS, and PAY_REPORT_FORMAT_MAPPINGS_F, while DUAL supports scalar lookups. These tables supply the population selection, address resolution, action creation, label and message lookup, and formatting mappings required to produce the RL-1 register.

Usage Notes

PAY_CA_RL1_REG is not an end-user API. It is invoked indirectly by Canadian year-end processing, principally from PAY_CA_RL1_MAG (the RL-1 magnetic media and register driver), and it is also referenced by PAY_CA_EMP_ADDRESS_DTLS, PAY_CA_EOY_ARCHIVE, and PAY_CA_T4_XML — the latter reflecting shared address and formatting logic with the T4 XML process. The package is referenced by seven other packages in total.

Custom code should not call these procedures directly unless the calling program replicates the RL-1 driver context. Because the procedures operate on payload and action state, they must be executed within the standard year-end RL-1 concurrent program flow. Migration or upgrade effort should verify the package remains VALID after patching, since dependent year-end and T4 XML programs fail if it becomes invalid.