Search Results fetch_xml

Overview

PAY_IN_SOE is an Oracle EBS PL/SQL package owned by the APPS schema and classified under the ETRM taxonomy as an "OTHER" API — that is, it is not a published public API with a guaranteed interface, but rather an internal implementation package used by Oracle Payroll functionality. The name follows the "SOE" (Statement of Earnings) naming convention, and in Oracle Payroll the SOE framework is the mechanism by which payslip and payment-related documents are generated, formatted, and delivered to employees and third parties. The package is documented as VALID in both EBS 12.1.1 and 12.2.2, and its dependency footprint confirms that it sits in the payroll action-processing and document-generation layer of the application rather than in the core payroll calculation engines.

Its primary business role is to support the extraction of payroll statement-of-earnings data into XML, and to submit and load that XML through the concurrent manager infrastructure. It therefore bridges payroll run results, employee/assignment master data, and the output-generation stack used for payslip distribution.

Key Procedures and Functions

• GET_TEMPLATE — Retrieves the applicable template definition used to drive the formatting of the statement-of-earnings output.
• FETCH_XML — Retrieves the generated XML payload for the statement, typically for a specified payroll action or assignment context.
• GET_EMP_ADDRESS — Returns the employee's address information, sourced from PER_ADDRESSES, for inclusion in the generated document.
• GET_EMP_EMAIL — Returns the employee's e-mail address, used when the statement is delivered electronically.
• SUBMIT_REQ_XML_BURST — Submits a concurrent request that generates the XML in burst mode, allowing multiple statements to be produced and split in a single run.
• LOAD_XML — Loads a generated XML document, typically as part of the inbound processing or persistence step after generation.
• LOAD_XML_BURST — Performs the equivalent load operation in burst mode, handling multiple XML documents produced by a single burst submission.

Tables Accessed

• PAY_PAYROLL_ACTIONS and PAY_ASSIGNMENT_ACTIONS — Identify the payroll run and the individual assignment-level actions for which statements are produced.
• PAY_ACTION_INFORMATION and PAY_ACTION_INTERLOCKS — Provide action-level detail and interlock state information controlling what output may be generated.
• PER_ADDRESSES — Source of employee address data used by GET_EMP_ADDRESS.
• FND_CONCURRENT_REQUESTS — Tracks the concurrent requests submitted for XML burst generation.
• FND_APPLICATION, FND_APPLICATION_TL, FND_PRODUCT_INSTALLATIONS — Standard Application Object Library lookups used for localization and installation status.
• DBMS_LOB and DBMS_SQL — Used for large-object handling of XML content and dynamic SQL execution, respectively.

Usage Notes

PAY_IN_SOE is not a general-purpose integration API and is referenced by zero other packages, which confirms it is a terminal, self-contained implementation unit within Oracle Payroll. It is invoked indirectly through standard payroll statement-of-earnings processing and concurrent program submission rather than through direct customer-facing calls. Customizations should not depend on its signature, as it falls outside Oracle's supported public API set. Where customers require SOE output, the supported route is through the standard Oracle Payroll payslip/statement configuration and the associated concurrent programs, with PAY_IN_SOE acting as an internal engine behind that flow.