Search Results p_sort_order_4

Overview

APPS.PAY_PYNZSOE_XMLP_PKG is the Oracle E-Business Suite PL/SQL package body that backs the New Zealand "Statement of Earnings" (SOE) XML Publisher concurrent program. It is registered under the APPS schema with an API classification of OTHER, meaning it is a report-support package rather than a public business API. Its principal responsibility is to supply runtime parameters, derived values, and formatted columns to the XML Publisher report definition.

The package implements the standard Oracle Reports/PUBLISHER integration contract: a BeforeReport function performs initialisation and returns a boolean to signal success or failure, while the body also exposes formatted formula columns and user-exit style routines that the report layout invokes at execution time. The USER_EXIT_FAILURE exception declared at the top of the body is raised when initialisation fails, allowing the concurrent manager to report an error rather than producing a malformed output.

Key Procedures and Functions

Thirty-two procedures and functions are documented. The core entry points are BEFOREREPORT and AFTERREPORT, which bracket report execution and handle parameter resolution and cleanup respectively.

The formula functions supply computed and display-ready values to the report template:

• F_GET_DETAILSFORMULA, F_GET_CUMULATIVE_LEAVE_BALFORM — detail-line retrieval and cumulative leave balance calculation for the earnings statement.
• CF_AMOUNT_PAIDFORMULA, CF_NET_THIS_PAYFORMULA, CF_NET_YTDFORMULA — payment amount, net pay for the current period, and net pay year-to-date.
• CF_GET_MISCELLANEOUS_VALUESFOR, CF_CURRENCY_FORMAT_MASKFORMULA — miscellaneous earnings/deduction values and the currency display mask.
• CP_NON_TAX_ALLOW_THIS_PAY_P, CP_NON_TAX_ALLOW_YTD_P, CP_GROSS_YTD_P — non-taxable allowance (current and year-to-date) and gross year-to-date.

Address and positional data are supplied by the P_ADDRESS_LINE_1_P, P_ADDRESS_LINE_2_P, P_ADDRESS_LINE_3_P, P_TOWN_CITY_P, P_POSTCODE_P, P_COUNTRY_P, and P_POSITION_NAME_P functions, which format the employee's mailing address and job title for the New Zealand statutory layout. The grouped function G_ASG_PAYMENTS_BREAK_GGROUPFIL implements the assignment-level payment break grouping that drives report sectioning.

Tables Accessed

The package reads two APPS synonyms. PAY_PAYROLL_ACTIONS is queried in BeforeReport to resolve the payroll action identifier into a business-readable action type via HR_LOOKUPS, and to derive the payment-run context. The payroll name itself is resolved from PAY_PAYROLLS_F using the P_PAYROLL_ID parameter.

FND_CURRENCIES supplies currency precision and formatting attributes used by the currency format mask formula. The package does not appear to write to any table; it is a read-only reporting helper.

Usage Notes

This package is not intended for direct invocation from custom code. It is executed exclusively through the Oracle EBS concurrent program that drives the NZ Statement of Earnings XML Publisher report, typically submitted from the Payroll or Payment processes in the New Zealand localisation. The user parameter p_sort_order_4, visible in BeforeReport, is one of four sequence parameters allowing the submitter to control report ordering; when set to the literal value FULL_NAME it is translated at runtime to nvl(order_name, full_name) so that employees known by an ordering name sort correctly.

The cp_where_clause and cp_order_by package globals are assembled dynamically from the incoming parameters before being passed to the report query, so any extension of the WHERE or ORDER BY logic must preserve the leading whitespace convention used in the body. Because the package is documented as referenced by zero other packages, it can be modified with limited regression scope, though functional testing of the concurrent program remains mandatory.