Display Error Message

Audience: Citizen Developer
Skill Prerequisites: HTML

This action displays a message at the bottom of a Form, at the bottom of a Grid when used on Grid buttons, or inline when used on Grid Item Buttons. It prevents further execution of actions below it in the stack.

Typical Use Cases

  • Display a permission error.
  • Display an error returned from a Server Request action.
  • Use in On PreInit or On Init form events to conditionally prevent the loading of a form.

Don't use it to

  • Debug - Use Log Error or Log Debug Message

Related Actions

Action NameDescription
Display Toast MessageDisplays a simple notification/information message to a user in a small popup. Use this to show a message that will timeout automatically and doesn't change the page layout.
Display MessageDisplays a postback message after the form is submitted. Use this if you want the page to refresh.

Input Parameter Reference

ParameterDescriptionSupports TokensDefaultRequired
MessageThe content to display. Allows HTML input. Use the Append Field dropdown to automatically add specified field names followed by the field token into the message or the Append All Fields button to add all fields. Fields are added to the end of any content you may have already entered.Yesempty stringNo

Examples

1. Simple Permission Error Message

Import this action into the On PreInit or On Init sections of a form and add a condition to check to see if the logged in user has permission to use the form.

{
"Title": "Display Error Message",
"ActionType": "ShowError",
"Description": "User Permission Error",
"Parameters": {
"Message": "<p>You don't have permission to use this form.</p>"
}
}
Last updated on by Patrick Anderson