Tfs Validate Required Field Tool

[MrHinsh]

This discussion is for questions, feedback, and community support related to the TFS Validate Required Field Tool.

Quick Reference

• Class Name: TfsValidateRequiredFieldTool
• Friendly Name: Tfs Validate Required Field
• Documentation: TFS Validate Required Field Tool

How to Use This Discussion

• Ask Questions: If you need help configuring or using this component
• Share Examples: Post your configuration examples or use cases
• Report Issues: Describe any problems you encounter (though bugs should be reported as GitHub Issues)
• Request Features: Suggest improvements or new features

Related Documentation

Please refer to the official documentation for detailed configuration options and examples.

[YuriVanZieks]

Hi !

I have been scratching my head as how to use these tools. I have been trying to insert an exclusions for the WorkItems where I can't insert a ReflectedWorkItemId, so it may migrate only the fields I ask him too, but unfortunately I don't really understand the doc as it doesn't really show a full example of a configuration.json. I get the errors from the cmd stating missing required properties ... I'll just put it here :

  "$schema": "https://devopsmigration.io/schema/configuration.schema.json",
  "Serilog": {
    "MinimumLevel": "Information"
  },
  "MigrationTools": {
    "Version": "16.2",
    "Endpoints": {
      "Source": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "Collection": "https://dev.azure.com/playteststeven/",
        "Project": "Source",
        "Authentication": {
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "UserName": "",
            "Password": "** removed as a secret ***"
          },
          "AccessToken": "token here"
        },
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
        "LanguageMaps": {
          "AreaPath": "Area",
          "IterationPath": "Iteration"
        }
      },
      "Target": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "Collection": "https://dev.azure.com/playteststeven/",
        "Project": "Destination",
        "Authentication": {
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "UserName": "",
            "Password": "** removed as a secret ***"
          },
          "AccessToken": "token here"
        },
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
        "LanguageMaps": {
          "AreaPath": "Area",
          "IterationPath": "Iteration"
      }
    },
    "Processors": [
      {
        "ProcessorType": "TfsWorkItemMigrationProcessor",
        "Enabled": true,
        "UpdateCreatedDate": true,
        "UpdateCreatedBy": true,
        "WIQLQuery": "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",
        "FixHtmlAttachmentLinks": true,
        "WorkItemCreateRetryLimit": 5,
        "FilterWorkItemsThatAlreadyExistInTarget": false,
        "GenerateMigrationComment": true,
        "SourceName": "Source",
        "TargetName": "Target"
      }
    ],
    "CommonTools": {
      "TfsValidateRequiredFieldTool": {
        "Enabled": true,
        "Exclusions": [
          "Code Review Request",
          "Code Review Response",
          "Feedback Request",
          "Feedback Response",
          "Shared Steps",
          "Issue",
          "Shared Parameter",
          "Defect",
          "DAA"
        ]
      },
      "TfsWorkItemTypeValidatorTool": {
        "Enabled": true,
        "IncludeWorkItemtypes": [
          "Bug",
          "Task",
          "User Story",
          "Product Backlog Item",
          "Feature",
          "Epic",
          "Risk"
        ]
      }
    }
  }
}
}

Likely root cause missing properties (all deduped candidate sets):
  Path: MigrationTools.Endpoints.CommonTools
    - missing Authentication, Collection, EndpointType, LanguageMaps, Project, ReflectedWorkItemIdField (freq 4)

Path: MigrationTools.Endpoints.CommonTools
  - (Ln 62, Pos 20) Required: Required properties are missing from object: AccessToken, AuthenticationMode, Organisation, Project, ReflectedWorkItemIdField, EndpointType.
  - (Ln 62, Pos 20) Required: Required properties are missing from object: Authentication, Collection, LanguageMaps, Project, ReflectedWorkItemIdField, EndpointType.
  - (Ln 62, Pos 20) Required: Required properties are missing from object: EndpointType.
Path: MigrationTools.Endpoints.Processors
  - (Ln 47, Pos 19) Type: Invalid type. Expected Object but got Array.

Total unique validation errors after filtering: 4

NOTE: A single missing property can trigger multiple branch (anyOf/allOf) mismatches. Fix the root cause lines above first.

It's probably very wrong, but I just can't figure how we are suppose to syntax the tools and how to insert them !

[YuriVanZieks]

Self-update :

