Knowi dashboard filters make it easy for the users to apply different data perspectives on the dashboard, across all the widgets. Once the filters are defined by the dashboard creators or admins, the end-user viewing the dashboard can select a particular filter or Filter Set to visualize the data of most interest on the dashboard. Moreover, some advanced filtering functionalities are also provided including auto-suggestions, multi-value filters, and date ranges.
Note: Knowi remembers the filtered view, hence the next time the user visits the dashboard, the same filtered view is displayed.
Quick Navigation for Frequently Asked Questions:
- How do I set up a new filter? Adding a New Filter
- How can I make a hidden filter, prevent filter deletion by end users, or require a filter value? Filter Behavior
- Can I create a default filter view for all users with access to the dashboard? Save as Global
- How will the end user edit and interact with the filters? End-User Filter Edit
- How do I change where filters appear on the dashboard? Filter Bar Placement
- How do I organize filters into sections? Group Headings and Dividers
Admin Settings
Admins and dashboard creators are provided with the ability to control the access of data and values the end-users can filter through any one of the following two options:
- Adding a new filter directly
- Fine-Tuning the available filters
In the subsequent sections, the step-by-step procedure for the implementation of the above two has been elaborated, to help admins and dashboard owners incorporate control on how data appears on the dashboard.
Adding New Filter
Step 1: Click on the Filters icon on the dashboard toolbar.
Step 2: Click on the +Add button and select Filter from the dropdown list.
Step 3: Configure the filter by defining the values for the following parameters:
- Fields to filter
- Condition type
- Value
- Filter Control
Note for the Condition Type:
- Equals is case sensitive.
- Contains is not case dependent (and slower in cases with large amounts of data)
- Users can use the Starts With condition type to filter records that start with the filter input value. This condition type can be used on integer or string field types only.
Note for adding Values:
- Users can add comma-separated values in the Value dropdown while creating filters. The records in the Value field are populated based on the field chosen in the Field to Filter dropdown. The filter type is Multiple in this case.
Note for the Nested fields:
If data contains JSON, the nested fields will be shown in the list to filter. A user can therefore filter on inner fields. Please note that this list will only contain a few nested fields as Knowi will not scan the whole dataset for the JSON data. However, Cloud9QL can be used to filter any nested field.
Step 4 (Optional): Make your filters more user-friendly by changing the name of the filter and adding a description.
- Change field label - Adjust the name of the filter
- Description - A question mark icon will be displayed beside the filter. When a user hovers over it, a description will appear for them to read.
Step 5: Hit the Save button and the filter will be added to the right sidebar.
Filter Behavior
The admin or dashboard creator can also toggle on any of the following two or both to further optimize the filter behavior:
Hidden: The filter will be applied to the dashboard but the definition of it will be completely hidden from the dashboard end users. It will only be available to view and edit by an admin or the dashboard creator.
Mandatory: If this option is set, the filter is always present on the dashboard and prevents the end-users from removing the filter. However, the end-user can still add or remove values from that filter.
Require Value: Set this option to optimize the filters and define a required value for the filters on the dashboard. To set this option, you need to toggle on the mandatory option.
- If you would like to require a value, and have the filter pick the first value from the picklist if none is selected, see our documentation on Require Value Filter with Empty Values.
Save as Global
Once the fields to filter are added through the Add button, the admin or dashboard creator will then have the option to save the newly created filter configuration as a Global Setting for all end users of the dashboard to see.
This, in essence, will be the end-user 'default view' when they first enter the dashboard. From here, they will be able to change the default selections and add in their own personal filters on top of the global view configure.
Clicking on the 'reset' will take the user back to the global default view of the data.
It is similar to a hidden filter in that it would provide a default view of the dashboard, however, it differs due to the fact that the end-user would not know the filter existed at all and could therefore not change any of the default values configured.
Advanced Filter Settings
The admin or dashboard creator has the ability to control advanced filter settings, including deciding which fields to either allow or forbid from using in the filters, and where and how the filter bar appears on the dashboard.
Step 1: Click on the Filters icon on the dashboard toolbar.
Step 2: Click on the Settings gear icon.
Step 3: Configure the settings described in the sections below and click Save.
Note: Pin Filter Bar, Placement, and Style are only available in the dashboard filter settings, not in widget filter settings.
Cascading Suggestions
When enabled, suggestions for filters will be in the order of filters enabled. For example, if there are three filters for country, state, and county enabling, this will display states for the country selected and counties will be based on the country and state selected.
Widget Field Filters
When enabled, filters are applied on the widget fields after any widget level data processing.
Lock Filter Set
When enabled, users cannot modify or remove filter sets. This prevents accidental changes to important filter configurations.
When Lock Filter Set is enabled:
- Edit and delete options for individual filters are removed
- Edit and delete options for the filter set itself are removed
- The filter set becomes mandatory (trash can icon is hidden)
- The X button and toggle controls are hidden
To modify or remove a locked filter set, admins must first disable "Lock Filter Set" in the settings.
Pin Filter Bar
When enabled, the filter bar stays pinned to the top of the dashboard and remains visible as users scroll down.
This setting applies when the filter bar Placement is Top. When filters are placed on the left or right, the filter panel always stays visible while scrolling.
Manual Configuration
Note: By default, all the fields are allowed.
| Access Type | Field |
|---|---|
| Allow | Select specific fields you want to provide to the end-users for filtering |
| Forbid | Select specific fields you don't want to provide to the end-users for filtering |
Step 4: After making the relevant selections, click on the Save button at the top to save your manual configurations.
Disable or Enable
As an admin or dashboard creator, you can temporarily disable or enable the existing filter(s) from the right sidebar to control the access of data and values the end-users can filter.
Edit Filter
As an admin or dashboard creator, you can edit the existing filter(s) from the right sidebar to control the access of data and values the end-users can filter.
Step 1: Click on the Edit icon of the filter you want to re-configure.
Step 2: Make relevant changes and click on the Save button.
End-User Filter Edit
Once the filters have been created and applied to a dashboard, it is very easy for the end-user to change the values in the filter itself. To do this, the end-user simply clicks on the filter in the dashboard filter bar and updates the values.
Filter Bar Placement
Placement controls where the dashboard filters appear. Dashboard filters can be placed at the top of the dashboard or in a side panel on the left or right. Filters, filter sets, group headings, and dividers work the same way in every placement.
Step 1: Click on the Filters icon on the dashboard toolbar.
Step 2: Click on the Settings gear icon.
Step 3: Under Placement, select Top, Left, or Right.
Step 4: Click Save.
The placement is saved with the dashboard and is the default view for everyone who opens it.
| Placement | Description |
|---|---|
| Top | Filters appear in a bar across the top of the dashboard. Click the Filters icon at the start of the filter bar to switch between the compact and expanded views. To keep the bar visible while scrolling, enable Pin Filter Bar. |
| Left | Filters appear in a side panel on the left side of the dashboard. The panel always stays visible while scrolling. |
| Right | Filters appear in a side panel on the right side of the dashboard. The panel always stays visible while scrolling. |
Side Panel Filters
When filters are placed on the left or right, the side panel collapses into a narrow bar with a Filters icon at the top, giving the dashboard widgets more room. The panel is collapsed each time the dashboard loads.
- Click the Filters icon to expand the panel and view the filters.
- Select or change filter values the same way as in the top filter bar. When you click away from the filter, the dashboard reloads with the new values.
- Click the Filters icon again to collapse the panel.
PDF Exports
Filter placement and style do not affect PDF exports. Exported dashboards always show the filters in the compact filter bar at the top of the dashboard, even if the dashboard uses a left or right side panel or the expanded style.
Filter Bar Style
Style controls how each filter is displayed on the dashboard. To set the style, open the filter settings from the Settings gear icon in the Filters panel, select a Style, and click Save.
| Style | Description |
|---|---|
| Compact | Filters are shown as small pills. Click a filter to open it and change its values. Compact saves space on dashboards with a long list of filters. |
| Expanded | Each filter is shown as a larger control, so users can see and change its values directly on the filter bar. Filters within a filter set are also spread out across the filter bar. |
The style is the default view when the dashboard loads. When the filters are placed at the top, users can click the Filters icon at the start of the filter bar to switch between the compact and expanded views. This switch is not saved, and the dashboard returns to its default style the next time it loads.
Paging Through Filters
When the filters are placed at the top and there are more filters than fit in the filter bar, use the arrows to page through them. In the compact style, the arrows appear at the end of the filter bar. In the expanded style, the arrows appear at the bottom of the filter bar.
Side panels on the left or right scroll instead of paging.
Group Headings and Dividers
Group headings and dividers organize dashboard filters into sections. They appear in every placement and style.
Step 1: Click on the Filters icon on the dashboard toolbar.
Step 2: Click on the +Add button and select Group Heading or Add divider from the dropdown list.
Step 3: For a group heading, type the heading name and press Enter. To change the name later, click the heading text.
Step 4: Drag the group heading or divider to where you want it in the list of filters. Filters placed below a group heading are grouped under it.
To remove a group heading or divider, click the x icon next to it.
Group headings and dividers can also be added inside a filter set. See Add Group Headings and Dividers to a Filter Set.