a!recordFilterList() Function

Function

a!recordFilterList( name, options, defaultOption, isVisible, allowMultipleSelections )

Creates a user filter category for the record list.

Parameters

Returns

Facet

Usage considerations

This function creates a Facet type object, and is used within a Record Type Object

Options for the user filter are created with the a!recordFilterListOption() function. The most popular use of a!recordFilterList() is to generate filter options instead of manually writing them.

Since users can save filter values, try to use expressions that rarely change the options available. If users save an option that is not available the next time they load the record, a warning message will display and the user may need to update their saved filter.

Example

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
=a!recordFilterList(
  name: "Status",
  options: {
    a!recordFilterListOption(
      id: 1,
      name: "Active",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "active"
      )
    ),
    a!recordFilterListOption(
      id: 2,
      name: "Inactive",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "inactive"
      )
    )
  },
  defaultOption: "Active",
  isVisible: true,
  allowMultipleSelections: true
)

See Expression-Based User Filters for common uses.

Feature compatibility

Feedback