Suspending a process

The suspendProcess method can suspend an instance of a document routing work package for a specific duration (in minutes), or for a given resume list. The method sets the suspend flag of the specified work package to true.

The duration specifies how long to keep the suspend flag at true. The resume list is a set of requirements that instructs a folder to wait for the arrival of certain item types and quantities (specified in a sequential collection of DKResumeListEntryICM objects). When the duration elapses, or when the resume list is satisfied, then the system resets the work package suspendState flag from true (1) to false (0). You can also force the work package to prematurely move to the next work node by calling the continueProcess API.

Suspending a package does not affect the state of other packages on the same process.

The suspendProcess API does not relate to processes and threads in a programming environment.

The DOCROUTINGUPDATE field in the system control table controls the scheduled time to re-evaluate the suspend flag of a work package. The default time interval is 10 minutes.

Example: Java™

dkCollection  requirements = new DKSequentialCollection();
//Process will be suspended for 2 minutes.
routingService.suspendProcess(workPackagePidStr, 2, requirements);

For the complete example, see the SDocRoutingProcessingICM sample.