Search Results cp_uomformula

Overview

APPS.PAY_PYNZREC_XMLP_PKG is a PL/SQL package that supports the Oracle E-Business Suite concurrent program responsible for the New Zealand payroll reconciliation report. As indicated by the _XMLP_PKG suffix, this package is the generated code-behind artifact for an Oracle BI Publisher (XML Publisher) report definition. The report source, PYNZRECS.pls, dates to 2007 and belongs to the payroll jurisdiction-specific module for New Zealand under the PAY application. The package is owned by APPS and is not classified as a public API; it is an internal report-support component.

The package exists to bind the data model of the reconciliation report to the XML Publisher template. It declares global state variables that hold report parameters and contextual values for the duration of a single report run, and it exposes formula functions whose return values are inserted into the report output at template evaluation time. The business purpose is to present a payroll reconciliation view for New Zealand legislation, giving payroll administrators and auditors a formatted, sortable listing that ties payroll actions to their time periods, organizations, and currency formatting conventions.

Key Procedures and Functions

The package declares 13 documented procedures and functions. The two lifecycle hooks are BeforeReport and AfterReport, both returning BOOLEAN, which XML Publisher invokes before and after the report data model executes. BeforeReport is the standard location for validating parameters and preparing query inputs; AfterReport performs any final teardown.

The formula functions supply derived display values to the report layout:

• CF_sort_order_displayFormula — resolves the sort order chosen at run time into its display form for the report header. This is the specific function referenced by the search term cf_sort_order_displayformula.
• CF_business_groupFormula — returns the business group context for the report.
• CF_payroll_run_displayFormula — produces the formatted payroll run description shown on the output.
• CF_legislation_codeFormula — returns the legislation code driving the New Zealand-specific logic.
• CP_input_value_nameFormula, CP_UOMFormula, and CP_report_nameFormula — return the input value display name, unit of measure, and report name respectively.
• cf_currency_format_maskformula — accepts the legislation code and derives the appropriate currency format mask.

Three accessor functions, CP_input_value_name_p, CP_UOM_p, and CP_report_name_p, expose the corresponding global values for use elsewhere in the report logic.

Tables Accessed

The package reads the following tables through APPS synonyms:

• PAY_PAYROLL_ACTIONS and PAY_ALL_PAYROLLS_F — supply payroll action and payroll definition data used to identify the run being reconciled and to drive the payroll run display formula.
• PER_TIME_PERIODS — supplies period dates that anchor the reconciliation to the correct payroll calendar window.
• HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION — resolve the business group and organizational context for the report.
• FND_CURRENCIES — provides currency attributes used by the currency format mask formula.

Usage Notes

This package is invoked automatically by the XML Publisher engine when the associated New Zealand payroll reconciliation concurrent program is submitted; it is not intended for direct invocation from forms or custom code. The global variables (P_BUSINESS_GROUP_ID, P_SORT_ORDER, P_PAYROLL_ACTION_ID, P_CONC_REQUEST_ID, and the CP_ globals) are populated from the concurrent program parameters at run time. Because the package is classified as OTHER and referenced by zero other packages, customers should treat it as internal and avoid calling its members directly; customization should be confined to copying and extending the report definition rather than modifying the generated package. Behavior is consistent across EBS 12.1.1 and 12.2.2, as the file header reflects a stable 12.0 revision.