TFSEventHandler Wiki & Documentation Rss Feed

TFS Event Handler News Feed

.NET Service Manager

Wednesday, August 06, 2008 | From TFS Event Handler

Hosted Sticky Buddy

Monday, August 04, 2008 | From TFS Event Handler

Error creating listener in Team Build

Friday, July 04, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

TFS Event Handler News Feed

Updated Wiki: Home

hinshelmw — Mon, 04 Aug 2008 10:57:51 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

The Team Foundation Server Event Handler is an system by which users can easily write event handlers and get them actioned when TFS fires events. The TFS Event Handler Service is a server application that attaches onto the soap events that are fired from Team Foundation Server's eventing service. The TFS Event Handler Service has two parts: The Queuer which handles the TFS events and then relays those messages over a MSMQ WCF service to the EventHandler service that loads all avilable user built Event Handlers and runs the events against the appropriate handlers.

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...
2008-05-30 - Renaming to Production version
2008-05-30 - Addition of Heat integration Handler

Common Tasks

v2.0 (CTP) (Proposed Release)

The v2 product will build on v1 and provide better GUI interaction with the handler system as well as increased debug capability against it.

News

Error creating listener in Team Build

TFS Event Handler News Feed

Friday, July 04, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

TFS Event Handler News Feed

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 13:23:37 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...
2008-05-30 - Renaming to Production version
2008-05-30 - Addition of Heat integration Handler

Common Tasks

v2.0 (CTP) (Proposed Release)

The v2 product will build on v1 and provide better GUI interaction with the handler system as well as increased debug capability against it.

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: TFS Event Handler v1.0

hinshelmw — Fri, 30 May 2008 11:11:12 GMT

TFS Event Handler

The TFS Event Handler consists of a server application that hosts the TFS Event Notification Service and the TFS Event Handlers. When a Work Item in Team Foundation Server is changes an SOAP event is fired that is picked up by the TFS Event Handler Server through the TFS Event Notification Service which then call all of the TFS Event Handlers that are currently loaded.

TFS Event Handler Server

TFS Event Handler Server v1.0 - Installation and Configuration

TFS Event Handlers

Assigned To - Send an email to a user who is assigned an email unless they are the one that assigned it to themselves.
Notify Creator - Sends an email to the Owner of a Work Item when it is changed unless they are the one that changed it
Re-Assigned - Send an email to a user when a work item that they are assigned is re assigend to someone else unless they are the one that made the change.
Heat Journal Update - Updates a Heat Journal Entry with the duration of work and a not with a link to the TFS Artifact

Related Releases

Release v1.0

Related Pages

UPDATED WIKI: TFS Event Handler Server v1.0

hinshelmw — Fri, 30 May 2008 10:22:09 GMT

TFS Event Handler Server v1.0 : Release v1.0

Installation
Upgrading
Configuration

Installation

The installation is fairly simple. Just run the exe. This will create a service on your local computer and all the appropriate files in the correct folders.

You will not be able to start the service before you have configured it!

Upgrading

If you are upgrading the TFS Event Handler Server to the latest version make sure that you make a copy of the .config file so you don't have to write it again. And make sure that you stop the service first or you may need to restart.

Configuration

You will need to configure the application to work with your team server. This has a number of steps:

Change the account that the service runns under

To allow the service to run correctly it must have permission to perform certain operation on your Team Foundation Server. To this end you need to set the account that the service runs under to TFSService or TFSSetup. I have used TFSSetup for all my tests.
You can do this by locating the service in the Service Manager and right clicking on it, selecting "properties" nad viewing the "Log On" tab. You should then set the account to an existing account with the desiered permissions for TFS.

Edit the application.config file to suit your needs

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 WCF service options, which really only requires you to change one value.

<system.serviceModel>
        <services>
            <service name="RDdotNet.TeamFoundation.NotificationService">
                <endpoint address="http://[LocalMacheneName]:8677" binding="basicHttpBinding"
                    bindingConfiguration="" contract="RDdotNet.TeamFoundation.INotificationService" />
            </service>
        </services>
    </system.serviceModel>

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.

<TeamServers>
            <TeamServer name="[TFS Server Name]"
                        url="http://[TFS Server Name]:8080/"
                        subscriber="[Subscriber AD Account]"
                        mailAddressFrom="[From Email Address]"
                        mailFromName="[Form name]"
                        mailServer="[email relay server]"
                        logEvents="True"
                        testMode="True"
                        testEmail="[email to send testes to]"
                        eventLogPath="C:\temp\TFSEventHandler\">
            </TeamServer>
        </TeamServers>

In the Team Servers section you need to list all of the team servers that you are going to be handling events for. The system will automatically add the 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.

TeamServer Options

Name	Type	Description
name	System.String	This should be a friendly name for the team foundation server
url	System.Uri	The URI for the TFS server you wish to connect to including protocol and port.
mailFromAddress	System.String	The address from which you want all emails sent by the system to say that they are sent.
mailFromName	System.String	The display name of the from email address
mailServer	System.String	The mail server that you have permission for to send emails
logEvents	System.Boolean	A true or false value that enables logging of all events within that system. Excellent for debugging...
testMode	System.Boolean	When in test mode all emails sent by the system will only be sent to email address defined by testEmail. Set to false for production.
testEmail	System.String	The email address that, when testMode is enabled will receive all emails sent from the system.
eventLogPath	System.String	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.
subscriber	System.String	The AD account name of the account that is writing the events. Set to the name of your TFSSetup or TFSService accounts.

