Free cookie consent management tool by TermsFeed

a!applyValidations Function

On This Page

Function

a!applyValidations( recordField, context, additionalValidations )

This function references pre-configured record field validations and allows you to create additional validations to apply. Additional validations can be used to address less common scenarios that aren't applicable to every use of a record field.

You can use the a!applyValidations() function in any expression or interface to reference and add to the pre-configured validations for a record field, but we especially recommend including it in the reusable input interface for the record field. If a record field has validations configured, then the generated input interface for the record field will automatically use the a!applyValidations() function.

To learn more about best practices for creating and using reusable record field validations and interfaces, see Build Your Best Data Fabric

See also:

Parameters

Keyword Type Description

recordField

Record Field

References a record field and the pre-configured validations for that field.

context

Any Type

A rule input or local variable that calls the relevant data for the validation. For example, record data, record field values, and data returned by APIs.

additionalValidations

List of Text

Validations applied in addition to the pre-configured record field validations. Additional validations can be used to address less common scenarios that aren't applicable to every use of a record field.

Returns

Record Data

Usage considerations

Supporting functions for validations

These functions were specifically created in conjunction with the a!applyValidations() function to help you easily create intuitive validations:

Example

Using pre-configured validations

The following example uses a rule input of the record type that the record field you're referencing belongs to.

1
2
3
4
5
a!applyValidations(
 recordField: recordType!Case.field.email,
 context: ri!case,
 additionalValidations: {}
)

Using pre-configured and additional validations

The following example uses a rule input of the record type that the record field you're referencing belongs to.

1
2
3
4
5
6
7
8
9
10
11
a!applyValidations(
 recordField: recordType!Case.field.endDate,
 context: ri!case,
 additionalValidations: {
    if(
     ri!case[recordType!Case.fields.endDate] > today(),
     "",
     "Enter Valid Date"
    )
    }
)

Using the applyValidations function in a reusable input interface for an email record field

The following expression is an example of a reusable record field interface. The example uses a rule input of the record type that the record field you're referencing belongs to.

1
2
3
4
5
6
7
8
9
10
11
12
13
14
a!textField(
  label: recordType!Employee.fields.email.properties.displayName,
  labelPosition: "ABOVE",
  showWhen: fn!true(),
  value: ri!employee[recordType!Employee.fields.email],
  saveInto: ri!employee[recordType!Employee.fields.email],
  align: "LEFT",
  validations: {
    a!applyValidations(
      recordField: recordType!Employee.fields.email,
      context: ri!employee
    )
  }
)

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 Interfaces Partially compatible

Can be used with offline interfaces if loaded at the top of the interface.

Sync-Time Custom Record Fields Incompatible
Real-Time Custom Record Fields Incompatible

Custom record fields that evaluate in real time must be configured using one or more Custom Field functions.

Process Reports Incompatible

Cannot be used to configure a process report.

Process Events Partially compatible

If autoscale is enabled, can be used to configure a supported process event node (such as a start event or timer event).

Process Autoscaling Compatible

Can be used in autoscaled processes.

Event Consumer Filter Conditions Incompatible

Cannot be used in filter conditions.

Event Consumer Event Handlers Incompatible

Cannot be used in event handler expressions.

Feedback