Introduction
Filters are used to control the context within a Form. Modelers should also know about the advanced Filter settings available so that they can build Forms optimized for users.
Filter Configuration Options
Within the Form editor, there is a Filter section that allows you to configure the Dimension and Attributes selected in Layout.
Field | Description |
---|---|
Header Display | The Header Display overrides the Hierarchy's name. If you leave it blank, the Form will display the Filter’s default header, which is set to the selected Hierarchy/Member List name of the Dimension. |
Default Member | For each Filter, you can set a default starting Member. We recommend to default the lowest Member within a hierarchy to optimize performance when the Form is first opened. For more information on setting Default Members, check the section below. |
Scope | A Filter can contain a set of Dimension Members. Only members from that set will be allowed for selection by end users. If you need to scope your Filters dynamically, read this article on relationships. |
Multi-Select | Determine whether users can select multiple Members for the Filter. |
Read-Only | When a Filter is set to read-only, users cannot change the Filter's value. |
(Leaves-Only) Selectable | Shows a checkbox beside each Hierarchy Member without any children, with the parent members being non-selectable. |
(All) Non-Selectable | Removes the checkbox from the All Member, preventing it from being selected. |
Options |
Further Form customizations options detailed below. |
Default Member
Select one of the icons displayed in the Default Member column.
Option | Description |
---|---|
Selected Member | The default setting, which allows you to pick a Default Member from the Member List. |
Custom Member | Enter custom display text in this field (e.g., "Please select..."). |
Member Variable | Rather than hard-coding a specific default Member, you can set a Member Variable as the default that dictates Filter updates across many Forms. This affects only the default behavior. Users will be able to save Apps with a different Filter selected. Refer to the Member Variables article for more information. |
Member Variable (Dynamic) | A dynamic Member Variable behaves, for the most part, similarly to a standard Member Variable; however, the former ensures user-saved Apps always open with the Filter set to the current Member Variable setting in the Modeler. |
Options
Select one of the icons displayed in the Options column.
Field | Description |
---|---|
Ensure Selection | Enforces selection of at least one Member. |
Auto Refresh | Automatically refreshes the Form every time the Filter selection is changed. |
Expand All | If the Form is configured with an Advanced Relationship, then the filter will show only valid Members based on the relationship. This option overrides the Show Valid Member behavior by always displaying the Hierarchy's full definition. |
Level Mode | Makes each level of a Level Hierarchy selectable Members. It is useful in conjunction with a Filter Variable as users can view different granularities on rows and columns based on Filter selection. |
Explicit Security | Displays only the Members the user has explicit permission to view. For example, when the user has permission to only view leaf Members of a PC Hierarchy, the Filter will show only the leaves and not the parents. |
Further Reading
- Capture Filter Selections with @FilterScope
- Clear Non-Valid Filter Selections
- Configure Mapping Filters
- Manage Dashboard Filters
- Update Dashboard Filter with Rule
- Use Filter Variables
- Use Member Variables in Form Filter