Compass Version 1.3

Email Notification Settings

The Compass Email Notificationis set up on a per project basis. After the initial version 1.0 of Compass was released with the Email notification set up on a per build plan basis it was determined that in nearly every case the email notification was the same for all build plans in a given project. Therefore, in Compass version 1.1 the email notification parameters were moved to the project details page with the assumption that in the rare case where different individuals should receive different email notifications inside of the same project that those individuals could set up email filters in their email clients.

The Email Notification section in the project page looks like this:

As you can see at the bottom of the dialog, there are two email lists that can be set up. One email list for when all builds complete regardless of their completion status. As well as a second email list for when builds fail. The rest of the parameters in this dialog tell Compass how to send the messages. Compass uses the SMTP mail client embedded in python to send it's email but it still requires an SMTP server to connect to, to distribute the message. The follow options are all of the options in the Email Notification section on the Compass Project Details page.

The options in the email notification are:

Email Notification Option	Description
SMTP Server address	This is the server and optionally port number to send the message through (ie: localhost:25)
Sender Name	This is the email address on the SMTP server to use to send the notification messages.
Requires Password checkbox	If the email address/user requires a password to send email on the SMTP server then check this box.
Password	Is the password for the specified sender above.
Email Address for all builds	This is a list of email addresses to send an email notification any time a build plan completes for this project. The list is separated by commas. Anx Labs recommends setting up an email list via your organization's exchange or mailman server so that users can subscribe themselves to the list. This email list can then be used as the single email address for this option.
Email Addresses for failed builds	This is a list of email addresses to send an email notification any time a build plan fails for this project. The list is separated by commas. Anx labs recommends setting up an email list via your organization's exchange or mailman server so that users can subscribe themselves to the list. This email list can then be used as a single email address for this option.

The email notification that is sent is defined by Compass and is currently not a configurable parameter. All notifications have the same email format. The message that is sent has the subject line:

[ <status> ] Compass build report [id: <build number>]

and a message body of:

Compass completed build <build plan name>
Result: <status>