i4connected Knowledgebase

Configuring the Alarm Emailing Settings

Abstract

Check out this guide in order to learn how to configure the alarm emailing functionality within the i4connected system.

This article describes how to configure the alarm emailing functionality within the i4connected system.

The alarm email settings can be configured using the WEBfactory DWH Server.exe.config file of the Server (located in the root directory of the Server). The email related XML settings are available under the <mailSettings> node, as follows:

<mailSettings>
	<smtp from="report.webfactory@gmail.com" deliveryMethod="Network">
            <network host="smtp.gmail.com" port="587" enableSsl="true" userName="report.webfactory@gmail.com" password="*******" defaultCredentials="false" />
        </smtp>
</mailSettings

The XML code above is commented by default thus the alarm email functionality is disabled. The alarm email functionality is enabled automatically when the XML code above is uncommented.

The Server reads the configuration when starting, so restarting the Server is required after configuring the Alarm Email Settings.

The <smtp> node

The attributes of the <smtp> node allow the user to configure the delivery method and the sender:

<smtp from="report.webfactory@gmail.com" deliveryMethod="Network">

Attribute

Description

deliveryMethod

Specifies the delivery method for e-mails. Acceptable values are network, pickupDirectoryFromIis, and specifiedPickupDirectory.

  • network: uses a SMTP server from the local network

  • pickupDirectoryFromIis: saves the emails as files in the IIS directory. Another server can pick up the files and send the emails.

  • specifiedPickupDirectory: saves the emails as files in a specified directory. Another server can pick up the files and send the emails.

from

The sender identity. In the example displayed above, the identity is represented by the name of the sender and the email address (specified between angular brackets <> written in ASCI code).

The <network> child node

The attributes of the <network> node allow the user to configure the SMTP host, port, encryption, SMTP user and receiver.

<network host="smtp.gmail.com" port="587" enableSsl="true" userName="report.webfactory@gmail.com" password="********" defaultCredentials="false" />

Attribute

Description

host

Specifies the hostname of the SMTP mail server to use for SMTP transactions. This attribute has no default value.

port

Specifies the port number to use to connect to the SMTP mail server. The default value is 25.

enableSsl

Specifies whether SSL is used to access an SMTP mail server. The default value is true.

defaultCredentials

Specifies whether the default user credentials should be used to access the SMTP mail server for SMTP transactions. The default value is false.

userName

Specifies the user name to use for authentication to the SMTP mail server.

password

Specifies the the user password for authentication to the SMTP mail server.

The <specifiedPickupDirectory> child node

This node is required only when using the specifiedPickupDirectory delivery method in the <smtp> node. The node's attribute allows the user to specify the target directory where the emails will be saved.

<specifiedPickupDirectory pickupDirectoryLocation="directory" />

Attribute

Description

pickupDirectoryLocation

The directory where applications save e-mail for later processing by the SMTP server.

Tip

More information about the mailSettings XML node is available on the official MSDN page: <mailSettings> Element (Network Settings)