Tfs WorkItemType Validator Tool

Validates Work Item Types against a set of rules. Does not migrate Work Items, only validates types.

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

missing XML code comments

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:
FieldMappings
Type:
Dictionary
Description:
Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.
Default Value:
missing XML code comments
Parameter:
IncludeWorkItemtypes
Type:
List
Description:
List of work item types which will be validated. If this list is empty, all work item types will be validated.
Default Value:
missing XML code comments
top

Samples

top

Sample

Sample

There is no sample, but you can check the classic below for a general feel.
top

Defaults

Defaults

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

Classic

Classic

{
  "$type": "TfsWorkItemTypeValidatorToolOptions",
  "Enabled": true,
  "IncludeWorkItemtypes": [],
  "FieldMappings": {}
}
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.tfsworkitemtypevalidatortool.json",
  "title": "TfsWorkItemTypeValidatorTool",
  "description": "missing XML code comments",
  "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"
    },
    "fieldMappings": {
      "description": "Field reference name mappings. Key is work item type name, value is dictionary of mapping source filed name to target field name. Target field name can be empty string to indicate that this field will not be validated in target. As work item type name, you can use * to define mappings which will be applied to all work item types.",
      "type": "object"
    },
    "includeWorkItemtypes": {
      "description": "List of work item types which will be validated. If this list is empty, all work item types will be validated.",
      "type": "array"
    }
  }
}
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