Search Results get_parameter

Overview

APPS.PAY_ZA_TAX_REG_AR is a legislative PL/SQL package body shipped as part of the Oracle E-Business Suite Payroll module for South Africa (ZA). Its principal business purpose is to supply the data extraction and reporting logic behind the South African Tax Register Report, a statutory report produced from Oracle Payroll that consolidates employee-level tax-related balances for a payroll period. The package follows the standard Oracle Reports integration pattern used by legislative reporting: it exposes BEFOREREPORT and AFTERREPORT hooks that initialize and tear down session state, a RANGE_CURSOR function that supplies a query result set to the report, and archive lifecycle routines (ARCHINIT, ARCHIVE_CODE, DEINIT_CODE) for the Payroll Action Information archiving mechanism.

Although the ETRM registry classifies the object as OTHER, the source excerpt identifies it as PAY_ZA_TAX_REG_AR with an internal package global string declared as pay_za_tax_reg_rep., indicating an XML Publisher (BI Publisher) oriented report implementation. The package also carries a legislative-parameter parsing utility, GET_PARAMETER, which is directly relevant to the user's search term.

Key Procedures and Functions

• BEFOREREPORT — Initialization entry point invoked by the report before the main query executes. It is responsible for parsing the legislative parameter string passed by the concurrent program, populating package-level globals (payroll, period, sort criteria, and debug flags), and preparing the session for report execution.
• AFTERREPORT — Cleanup routine executed after the report completes, releasing package globals and any session context established during the run.
• RANGE_CURSOR — Supplies the primary data set to the report. It returns the tax register rows drawn from assignments, payroll actions, and the permanent tax register store.
• ACTION_CREATION — Creates the payroll action record associated with the legislative reporting run, allowing the report parameters to be stored against a PAY_PAYROLL_ACTIONS row.
• ARCHINIT — Initializes the archiving context for Payroll Action Information, opening the archive buffer prior to row emission.
• ARCHIVE_CODE — Performs the actual archive write, persisting the legislative parameter payload so the run can be reproduced.
• DEINIT_CODE — Terminates the archiving context and flushes remaining state.
• GET_PARAMETER — The private helper the user searched for. It accepts a full legislative parameter string and a token, then returns the value associated with that token by scanning for the delimiter and extracting the substring. It underpins all parameter-driven behaviour in BEFOREREPORT, including the legal entity parameter added in version 120.0.12010000.3–.5 under Bug 16174886.

Tables Accessed

The package reads or writes the following documented tables through APPS synonyms: PAY_PAYROLL_ACTIONS (source of the legislative parameter string and target of ACTION_CREATION), PAY_ACTION_INFORMATION (archived parameter storage), PAY_ALL_PAYROLLS_F and PER_TIME_PERIODS (payroll and period validation and period date resolution), PER_ALL_ASSIGNMENTS_F (assignment-level report rows), PAY_ASSIGNMENT_ACTIONS and PAY_ASSIGNMENT_ACTIONS_S (assignment action detail), PAY_ZA_TAX_REGISTERS (the permanent South African tax register store), PER_ASSIGNMENT_EXTRA_INFO (legislative assignment attributes), HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION (legal entity and organisation resolution), FND_CONCURRENT_REQUESTS (concurrent request context), and DUAL for scalar evaluation.

Usage Notes

The package is not a public API and is referenced by no other packaged objects. It is invoked exclusively through the South African Tax Register concurrent program and its XML Publisher template. The concurrent program supplies a legislative parameter string containing the payroll, start and end periods, sort options, print-detail flag, debug flag, and the legal entity identifier; GET_PARAMETER dissects this string during BEFOREREPORT. Because the parameter format is positional and delimiter-based, any customisation that adds a new legislative parameter must extend the delimiter grammar and be registered in the concurrent program definition; otherwise GET_PARAMETER returns null for the unknown token. The package is version-tracked at 120.1.12020000.3, compatible with both EBS 12.1.1 and 12.2.2, and should be treated as closed for direct invocation by custom code.