Skip to main content

Pentaho+ documentation has moved!

The new product documentation portal is here. Check it out now at


Hitachi Vantara Lumada and Pentaho Documentation

Pentaho Dashboard Designer


Creating a dashboard in Dashboard Designer is as simple as choosing a layout template, theme, and the content you want to display. In addition to displaying content generated from Interactive Reports and Analyzer, Dashboard Designer can also include these content types:

  • Charts

    Simple bar, line, area, pie, and dial charts created with Chart Designer.

  • Data Tables

    Tabular data.

  • URLs

    Web sites that you want to display in a dashboard panel.

Dashboard Designer has dynamic filter controls, which enable dashboard viewers to change a dashboard's details by choosing different values from a drop-down list, and to control the content in one dashboard panel by changing the options in another. This is known as content linking.

Get started with the Dashboard Designer

You can view the editable version of the Sales Performance (Dashboard) in Dashboard Designer by clicking Browse Files on the User Console Home page. Follow these quick steps.


  1. In the Folders pane, click to expand the Public folder, then click to highlight the Steel Wheels folder.

  2. In the center pane, double-click on Sales Performance (dashboard).

  3. After the dashboard opens, click Edit in File Actions.

    Dashboard Designer
    Item Name Function
    1 Opened view Displays quick access buttons across the top to create and save new Analyzer Reports, Interactive Reports, and dashboards. Opened reports and files show as a series of tabs across the page.
    2 Prompts panel The Prompts panel gives you a way to add filters to the individual parts of your dashboard.
    3 Browse folders and Files panels Locate your files using the Browse and Files panels, and add them to dashboards.
    4 Dashboard canvas Shows a dynamic view of your dashboard as you work to build it. The look of your dashboard refreshes as you add content from the Browse folders and Files panels, and work with the Prompts or Objects panels.
    5 Objects panel Refine the look of your dashboard with the Objects panel by choosing a dashboard template or changing the titles for each object in the dashboard.

Creating dashboards


When you create new dashboards, you have options to add Analyzer and Report Designer reports and even websites to your dashboard. You can also customize your dashboard with previously created charts, tables and files.

Create a dashboard

You must be logged into the User Console. Use these steps to create a new dashboard.


  1. From the User Console Home page, click Create New, then select Dashboard.

    The name you entered appears on the top left corner of the dashboard. This name helps you identify the page if you want to edit, copy, or delete it later.
  2. On the bottom of the page, click the Properties tab, and enter a title for your dashboard page in the Page Title text box.

  3. Click Templates to choose a dashboard layout.

    A blank dashboard with the layout you selected appears.
  4. Click Theme to choose a theme for your dashboard.

    The theme you selected is applied to your dashboard.


You now have the basic framework for a Pentaho dashboard.

Add a report from Analyzer

Use these steps to display an analysis report in a dashboard.


  1. Select a panel in the Dashboard Designer.

  2. Click Insert and choose File.

  3. Locate the appropriate analysis report and click Select.

    The report appears inside the dashboard panel.

Export an Analyzer report

You can export an Analyzer report from a dashboard as a PDF, CSV, or an Excel workbook file.


  1. In the dashboard toolbar, click Actions.

  2. Select one of the following available output formats from the menu that displays:

    • Export to PDF
    • Export to CSV
    • Export to Excel Workbook
    Your selection is the default export format until you change it.


PUC generates the report and downloads it to the browser's default download folder.

Add a report from Report Designer

Use these steps to add a report created with Report Designer.


  1. Select a panel in the Dashboard Designer.

  2. Click the Insert icon and choose File.

    A browser window opens.
  3. Locate the appropriate report file.

  4. Click Select to place the report inside the dashboard panel.

    Pagination control arrows at the top of a report allows you to scroll through long reports. Notice that the report file name, Inventory.prpt, appears under Content in the dashboard edit pane in the sample below. This sample report contains parameters. You can enter values manually and link them to a dashboard filter in the text boxes under Source. When the report renders again, the parameter value(s) you entered are included in the report. Sample report in dashboard
    ImportantIf you choose a Report Designer file to place in a dashboard, but do not supply values for required parameters, the report will show up blank.

Add a website

Use these steps to display contents of a website in a dashboard panel.


  1. Select a panel in the Dashboard Designer.

  2. Click the Insert icon and select URL.

    The Enter Web site dialog box appears.
  3. Enter the website URL in the text box and click OK.

  4. If applicable, click the Edit icon to make changes.

Drag-and-drop content

Use these steps to add an existing chart, table, or file to your dashboard panels using the drag-and-drop feature.


  1. In the left pane of the Pentaho User Console, under Files, locate to the content (chart, table, or file) you want added to your dashboard.

  2. Click and drag the content into a blank panel on your dashboard.

    You will see the "title" of the content as you move it around the dashboard. Notice that the title background is red; it turns green when you find a panel where the content can be dropped.
  3. Repeat steps 2 and 3 until your dashboard contains all the content you want to display.

    To swap content from one panel to another, click the title bar of the panel that contains the content you want moved and drag it over the panel you want swapped. You will see the swap icon as you are moving the content.
    NoteIf you are working with an existing dashboard, you can perform steps 2 and 3 steps; however, a warning message appears when you try to place content in a panel that already contains content. The new content will override the existing content.

Create a chart

The Chart Designer tool allows you to create bar, pie, line, dial, and area charts that can be added to a dashboard.

Learn more

Adjust white space in dashboard panels

Sometimes you must adjust the white space in dashboard panels, (or the filter panel), so that content appears correctly. Use these steps to adjust white space.


  1. In the lower pane, click General Settings and then click the Properties tab.

  2. Click Resize Panels.

    The white space between the dashboard panels turns blue.
  3. Adjust the panel size by clicking and holding the left mouse button down as you move the blue lines (white space) around. Release the mouse button when you are satisfied with the positioning of the panel.

  4. Click Close in the lower-right corner of the dashboard to exit resize layout mode.

  5. Examine the dashboard contents to make sure they are placed correctly.

    You can return to the resize layout mode if you need to make additional changes.

Set the refresh interval

The content in your dashboard may need to be refreshed periodically if users are examining real-time data. You can set refresh intervals for individual panels on your dashboard or for the entire dashboard.


  1. To set the refresh interval for individual panels in the dashboard, click the Edit button and the choose the panel that contains the content you want refreshed in the Objects panel.

  2. Under Refresh Interval (sec) enter the interval time in seconds and click Apply.

  3. (Optional) If you want the entire dashboard to refresh, click the Prompts tab in the dashboard and set your refresh interval.

Save a dashboard

You must be in Edit mode to save a dashboard.


  1. Click the Save As button (floppy disk and pencil icon) to open the Save As dialog box.

  2. In the File Name text box, type a file name for your dashboard.

  3. Enter the path to the location where you want to save the dashboard.

    Alternatively, use the Up and Down arrows or click Browse to locate the solution (content files) directory in which you will save your dashboard.
  4. Click Save.

    The report saves with the name specified.

Advanced topics


The following topics help to extend your knowledge of Dashboard Designer beyond basic setup and use: