1. Home
  2. Other Releases
  3. On-premises 5.2
  4. Guides
  5. Tours
  6. Concepts
  7. Tools
    1. Alert Editor
    2. Alias Sync Tool
    3. Analyzer
    4. Apache Parquet Merge Tool
    5. Avro Extractor Tool
    6. Business Schema Designer
    7. Business Schema Manager
    8. Cluster Management Console
    9. Command Line Interface
    10. Content Manager
    11. Dashboard Filters Manager
    12. Data Agent
    13. Data APIs for External Notebooks
    14. Data Manager
    15. Formula Builder
    16. Formula Validation Tool
    17. Inspector Tool
    18. Join Editor
    19. Load Job Viewer
    20. Model Update Viewer
    21. Notebook Editor
    22. Profile Manager
    23. Public API
    24. Query Plan Viewer
    25. Scheduler
    26. Schema Designer
    27. Schema Diagram Viewer
    28. Schema Manager
    29. Schema Wizard
    30. Security Manager
    31. Table Editor
    32. Tenant Management Tool
    33. Versioning Migration Tool
  8. References
  9. Integrations
  10. Data applications
  11. Releases

Tools → Dashboard Filters Manager

About the Dashboard Filters Manager

The Dashboard Filters Manager allows a tenant user with the necessary access rights to create and manage dashboard filters.

There are four types of dashboard filters:

  • prompt which can be a filterable column, a partial filter expression, or a complete filter expression
  • presentation variable which is a referenceable and mutable variable within the scope of the dashboard and has a data type and a default value
  • applied filter which is a filter expression that affects all applicable insights on all tabs of the given dashboard
  • filter option which is a filter expression that affects all applicable insights on all tabs of the given dashboard
Note: Differences between dashboard filters and dashboard runtime filter

Whereas a dashboard consumer creates a dashboard runtime filter using the Filter bar or by interacting with an insight, a dashboard developer creates a dashboard filter using a Prompt, Applied Filter, Presentation Variable, or Filter Option.

Dashboard Filters Manager access rights

A user that belongs to a group with the Analyze User, Individual Analyzer, or SuperRole roles can access the Dashboard Filters Manager. To access the Dashboard Filters Manager for a given dashboard:

  • In the Action bar, select More Options (⋮ vertical ellipsis).
  • Select Manage Dashboard Filters.

Dashboard Filters Manager anatomy

The Dashboard Filters Manager consists of the following:

  • Action bar
  • Data panel
  • Manage Data Sets panel
  • Filters and Prompts panel
  • Properties panel
  • Filter values panel

Action bar

In the Action bar, you can:

  • Undo a previous action
  • Redo a previous undone action
  • Expand the tool to full screen or collapse the tool back to a model
  • Close the tool and return to the dashboard

Data panel

The Data panel shows an expandable and collapsable tree of available columns for a given dashboard dataset. A dataset can contain one or more of the following:

  • Physical schema
    • Alias
    • Physical schema table
    • Materialized view
    • Incorta Analyzer Table
    • Incorta SQL Table
  • Business schema
    • Business schema view
    • Incorta Analyzer View

In the Data panel, you can:

  • open the Manage Data Set panel (select Manage Datasets) and select the parent data set for the dashboard
  • expand or collapse all columns in the tree at the Schema Level or the Table Level
  • sort the tree by name or original order
  • show all columns, show columns by a specific data type group such as String or Numerical, or show columns by a specific function such as Key
  • search for a specific physical schema, business schema, table, view, or column
  • view the details of a column including sampling available data
  • add a Formula to the Prompts, Applied Filters, or Filter Options trays (drag and drop to a tray)
  • add one or more columns to Prompts, Applied Filters, or Filter Options (multi-select drag and drop to a tray)
Note: Schema Level and Table Level

The Data panel refers to both a Schema Level and a Table Level. Schema Level refers to both physical schemas and business schemas. Table Level refers to an alias, physical schema table, materialized view, Incorta Analyzer table, Incorta SQL table, business schema view, and Incorta Analyzer View.

Manage Data Set panel

The Manage Data Set panel contains two tabs: Views and Tables.

