Alert Templates

AlertSite Enterprise plan customers can customize the contents of email, JSON and AIM (AOL Instant Message) alerts by changing the templates used to format alerts. It is also possible to create multiple templates for the same alert type and assign different templates to different recipient groups.

To access the template editor, select Alerts > Template Editor from the top menu. The editor shows a list of all available templates, with a preview of the template you selected. Click the preview to switch to the edit mode.

Alert Template Editor

In This Topic

Supported Alert Types

You can change the templates for these message types:

 

There are separate templates for different alert delivery methods:

 

You can customize the templates for different combinations of alert types and delivery methods separately.

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, $DESCRIP is replaced with the monitor name, $STATUS – with the AlertSite status code. When editing a template, click Variables to see all variables available for this template.

Alert template format

Monitor-Specific Alert Notes

Monitors can have user-defined notes specific to each monitor, for example: “This transaction uses account: user/p@ssw0rd”. You can add these notes on the Alerting tab in the monitor configuration.

These notes can be included in email error alerts by adding the $ALERT_NOTE variable to your templates. Note that default templates do not include this variable. You need to configure custom email templates if you want email alerts to include monitor-specific notes.

Default Template

You can have several templates for each alert type and delivery type, and use them for different recipient groups. The default template is marked in the template list. This template is used for all alerts unless changed for individual recipient groups. You can change which template is used by default as explained below.

Default template

Managing Templates

To create a template

You can create new templates based on existing templates:

  1. In the Template Editor, select a template to use as a base for your new template. The base template should be for the same error type and delivery method as you need.

    Tip: Filter the template list to find base templates faster.

    Selecting a base template for the new template

  2. Change the template subject and body as needed.
  3. (Optional.) To use the new template as default, click the icon so that it becomes blue . The default template is used for all alerts of this type and delivery method, unless changed for individual recipient groups.

    Make default template

  4. Click Save As and enter a name for your new template.
  5. Click Save.

Now you can assign the new template to your recipient groups (see below).

To edit a template

To edit a template, select the template and then click its contents. Once ready, click Save to overwrite the current template or Save As to save it as a new template.

Note: AlertSite system templates are read-only and cannot be changed.

To change the default template

To use a custom template as default:

To restore a system template as default:

To send a test alert

You can test the templates by sending a test alert to an email address:

To delete a template

In the template editor, select a custom template, then click Delete in the top right.

Note: You cannot delete AlertSite system templates.

Assigning Templates to Recipient Groups

  1. Go to Alerts > Recipient Groups.
  2. To create a group, click + New Recipient Group and select the monitors and recipients to group.

    – or –

    To edit an existing group, click that group.

  3. Under Custom Templates, click the Add/Edit link.
  4. All custom templates that exist in your AlertSite account are grouped into categories, such as Site Error HTML or Site Clear Text/AIM. The category names reflect the notification type (error or “all clear”) and alerting method (HTML email, text email, JSON POST request, or AIM).

  5. To select a template, expand its category by clicking , then select the radio box next to the template name.

    You can select one template in each category. For example, one template for Site Error HTML and one template for Site Clear HTML.

    Alert templates used for a recipient group

    Note: The selected templates must match the notification methods used by the alert recipients in this group, otherwise AlertSite will use the default templates.

  6. Click Save changes.

Email, AIM and JSON POST recipients in this group will now receive customized alerts based on the selected templates.

See Also

© 2017 SmartBear Software. All rights reserved.      Terms of Use · Privacy Policy