Search Results p_not_submitted_only_flag




Overview
Explore in AI Chat

Overview

PSB_PSBWSSUB_XMLP_PKG is an Oracle Applications (APPS) PL/SQL package that serves as the report logic container for the Oracle Projects "Worksheets Submission" BI Publisher (XML Publisher) report. The package is generated in the standard XML Publisher PL/SQL stub pattern: it declares a set of package-level globals that hold concurrent program parameters and report-level computed values, and exposes a small number of lifecycle functions invoked by the BI Publisher report engine at defined points during report execution.

The business function of the report supported by this package is to identify and present budget worksheet records — and, when requested, only those worksheets that have not yet been submitted — so that project and budget administrators can monitor submission status and follow up on outstanding items. The package itself does not implement complex business logic; rather, it serves as the binding layer between the concurrent program parameters and the report's data model and layout.

The package is owned by APPS and is classified as OTHER in the ETRM metadata, reflecting its role as a report-support object rather than a public API. The header comment indicates a last modification in January 2008 at version 120.0, consistent with the 11i/12.1.1 lineage. Under EBS 12.2.2 the same object is deployed in the consolidated AD/TXK code environment, but its structure and behavior are unchanged because it is an XML Publisher report package and not part of the online forms runtime.

Key Procedures and Functions

The package declares twelve documented functions. Several are report lifecycle hooks that the XML Publisher engine calls automatically during processing, and the remainder are "getter" accessors that expose global state to the report's data model.

  • BEFOREREPORT — Executed once before report output is produced. It initializes report-level globals, resolve the budget group context, and sets up any session state required by the report queries.
  • BEFOREPFORM — Invoked before the report's parameter form logic; used to prepare or validate parameter values prior to form display.
  • AFTERPFORM — Invoked after the parameter form is processed; used to finalize parameter-derived values before the main report query executes.
  • BETWEENPAGE — Called between page breaks of the report; provides a hook for page-level formatting or logic.
  • AFTERREPORT — Executed after all report output has been generated; used for cleanup and finalization.
  • CP_BUDGET_GROUP_NAME_P — Returns the resolved budget group name (CP_BUDGET_GROUP_NAME) for display in the report header.
  • CP_NO_DATA_FOUND_P — Returns the CP_NO_DATA_FOUND message string used when no qualifying worksheet records exist.
  • CP_END_OF_REPORT_P — Returns the CP_END_OF_REPORT banner string printed at report termination.
  • CP_STARTDATE_PP_P — Returns the start date of the prior period (CP_STARTDATE_PP) used in the reporting date range.
  • CP_ENDDATE_CY_P — Returns the end date of the current year (CP_ENDDATE_CY) for the reporting date range.
  • CP_NOT_SUBMITTED_ONLY_P — Returns the formatted (VARCHAR2(80)) value of the P_NOT_SUBMITTED_ONLY_FLAG parameter, which is the user-search term. When set to 'Y', the report restricts output to worksheets that have not been submitted.
  • CP_GLOBAL_WORKSHEET_ID_P — Returns the CP_GLOBAL_WORKSHEET_ID global, used to carry the worksheet identifier through report processing.

Tables Accessed

The package's report queries reference two documented tables through APPS synonyms:

  • PSB_BUDGET_GROUPS — The budget group definition table. It supplies the budget group name displayed via CP_BUDGET_GROUP_NAME and provides the context filtered by the P_BUDGET_GROUP_ID parameter.
  • PSB_WORKSHEETS — The worksheet header table. It is the primary source for worksheet rows, submission status, and the worksheet identifier (P_WORKSHEET_ID), and is the table against which the not-submitted-only filter is applied.

Usage Notes

PSB_PSBWSSUB_XMLP_PKG is not intended for direct invocation by custom code. It is invoked indirectly by the XML Publisher concurrent program that runs the Worksheets Submission report. At runtime, the concurrent manager submits the report; the report engine calls BEFOREREPORT, BEFOREPFORM, AFTERPFORM, BETWEENPAGE, and AFTERREPORT in sequence, and references the CP_* getter functions from the report's data template and layout template.

The parameter P_NOT_SUBMITTED_ONLY_FLAG is the driver for the "p_not_submitted_only_flag" search term. When the user runs the report with this flag set to 'Y', the underlying worksheet query is filtered so that only unsubmitted worksheets appear; the formatted equivalent is exposed to the layout through CP_NOT_SUBMITTED_ONLY_P.

Because the package is report-private and referenced by no other packages (0 dependents in the ETRM metadata), it carries no public API contract. Customizations should be applied to the underlying report definition or, where necessary, to a copied version of the package, since direct modification of the seeded APPS package is not supported and will be overwritten by patching.