Versions Compared

Version Old Version 8 New Version Current
Changes made by

Robert Alexander Marshall

Robert Alexander Marshall

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Table of Contents
minLevel1
maxLevel6
outlinefalse
typeflat
separatorpipe
printablefalse

Overview

Excerpt

A trigger can be set to listen 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 "conditions" are have been met.

If the set conditions are met for the named event, one or more trigger "actions" occur.

Event

A trigger can be set to listen for the following events.

Filter by label
showLabelsfalse
showSpacefalse
cqllabel = "jsontriggerevent" and space = currentSpace ( )

A workflow JSON trigger can include more than one You can add multiple triggers, each with a different "event". However, you can only include one of each type of event can be included in a single "event" in the trigger.

For example, when adding the change of state

  • {"event": "on-change-state", "actions":[............]}

The trigger event is Any other use of this event must be filtered to a specific occurrence using conditions.For example, the event has a condition to only listen for a change of state to a named stateusing a condition:

  • {"event": "on-change-state","conditions":[{"state":"Approved"}], "actions":[............]}

Once the event occurs and any conditions are met, and one or more set trigger actions occur.

Example "on-expire" event

Insert excerpt
on-expire event
on-expire event


A space administrator can use the visual editor or the code editor to add one or more triggers to a workflow.

Excerpt
nameevent
The trigger can be added to a custom workflow using the code editor.
_visualeditor

In the visual editor:

cdmc_visualeditor_trigger_addtrigger_onstatechanged_statecondition_setmessageaction.pngImage Added

You can use the following options to add the workflow trigger:

  • select an Event

  • add a Condition

  • include one or more Actions to execute automatically

The workflow trigger listens for a single event selected from a dropdown menu.

cdmc_visualeditor_extract_addtrigger_eventdropdownoptions.pngImage Added
Excerpt
nameevent_codeeditor

In the code editor:

cdmc_codeeditor_savedtrigger_message.pngImage Modified

The code editor includes JSON schema to help support writing the trigger:

  • color coding to easily distinguish property names, values, and different data types

  • autocomplete feature

  • dropdown selectors for available

property names, including workflow trigger events, conditions, and actionscdmc_code_editor_jsonschema_help_triggers_event.pngImage Removed

The code editor includes a dropdown schema option for the available events.

cdmc_codeeditor_trigger_eventname_schema_onchangestate_highlighted.pngImage Removed

You can also add the trigger using the visual editor.

cdmc_wfbuilder_editworkflow_trigger_onexpire_withsetmessageaction.pngImage Removed

You can write the workflow trigger or copy and paste the existing JSON code for a trigger (without the opening "triggers": JSON notation) to the Triggers dialog box in the Edit Workflow panel.

Related Pages

  • JSON Triggers

    • Trigger Actions

    • properties

    The JSON schema includes an option to add a single event for the trigger.

    cdmc_code_editor_jsonschema_help_triggers_event.pngImage Added

    Once you have added the event attribute, you can select the event name from a JSON schema help box.

    cdmc_codeeditor_trigger_eventname_schema_onchangestate_highlighted.pngImage Added

    Related Pages