TerminateBranch system function

The TerminateBranch system function prematurely ends the processing of a work item. Use this system function to terminate processing of one branch of a workflow.

NOTE This system function was called Terminate in previous versions. Existing workflow definition that use the Terminate system function continue to work as before.

The behavior of this function varies depending on the workflow map it is on:

  • On the Terminate system map, the TerminateBranch function immediately removes the work item from the system, skipping any steps that have not been executed.
  • On all other maps, the TerminateBranch function calls the Terminate map defined in or inherited by the workflow. The work item is then processed and ultimately removed from the system according to the logic of the Terminate map.

In all cases, when the Terminate map executes, all active, suspended, or disabled timers for the work item are ended.

To use the TerminateBranch system function

  • From the General System Palette, drag a TerminateBranch step onto the workflow map where you want to stop the current work item.

    The TerminateBranch system function has no parameters.

TIP If a TerminateBranch system function ends processing on a submap, control returns to the calling map.