Page Comparison

When reports are rendered in the Pentaho User Console, they are rendered via a Pentaho Plugin (Reporting Platform Plugin).

Like .xactions, reports (.prpts) can be accessed via a URL. This URL can be easily be created by right clicking on a report (.prpt) and selecting "Create Deep Link". Note: This encodes the URL.

Launching the report within the Pentaho User Console

In the link below, "name" parameter allows you to assign a name to the tab that will display in the Pentaho User Console.

http://localhost:8080/pentaho/Home?name=Inventory%20in%20PUC&startup-url=http%3A%2F%2Flocalhost%3A8080%2Fpentaho%2Fcontent%2Freporting%2Freportviewer%2Freport.html%3Fsolution%3Dsteel-wheels%26path%3D%2Freports%26name%3DInventory.prpt

Launching the report without the Pentaho User Console

http://localhost:8080/pentaho/content/reporting/reportviewer/report.html?solution=steel-wheels&path=/reports&name=Sales%20Summary.prpt

Passing Date and Number Parameter

Pentaho Reporting expects that all Number parameter conform to a standard format using the format pattern:

"###0.##############################################"

Example: 1234.5678

Numbers are parsed with Locale.US, so the decimal separator is a point.

Dates must be passed using the ISO-standard date format. The corresponding date format string is

"yyyy-MM-dd'T'HH:mm:ss.SSSz"

Example: 2010-12-31T19:39:15.010+0000

In case of server timezone dates, the timezone can be omitted.

Reporting Plugin Parameter Reference

The Pentaho Reporting System reserves all parameter names starting with "::" as system parameter. The engine will claim these parameters as private property. Do not use such parameter names for your own reports.
In addition to that, the following parameter names are used by the BI-Server reporting-Plugin and should not be used in a report for user-data (unless you know exactly what you are doing)

HTML Table

border	1

Table Row (tr)

Table Head (th)
Name

Table Head (th)
Description

Table Row (tr)

Table Cell (td)
solution

Table Cell (td)
The name of the current solution in the solution repository

Table Row (tr)

Table Cell (td)
path

Table Cell (td)
The path within the solution repository

Table Row (tr)

Table Cell (td)
name

Table Cell (td)
The name of the prpt within the repository

Table Row (tr)

Table Cell (td)
action

Table Cell (td)
Alias for the "name" parameter.

Table Row (tr)

Table Cell (td)
renderMode

Table Cell (td)

One of the following values:

Value	Description
REPORT	renders the report
XML	returns the parameter description document for the UI
PARAMETER	same as XML, but does not perform any pagiation
SUBSCRIBE	for managing subscriptions
DOWNLOAD	Downloads the prpt file, if the user has the correct permissions

Table Row (tr)

Table Cell (td)
output-target

Table Cell (td)

Defines how the report should be exported. This parameter is the canonical output parameter and overrides all other parameters that may attempt to define the output type.

Output-target	Description
table/html;page-mode=stream	HTML as a single page, all report pagebreaks are ignored
table/html;page-mode=page	HTML as a sequence of physical pages, manual and automatic pagebreaks are active
application/vnd.openxmlformats-officedocument.spreadsheetml.sheet;page-mode=flow	Excel 2007 XLSX Workbook
table/excel;page-mode=flow	Excel 97 Workbook
table/csv;page-mode=stream	CSV output
table/rtf;page-mode=flow	Rich-Text-Format
pageable/pdf	PDF output
pageable/text	Plain text
pageable/xml	Pageable layouted XML
table/xml	Table-XML output
pageable/X-AWT-Graphics;image-type=png	A single report page as PNG
mime-message/text/html	Mime-Email with HTML as body text and all style and images as inline attachments

Table Row (tr)

Table Cell (td)
dashboard-mode

Table Cell (td)

if "true": If the export generates HTML, the report will generate a body-fragment (content without the HTML, HEAD and BODY tags and all styles inlined into "style" attributes), which is easy to include in dashboards or other HTML pages.
This is the same result as if the report configuration property "org.pentaho.reporting.engine.classic.core.modules.output.table.html.BodyFragment" has been set to true.