The Views tab contains one or more business schemas in a tree. A business schema can contain a business schema view or an Incorta Analyzer View.

The Tables tab contains one or more physical schemas in a tree. A physical schema can contain an alias, physical schema table, materialized view, Incorta Analyzer Table, or Incorta SQL Table.

Use the Manage Data Set panel to select one or more items for the dashboard dataset.

Note: Incorta Analyzer View limitations

For a dashboard dataset, avoid combining an Incorta Analyzer View with another business schema or physical schema. An Incorta Analyzer View has runtime limitations that may negate dashboard filters and dashboard runtime filters for insight's with differing query plans from the Incorta Analyzer View.

Here are some of the options available in the Manage Data Set panel:

  • search for a specific physical schema, business schema, table, or column
  • select a parent or child item in the tree
  • to save the dashboard dataset, select Done, otherwise continue creating the dashboard filters

Filters and Prompts panel

The Filters and Prompts panel contains four trays:

  • Prompts
  • Presentation Variables
  • Applied Filters
  • Filter Options

You can drag and drop one or more columns from the Data panel to a tray. To select multiple columns in the Data panel, you must use the following keystrokes:

  • On Mac OS, use command
  • On Windows OS and Linux OS, use Ctrl

Trays

From the Data panel, you can add one or more columns to a tray. When applicable, you can also add a formula to a tray. You can easily reorder columns and formulas in a tray by selecting the column or formula, and dragging it up or down the scrolled list to drop it in the desired location. All trays have a Clear All command. A column or formula in a tray is a Pill. Each pill has configurable properties. The parent tray determines the available properties of a pill.

Note: Change the name of the pill

To change the name of the column or formula that is a Pill, you must double-click. In the text box, you can modify the name. In this release, there is no visible Name or Label property for a pill.

Prompts tray

You can specify the order of two or more prompt pills:

  • Order Alphabetically
  • Order Manually

A prompt pill can be a formula or column.

Presentation Variables tray

To manually create a presentation variable, select + Add. To quickly define the Field (Optional) as a property, you can also drag and drop one or more columns from the data panel to the tray.

Applied Filters tray

An applied filter pill can be a formula or column. You can manually order the pills.

Filter options tray

To manually create a filter option, select + Add. A filter option pill can be a formula or column.

Properties panel

The Properties panel is specific to each tray and the given pill.

Properties panel for a prompt pill

A prompt specifies either a filterable column or a formula. For a filterable column, a prompt can define a partial or complete filter expression. The filterable expression serves a dashboard runtime filter. A prompt that is a formula typically is a filterable expression that also severs as a dashboard runtime filter.

As a filter expression, a prompt pill consists of at least one filterable column, a filter operator, and an optional filter value. A prompt pill that has a filter expression with an undefined filter value represents a partial filter expression. A partial filter expression results in an incomplete dashboard runtime filter, and as such, does not affect the dashboard.

Once defined and configured, a prompt always appears in the Columns panel of the Filter dialog. To learn more about the various properties of a prompt pill and how various configurations affect behavior, review Concepts → Prompt.

Properties panel for a presentation variable pill

Presentation Variables, use the tray to manage the presentation variable pills. Once defined and configured, a presentation variable appears as a filterable column in the Filter dialog and as a filter bar pill.

Properties panel for an applied filter pill

An applied filter is a filter expression that affects all applicable insights on all tabs of the given dashboard. It behaves the same way as a default filter option. The difference between them is that a dashboard consumer without Edit access rights to the dashboard is not aware of an applied filter.

Properties panel for a filter option pill

Dashboard Filters Manager actions for filter options

Using the Dashboard Filters Manager, you can perform the following actions for filter options:

