Search Results write_line

Overview

APPS.PQP_GB_SWF_EXTRACT is an Oracle E-Business Suite PL/SQL package body that supports the statutory School Workforce Census (SWF) extraction for United Kingdom payroll and HR customers. The SWF census is a Department for Education (DfE) data return collected annually from Local Authorities (LAs) and schools, reporting on teaching and support staff headcount, absence, qualifications, and related personnel attributes. This package assembles the structured XML output required by the census, reading payroll and assignment data held in the Oracle HRMS and Oracle Payroll schema, and writing the resulting file(s) to a directory on the database server.

The package is versioned for 12.1.1 and 12.2.2 and is labelled "noship," indicating it is not shipped as a standard seeded object but is delivered through a patch or an ETRM-referenced fix (the header cites Bug#12586059, which governs multiple data-return variants). Its internal constants and globals—such as census year, census date, LEA number, establishment number, data return type, IANA character set, and output file handle—reflect an extraction driven by a concurrent request and a payroll action.

Key Procedures and Functions

The documented procedure list contains one entry: XML_EXTRACT. This is the driver procedure that orchestrates the census output. It is responsible for populating the package-level globals (census year, request id, payroll action id, LEA and establishment numbers, exclusion flags for absence and qualifications, and the file handle) and for producing the required data-return file according to the type selected (TYPE1, TYPE1A, TYPE1B, TYPE2, TYPE3, or TYPE4, which determine single or multiple file output and the naming convention LEA_<LEA number>.<req_id> or EST_<EST number>.<req_id>).

The body additionally contains internal helper routines required by the extraction logic. The most significant of these is WRITE_LINE, which formats individual XML elements. WRITE_LINE accepts a tag type ('O' for open, 'C' for close, and a value form), a tag name, and a tag value, constructs the corresponding XML fragment, and writes it out. Because WRITE_LINE is not listed among the documented procedures, it should be treated as a private utility internal to the package rather than a public entry point.

Tables Accessed

The package reads from and writes to the following documented APPS synonyms:

• PAY_PAYROLL_ACTIONS — provides the payroll action context (g_payroll_action_id, g_request_id) that scopes the census run.
• PAY_ACTION_INFORMATION — supplies the action-information values from which XML tag content (l_data in WRITE_LINE) is drawn.
• PAY_ASSIGNMENT_ACTIONS — links payroll actions to the assignment (person) records included in the return.
• AD_FILES and AD_FILE_VERSIONS — used to resolve and record the output file and its version metadata within the concurrent manager file framework.
• UTIL_FILE — the Oracle-supplied file I/O package (UTL_FILE) used to open, write, and close the census output file through g_file_handle.
• DUAL — used for scalar evaluation and context lookups.

Usage Notes

PQP_GB_SWF_EXTRACT is not a general-purpose API and is not referenced by any other package in the ETRM inventory (referenced by 0 other packages). It is invoked in the context of the School Workforce Census extraction process, typically through a concurrent program or a payroll action submitted from the Oracle EBS Payroll responsibility. At runtime it depends on a valid output directory on the database server (g_output_dir) and appropriate UTL_FILE directory permissions. Because the package is not shipped, it may be applied by patch or custom extension; implementers should confirm the exact patch level before relying on a specific data-return type or the WRITE_LINE behaviour referenced in the search term.