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.
Note: 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>Properties.
- Click 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: Click the Ellipses button 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: Click 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.
- Right-click on a tab, and select Properties.
- Click 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: Click this button to open the Filter window, and then create a new custom filter (name the filter and define the Expression).
- Edit: Click this button to open the Filter window, and then edit an existing custom filter.
- Delete: Click this button to delete an existing custom filter.
- Up/Down Arrows: Click 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 clicks 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.
- Right-click on a tab, and select Properties..
The Tab Properties window opens.
- Click 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.
- Click 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 (File>Publish Blueprint) to commit the changes, or save the Blueprint (File>Save Blueprint) to continue making other changes.