Define Tab Filter Properties for a Form Arrangement
Use the Filters page in the Tab Properties window to define how content from a one-to-many Relationship is filtered on the form arrangement tab (example: Filter Journals based on type).
Filters can be:
- Pre-applied: Define an expression to pre-filter the content on the tab.
- User-applied: Define and display a Filter button/drop-down on the tab's toolbar so that users can filter their own content. You can also define a default behavior for the Filter button, and include a Search option so that users can search for specific data.
- Applied when linking records: Define and display a Filter button/drop-down in the Record Selector window when adding records to a tab.
The Tab Properties window is available in the Form Arrangement Editor (within a Blueprint in CSM Administrator). The Filters page is only available for tabs that display child objects in one-to-many relationships (example: Journals, Configuration items, etc.). Defining filters when linking records is only available for one-to-many links relationships (example: Change Requests).
To define a pre-applied filter for a form arrangement:
- Open a form arrangement in the Form Arrangement Editor.
- On a tab, right-click and select Properties.
- Select the Filters page.
- Define a pre-applied filter:
- Limit the rows that appear: Select this check box to use an expression to pre-filter the content on the tab. Then, define the expression using one of the following options:
- Stored Expression: Select the ellipsis to open the Expression Manager, and then select an existing stored expression or create a new stored expression. Stored expressions can be reused in numerous places in CSM.
- Custom Expression: Select the Custom Expression button to open the Custom Expression Builder, and then create a custom expression specifically for this scenario.
- Limit the rows that appear: Select this check box to use an expression to pre-filter the content on the tab. Then, define the expression using one of the following options:
-
Select OK.
To define a custom user-applied filter for a form arrangement:
- Open the Form Arrangement Editor.
- On a tab, right-click and select Properties.
- Select the Filters page.
- Define and display a custom Filter button/drop-down on the tab's toolbar so that users can filter their own content:
- In the Custom Filters area, create/edit/delete/order custom filters (each custom filter is displayed in the Filter drop-down):
- Add: Select this button to open the Filter window, and then create a new custom filter (name the filter and define the expression).
- Edit: Select this button to open the Filter window, and then edit an existing custom filter.
- Delete: Select this button to delete an existing custom filter.
- Up/Down Arrows: Select to change the order in which the custom filters are displayed in the Filter drop-down.
- Default Button Behavior: Select a default behavior for when a user selects the Filter button (rather than the Filter drop-down arrow).
- Show Drop-down List: Select this option to display a drop-down of available filters.
- Search Dialog: Select this option to open the Search window, where users can search for specific data. This option is only available if the Display Search Option (below) is checked.
- Custom Filter: Select a custom filter to apply.
- Display Search Option: Select this check box to include a Search option in the Filter drop-down. The Search option opens a window, where users can search for specific data.
- In the Custom Filters area, create/edit/delete/order custom filters (each custom filter is displayed in the Filter drop-down):
-
Select OK.
To define filters for a record selector (when adding records to a tab):
- Open a form arrangement in the Form Arrangement Editor.
- On a tab, right-click and select Properties.
The Tab Properties window opens.
- Select the Filters page.
- In the Filter List when Linking Records area, define a list of filters that users can select when adding records to a tab.
- Select Add to add a constraint or filter.
- Define the constraint:
- Field: Select a field in the Business Object you are currently working with.
- Operator: Select an operator (example: Equals).
- Value: Select a value for the field. Applicable values include:
Select OK.
- Add additional constraints as necessary.
- Define additional properties for the filter:
- Filter Display Name: Type a name to display next to the Filter button in the record selector window.
- Allow User to Choose Records that Don't Meet the Limiting Filter: Select this check box to allow users to select records outside of the defined list of filters.
-
Select OK.
- Publish the Blueprint to commit the changes, or save the Blueprint to continue making other changes.