The E-Mail event response creates an electronic mail message documenting the occurrence of an event. The e-mail body text contains the name of the resource that generated the event, event sequence numbers, date and time stamp, and the event string. It may contain user-supplied messages to the recipient.
The figure below is the E-Mail Definition dialog.
Refer to Using Vantage Dialogs to learn about Vantage dialogs. Each control on the dialog is explained in the text that follows.
Send To:
Use this control to enter the e-mail addresses of those who are to receive the Vantage E-Mail report. Text is limited to one line of 256 characters. Click the control and type the addresses.
Send CC:
Use this control to enter the e-mail addresses of those who are to receive the Vantage E-Mail report. Text is limited to one line of 256 characters. Click the control and type the addresses.
Profile File Name:
Use this control to enter the name of the profile file that is to be used to further define the nature of the E-Mail event report. These files are always found in the subdirectory /opt/vantage/email/profiles.
Console output controls:
Every e-mail message contains some of the text that was received from the monitored resource. This control allows the user to specify the extent of that text. If the first box is unchecked then the console context that is sent along in the body of the e-mail report is the same data that is sent to a Message event, or as $3 to an API Exec event.
If more specific data is needed the range of data to be sent in the e-mail report can be specified in this box. The resource must be in the process of logging data when the event occurs or there will be no source for the information to be drawn from.
A profile file allows the modification of the E-Mail event report. The file is simply a text file that can be created and modified with your favorite text editor. In a profile file there are tags that are followed by an equals sign (=), then data followed by an end-of-line. The following is a list of tags that may be used in the /opt/vantage/email/profiles profile files.
BCC= Append the name(s) on this line to the blind carbon copy list.
CC= Append name(s) on this line to the carbon copy list.
SUBJECT= Change the text of the subject to the text on this line.
TEXT= Place the text on this line into the body of the mail.
TEXTFILE= Place the text in this file into the body of the mail. All text files are found in STATIC/email/text
TO= Append name(s) on this line to the 'send to' list.
Profile File Example
The file is processed in order, so the following example results in the following output -
TEXT= first line
TEXT=Second line
TEXTFILE=mary
TEXT=last line
first line
Second line
Mary had a little lamb.
Its fleece was white as snow.
last line
Click OK when all controls are as desired. Click the Add button on the Event Definition dialog to add the event.
You must Distribute Events when finished adding or modifying an event for the new event to be detected.
See also Operating Vantage
