Search Results pay_payjpitt_xmlp_pkg




Overview
Explore in AI Chat

Overview

PAY_PAYJPITT_XMLP_PKG is a PL/SQL package in the APPS schema that supports the Oracle Payroll Japanese Income Tax Report (PAYJPITT), a legislative report delivered for Japanese payroll. The suffix "XMLP_PKG" identifies it as the generated PL/SQL package that accompanies an Oracle XML Publisher (BI Publisher) concurrent program. Its role is to supply the report's data model: it accepts report parameters, executes the appropriate initialization logic, and populates the column values and summary totals that the XML Publisher template renders into the printed statutory output.

The package has no published API classification; it is classified as OTHER and is intended for internal use by the concurrent program that owns it. It is documented as VALID in ETRM 12.2.2 and depends only on the SYS.STANDARD package, meaning its internal logic is entirely driven by the SQL statements it embeds and the APPS synonyms those statements reference. The report falls within the Japanese payroll legislative reporting family, so its execution is normally tied to a completed payroll action run.

Key Procedures and Functions

The package exposes 36 documented procedures and functions. The principal control routines are BEFOREREPORT, AFTERREPORT, and AFTERPFORM, which form the standard XML Publisher data-model lifecycle: BEFOREREPORT performs setup before the main query executes, AFTERPFORM runs after the report's parameter form values are captured, and AFTERREPORT handles post-query processing such as final totals. TO_JP_CHAR is a conversion function used to format values into a Japanese character representation for the report output.

The remaining routines are grouped by report section. The CP_A_* family covers the "A" category, comprising CP_A_COUNT_P, CP_A_ZERO_ITAX_COUNT_P, CP_A_TAXABLE_INCOME_P, CP_A_ITAX_P, plus the sub-groups CP_A_OTHER_* and CP_A_HEI_* (each with COUNT_P, ZERO_ITAX_COUNT_P, TAXABLE_INCOME_P and ITAX_P variants). The CP_B_* family covers the "B" category, with documented members including CP_B_OTHER_COUNT_P, CP_B_OTHER_TAXABLE_INCOME_P, CP_B_OTHER_ITAX_P and CP_B_HEI_COUNT_P. The naming convention shows each group is responsible for counting employees, isolating those with zero income tax withheld, aggregating taxable income, and aggregating income tax withheld. The _OTHER_ and _HEI_ prefixes distinguish separate reporting categories within the Japanese tax report.

Tables Accessed

The package reads through APPS synonyms of the core Oracle HRMS and Payroll tables. PAY_PAYROLL_ACTIONS and PAY_ACTION_INTERLOCKS provide the payroll run header and its processing context, which determine the reporting period and the set of actions to be reported. PAY_ASSIGNMENT_ACTIONS supplies the per-assignment results of those actions, forming the employee-level detail that is aggregated into the taxable income and income tax totals. HR_ALL_ORGANIZATION_UNITS and HR_ORGANIZATION_INFORMATION supply organizational and legal-employer details, including the organization information needed to identify the reporting legal entity and its registration attributes. DUAL is used for single-row computations such as date or parameter derivations.

Usage Notes

PAY_PAYJPITT_XMLP_PKG is invoked indirectly by the Oracle Payroll Japanese Income Tax Report concurrent program; it is not a general-purpose API and is not referenced by any other PL/SQL package. It should not be called from custom code or modified in place, since Oracle may regenerate the package when the underlying report definition is patched. Customizations should be applied to the XML Publisher template rather than the generated package body. When the report produces incorrect results, the package and its concurrent program definition should be validated as part of Japanese payroll legislative patch verification.