a!facet() Function

Creates a user filter category for record list.

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!facetOption() function. The most popular use of a!facet() is to generate filter options instead of manually writing them. See the Expressible User Filters page for common uses.

Syntax

a!facet( name, options, defaultOption, isVisible )

  • name (Text): The name of the user filter that displays to end users.
  • options (FacetOption Array): The options that users can select from for a given user filter.
  • defaultOption (Text): Determines which, if any, filter option is applied when a record list first loads.
  • isVisible (Boolean): Determines whether the filter is visible to the user at runtime. Default is true.
  • allowMultipleSelections (Boolean): Determines whether the filter allows the user to select multiple options or a single option. Default is true.

Returns

Facet

Example

=a!facet(
  name: "Status",
  options: {
    a!facetOption(
      id: 2,
      name: "Active",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "active"
      )
    ),
    a!facetOption(
      id: 3,
      name: "Inactive",
      filter: a!queryFilter(
        field: "status",
        operator: "=",
        value: "Inactive"
      )
    )
  },
  defaultOption: "Active",
  isVisible: true,
  allowMultipleSelections: true
)

Old Versions

There are older versions of this function. You can identify older versions by looking at the name to see if there is a version suffix. If you are using an old version, be sure to refer to the corresponding documentation from the list below.

Old Versions Reason for Update
a!facet_17r1

Added the allowMultipleSelections parameter, which, by default, allows multiple selection user filters.

To learn more about how Appian handles this kind of versioning, see the Function and Component Versions page.

FEEDBACK