SiteScope Reference Guide

An important part of effectively managing your network infrastructure is having access to accurate, up-to-date, and specific information about the condition of systems and servers. You use SiteScope alerts to send notification of system faults and errors when they are detected. You can customize SiteScope alert templates to meet specific requirements of your organization.

This chapter describes:

• About Alert Templates
• Alert Template Groups
• Other Template Groups

SiteScope uses templates when generating alert messages and reports. In most case you select the template you want to use in the Define Alert form when you create an alert. You can customize the existing templates or create your own by making a copy of an existing template. You customize the alert templates by adding or removing text, by adding property variables as listed in the tempprops00Template Properties section, or changing the order of text or property variables that are included in the template.

---

Note:   It is recommended that you create custom alert templates using new filenames. If you modify one of the default templates provided with SiteScope and save the changes to the same file, the changes that you make may be lost if you reinstall SiteScope or upgrade the SiteScope installation.

---

To make a custom alert template available to SiteScope, you must save any customized alert templates into the directory containing the templates for the applicable alert type. The following is a list of the directory names containing SiteScope alert templates you can copy and customize.

Template Files

The templates in these groups are text files which include property variable markers. You use a text editor to create or modify these templates. The new templates saved into the directories shown will become available to the applicable alert on the Define Alert form.

The following is an example of the default template used for the E-mail Alert. The names that appear within <brackets> are property variable markers. When the alert is generated, SiteScope replaces these markers with the corresponding values of the variable for the monitor or monitor group that has triggered the alert.

This alert is from SiteScope at <sitescopeURL> Monitor: <groupID>:<name> Group: <group> Status: <state> Sample #: <sample> Time: <time> ---------------------- Detail ---------------------- <mainParameters> <mainStateProperties>

you add or edit the text portions of the template. For example, you could change the first line of the template above to read:

A Web monitoring alert was generated by the SiteScope installation found at <sitescopeURL>

To change the text content of alert messages

1. Open a text editor that has access to the alert template directories on the SiteScope machine.

2. Open one of the existing template files in the template directory of the alert type you want to customize. For example, to customize a alert template for use with E-mail alerts, select a template file in the <SiteScope install path> /SiteScope /templates.mail directory.

3. Make changes to the template. Depending on the alert type, you can add or remove text, change the order of text or property variables, or add other property variables.

   To add specific monitor results or monitor configuration properties, add the applicable property variable name between < > bracket pairs to the template. The tempprops00Template Properties section contains lists of the available properties for different monitor types. For example, to add the percentage of a disk drive that is full for an alert used for Disk Space monitors, add the property variable <percentFull> to the template.

4. Save the changes to a unique filename within the directory for the applicable alert type.

You can customize Sound alerts by adding your own audio files for SiteScope Sound alerts, the files must be of the *.au format.

The following table shows other template types used by the SiteScope application. The templates in these directories are not used by alerts.

---

Note:   You should not modify the templates in these directories without specific procedures provided in the product documentation or as instructed by Customer Support.

---

Reserved Templates

Copyright 2004 Mercury Interactive Corporation.
All rights reserved.

Documentation comments or suggestions?
Please send feedback to documentation@mercury.com