Tfs Work Item Link Tool

Tool for migrating work item links and relationships between work items, including shared steps and parameters for test cases.

Last updated: July 28, 2025 | Edit this page | Discuss this page

Tool for migrating work item links and relationships between work items, including shared steps and parameters for test cases.

top

Options

Parameter
Type
Description
Default Value
Parameter:
Enabled
Type:
Boolean
Description:
If set to true then the tool will run. Set to false and the processor will not run.
Default Value:
missing XML code comments
Parameter:
FilterIfLinkCountMatches
Type:
Boolean
Description:
Skip validating links if the number of links in the source and the target matches!
Default Value:
missing XML code comments
Parameter:
SaveAfterEachLinkIsAdded
Type:
Boolean
Description:
Save the work item after each link is added. This will slow the migration as it will cause many saves to the TFS database.
Default Value:
Not specified
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsWorkItemLinkTool": {
        "Enabled": "True",
        "FilterIfLinkCountMatches": "True",
        "SaveAfterEachLinkIsAdded": "False"
      }
    }
  }
}
top

Defaults

Defaults

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsWorkItemLinkTool": {
        "Enabled": "True",
        "FilterIfLinkCountMatches": "True",
        "SaveAfterEachLinkIsAdded": "False"
      }
    }
  }
}
top

Classic

Classic

{
  "$type": "TfsWorkItemLinkToolOptions",
  "Enabled": true,
  "FilterIfLinkCountMatches": true,
  "SaveAfterEachLinkIsAdded": false
}
top

Metadata

top

Schema

This is the JSON schema that defines the structure and validation rules for this configuration.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://devopsmigration.io/schema/schema.tools.tfsworkitemlinktool.json",
  "title": "TfsWorkItemLinkTool",
  "description": "Tool for migrating work item links and relationships between work items, including shared steps and parameters for test cases.",
  "type": "object",
  "properties": {
    "enabled": {
      "description": "If set to `true` then the tool will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "filterIfLinkCountMatches": {
      "description": "Skip validating links if the number of links in the source and the target matches!",
      "type": "boolean"
    },
    "saveAfterEachLinkIsAdded": {
      "description": "Save the work item after each link is added. This will slow the migration as it will cause many saves to the TFS database.",
      "type": "boolean",
      "default": "false"
    }
  }
}
Project Information
Azure DevOps Marketplace
YouTube Channel
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation