The 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 the WHERE clause to filter records.
You can add a filter with all necessary filters in your Favorites in the Navigation menu. To do this, drag and drop the breadcrumbs to the Favorites navigation tab.
Filter components
Filters consist of the following components:
- Condition builder (and the breadcrumbs as its integral part).
- Search and sorting:
- Input field at the top of every column is used for searching.
- Click on the column title to sort the search results.
- 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 the filter works
To be more visual, let's take an example.
We need to find Alexander Egorov's closed tasks, sorted by priority.
For this, we will create such a filter on the task list (the task table):
After that, condition string can be found in the condition GET parameter:
list/task?condition=(((state=4^ORstate=5)^assigned_userLIKEAleksandr%20Egorov))^ORDERBYpriority
The condition string elements more closely:
| Element | Description |
|---|---|
| (state=4^ORstate=5) | State = 4 or State =5 (Closed Complete or Closed Incomplete) |
| subjectISNOTEMPTY | Subject is not empty |
| assigned_user.username=aleksandr_egorov | Username = Alexander Egorov |
| ^ORDERBYpriority | Records will be sorted by the priority fields in the ascending order. |
Filtering for the fields of the Reference, List, Choice, Record Class and Field Name types has some nuances related to the value and default_value fields correlation in tables:
- Filtering is performed by the value of the value field. For example: in case the filter condition is field_name = value, then displayed condition will be field_title = display_value.
- Column search is performed by the value of the display_value field; either the filter or the breadcrumbs on the filter top are filled with the condition field_name = value; at the time, the condition displayed is field_title = display_value.
- The auto-suggest functionality is performed by either value or display_value field values.
The table below can clarify the filtration specifics when doing the selection with field of types above involved.
| Column type | Operator | Search field |
|---|---|---|
| Reference | LIKE / NOTLIKE / STARTSWITH / ENDSWITH | display_value |
| List | LIKE / NOTLIKE | display_value |
| Choice | LIKE / NOTLIKE / STARTSWITH / ENDSWITH | title |
| Record Class | LIKE / NOTLIKE / STARTSWITH / ENDSWITH | title |
Field scalar type matters when you filter with the Condition Builder. If the field you filter by is of the varchar or text type (for example, HTML field type, or Script, or String), then you cannot use exact operators (for example, '='). This operator is unavailable for fields of varchar and text types. You'll have to filter out using LIKE operator.
And if the field is of one the number types (for example, decimal, int8, int4), then exact operators are available, and you can filter by them.
See the Condition Operators article to obtain filter operators full list.
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):
- Navigate to System Definition → Dynamic Filters.
- Click New and fill in the fields.
- Click Save or Save and Exit to apply changes.
You can also create dynamic filters for table fields of the sys_id type (ID). To do that, specify the dynamic filter form fields in the following way:
- In the Column type, select biginteger from the list.
- In the Reference table, specify the table to apply this filter on.
- Set the Active checkbox checked.
- Set the Available for filter checkbox checked.
- Complete filling the form and click Save.
To apply the dynamic filter created, specify the ID table column and the is (dynamic) operator as the Condition Builder field and operator appropriately.
Dynamic filters form fields
| Field | Mandatory | Description |
|---|---|---|
| Title | Y | The filter title. |
| Column Type | N | The column type used in the filter. This field references to the Columns dictionary. |
| Referenced Table | Y | Choose the table to apply this filter on. |
| Available for Filter | N | Select this checkbox to make this filter available in the list filters. |
| Available for Reference Qualifier | N | Select this checkbox to make this filter available for a dynamic reference qualifier. |
| Active | N | Select this checkbox to make the filter active. |
| Order | N | Enter the number to define the order of filter processing. |
| Script | Y | Enter the script that the dynamic filter runs. You can use all methods of server-side API classes here. After executing, the script should return the record ID or array of IDs. |
