Concepts → Filter Option
About a Filter Option
Filter options are a set of predefined filters you add to a dashboard. End users can choose from these filter options at the dashboard runtime. One filter option can be the default one that is automatically applied when loading the dashboard. The end user has to choose one filter to apply. Filter options, as with other dashboard filters, apply to all insights on the dashboard.
Filter options allow end users to view the same dashboard with different filters. Instead of applying runtime filters or applied filters and creating bookmarks, filter options are there for the user to choose from.
Valid References in a Filter Option
When creating a filter option, you can use either a formula or a column (whether data-backed column or formula column), and accordingly, you can reference different objects in the filter option as follows:
- Use a formula to add a filter expression
- Use a formula to add a dynamic filter referencing a filter expression session variable
- Use a Physical_Schema.Table.Column to filter by specific values or by referencing an internal session variable, external session variable, or global variable
- Use a Physical_Schema.Incorta_Table.Column to filter by specific values or by referencing an internal session variable, external session variable, or global variable
- Use a Physical_Schema.Materialized_View.Column to filter by specific values or by referencing an internal session variable, external session variable, or global variable
- Use a Business_Schema.View.Column to filter by specific values or by referencing an internal session variable, external session variable, or global variable
- Use a Business_Schema.Incorta_View.Column to filter by specific values or by referencing an internal session variable, external session variable, or global variable
| Filter using | Filter Expression | Filter Expression Session Variable | Specific Values | Internal Session Variable | External Session Variable | Global Session Variable |
|---|---|---|---|---|---|---|
| Formula | ✔ | |||||
| Dynamic Formula | ✔ | |||||
| Physical_Schema.Table.Column | ✔ | ✔ | ✔ | ✔ | ||
| Physical_Schema.Incorta_Table.Column | ✔ | ✔ | ✔ | ✔ | ||
| Physical_Schema.Materialized_View.Column | ✔ | ✔ | ✔ | ✔ | ||
| Business_Schema.View.Column | ✔ | ✔ | ✔ | ✔ | ||
| Business_Schema.Incorta_View.Column | ✔ | ✔ | ✔ | ✔ |
The join relationship between physical schema tables determines the behavior of filters applied to dashboards. For example, when filtering by a column in a parent table, this filter automatically applies to all the dashboard insights related to this table’s child tables. On the contrary, using a column in a child table for filtering a dashboard does not affect the insights related to parent tables.
This same behavior applies to referencing a physical schema table in a filter option.
Filter Option Properties
The following are the general properties of a filter option.
| Property | Description | Comments |
|---|---|---|
| Name | Enter the name of the filter option as it will appear on the Filter Options list | |
| Default | Enable this option to set the current filter option as default | If you create only one filter option, it will be the default even if you haven’t enabled this option. |
| Filter | Drag the column or add a new formula to use for the filter option | |
| Formula | Define the properties of the formula used as a filter option | Available only if you use a New Formula for the filter option |
| Column | Define the properties of the column as a filter option | Available only if you use a column for the filter option |
Formula filter option properties
The following are the properties of a formula filter option.
| Property | Control | Description | Comments |
|---|---|---|---|
| Name | text box | Enter a name for the new formula | |
| Dynamic | toggle | Enable this option to select a filter expression session variable instead of creating a filter expression | |
| Value | drop down list | Select the filter expression session variable | Visible only when Dynamic is enabled |
| Formula | text box | When selected, it invokes the Formula Builder to create the filter expression | Visible only when Dynamic is disabled |
| Edit Operator/Value(s) | button | Click to determine the filter operator and values | Visible only when Dynamic is disabled |
Column filter option properties
The following are the properties of a column filter option.
| Property | Control | Description | Comments |
|---|---|---|---|
| Column name | label | Displays the fully-qualified name of the column you dragged | |
| Name | text box | Enter a display name for the column | Not displayed to end users |
| Edit Operator/Value(s) | button | Click to determine the filter operator and values | You can reference an internal session variable, external session variable, or global variable for the values. |
View Access Rights
In order to reference a column or variable in a dashboard filter option, you must have View access privileges to the grandparent object (schema or business schema) or the variable.
Apply a Filter Option
After creating filter options, the Dashboard page shows the Filter Options icon (padlock) next to the dashboard name. Select the icon to view a list of the filter options defined for this dashboard. Select a filter option to apply to all insights on the dashboard, if applicable.