Global Filters
Filter a Whole Home Page at Once
Global filters let users narrow every dashboard and report widget on a Home page with one set of filters, instead of setting the same filter on each widget. A user picks a parent, a state or an attribute value once, selects Apply, and every widget that can use that filter updates.
You set global filters up in the Home template, in Design Studio. They appear as a filter card above the widgets.
Before You Start
- Global filters are available on Home templates only.
- They act on Dashboard and Report widgets. Text, Rich Text, Separator, Tasks, Messages, Activity Log and custom widgets are not filtered.
- A filter is only offered when at least one widget on the template can use it. Protrak reads the query behind each widget to find out, so add your widgets first and set up the filters afterwards.
Set Up Global Filters
- Open the Home template in Design Studio.
- Select Template Settings (⚙).
- Select Show Global Filters.
- Fill in the card settings, then add the filters you want.
- Select Ok, then Save the template.
Card Settings
| Setting | What It Does |
|---|---|
| Title | Heading of the filter card (up to 255 characters). Leave it empty for a card without a heading. |
| Filter layout | Separate rows puts parent, state and attribute filters on their own rows. Single row flows them in one wrapping row. |
| Collapsible | Lets users fold the card away. A collapsible card always has a heading, so an empty title falls back to Global Filters. |
| Collapsed by default | Starts the card folded. Available when the card is collapsible. |
| Show parent / state / attribute filters | Turns a whole section on or off without deleting its filters. |
In both layouts, a divider separates the parent, state and attribute groups.
Add Filters
Each section has an Add list with the filters that the widgets on this template can use. Pick one and select Add.
| Filter | What users filter by | Per-filter settings |
|---|---|---|
| Parent | A parent record, such as a plant or site, reached through a relation | Display name, Depends on (a parent above it), optional default, Show as: Path controls or Hierarchy rail |
| State | The states of a lifecycle | Display name, default states, Show as: Chips, Capsules or Dropdown |
| Attribute | A value of an attribute, with a condition such as contains | Display name, default value, Show as: Readable line, Compact row or Column markers |
Good to know:
- Display names must be filled in and unique across all three kinds of filter, ignoring upper and lower case.
- Depends on narrows a parent by the one above it. Changing the upper parent clears the levels below it. A parent can only depend on a parent listed before it.
- Attribute defaults are required, except for conditions that need no value (for example Is empty or Today). Between needs both values.
- Attribute filters support every attribute type. Every condition of the widget's query is offered. In and Not in take one value per line (a multi-select for a picklist).
- The default of a parent is a record in the tenant, so it is not exported with the schema.
See Which Widgets a Filter Reaches
Next to each filter's name, the info icon lists:
- Applied to widgets: the widgets that use this filter in their query.
- Not applied to widgets: the other dashboard and report widgets on the template.
Each widget in the list has an open icon that opens its type widget in a new tab, so you can add the filter to its query. If a filter shows No widget in this template uses this filter, no widget can use it yet and it has no effect.
What Users See
- The filter card sits above the widgets. Users change the filters and select Apply. Nothing changes on the page until then, so several changes cost one refresh per widget.
- Reset returns the filters to your defaults and applies them.
- A widget takes the selection only when the filter is part of its own query. Other widgets keep their data.
- A filter the widget has set as enforced is never overridden.
- After Apply, the widgets that the change updated get a coloured outline, so users can see what the filters acted on.
- A widget that has scrolled out of view loads the new selection when the user scrolls back to it.
- Auto-refresh keeps the applied filters. Users do not have to apply them again after a refresh.
- The selection lives on the page only. It starts from your defaults again when the page is reopened.
- On mobile and tablet, where the page shows one widget at a time, the filter card sits above the selected widget.
Preview
Preview in Design Studio shows the filter card and the outline, using the settings as you have them in the editor, so you can check the layout before you save.
Tips
- Give each filter a short display name that matches how your users talk about the data.
- Use Single row for a few compact filters and Separate rows when there are many.
- Add a Text widget above the widgets to explain what the filters do, if your users are new to them.
- To change which widgets a filter reaches, edit the query of the widget's type widget. Then reload the template in Design Studio so the info icon reads the new query.