Logging Notification Email

Reference Number: AA-00610 Views: 4535 Last Updated: 04-23-2013 11:17 AM 0 Rating/ Voters

SiteAudit can be configured to log notification email to the file system.  This is a great aide to help determine which email notifications were sent by SiteAudit.  


The SiteAudit On-Site Viewer and Hosted Client contain Application Settings under the Tools menu where users can enable logging of notifications generated by SiteAudit.  This is a great troubleshooting aide as it allows users to see a copy of all notification email generated by SiteAudit.  This allows users to confirm that SiteAudit is generating expected emails. The Debug_LogNotificationEmail application setting should be enabled to confirm SiteAudit is generating the expected notification email.  Quite often, failure to deliver email is due to issues with the mail server or recipient email addresses.  When problems with the mail server or email addresses are detected, an error event is written to the Netaphor Event Log that will help to identify the issue.  If the problem cannot be determined, enable logging of the notification email to confirm that SiteAudit is generating the expected email.

How to Log Notification Email

To allow SiteAudit to log notification email to the local file system where the monitoring service runs, one must set the value of Debug_LogNotificationEmail to true.  

  1. Select Tools > Application Settings
  2. Select the Monitoring tab
  3. Locate the Debug_LogNotificationEmail setting and change its value to True
  4. Click OK to close the Settings dialog
  5. Restart the monitoring service

Logged Email Notifications

When Debug_LogNotificationEmail is enabled, SiteAudit logs a copy of each email it sends in its raw format to a folder named, notification_logs.  This folder is located in the application data folder.  For Vista and later operating systems, this folder can be found at C:\ProgramData\Netaphor\SiteAudit and for Windows 2003 and XP, C:\Documents and Settings\All Users\Application Data\Netaphor\SiteAudit

Notification File Names

Emails logged to the file system are named by date and time.


Notification Log File Content

Notification email sent from SiteAudit typically have a stylesheet applied to them to format the appearance of the email.  The notification email logged to the file system are in a raw XML format as shown below.  If Custom Fields have been added to SiteAudit, these will appear in the notification email as well.

The logged notification file contains information about the mail server in the first four lines.  If email is not being delivered to recipients, it may be the case that the mail server is inaccessible or perhaps the access credentials have expired.

The raw email data contain information about the incident that has occurred and the printer on which it occurred.  For example, the printer IP address, DNS name, location, etc. are present in the notification as well as information about the incident such as, its description, severity, when the incident occurred, how long the incident has been in effect, etc.

Two other data items included in the notification are the Urgent flag, that indicates the notification is the result of an expedite when the value is true.  It is possible to be notified when an incident is resolved.  If the Resolved  value is true, then the notification is intended to notify that an issue has been resolved.

Note that if any custom fields have been created, they are also included in all alert notifications.  Note that custom field information will not be included in the rendered HTML notifications by default. These can be added by customizing the SiteAuditAlertNotification.xsl stylesheet.  To learn how to add custom fields to your HTML rendered notification, refer to the Custom Fields article