Versions Compared

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

When the workflow "event" occurs the trigger checks that any required "conditions" are 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 (Content by label)
showLabelsfalse
showSpacefalse
cqllabel = "jsontriggerevent" and space = currentSpace ( )

A workflow JSON trigger can include more than one "event".

However, only one of each type of event can be included in a single "event" in the trigger.

For example,

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

The trigger event is 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 state

  • {"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


To add this trigger The trigger can be added to a custom workflow using the workflow builder visual editor, code editor.

cdmc_codeeditor_savedtrigger_message.pngImage Added

The code editor includes

  • 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 actions

cdmc_code_editor_jsonschema_help_triggers_event.pngImage Added

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

cdmc_codeeditor_trigger_eventname_schema_onchangestate_highlighted.pngImage Added

You can also add the trigger using the visual editor.

cdmc_wfbuilder_editworkflow_trigger_onexpire_withsetmessageaction.pngImage Added

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

Image Removed

Related Pages