FunctionCopy link to clipboard
Configures a validation message for forms, sections, and editable grids.
See also: Form, Section, Editable Grid
ParametersCopy link to clipboard
Name | Keyword | Types | Description |
---|---|---|---|
Message |
|
Text |
The validation message to display. |
Validate After |
|
Text |
Determines when to display the validation message. Valid values are '"REFRESH"'' (default), and '"SUBMIT"'. |
Visibility |
|
Boolean |
Determines whether the component is displayed on the interface. When set to false, the component is hidden and is not evaluated. Default: true. |
Usage considerationsCopy link to clipboard
- Only supported in form, section, and editable grid components.
- When Validate After is
"SUBMIT"
, the validation message is only displayed when the user selects a button component where validate istrue
, or when the user selects a submit button.
ExampleCopy link to clipboard
To experiment with examples, copy and paste the expression into an interface object.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
=a!localVariables(
local!amount: 5000,
a!formLayout(
contents: {
a!textField(
label: "Amount",
value: local!amount,
saveInto: local!amount
)
},
buttons: {
a!buttonArrayLayout(
buttons: {
a!buttonWidget(
label: "Submit",
style: "SOLID",
submit: true
)
}
)
},
validations: a!validationMessage(
message: "The total cannot be greater than $1,000",
validateAfter: "REFRESH",
showWhen: local!amount > 1000
)
)
)
Copy
Feature compatibilityCopy link to clipboard
The table below lists this component's compatibility with various features in Appian.
Feature | Compatibility | Note |
---|---|---|
Portals | Incompatible | |
Offline Mobile | Incompatible | |
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 | Incompatible | Cannot be used to configure a process event node, such as a start event or timer event. |
Process Autoscaling | Compatible |
Related PatternsCopy link to clipboard
The following patterns include usage of the Validation Message.
- Showing Validation Errors that Aren't Specific to One Component (Validation): Alert the user about form problems that aren't specific to one component, showing the message only when the user clicks "Submit".