Tfs Validate Required Field Tool

Tool for validating that required fields exist in target work item types before migration, preventing migration failures due to missing required fields.

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

Tool for validating that required fields exist in target work item types before migration, preventing migration failures due to missing required fields.

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:
Exclusions
Type:
List
Description:
Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.
Default Value:
[]
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "TfsValidateRequiredFieldTool": {
        "Enabled": "True",
        "Exclusions": [
          "Work Request",
          "Opertunity",
          "Assumption"
        ]
      }
    }
  }
}
top

Defaults

Defaults

There are no defaults! Check the sample for options!
top

Classic

Classic

{
  "$type": "TfsValidateRequiredFieldToolOptions",
  "Enabled": true,
  "Exclusions": [
    "Work Request",
    "Opertunity",
    "Assumption"
  ]
}
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.tfsvalidaterequiredfieldtool.json",
  "title": "TfsValidateRequiredFieldTool",
  "description": "Tool for validating that required fields exist in target work item types before migration, preventing migration failures due to missing required fields.",
  "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"
    },
    "exclusions": {
      "description": "Add a list of work item types from the source that you want to exclude from validation. This is a case-insensitive comparison. WARNING: If you exclude a work item type that exists in the migration dataset, the migration will fail when trying to.",
      "type": "array",
      "default": "[]"
    }
  }
}
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