Skip to content

Commit 5a907ab

Browse files
committed
Add common issue troubleshooting section for work item type validation failures
1 parent a11cfbb commit 5a907ab

File tree

1 file changed

+43
-0
lines changed
  • docs/content/docs/get-started/getting-started

1 file changed

+43
-0
lines changed

docs/content/docs/get-started/getting-started/index.md

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,49 @@ The default [TfsWorkItemMigrationProcesor]({{< ref "docs/reference/processors/tf
6565
7. Adjust the [`NodeBasePaths`]({{< ref "docs/reference/processors/workitem-tracking-processor" >}}) or leave empty to migrate all nodes
6666
8. From your working folder run `devopsmigration execute --config .\configuration.json`
6767

68+
### Common Issue: Work Item Type Validation Failures
69+
70+
> **⚠️ IMPORTANT:** The migration tools include automatic validation that runs before migration starts and can cause your migration to fail if source and target systems have different work item types or fields.
71+
72+
The [TfsWorkItemTypeValidatorTool]({{< ref "docs/reference/tools/tfsworkitemtypevalidatortool" >}}) automatically validates that:
73+
74+
- All source work item types exist in the target system (or have mappings configured)
75+
- Required fields exist in target work item types
76+
- Field types are compatible between source and target
77+
- The ReflectedWorkItemId field exists in target work item types
78+
79+
**If validation fails**, the migration will stop immediately with detailed error messages. Here's how to resolve common validation issues:
80+
81+
**Missing Work Item Types:**
82+
83+
```text
84+
Work item type 'Risk' does not exist in target system.
85+
```
86+
87+
- **Solution 1:** Create the missing work item type in your target system
88+
- **Solution 2:** Configure a work item type mapping to map 'Risk' to an existing type like 'Issue'
89+
- **Solution 3:** Exclude the work item type from your migration query
90+
91+
**Missing ReflectedWorkItemId Field:**
92+
93+
```text
94+
'User Story' does not contain reflected work item ID field 'Custom.ReflectedWorkItemId'.
95+
```
96+
97+
- **Solution:** Add the custom field to ALL work item types in your target project (see [ReflectedWorkItemId setup]({{< ref "docs/setup/reflected-workitem-id" >}}))
98+
99+
**Missing Custom Fields:**
100+
101+
```text
102+
Missing field 'Microsoft.VSTS.Common.CustomField' in 'User Story'.
103+
```
104+
105+
- **Solution 1:** Add the missing field to the target work item type
106+
- **Solution 2:** Configure field mapping to map to an existing field
107+
- **Solution 3:** Exclude the field from validation if it's not needed
108+
109+
For detailed troubleshooting and configuration options, see the [TfsWorkItemTypeValidatorTool documentation]({{< ref "docs/reference/tools/tfsworkitemtypevalidatortool" >}}).
110+
68111
**Remember:** If you want a processor to run, its `Enabled` attribute must be set to `true`.
69112

70113
Refer to the [Reference Guide]({{< ref "docs/reference" >}}) for more details.

0 commit comments

Comments
 (0)