Page Comparison

Overview

One or more trigger actions can be set for a named event in the workflow.

Table of Contents

minLevel	1
maxLevel	6
outline	false
type	flat
separator	pipe
printable	true

Overview

A trigger action that displays a custom screen notification. The message can be customized with a title, message content, and notification style.

Image Added

When the workflow trigger event occurs, the trigger will check checks that any required conditions are met, and if met they are, the "set-message" action displays an inon-app screen notification message.

Info
One or more trigger actions can be set for a named event in the workflow.

`"set-message"`

Excerpt

The trigger action "set-message" creates a message notification and can include a message title and a body.

Info
It can be set as info, warning, or error and

can be

set to auto-close after a specified period or require

a read confirmation

user acknowledgment.

action (set-message)
- type
(enum)
- ❗️ Indicator of the level of the message
  - info
  - warning
  - error
- title
(string)
- For adding a title to the message
body (string) ❗️
- body❗️ For adding the content for the body of the message
tags (enum). is used as a tag for the message to record the current state when the action occurred.
- state
mode (enum) Message mode. By default, "ack", a user will have to acknowledge it, while with "autoClose", it'll disappear after 10s.
- ack
- autoClose

❗️ indicates a mandatory parameter - the set-message "type" parameter value and the "body" parameter value are required

❗️ Mandatory parameters

type

The "type" parameter value must be included.

body

The "body" parameter value must be included.

Trigger example

Code Block

"triggers":
[
	{"event": "on-change-state",
	"conditions":
	[
		{"state":"Expired"}
	],
	"actions":
	[
		{"action": "set-message",
			"type": "info",
			"title": "Stale content",
			"body": "Content may be out of date",
			"tags": "state",
			"mode": "autoClose"}
	]}
]

Info
If When adding the JSON trigger using using the workflow builder visual editor, there is no need to include the opening `"triggers":` JSON markup notation, since ; it will be is added automatically by the workflow builder.

The above trigger listens for a state change event to the Expired state and will display displays an on-screen message notification on the change of state.oImage Removed