Terminating a process instance

Sometimes, a top-level process instance that in an unrecoverable state must be terminated.

About this task

To perform this action, the caller must be a process administrator or a system administrator. However, if Business Flow Manager is using the alternative process administration mode that restricts process administration to system administrators, then only callers in the BPESystemAdministrator role can perform this action.

Because a process instance terminates immediately, without waiting for any outstanding subprocesses or activities, you should only take this action in exceptional situations.

Procedure

Retrieve the process instance that is to be terminated.

ProcessInstanceData processInstance = 
       process.getProcessInstance("CustomerOrder");

Terminate the process instance.
If you terminate a process instance, you can terminate the process instance with or without compensation.
To terminate the process instance with compensation:
```
PIID piid = processInstance.getID();
process.forceTerminate(piid, CompensationBehaviour.INVOKE_COMPENSATION);
```
To terminate the process instance without compensation:
```
PIID piid = processInstance.getID();
process.forceTerminate(piid);
```
If you terminate the process instance with compensation, the compensation of the process is run as if a fault had occurred on the top-level scope. If you terminate the process instance without compensation, the process instance is terminated immediately without waiting for activities, to-do tasks, or inline invocation tasks to end normally.

Applications that are started by the process and standalone tasks that are related to the process are not terminated by the force terminate request. If these applications are to be terminated, you must add statements to your process application that explicitly terminate the applications started by the process.