WorkItem Tracking Processor

This processor is intended, with the aid of ProcessorEnrichers , to allow the migration of Work Items between two Endpoints .

Last updated: September 10, 2025 | Edit this page | Discuss this page

This processor is intended, with the aid of ProcessorEnrichers , to allow the migration of Work Items between two Endpoints .

top

Options

Parameter
Type
Required
Description
Default Value
Parameter:
CollapseRevisions
Type:
Boolean
Required:
false
Description:
Gets or sets a value indicating whether to collapse revisions into a single work item.
Default:
missing XML code comments
Parameter:
Enabled
Type:
Boolean
Required:
true
Description:
If set to true then the processor will run. Set to false and the processor will not run.
Default:
missing XML code comments
Parameter:
Enrichers
Type:
List
Required:
false
Description:
List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.
Default:
missing XML code comments
Parameter:
RefName
Type:
String
Required:
false
Description:
Refname will be used in the future to allow for using named Options without the need to copy all of the options.
Default:
missing XML code comments
Parameter:
ReplayRevisions
Type:
Boolean
Required:
false
Description:
Gets or sets a value indicating whether to replay all revisions during migration.
Default:
missing XML code comments
Parameter:
SourceName
Type:
String
Required:
true
Description:
This is the IEndpoint that will be used as the source of the Migration. Can be null for a write only processor.
Default:
missing XML code comments
Parameter:
TargetName
Type:
String
Required:
true
Description:
This is the IEndpoint that will be used as the Target of the Migration. Can be null for a read only processor.
Default:
missing XML code comments
Parameter:
WorkItemCreateRetryLimit
Type:
Int32
Required:
false
Description:
Gets or sets the number of times to retry work item creation if it fails.
Default:
missing XML code comments
top

Samples

top

Sample

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

Defaults

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

Classic

{
  "$type": "WorkItemTrackingProcessorOptions",
  "Enabled": false,
  "ReplayRevisions": false,
  "CollapseRevisions": false,
  "WorkItemCreateRetryLimit": 0,
  "SourceName": null,
  "TargetName": null
}
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.processors.workitemtrackingprocessor.json",
  "title": "WorkItemTrackingProcessor",
  "description": "This processor is intended, with the aid of [ProcessorEnrichers](../ProcessorEnrichers/index.md), to allow the migration of Work Items between two [Endpoints](../Endpoints/index.md).",
  "type": "object",
  "properties": {
    "CollapseRevisions": {
      "description": "Gets or sets a value indicating whether to collapse revisions into a single work item.",
      "type": "boolean"
    },
    "Enabled": {
      "description": "If set to `true` then the processor will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "Enrichers": {
      "description": "List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.",
      "type": "array"
    },
    "RefName": {
      "description": "`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.",
      "type": "string"
    },
    "ReplayRevisions": {
      "description": "Gets or sets a value indicating whether to replay all revisions during migration.",
      "type": "boolean"
    },
    "SourceName": {
      "description": "This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.",
      "type": "string"
    },
    "TargetName": {
      "description": "This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.",
      "type": "string"
    },
    "WorkItemCreateRetryLimit": {
      "description": "Gets or sets the number of times to retry work item creation if it fails.",
      "type": "integer"
    }
  },
  "required": [
    "enabled",
    "sourceName",
    "targetName"
  ]
}
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