Action: Send an Email

From WebWatchBotWiki
Jump to: navigation, search
 Share 

Description

The Email Tab specifies the email addresses and additional actions to perform.

alarm_send_email.gif

Fields And Buttons

Email Addresses

Enter one or more, separated by a comma (,), semicolon (;), or pipe (|)

  • By default, there are no email addresses entered.
  • If active, an email will be sent to the specified email addresses when an alarm is triggered and when it is automatically reset.
  • An email is not sent if the alarm is manually reset.
  • (Enterprise and Trial versions only) Contacts can be entered in this field or selected by clicking on the "[EmailSettingsContacts.html Add Contacts]" button.
  • (Enterprise and Trial versions only) Contact users can be entered with enclosing less than & greater than signs (<>) and contact groups can be entered with enclosing braces ([ ]). For example: <username>, and [groupname]

Active (Un-checking this box will prevent email from being sent to the above addresses)

  • By default, this option is not checked/active.
  • Checking this option will cause emails to be sent to the specified email addresses when an alarm is triggered.

Subject

  • The message subject that can be modified for each individual Watch Item.
  • Replacement tokens are provided for subject customization. WebWatchBot will automatically replace the tokens with the appropriate value when the email alert is created. Tokens include:
    • <%Date%>
    • <%Time%>
    • <%DateTime24h%> - 24 hour time, e.g. 13:00 instead of 1 PM
    • <%Time24h%> - 24 hour time, e.g. 13:00 instead of 1 PM
    • <%MachineName%>
    • <%WatchItemName%>
    • <%AlarmCondition%> - one of two values: "UP" or "DOWN"

Additional Message Text

  • Additional message text in addition to the normal email message text.
  • Additional message text is placed after the email message header as defined in the template.

Send With Email

  • Send Output
    • The downloaded page will be sent in the email when an alarm is triggered and automatically reset.
    • An email is not sent if the alarm is manually reset.
    • Page downloaded cannot be sent with Small Text Messages.
  • Run and Send selected Report
    • The specified report is run and attached to the email when an alarm is triggered and automatically reset.
    • Add - A report can be added when this button is clicked.
    • Edit - An existing report can be edited when this button is clicked.
    • Reports cannot be sent with Small Text Messages.


Email Message Template

There are three email templates for email customization and are located in the resource sub-directory below the WebWatchBot installation directory.

Each message type has a corresponding template file: template_alert_html.html, template_alert_plain.txt, and template_alert_sms.txt.

The html template file references a Cascading Style Sheet (CSS) named "alert.css".

Both the template file and the CSS file can be modified and customized.

The template file contains the following tokens that are replaced when the email message is generated:

  • <%bgcolor%> - Internally replaced by a color dictated by the alarm condition or status.
  • <%PageHeading%> - Internally replaced.
  • <%Content%> - Internally replaced.
  • <%ExtraText%> - Replaced with the text entered in the field "Additional Message Text"
  • <%DownloadedPage%> - Internally replaced if the option "Send Output" is checked with the last output of the last run for the Watch Item.

Please note: Removal of any of the tokens will prevent substitutions, but will not cause an error. Moving, restructuring, or duplicating of tokens while possible may create a malformed email message.