Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Insert excerptsend-email trigger actionsend-email trigger actionnopaneltrue

Related Pages

JSON
Table of Contents
minLevel1
maxLevel2
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Excerpt
hiddentrue
namepagesummary

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

Excerpt
hiddentrue
nameRefined page card image
Image Removed

When the workflow event occurs the trigger checks that any required condition is met, and if met the action(s) will occur.

Actions

A list of actions to perform once the event has occurred and the conditions are fulfilled. A single trigger may include one or more actions.

Table of Contents
maxLevel3
minLevel3
Triggers can be added to a workflow using workflow builder.workflow builder visual editor - edit workflow panel with trigger addedImage Removed
Code Block
"triggers:"
[
	{"event": "on-change-state",
		"conditions":
		[
			{"state": "Rejected"} ],
		"actions":
		[
			{"action":"set-message", "type":"info", "title":"Hey My Wonderful design and Tech Team", "body":"We have some work to do ... it was rejected!!!"}
		]
	}
]
Info

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

If the action includes a "user" parameter, the users can only be added using the userId. The "group" parameter value can be added as either groupId or groupName. Both the "user" and the "group" parameters accept workflow parameters.

"change-state"

Insert excerptchange-state trigger actionchange-state trigger actionnopaneltrue

"publish-page"

Insert excerptpublish-page trigger actionpublish-page trigger actionnopaneltrue

"approve"

Insert excerptapprove trigger actionapprove trigger actionnopaneltrue

"reject"

Insert excerptreject trigger actionreject trigger actionnopaneltrue

"assign" and "unassign"

Insert excerptassign trigger actionassign trigger actionnopaneltrue

"set-expiration"

Insert excerptset-expiration trigger actionset-expiration trigger actionnopaneltrue

"clear-expiration"

Insert excerptclear-expiration trigger actionclear-expiration trigger actionnopaneltrue

"set-message"

Insert excerptset-message trigger actionset-message trigger actionnopaneltrue

"clean-messages"

Insert excerptclean-messages trigger actionclean-messages trigger actionnopaneltrue

"remove-restrictions"

Insert excerptremove-restrictions trigger actionremove-restrictions trigger actionnopaneltrue

"send-email"

Trigger actions let you automate tasks such as assigning reviewers, fast-tracking state changes, or sending custom email notifications when a workflow event occurs.

You can set one or more trigger actions for a named event in the workflow.

When the event occurs, the trigger verifies that any required conditions are met before executing the assigned actions.

For example, the following trigger displays an on-screen message notification when the state changes to the Rejected state.

cdmc_workflowtriggertrigger_visualeditor_chnagstateevent_oneaction_setmessage_action.pngImage Added

You can add one or more actions to a workflow trigger using the Add Action option in the visual editor.

cdmc_workflowtriggeraction_visualeditor_setmessage_action.pngImage Added

You can customize some workflow actions using the visual editor, such as adding custom content for a notification or choosing the users or groups to include when adding a page-level restriction.

Actions let you approve or reject approvals, add and remove page view or edit restrictions, send custom emails, or add or remove one or more page labels.

Info

Some workflow trigger actions are part of a gradual rollout of new features and might not be currently available in all instances.

Trigger actions

Trigger actions include:

Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
sortcreation
showSpacefalse
reversefalse
titleState trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_state" and space = currentSpace ( )
Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
sortcreation
showSpacefalse
reversefalse
titleNotification trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_notifications" and space = currentSpace ( )
Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
sortcreation
showSpacefalse
reversefalse
titleApproval trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_approvals" and space = currentSpace ( )
Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
titlePage restrictions trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_restrictions" and space = currentSpace ( )
Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
sorttitle
showSpacefalse
reversefalse
titleLabel trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_labels" and space = currentSpace ( )
Filter by label (Content by label)
showLabelsfalse
maxCheckboxfalse
showSpacefalse
reversefalse
titlePublishing trigger actions
cqllabel = "trigger_action" and label = "trigger_actions_publishing" and space = currentSpace ( )

The publish-page action requires the installation of the Comala Publishing app.

Adding a trigger action

A workflow trigger can be added to a workflow using the visual editor or the code editor. You can add one or more actions to each workflow trigger.

Insert excerpt
Trigger events
Trigger events
nameevent_visualeditor
nopaneltrue

One or more trigger actions are added using the Add Action option:

  • choose Add Action to open a dialog box to select a trigger action

cdmc_visualeditor_extract_actions_addaction.pngImage Added
  • select a trigger action using the Actions dropdown menu

cdmc_visualeditor_triggers_addactiondialogbox_selectanaction_setmessage_dropdownmenu.pngImage Added
  • add any action parameter values (including mandatory parameters)

cdmc_visualeditor_addaction_dialogbox_set_message_parametervaluesadded.pngImage Added
  • choose Add

You also need to apply these changes to the workflow trigger in the Add trigger or Edit trigger box. You can then Save the trigger changes to the workflow.

Adding a workflow trigger in the visual editor, automatically updates the workflow template in the code editor:

cdmc_coded_editor_workflowtrigger_on-change-state_set-message_highlighted.pngImage Added

You can add the trigger and trigger action as JSON code using the code editor. The editor includes JSON schema help for workflow triggers and the actions.

cdmc_codeeditor_extract_trigger_actions_action_schema_help_list.pngImage Added