a!recordFilterDateRange() Function

Creates a user filter for a record list.

This function creates a Facet type object, and is used within a Record Type Object for creating and configuring date range user filters. See Expression-Based User Filters for common uses.

Syntax

a!recordFilterDateRange( name, field, defaultFrom, defaultTo, isVisible )

  • name (Text): The name of the user filter that displays to end users.
  • field (Record Field): The record field the filter will apply to. The record field is referenced using the recordType! domain. For example, recordType!Case.fields.caseName.
  • defaultFrom (Text): Determines which, if any, starting date is applied when a record list first loads.
  • defaultTo (Text): Determines which, if any, ending date is applied when a record list first loads.
  • isVisible (Boolean): Determines whether the filter is visible to the user at runtime. Default is true.

Returns

Facet

Example

1
2
3
4
5
6
7
=a!recordFilterDateRange(
   name: "Hire Date",
   field: recordType!Employee.fields.hireDate,
   defaultFrom: "today()",
   defaultTo: "today() + 365",
   isVisible: 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!recordFilterDateRange_20r2

Supports updated record types that use record type field references.

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

Open in Github Built: Fri, Oct 22, 2021 (11:14:24 AM)

On This Page

FEEDBACK