Search Results trl_global_variables_rec_type

Overview

ZX_EXTRACT_PKG is an Oracle E-Business Suite release 12.1.1 / 12.2.2 PL/SQL package owned by the APPS schema that belongs to the E-Business Tax (EBTax / ZX) product family. It is a core component of the tax reporting extraction infrastructure responsible for populating the tax extract interface tables from which downstream tax reporting, reconciliation, and statutory reporting processes draw their data. The package is classified under the ETRM metadata as an "OTHER" API type, meaning it is not formally published as a public transactional API; it is instead an internal engine used by EBTax reporting functionality.

The source header confirms this role: the principal entry point, populate_tax_data, is documented as "the main procedure of the ZX_EXTRACT_PKG, which populates tax data into tax extract interface tables." The excerpt also exposes the package-level record type TRL_GLOBAL_VARIABLES_REC_TYPE, which the user searched for. This record articulates the full set of reporting parameters — reporting level and context, legal entity, ledger, reporting ledger, register type, product, matrix report flag, detail level, currency ranges, transaction class inclusion flags for both Payables and Receivables, and GL manual line inclusion — that drive a tax extract run. It functions as an in-memory parameter container for the extraction session.

Key Procedures and Functions

The documented public interface exposes thirteen procedures and functions. The most significant are described below.

• POPULATE_TAX_DATA — the primary driver procedure. It reads EBTax transaction and reporting source data and writes the results into the tax extract interface tables, using the reporting parameters described in TRL_GLOBAL_VARIABLES_REC_TYPE.
• SET_RETCODE — sets the standard EBS return code (success, warning, or error) for the calling process.
• APPEND_ERRBUF — appends diagnostic text to the standard error buffer, allowing errors to be accumulated and surfaced to the caller.
• PURGE — removes previously extracted data, typically invoked before a fresh extraction run.
• ZX_UPD_LEGAL_REPORTING_STATUS — updates the legal reporting status associated with a tax reporting entity or registration.
• GET_REP_CONTEXT_ID — resolves the reporting context identifier required to scope reporting queries.
• USE_MATRIX_FLAG — determines whether a matrix-style report applies to the current run.
• GET_LEGAL_MESSAGE — returns the legal message or disclaimer text associated with a report.
• GET_VAT_TRANSACTION_CODE_NAME — retrieves the descriptive name of a VAT transaction code for reporting output.

Tables Accessed

The package operates across the EBTax, Financials, and Trading Community schemas via APPS synonyms.

• ZX_LINES — the primary EBTax tax line table, the core source of extracted tax detail.
• ZX_REP_ACTG_EXT_T and ZX_REP_TRX_DETAIL_T — tax reporting accounting and transaction detail interface tables, the principal write targets.
• GL_LEDGERS, GL_PERIOD_STATUSES, and FND_PRODUCT_GROUPS — ledger, period, and product group context necessary to scope an extract run.
• XLE_ENTITY_PROFILES, XLE_ETB_PROFILES, XLE_REGISTRATIONS — legal entity, establishment, and tax registration data.
• HR_LOCATIONS_ALL, HR_ORGANIZATION_INFORMATION, HZ_PARTIES, HZ_ORG_CONTACTS, HZ_PERSON_PROFILES, HZ_RELATIONSHIPS — party, location, and relationship data used to resolve legal reporting identities and contact details.

Usage Notes

ZX_EXTRACT_PKG is not intended for direct ad-hoc invocation. It is typically called from the EBTax tax reporting concurrent programs and supporting forms, and it is referenced by 25 other packages, indicating a shared internal contract. Customizations that call it should invoke POPULATE_TAX_DATA within the same initialization, extraction, and finalization sequence used by the standard reporting programs, respecting SET_RETCODE and APPEND_ERRBUF conventions and reusing GET_REP_CONTEXT_ID and USE_MATRIX_FLAG to derive consistent reporting scope. Because the package is marked "OTHER" rather than a public API, source-level changes may occur across patch levels (the header indicates version 120.20.12010000.3), so dependent code should avoid assumptions about internal structures beyond the documented procedures.