pub.prt.admin:resumeProcesses

The service can be invoked either on a per-model basis or for all available models on a given Process Engine server. When this service is executed, the subscription triggers for the qualifying models are enabled, facilitating the creation of new instances. In addition, any previously suspended instances are set to status = RESUMED. In the case of a cluster or a distributed Process Engine set up, the node that the service is invoked on is considered primary and it broadcasts the resume action across all participating nodes that it is aware of.

ProcessModelID

String Optional. This is the process key for the model that the user wants to resume. All versions of a given model are affected.

resumeAll

String Optional. Indicates whether or not the resume action will affect all models or only the model that is specified as the value for the parameter ProcessModelID. The following values apply:

true — The ProcessModedID value, if provided, is ignored and the resume action is applied to all available models, their corresponding process instances, and their subscription triggers.

false — Default. The resume action is applied only to the process model defined in the parameter ProcessModelID (all process instances and subscription triggers).

message	String Optional. Displays any exceptions encountered during the service call.
success	String Optional. Returns one of the following: error — Indicates that one or more exceptions occurred during the service call. true — Indicates that the service call executed without any exceptions. It does not indicate that all internal tasks initiated by the service call have run to completion. To verify that the resume action is complete, refer to the Usage Notes section.

This service is intended for use during scheduled maintenance periods that require processing to be paused for a period of time and then subsequently resumed. The service may be used to resume processing by either resuming a single process model or all available models on the system that were previously suspended.

The service affects all versions of targeted process models, and in the case of a cluster or distributed set up, the resume action is relayed to all participating nodes. To resume only a specific model, users can invoke this service and provide the appropriate value for the ProcessModelID input parameter. To resume all models on a given system, invoke the service by setting the value of the resumeAll parameter to true.

The service resumes subscription triggers for all targeted services. Any qualifying instances that were previously set to suspended by other means (for example, manually with webMethods Monitor) will be resumed, as the invocation of this service affects all qualifying instances without exception.

Note: Be aware that the complementary suspendProcesses service suspends subscription triggers for all targeted process models; during the suspension period, any incoming documents directed to those models will be cached until such time as the model is resumed. Applying the resumeProcesses service will enable the subscription triggers for all targeted models, and all cached documents will be processed. This could cause a temporarily heavy load on the system.

This service may not work as expected for environments or process models that use volatile tracking. In this case, the resume feature relies solely on the Process Engine cache in RAM to determine the instances that will be affected. However, due to its dynamic nature, the Process Engine cache may be momentarily out-of-sync, especially following a server restart or a package re-load. In such cases, resuming at the instance-level using webMethods Monitor may be the only alternative.

The resume action is a series of independent tasks across all participating nodes. To verify that the resume action is indeed complete, the users are advised to use the following actions:

Use the webMethods Broker (deprecated) trigger management page (Settings > Messaging > Broker/Local Trigger Management) in the IS Administrator interface to verify that all the qualifying subscription triggers are enabled.