Integration Server 10.5 | Built-In Services Reference Guide | Event Folder | Summary of Elements in this Folder | pub.event:addSubscriber
 
pub.event:addSubscriber
WmPublic. Creates a subscription for a specified event.
Important:
Subscriptions that you add using this service take effect immediately; however, they are not made permanent unless you also persist them to disk with the pub.event:saveEventManagerSettings service. If you do not run pub.event:saveEventManagerSettings after adding subscribers, your changes will be lost when the server is restarted.
Input Parameters
EventType
String Type of event to which the event handler is subscribing. Must be one of the following:
Alarm Event
Audit Event
Audit Error Event
Error Event
Exception Event
GD End Event
AGD Start Event
JMS Delivery Failure Event
JMS Retrieval Failure Event
Journal 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.
Filter
String Selects (filters) the set of events within EventType to which the event handler is subscribing. addSubscriber uses Filter as a pattern string to filter a particular attribute of an event.
The pattern string can be composed of literal characters, which match a character exactly, and/or the "*" character, which matches any sequence of characters. For example:
This pattern string...
Would match...
*
Any string
M*
Any string that starts with an uppercase "M."
M*X
Any string that starts with an uppercase "M" and ends with an uppercase "X."
The following table shows the attribute that is filtered for each event type. Note that some event types cannot be filtered.
EventType
Filtered attribute
Alarm Event
Message generated by the alarm event.
Audit Event
Fully qualified name of the service that generates the audit event.
Audit Error Event
Concatenated values of the destination and errorCode parameters of the audit error event.
Error Event
Error message text for the error that generates the error event.
Exception Event
Fully qualified name of the service that generates the exception event.
GD End Event
None. This event type cannot be filtered. Filter is ignored for this event type.
GD Start Event
Fully qualified name of the service that generates the GD Start Event.
JMS Delivery Failure Event
Name of the JMS connection alias used to send the message to the JMS provider.
JMS Retrieval Failure Event
Fully qualified name of the JMS trigger that invoked the trigger service for which the error occurred.
Journal Event
The major code and minor code of the message that causes the journal event.
Port Status Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Replication Event
Name of the package being replicated.
Security Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Session End Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Session Expire Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Session Start Event
User ID of the user starting the session or the groups to which the user belongs. (The filter is applied to a space-delimited list of groups, composed of group names suffixed with the user's user ID.)
The following examples show how you might filter session start events for various groups and/or user IDs:
To select session starts for any user in the Administrators group, the filter would be:
*Administrators*
To select session starts for the user ID "LRMalley" in the Administrators group, the filter would be:
*Administrators*LRMalley
To select session starts for the user ID "LRMalley" in any group, the filter would be:
*LRMalley
Stat Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Tx End Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Tx Start Event
None. This event type cannot be filtered. Filter is ignored for this event type.
Service
String Fully qualified name of the event-handler service (the service that will execute when the event specified by EventType and Filter occurs).
Comment
String Descriptive comment for this subscription. This comment is displayed when subscriptions are viewed with Designer.
Enabled
String Flag specifying the status of the subscription. Must be one of the following values. Set to:
*true to make the subscription active.
*false to make the subscription inactive. This is the default.
Note:
Although the default value is false, you will generally want to set Enabled to true to activate the subscription immediately when it is added.
Output Parameters
Result
String Flag indicating whether the subscriber was successfully added. A value of:
*true indicates that the subscriber was added successfully.
*false indicates that the subscriber was not added.
See Also
pub.event:deleteSubscriber
pub.event:modifySubscriber
pub.event:getSubscribers
pub.event:saveEventManagerSettings