Now you are ready to set the event handlers. These are defined within the "Events" section:

<Events>
            <!-- 
                        Use one of the following events:
                                        AclChangedEven
                                        Branchmovedevent
                                        BuildCompletionEvent
                                        BuildStatusChangeEvent
                                        CommonStructureChangedEvent
                                        DataChangedEvent
                                        IdentityChangedEvent
                                        IdentityCreatedEvent
                                        IdentityDeletedEvent
                                        MembershipChangedEvent
                                        WorkItemChangedEvent)
                        Then you need to add handlers for the events.
                                          
                   Example:
                           <Event eventType="WorkItemChangedEvent">
                                <Handlers>
                                    <Handler type="RDdotNet.TeamFoundation.WorkItemTracking.AssignedToHandler"
                                             assemblyFileName="RDdotNet.TeamFoundation.WorkItemTracking.AssignedTo.dll"
                                             assemblyFileLocation="~\EventHandlers\WorkItemTracking\">
                                    </Handler>
                                </Handlers>
                            </Event>
                    -->
            <Event eventType="WorkItemChangedEvent">
                <Handlers>
                    <Handler type="RDdotNet.TeamFoundation.WorkItemTracking.AssignedToHandler"
                             assemblyFileName="RDdotNet.TeamFoundation.WorkItemTracking.AssignedTo.dll"
                             assemblyFileLocation="~\EventHandlers\WorkItemTracking\">
                    </Handler>
                </Handlers>
            </Event>
        </Events>

As you can see you are theoretically allows to us any events. 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.

Name	Type	Description
eventType	RDdotNet.TeamFoundation.EventTypes	Enumerator that defines the list of possible events.
type	System.Type	This must be a valid type in the assembly listed in assemblyFileName
assemblyFileName	System.String	This must be a valid assembly found in the assemblyFileLocation
assemblyFileLocation	System.String	A location within the servers file system that holds this assembly. ~ denotes the applications root.

If you are using friendly server names or TeamPlain the you can change the TFS server links to be TeamPlain ones using the UrlReplacements config element:

<UrlReplacements>
            <!-- The Url Replaces change the url listed in the event to valid public items
            Examples:
                This item changes the TFS url to a TeamPlain v1 url
                <Replace eventType="WorkItemChangedEvent" 
                                         old=":8080/WorkItemTracking/WorkItem.aspx?artifactMoniker=" 
                                        new="/workitem.aspx?id=" />
                            
                These items change the server location to a public host header:
                <Replace eventType="WorkItemChangedEvent" 
                                         old="[ServerProductionEnviromentName]" 
                                         new="[PublicProductionEnviromentUri]" />
                <Replace eventType="WorkItemChangedEvent" 
                                         old="[ServerDevelopmentEnviromentName]" 
                                         new="[PublicDevelopmentEnviromentUri]" />
            -->
</UrlReplacements>

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 grater 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 know nothing about it, they will still get an email that will link them through to TeamPlain.

And that is you 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 :)

Test the service

comming soon

Turn off Debug Mode

When you have completed testing and are sure that it workd, all you have to do is change the testMode property to False and restart the service.

<TeamServers>
            <TeamServer name="[TFS Server Name]"
                        ...
                        testMode="True"
                        ...
            </TeamServer>
        </TeamServers>

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 10:19:46 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

v2.0 (CTP) (Proposed Release)

The v2 product will build on v1 and provide better GUI interaction with the handler system as well as increased debug capability against it.

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 08:32:40 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

v2.0 (CTP) (Proposed Release)

The v2 product will build on v1 and provide better GUI interaction with the handler system as well as increased debug capability against it.

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 08:31:59 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v2.0 (CTP) (Proposed Release)

The v2 product will build on v1 and provide better GUI interaction with the handler system as well as increased debug capability against it.

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 08:29:53 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 08:28:09 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

v1.0 [Documentation]

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler

NEWS FEED

UPDATED WIKI: Home

hinshelmw — Fri, 30 May 2008 08:27:43 GMT

Welcome to the Team Foundation Server Event Handler Homepage!

Release List

!!!v1.0 [Documentation]
This release comes with 2 event handlers. One is fully tested and this is the AssignedTo handler which sends a nicely formated email to users if a work item is assigned to them regardless wither they have added alerts. This email can be tailored to link back to TeamPlain v1.0 instead of TFS.

2007-06-18 - Original release under the name "TFS Event Handler (Prototype)"
2008-05-27 - Updated to take care of some bugs.
2008-05-27 - Addition of Some event handlers...

Common Tasks

News

NEWS FEED

Thursday, May 15, 2008 | From TFS Event Handler

Thursday, May 15, 2008 | From TFS Event Handler

Monday, April 21, 2008 | From TFS Event Handler

Friday, April 18, 2008 | From TFS Event Handler

Thursday, April 17, 2008 | From TFS Event Handler

Tuesday, April 15, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Monday, February 11, 2008 | From TFS Event Handler

Tuesday, February 05, 2008 | From TFS Event Handler

Thursday, January 31, 2008 | From TFS Event Handler

Tuesday, January 29, 2008 | From TFS Event Handler

Monday, January 28, 2008 | From TFS Event Handler

Thursday, January 24, 2008 | From TFS Event Handler

Monday, July 16, 2007 | From TFS Event Handler

TFS Event Handler prototype Configuration Demystified

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Monday, June 18, 2007 | From TFS Event Handler

Sunday, June 17, 2007 | From TFS Event Handler

Monday, May 07, 2007 | From TFS Event Handler