Tfs WorkItem Migration Processor

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.tfsworkitemmigrationprocessor.json",
  "title": "TfsWorkItemMigrationProcessor",
  "description": "WorkItemMigrationConfig is the main processor used to Migrate Work Items, Links, and Attachments. Use `WorkItemMigrationConfig` to configure.",
  "type": "object",
  "properties": {
    "attachRevisionHistory": {
      "description": "This will create a json file with the revision history and attach it to the work item. Best used with `MaxRevisions` or `ReplayRevisions`.",
      "type": "boolean",
      "default": "false"
    },
    "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"
    },
    "filterWorkItemsThatAlreadyExistInTarget": {
      "description": "This loads all of the work items already saved to the Target and removes them from the Source work item list prior to commencing the run. While this may take some time in large data sets it reduces the time of the overall migration significantly if you need to restart.",
      "type": "boolean",
      "default": "true"
    },
    "fixHtmlAttachmentLinks": {
      "description": "**beta** If enabled this will fix any image attachments URL's, work item mention URL's or user mentions in the HTML fields as well as discussion comments. You must specify a PersonalAccessToken in the Source project for Azure DevOps; TFS should use integrated authentication.",
      "type": "boolean",
      "default": "true"
    },
    "generateMigrationComment": {
      "description": "If enabled, adds a comment recording the migration",
      "type": "boolean",
      "default": "true"
    },
    "maxGracefulFailures": {
      "description": "The maximum number of failures to tolerate before the migration fails. When set above zero, a work item migration error is logged but the migration will continue until the number of failed items reaches the configured value, after which the migration fails.",
      "type": "integer",
      "default": "0"
    },
    "pauseAfterEachWorkItem": {
      "description": "Pause after each work item is migrated",
      "type": "boolean",
      "default": "false"
    },
    "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"
    },
    "skipRevisionWithInvalidAreaPath": {
      "description": "When set to true, this setting will skip a revision if the source area has not been migrated, has been deleted or is somehow invalid, etc.",
      "type": "boolean"
    },
    "skipRevisionWithInvalidIterationPath": {
      "description": "This will skip a revision if the source iteration has not been migrated i.e. it was deleted",
      "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"
    },
    "updateCreatedBy": {
      "description": "If this is enabled the creation process on the target project will create the items with the original creation date. (Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate, not the internal create date)",
      "type": "boolean",
      "default": "true"
    },
    "updateCreatedDate": {
      "description": "If this is enabled the creation process on the target project will create the items with the original creation date. (Important: The item history is always pointed to the date of the migration, it's change only the data column CreateDate, not the internal create date)",
      "type": "boolean",
      "default": "true"
    },
    "wIQLQuery": {
      "description": "A work item query based on WIQL to select only important work items. To migrate all leave this empty. See [WIQL Query Bits](#wiql-query-bits)",
      "type": "string",
      "default": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject AND [System.WorkItemType] NOT IN ('Test Suite', 'Test Plan','Shared Steps','Shared Parameter','Feedback Request') ORDER BY [System.ChangedDate] desc"
    },
    "workItemCreateRetryLimit": {
      "description": "**beta** If set to a number greater than 0 work items that fail to save will retry after a number of seconds equal to the retry count. This allows for periodic network glitches not to end the process.",
      "type": "integer",
      "default": "5"
    },
    "workItemIDs": {
      "description": "A list of work items to import",
      "type": "array",
      "default": "[]"
    }
  }
}