Getting Started with the VSTS Sync Migrator

If you want to perform a bulk edit or a migration then you need to start here. This tool has been tested on updating from 100 to 250,000 work items by its users.

Install

In order to run the migration you will need to install the tools first.

  1. Install Chocolatey from https://chocolatey.org/install
  2. Run "choco install vsts-sync-migrator" to install the tools source

The tools are now installed and calling "vstssyncmigrator" from any command line will run the tools.

Create a default configuration file

  1. Open a command prompt or PowerShell window
  2. Run "vstssyncmigrator init" to create a default configuration
  3. Open "vstsbulkeditor.json" from the current directory

You can now customise the configuration depending on what you need to do. However a basic config that you can use to migrate from one team project to another with the same process template is:

{
  "TelemetryEnableTrace": true,
  "Source": {
    "Collection": "https://sdd2016.visualstudio.com/",
    "Name": "DemoProjs"
  },
  "Target": {
    "Collection": "https://sdd2016.visualstudio.com/",
    "Name": "DemoProjt"
  },
  "ReflectedWorkItemIDFieldName": "TfsMigrationTool.ReflectedWorkItemId",
  "WorkItemTypeDefinition": {
    "Bug": "Bug",
    "Epic": "Epic",
    "Feature": "Feature",
    "Product Backlog Item": "Product Backlog Item",
    "Shared Parameter": "Shared Parameter",
    "Shared Steps": "Shared Steps",
    "Task": "Task",
    "Test Case": "Test Case"
  },
  "Processors": [
    {
      "ObjectType": "VstsSyncMigrator.Engine.Configuration.Processing.NodeStructuresMigrationConfig",
      "Enabled": true,
      "PrefixProjectToNodes": false
    },
    {
      "ObjectType": "VstsSyncMigrator.Engine.Configuration.Processing.WorkItemMigrationConfig",
      "Enabled": true,
      "PrefixProjectToNodes": true,
      "UpdateCreatedDate": true,
      "UpdateCreatedBy": true,
      "UpdateSoureReflectedId": true,
      "QueryBit": "AND [TfsMigrationTool.ReflectedWorkItemId] = '' AND  [Microsoft.VSTS.Common.ClosedDate] = '' AND [System.WorkItemType] IN ('Shared Steps', 'Shared Parameter', 'Test Case', 'Product Backlog Item', 'Task', 'Feature', 'Epic', 'Bug')"
    },
    {
      "ObjectType": "VstsSyncMigrator.Engine.Configuration.Processing.LinkMigrationConfig",
      "Enabled": true,
      "QueryBit": "AND ([System.ExternalLinkCount] > 0 OR [System.RelatedLinkCount] > 0)"
    },
    {
      "ObjectType": "VstsSyncMigrator.Engine.Configuration.Processing.AttachementExportMigrationConfig",
      "Enabled": true,
      "QueryBit": "AND [System.AttachedFileCount] > 0"
    },
    {
      "ObjectType": "VstsSyncMigrator.Engine.Configuration.Processing.AttachementImportMigrationConfig",
      "Enabled": true
    }
  ]
}

Here we are performing the following operations:

  1. Set the Source and Target Team Projects
  2. Set the field name of the Migration tracking field. I use "TfsMigrationTool.ReflectedWorkItemId" for TFS and "ReflectedWorkItemId" for VSTS
  3. Set the mapping of Work Items that you want in "WorkItemTypeDefinition". This allows you to merge and change types..
  4. NodeStructuresMigration - We need to create the same Area and Iteration paths in the Target Team Project as you have in the Source. Make sure you clean up your Area and Iteration paths first.
  5. Work Item Migration - Move the work items. Use the QueryBit to scope to only the items that you want.
  6. Link Migration - Once all of the work items are across you can then migrate the links. Links will only be re-created if both ends of the link are in the new system. The "ReflectedWorkItemId" field value is used to find the new work items easily.
  7. Attachment Export & Import - Now we can export and then re-import the attachments. This just done separately to prevent errors

Remember if you want a processor to run it's Enabled property must be set to true.

If you have Test Suits & Plans you can also migrate them using other processors, you would need to add them to your configuration file.