Add a filter option

  • Using the Content Manager, access a dashboard.
  • In the Action bar, select More Options (⋮ vertical ellipsis).
  • Select Manage Filters & Prompts.
  • In the Dashboard Filters Manager, in the Action bar, select Filter Options (funnel with gear icon).
  • On the Filter Options list, select Add Filter Options (addition icon).
  • In the Filter Options dialog, in Name, enter the display name of the filter option as it will appear on the Filter Options list to dashboard consumers.
  • Enable the Default toggle to set the current filter option as default. Disable it to unset the default filter option.
  • From the Data panel, drag and drop one or more columns or new formulas to the filter tray in the filter option.
  • For each pill in the filter tray, select V (down arrow) next to the pill name to specify the filter option pill properties. To learn more about filter option pill properties, please review Concepts → Filter Option.
  • Select Done.
  • To save changes, in the Action bar, select Done.
Note

When you add multiple pills to a filter option, a row must match all the filter option conditions to include in the query result set.

Set or unset a default filter option

The default filter option is the one that is automatically applied when loading the dashboard. You can manually set a specific filter option as the default one; however, if you create only one filter option, it will automatically be the default. If you create multiple filter options without manually setting a default one, the first created filter option will automatically be the default. Only one filter option can be the default.

  • In the Dashboard Filters Manager, in the Action bar, select Filter Options (funnel with gear icon).
  • On the Filter Options list, select a given filter option.
  • Enable the Default toggle, to set the default filter option, or disable the Default toggle to unset the default filter option.
  • Select Done.
  • To save changes, in the Action bar, select Done.

Edit a filter option

  • In the Dashboard Filters Manager, in the Action bar, select Filter Options (funnel with gear icon).
  • On the Filter Options list, select a given filter option.
  • Make the necessary changes, and then select Done.
  • To save changes, in the Action bar, select Done.

Delete a filter option

  • In the Dashboard Filters Manager, in the Action bar, select Filter Options (funnel with gear icon).
  • On the Filter Options list, select a given filter option.
  • Select Delete.
  • To save changes, in the Action bar, select Done.

Dashboard Filters Manager actions for prompts

Using the Dashboard Filters Manager, you can perform the following actions for dashboard prompts:

Add a prompt

  • Using the Content Manager, access a dashboard.
  • In the Action bar, select More Options (⋮ vertical ellipsis).
  • Select Manage Filters & Prompts.
  • In the Dashboard Filters Manager, select Prompts.
  • From the Data panel, drag and drop a column or a formula to the prompts tray, or select + (a circle with addition icon) next to the column name in the Data panel.
  • For a given prompt pill, select V (down arrow) next to the pill name to specify the prompt pill properties. To learn more about prompt pill properties, please review Concepts → Prompt.
  • To save changes, in the Action bar, select Done.
Note

Starting with release 5.0, you can save a prompt that is a default filter without defining a filter value.

Manage prompt pills display order

You can manage the order of prompt pills in the Columns panel in the Filters dialog of the Filter bar. You can order them manually or alphabetically. Default filters are ordered separately, that is, they have their own order, and then they are followed by other filters in their order.

Here are the steps to control the prompt pills display order:

  • In the Dashboard Filters Manager, select Order Alphabetically or Order Manually as appropriate.
  • To save changes, in the Action bar, select Done.

Set or unset a prompt as a default dashboard runtime filter

Prompts that you use as default filters are displayed as dashboard Filters bar pills when dashboard consumers access the dashboard. Prompts serving as default filters can or cannot be mandatory dashboard runtime filters. A prompt serving as a default filter does not require a default value unless it is a mandatory one. For more information, please refer to Concepts → Prompt.

Here are the steps to set or unset a prompt as a default dashboard runtime filter.

  • In the Dashboard Filters Manager, select Prompts.
  • In the Prompts tray, for the prompt pill that you want to set as a default filter, select V (down arrow) next to the pill name.
  • In the prompt pill properties, enable the Default Filter toggle, to set a default filter, or disable the Default Filter toggle to unset a default filter.
  • For a default prompt,
    • Select Select Filter.
    • Select an operator and none, one, or more values.
    • Select Filter.
  • To save changes, in the Action bar, select Done.

Set a prompt as a mandatory dashboard runtime filter

A prompt can serve as a mandatory dashboard runtime filter that has a default filter value. A dashboard consumer is unable to remove or clear a mandatory prompt.

