Scrat User Guide. Quality Center 2 Team Foundation Server 2010 Migration Tool. Version: Last updated: 5/25/2011. Page 1

Transcription

1 Scrat User Guide Quality Center 2 Team Foundation Server 2010 Migration Tool Version: Last updated: 5/25/2011 Page 1

2 CONTENTS INTRODUCTION... 3 INSTALLATION... 4 Prerequisites 4 Activation 6 Check List 8 Menu Bar 9 File... 9 Tools... 9 Help Wizard 12 Migration Type and Configuration Connections User Mapping 18 Area Creation 19 Skip Add Value Remove Value Replace Value Revert Create Field Mapping 24 Data Mapping 26 State Mapping 27 Add State Remove State Creator 28 Log Page 2

3 Introduction This document describes how to use Scrat for performing an easy migration from Quality Center 9.0, 9.02 and 10 to Team Foundation Server Team Foundation Server 2010 includes the following general features: Easy Wizard Provides a wizard based migration tool enabling easy and fast configuration and usage. Comprehensive Support Provides full support for defining requirements, test cases and defects. Linking Support Enables all migrated items to have compatible links based on TFS 2010 linking. Allows for multi step migration using Staged migration The migration tool works with an XML repository file that contains all migration information. The Migration processes itself and the results are saved in XML format enabling a gradual migration to TFS. Attachments Provides support for Item attachments and for Steps attachments (Test Cases). Hierarchy Translates Quality Center hierarchy to Area Paths in TFS. Call 2 Test Creates Shared Steps in TFS 2010 based on the QC Call 2 Test feature. Team Foundation Server 2010 includes the following mapping features: User Mapping Enables easy mapping between Quality Center users to TFS (LDAP) users. Fields Mapping Maps all "Visible" fields in TFS against Quality Center fields. Data Mapping Enables data mapping based on Fields Mapping from Quality Center to different data on TFS. State Mapping Maps all States fields in TFS against Quality Center States fields. Page 3

