Search Results get_arch_val

Overview

The APPS.PAY_CA_T4A_MAG package body is a Canadian payroll legislative reporting component within Oracle E-Business Suite, supporting the generation of the T4A tax slip (Statement of Pension, Retirement, Annuity, and Other Income) and related magnetic media output. It operates within both the 12.1.1 and 12.2.2 release lines, drawing its data from Oracle Payroll and Oracle Human Resources core tables. The package encapsulates the business logic required to retrieve payroll action parameters, resolve legislative and assignment-level details, compute T4A reporting amounts and footnotes, and render output into the XML structure expected for T4A slip and magnetic media filing.

The package is classified as OTHER in the ETRM repository and exposes 11 documented procedures and functions. It is referenced by one other package, indicating it is a subordinate component invoked by a parent reporting driver rather than a standalone entry point. Its operations are tightly coupled to the payroll action model, using PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS as the anchor records for a given report run.

Key Procedures and Functions

• GET_REPORT_PARAMETERS — Retrieves the parameters for which the T4A report is being run from PAY_PAYROLL_ACTIONS, including the period start and end dates, business group, report type, and legislative parameters.
• RANGE_CURSOR — Defines the driving cursor that establishes the range of assignments or rows to be processed during the report run.
• CREATE_ASSIGNMENT_ACT — Creates or processes an assignment action record associated with the T4A reporting activity.
• GET_PARAMETER — Resolves a named parameter value for the report, typically surfaced through the payroll action information or legislative parameters.
• GET_T4A_PP_REGNO — Returns the payee/payer registration number required on the T4A slip.
• GET_T4A_FOOTNOTE_AMOUNTS — Computes the amounts reported in the footnotes of the T4A slip.
• VALIDATE_GRE_DATA — Validates Government Remittance/Reporting data prior to output generation.
• GET_DBITEM_VALUE — Retrieves a value for a specified database item, often used in conjunction with FF_DATABASE_ITEMS.
• CONVERT_2_XML — Converts the assembled reporting data into XML for output.
• CONVERT_T4A_OTH_INFO_AMT — Converts or formats the "Other Information" amounts on the T4A slip.
• GET_ARCH_VAL — The function matching the user's search term; it retrieves an archived value, typically reading from the FF_ARCHIVE_ITEMS table to return the historical or archived value of a payroll/legislative element when the live value is not available or when a specific effective snapshot is required.

Tables Accessed

The package reads from PAY_PAYROLL_ACTIONS to obtain report parameters and from PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S to resolve assignment-level actions. Person and assignment details come from PER_ALL_PEOPLE_F and PER_ALL_ASSIGNMENTS_F. Organization context is drawn from HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION. Legislative and archival values are sourced from FF_DATABASE_ITEMS and FF_ARCHIVE_ITEMS, which underpin GET_ARCH_VAL and GET_DBITEM_VALUE. PAY_ACTION_INTERLOCKS and PAY_ACTION_INFORMATION provide ancillary report and interlock data, while DUAL and PLITBLM support utility operations. No direct writes to business tables are documented beyond any action creation performed by CREATE_ASSIGNMENT_ACT.

Usage Notes

PAY_CA_T4A_MAG is invoked indirectly through the Canadian payroll year-end reporting flow rather than called directly from a form. It is triggered by the parent package that drives T4A magnetic media and slip production, receiving the payroll_action_id from the standard payroll report submission (PYUGEN) process. Customizations should avoid calling internal procedures out of sequence, since report parameters and cursors are established during initialization. The GET_ARCH_VAL function is commonly referenced when archived legislative values must be retrieved for a historical reporting period, ensuring the T4A output reflects the values in effect at the time of the original payroll run rather than current balances.