Related Products: |
EMMK-101, EMMK-102, EMMK-103 |
Related Documents: |
ISCM-0380, ISCM-0385 |
Type: |
Operation |
Keywords/Labels: |
address groups, email templates, testing email notifications |
Summary: |
This article explains how to create address groups, create email templates, add email templates and address groups to alarms, testing email notifications, and acknowledge alarms. |
Configure InsightCM to send alarm notification emails.
Before you begin, configure your role with serverSettings_edit permissions, create an address group, and create an email template. Refer to Relationships Between User Accounts and Permissions for more information about permissions.
-
On the server machine, in File Explorer, navigate to the ProgramData\Cutsforth\InsightCM\Auth folder.
-
Open the SmtpConfiguration.json file in a text file editor.
-
Modify each line category according to your server information.
"Host": "<servername>",
"Port": "<port number>",
"UseSsl": <true or false>,
"RequireAuthentication": <true or false>,
"Username": "<username>",
"Password": "Secret\\Password", "Secret\"Password"
Note
If your password contains backslashes or double quotations, you must use double backslashes or a backslash and double quotations respectively as shown in the above example.
"TimeoutSeconds": <number>,
"FromAddress": "yes-reply@localhost",
"TestMode": <true or false>
-
Save the .json file and open Windows Services.
-
Find and select InsightCM <version> and click Restart.
Create and maintain lists of email addresses to which InsightCM sends alarms and other notifications.
If there are several users that need to receive certain email notifications, create an address group. Use address groups to keep a diverse portfolio of users informed regarding the state of InsightCM or the equipment it is monitoring. Complete the following steps to create a new address group and assign the group to an alarm rule.
Note
To customize the email sent for a specific alarm rule, create an email template and assign it to the alarm rule. Refer to Creating Email Templates to learn how to do so.
-
Click the Navigation menu () and select Options.
-
Navigate to the Notifications section, select Address Groups,and click the Add button.
-
Enter a name for the address group in the Name text box.
-
Enter valid user email addresses and separate each email address with a comma, new line, space, or semicolon.
-
Configure the level of visibility that individual users have regarding other recipients of the same email notification by using the various recipient text boxes.
-
Click OK to add the new address group to the Selected Group pull-down list.
Create templates for email notifications that the InsightCM Server sends when an alarm is set.
-
Click the Navigation menu () and select Options.
-
Scroll down to the Notifications section and select Email Templates.
-
Select the default option from the Template pull-down.
-
Click the Edit button to give the email template a descriptive name and click OK.
-
Write a brief description of what information this template will send about an alarm.
-
Write an informative subject line for the email template.
-
Write the contents of the email and click OK.
Note
Define email templates independently of address groups to pair one address group with multiple email templates or one email template with multiple address groups. You may want to notify a single individual when a low-severity alarm occurs, but notify several individuals with the same message when a high-severity alarm occurs.
Assign an email template to an alarm level.
Before you begin, create an email template and create an address group.
-
Click the Navigation menu () and select Alarms.
-
Select an alarm and click Edit.
-
Under Levels, select an alarm severity level and click Edit.
-
Select the Send Email checkbox.
-
Select an address group.
-
Select an email template.
-
Click OK.
Use the console to test whether InsightCM sends email notifications successfully.
Before you begin, set up email alarm notifications.
-
On the server computer, open Command Prompt.
-
Navigate to the folder in which InsightCM is saved using the following command:
cd C:\Program Files\Cutsforth\InsightCM
-
Execute the following commands to test email notifications:
InsightCMConsole.exe sendtestemail -grp [address group name]
-
Verify whether a test email notification is sent to those in the address group.
The server implements authentication for users by providing permissions to groups of users. Permissions serve as access rights that control the ability of the users to view or make changes to specific pages in the web application. Therefore, you might not see pages, tabs, or components described in this help system, or you might not be able to edit particular settings. When possible, this help system documents the permissions required to perform actions so you can seek assistance from a user who possesses the required permissions.
View the relevant data for and acknowledge a trend alarm.
-
Click the Navigation menu () and select Alarms > Active Trend.
-
Select an alarm and click View to see the relevant Trend viewer data in the Alarm dialog.
-
Click Acknowledge.
As a result, you moved the alarm instance from the Active Trend Alarm tab to the Alarm Instances dialog, though you did not clear the instance.