Integration Server 10.15 | Built-In Services Reference Guide | Alert Folder | Summary of Elements in this Folder | pub.alert.notifier:create
 
pub.alert.notifier:create
WmPublic. Creates a notifier.
Input Parameters
name
String. Name of the notifier.
enabled
Boolean. Optional. Specifies whether the notifier is enabled or not. Set to:
*true to enable the notifier.
*false to disable the notifier. This is the default.
If a notifier is disabled, alerts are not fetched for the notifier.
consumptionMode
String. Optional. Specifies whether notifications are created for all alerts or only the latest alerts. Set to:
*earliest to get notifications for all alerts in the system. This is the default.
*latest to get notifications only for the alerts emitted after the notifier is created.
autoMark
Boolean. Optional. Specifies whether notifications are automatically marked as read or a user must do it manually. Set to:
*true to automatically mark a notification as read after the service specified in the notifier settings is invoked. This is the default.
*false to manually dismiss a notification from Integration Server Administrator, which marks the notification as read.
channelIds
Object[]. Identifies the channels for which you want to receive notifications. You can specify either an individual channel identifier or a list of identifiers. For example, channelIds[0] as 2 for "Server Error" or channelIds[1] as 10 for "Threat Protection" or channelIds[0] as 2 and channelIds[1] as 1 for both.
intervalInSeconds
Short. Time in seconds after which the system task created for the notifier should check for unread alerts.
severityCutoff
String. The severity to consider for fetching alerts. For example, if you set this value as Critical, you will receive notifications only for critical events. If you set this value as Error, you will receive notifications for critical and error events. Set the parameter to one of the following values:
*Critical. This is the default.
*Error
*Information
*Warning
notifyInstantly
Boolean. Optional. Specifies whether or not notifications are generated as soon as an alert is raised. Set to:
*true to instantly generate a notification for an alert.
*false if an instant notification is not required for an alert. This is the default.
Note:
If intervalInSeconds is also specified, the notifyInstantly parameter takes precedence.
webSocketEnabled
Boolean. Optional. Specifies whether or not Integration Server uses a WebSocket connection to send notifications. Set to:
*true to enable a WebSocket connection to send notifications.
*false to disable a WebSocket connection. This is the default.
webSocketSender
Document. Optional. 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.
serviceInvokeEnabled
Boolean. Optional. Specifies whether a service is invoked with the notifier parameters as pipeline variables or not. Set to:
*true to invoke a service using the notifier parameters.
*false to disable service invocation for the notifier. This is the default.
serviceInvokeSender
Document. Optional. 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. Optional. Specifies whether Integration Server uses an SMTP server to send notifications or not. Set to:
*true to use an SMTP server to send notifications.
*false if you do not want to use an SMTP server to send notifications. This is the default.
smtpSender
Document. Optional. 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. If you specify multiple addresses, separate them 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. Optional. The port on which the SMTP server listens to incoming connections.
auth
Document. Optional. Authorization information that the SMTP service submits to the SMTP server.
Key
Description
user
String. Username that Integration Server uses to send notifications.
pass
String. Password associated with the user.
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.
Output Parameters
message
String. Indicates whether the notifier is successfully created or not.
Usage Notes
If you specify the intervalInSeconds parameter while creating a notifier, Integration Server creates a simple interval task that runs in the background and does the tasks specified in the notifier such as invoking a service or sending a mail, and so on.
Prior to Integration Server version 10.15, the pub.alert.notifier:create service included the smtpSender/secure/useJSSE input 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:create, 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 useJSSE were set to yes.