There are a number of config options for the TFS Event Handler Prototype. I will describe all of them in depth here. The first step is to set the Windows Communication Foundation service options, which really only requires you to change one value.
The important one is the
[LocalMacheneName] variable, which should be set to the local machine name, or the domain name that points to your computer if you have a crazy proxy.
The next step is to set the real options for this software. This starts with the
<RDdotNet.TeamFoundation> options, and requires you to set a number of things.
<BaseAddress url="http://[LocalMacheneName]:3624/" />
Again, you need to set the machine name, but make sure that the port is different.
<TeamServer name="[TFS Server Name]"
url="http://[TFS Server Name]:8080/"
subscriber="[Subscriber AD Account]"
mailAddressFrom="[From Email Address]"
mailServer="[email relay server]"
testEmail="[email to send testes to]"
In the Team Servers section, you need to list of all of the team servers that you are going to be handling events for. The system will automatically add event subscriptions for all Team Servers added here, but I have only tested with two, and I now always run the service on the TFS server.
|This should be a friendly name for the Team Foundation Server|
|The URI for the TFS you wish to connect to, including protocol and port|
|The address from which you want all emails sent by the system to say that they are sent|
|The display name of the from email address|
|The mail server that you have permission for to send emails|
|A true or false value that enables logging of all events within that system; excellent for debugging...|
|When in test mode, all emails sent by the system will only be sent to the email address defined by |
testEmail; set to false for production
|The email address that, when |
testMode is enabled, will receive all emails sent from the system
|The location that the event logs will be written to; all events received get assigned a |
System.Guid, and all logs pertaining to that event get saved in the corresponding folder
|The AD account name of the account that is writing the events; set to the name of your |
Now you are ready to set the event handlers. These are defined within the "
Now you need to add handlers for the events. Example:
As you can see, you are theoretically allowed to use any event. Please keep in mind that only the
WorkItemChangedEvent and the
CheckInEvent have been tested. When you add the "
Event" tag with the corresponding
eventType (which is an enumerator), this tells the system which specific events to subscribe to.
You can then add handlers to an event. These handlers are fired whenever these events are received.
|Enumerator that defines the list of possible events.|
|This must be a valid type in the assembly listed in |
|This must be a valid assembly found in the |
|A location within the server's file system that holds this assembly; ~ denotes the application's root|
If you are using friendly server names or TeamPlain, you can change the TFS server links to be TeamPlain ones using the
UrlReplacements config element:
This works by replacing values within the URL in the events. You specify the event type, what to look for, and what to replace it by. This allows greater control and the integration of TeamPlain into your world. If a task is assigned to someone outside of your departmental sphere who you have given permission to TFS but who knows nothing about it, they will still get an email that will link them through to TeamPlain.
And, that is it, you are all set. If you have installed the service and set the account that is used to run the service, you should get no errors when starting. No guarantees though :)