Synchronization with Microsoft Team Foundation Server 2010 How To Setup March 19, 2011 v. 2
INTRODUCTION 3 PREREQUISITES 3 INSTALLATION 3 DEPLOYMENT SCENARIOS 4 SINGLE SERVER SCENARIO 4 DISTRIBUTED SCENARIO 4 COMMUNICATION DIAGRAM 5 INSTALLATION 6 SET UP NEW PROJECT IN MICROSOFT TEAM FOUNDATION 6 SET UP SPRINTS IN TFS 7 LOCAL DATABASE INSTALLATION 8 SYNCHRONIZATION HUB INSTALLATION 8 SCRUMDESK TFS EVENT SUBSCRIBER PLUGIN INSTALLATION 9 INSTALL SCRUMDESK 9 SET UP SCRUMDESK PROJECT S SYNCHRONIZATION 9 SET UP SYNCHRONIZATION HUB 11 SYNCHRONIZATION TEST 12 SYNCHRONIZATION SCRUMDESK TO TFS 13 SYNCHRONIZATION TFS TO SCRUMDESK 14 EVENT LOG 15
3 Introduction This document describes setup of synchronization between ScrumDesk and Microsoft Team Foundation Server 2010. Synchronization allows having agile stories accessible in different clients of TFS 2010 while still having flexibility of agile project management offered by ScrumDesk. Prerequisites Microsoft Windows XP, Vista or Windows 7 Microsoft.NET 3.5 Framework at least Microsoft Team Foundation Server 2010 Visual Scrum 1.0 Installation ScrumDesk Project ScrumDesk Hub Users Mappings ScrumDesk User TFS User John JPierre Mary MFergus BillG BGilger Windows MessageQueue TFS Event Subscriber Plugin Microsoft Team Foundation Server 2010 2010 MS VS Scrum 1.0
4 Deployment scenarios Hub package can be installed in different ways. We recommend two scenarios. Single server scenario The easiest and suggested way of installing the hub package is to install it on the same computer/server. Server: - Windows 2003/2008 o Windows Message Queue component installed - SQL Server 2008 (installed by TFS 2010) - Team Foundation Server 2010 o Microsoft Visual Studio Scrum 1.0 Template - ScrumDesk o ScrumDesk TFS Event Subscriber Plugin o Synchronization Hub o ScrumDesk Database (use ScrumDesk Database Manager) Distributed scenario This deployment scenario requires good knowledge of the windows administration because of security related requirements. Server A TFS Server must be accessible. User account for synchronization hub to access TFS must be created, must be a member of TFS Administrators and every synchronized Project Administrators group. - Windows 203/2008 o Windows Message Queue - Team Foundation Server 2010 o Microsoft Visual Studio Scrum 1.0 Template - ScrumDesk o Synchronization Hub Server B The server must be accessible by Server A. - SQL Server 2005/2008 o Configured for remote connections - ScrumDesk databases
5 Communication diagram ScrumDesk Change written immediately Refresh command or every 10 minutes auto check ScrumDesk Database Change checked every sync connection interval Synchronization Hub Change written immediately Message Queue Change written immediately TFS Event Subscriber Plugin Microsoft Team Foundation Server Team Foundation Server Database
6 Installation Prerequisites Microsoft Tam Foundation Server 2010 Steps Message Queue (see Deployment scenario where to install it) SQL Server 2005/2008 (any edition) 1. Set up new project in TFS 2. Set up sprints in TFS 3. Local database installation 4. ScrumDesk Synchronization Hub installation 5. ScrumDesk TFS Event Subscriber Plugin Installation 6. ScrumDesk client installation 7. Set up project synchronization details 8. Set up Synchronization Hub Set up new project in Microsoft Team Foundation 1. Run Microsoft Visual Studio 2. Connect to your Team Foundation Server 2010 3. Choose File/New/Team Project 4. Enter the project name
7 5. In the next window select Microsoft Visual Studio Scrum 1.0. Microsoft Visual Studio Scrum 1.0 is required to be installed before this step! 6. Go to the following window by pressing Next or press Finish. ScrumDesk require entering only the name and correct template. Set up sprints in TFS Beta version of Hub does not support automatic synchronization of sprints between ScrumDesk project and TFS project when new synchronization connection is created so it must be done manually. TFS to ScrumDesk synchronization If you edit sprint in TFS it will be automatically synchronized (created if does not exist) to ScrumDesk project ScrumDesk to TFS synchronization 1. Open Areas and Iterations in Visual Studio
8 2. Create setup that exists in ScrumDesk project 3. Close the dialog 4. Restart Synchronization hub otherwise hub will not see your changes. 5. Edit sprint in ScrumDesk, sprint will be synchronized (created if does not exist) with TFS project Local database installation Register for On-Site edition and follow steps written in an email you receive upon your registration. Synchronization Hub installation Download the installation from http:///download/hub/ng/scrumdeskhubinstaller.msi.
9 ScrumDesk TFS Event Subscriber Plugin installation 1. Download ScrumDesk TFS Event Subscriber plugin. 2. Unzip the content to %Program Files%\Microsoft Team Foundation Server2010\Application Tier\Web Services\bin\Plugins 3. Plugin communicates with Synchronization Hub via message queue. You can change the queue name changing MessageQueueName parameter in TFS2010ServerPlugin.dll.config. 4. Check SDHubLog events in Windows EventLog Viewer whether TSF gets restarted successfully. Install ScrumDesk You will receive installation steps by email after you register. Set up ScrumDesk project s synchronization Now you can create a new ScrumDesk project that will be synchronized with TFS. 1. Create a new ScrumDesk project 2. Go to Project view 3. Switch Synchronization tab
10 4. Click on New command. Integration details window will appear. 5. Select synchronization connector type. For TFS 2010 choose Visual Studio Scrum 1.0 (TFS 2010) type. 6. Enter your Microsoft TFS server details: a. Title enter name for your synchronization b. Server address and port for your TFS. Always use localhost in TFS address otherwise it will not work. c. Project Name name of the project stored in TFS that has to be synchronized with current ScrumDesk s project d. Domain, Login, Password account that allows ScrumDesk Synchronization Hub communicate with TFS e. Refresh time to check changes User mapping ScrumDesk team member accounts must be mapped to Microsoft Team Foundation Server accounts. 1. Click User Mapping command
11 2. Enter TFS account name into Target System User Name 3. Integration List displays project s synchronization connections to 3 rd party systems Set up Synchronization Hub 1. Start Synchronization Hub with administrator credentials because it needs to have privileges to write to event log and message queue. 2. Double click an icon in system tray to show Synchronization Hub window. 3. Settings window will displays as the first. You are asked to provide company license key you received in an email upon the registration. It is required to provide proxy details as the license is verified via ScrumDesk license service.
12 4. Click Add menu item and enter ScrumDesk database server details: a. Description enter name of your synchronization b. Server name name or IP of server where ScrumDesk database is installed c. Database name of database you want to synchronize with d. Authentication in case of SQL Server authentication enter login and password 5. Click on Test button to verify connectivity to your data. Synchronization test In this step we are going to test synchronization. THIS TEST IS REQUIRED! TFS sprints must use exactly the same names as in ScrumDesk. TFS sprints must be created before the synchronization.
13 Synchronization ScrumDesk to TFS 1. Run ScrumDesk a. Create new project b. Go to Project view c. Switch Integration page d. Enter synchronization connection detail. Use correct user name to access TFS. This user must be a member of TFS Administrators and Project Administrators group! 2. Switch to Backlog view. a. Create a new story b. Fill Subject and Description. 3. Switch to Visual Studio Team Explorer a. Display Project Backlog b. Wait a few seconds (based on the synchronization interval filled in synchronization connection details). c. Refresh query results d. You should see the story now.
14 Synchronization TFS to ScrumDesk 1. Run Microsoft Visual Studio a. Run Team Explorer b. Expand your project c. Right click on Work Items d. Add new Product Backlog Item e. Enter item details f. Click Save in toolbar 2. Switch to ScrumDesk a. Go to Backlog View b. Click Refresh command to see changes immediately. ScrumDesk checks project database changes after some interval. c. New story entered in step 6 should appear.
15 Event log ScrumDesk Synchronization Hub writes error into event log. To display it, run Event Viewer. 1. Run Event Viewer 2. Expand Application and Services Logs 3. Click on ScrumDesk Hub item 4. Click an error. Details of the error will appear in bottom window.
16 If you need more information please take a look on or don t hesitate to send email to support@scrumdesk.com. ScrumDesk contacts scrumdesk@scrumdesk.com Sales: sales@scrumdesk.com Support: support@scrumdesk.com