Results for “pqp_gb_swf_extract”

AI-generated from documented ETRM metadata — verify critical details on the linked pages.

Overview

PQP_GB_SWF_EXTRACT is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified under the ETRM (E-Business Suite Technical Reference Manual) as an "OTHER" API type. It is a United Kingdom localization component within the Oracle Payroll (PQP) product family, and its name reflects the legislative reporting obligations for UK payroll: the "GB" prefix denotes Great Britain, while "SWF" refers to the Summary of Withheld Facts (also historically associated with the P11D/PAYE settlement and Real Time Information reporting streams). The package provides a programmatic extraction utility used to gather payroll processing data and write it out to a flat file for downstream statutory submission, reconciliation, or archival.

The package is reported as VALID in both Oracle EBS 12.1.1 and 12.2.2, and its sole documented dependency outside of APPS is the SYS.STANDARD package, indicating that it does not rely on other custom Oracle payroll APIs for its core logic and interacts with the database primarily through the standard PL/SQL runtime plus the listed schema objects.

Key Procedures and Functions

ETRM documents exactly one callable subprogram within PQP_GB_SWF_EXTRACT:

• XML_EXTRACT — the entry point that performs the extraction of payroll-related data and renders it in an XML-structured format suitable for statutory or operational output. Its name indicates that the extraction is serialized as XML rather than as a fixed-width or delimited text file, which aligns with contemporary HMRC electronic reporting formats.

No parameter signatures are published in the available metadata; the procedure should be invoked only in the manner prescribed by the originating Oracle documentation or the calling concurrent program definition.

Tables Accessed

The package references the following tables (via APPS synonyms), each serving a distinct role in the extraction pipeline:

• PAY_PAYROLL_ACTIONS — the master record of a payroll run; identifies which payroll action is being extracted.
• PAY_ASSIGNMENT_ACTIONS — the per-assignment results of a payroll action, providing the population of employees included in the run.
• PAY_ACTION_INFORMATION — the balance and value information associated with the action, supplying the monetary figures reported in the extraction.
• AD_FILES and AD_FILE_VERSIONS — Oracle Application Object Library tables used to register and version the generated output file in the file repository.
• UTL_FILE — the Oracle-supplied PL/SQL package used to physically write the extracted XML content to a directory on the database server.
• DUAL — the standard single-row pseudo-table, used for trivial scalar evaluation and control logic.

Usage Notes

PQP_GB_SWF_EXTRACT is referenced by no other documented package, which indicates it sits at the outer edge of the dependency chain rather than acting as a shared utility. It is therefore most commonly invoked either directly by a concurrent program registered under the UK Payroll responsibility, or from custom PL/SQL where a statutory UK payroll extract is required. Because it writes via UTL_FILE, the target directory must be a valid, reachable Oracle DIRECTORY object with appropriate grants to the APPS schema, and the file must subsequently be retrieved from the application or database server tier for submission. When the extraction is triggered from a standard Oracle concurrent program, the AD_FILES/AD_FILE_VERSIONS entries allow the output to be located through the standard file management screens. Customers extending the package should treat XML_EXTRACT as the supported interface and avoid calling internal, undocumented helpers, since only this procedure is exposed in ETRM.