Search Results psp_pspenawd_xmlp_pkg




Overview
Explore in AI Chat

Overview

PSP_PSPENAWD_XMLP_PKG is an Oracle E-Business Suite PL/SQL package owned by the APPS schema and classified as an OTHER API. It is the supporting package for the Oracle Grants / Project Accounting "Award Encumbrance" XML Publisher (BI Publisher) report — internally designated PSPENAWD — within the ETRM (Enterprise Technical Reference Manual) for release 12.1.1 and 12.2.2. The package encapsulates the report-level PL/SQL logic that XML Publisher invokes at defined trigger points in the report lifecycle: before the parameter form is submitted, before the report executes, and after the report completes, together with the column-level formula functions that transform raw query output into display-ready values.

Its principal business purpose is to present award encumbrance information — committed and encumbered amounts against awards, by payroll, set of books, award template and pay template — in a formatted, currency-aware layout. The "cf_" prefix on many of its functions indicates they are XML Publisher "column formula" callbacks, invoked as the report layout is populated to derive computed columns such as currency-formatted totals. The package also performs date-range and award end-date validation to drive report behavior.

Key Procedures and Functions

The package exposes twelve documented program units:

  • AFTERPFORM — a report trigger executed after the parameter form is submitted, typically used to validate or default report parameters before execution.
  • BEFOREREPORT — the pre-report trigger where setup such as the set of books, business group, and concurrent request context are established.
  • AFTERREPORT — the post-report trigger used to finalize or clean up after the report run.
  • CF_CHARGING_INSTFORMULA — derives the charging instruction text for an award/project/task/expenditure combination.
  • CF_AWD_END_DTFORMULA — returns the award end date for a given award.
  • CF_DATE_CHECKFORMULA — compares the award end date against the encumbrance end date to produce a comparison result.
  • CF_END_DATE_RANGEFORMULA — produces a display value based on the encumbrance begin and end dates.
  • CF_AWARD_TOTAL_DSPFORMULA — formats the award total using the derived currency format.
  • CF_PELH_ENC_AMOUNT_DSPFORMULA — formats the summed encumbrance amount for display.
  • CF_PAY_TOTAL_DSPFORMULA — formats the pay total using the currency format.
  • CF_CURRENCY_FORMATFORMULA — returns the currency formatting mask for a given currency code.
  • CF_CURRENCY_TOTAL_DSPFORMULA — the function the user searched for; it formats the currency total amount for display using the supplied currency format, returning a VARCHAR2.

Tables Accessed

The package reads from the following documented tables via APPS synonyms: GMS_AWARDS and GMS_AWARDS_ALL (award header and award definitions), PA_PROJECTS_ALL (project details tied to awards for charging instructions), HR_ALL_ORGANIZATION_UNITS and HR_ALL_ORGANIZATION_UNITS_TL (organization and translated organization names), and PSP_REPORT_TEMPLATE_DETAILS (report template configuration used to drive layout/parameter behavior). These reads support resolving award, project, organization, and template context for the report output.

Usage Notes

PSP_PSPENAWD_XMLP_PKG is not a general-purpose API. It is referenced by no other packages in the ETRM metadata, indicating it is invoked indirectly — by the XML Publisher report definition PSPENAWD and its data template — rather than called from custom code. The report is typically launched as a concurrent program, at which point XML Publisher fires AFTERPFORM, BEFOREREPORT and AFTERREPORT, and calls the cf_ column formulas during data layout. Customizations should not call these functions directly but should modify a copied report definition, preserving the APPS package as-is.