Terminating Process Instances

You can terminate a process instance by using the Java API and web service API. When terminated, a process instance no longer performs actions. One reason to terminate a process instance is that it is no longer applicable. Assume, for example, that a long-lived process requires a bank manager’s input. However, because the bank manager is not available and cannot respond to the process instance, the process instance keeps running while waiting for the bank manager’s input. During that time period, a potential bank customer withdraws their mortgage application, resulting in the bank manager’s input being unnecessary. As a result, the process instance can be terminated.

Note: The name of the service that is invoked when terminating a process instances is ProcessManager. To create a proxy object that lets you invoke its operations by using a web service, specify this WSDL definition: http://localhost:8080/soap/services/ProcessManager?WSDL. (See Invoking LiveCycle ES Using Web Services.)

Summary of steps

To terminate a process instance, perform the following tasks:

1.	Include project files.

2.	Create a ProcessManager Client API object.

3.	Terminate the process instance.

Include project files

Include necessary files into your development project. If you are creating a client application by using Java, include the necessary JAR files. If you are using web services, make sure that you include the proxy files. (See Including LiveCycle ES Java library files.)

Create a ProcessManager Client API object

Before you can programmatically terminate a process instance, you must create a ProcessManager object.

Terminate the process instance

To terminate a process instance, ensure that it is a valid process instance. If you attempt to terminate a process instance that does not exist or was previously terminated, a run-time exception is generated. To successfully terminate a process instance, you require the process invocation identifier that can be obtained when invoking a long-lived process by using the Invocation API. (See Invoking Human-Centric Long-Lived Processes.)


View Java walkthrough	View web service walkthrough

Current page: http://livedocs.adobe.com/livecycle/8.2/programLC/programmer/help/000820.html