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

Use prompts on dashboards

Parent article

Prompts display a subset of data based on the dashboard user's point of view. For example, a European user may only want to see EMEA region sales data, whereas the dashboard's default region is the NA region. To ensure that a prompt links to the correct content in a dashboard, the content to which you are linking (data table or chart) must contain at least one parameter.

Get started with dashboard prompts

Perform the following steps to add prompts to your dashboard:


  1. In the dashboard page, select Edit (the pencil icon), which will make the Objects pane appear.

  2. Under General Settings, select Prompts.

    The Prompts pane appears on the right. No prompts are listed if this is the first time you are assigning prompts.
  3. To display a prompt toolbar to users of the dashboard, enable Show Prompt Toolbar.

    The prompt toolbar appears at the top of the dashboard.
  4. Click the Add button to start adding prompts.

    The Prompts dialog box appears.
  5. In the Prompts dialog box, enter a display name for the control label, such as Region.

  6. Enable Display Name as Control Label if you want users to see the display name in the prompts toolbar.

  7. Select your control type.

    Control types define how your prompt values are selected, such as in a drop down list or as a radio button or check box.

    The table below contains a description of each control type.

    Control TypeDescription
    Drop-downUsers select a value from a drop-down list of options.
    ListUsers select a value from a scrolling list. This prompt control type allows users to make multiple selections.
    Radio buttonUsers click a radio button to choose a value. You can set the radio buttons to display vertically or horizontally.
    Check boxUsers select a check box to choose a value. This prompt control type allows users to make multiple selections within a set of check boxes. You can set the check boxes to display vertically or horizontally.
    ButtonUsers click a button to choose a prompt value. This prompt control type allows users to make multiple selections within a set of buttons. You can set the buttons to display vertically or horizontally.
    Text fieldUsers manually enter a text string or number into a text field. You can specify maximum characters allowed within the text box and the width of the text box itself.
    Date pickerUsers examine values based on calendar dates.


Your dashboard now has a prompt.

Edit prompts

You can edit prompts as needed. Use these steps to edit prompts.


  1. Locate the prompts pane at the top of the panes in the dashboard.

  2. Locate the different prompts and the drop-down menus next to them.

  3. Select the prompt you want to edit and choose an alternative prompt from the drop-down menu.

    The prompt changes, causing the graphs and charts in the dashboard to change appropriately.

Additional prompts

You can also create the following types of prompts:

  • Toolbar

    Create a dashboard toolbar for your prompts.

  • List

    Define a query to retrieve a list of display names and corresponding values from a metadata data source.

  • Date

    Select values based on calendar dates.

Learn more

Link dashboard prompts to Analyzer parameters

The instructions below explain how to parameterize an Analyzer report.
NoteThis process only applies to dashboards which include parameterized Analyzer reports. You must have a query parameter in the Analyzer report to proceed.


  1. In your Analyzer report, right-click a field you want to link to, then select Filter.

    The Filter dialog box opens. In the example below, data will be filtered by Territory. Analyzer filter
  2. Enter a name for the parameter in the Parameter Name text box and select its corresponding check box to enable it.

  3. Select the values you want associated with the parameter. Use the arrow buttons to add and remove values.

  4. When finished, click OK to save your selections and close the Filter dialog box. Be sure to save your report.

  5. In the upper-left corner of the report, you can see that a filter is in use. Optionally, click the Edit (pencil) icon to make changes to your filter, or the Delete (X) icon to remove the filter.

  6. Create a dashboard and drag the Analyzer report into a panel.

    The name of the parameter appears in the lower portion of the dashboard under Parameters. If a Between operator is parameterized, two parameters will be automatically created with the suffixes _START and _END.
  7. Add a filter to the dashboard based on the parameter you created in your Analyzer report.

    The filter appears in the dashboard.