4 Installation Before starting the installation, make sure the latest version of Scrat is being used. If it is not the latest version, go to the Scrat Home Page ( to download the latest version. Prerequisites The requirements for using Scrat and for performing the migration are as follows: Redistributable SDK Platform - CAPICOM FF88EA5896F6 HP Quality Center Client Side Setup Add-in - For information on installing clients using the Client Side Setup, see HP Software Self-solve knowledge base article KM Microsoft Team Explorer After completing all the prerequisites, run the Scrat setup file. To run the Scrat setup file: 1. Locate and run the setup application. The Welcome to the Scrat Setup Wizard window is displayed. Page 4

5 2. Click Next. The License Agreement is displayed. 3. Read the License Agreement, select "I Agree" and click Next. The Select Installation Folder is displayed. Page 5

6 4. Ensure the target folder where Scrat is to be installed is correct. 5. Click Next. The setup process starts. After the setup is finished, a "Scrat" shortcut is displayed on the desktop and a new folder in the Programs contains the "Scrat" application and a Readme file. Activation To activate Scrat perform the following: 1. Open the Scrat application. The "License Activation Screen" is displayed providing a Machine Key (based on the computer MAC address). 2. On the Menu Bar click Help and from the sub-menu select Activate. The License Activation Screen containing a Machine Key is displayed. Page 6

7 3. Copy the "Machine Key" (The Copy button can be used) and send it to the Scrat administrator. After sending the "Machine Key", the administrator sends back a "License Key" containing the License information. 4. Paste the License key into the "License Key" pane and click Active License. After activating the License, the number of items permitted with the license is displayed. Page 7

8 If the number of items is insufficient, click Reactivate License and enter another License Key provided by the Scrat Administrator. Each license is valid only for a specified number of items. Check List Before starting the Migration, prepare the following: Fields and Data During the migration, there is a request for fields to be mapped from QC to TFS and data mapped from QC to TFS. Make sure the TFS server contains all Field and Data corresponding to the QC Fields and Data. Required Fields The Migration Tool requires all fields to be mapped. Remove the require tags from the work item definition. Allow Values It is suggested to remove all references to "AllowValues" tags from the work item definition and replace them with "SuggestedValues". To gain familiarity with these terms contact the TFS Administrator. HTML Fields Many fields in the Quality Center are HTML fields. When mapping Fields from QC to TFS ensure the TFS field is also an HTML field, as not all values transferring to TFS include HTML tags. Page 8

9 Menu Bar The Menu Bar contains the following options: File Tools Help File The File Menu Bar option contains the following: New Restarts the migration wizard and enables starting the migration steps from the beginning. Save Saves the configuration and completed stages to the configuration file selected in the "Migration Type and Configuration" stage. Reload Loads the configuration to enable manually changing the configuration XML. Exit Closes the Scrat Migration Wizard. Tools The Tools Menu Bar option contains the following: View XML Enables viewing the Configuration XML file from the migration wizard. (View XML is Read Only mode) Page 9

10 Statistics Enables viewing the total number of items successfully migrated at any time during the migration. Help The Help Menu Bar option contains the following: About Displays the application s current version and contains a link to the Scrat home page for additional updates for the Scrat migration tool. Page 10

11 Activate Provides an alternative method to activate the product and display the license type. For more information please read Activation. Page 11

12 Wizard The Wizard requires the following steps: Migration Type and Configuration Connections User Mapping Area Creation Field Mapping Data Mapping State Mapping Creator Migration Type and Configuration Migration Configuration File The Scrat migration tool is based on the XML configuration file. In this step a new configuration file is created using the "New" button. The configuration file is used to manage large-scale migrations (More the domain or project in QC). Page 12

13 Example: A configuration file for Project A is created. For the next Project (Project B), it is required that all settings in Project B are the same as for Project A except for the Work Item creation results. All the same, configurations are used for the migration process. Check the relevant check box when creating a configuration file by copying an existing configuration file. The following figure illustrates this selection. Example:A configuration file is created for Project A. All Project B settings are the same, except Work Item creation results. Therefore, all the same configurations are used for the migration process. When creating a configuration file by copying an existing one, select the relevant option for Configuration Usage (Settings, Work Items or All) as described on the following figure. *** You can add the description for those option here **** Page 13

14 Migration Type The Migration Type can be selected. The following figure illustrates the migration options. The additional migration options selected in the migration type include: Split Steps contains break line ('\n' or 'br') Remove Steps Order List Numbers Convert Space from Parameters To: Split Steps contains break line ('\n' or 'br') Sometimes QC users write a number of steps in one "Design Step" as illustrated in the following figure. Page 14

15 During migration the separate steps are merged into one step, as illustrated in the following figure. Selecting "Split Steps contains break line ('\n' or 'br')" splits the merged migration steps with '\n' and 'br' signs, as illustrated in the following figure. Page 15

16 Remove Steps Order List Numbers Select "Remove Steps Order List" when selecting "Split Steps contains break line ('\n' or 'br')". This avoids duplicate step numbers when the MTM automatically defines the step numbers, as illustrated in the following figure. Convert Space from Parameters To: Scrat also converts Quality Center Test Case Parameters to MTM format. By default the QC Test Case Parameters contain Spaces and cannot be migrated with spaces to TFS. When selecting how to convert Parameters with spaces to TFS there are options to deal with the space issue. The following figure illustrates the options Trim space, Dash or Underscore. Trim Space Dash Underscore Connections This step requests a connection to the Team Foundation Server (Target machine for the migration). To connect to the Team Foundation Server: 1. Click the Browse button located beside the "Team Foundation Server URL" text field. The Connect to Team Project window is displayed. Page 16

17 2. Navigate to and select the Team Project for this migration session. 3. Click Connect. A successful connection is indicated with the icon. 4. Enter the following information: Quality Center Server URL User Name (The account most be a Domain\Project member.) Password Page 17

18 After the first steps are completed, a Domain and Project per Domain list is enabled in the Domain and Project fields respectively. 5. Select the domain and project from the drop-down lists. 6. Click Test to verify the information against the Quality Center Server. User Mapping The User Mapping step displays Quality Center Users and enables them each to be assigned a TFS user. The "Set Default User" can also be used to assign all Quality Center users to just one list user. The following figure illustrates how to assign Quality Center users to a user list. Page 18

19 Area Creation Quality Center enables a hierarchy of Requirements, Defects and Test Cases based on folders. To migrate with the same structure into TFS, Scrat translates the hierarchies into Area Paths in TFS. The following Area Path options are available: Skip Add Value Remove Value Replace Value Revert Create Page 19

20 Skip Creating Areas is not mandatory during Scrat migration. To move to the next stage without Area creation: 1. Check "Skip Area Creation". A confirmation dialog box is displayed. 2. Click Yes. To use existing area configurations from previous Area creation: 1. Check Skip Area Creation. A confirmation dialog box is displayed. (picture above). 2. Click Cancel Note: Skipping the area creation stage, places all work items under the current project s root area and Test Case hierarchy will not be available. Add Value To add new value: 1. Write the New value in the "Change To" field. 2. Click Add Head. Page 20

21 The result is illustrated in the following figure. Remove Value To remove a value from the Area Path: 1. Select the value from the combo box. Make sure the "Change To" field is empty. 2. Click Apply. The result is illustrated in the following figure. Page 21

22 Replace Value Before creating Area Paths in TFS some values can be changed. To change values: 1. In the "Area Modification Panel" select the value to change from the drop-down list. 2. Enter the new value in the Change To field. 3. Click Apply. The result is illustrated in the following figure. Revert To undo all changes: Page 22

23 1. Click Revert. The original Areas are automatically returned to the list. Create To create a Quality Center hierarchy as Areas in TFS: 1. Click Create Areas. A progress bar illustrates the creation process progress and completion. The following figure illustrates the Team Project picked for this migration session displaying the entire hierarchy structure as Areas. Page 23

24 Field Mapping The Field Mapping step enables mapping between Quality Center fields (right side) and Team Foundation Server fields (left side). The following figure illustrates the mapping options: Page 24

25 The following table describes the mapping options: 1 Team Foundation Server 2010 contains a "Category" definition enabling more than one work item to be defined as a "Requirement". Select the work item to use from the "Select Work Item Type" drop-down list. Example - In the Agile process template the "Requirement" work item is "User Story". 2 Mandatory Fields are displayed in red. A corresponding Team System Field in the Quality Center Fields must be selected. 3 Define corresponding fields for each field in Team Foundation Server by selecting from the Quality Center Fields drop-down list. 4 Some fields are automatically disabled and cannot be used during the migration. 5 Let the mouse hover over the Team Foundation Server fields to get the field summary and values. Page 25

26 Data Mapping After selecting the Field Mapping, the Data Mapping for each stage must be defined. Values from Quality Center are not aligned with Team Foundation Server values. The following figure illustrates the data mapping options: The following table describes the data mapping options: 1 When Quality Center and Team Foundation Server fields are of the same type and no special rules apply to them, data mapping does not need to be set and the data transfers as is. (This applies to all fields of the same type int, double etc.) 2-3 List to List Data Mapping When both fields contain values (free text is not allowed), a corresponding value can be defined in Team Foundation Server for each value in Quality Center. The value is selected from the drop-down list on the right. 4 List to List Free Data Mapping When a Quality Center field contains a list of values but the corresponding field in Team Foundation Server contains a field with a <SUGGESTEDVALUES> rule (enables adding free text), all values from Quality Center fields are automatically copied as Team Foundation Server field values. (These values can be changed) Page 26

27 State Mapping Team Foundation Server Work Items work on State workflow. These are based on two fields: State and Reason. When creating a new Work Item, the work item can only be saved with the first State. The user cannot change this first save. The State Mapping Stage enables a path definition where the Work Item is saved in the required Stage and Reason. Add State By default, all Quality Center States are translated to the default State and Reason in the Team Foundation Server. To change the Default State: 1. Click Add. A new line is displayed with the available new State and Reason. Remove State An Added State and Reason can be removed. To remove an added State and Reason: 1. Select the State and Reason to remove. 2. Click Remove. The State and Reason is removed. Page 27

28 Creator This is the final stage (except for Test Cases Migration Hierarchy Builder). To start the migration process: 1. Click Start. The migration process starts using the settings defined during the Wizard completion. After the migration is completed, a summary at the end of the log is displayed. Log After the migration is completed, view the log and save it. To save the log: 1. Click Save Log. Page 28

29 The log is saved. Page 29