Configuring Form Filters
By Kevin Hsu - May 01, 2013
Filters are used to control the context within a form. When designing your form it is important to be aware of the different options available for configuration on the form.
Filter Configuration Options
Within the form editor there is a Filter section that allows you to configure the dimension and attributes that you have selected in Layout.
Default Member: For each filter, you can set a default starting member. It is recommended to default each member to the lowest member within a hierarchy to give better performance when the form is first opened.
Header Display: This will override the display of the hierarchy name for the filter title. If you leave it blank, it will display filter’s default header, which is set to the selected hierarchy/member list name of the dimension. In the example above, ‘Time’ will replace ‘FiscalYear’ in this form.
Read Only Filter: Filters can also be set to read only mode. When a filter is set to read only, users will not be allowed to change the value of the filter.
Select Multiple: Determine whether this filter allows selecting multiple members at a time.
Level Mode: With Level Mode enabled, the filter will provide each level of a Level Hierarchy as members to select. This is useful in conjunction with a Filter Variable as you allow the user to view different granularity on rows and columns based on selection of this filter.
Scope: A filter can contain a set. Only members from that set will be allowed for selection by end users.
Show All: If the form is configured with Advanced Relationship, then the filter will show only valid members based on the relationship. The Show All option is to override the show valid member relationship behavior by always showing the full definition of the hierarchy.
To understand relationship, please refer to Using Linked Model article before reading below.
A form can make use of one or more relationship to define the valid combination of members across dimensions within a model. For instance, there might be a set of products that are sold in certain countries, or a relationship that defines which Accounts are valid for a set of Departments. You can configure relationship on a form by using the measure from a linked model of the parent model.
In the ‘By Metric’ form in Workforce sample application, there are three restrictions that will be applied.
1. When a user selects a department, the employee type will only show the options that the department has. For example, there is no Contract employee in AMERICAS, so when Department Filter is set to ‘AMERICAS’, ‘Contract’ will be hid from the candidate list.
2. The form will only display the employees that belong to that department.
3. Certain Employee Type has its own group of Metrics. So the candidate list of Metric filter will be dynamically adjusted based on the selection of Employee Type filter.
These restrictions can be realized by two relationships, as shown below.
The first relationship is from the Dep-Emp-Type Validation model. We have applied this relationship to Row for the first restriction and to Employee Type filter for the second restriction.
Below is an example of some records in this model:
For example, the first record validate the ‘709-80000-Hourly’ relationship. Therefore Employee 80000 will show in the form when the Department filter is set to ‘709’ and ‘Hourly’ is selected for Employee Type filter.
It’s easy to understand how the second relationship (Emp Type-Metric Validation_Validation) applies to the third restriction. However, if we apply this relationship to Rows, it works just as well. The main purpose for this is to avoid invalid input when the selection values of Employee Type and Metric are not valid. The following video shows what happens if the Row box is unchecked.
In this case, since the Hourly-Base Annually Rate is not valid, the relationship does not apply its effect to the row axis of the form. Therefore the form will still be rendered.
On the other hand, let’s take a look at the scenario when the Row box is checked.
Now the relationship will pose its validation to the row axis, which results in a blank canvas to avoid invalid input.
Filter in different forms can be linked together. This can be configured in Administrator. See detailed in ‘Filter Groups’ Section in the Kepion Administrator Guide.