pub.trigger:suspendProcessing
WmPublic. Suspends document processing for the specified webMethods messaging trigger.
Input Parameters
triggerName | String Fully qualified name of the webMethods messaging trigger for which you want to suspend document processing. |
persistChange | String Optional. Flag indicating whether the document processing change should be permanent or temporary. Set to:  true to save the change to file. Integration Server persists the change across server restarts, package reloads, and changes to trigger properties. The trigger will not process documents until processing is actively resumed via the Integration Server Administrator or by execution of the pub.trigger:resumeProcessing service. false to indicate that the change is temporary and will not be maintained when the server restarts, the trigger is enabled or disabled, or the package containing the trigger reloads. This is the default. |
applyChangeAcross Cluster | String Optional. Flag indicating whether document processing should be suspended for this trigger across all the servers in the cluster. Set to: true to suspend document processing for the specified trigger on all the servers in the cluster. Note:
To make the document processing change on all the servers in a cluster, the Integration Server must belong to a properly configured cluster and it must be configured to synchronize trigger changes across the cluster. For more information about configuring an Integration Server to synchronize trigger management changes across a cluster, see webMethods Integration Server Administrator’s Guide. false to indicate that document processing for this trigger should be suspended on the local Integration Server only. This is the default. |
Output Parameters
None.
Usage Notes
This service affects all documents in the specified trigger queue on the Integration Server, including documents retrieved from the messaging provider and from local publishing.
When you suspend document processing, the Integration Server will not dispatch any more server threads to process documents in the trigger's queue. Any server threads currently processing documents for the trigger will execute to completion. This includes documents that are being retried.
When you suspend document processing, documents that the trigger retrieves will collect in the trigger queue until the trigger resumes document processing. If the server restarts before document processing resumes, volatile documents are discarded.
If you do not persist the change, the trigger reverts to the previously saved document processing state when the server restarts, the trigger is enabled or disabled, or the package containing the trigger reloads.
The Integration Server will not suspend document processing for the specified trigger if the trigger is locked by a user. For more information about locking elements, see webMethods Service Development Help.
If you suspend document processing, but do not suspend document retrieval for a trigger, the trigger queue fills to capacity and Integration Server stops retrieving documents for this trigger from the messaging provider.
If you set applyChangeAcrossCluster to true and the synchronization is not successful, the following occurs:
If the
Integration Server does not update all the
Integration Servers in the cluster successfully, the
Integration Server writes the following server log entry for each server that could not be updated:
[ISS.0098.0107E] Error occurred during cluster invoke:
Alias = remoteAliasName; Service = serviceName; Exception = exceptionName
The Integration Server Administrator also displays the following message:
[ISS.0085.9203] Errors occurred while updating remote aliases
(x of y updates failed). See server logs for more details.
If the
Integration Server cannot update the
Integration Servers in the cluster because the change could not be made locally, the
Integration Server Administrator displays the following message:
[ISS.0085.9204] Local update failed: Exception providing reason for failure.
(Note: The cluster synchronization will not run until all local errors
are resolved.)
If the
Integration Server cannot update the
Integration Servers in the cluster because cluster synchronization is not configured, the
Integration Server writes the following server log entry:
[ISS.0033.0156W] Cluster invoke did not complete successfully.
Cluster Synchronization feature is not configured.
You can use the Integration Server Administrator to view and change cluster synchronization status for triggers. For more information, see webMethods Integration Server Administrator’s Guide.
In a Java service, you can suspend document processing by calling com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setProcessingSuspended(). For more information about this method, see the webMethods Integration Server Java API Reference for the com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade class.
You can resume and suspend document processing for an individual trigger or all triggers using the Integration Server Administrator. For more information, see webMethods Integration Server Administrator’s Guide.
See Also