1. Home
  2. On-premises 5.1
  3. Guides
  4. Tours
  5. Concepts
    1. Aggregate filter
    2. Alias
    3. Apache Avro™
    4. Apache Kafka™
    5. Applied filter
    6. Base table
    7. Bookmark
    8. Business schema
    9. Business schema view
    10. Business schema view column
    11. Business schema view formula column
    12. Column
    13. Connector
    14. Dashboard filter
    15. Dashboard folder
    16. Dashboard runtime filter
    17. Data agent
    18. Data alert
    19. Data destination
    20. Date system variable
    21. Distinct filter
    22. Expression
    23. External data source
    24. External session variable
    25. Filter expression
    26. Filter expression session variable
    27. Filter option
    28. Formula column
    29. Formula expression
    30. Full load
    31. Global Variable
    32. Incorta Analyzer Table
    33. Incorta Analyzer Table column
    34. Incorta Analyzer Table formula column
    35. Incorta SQL Table
    36. Incorta View
    37. Incorta View formula column
    38. Individual filter
    39. Insight filter
    40. Internal query expression
    41. Internal session variable
    42. Join
    43. Join condition
    44. Join condition column
    45. Join filter
    46. Join filter column
    47. Level based measure
    48. Load filter
    49. Local data file
    50. Local data folder
    51. Materialized View
    52. Materialized View Column
    53. Materialized View Formula Column
    54. Measure filter
    55. Miscellaneous system variable
    56. Multi-Source table
    57. Physical schema
    58. Physical schema table
    59. Physical schema table column
    60. Physical schema table formula column
    61. Physical schema table runtime security filter
    62. Presentation variable
    63. Prompt
    64. Query system variable
    65. Runtime business view
    66. Runtime business view formula column
    67. Runtime security filter
    68. Session variable
    69. Shared Storage
    70. SQL Interface
    71. Upgrade Readiness
    72. Variable
    73. Visualization
  6. Tools
  7. References
  8. Integrations
  9. Data applications
  10. Releases

Concepts → Dashboard Runtime Filter

About a dashboard runtime filter

A dashboard runtime filter is a user-defined filter for a dashboard. A dashboard consumer creates and applies a filter expression through various interactions such as:

  • using the controls in the Filter bar in the dashboard
  • selecting a dashboard tab in the Go To menu in an insight
  • selecting a dimension or measure value in an insight
  • selecting a dimension in the Filter By menu in an insight

For example, for a Listing Table insight, a dashboard consumer may select a value that is a measure. This very insight interaction designates the measure as a filterable column in the filter expression for the dashboard runtime filter.

Once created, the dashboard runtime filter is applied to all applicable insights on all tabs of a given dashboard. The dashboard runtime filter also appears as a filter bar pill.

The filter bar pill shows the filterable column, the filter operator, and depending on the operator, one or more selected filter values.

A dashboard consumer can create a bookmark for an existing dashboard runtime filter.

Note

A dashboard runtime filter differs from a dashboard 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.

About a filter expression for a dashboard runtime filter

An example of a filter expression is to return only the rows where the Product Category column has "Electronics" as a row value. In this regard, a filter expression consists of:

  • a filterable column, e.g. Product Category
  • a filter operator, e.g. equals
  • a filter value, e.g. "Electronics"

The filter expression context for a dashboard runtime filter consists of one or more filterable columns.

About a filterable column for a dashboard runtime filter

A filterable column is a column from a physical schema table or runtime business view. A filterable column can be a key, measure, or dimension.

The default behavior of a dashboard is to coalesce a list of dimension columns from all insights on all tabs as filterable columns available in the Filter and Search controls of the Filter bar.

Note

A user interaction with a measure on an insight create a filterable column that is a measure. The filter bar pill for is editable. In this manner, a dashboard consumer can modify the filter operator or filter value for a filterable column that is a measure.

About a filter operator for a dashboard runtime filter

A filter operator defines the operation for the filter expression. The available operators depends on the data type of the filterable column.

OperatorDateTimestampIntegerLongDoubleStringText
Equalsxxxxxxx
Does Not Equalxxxxxxx
Greater Thanxxxxxxx
Greater Than or Equalsxxxxxxx
Less Thanxxxxxxx
Less Than or Equalsxxxxxxx
Null (an absence of any value)xxxxxxx
Not Null (must contain a value)xxxxxxx
In ( as In a list of one or more values)xxxxxxx
Not In ( as Not In a list of one or more values)xxxxxxx
Starts Withx
Does Not Start Withx
Containsx
Does Not Containx
Ends Withx
Betweenxxxxxxx
Is Descendantxxxxxx

About a filter value for a dashboard runtime filter

A filter value depends on the filter operator and is typically one of the following:

  • one or more values that you select within the index of the filterable column values
  • one or more values that you enter
  • a range of values such as a Start Date and End Date or From and To

A filter value can be a scalar value, array of scalar values, or a reference to a variable as follows:

About an applicable insight for a dashboard runtime filter

A dashboard runtime filter applies the filter expression to all applicable insights on all tabs of a given dashboard.

For a filterable column, an applicable insight meets one of the following conditions:

  • the filterable column is a dimension or measure column in the insight
  • the filterable column has a sibling dimension column from the same physical schema table, and that sibling is a dimension for the insight
  • the filterable column is a dimension that shares a measure on the insight from a common child table with other dashboard insights

If an applicable insight already contains an insight individual filter, a dashboard runtime filter will complement the insight individual filter based on a common filterable column as described above.

Important: Incorta View

If a filterable column is from an Incorta View, the applicable insight must contain only measures or dimensions from that Incorta View. Similarly, a filterable column is not from an Incorta View, the applicable insight must not contain measures or dimensions from an Incorta View.