tip This documentation is for the old interface of AlertSite. If you use the new interface (AlertSite UXM), see Alert Templates.

Notification Message Templates

You can customize the contents of email and AIM alerts by changing the templates used to format the messages. You can also create multiple templates for the same alert type and assign different templates to different notifier groups.

Message Types

You can change the templates for these message types:

  • Site Error – an availability error like timeout, missing keyword or HTTP error.
  • Site Error Clear – the error condition stopped.
  • Server Error – A ServerAgent alert.
  • Server Error Clear – ServerAgent error condition stopped.
  • Website Change – Web Site devices with the Notify on Content Change option send this message when your HTML page size changes.
  • Traceroute – Sent on TCP connect (status 1) and timeout errors (status 2, 4050, 4059) if the TCP Traceroute on Network Error option is selected.
  • SSL Certificate Expiration – Secure Web Site devices with the Report Expired SSL Certificates option send this message when your site's SSL certificate is about to expire or has expired.

There are separate templates for different notification methods. For example, you can customize the templates for Site Error via E-mail (HTML format) and Site Error via AIM individually.

Viewing Notification Templates

To view and manage notification templates, click Notifiers in the top menu, then click Manage Notification Templates.

Accessing the alert template manager

On the management screen, select the message type to see all existing templates for that message. Select a template to view its contents.

Viewing templates

Default Template

You can have several templates for the same message type, with different templates used in different notifier groups. The default template is marked "*" in the template list. The default template is used for all alerts, unless changed for individual notifier groups.

To use a custom template as a default, edit this template and select the Default check box.

Template Format

A template consists of a subject and an optional body. Subject and body can include variables – they begin with the $ character. When an alert is sent, variables are replaced with the corresponding values. For example the variable $LOCATION would be replaced with the name of the location where the alert occurred. Click VIEW available variables to view all variables (name, description and type) that can be used in the selected template.

Template contents

Templates Variables

There are 3 types of template variables:

  • Simple
  • Template
  • Template Array

Simple variables are replaced with the value of that variable when the message is generated. The variable $LOCATION in the Site Error via E-mail (text format) message is an example of a simple variable. This variable is replaced with the name of the location where the alert condition occurred when the message is generated.

Template variables are replaced with the contents of the named template when the message is generated. The variable $TXNINFO in the Site Error via E-mail (text format) message is an example of a template variable. This variable is replaced with the contents of the $TXNINFO template when the message is generated.

Template array variables generate multiple rows containing the named template. The $RRDETAIL_ROWS variable in the Site Error via E-mail (text format) message is an example of a template array variable. This variable is replaced with one of the contents of the $RRDETAIL_ROWS template for each Round-Robin location.

Managing Templates

To create a template

You can create new templates based on existing templates:

  • On the template management screen, select the Message Type.
  • Select a Template to use as a base for your new template.
  • Edit the template subject, body and other elements.
  • Enter the Template Name.
  • (Optional.) To use the new template as default for the selected message type, select the Default check box.
  • Click Save As in the top right.

Now you can assign the created template to your notifier groups (see below).

Note that you can create multiple templates for the same message type and use them with different notifier groups.

To edit a template

Select the Message Type and the Template you want to edit, then change the template text. Once ready, click Save to overwrite the current template or Save As to save it as a new template.

Note: You cannot change the built-in templates – those named AlertSite System Template.

To send a sample alert

Select a template and click Test Sample Alert. You will see the formatted version of the selected template. To email this sample message, enter an email address and click Send Message.

To delete a template

Select a template and click Delete. Any notifier groups that used this template will be switched to the default template.

Assigning Templates to Notifier Groups

  • From the top menu, select Notifiers > Notifier Groups.
  • To create a new recipient group, click Add a New Group. Select one or more devices and the notifiers who will receive alerts from these devices.
    –- or –-
    To edit an existing group, click the group name.

    Edit a notifier group

  • Scroll down to the bottom.
  • Select the templates for this notifier group. Move the needed templates from the Available list to the Included list by clicking <<.
    You can select one template for each message type. For example: one template for Site Error via Text, one template for Site Error via AIM, one template for Site Clear, and so on.

    Templates used by a notifier group

  • Click Submit to save the changes.

Email and AIM notifiers in this group will now receive customized alerts based on the selected templates.

Back to top
Back to index

© 2016 SmartBear Software --
Syndicate this site RSSATOM