Search Results cf_net_this_payformula




Overview

APPS.PAY_PAYCNSOE_XMLP_PKG is the generated PL/SQL package that backs the Oracle Payroll "Consolidation Set Summary" XML Publisher concurrent program (short name PAYCNSOES). It operates as an AUTHID CURRENT_USER package and follows the standard Oracle Reports/XML Publisher server-side packaging convention, in which report-level parameters, formula columns, and trigger logic are exposed as package globals, functions, and procedures so that the XML Publisher data template can invoke them during report execution. The package consolidates payroll balance information across a consolidation set, producing taxable, non-taxable, voluntary, and statutory balances for both the current pay period and year-to-date, along with net pay figures. It is delivered under the APPS schema in Oracle E-Business Suite 12.1.1 and 12.2.2.

Key Procedures and Functions

The documented API surface comprises 31 procedures and functions. The principal execution entry points are BEFOREREPORT and AFTERREPORT, which initialize package state and release resources around the report run. Formula functions include CF_BUSINESS_GROUPFORMULA and CF_LEGISLATION_CODEFORMULA, which resolve business group and legislation context, and CF_CURRENCY_FORMAT_MASKFORMULA together with SET_CURRENCY_FORMAT_MASK, which derive the currency display format applied to monetary columns.

The balance calculation logic is centered on CF_NET_THIS_PAYFORMULA and CF_NET_YTDFORMULA, which return net pay for the current period and year-to-date respectively, and on CF_BALANCESFORMULA, a generalized calculation routine that computes a balance value given an organization name and the current-pay and YTD amounts. Supporting these are the balance column procedures CP_TAXABLE_THIS_PAY_P, CP_TAXABLE_YTD_P, CP_NON_TAXABLE_THIS_PAY_P, CP_NON_TAXABLE_YTD_P, CP_VOLUNTARY_THIS_PAY_P, CP_VOLUNTARY_YTD_P, CP_STATUTORY_THIS_PAY_P, and CP_STATUTORY_YTD_P. Report setup helpers include CONSTRUCT_ORDER_BY, which assembles the dynamic ORDER BY clause from the sort-order parameters, GET_PARAMETERS_NAME, which resolves parameter display names, and the validation trigger P_BUSINESS_GROUP_IDVALIDTRIGGE. The package also declares numerous global variables (P_ and CP_ prefixed) that carry query, parameter, and computed values across the report lifecycle.

Tables Accessed

The package references four tables through APPS synonyms. PAY_CONSOLIDATION_SETS supplies the consolidation set definition that scopes the report. HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION provide organization and location data used to resolve payout locations and organization names. FND_CURRENCIES supplies currency attributes used to build the currency format mask applied to monetary balance columns.

Usage Notes

PAY_PAYCNSOE_XMLP_PKG is invoked indirectly by the Oracle Payroll Consolidation Set Summary concurrent program through its XML Publisher data template; it is not intended for direct invocation from forms or custom code. The package is not referenced by any other documented package, confirming it is a leaf-level report implementation object. Customizations should target the underlying XML template or a copied report definition rather than the generated package, since the package is regenerated whenever the report definition changes.