Filters
This module defines the filter panel of a room: the metadata the user can narrow the content list on, and the way each one is presented to them.
It also defines predefined filters, described below.
Metadata configuration
- Name: metadata chosen in the list.
- Mode:
- Editable: presents the metadata in a text field to allow typing.
- Facet: presents every value in facet mode to select.
- Sort mode:
- Alphabetical order: sort in alphabetical order.
- Occurrence number: sort by number of occurrences.
Predefined filters
A predefined filter is a filter written in advance by the configurator and offered ready-made to the user, as a simple checkbox.
It answers two needs. First, expressing a criterion the user could not formulate themselves with the filter panel: the panel can only filter metadata by metadata, whereas a predefined filter relies on a GQL predicate and can therefore cross several conditions: for instance "my current contracts reaching their term". Second, setting a working frame: a predefined filter can be active as soon as the room is entered, which narrows from the start what the user sees, and can be locked so they cannot remove it.
A predefined filter can also stay invisible: it then applies without appearing in the panel. Finally, the filters display flow can condition its use, in particular on the location of the user.
Predefined filters appear first in the filter list.
Parameters
-
GQL Predicate: GQL predicate that defines the filter. Use the keys as defined in the template. Refer to the GQL reference guide for more details. For instance:
standard.status = 'Approved' -
Activated: the filter is ticked from the start. It therefore applies as soon as the room is entered and is set back on each reload.
-
Displayed: the filter is listed with the others in the panel (label and checkbox, not sorted, first) and as chips.
-
Locked: the checkbox of the filter is greyed out and its chip cannot be removed: the user cannot turn it off.
Other options
- Sorting filters panel: sorts the filter panel in alphabetical order, or uses the position in the filter table.
- Filtering type for facet value: defines how the text of the editable value is filtered (contains or starts with).
Flows
This module can be used in the following flow: