May 5, 2010

Surround SCM Email Notifications

Surround SCM
I worked on the C# API, which is really a wrapper for the C API, For the Surround SCM 2010.0 release. If you've ever written a wrapper or any type of "code layer" you know how important it is to keep up with changes made to the base layer. Surround SCM has a feature called "Email Notifications" that allows you to do just that. As you may have guessed, an email notification is just an email that is sent to you when a specified action takes place. Going back to my work on the C# API, to keep up with changes to the C API I set up an email notification to alert me anytime another user performed a change to a file in the API repository. Email notifications are easy to set up. Just login to your Surround SCM GUI client and open the "Email Notifications" dialog (Tools -> My Email Notifications...). This dialog includes all of your current email notifications. Tto create a new one, click the "Add" button. The first tab in the Add My Email Notification dialog is "Pre-Conditions". Select the conditions that the files must meet in order for the email to be sent (e.g., branch and repository, filename, workflow state, user performing action, etc). Next, click the "Trigger When" tab. This tab contains filtering options related to the event that caused the notification (see screenshot). Select the event you want to trigger the notification. Finally, to specify the template used to create the notification click the "Edit Email Template..." button. Once you've got your notification configured click "OK" to save it. [caption id="attachment_2211" align="aligncenter" width="309" caption="Add Email Notification Dialog"]Dialog for creating a Surround SCM email notification[/caption]

Here are just a few ideas for using email notifications:

  • Owner Code Review - If you're in the habit of reviewing changes made to files you own, an email notification can help keep you from falling behind.
  • IDE Project Changes - Another user has just added a new file to the IDE project and checked it into Surround SCM.
  • Common Code - Your team shares code with another team, when the other team makes changes to a common source file it might be a good idea to take a quick look at the changes.
  • Workflow Change - If a file's workflow state is changed and requires action on your part.