Integration Server 10.5 | Built-In Services Reference Guide | Event Folder | Summary of Elements in this Folder | pub.event:getSubscribers
 
pub.event:getSubscribers
WmPublic. Returns the list of subscribers for a specified event type.
Input Parameters
EventType
String Type of event for which you want the list of subscribers. Must be one of the following values:
Alarm Event
Audit Event
Audit Error Event
Exception Event
GD End Event
GD Start Event
JMS Delivery Failure Event
JMS Retrieval Failure Event
Port Status Event
Replication Event
Security Event
Session End Event
Session Expire Event
Session Start Event
Stat Event
Tx End Event
Tx Start Event
Tip:
To view the current list of event types, you can execute the pub.event:getEventTypes service.
Output Parameters
Subscribers
Document The list of subscribers. For each subscriber, Subscribers will contain a key that is the subscriber ID. The value of that key is a document containing the following information about the subscriber:
Key
Description
Service
String Fully qualified name of the event-handler service (that is, the service that subscribes to the event in EventType).
Filter
String Filter associated with the subscription. This is a pattern string that selects (filters) an event based on a particular attribute. Filter is composed of literal characters, which match a character exactly, and/or the "*" character, which matches any sequence of characters. For example:
** would math any string.
*M* would math any string that starts with an uppercase "M."
*M*X would math any string that starts with an uppercase "M" and ends with an uppercase "X."
For a list of attributes to which the filter is applied, see pub.event:addSubscriber.
Comment
String Descriptive comment associated with the description. If a comment has not been assigned to the subscription, Comment will be empty.
gID
String Subscriber ID.
Enabled
String Flag indicating the status of the subscription. Will be one of the following values. A value of:
*true indicates that the subscription is active.
*false indicates that the subscription is inactive.
See Also
pub.event:addSubscriber
pub.event:modifySubscriber
pub.event:deleteSubscriber