TL;DR
You can use component M5580 to configure filters once and reuse them in different parts of an app, such as export reports and timelines. Filters are managed from the Filters overview and configured on the Filter details page. You can define whether a filter appears as a field or dropdown, how dropdown values behave, etc.
Context and background
Component M5580 provides the core functionality for setting up reusable filters. It contains:
- A Filters overview under General views
- A Filter details page
- Settings for filter behavior and filter panel behavior
The examples below use these component revisions:
- M6170 r97
- M5580 r43
Configuring a filter
On the Filter details page, you can configure the following fields:
-
Title > The visible name of the filter.
-
Sequence > The display order of the filter. This is set automatically, but can be set/adjust manually.
-
Active > Indicates whether the filter is active. The default value is Yes.
-
Filter type >
Determines how the filter is shown in the left-side filter panel:- Field
- Dropdown
-
Filter selection type >
Only relevant when Filter type = Dropdown.
Defines how many values a user can select:- Single select
- Multi select
-
Filter search type >
Only relevant when Filter type = Dropdown.
Defines how dropdown values are searched when the user types in the field:- Contains
- Starts with
-
Enable “(de)select all” functionality >
Only relevant when:- Filter type = Dropdown
- Filter selection type = Multi select
This option allows users to select or deselect all dropdown values at once.
-
Context type >
Can be filled in when context is used for expressions (value expression, filter expression, sort expression > check below). For example, a data type could be a team, a context type – departments, and a user can filter a team form a particular department. -
Internal name > The technical/internal name of the filter.
-
Data type >
Defines whether the filter is based on a primitive value (such as string, number, or date) or a record (such as activity, product, team, or another entity). -
Value expression >
Only relevant when Filter type = Dropdown.
Defines what the filter displays to the user, for example a product description or product code. -
Filter expression >
Only relevant when Filter type = Dropdown.
The default value is true, meaning no additional filtering is applied.
You can use this expression to limit available dropdown values, for example to only show active records. -
Sort expression >
Only relevant when Filter type = Dropdown.
Defines the order in which dropdown values are shown. -
Default value expression >
Use this when a default filter value should be prefilled. -
Remarks >
Free text field for additional notes or explanation.
Configuring filter panel behavior
On the General Settings details page, under the tabbed panel Management settings, there is a form called Filter panel behavior.
Here you can define:
- Expand behavior
Determines whether the filter panel expands in:- Edit mode
- View mode
- Apply behavior
Determines what happens after a user applies or cancels the filter:- Collapse the filter panel
- Keep the filter panel expanded
Example: Using a filter in an export report
After a filter has been added, it can be used in other places, such as an export report.
To add a filter to an export report:
- Open the relevant export report.
- Check whether the linked export definition uses parameters.
- Go to Export report parameters overview.
- Click on Get parameters.
- Open the newly added parameter record(s), notice that the name(s) will be predefined according to the name of the parameter(s) in the export definition.
- Select the filter(s) that should be linked to the parameter.
- Generate the report. The selected filter(s) will be applied.
Feedback
If this article is unclear or missing an example, please add feedback so the article can be improved.