I managed somehow to resolve the errors and correct the script, it goes like this :

  "$schema": "https://devopsmigration.io/schema/configuration.schema.json",
  "Serilog": {
    "MinimumLevel": "Information"
  },
  "MigrationTools": {
    "Version": "16.2",
    "Endpoints": {
      "Source": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "Collection": "https://dev.azure.com/playteststeven/",
        "Project": "Source",
        "Authentication": {
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "UserName": "",
            "Password": "** removed as a secret ***"
          },
          "AccessToken": "token here"
        },
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
        "LanguageMaps": {
          "AreaPath": "Area",
          "IterationPath": "Iteration"
        }
      },
      "Target": {
        "EndpointType": "TfsTeamProjectEndpoint",
        "Collection": "https://dev.azure.com/playteststeven/",
        "Project": "Destination",
        "Authentication": {
          "AuthenticationMode": "AccessToken",
          "NetworkCredentials": {
            "Domain": "",
            "UserName": "",
            "Password": "** removed as a secret ***"
          },
          "AccessToken": "token here"
        },
        "ReflectedWorkItemIdField": "Custom.ReflectedWorkItemId",
        "LanguageMaps": {
          "AreaPath": "Area",
          "IterationPath": "Iteration"
      }
    }
  },
    "Processors": [
      {
        "ProcessorType": "TfsWorkItemMigrationProcessor",
        "Enabled": true,
        "UpdateCreatedDate": true,
        "UpdateCreatedBy": true,
        "WIQLQuery": "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",
        "FixHtmlAttachmentLinks": true,
        "WorkItemCreateRetryLimit": 5,
        "FilterWorkItemsThatAlreadyExistInTarget": false,
        "GenerateMigrationComment": true,
        "SourceName": "Source",
        "TargetName": "Target"
      }
    ],
    "CommonTools": {
  "TfsWorkItemTypeValidatorTool": {
        "Enabled": true,
        "FixedTargetFields": {
          "User Story": [
          ]
        },
        "IncludeWorkItemtypes": [
          "Bug",
          "Task",
          "User Story",
          "Feature",
          "Epic",
          "Risk"
        ]
      }
    }
  }
}

