Integration Server 10.15 | Built-In Services Reference Guide | Alert Folder | Summary of Elements in this Folder | pub.alert.notifier:list
 
pub.alert.notifier:list
WmPublic. Lists all the notifiers in the system.
Input Parameters
None.
Output Parameters
notifiers
Document List. The list of notifiers in the system. Each notifier has the following keys:
Key
Description
name
String. Name of the notifier.
enabled
Boolean. Specifies whether the notifier is enabled or not. A value of:
*true indicates that the notifier is enabled.
*false indicates that the notifier is disabled.
If a notifier is disabled, alerts are not fetched for the notifier.
consumption​Mode
String. Specifies whether notifications are created for all alerts or only the latest alerts. A value of:
*earliest indicates that the notifications are generated for all alerts in the system.
*latest indicates that the notifications are generated only for the alerts emitted after the notifier is created.
autoMark
Boolean. Specifies whether notifications should be automatically marked as read or a user must do it manually. A value of:
*true indicates that the system automatically processes the notification. For example, a notification is automatically marked as read after the service specified in the notifier settings is invoked.
*false indicates that a user must manually mark the notification as read.
channelIds
Object[]. List of identifiers of the channels for which you want to receive notifications.
interval​InSeconds
Short. Time in seconds after which the notifier should check for unread alerts.
severityCutoff
String. The severity to consider for fetching alerts. For example, if this value is Critical, you will receive notifications only for critical events. If this value is Error, you will receive notifications for critical and error events. This parameter can have one of the following values:
*Critical
*Error
*Information
*Warning
notifyInstantly
Boolean. Specifies whether or not notifications is generated as soon as an alert is raised. A value of:
*true indicates that notifications are generated instantly for an alert.
*false indicates that notifications are not generated instantly for an alert.
Note:
If intervalInSeconds is also specified, the notifyInstantly parameter takes precedence.
webSocket​Enabled
Boolean. Specifies whether or not Integration Server uses a WebSocket connection to send notifications. A value of :
*true indicates that a WebSocket connection is enabled to send notifications.
*false indicates that a WebSocket connection is disabled.
webSocket​Sender
Document. Sends a message on a connected WebSocket session.
Key
Description
endPointURL
String. The URL of the remote WebSocket server that Integration Server uses to send notifications.
service​InvokeEnabled
Boolean. Specifies whether a service is invoked with the notifier parameters as pipeline variables or not. A value of:
*true indicates that a service can be invoked using the notifier parameters.
*false indicates that a service invocation is disabled for the notifier.
service​InvokeSender
Document. Invokes a service for alerts fetched for this notifier.
Key
Description
nsName
String. The namespace of the service. For example, pub.flow:tracePipeline
smtpEnabled
Boolean. Specifies whether Integration Server uses an SMTP server to send notifications or not.
smtpSender
Document. Details of the SMTP Server and client used to send the notifications.
Key
Description
to
String. E-mail address of the recipient for a notification. Multiple addresses are separated with commas.
from
String. E-mail address of the sender. If you do not specify this value, Integration Server uses the value specified for the mail.smtp.from JVM property. Furthermore, if a value is not specified for that property, Integration Server uses the default value, user@servername, where the user is the operating system user ID, and servername is the host name of Integration Server.
mailhost
String. Hostname of the SMTP server.
mailhostPort
Integer. The port on which the SMTP server listens to incoming connections.
auth
Document. Authorization information that the SMTP service submits to the SMTP server.
Key
Description
user
String. Username that Integration Server uses to send notifications.
secure
Document. Parameters specifying the security protocol and trust store information to perform certificate validation, which Integration Server uses to communicate with the SMTP server port.
Key
Description
transport​Layer​Security
String. Type of the security protocol that Integration Server uses to communicate with the SMTP server port. Set to:
*none, to use a non-secure mode to communicate with the port on the SMTP server. This is the default.
*explicit, to use explicit security when communicating with the port on the SMTP server. With explicit security, Integration Server establishes an un-encrypted connection to the e-mail server, and then switches to the secure mode.
*implicit, to use implicit security to communicate with the port on the SMTP server. With implicit security, Integration Server always establishes an encrypted connection to the e-mail server.
truststore​Alias
String. Alias for the truststore that contains the list of certificates that Integration Server uses to validate the trust relationship. If you do not specify a truststore alias, the default truststore alias is used.
Usage Notes
Prior to Integration Server version 10.15, the pub.alert.notifier:list service included the smtpSender/secure/useJSSE output parameter which specified whether Integration Server created the outbound connection using the Java Secure Socket Extension (JSSE) library. Beginning with Integration Serverversion 10.15, Integration Server establishes all secure outbound connections with JSSE. If you migrated to Integration Server 10.15 and a migrated service invokes pub.alert.notifier:list, the smtpSender/secure/useJSSE parameter still appears in the pipeline. However, Integration Server ignores the value of the smtpSender/secure/useJSSE parameter, proceeding as if smtpSender/secure/useJSSE were set to yes.