Notification Templates

For sending any notifications, SapphireIMS provides default templates for the notifications for both E-mail and SMS notifications where applicable. These templates are active by default. You can also configure your own template. This section describes the template types.

Addition and Deletion of templates

To add a new template, click the 'Settings' tab. In the 'Fault and Notifications' section, click 'Notification Templates'.

Click ‘Add’ to add a new template. The following screen is displayed

The fields which are common across all templates are described below.

Serial No	Field Name	Description
1	Template Name	Enter a unique name for the template
2	Description	Enter the description of the template
3	Notification Category	Select any one of the categories from which this template will be inherited. The table below lists the categories and its use.
4	Email Subject	Enter the text (including macros as needed) for the Email subject line
5	Email Body	Enter the text (including macros as needed) for the Email body
6	SMS Template	Enter the text (including macros as needed) for the text of the SMS
7	Tabular Data	This field is present only for Log Analyzer notifications. You can select the fields to be included in the notification in a tabular format which will be helpful in analysis of the log information.

The various categories of templates are as follows. Support for E-mail and SMS notification is also marked as Yes or No.

Serial No	Category	Description	E-Mail	SMS
1	Alerts	Used for alert notifications on occurrence of Fault Alarms and on reset of Alarms	Yes	Yes
2	Automation Job Notification	Used for notifications on successful completion of automation jobs	Yes	Yes
3	Job Status	Used for notification on successful completion of tasks	Yes	Yes
4	Dynamic Threshold Notification	Used for notifications when Dynamic Thresholds are breached	Yes	No
5	Escalations	Used for Service Desk escalation notification	No	Yes
6	General Notification	Used for Generic Notifications	No	Yes
7	LDAP User Notification	Used for notifications of status change of LDAP users	Yes	No
8	Log Analyzer Notification	Used for notifications pertaining to Syslog, Event Logs, Netflow, SNMP Traps and Application Logs	Yes	No
9	Product Health Notification	Notifications in case of failure of product	Yes	No
10	Replication Notification	Notification in case of replication failures and recovery	Yes	No
11	Software Metering Notification	Notification on unused software	Yes	No

You can use Macros in the Email subject, Email body and SMS text. The Macros will be substituted with actual values while the message is getting generated. To add macros, right click on the text area in these fields. A pop-up appears with the list of available macros for that notification message (the macros vary according to the template category). A sample macro list for alerts is shown below.

Select a macro and it will get inserted in the text box surrounded by $$ symbol. As an example the settings for the Alert notification is shown

To delete a template, select a template in the list and click on 'Delete'.

Activating and Deactivating Templates

To deactivate a template, select the template and click ‘Deactivate’
To activate a template, select the template and click ‘Activate’

Note: Only one template in each category can be active at a time. At the time of notification generation, the active template is used. If no templates are defined, the default templates shipped with SapphireIMS are used.