Filters
Overview
Universal Controller lets you apply filters to lists throughout the user interface.
You can:
- Create a filter and either:
- Apply it only to the list for which it was created.
- Apply it to multiple record types (see Global Filters) .
- Create any number of Filters for a list, and any amount of criteria for each Filter.
- Create a Filter and apply it to a list without saving it; you will not be able to re-apply it to the list.
- Create a Filter and save it; the filter is automatically applied to the list and saved so that you will be able to re-apply it to the list at any time.
- Save a previously saved Filter under a different name. You can edit the re-named Filter and apply it to the same list as the original Filter at any time.
By default, no filtering is applied to a list. This is indicated by the default value (-- No Filter --) for the Filter field in the List task bar. However, you can pin a saved Filter to a list to make that the default Filter for the list.
You also can create a quick, one-time filter (it is not saved) that allows you to sort a list by record name (see Go To Filter).
Creating a Filter
To create a Filter:
Step 1 | From the Services, select the record type list for which you want to apply a filter. |
---|---|
Step 2 | Click the Filter... button in the List task bar that displays at the top of the list. A Filter Details pop-up dialog displays. |
Step 3 | In the Visible To field, select whether you want the Filter to be visible to only to the logged in user, to any logged in user, or to any logged in user that belongs to the same user group as the logged in user. |
Step 4 | If you want the filter to be available for use for all record type that use filters, click the global checkbox. |
Step 5 | Using the field descriptions below as a guide, select criteria for the Filter. |
Step 6 | When you have selected the filter criteria, you can:
If you want to save the Filter, you must enter a Name for it. You do not have to enter a Name for a Filter if you only want to apply it. |
Note
You also can create a filter by viewing a saved filter on the Filters list and clicking the Save As... button. This new filter applies only to the record type list of the saved filter, but you can change any of its filter criteria.
Global Filters
Global filters can be created from any supported record type and can be used/applied in any record types.
For example, you can create a global filter for a type of task and use that same filter in Triggers or any other supported records.
Filter Fields
You can create global filters with the following common fields and use them on any supported record types.
Whichever record type has all of these common fields, the global filter can be created and re-used from other record types.
Field | Description |
---|---|
Name | Name of the record |
Description | Description |
Member of Business Services | List of Business Services |
Created | Created Date |
Created By | Created By |
Updated | Updated Date |
Updated By | Updated By |
UUID | UUID of the record |
Supported Record Types
You can create global filters for the following record types.
- Agent
- Agent Cluster
- Application
- Bundle
- Bundle Target
- Calendar
- Credential
- Database Connection
- Email Connection
- Email Template
- OMS Sever
- Peoplesoft Connection
- SAP Connection
- Script
- SNMP Connection
- Task
- Task Instance
- Trigger
- Variable
- Virtual Resource
Applying a Filter
There are two ways to apply a Filter to a list:
Applying a New Filter
To apply a new Filter to a list:
Step 1 | After you have created a Filter, click the Apply Filter button. The list then displays only those records that match the selected criteria. The Filter is identified as --Unsaved 1 -- in the Filter field on the List task bar. |
---|---|
Step 2 | If you want to save the applied Filter so that it can be re-applied to this list at any time, click the Save button. The Filter now is listed on the Filters list. |
Step 3 | To remove the Filter from the list and redisplay all records, click -- No Filter -- in the Filter field. |
Applying an Existing Filter
To apply an existing Filter to a list:
Step 1 | On the List task bar, click the Filter drop-down list arrow to display a list of all existing Filters for this list. |
---|---|
Step 2 | Click the Filter that you want to apply to the list. The list displays only those records that match the criteria of the selected Filter, which now is identified in the Filter field. |
Saving a Filter
Saving a Filter:
- Applies it to the list immediately.
- Saves it so that is can be applied again at any time.
Also,you must save a Filter if you want to pin the Filter to the list so that it replaces -- No Filter -- as the default Filter for the list.
To save a filter that you have created, click the Save button in the Filter Details. The saved Filter:
- Is applied to the list.
- Displays in the Filter drop-down list in the List task bar.
- Displays in the Filters list of all Filters created for all list.
Pinning a Filter
You can pin a saved Filter to a list so that the pinned Filter replaces -- No FIlter -- as the default Filter for the list. Only records in the list that match the criteria of the pinned Filter will be displayed, by default, on the list.
(Pinning a Filter to a list does not prevent you from selecting other Filters for the list.)
To pin a Filter to a list:
Step 1 | Create and save a Filter. |
---|---|
Step 2 | Apply the Filter to the list. The Name of the Filter is identified in the Filter field of the List task bar. |
Step 3 | Click the Filter button in the List task bar to display the Filter Details for the applied Filter. |
Step 4 | Click the Pin Filter button, and then click the Close button. (You do not have to click the Update button, as no changes were made to the details.) The pinned Filter has now become the default Filter for this list. |
Unpinning a Filter
If you have pinned a saved Filter to a list so that it has become the default Filter for the list, only records in the list that match the pinned Filter criteria are displayed. You must unpin the Filter in order to select -- No Filter -- as the default Filter, which allows all records in the list to display.
To unpin a Filter to a list:
Note
If the pinned Filter is the Filter currently applied to the list, skip to Step 3.
Step 1 | Click the Filter drop-down list arrow of the List task bar to display the list of all Filters for the list. The pinned Filter is identified with a check mark in the Pinned column. |
---|---|
Step 2 | Click the pinned Filter to apply it to the list. |
Step 3 | Click the Filter button on the List task bar to display the Filter Details for the pinned Filter. |
Step 4 | Click the Unpin Filter button, and then click the Close button. (You do not have to click the Update button, as no changes were made to the details.) The pinned Filter is no longer the default Filter for this list (although the unpinned Filter remains as the currently selected Filter for the list). |
Filters List
The Filters list displays a list of all saved Filters for all lists.
Step 1 | From the Administration navigation pane, select Configuration > Filters. The Filters list displays. |
---|---|
Step 2 | Click the Details icon next to a Filter Name or click anywhere in the Filter row to display Details for that Filter. Note If you want to apply a Filter to a list, you must select the Filter from the Filter field in the List task bar for that list. You cannot apply a Filter from the Filters list or from the Details of a Filter in the Filters list. |
Filter Details Field Descriptions
The following table describes the fields and buttons that display in Filter Details.
Field Name | Description |
---|---|
Details | This section contains detailed information about the Filter record. |
Table | Universal Controller table (record type) to which this Filter applies. |
Global | Indication for whether or not this filter will be available for multiple record types (see Global Filters). |
Visible To | Users that can see this Filter in the Filters drop-down list and apply the Filter to the list.
If you unselect a group that you are not a member of from the Visible To column, and submit the change, you will not be able to add that group back. You can only select and unselect visibility for groups that you are a member of. |
Name | Name of this Filter. |
Filter | This section contains the criteria for the Filter. |
Match All | Specifies that when this Filter is applied, the list will displays all records that match all of the criteria. |
Match Any | Specifies that when this Filter is applied, the list will displays all records that match any of the criteria. |
Add ( + ) icon (Filter Criteria fields) | Allows you to add three criteria fields for this Filter:
If you are filtering on date-related fields using the between (inclusive) comparison operator (SQL BETWEEN condition), the database query can produce unexpected results when the later date is specified before the earlier date. |
Buttons | This section identifies the buttons displayed above and below the Filter Details that let you perform various actions. |
Save | For a new Filter; applies the Filter to the list and saves a new Filter record in the Controller database. |
Save As... | For saved Filters; Creates a copy of the filter with a different Name and/or Visible To fields. |
Apply Filter | For a new, unsaved Filter; applies the filter to the list. |
Pin Filter | For a Filter; allows you to pin (select) the Filter as the default Filter for the list. |
Unpin Filter | For a Filter; allows you to unpin (de-select) the Filter as the default Filter for the list. |
Clear Filter | For saved Filters; clears the Filter of all criteria field values. |
Update |
Saves updates to the record. |
New | Displays empty (except for default values) Details for creating a new record. |
Delete |
Deletes the current record. |
Refresh | Refreshes any dynamic data displayed in the Details. |
Close | For pop-up view only; closes the pop-up view of this Filter. |
Unresolved and Variable Fields in a Filter List
For records that have one or more fields in which you can enter a variable instead of selecting a record type, the first of the three Filter Criteria fields includes two selections:
- <record type>Variable
- <record type>Unresolved
Variable refers to the Variable check mark field that is provided for a record type field. If you select <record type>Variable, a Comparison Operator, and a Value, and then apply the filter, the list will display only those records that have the Variable field check marked and which match the Comparison Operator and Value criteria.
Unresolved refers to the <record type> field itself in which a variable has been entered. If you select <record type>Unresolved, a Comparison Operator, and a Value, and then apply the filter, the list will display only those records that have the Variable field check marked and which match the Comparison Operator and Value criteria for the <record type> field.
Examples
The following examples illustrate Variable and Unresolved filter criteria being applied to a task list.
Example 1
Apply this filter criteria to list all tasks for which the Agent Variable field has been check marked.
Example 2
Apply this filter criteria to list all tasks for which the Highest Instance Time in Seconds is greater than 30 and the task Name contains the characters stonebranch.
Go To Filter
You can create a quick filter for a list that will filter the list by full or partial record name.
You can filter for a specific record name or for record names matching a Go To Operator user preference: contains, starts with, or equals.
To create a Go To filter:
Step 1 | From the Services, select the record type list for which you want to apply a filter. |
---|---|
Step 2 | Either:
A Go To pop-up dialog displays. |
Step 3 | Select an operator for the Go To filter (the current value of the Go To Operator user preference displays by default), enter a full or partial record name, and click the Go button. The list then will display only records that match your Go To filter selections. Note Selecting an operator that is different than the current Go To Operator user preference value does not change that user preference value. |