error() Function

Function

error( message )

Raises an error with the given message, used for invalidating execution.This function never returns a value.

Parameters

Keyword	Type	Description
message	Text	The text of the error message.

Returns

Any Type

Usage considerations

Returning no value

This function is used for invalidating execution. It never returns a value.

Examples

error("This is an error message.") returns an error with the message This is an error message.

Feature compatibility

The table below lists this function's compatibility with various features in Appian.

Feature	Compatibility	Note
Portals	Compatible
Offline Mobile	Compatible
Sync-Time Custom Record Fields	Compatible	Can be used to create a custom record field that only evaluates at sync time.
Real-Time Custom Record Fields	Incompatible
Process Reports	Compatible
Process Events	Compatible

Feedback