a!recordFilterDateRange() Function

Function

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

Creates a user filter for a record list.

Parameters

Keyword Type Description

name

Text

Name of the date range user filter.

field

Record Field

The record field or related record field the filter will apply to.

isVisible

Boolean

Determines whether the filter is visible to the user. Default is true.

defaultFrom

Date

Determines the default start date, if any, for the date range filter.

defaultTo

Date

Determines the default end date, if any, for the date range filter.

Returns

Facet

Usage considerations

This function creates a Facet type object, and is used within a Record Type Object for creating and configuring date range user filters.

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
)

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.

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: Mon, Oct 03, 2022 (01:42:07 PM)

On This Page

FEEDBACK