5.1.2.5. Erosion Notification System

The Axivion Dashboard Server is able to send Erosion Notification Emails upon added or removed issues after a new analysis run is complete.

This feature must first be enabled and configured on the General Settings page.

See here on a user perspective on how to make use of Erosion Notification Mails.

Administrators can disable the Dashboard-integrated erosion notifications on a per-project basis on the Projects Configuration Page.

Note

The Erosion Notification System is designed to give users control over which emails they receive through configurable settings. If you, however, want to enforce specific notification policies without user control, we recommend using a custom solution instead of the Dashboard Erosion Notification System—see this example for guidance.

Erosion Notification Templates

You can customize the Erosion Notification emails sent by the Dashboard to inform users of added or removed issues via templates.

The Axivion Suite ships with two default templates inside the folder mailtemplates inside your global config-folder. As for all configuration inside this folder you should not change it but instead copy it to the same location inside your dashboard’s config folder and modify it there. The Dashboard Erosion Notification System will fall back to the global config files so only copy the files you actually plan to modify.

There are two template files, erosionmail.txt and erosionmail.html. As you can see by their extension they serve to generate text or HTML emails depending on the preferences of each user.

Inside both templates you can put whatever content you want, but be sure to always include the string “${details}” which will be replaced by the actual, user-configurable content.

For your reference here is the complete list of variables you can use:

realname

the notified user’s full name

address

the notified user’s email address

username

the notified user’s login name

projectname

the name of the project to send notifications for

details

the detailed content of the notification

time

the time the email is generated

starttime

the time of the version diffed against

endtime

the time of the current version

startname

the name of the version diffed against

endname

the name of the current version

dashboardurl

the url of the dashboard sending the notification

notification_settings_url

URL to the user’s notification settings page

bauhaus_version_name

Name of the current version of the Axivion Suite

Inside HTML templates you have the ability to include “<img>” tags with the “src” attribute naming an image file relative to the template itself. Such files will be embedded into the email and the “src” attribute will be changed to refer to the embedded image.

Be sure to change the template HTML cautiously as email clients tend to be picky about what HTML they accept.