Setting Up Alert Destinations and Notifications

Click the Alert Destinations node in the navigation tree to see currently defined destinations. The pane displays the user-supplied name of the destination and the destination type, either email or SNMP.

Click the New Destination button to create a new destination. The Add Alert Destination pane opens. You start by entering a name for the destination and selecting the destination type. From the Type pull-down list, select the type of destination: email or SNMP. (See below.)

Depending on the destination type you select, you are prompted for additional fields.

When adding an email-type destination, you must designate server and the recipient user information. The figure below is an example of configuring an email destination:

For an email destination, you need to specify the following:

Check the TLS/SSL box if the server requires a secure environment. You must set this field to conform to your SMTP provider’s server configuration.

When finished, click Save to complete adding the destination.

SNMP-type destinations have different fields than email-type destinations. The figure below is an example of how you might set up an SNMP destination:

Specify the following for SNMP destinations:

When finished, click Save to complete adding the destination.

To edit a destination, double-click the destination entry in the Alert Destinations pane. The edit pane displays the data entered for that destination and you can change values as needed.

Set up notifications after you have defined possible destinations for your notifications. When you create a new notification, you must select a destination for the notification from a list of defined destinations.

Click the Alert Notifications node in the navigation tree to view alert notifications that are already defined. The pane displays the names of all alert notifications and their destinations.

To create a new notification, click the New Notification button. The Add Alert Notification pane opens. (See below.)

Enter a name for the notification. Specifying a filter for the notification is optional and is covered in the next paragraph. Select the notification destination from the Destination pull-down list. If you have not yet defined a destination, then this list is empty and you cannot complete the notification specification.

You optionally may specify one or more filters. When you click the Add button in the middle of the pane, the pane displays a table into which you specify the filter field(s) and values for these field(s). You may add as many filter fields as you like. Select each filter field from the Field pull-down menu. The Value pull-down menu displays the values that correspond to the selected field. (The figure below is an example of this.)

For each filter field you specify, be sure to click the Save button beneath the Field/Values table to save that filter, or click Cancel to discard the entry. You can select filter fields and delete them, if you want. Add additional filters by clicking the Add button, but be sure you click Save or Cancel before specifying these additional filter fields.

For example, the next figure shows how you might filter notifications on the Alert field. Once you select Alert for the Field column, the Value column displays any alerts that have been defined and you can select an alert value from the list.

The Filter table displays any added filters. You can remove any filters you have added by clicking the red X to the right of the Value column.

If the destination type you select is email, you enter the email recipient name, the name of the sender, a subject, and text for the body of the email. You must enter data for all these fields (See the figure below.)

For email destinations, you may use an expression in the subject and body fields. To use an expression and have it correctly interpreted, you must enclose the expression in curly braces and precede it with a dollar sign ($) symbol, as shown below. For example:

You can combine the expression with some other text. For example, you might want a subject line that displays a standard message that an alert has been triggered but also includes an expression indicating the alert condition. You might set the subject field as follows:

See below for more information on properties that you can use with these alert expressions.

When the destination type is SNMP, you are prompted just for a value, as shown below. You must enter data for the Value field to be able to save the notification.

For all notifications, be sure to click the Save button after you have entered all required data. Notice that the Save button is grayed out until all required fields are completed.

To edit a notification, double-click the notification entry in the Alert Notifications pane. The edit pane displays the data entered for that notification and you can change values as needed.

There are a number of properties whose values you can incorporate into alert destinations and notifications. You incorporate these properties using the expression syntax shown above. Some properties are common to all alert types, while others pertain to specific alert types.

The following properties are common to all alert types. (The class com.mulesoft.console.alert.RaisedAlert contains the declaration of alert properties.)

Certain alert types have other accessible properties in addition to the common properties shown above. The table below shows the alert types for which additional properties are defined and the specific properties.