a!recordFilterListOption() Function

Function

a!recordFilterListOption( id, name, filter, dataCount )

Creates a filter option for the a!recordFilterList() function.

Parameters

Keyword Type Description

id

Integer

The unique identifier for the filter option. This must be unique across other filter options within the same user filter.

name

Text

The name of the filter option that is displayed to users.

filter

QueryFilter

The QueryFilter value that will be sent by the framework when this filter option is selected.

dataCount

Integer

An optional value that defines how many items in the data set will be selected if this filter option is selected.

Returns

FacetOption

Usage considerations

This function, when used within the options parameter in the a!recordFilterList() function, creates a user filter option.

Example

1
2
3
4
5
6
7
8
9
=a!recordFilterListOption(
  id: 1,
  name: "Active",
  filter: a!queryFilter(
    field: "status",
    operator: "=",
    value: "active"
  )
)

See Expression-Based User Filters for common uses.

Feature compatibility

The table below lists this function's compatibility with various features in Appian.
Feature Compatibility Note
Portals Partially compatible

Can be used with Appian Portals if it is connected using an integration and web API.

Offline Mobile Partially compatible

Can be used with offline mobile if it is loaded at the top of the form.

Custom Record Field Expressions Incompatible
Process Reports Incompatible

You cannot use this function to configure a process report.

Process Events Incompatible

You cannot use this function to configure a process event node, such as a start event or timer event.

Open in Github Built: Mon, Nov 21, 2022 (01:52:20 PM)

On This Page

FEEDBACK