Filters

To create a new filter

1. Do one of the following:

   • On the page where you want to add a new filter, select Menu > My filters.

   • On the Task dashboard page, select the filter options button .

2. Select New.

3. Complete the following fields.

   Field	Action
   Name	Enter a name for the filter. This name appears in the filter menu, so choose a name that is concise and meaningful.
   Description	Describe the purpose of the filter.
   Primary	Select Yes to designate the current filter as the primary. The default setting is No. Notes: When you set a filter as primary, it is applied automatically when you open the page. You do not need to select a primary filter. Only one filter can be primary at a time. When you assign a filter as the primary, Civic Platform resets the Primary field for all other filters to No.

4. In the Search by section, build your query using the options described below.

   

   #	Description
   A	For most filters, you can leave this box blank. If you are creating a complex query that requires parentheses to group operations, you can enter an open (left) parenthesis. (The corresponding right parenthesis is entered in the second to last field.)
   B	Choose the desired field. The current page determines the available filter fields. For example: The filter fields for the Task dashboard page include options for filtering your tasks. The filter fields for Record list page include all the record fields in the record search form, plus Application-specific info, Address template, Owner template, Parcel template, and Module name. The filter fields for other pages are the fields that display in the search form of each page. Notes: If the Application-specific info (ASI) option is available and you select it, Civic Platform displays all the ASI groups in a pop-up window. Select an ASI group code from the ASI group code field, and then select the desired ASI field in the ASI field tree. If Address template, Parcel template, or Owner template are available and you select one of them, Civic Platform displays all the active template attributes in a pop-up window. Select the desired attribute.
   C	Choose the desired relational operator. For a list of available operators, see Relational operators.
   D	Specify the specific value or variable against which you want to compare the data in field B. You can manually enter a value in this field, or you can select the Variable picker button to the right of the field and select a variable from the Variable list. For a list of variables, see Filter variables. If you select a user-name-related field for the filter field, Civic Platform displays three fields where you can specify the first name, middle name, and last name of a person, instead of one Value field. For a list of user-name-related pages and filter fields, see User-name-related list pages and search by fields. If you select a variable for a name field, Civic Platform turns the three fields into a read-only Full name field and populates the field with the specified variable.
   E	For most filters, you can leave this box blank. If you are creating a complex query that requires parentheses to group operations properly, you can enter a close (right) parenthesis. (The corresponding left parenthesis is entered in first field.)
   F	Select a logical operator in this field if you are querying additional fields (for example, you want to query by date and/or location). Select AND if you want the query to use both this field and the next field to find matches. Choose OR if you want the query to use either this field or the next field to find matches. If you don't get the results you are expecting, try using parentheses to group operations.

5. To add another field to the filter, select the New field button and repeat step 4.

6. (Optional) Select the Preview SQL button to view the SQL query that will run when the filter is applied.

7. Select Submit to save the filter.

You can modify or delete filters that you created. However, you cannot modify or delete filters created by administrators.

To modify or delete a filter

1. Do one of the following:

   • On the page where you want to modify or delete a filter, select Menu > My filters.

   • On the Task dashboard page, select the filter options button .

   Note: You must have the correct permissions to modify or delete filters. If you do not have permissions, the check box next to those filters will be disabled. You can still view the filter by selecting the filter name link.

2. Do one of the following:

   • To modify a filter:

     1. Select the filter name link.

     2. Make updates as needed and select Submit.

   • To delete a filter:

     1. Select the check box next to the filter name link.

     2. Select Delete.

1. On the desired page, do one of the following:

   • On the page toolbar, select the My filters list and select the filter you want to apply.

   • Select a module from the Module list and select a module-specific filter from the My filters list.

   Note: Select Select from the My filters list to reset the filters to the default.

You can make one filter the primary filter. When you designate a filter as Primary, Civic Platform automatically applies that filter each time you open the page or tab.

1. Do one of the following:

   • On the page where you want to add a new filter, select Menu > My filters.

   • On the Task dashboard page, select the filter options button .

2. Select the filter name link.

3. Do one of the following:

   • For filters you do not have permission to edit, select the Primary button, and then select Cancel to return to the My filters page.

   • For filters you have permission to edit, select Yes in the Primary field and select Submit.

4. Return to the list page or the Task dashboard and select the Refresh button.

   Note: The page displays the results for the specific filter chosen. In addition:

   • On the page list, the My filter menu displays the primary filter (if any).
   • On the Task dashboard, the Filter pages menu displays the primary filter (if any).

You can use variables to build queries on the filter form. Variables are placeholders that are populated automatically by the system.

Relational operators define the relationship between the field you select and the value you want to compare that field against.