5.1.2.5. Erosion Notification System

The Axivion Dashboard Server can send erosion notification emails when issues are added or removed after a new analysis run is complete.

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

See here for a user’s perspective on how to use erosion notification emails.

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 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 use templates to customize the Erosion Notification emails sent by the dashboard to inform users of added or removed issues.

The Axivion Suite ships with two default templates in the mailtemplates folder within your global config folder. As with all configuration inside this folder, you should not modify the files directly; instead, copy them to the same location inside your dashboard’s config folder and modify them there. The Dashboard Erosion Notification System falls 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. Based on their extensions, these files generate text or HTML emails depending on the preferences of each user.

You can include any content you want in both templates, but ensure you 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 for which notifications are sent

details

The detailed content of the notification

time

The time the email is generated

startname

The name of the version being compared 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

In HTML templates, you can include <img> tags with a “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.

Modify the template HTML cautiously, as email clients tend to be restrictive about the HTML they accept.