Search Results spawn_archive_reports

Overview

PAY_AU_RECONCILIATION_PKG is an Oracle E-Business Suite payroll package owned by the APPS schema and classified as OTHER in the ETRM repository. Its purpose is to support Australian payroll reconciliation reporting, providing the calculation logic and concurrent program hooks required to derive the earnings, tax, deduction, and payment balances that appear on Australian reconciliation and payment summary style reports. The package exposes both a point-in-time balance API (GET_AU_REC_BALANCES) and a year-to-date counterpart (GET_YTD_AU_REC_BALANCES), and it also implements the standard Oracle Payroll archive/range "code" procedures used by the report generation framework (RANGE_CODE, INITIALIZATION_CODE, ASSIGNMENT_ACTION_CODE, ARCHIVE_CODE). The header comment (pyaurecs.pkh 120.0) indicates the specification has been stable since the 11i era and continues to be shipped in 12.1.1 and 12.2.2 without functional change.

Key Procedures and Functions

The documented package contains nine procedures:

• GET_AU_REC_BALANCES — Returns the in-period reconciliation amounts for a single assignment action: gross earnings, non-taxable earnings, pre-tax deductions, taxable earnings, tax, deductions, direct payments, net payment, and employer charges. It accepts an assignment action identifier and a registered employer discriminator.
• GET_YTD_AU_REC_BALANCES — Returns the same set of measures on a year-to-date basis, allowing the reconciliation report to show both current-period and cumulative figures.
• POPULATE_DEFINED_BALANCE_IDS — Populates the internal defined-balance identifier collections used by the balance retrieval routines, driven by a YTD flag and the registered employer.
• RANGE_CODE — Builds the SQL range predicate (returned as a VARCHAR2) that the Oracle Payroll report framework uses to restrict the assignment action set processed by the concurrent program.
• INITIALIZATION_CODE — Performs one-time setup for a payroll action run, invoked by the payroll action framework at the start of processing.
• ASSIGNMENT_ACTION_CODE — Executes the package logic for each assignment action selected within the range returned by RANGE_CODE.
• ARCHIVE_CODE — Writes the normalised reconciliation rows into the archive table consumed by the report layout stage.
• SPAWN_ARCHIVE_REPORTS — Submits the child concurrent requests that produce the archived reconciliation output, using report format and mapping definitions to determine the correct report and parameters.
• CHECK_REPORT_PARAMETERS — Validates the concurrent program parameters (for example registered employer, payroll, or period) before the run proceeds.

Tables Accessed

The package reads and writes the core Oracle Payroll tables through APPS synonyms. PAY_PAYROLL_ACTIONS, PAY_ASSIGNMENT_ACTIONS, and their _S shadow tables provide the payroll action and assignment action context that drives range selection and archive processing. PAY_ACTION_INFORMATION and PAY_ACTION_INFORMATION_S hold the action-level parameters and registration details used by INITIALIZATION_CODE and CHECK_REPORT_PARAMETERS. The balance engine is reached through PAY_DEFINED_BALANCES, PAY_BALANCE_TYPES, PAY_BALANCE_DIMENSIONS, and the PAY_BALANCE_PKG collections referenced in the specification, which supply the balance values returned by the GET_*_AU_REC_BALANCES procedures. Employee and legislative context come from PER_ALL_PEOPLE_F and HR_ALL_ORGANIZATION_UNITS, while HR_SOFT_CODING_KEYFLEX supports costing-related reconciliation columns and FND_CURRENCIES resolves currency attributes. PAY_POPULATION_RANGES drives range generation, PAY_REPORT_FORMAT_MAPPINGS_F determines the report format used by SPAWN_ARCHIVE_REPORTS, and FND_CONCURRENT_REQUESTS is queried to monitor or link the child requests submitted by that procedure.

Usage Notes

PAY_AU_RECONCILIATION_PKG is not normally called directly by end users. It is invoked by the Oracle Payroll action framework when the Australian reconciliation concurrent program is run: the framework calls CHECK_REPORT_PARAMETERS, INITIALIZATION_CODE, and RANGE_CODE to establish the run, ASSIGNMENT_ACTION_CODE to process each assignment action, ARCHIVE_CODE to persist the results, and SPAWN_ARCHIVE_REPORTS to launch the output reports. Because it references PAY_REPORT_FORMAT_MAPPINGS_F and FND_CONCURRENT_REQUESTS, the report format configuration must be reviewed after any cloning or patching activity. The package is referenced by one other package in the ETRM repository, and custom code that needs Australian reconciliation balances should call GET_AU_REC_BALANCES or GET_YTD_AU_REC_BALANCES rather than querying balances directly, since these routines encapsulate the correct treatment of non-taxable earnings, pre-tax deductions, direct payments, and employer charges. The NOCOPY hints on the OUT parameters confirm the procedures are designed for efficient PL/SQL-to-PL/SQL invocation.