Description:

The AbortInstance step is used to abort a FlowWright process instance from within a workflow.

The step is categorized under AI and is defined as a Process step with the display name Abort instance. It accepts an instance ID that identifies the process instance to abort.

Usage:

The AbortInstance step is used when a workflow needs to terminate a specified process instance.

A typical workflow pattern is:

Determine Instance → Abort Instance → Continue Based on Result

The step can receive the instance ID through workflow data, allowing the target instance to be determined dynamically.

For example, a workflow could identify a process instance that should no longer continue and then pass its ID to AbortInstance.

Typical Workflow Suggestions:

Abort an Unnecessary Process Instance

Use AbortInstance when another workflow determines that an existing process instance is no longer required.

For example:

Identify Instance → Evaluate Condition → Abort Instance

If the condition indicates that processing should no longer continue, the identified instance can be passed to the AbortInstance step.

Stop Duplicate Process Processing

Use the step as part of a workflow that identifies an existing process instance that should not continue because another instance is already handling the same business activity.

For example:

Check Existing Instance → Identify Duplicate → Abort Instance

The instance ID of the duplicate process can be supplied to the step.

Abort a Process After a Business Decision

Use AbortInstance after a decision or evaluation determines that an existing process instance should be terminated.

For example:

Evaluate Business Condition → Abort Instance → Continue

This allows workflow logic to determine whether the identified process instance should be allowed to continue.

Cancel Related Processing

Use the step when one workflow needs to stop a related process instance as part of a larger business process.

For example:

Process Event → Identify Related Instance → Abort Instance

You can provide the related process instance ID dynamically as the instance ID to abort.

Abort an Instance During Exception Handling

Use AbortInstance in an exception-handling workflow when a failure or business condition requires a related process instance to be stopped.

For example:

Detect Exception → Identify Affected Instance → Abort Instance → Exception Handling

The True and False outputs can then be used to route the workflow according to the result of the abort operation.

Example:

Let’s build and execute the “abortInstanceDef” example:

• Create a new process definition named “abortInstanceDef” and open it in designer mode. 
• Drag an “abortInstance” step to the canvas.
• Connect the dots between the “Start” and “abortInstance” steps.
• Select the line between the steps to configure the “Connection Properties”. The default property values are “None, True, False, Error, and Evaluate”. Depending on the step’s purpose, you can configure additional values.
• Click the "abortInstance" step to configure its "Required" properties. Provide a name for the step, then click the Save button. Note: Click the "AI Predict" button to have the Copilot add new process steps that match your process description. 

• Navigate to the Process Instance page and search for instances with the “sleeping” status. Copy the InstanceID GUID value to the clipboard. 

• Click the "abortInstance" step to configure its "Optional" properties. Provide the system variable that holds the current instance's GUID, or provide the GUID of another “sleeping” process instance. Or keep the text box empty to target the current process instance. 

• The “Logging” configuration is necessary for documentation and also measures workflow progress and percent complete. This is achieved 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 instance, and execute it. Render the process instance. When the workflow reaches the AbortInstance step, FlowWright uses the supplied instance ID to abort and identify the process instance on which the operation is performed. The result is exposed through the step's True or False return path. Navigate to Process Instances and render the instance to view its status. 

Tips:

• Provide the correct instance ID: The value supplied to the instance ID input should identify the intended process instance.
• Use Variables/Globals for dynamic instance IDs: This allows the target instance to be determined during workflow execution.
• Validate the target before aborting: Where appropriate, use preceding workflow logic to determine which instance should be aborted.
• Use both return paths: Connect the True and False outputs to appropriate workflow handling.
• Use exception handling where appropriate: If an abort operation is part of an error-handling workflow, provide a meaningful path for unsuccessful execution.
• Avoid hard-coded IDs when possible: Dynamic identification makes the workflow more reusable across process instances.

Definition Sample:

You may download the sample definition(s) from the link provided and later import them (drag-and-drop) into your FlowWright Process Definition (XML file) or Form Definition (HTML file) page. 

Note: After the import, verify and complete any missing configurations, such as file path references and database connections. Then, save the definition to confirm the changes. 

Click here to download the sample file.