Filters

reThe filter is used to limit the set of records to be displayed in the list (in any list: related list, open list, the dictionary). The filter sets certain conditions for the record to meet to be in the list. Filters can be configured with the Condition Builder.

For example, we need to filter users living in Sevastopol. In SQL, we use WHERE operator to filter records.

Filter components

Filters consist of the following components:

1. Condition builder (and the breadcrumbs as its integral part).
2. Search and sorting:
   1. Input field at the top of every column is used for searching.
   2. Click on the column title to sort the search results.
3. Filter Out/Show Matching (this item can be found in the context menu, to open it, right-click on the list cell).

All these components form the condition string, which is sent in the request as a GET parameter, and the filtered list of records will be returned and displayed.

The difference between condition builder on lists and regular condition builder is that breadcrumbs and sorting functionality added.

Breadcrumbs allow assessing the filter visually. Also, they allow quick filter editing by navigation to the condition specified.

Sorting allows adding its conditions (ascending or descending) on one or more list fields.

How filters work

For more clarity, let's take an example.

We need to find John Doe's closed requests, sorted by priority.

For this, we will create such a filter on the Request list (the itsm_request table):

After that, condition string can be found in the condition GET parameter: 

/list/task?condition=(state%3D-2%5EdescriptionISEMPTY%5Epriority<3)

The condition string elements more closely:

Encoding and decoding queries

To decode an encoded query string storing the condition obtained from the GET parameter, we recommend using the addEncodedQuery and getConditionQuery methods of the SimpleRecord Server-Side class. You can decode the encoded string by completing the simple steps:

1. Perform a selection against the table list view using a Condition Builder.
2. Copy the condition from the URL as shown on the screenshot below:
   
3. Navigate to System Settings → System Scripts and click New.

4. Fill in the Script field with code below (this one is given for example):

   1. Fill in the {tableName} placeholder with the table system name.

   2. Fill in the {conditionQueryCondition} placeholder with the copied condition.
   3. Click Run to execute the script.

const current = new SimpleRecord('{tableName}');
current.addEncodedQuery('{conditionQueryCondition}');
ss.info(current.getConditionQuery());
// Info: (state=-2^descriptionISEMPTY^priority<3)

Dynamic Filters

Dynamic filters extend the filters by the JS scripts executing ability. This ability is available in the list condition builder and in the dynamic reference qualifier condition builder.

In Condition Builder, dynamic filters are available when selecting the reference field and the 'is (dynamic)' or similar operator. After this, the list of available dynamic filters will appear.

When executing the filter as a value of the condition using the 'is dynamic' operator, the value returned by the dynamic filter script will be used.

To create a new dynamic filter, please complete the following steps (a new record in the Filter Option Dynamic (sys_filter_option_dynamic) table will be created):

1. Navigate to System Settings → Dynamic Filters.
2. Click New and fill in the fields.
3. Click Save or Save and Exit to apply changes.

Dynamic filters form fields