Creating email alarm and event notifications and destinations in SMP UI at Release 11.0 and earlier - Metasys - LIT-12013352 - M4-SNE10500-0 - M4-SNE10501-0 - M4-SNE11000-0 - M4-SNE11001-0 - M4-SNE110L0-0 - M4-SNE110L1-0 - M4-SNE22000-0 - M4-SNE22001-0 - Supervisory Device - SNE10 Network Engine - SNE11 Network Engine - SNE22 Network Engine - SNE Supervisory Network Engine - 12.0

SNE Commissioning Guide

Brand
Metasys
Product name
SNE10 Network Engine
SNE11 Network Engine
SNE22 Network Engine
SNE Supervisory Network Engine
Document type
Commissioning Guide
Document number
LIT-12013352
Version
12.0
Revision date
2022-12-12
Product status
Active
Language
English
Important: LCS85 email configuration is no longer available with the SMP UI at Release 12.0.

A network engine can be set up to generate custom alarm and event email messages and send the messages to one or more specified email destinations.

Note: In most scenarios, we recommend that you set up the Email DDA and configure the email notifications and the notification destinations after the network engine is configured with an archive database that includes the user database.
  1. In the Site Management Portal UI, display the network engine device object, click the Email tab, and then click Edit. (See the top half of the Display panel in jka1593024573512.html#qli1560500392124__fig_997C7AE44DE84E908D31C810D5713435.)
  2. Enter the Shared Configuration values according to Table 1. These fields establish values for attributes that are common to all email alarm notifications generated from this network engine. Refer to Alarm and Event Management in Metasys Site Management Portal Help (LIT-1201793) for additional information on setting the attribute values for alarm and event notifications.
  3. Scroll down to the Destinations section of the Email tab.
  4. Click New. The Email Destinations Configuration edit section appears.
    Figure 1. SNE Email Configuration - Edit Mode
  5. Enter the Destination values according to Table 1. (Refer to the Alarm and Events Management section in the Metasys Site Management Portal Help (LIT-1201793) for additional information on setting the attribute values for alarm and event notifications.)
    Table 1. Shared Attributes for All Email Destinations

    Attribute

    Description (Value Requirement/Range)

    Initial Value

    SMTP Server Host

    Specifies the SMTP server name that handles outgoing email. (Required Value)

    Fully qualified host name

    SMTP Port

    Specifies the TCP port that the server uses to deliver email message. (Required Value/1 to 25)

    25

    Authentication Type

    Specifies the Authentication Type the network engine uses to log in to the outgoing email server. Select SMTP, POP before SMTP, or None.

    None

    SMTP User Name

    Specifies the user name the network engine uses to log in to the SMTP server that handles outgoing email messages. (Required only if SMTP is selected for Authentication Type.)

    SMTP Password

    Specifies the password the network engine uses to log in to the SMTP server that handles outgoing email messages. (Required only if SMTP is selected for Authentication Type.)

    POP Server Hostname

    Specifies the POP server name for incoming email messages. (Required only if the email server requires POP before SMTP, before it accepts email messages from client. If this field is left blank, POP before SMTP is disabled.)

    POP User name

    Specifies the POP user name. (Required only if POP Authentication is required and there is a value specified for POP server host.)

    Maximum 20 characters

    POP Password

    Specifies the POP Password. (Required only if POP Authentication is required and there is a value specified for POP server host.)

    Maximum 20 characters

    From Email Address

    Specifies a valid email address that is recognized and exists on the SMTP Server. (Required Value)

    Email address

    SSL Email Enabled

    When True, emails are sent over an SSL-encrypted connection if the server supports encryption with StartTLS. When this parameter is set to True, emails are not sent if they cannot be encrypted, regardless of the SSL Email Ignoring Errors attribute setting.

    False

    SSL Email Ignoring Errors

    When True, the email is sent even if the email server certificate appears to be invalid. When False, the email is sent only if the operating system can verify that the server sent a valid SSL certificate. This feature is only enabled if SSL Email Enabled is True.

    Note: Make sure that correct certificate revocation, such as Online Certificate Status Protocol (OCSP) stapling, is enabled and configured. For more information about OCSP configuration, refer to https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-ocsp/5792b4c4-c6ba-439a-9c2a-52867d12fb66.

    False

    Email Diagnostics

    Displays diagnostic information regarding the communication between the Email DDA (SMTP Client) and the SMTP Server. This attribute displays both successful and unsuccessful email message deliveries.

    Table 2. Attributes for Specific Email Destinations and Notifications

    Attribute

    Description (Value Requirement/Range)

    Initial Value

    Label

    Specifies a name for the email destination (for example, John Doe).

    Email Address

    Specifies the destination email addresses (for example, john.doe@jci.com). (Required Value)

    Priority

    Specifies the email message priority (High, low, or normal).

    Normal

    Subject

    Contains the body text of the email message. (Maximum of 256 characters.)

    Retries

    Specifies the number of attempts at sending the email message. (0–10 Retries)

    3

    Enabled

    Enables or disables Email Destination. (True, False)

    True

    Filters

    Enables you to specify the rules that filter alarm and event notifications. Each filter has an Item, Operator, and Value.

    Format

    Enables some predefined format characteristics of the notifications that are sent to a destination. Predefined format characteristics include:
    • Notification Priority
    • Notification Message (content)
    • Value
    • Site Name
    • Item Description
    • Item Fully Qualified Reference
    • Item Category
    • Acknowledge Required
    • Previous Status
    (Enable a format by selecting the check box next to the format.)

  6. Click New to the right of Destination Email Addresses. The Email Import dialog box appears. Import user names and the associated email addresses from the list of user names for the site. (Refer to the Metasys® SMP Help [LIT-1201793] for more information.)
    Figure 2. Import Email Addresses Dialog Box

  7. To filter the email messages that are sent to a destination, click New next to the Filters section of the Email Destination Configuration tab. The Add Filter dialog box appears.
    Figure 3. Add Filter Dialog Box

  8. Select the Item, Operator, and Value (from the drop-down lists) for the condition that you want to trigger the email notification. (Refer to Event Message Routing, Filtering, and Destinations in the Metasys® SMP Help [LIT-1201793] for additional information on filters.)
  9. Click OK.
  10. Enable the Format characteristics for email notifications sent to the specified destinations by selecting the check boxes next to the Format characteristic.
  11. Add additional email destinations with filters and formats as required.
  12. Click Save.