Interrupting Task Step Component

This component is similar to the task component but it has one difference: it does not have the output. This is useful to represent a step that interrupts the workflow execution.

Example

Check the Pro Components Example.

Pro

This component is available only in the Pro version.

Properties

Property	Type	Description
componentType	string	The type of the component. To use the interrupting task step component you must set it to interruptingTask.
id	string	The unique identifier of the step. We recommend to use the next() function from the Uid class to generate it.
name	string	The name of the step.
type	string	Your custom type of the step.
properties	object	The properties of the step.

Example

const step = {
  componentType: 'interruptingTask',
  id: '2a11d8498af26cdb67e2f27171e82f8e',
  name: 'Stop workflow',
  type: 'stopWorkflow',
  properties: {
    reason: 'The workflow has been stopped by the user.'
  }
};

Customization

Pro Only

This part of the article is available only for subscribers of the pro package. Buy the pro package to get an access to this part.

If you have already subscription please log in.