Search Results ar_arxpar_xmlp_pkg




Overview
Explore in AI Chat

Overview

The package APPS.AR_ARXPAR_XMLP_PKG is the generated PL/SQL specification behind the Oracle Receivables XML Publisher (BI Publisher) concurrent program known internally as ARXPAR. The name suffix _XMLP_PKG identifies it as an XML Publisher report package, a construct introduced with the Oracle E-Business Suite XML Publisher technology stack. Where a traditional Oracle Reports concurrent program would have an associated report definition and a generated PL/SQL package, XML Publisher programs rely on a data definition (typically an SQL query or a PL/SQL data source) plus the XML template registered in the XML Publisher Administrator responsibility. The PL/SQL package AR_ARXPAR_XMLP_PKG acts as that data source logic layer.

The stated header revision is $Header: ARXPARS.pls 120.0 2007/12/27 13:58:40 abraghun noship $, and the object is classified under ETRM's API classification of OTHER. The package is owned by APPS and is loaded as part of the standard Receivables schema, meaning it is available to any concurrent request submitted against the Receivables responsibility set.

Key Procedures and Functions

The specification exposes seven documented procedures and functions. Each serves a specific role in the report execution lifecycle.

  • BeforeReport — returns a boolean and is invoked by the XML Publisher engine immediately before the report data is generated. It is the conventional initialization hook, where package-level state and parameters are staged.
  • AfterReport — returns a boolean and executes after report completion, providing a cleanup or post-processing entry point.
  • report_nameformula — returns a varchar2 and accepts a Company_Name argument. It is a formula column, meaning its return value is computed per row of the underlying query rather than being read from a table column. It dynamically determines the report name, presumably by combining the company name with a fixed report label.
  • NLS_YESFormula — returns a VARCHAR2 formula value. Typically this resolves to a yes-like translated string resolved through the Oracle NLS (National Language Support) message translation facilities.
  • NLS_NOFormula — returns a VARCHAR2 formula value, the counterpart to the previous function. This is the specific object the user searched for under the term nls_noformula. It supplies the localized "No" representation for display in the report output, ensuring the report renders correctly under locales whose affirmative/negative conventions or character sets differ from the base language.
  • RP_COMPANY_NAME_p — returns a varchar2 and is the accessor (getter) for the package-level variable RP_COMPANY_NAME, declared as varchar2(30). It exposes the resolved company name to the report template or layout.
  • RP_REPORT_NAME_p — returns a varchar2 and is the accessor for the package-level variable RP_REPORT_NAME, declared as varchar2(240). It exposes the resolved report title to the report layout.

In addition to the documented functions, global variables P_Set_of_Books_Id and P_conc_request_id are declared at package level, and functions RP_COMPANY_NAME_p and RP_REPORT_NAME_p provide read access to the company name and report name globals respectively.

Tables Accessed

The only documented table reference is FND_CONCURRENT_REQUESTS, accessed through an APPS synonym. This is consistent with the presence of the P_conc_request_id global variable. Looking up the concurrent request row allows the package to derive context such as the request ID, the submitting user, the responsibility, and the request date, which the report layout can then surface. No other application tables are documented as referenced by the package, indicating that the heavier data retrieval for this report is performed by the XML Publisher data definition query rather than inside the package body.

Usage Notes

AR_ARXPAR_XMLP_PKG is invoked indirectly. End users do not call it; the XML Publisher concurrent program engine instantiates it as the report's PL/SQL data source during request submission. The standard sequence is: the concurrent manager picks up the ARXPAR request, the XML Publisher engine calls BeforeReport, executes the data definition (which invokes formula columns such as report_nameformula, NLS_YESFormula, and NLS_NOFormula), merges the resulting XML data with the RTF or XSL-FO template, writes the output document, and finally calls AfterReport.

Customizations should not modify the seeded package, because edits are overwritten during patch application. Instead, developers cloning this report should copy the package and register a new concurrent program. Developers integrating with it programmatically can call RP_COMPANY_NAME_p and RP_REPORT_NAME_p after invocation to retrieve the values staged by the report, and may reference the package-level variables directly where the package state is visible.