URL Parameters for the Report Viewer Plugin

NOTE: THIS PAGE IS OUT OF DATE. THE REPORTING PLUGIN CAN BE CONFIGURED VIA THE REPORT CONFIGURATION.

DO NOT USE THE METHODS OUTLINED HERE FOR SERVERS NEWER THAN 3.7.

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

Additional parameters for the report viewer

Parameter Name

Default Value

Accepted Values

Description

showParameters

true

true, false

If true, shows the parameter UI, but will keep the pagination controller.

paginate

true

true, false

If true, shows the pagination controls.

layout

vertical

vertical, flow

If set to vertical, parameter UI will use a vertical layout where each
parameter will stack on top of the next.
If set to flow, parameter UI will layout the parameters on the same row until wrapping is needed.

To make this the default behavior for the reporting plugin

Edit the command property in the reportingplugin.xml in /pentaho-solutions/system/reporting/.

For example

<operation>
<id>RUN</id>

<command>content/reporting/reportviewer/report.html?solution={solution}&amp;path={path}&name={name}&layout=flow</command>
</operation>


Note: &layout=flow has been added.