1. Designing Pixel-Perfect Reports in Oracle Transactional Business Intelligence
  2. Create Pixel-Perfect Reports and Layouts
  3. Create and Edit Reports
  4. Access Reports via a URL

Access Reports via a URL

You can call a report via a URL from another application.

Use the report URL format and specify the parameters for the report in the URL.

Report URL Format

You can call a report using a URL, for which you can build the URL.

The basic URL for a report is:

https://<server:port>/ui/xmlpserver/<ReportDirectory>/<ReportName>.xdo

or

https://<server:port>/xmlpserver/<ReportDirectory>/<ReportName>.xdo

where

  • server:port is the name of the server and port number where Publisher is running
  • ui is a static string for the user interface path
  • xmlpserver is a required static string (the name of the application)
  • ReportDirectory is the folder path to the report. When the report is under Shared Folders, don't include "Shared Folders" in the path. If the report is under My Folders, include the ~username as the first node in the path. See the examples following.
  • ReportName.xdo is the name of the report with the .xdo extension. If the name contains spaces, replace the space with a "+" character.

Examples

The following examples render the complete report inside the report viewer with all the report controls.

The following URL launches the North America Sales report. The report resides in the catalog under Shared Folders/Samples/Sales. Note that Shared Folders isn't included in the path.

https://example.com:7001/xmlpserver/Samples/Sales/North+America+Sales.xdo

The following URL launches the North America Sales report that resides in the catalog under My Folders/Samples/Sales. Note that the user name in this case is weblogic, therefore the first node in the path is ~weblogic.

https://example.com:7001/xmlpserver/~weblogic/Samples/Sales/North+America+Sales.xdo

Report URL Parameters

When you use a URL to call a report, you can specify parameters in the URL.

The default layout, default output format, and default parameters are used to render the report. You can add parameters to the URL to specify how the report renders.

When you construct the URL, note the following standard URL syntax:

  • ? denotes the first parameter
  • & denotes each additional parameter

The following table describes the parameters you can add to the URL.

Parameter Definition Example Usage

_xpt

Specifies whether to render the report in the report viewer or export the document to a new window appropriate for the output type. For example, if the output type specified is html, the report document (only) will render in a browser window; if the output type is PDF you will be prompted to save or open the PDF document. When this parameter isn't specified, the report renders in the report viewer.

Valid values are:

  • 0 renders the report in the report viewer

  • 1 exports the document to appropriate application window

_xpt=0

_xdo

(Optional) Provides the path to the report.

_xdo=%2FSamples%2FSalary+Report.xdo

_xt

Specifies the layout to use. Enter the name of the layout as defined in the report definition. If an invalid name is entered, the default layout is used.

_xt=Manager+Summary

_xf

Specifies the output format. If no value is specified, the default output format is used. If an invalid value is specified, or, if a value is specified that isn't enabled for the layout, the report doesn't render. Valid values are:

  • analyze for Interactive output

  • rtf

  • docx

  • pdf

  • html

  • pptx for PowerPoint 2007

  • ppt for PowerPoint

  • xml for data

  • excel for Excel

  • excel2000 for Excel 2000

  • xslx for Excel 2007

  • csv

_xf=pdf

Report parameters as named in the data model

Specify name-value pairs for the parameters specific to the report. You must use the parameter name as defined in the data model.

dept=10

_xmode

Specifies the report viewer mode. If not specified, defaults to view in the full report viewer. Valid values are:

  • 0 to view in the full report viewer.

  • 1 to hide Publisher banner, hide parameters, can change layout, other actions: export only.

  • 2 to hide Publisher banner. (No Header)

  • 3 to hide Publisher banner and parameters. (No Parameters)

  • 4 to hide Publisher banner, parameters, other actions, and layouts. (Document Only)

_xmode=1

Example:

https://example.com:7001/xmlpserver/Samples/Salary+Report.xdo?_xpt=0&_xdo=%2FSamples%2FSalary%20Report.xdo&_xmode=4&dept=10&_xt=Simple&_xf=html

This URL runs the "Salary Report" report located under Shared Folders/Samples. Note the following:

_xpt=0 renders the document in the report viewer

_xdo=%2FSamples%2FSalary%20Report.xdo defines the report path

_xmode=4 renders the document only

dept=10 sets the report-specific parameter "dept" to "10"

_xt=Simple uses the layout called "Simple"

_xf=html sets the output format to html