Skip to main content
Planview Customer Success Center

Report Component Variable Settings (Beta)

Configuring Filters and Time Series Settings for Dashboard Report Components

When you place a report on a dashboard, any filters or time series settings (dates, frequency) already configured for the report are applied to the report and shown by default in the Variable Settings modal - each report component has its own modal. You can leave the settings as-is, change them, or remove them altogether - this will not impact the filters or time series on the standalone report, only how the report is rendered in the dashboard. In addition, you can determine whether to allow dashboard consumers to change these setting interactively, while viewing the dashboard. This is useful, for example, if the report is initially filtered to all projects with Status = Proposed; if allowed to change the filter, the dashboard consumer can re-filter the report to their interests, such as all project with Status = Open. 

Configuring Variable Settings

To set up a filter or time series on a report component, make sure that at least one report has been added to the report to the dashboard Preview Pane, then click the Component menu control in the top-right corner of the Preview Pane (looks like a down arrow) and choose Edit Variable Settings, as shown below:

component_menu.png

The Variable Settings modal appears.

2020-08-17_13-45-43.png

Default settings

Any variable settings configured in the original report appear in the dashboard report component. For example, the screenshot to the left shows the settings from the original report: a project filter (Status is in Progress) and "Allow changing filter: When Viewing' is selected for the project filter. There is also the option to include a Task filter (because the report includes task fields), but no filter value was included on the original report.

Filters

There can be one or more ad-hoc filter controls for each report component; the number of controls depends on the report topic and whether the report definition includes additional entities. In the example to the left, the report topic is "Project" and the report includes tasks - so there is an ad hoc filter control for each. Whether filter values are included depends on whether the builder of the report included them.

Regardless of how the underlying report is set up, you can leave the settings as-is, or make changes. For example, you might decide that you want to allow dashboard consumers to use a Task filter, simply enable the 'Allow changing filter: When Viewing' checkbox for the task. Any changes you make here are NOT reflected back in the original report.

Date Range/Frequency

If the report component is a Time Series, then there will be default settings in the Variable Settings modal. As shown in the screenshot, the default is Frequency = Monthly, with a specified date range. Leave as-is, change, and/or give dashboard consumers the ability to change by enabling 'Allow changing: When viewing'. 

Change Variable Settings When Viewing

As mentioned earlier, you can configure each dashboard component to allow its consumers to change variable settings (filters, date/frequency for time series) while viewing the dashboard. Remember that is configured per dashboard component - that is, some reports might be configured to allow users to change a filter, while other report components will not.

Dashboard consumers can access these variable settings (if allowed) by clicking the Component menu (shown in the screenshot below left) and choose Edit Variable Settings to display the Variable Settings modal (shown below right).  In the example below, the Projects filter and time series settings can be adjusted. After hitting Apply, the dashboard is re-run.

If a dashboard has no configurable components, then there will be no Edit Variable Settings menu item.

2020-08-17_13-57-54.png
2020-08-17_14-06-19.png

Remove a Report Component

To remove a component from a dashboard, open its Component menu and choose Remove. This simply removes the report from the dashboard - it does NOT delete the report.