Search Results set_retcode

Overview

JGRX_WT is an Oracle E-Business Suite PL/SQL package owned by APPS that implements the generic withholding tax extraction framework used by Oracle Payables and its regional localization extensions. Its principal business function is to populate the interface table JG_ZZ_AP_WHT_ITF with withholding tax data that is subsequently consumed by Oracle Reports and regional reporting programs. The package is declared AUTHID CURRENT_USER, meaning that all unqualified object references are resolved in the schema of the invoker rather than the owner, a design choice that allows the package to operate correctly across multiple operating units and legal entities configured within Payables.

The header comment (jgrxwts.pls 120.6) identifies the package as the core generic withholding tax routine. Its architecture separates generic extraction logic from country-specific plug-ins, of which the Korean withholding tax report is the documented example. Because the package exposes a hook-based report lifecycle—before report, bind, and after fetch—it functions as a reusable reporting engine rather than a standalone application.

Key Procedures and Functions

• GET_WITHHOLDING_TAX — The core generic routine that populates JG_ZZ_AP_WHT_ITF. It drives the report lifecycle by internally calling the before-report routine to construct the base SELECT statement and the bind routine to bind report variables.
• JG_WHT_EXTRACT — The Korean withholding tax plug-in. It invokes the generic GET_WITHHOLDING_TAX procedure and supplies country-specific behavior at each stage of the report.
• SET_RETCODE — Sets the completion status returned to the calling concurrent program, populating the retcode and error buffer outputs. This is the procedure most closely associated with the search term "set_retcode" and is the standard mechanism by which the extraction communicates success or failure to the concurrent manager.
• APPEND_ERRBUF — Appends a message to the error buffer, allowing multiple diagnostic messages to accumulate without overwriting earlier entries.
• BEFORE_REPORT — Generic before-report hook that constructs the basic SELECT statement used to drive the extraction.
• WHT_BEFORE_REPORT — Withholding-tax-specific before-report routine that adds conditions required by the localization (for example, Korean-specific selection criteria).
• WHT_BIND — Binds the report parameters and variables into the dynamic SQL statement.
• WHT_AFTER_FETCH — Performs row-level manipulation on each fetched record, applying regional transformations after data retrieval.
• GET_LOOKUP_MEANING — Resolves an Oracle lookup code to its displayed meaning, used to translate coded values appearing in the extracted withholding tax records.

Tables Accessed

• AP_SYSTEM_PARAMETERS_ALL — Supplies Payables system options and defaults, including the setup context required to drive the extraction.
• AP_INVOICE_DISTRIBUTIONS_ALL — Provides invoice distribution lines that carry the withholding tax amounts and tax attributes subject to extraction.
• DBMS_SQL — The dynamic SQL package used to construct, parse, bind, and execute the SELECT statement assembled by the before-report and bind routines.
• PLITBLM — The PL/SQL table and buffer management package used to hold and manipulate extracted rows and error text during processing.

Usage Notes

JGRX_WT is designed to be invoked as a concurrent program, most commonly through the Oracle Reports executable that triggers the generic withholding tax extract or the Korean variant. The retcode and errbuf output parameters follow the standard Oracle Applications concurrent program interface: the calling concurrent manager reads these values to determine request completion status, which is why the SET_RETCODE procedure is central to the package's contract with its callers. The package is referenced by one other package within the APPS schema, indicating reuse by a dependent program unit.

Custom code should not call the plug-in routines directly. The supported extension pattern is to model a new country implementation on JG_WHT_EXTRACT: call the generic GET_WITHHOLDING_TAX routine and supply localization-specific logic in the before-report, bind, and after-fetch hooks. Because the package is AUTHID CURRENT_USER, any schema invoking it must hold direct privileges or synonyms on the APPS tables and packages it references.