Description:
This step aborts the current process instance, automatically closes any open tasks, and stops the process from continuing. It 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 the "abortInstance" step to configure its "Settings" properties. Provide a name to the step.
- Click 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 with a GUID value. Or, keep the text box empty to consider the current process instance.
- The “Logging” setting configuration is necessary for documentation and also measures the workflow progress and the 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. Render the process instance. Click on the process step to view its properties. The step should abort the instance. Navigate to Process Instances and render the instance to view the status.
Definition Sample:
You may download the sample definition(s) from the link here and later import it (drag-drop) to your FlowWright Process Definition (XML file) or Form Definition (HTML file) page.
NOTE: Please verify and complete the process steps for any missing configurations, such as file path references and database connections after import. Then, save the definition to confirm the changes.
Click here to download the sample file.