Here are the steps to set or unset a prompt as a mandatory dashboard runtime filter.

  • In the Dashboard Filters Manager, select Prompts.
  • In the Prompts tray, for the prompt pill that you want to set as a mandatory filter, select V (down arrow) next to the pill name.
  • In the prompt pill properties, enable the Default Filter toggle.
  • Select Select Filter.
  • Select an operator and none, one, or more values depending upon the selected operator.
  • Select Filter.
  • Enable the Mandatory Filter toggle.
  • To save changes, in the Action bar, select Done.
Note

When you disable the Default Filter toggle or change the filter expression to use an undefined filter value, the Mandatory Filter toggle is automatically disabled.

Edit a prompt pill

  • In the Dashboard Filters Manager, select Prompts.
  • In the Prompts tray, for the prompt pill that you want to edit, select V (down arrow) next to the pill name.
  • In the prompt pill properties, make the necessary changes.
  • To save changes, in the Action bar, select Done.

Remove a prompt pill

  • In the Dashboard Filters Manager, select Prompts.
  • In the Prompts tray, for the prompt pill that you want to remove, select X on the pill.
  • To save changes, in the Action bar, select Done.

Dashboard Filters Manager actions for applied filters

Using the Dashboard Filters Manager, you can perform the following actions for applied filters:

Add an applied filter

  • Using the Content Manager, access a dashboard.
  • In the Action bar, select More Options (⋮ vertical ellipsis).
  • Select Manage Filters & Prompts.
  • In the Dashboard Filters Manager, select Applied Filters.
  • From the Data panel, drag and drop a column or a formula to the applied filters tray, or select + (a circle with addition icon) next to the column name in the Data panel.
  • For a given applied filter pill, select V (down arrow) next to the pill name to specify the applied filter pill properties. To learn more about applied filter pill properties, please review Concepts → Applied Filter.
  • To save changes, in the Action bar, select Done.
Note

When you add multiple pills to the applied filters tray, a row must match the conditions in all the applied filters to include in the query result set.

Edit an applied filter

  • In the Dashboard Filters Manager, in the Action bar, select Applied Filter.
  • In the Applied Filters tray, for the applied filter pill that you want to edit, select V (down arrow) next to the pill name.
  • In the applied filter pill properties, make the necessary changes.
  • To save changes, in the Action bar, select Done.

Remove an applied filter

  • In the Dashboard Filters Manager, select Applied Filters.
  • In the Applied Filters tray, for the applied filter pill that you want to remove, select X on the pill.
  • To save changes, in the Action bar, select Done.

Dashboard Filters Manager actions for presentation variables

Using the Dashboard Filters Manager, you can perform the following actions for presentation variables:

Add a presentation variable

  • Using the Content Manager, access a dashboard.
  • In the Action bar, select More Options (⋮ vertical ellipsis).
  • Select Manage Filters & Prompts.
  • In the Dashboard Filters Manager, select Presentation Variables.
  • From the Data panel, drag and drop a variable to the presentation variables tray.
  • For a given presentation variable pill, select V (down arrow) next to the pill name to specify the applied filter pill properties. To learn more about presentation variable pill properties, please review Concepts → Presentation Variable.
  • To save changes, in the Action bar, select Done.
Important

Validation Rules for a presentation variable name

A presentation variable name…

  • Must begin with an alpha character, lower or upper case
  • After the first alpha character, can contain zero or more alphanumeric characters in lower, upper, or mixed case
  • After the first alpha character, can contain zero or more underscore (_)characters
  • Besides underscore (_), cannot contain special characters, symbols, or spaces

Edit a presentation variable

  • In the Dashboard Filters Manager, select Presentation Variables.
  • In the Presentation Variables tray, for the presentation variable pill that you want to edit, select V (down arrow) next to the pill name.
  • In the presentation variable pill properties, make the necessary changes.
  • To save changes, in the Action bar, select Done.

Remove a presentation variable

  • In the Dashboard Filters Manager, select Presentation Variables.
  • In the Presentation Variables tray, for the presentation variable pill that you want to remove, do one of the following:
    • Select X on the pill.
    • Select V (down arrow) next to the pill name, and then in the pill properties, select Delete.
  • To save changes, in the Action bar, select Done.