Email Tab - Metasys - LIT-12011964 - Software Application - System Configuration Tool - 13.2

Metasys SCT: System Configuration Tool Help

Brand
Metasys
Product name
System Configuration Tool
Document type
User Guide
Document number
LIT-12011964
Version
13.2
Revision date
2020-01-21
Language
English

The Email tab appears on Engine or Server objects. The Email DDA Attributes appear on the Shared Configuration section of the Email Tab. The Email DDA Destination Configuration Attributes appear when you edit a specific Email destination on the Email tab.

Notes:
  • At Metasys Release 10.1 the edit button is disabled for an ADS, ADX, or OAS. For these devices, use the Metasys UI to modify the attributes on this tab.
  • At Release 7.0 or later, Email Tab Destinations and all DDA communications feature alphabetical sorting. See table below.
Table 1. Email Sorting Icons
Icon Icon Name Description
Ascending Sorts destinations in alphabetical order
Descending Sorts destinations in reverse alphabetical order
Table 2. Email DDA Shared Configuration Attributes

Attribute Name

Description

SMTP Server Host

Specifies either a host name or IP address of a SMTP server. A host name can be specified only if a DNS is available to the device. This attribute is used in conjunction with Email DDA attribute. If no Email DDA destinations are configured, this attribute is ignored.

SMTP Port

Signifies the TCP port on which Email DDA should connect to deliver an email message. By default, this field is set to 25 (SMTP); however, some internal SMTP servers may be set up to non-standard ports, which require that this field be changed to match the listening port of the mail exchanger. If no Email DDA attribute exists, this attribute is ignored.

Authentication Type

Specifies the type of authentication used to send and receive emails. Depending on the selection you make, the fields on the Email tab become enabled or disabled to help you fill in only the fields required for that authentication type. If you select SMTP, the SMTP User Name and SMTP Password attributes become enabled. If you select POP-before-SMTP, the POP User Name and POP Password attributes become enabled.

SMTP User Name

Specifies a user name for the SMTP server. This attribute is ignored if the SMTP Server Host is empty. This attribute applies only when using SMTP authentication. If no Email DDA destinations are configured, this attribute is ignored. See SMTP Password.

SMTP Password

Specifies the password for the SMTP user name. This attribute is ignored if the SMTP Server Host is empty. This attribute applies only when using SMTP authentication. If no Email DDA destinations are configured, this attribute is ignored. See SMTP User Name.

POP Server Hostname

Specifies the hostname for the POP server. This attribute applies only when using POP authentication. If no Email DDA destinations are configured, this attribute is ignored.

POP User Name

Specifies a user name for the POP server. This attribute is ignored if the POP Server Hostname is empty. This attribute applies only when using POP authentication. If no Email DDA destinations are configured, this attribute is ignored.

POP Password

Specifies the password for the POP user name. This attribute is ignored if the POP Server Hostname is empty. This attribute applies only when using POP authentication. If no Email DDA destinations are configured, this attribute is ignored.

From Email Address

Specifies the email address from which all emails are sent. The From Email Address is a required field. If this attribute is not populated, the Email DDA does not attempt to send an email message.

SSL Email Enabled

When enabled or set to True, emails attempt to send over an SSL encrypted connection. If SSL is not supported, the email sends unencrypted unless SSL Email Ignoring Errors option is set to False. This attribute is disabled by default.

SSL Email Ignoring Errors

When True, the email is still 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. The feature is only enabled if SSL Email Enabled is True.

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 3. Email DDA Destination Configuration Attributes

Attribute Name

Description

Label

Identifies the user-friendly destination name in the list of Email DDAs. Maximum characters: 80

Email Address

Specifies the email address of one or more recipients. You must use valid email addresses set up on an email server for the device to successfully send the email alarms. When entering more than one email address, separate the addresses with a comma (for example, Jonathan.Smith@jci.com,Jane.Smith@jci.com).

Click the Browse icon to select email addresses defined by the user accounts in the Security Administrator system.

Maximum characters: 256

Priority

Specifies the priority of the outbound email message. This attribute defines the X-Priority field within the email’s MIME header. X-Priority is one of several ways to define the significance of an email. Not all email clients interpret it the same way. Refer to your email client’s documentation for more information.

You can choose from the following values:
  • High
  • Normal
  • Low
See the Hi Normal Low (Set 100).

Subject

Specifies the user-defined text that appears in the subject field of the email message.

Maximum characters: 256

Retries

Specifies the number or attempts made to send a message if there is a failure before the system discards it.

Range: 0–10

Enabled

Defines whether or not the destination is enabled. When this attribute is False, the Engine or Server does not deliver alarms to the configured recipients.

Filters

Specifies the rules to filter alarms. This attribute uses Alarm Value (Set 108).

See Filters for more information.

Format

Defines the format of the message, indicating which fields are present in the received message.

The following fields are optional:
  • Acknowledge Required (not an option for pager)
  • Authorization Category
  • Item Description
  • Item Fully Qualified Reference
  • Message
  • Previous Status
  • Priority
  • Site Name
  • Value

Refer to the Event Message Routing, Filtering, and Destinations section of the Metasys SMP Help (LIT-1201793) for more information on this DDA.