Using the > Email Layout page, you can create as many reusable email layouts (templates) for alerts as you want. Email layouts allow you to specify email format (plain text or HTML) and the information you want included in alert subject lines and content.
These formats may be applied to any of your alarms (in the General Options section of alarm settings). Only one layout can be specified per alarm. If you do not create your own email layouts, a default layout is used.
Email layout page
When you land on the Email Layout page, the templates you have created are listed by name. You can manage your templates from here; click to edit and to delete a layout.
Click Create Layout to create a new layout.
Creating or editing an email layout
- Navigate to > Email Layout .
Click Create Layout at top right. To edit an existing layout, click . You are directed to email layout settings.
Subject line and content fields are described in detail in Email Layout Settings below.
Enter or edit the Email Format Name to identify your template.
- Choose an Email Format (HTML or Plain Text ).
- Make other changes and click Save . Your newly created layout is now listed in the Email Layout page.
Email layout settings
When you click Create Layout to create a new layout from scratch, the default subject line includes the measurement name, warning/critical status, and performance/availability values.
The default message body of the alert lists the three most common errors (for availability alarms) or the three slowest measurement locations and their download performance (for performance alarms). There is also a hyperlink in the message body that takes you to a scatter plot for the data that generated the alarm. This information allows you to quickly make diagnostic decisions or even dismiss alarms generated by a few “outliers.”
Subject line items
Fields available for insertion into the email subject line are described below. Check the box next to a field to select it. The Sample subject line displays examples of selected fields. Hover over a field name to see the corresponding value highlighted in the sample subject line.
You can select and move the items in the sample subject line to change the order in which they appear.
|Escalation Prefix||If an escalation time period has been specified, this field inserts the word “Escalation” in the subject line of escalation alerts.|
|Slot Alias||Inserts the measurement name into the subject line of the alert.|
|URL||Inserts the initial URL navigated to into the alert subject line.|
|Alarm Alias||Inserts the alias or alarm name into the alert subject line.|
|Warning/Critical Status||Inserts the status of the alert (either warning or critical).|
|Performance/Availability Values||Inserts whether the alert is for performance or availability and the triggering value into the subject line of the alert.|
|Custom Text||When configuring an alarm, you can define brief custom text to appear in the subject line of alerts. After you check this option, enter your text in the field that appears below.|
Email subject line best practices
- The Escalation Prefix is always inserted as the first field in the subject line. We recommend not changing that position.
- The Slot Alias is generally used over Alarm Alias in the email subject. However, if you have created an alarm for each page of your measurement and have named it accordingly, you might want to replace Slot Alias with an appropriately named Alarm Alias . You can also use the Custom Text field for this purpose.
- Setting up your email subject to deliver important information is more helpful than the information in the email body.
Fields available for insertion into the email body are described below. Check the box next to a field to select it. The Sample body content displays examples of selected fields. Hover over a field name to see the corresponding value highlighted in the sample email body.
You can select and move the items in the sample body to change the order in which they appear.
|Date/Time||Inserts the day and time of alert generation (i.e., the date and time the alarm was triggered) into the body of the alert.|
|Slot Alias||Inserts the measurement name into the body of the alert.|
|URL||Inserts the initial URL navigated to into the alert body.|
|Alarm Alias||Inserts the alias or alarm name into the alert body.|
|Performance/Availability Values||Inserts whether the alert is for performance (and its component) or availability and the triggering value into the body of the alert.|
|Top Three Errors||Lists the three most frequent error types triggered (with a count) into the body of an availability alert. The errors are also broken down by the page on which they appear. The number of content errors is also listed.|
|Three Slowest Agents||Lists the three slowest agents into the body of a performance alert.|
|Link to Alarm Data||Inserts a link to view the alarm graph, a scatter plot containing the data triggering the alarm. This is the data in the look back period or the number of data points defined in the General Options section of alarm configuration.|
|Base Page Detail||For alarms based on individual pages of a measurement (see the General Optionssection of alarm settings), displays the base page URL and IP address in the body of the alert.|
|Custom Text||When configuring an alarm, you can specify custom information to appear in the body of alerts. A maximum of 512 characters is allowed in this field.|
Creating email groups
Administrators can create an email group in MyKeynote that can be used to send alerts. Alarm recipients, including individual addresses and email groups, are specified in alarm settings.
To create an email group:
Select the menu > Settings > Email Group .
Click Add New Group .
- Enter a Name for the email group.
Add individual addresses to the group by typing the address and clicking Add Member . Added addresses are listed below.
- Optionally, you can Share this email group with the Company if you want to make it available to all users in your account.
- Save your changes.