pub.trigger:resumeRetrieval
WmPublic. Resumes retrieval of documents from the messaging provider for a specific webMethods messaging trigger.
Input Parameters
triggerName | String Fully qualified name of the webMethods messaging trigger for which you want to resume document retrieval. |
persistChange | String Optional. Flag indicating whether the document retrieval 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 continue to retrieve documents until it is actively suspended via the Integration Server Administrator or by execution of the pub.trigger:suspendRetrieval 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 retrieval should be resumed for this trigger across all the servers in the cluster. Set to: true to resume document retrieval for the specified trigger on all the servers in the cluster. Note:
To make the document retrieval change on all the servers in a cluster, the Integration Server 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 retrieval for this trigger should be resumed on the local Integration Server only. This is the default. |
Output Parameters
None.
Usage Notes
This service does not affect document retrieval for locally published documents to which this trigger subscribes.
If you do not persist the change, the trigger reverts to the previously saved document retrieval state when the server restarts, the trigger is enabled or disabled, or the package containing the trigger reloads.
After this service executes, the Integration Server resumes document retrieval for this trigger at the percentage specified in the Queue Capacity Throttle field on the Messaging > webMethods triggers page in the Integration Server Administrator.
The Integration Server resumes document retrieval for the specified trigger even if document retrieval is suspended for all the triggers on the Integration Server (that is, the Retrieval State for all triggers is set to Suspended).
The Integration Server will not resume document retrieval 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 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 resume document retrieval by calling com.wm.app.b2b.server.dispatcher.trigger.TriggerFacade.setRetrievalSuspended(). 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 retrieval for an individual trigger or all triggers using the Integration Server Administrator. For more information, see webMethods Integration Server Administrator’s Guide.
See Also