[13:55:51 INF] [16.3.0-Preview.1] ProcessorContainer: Of 1 configured Processors only 1 are enabled
[13:55:51 INF] [16.3.0-Preview.1] ProcessorContainer: Adding Processor TfsWorkItemMigrationProcessor
[13:55:51 INF] [16.3.0-Preview.1] Logging has been configured and is set to: unknown.
[13:55:51 INF] [16.3.0-Preview.1]                               Max Logfile: Verbose.
[13:55:51 INF] [16.3.0-Preview.1]                               Max Console: Debug.
[13:55:51 INF] [16.3.0-Preview.1]                  Max Application Insights: Error.
[13:55:51 INF] [16.3.0-Preview.1] The Max log levels above show where to go look for extra info. e.g. Even if you set the log level to Verbose you will only see that info in the Log File, however everything up to Debug will be in the Console.
[13:55:51 INF] [16.3.0-Preview.1] Beginning run of 1 processors
[13:55:51 INF] [16.3.0-Preview.1] Processor: TfsWorkItemMigrationProcessor
[13:55:51 INF] [16.3.0-Preview.1] Migration Context Start: TfsWorkItemMigrationProcessor
Initializing expensive ProjectData from WorkItemStore...
Initializing expensive WorkItemStore...
[13:55:51 INF] [16.3.0-Preview.1] Connecting with AccessToken
[13:55:51 INF] [16.3.0-Preview.1] Access granted to https://dev.azure.com/playteststeven/ for Reis Steven ([email protected])
[13:55:52 INF] [16.3.0-Preview.1] Work Item Store connected to https://dev.azure.com/playteststeven/ with BypassRules set to True
Initializing expensive ProjectData from WorkItemStore...
Initializing expensive WorkItemStore...
[13:55:52 INF] [16.3.0-Preview.1] Connecting with AccessToken
[13:55:52 INF] [16.3.0-Preview.1] Access granted to https://dev.azure.com/playteststeven/ for Reis Steven ([email protected])
[13:55:52 INF] [16.3.0-Preview.1] Work Item Store connected to https://dev.azure.com/playteststeven/ with BypassRules set to True
[13:55:52 INF] [16.3.0-Preview.1] Validating work item types.
[13:55:52 INF] [16.3.0-Preview.1] Source work item types are: Task, Bug, Code Review Request, Code Review Response, Epic, Feature, Feedback Request, Feedback Response, Impediment, Product Backlog Item, Shared Steps, Shared Parameter, Test Case, Test Plan, Test Suite.
[13:55:52 INF] [16.3.0-Preview.1] Target work item types are: Task, Bug, Code Review Request, Code Review Response, Epic, Feature, Feedback Request, Feedback Response, Impediment, Product Backlog Item, Shared Steps, Shared Parameter, Test Case, Test Plan, Test Suite.
[13:55:52 INF] [16.3.0-Preview.1] Validating work item type 'Task'
[13:55:52 INF] [16.3.0-Preview.1]   All fields are either present or mapped.
[13:55:52 INF] [16.3.0-Preview.1] Validating work item type 'Bug'
[13:55:52 INF] [16.3.0-Preview.1]   All fields are either present or mapped.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Code Review Request' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Code Review Response' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Validating work item type 'Epic'
[13:55:52 INF] [16.3.0-Preview.1]   All fields are either present or mapped.
[13:55:52 INF] [16.3.0-Preview.1] Validating work item type 'Feature'
[13:55:52 INF] [16.3.0-Preview.1]   All fields are either present or mapped.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Feedback Request' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Feedback Response' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Impediment' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Product Backlog Item' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Shared Steps' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Shared Parameter' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Test Case' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Test Plan' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] Skipping validation of work item type 'Test Suite' because it is not included in validation list.
[13:55:52 INF] [16.3.0-Preview.1] All work item types are valid.
[13:55:52 INF] [16.3.0-Preview.1] Migrating all Nodes before the Processor run.
[13:55:52 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 1, start date: null, finish date: null
[13:55:52 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 2, start date: null, finish date: null
[13:55:53 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 3, start date: null, finish date: null
[13:55:53 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 4, start date: null, finish date: null
[13:55:53 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 5, start date: null, finish date: null
[13:55:53 INF] [16.3.0-Preview.1]  Processing Node: \Destination\Iteration\Sprint 6, start date: null, finish date: null
[13:55:53 INF] [16.3.0-Preview.1] ----------------------------------------------
[13:55:53 INF] [16.3.0-Preview.1] Migrating all Teams before the Processor run.
[13:55:53 INF] [16.3.0-Preview.1] TfsTeamSettingsProcessor::InternalExecute: Found 1 teams in Source?
[13:55:54 INF] [16.3.0-Preview.1] -> Settings found for team 'Source Team'..
[13:55:54 INF] [16.3.0-Preview.1] Migrating team capacities..
[13:55:55 INF] [16.3.0-Preview.1] Team capacities migration done..
[13:55:55 INF] [16.3.0-Preview.1] Querying items to be migrated: 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 ...
[13:55:55 INF] [16.3.0-Preview.1] 4 Work items received, verifying
[13:55:55 INF] [16.3.0-Preview.1] Loading 4 Work Items
[13:55:58 INF] [16.3.0-Preview.1] Replay all revisions of 4 work items?
[13:55:58 INF] [16.3.0-Preview.1] Validating::Check that all Area & Iteration paths from Source have a valid mapping on Target
[13:55:59 INF] [16.3.0-Preview.1] Validating::Check that all users in the source exist in the target or are mapped!
[13:55:59 WRN] [16.3.0-Preview.1] TfsUserMappingTool is disabled in settings. You may have users in the source that are not mapped to the target.
[13:55:59 INF] [16.3.0-Preview.1] Found target project as Destination
[13:55:59 INF] [16.3.0-Preview.1] [                Task][Complete:     1/4][sid:     6|Rev:  1][tid:  null | Work Item has 1 revisions and revision migration is set to True
[13:55:59 INF] [16.3.0-Preview.1] Source: Found 1 revisions to migrate on  Work item:Source
[13:55:59 INF] [16.3.0-Preview.1] Source: Found 1 revisions to migrate on  Work item:Source
[13:55:59 INF] [16.3.0-Preview.1] [                Task][Complete:     1/4][sid:     6|Rev:  1][tid:  null |  Processing Revision [1]
[13:55:59 INF] [16.3.0-Preview.1] EmbededImagesRepairEnricher: Fixing HTML field attachments for work item 0 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:55:59 INF] [16.3.0-Preview.1] TfsWorkItemEmbededLinkTool: Fixing embedded mention links on target work item 0 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:55:59 INF] [16.3.0-Preview.1] [                Task][Complete:     1/4][sid:     6|Rev:  1][tid:  null |  Saved TargetWorkItem 7. Replayed revision 1 of 1
[13:55:59 INF] [16.3.0-Preview.1] [                Task][Complete:     1/4][sid:     6|Rev:  1][tid:  null | ...Saved as 7
[13:55:59 INF] [16.3.0-Preview.1] [                Task][Complete:     1/4][sid:     6|Rev:  1][tid:  null | Average time of 0.557 per work item and 0 hours 0 minutes 1 seconds estimated to completion.
[13:55:59 INF] [16.3.0-Preview.1] [             Feature][Complete:     2/4][sid:     5|Rev:  1][tid:  null | Work Item has 1 revisions and revision migration is set to True
[13:55:59 INF] [16.3.0-Preview.1] Source: Found 1 revisions to migrate on  Work item:Source
[13:55:59 INF] [16.3.0-Preview.1] Source: Found 1 revisions to migrate on  Work item:Source
[13:55:59 INF] [16.3.0-Preview.1] [             Feature][Complete:     2/4][sid:     5|Rev:  1][tid:  null |  Processing Revision [1]
[13:55:59 INF] [16.3.0-Preview.1] EmbededImagesRepairEnricher: Fixing HTML field attachments for work item 0 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:55:59 INF] [16.3.0-Preview.1] TfsWorkItemEmbededLinkTool: Fixing embedded mention links on target work item 0 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:56:00 INF] [16.3.0-Preview.1] [             Feature][Complete:     2/4][sid:     5|Rev:  1][tid:  null |  Saved TargetWorkItem 8. Replayed revision 1 of 1
[13:56:00 INF] [16.3.0-Preview.1] [             Feature][Complete:     2/4][sid:     5|Rev:  1][tid:  null | ...Saved as 8
[13:56:00 INF] [16.3.0-Preview.1] [             Feature][Complete:     2/4][sid:     5|Rev:  1][tid:  null | Average time of 0.551 per work item and 0 hours 0 minutes 1 seconds estimated to completion.
[13:56:00 INF] [16.3.0-Preview.1] 1 Work items received, verifying
[13:56:00 INF] [16.3.0-Preview.1] Loading 1 Work Items
[13:56:03 INF] [16.3.0-Preview.1] [                Epic][Complete:     3/4][sid:     2|Rev:  2][tid:  null | Work Item has 2 revisions and revision migration is set to True
[13:56:03 INF] [16.3.0-Preview.1] Source: Found 2 revisions to migrate on  Work item:Source
[13:56:03 INF] [16.3.0-Preview.1] Target: Found 3 revisions to migrate on  Work item:Target
[13:56:03 INF] [16.3.0-Preview.1] Source: Found 0 revisions to migrate on  Work item:Source
[13:56:03 INF] [16.3.0-Preview.1] EmbededImagesRepairEnricher: Fixing HTML field attachments for work item 3 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:56:03 INF] [16.3.0-Preview.1] TfsWorkItemEmbededLinkTool: Fixing embedded mention links on target work item 3 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:56:03 INF] [16.3.0-Preview.1] [                Epic][Complete:     3/4][sid:     2|Rev:  2][tid:  null | Skipping as work item exists and no revisions to sync detected
[13:56:03 INF] [16.3.0-Preview.1] [                Epic][Complete:     3/4][sid:     2|Rev:  2][tid:  null | Average time of 1.229 per work item and 0 hours 0 minutes 1 seconds estimated to completion.
[13:56:03 INF] [16.3.0-Preview.1] 1 Work items received, verifying
[13:56:03 INF] [16.3.0-Preview.1] Loading 1 Work Items
[13:56:06 INF] [16.3.0-Preview.1] [                 Bug][Complete:     4/4][sid:     1|Rev:  2][tid:  null | Work Item has 2 revisions and revision migration is set to True
[13:56:06 INF] [16.3.0-Preview.1] Source: Found 2 revisions to migrate on  Work item:Source
[13:56:06 INF] [16.3.0-Preview.1] Target: Found 4 revisions to migrate on  Work item:Target
[13:56:06 INF] [16.3.0-Preview.1] Source: Found 0 revisions to migrate on  Work item:Source
[13:56:06 INF] [16.3.0-Preview.1] EmbededImagesRepairEnricher: Fixing HTML field attachments for work item 4 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:56:06 INF] [16.3.0-Preview.1] TfsWorkItemEmbededLinkTool: Fixing embedded mention links on target work item 4 from https://dev.azure.com/playteststeven/ to https://dev.azure.com/playteststeven/
[13:56:06 INF] [16.3.0-Preview.1] [                 Bug][Complete:     4/4][sid:     1|Rev:  2][tid:  null | Skipping as work item exists and no revisions to sync detected
[13:56:06 INF] [16.3.0-Preview.1] [                 Bug][Complete:     4/4][sid:     1|Rev:  2][tid:  null | Average time of 1.775 per work item and 0 hours 0 minutes 0 seconds estimated to completion.
[13:56:06 INF] [16.3.0-Preview.1]  Migration Processor Complete TfsWorkItemMigrationProcessor
[13:56:06 INF] [16.3.0-Preview.1] TfsWorkItemMigrationProcessor completed in 00:00:00
[13:56:06 INF] [16.3.0-Preview.1] Command ExecuteMigrationCommand completed in 00:00:21.0063687
[13:56:06 INF] [16.3.0-Preview.1] Check the logs for errors: C:\Users\REISST\Downloads\MigrationTools-16.3.0-Preview.1\logs\20250827135544

Buuut the Work Items are not present in the Destination project.

[MrHinsh]

Its doing a migration and saving work items. Where depends on your configuration.

[YuriVanZieks]

Well, the configuration is, simply, the project "Destination" that I created within the same organisation. From what I see, he does find the projet, but I don't see any work item there, as shown on the screenshot.