Search Results cp_ot_message_p
Overview
PAY_PYAUPYT_XMLP_PKG is a generated PL/SQL package belonging to the Oracle Payroll product family in Oracle E-Business Suite (EBS) 12.1.1 and 12.2.2. The suffix "XMLP_PKG" identifies it as the runtime support package for an Oracle XML Publisher (BI Publisher) report, specifically the Australian Payroll Payment Summary (PAYUPYT) concurrent program. The package is owned by the APPS schema and is classified in ETRM as an "OTHER" API, meaning it is not a public, supported integration interface but an internal artifact produced automatically when the underlying report's data model and layout are deployed.
Its business purpose is to hold the report's user-entered and derived parameters, format masks, and formula logic so that the XML Publisher template can render Australian payment summary output across the various state and territory taxation regimes (VIC, NSW, QLD, SA, TAS, WA, ACT, NT). The header comment shows it was created in late 2007 and matches the legislatively driven structure of the Australian payroll report.
Key Procedures and Functions
The ETRM metadata documents 14 procedures and functions. The report lifecycle functions are BEFOREREPORT, which initializes the package state prior to execution, and AFTERREPORT, which performs post-processing and returns a boolean status. SET_FORMAT_MASK establishes the numeric and currency display masks used throughout the report.
Formula functions supply values to the XML template. CF_BUSINESS_GROUPFORMULA resolves the business group context. CF_LEGISLATION_CODEFORMULA returns the applicable legislation code. CF_CURRENCY_FORMAT_MASKFORMULA derives the currency format mask. CF_STATE_TAXFORMULA computes state-level tax for a given jurisdiction.
The remaining seven entry points are the "CP_" parameter getters: CP_OT_MESSAGE_P, CP_MESSAGE_P, CP_CURRENCY_P, CP_TAX_STATE_P, CP_REPORT_TYPE_P, CP_LEGAL_EMPLOYER_P, and CP_DGE_P. These expose the values of the package-level constants CP_OT_MESSAGE, CP_MESSAGE, CP_CURRENCY, CP_TAX_STATE, CP_REPORT_TYPE, CP_LEGAL_EMPLOYER, and CP_DGE. The CP_MESSAGE_P function requested by the user therefore returns the report's general message constant (defined as a VARCHAR2(100)), typically used to surface a warning or informational banner in the report output.
Tables Accessed
The package reads from seven APPS synonyms. FND_CONCURRENT_REQUESTS and FND_SESSIONS supply the concurrent request and session context, including the request ID passed into P_CONC_REQUEST_ID. FND_CURRENCIES provides currency definitions for format masking. HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION resolve the legal employer and business group organization details. PAY_ACTION_INFORMATION, PAY_ASSIGNMENT_ACTIONS, and PAY_PAYROLL_ACTIONS provide the payroll action and assignment data that drive the payment summary totals; the date range parameters P_START_DATE and P_END_DATE bound this payroll data.
Usage Notes
PAY_PYAUPYT_XMLP_PKG is invoked indirectly through the Australian Payment Summary XML Publisher concurrent program rather than being called directly by application forms or custom PL/SQL. It is not referenced by any other package, confirming its role as a leaf-level report package. Because the CP_ parameter constants and many P_ variables are declared in the package specification, integrators occasionally read them for diagnostics, but the package is regenerated whenever the report definition is redeployed, so any dependency on it should be treated as unsupported. In both 12.1.1 and 12.2.2 the structure and naming remain consistent with the Oracle Reports-to-XML Publisher migration pattern.