Changing the process instance state

BP Server allows the transitions between suspending and resuming the process instance. The process instance can also be completed explicitly with the API support.

public void suspend()

An activated process instance can be suspended by invoking this API. In the suspended state, attributes of the process instance cannot be updated. The suspended process instance can be resumed to continue further processing.

Note: BP Server does not allow suspending a process instance that is not activated. If you try to invoke the API on a Suspended process instance, then an exception is raised.

public void resume()

You can use this API to reactivate the Suspended process instance. BP Server does not allow you to resume a process instance which is already activated.

public void complete()

The API completes the activated process instance. When you explicitly complete the ProcessInstance, it is also removed internally.

Note: BP Server does not allow completing a process instance which is created, but not activated. It also does not support completing a suspended process instance. If you try to invoke the API on a suspended process instance, or on a process instance that is not yet activated, then an exception is raised.