Search Results cp_ot_message

Overview

APPS.PAY_PYAUPYT_XMLP_PKG is the generated PL/SQL package body that supports the Oracle Payroll Australian Payroll Tax report, an XML Publisher (BI Publisher) concurrent program in Oracle E-Business Suite 12.1.1 and 12.2.2. The package follows the standard Oracle Reports-to-XML Publisher conversion pattern, in which Oracle Reports user exits, format triggers, and group filters are re-implemented as PL/SQL functions within a package whose name ends in _XMLP_PKG. The prior report-specific logic executes during the Before Report, After Report, and formula-column phases of the concurrent request lifecycle.

The package achieves two core objectives. First, it derives display values for report parameters and column formulas from Oracle HR and Payroll reference tables, so that the XML output shows lookup meanings, currency formatting masks, legislation codes, and organization names rather than raw identifiers. Second, it purges transient staging data written to PAY_ACTION_INFORMATION by the pre-processor when the concurrent request completes. The $Header value (PYAUPYLB.pls 120.1) indicates this is the XML Publisher label variant distributed with the Australian payroll tax feature.

Key Procedures and Functions

The 14 documented program units divide into three groups:

• Report lifecycle: BEFOREREPORT opens the lookups and organization cursors used to resolve state, report type, legal employer, and DGE (Designated Group Employer) values before the main query executes. AFTERREPORT deletes the rows inserted into PAY_ACTION_INFORMATION and removes the payroll action and assignment action records created for the run.
• Formula (CF_*) functions: CF_BUSINESS_GROUPFORMULA returns the business group name via HR_REPORTS.GET_BUSINESS_GROUP. CF_LEGISLATION_CODEFORMULA, CF_CURRENCY_FORMAT_MASKFORMULA, CF_STATE_TAXFORMULA, and SET_FORMAT_MASK derive legislation code, currency display mask, and state tax label values for the report layout.
• Parameter (CP_*) functions: 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 resolve the runtime values (and, in the case of CP_MESSAGE_P and CP_OT_MESSAGE_P, any informational message text) for each concurrent program parameter. The user search term cp_message corresponds to CP_MESSAGE_P.

No public API signature beyond the report parameter set is exposed; the package is invoked exclusively by the XML Publisher engine.

Tables Accessed

• PAY_ACTION_INFORMATION — staging table holding Australian payroll tax employee details, DGE details, YTD balance details, and archive assignment details; rows are deleted by AFTERREPORT.
• PAY_ASSIGNMENT_ACTIONS and PAY_PAYROLL_ACTIONS — the assignment-level and payroll-level action records created for the report run; deleted on completion.
• HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION — source of the business group name, legal employer name, and DGE (ORG_INFORMATION3) attribute.
• FND_CURRENCIES — currency format mask for the CF_CURRENCY_FORMAT_MASKFORMULA value.
• FND_CONCURRENT_REQUESTS and FND_SESSIONS — concurrent request context used to identify the running program and its parameters.

Usage Notes

The package is invoked automatically when the Australian Payroll Tax concurrent program (short name PYAUPYT) is submitted from the Submit Requests form or the Australian Payroll Tax report form. It is not referenced by any other PL/SQL package, so custom code should call the concurrent program rather than the package directly.

Because AFTERREPORT deletes rows from PAY_ACTION_INFORMATION, PAY_ASSIGNMENT_ACTIONS, and PAY_PAYROLL_ACTIONS, the report is destructive by design; the affected payroll action should not be reused. The exception handler issues a ROLLBACK, but the COMMIT that follows the exception block is issued unconditionally, so partial processing should be verified when errors occur. In 12.2.2 the package executes under the APPS schema with the standard XML Publisher security model, and the report output is generated as XML data plus an RTF template.