Abort an instance

Use this step to abort the current instance or any other sleeping instance.

Last published at: July 7th, 2023

AbortInstance Step

Description:

Aborts the current process instance, automatically closes any open tasks, stops the process from continuing any further.  Step can also abort any other process instance using the configured instance id.

Inputs

  • instanceID– id of the process instance to abort
 

 

Returns

  • True – step executed successfully 
  • False - step failed to execute 
 

 

Usage:

Example:

Let’s build and execute the abortinstanceDef example:

  • Create a new definition called “abortinstanceDef”
  • Select the definition and click the “design” button
  • Drag an “abortInstance” step to the canvas
  • Connect the dots between the start and “abortInstance” step
  • Click on the "abortInstance" step to configure its "Settings" properties. Provide a name to the step. 
  • Click on the "abortInstance" step to configure its "Advanced" properties. Provide the system variable which holds the current instance GUID value. Or, provide the other “sleeping” process instance GUID value. 
  • The “Logging” setting configuration is necessary for documentation and also measure the workflow progress and the percent complete. This is acheived by configuring the step state and percent fields individually as shown in the images below. Configure the “Logging” using the following properties.
  • Save the process definition, create a new process instance and execute. 
  • Render the process instance. Click on the process step. The step should abort the instance. Navigate to Process Instances and render the instance to view the status.