Hybrid Integration 10.2 | Integrating On-Premises Applications | Integration Server Built-In Services | Event Folder | pub.event.routing:subscribe
 
pub.event.routing:subscribe
WmPublic. Creates a subscription to a particular type of event using webMethods Event Routing. Integration Server identifies a subscription based on a combination of eventTypeName and serviceName or based on the subscriberId, if specified.
When the Event Routing framework receives a matching event, it routes the event to Integration Server. Upon receiving the event, Integration Server executes a specific service to process the event.
Input Parameters
eventTypeName
String Fully qualified name of the event type to which to subscribe. For example, {http://namespaces.softwareag.com/EDA/WebM/Sample/InventoryMgmt/1.0}PartInventoryLow is an event type identifier used for inventory management. Integration Server maintains a list of default event types in the directory Integration Server_directory /common/EventTypeStore on the machine where Software AG Universal Messaging is installed.
serviceName
String Fully qualified name of the service that Integration Server should invoke when the Event Routing framework notifies Integration Server about receiving an event of the type specified in eventTypeName. The signature for this service must reference the document type pub.event.eda:event as its only input.
Integration Server verifies that the service specified in serviceName exists and issues an error if the service does not exist or is not valid.
runAsUser
String Optional. Name of the user account whose credentials Integration Server uses to invoke the service specified in serviceName. Integration Server validates the user name when the service specified in serviceName is executed.
You can specify a locally defined user account or a user account defined in a central or external directory. The user account you specify must have the execute ACL associated with the service specified in serviceName.
If you do not specify any user account for runAsUser, Integration Server uses the name specified in the watt.server.event.routing.runAsUser server configuration parameter. If no user is specified in that parameter, Integration Server uses the Administrator user to execute the service. For more information about watt.server.event.routing.runAsUser, see webMethods Integration Server Administrator’s Guide.
isDurable
String Optional. Indicates whether or not the subscription is durable. Set to:
*true if you want the subscription to be a durable subscription.
Note: You must specify a unique value for the subscriberID parameter if you set isDurable to true.
In case of durable subscriptions, the messaging provider saves the messages for an inactive subscriber and delivers these saved messages when the subscriber creates a new subscription by specifying the same subscriberID. The messaging provider retains the messages for durable subscriptions until they are retrieved by the subscriber or until they expire.
*false if you do not want the subscription to be durable. This is the default.
Non-durable subscriptions allow subscribers to receive messages only if those messages are published while the subscription is active.
subscriberID
String Optional. User-specified unique identifier that designates the subscription as a durable subscription on the messaging provider. If no subscriberID is specified, the subscription will be non-durable.
If you remove a durable subscription by using the pub.event.routing:unsubscribe service with the removeDurable parameter set to false and you want to resume the subscription, you can do so by giving the same subscriberID in the pub.event.routing:subscribe service. However, if removeDurable is set to true while unsubscribing, you will have to create a new subscription with a new subscriberID.
If no subscriberID is specified, the subscription that is created is non-durable.
Note: You must specify a unique value for the subscriberID parameter if you set isDurable to true.
Output Parameters
None.
Usage Notes
This service replaces pub.event.nerv:subscribe, which has been removed.
Integration Server does not persist the subscriptions to event types across server restarts or WmPublic package reloads. Consequently, you need to create subscriptions each time Integration Server starts or you reload the WmPublic package. If you want these subscriptions to be created each time Integration Server starts or you reload the WmPublic package, you can assign the services that create durable subscriptions for various event types as startup services for the WmPublic package.
See Also
pub.event.routing:send
pub.event.routing:unsubscribe
pub.event.eda:event
Copyright © 2015- 2018 | Software AG, Darmstadt, Germany and/or Software AG USA, Inc., Reston, VA, USA, and/or its subsidiaries and/or its affiliates and/or their licensors.
Innovation Release