Table Row (tr)

Table Cell (td)
accepted-page

Table Cell (td)
Defines which page to generate for HTML-Page and PNG output.

Table Row (tr)

Table Cell (td)
autoSubmit

Table Cell (td)

Defines whether auto-submit should be active in the UI. If this parameter is given and either "true" or "false", the UI will not allow the user to change the auto-submit configuration.
This property is deprecated. Auto-Submit should be defined inside the report itself. A global default can be defined in the report configuration, using the global configuration key
"org.pentaho.reporting.engine.classic.core.ParameterAutoSubmit".

Table Row (tr)

Table Cell (td)
autoSubmitUI

Table Cell (td)
Defines the initial state for the auto-submit checkbox in the UI. This parameter has no effect if "autoSubmit" is defined in any way. This property is deprecated. Auto-Submit-UI should be defined inside the report itself. A global default can be defined in the report configuration, using the global configuration key "org.pentaho.reporting.engine.classic.core.ParameterAutoSubmitUI".

Table Row (tr)

Table Cell (td)
subscribe

Table Cell (td)
A internal flag indicating that a subscription is configured.

Table Row (tr)

Table Cell (td)
subscription-id

Table Cell (td)
A internal parameter.

Table Row (tr)

Table Cell (td)
subscription-name

Table Cell (td)
A internal parameter.

Table Row (tr)

Table Cell (td)
destination

Table Cell (td)
A internal parameter.

Table Row (tr)

Table Cell (td)
print

Table Cell (td)
Defines whether the report shall be printed. Overrides all other output properties.

Table Row (tr)

Table Cell (td)
printer-name

Table Cell (td)
The (optional) name of the printer if "print=true".

Table Row (tr)

Table Cell (td)
showParameters

Table Cell (td)
Defines whether the parameter UI shows any parameter input. This URL parameter is deprecated. Use the report attribute with the same name instead.

Table Row (tr)

Table Cell (td)
report-definition

Table Cell (td)
Only usable in XActions. Has no effect if given on a URL.

Table Row (tr)

Table Cell (td)
useContentRepository

Table Cell (td)
Only usable in XActions. Has no effect if given on a URL.

Table Row (tr)

Table Cell (td)
workbook

Table Cell (td)
Only usable in XActions. Has no effect if given on a URL.

Table Row (tr)

Table Cell (td)
res-url

Table Cell (td)
Only usable in XActions. Has no effect if given on a URL.

Table Row (tr)

Table Cell (td)
paginate

Table Cell (td)
Deprecated. Only used in legacy reports.

Table Row (tr)

Table Cell (td)
content-handler-pattern

Table Cell (td)
Only usable in XActions. Has no effect if given on a URL.

Table Row (tr)

Table Cell (td)
layout

Table Cell (td)
Defines how the parameter inputs are laid out. Can be one of "vertical", "horizontal" or "flow". This URL parameter is deprecated, use the report attribute instead. A global default can be defined in the report configuration, using the global configuration key "org.pentaho.reporting.engine.classic.core.ParameterUiLayout"

Table Row (tr)

Table Cell (td)
ignoreDefaultDates

Table Cell (td)
Deprecated. Has no effect anymore. The UI does no longer generate default selections, if you need a default value for a parameter, set it in the parameter definition instead.

Table Row (tr)

Table Cell (td)
output-type

Table Cell (td)
Deprecated. Use "output-target" instead.

How the simple-reporting-component selects the output-target

The algorithm to determine the output target from the given parameters is as follows:

...

If the output type given is invalid, the report will not be executed and calls to
SimpleReportingComponent#getMimeType() will yield a generic "application/octet-stream" response.

Examples

To download a PRPT file from the server:

...

Versions Compared

Old Version 16

New Version 17

Key

Passing Date and Number Parameter

Reporting Plugin Parameter Reference

How the simple-reporting-component selects the output-target

Examples