TfsUserMappingTool
Ref
Less than 1 minute to read
2024-09-10 16:11:58 +0000
draft
This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.
The TfsUserMappingTool is used to map users from the source to the target system. Run it with the ExportUsersForMappingContext to create a mapping file then with WorkItemMigrationContext to use the mapping file to update the users in the target system as you migrate the work items.
Options
| Parameter name | Type | Description | Default Value |
| Enabled | Boolean | If set to `true` then the tool will run. Set to `false` and the processor will not run. | missng XML code comments |
| IdentityFieldsToCheck | List | This is a list of the Identiy fields in the Source to check for user mapping purposes. You should list all identiy fields that you wan to map. | missng XML code comments |
| UserMappingFile | String | This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file. | missng XML code comments |
Examples
defaults
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"MigrationTools": {
"CommonTools": {
"TfsUserMappingTool": {
"Enabled": "False",
"IdentityFieldsToCheck": [
"System.AssignedTo",
"System.ChangedBy",
"System.CreatedBy",
"Microsoft.VSTS.Common.ActivatedBy",
"Microsoft.VSTS.Common.ResolvedBy",
"Microsoft.VSTS.Common.ClosedBy"
],
"UserMappingFile": "C:\\temp\\userExport.json"
}
}
}
}
sample
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
{
"MigrationTools": {
"CommonTools": {
"TfsUserMappingTool": {
"Enabled": "True",
"IdentityFieldsToCheck": [
"System.AssignedTo",
"System.ChangedBy",
"System.CreatedBy",
"Microsoft.VSTS.Common.ActivatedBy",
"Microsoft.VSTS.Common.ResolvedBy",
"Microsoft.VSTS.Common.ClosedBy"
],
"UserMappingFile": "C:\\temp\\userExport.json"
}
}
}
}
classic
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
{
"$type": "TfsUserMappingToolOptions",
"Enabled": true,
"IdentityFieldsToCheck": [
"System.AssignedTo",
"System.ChangedBy",
"System.CreatedBy",
"Microsoft.VSTS.Common.ActivatedBy",
"Microsoft.VSTS.Common.ResolvedBy",
"Microsoft.VSTS.Common.ClosedBy",
"System.AssignedTo",
"System.ChangedBy",
"System.CreatedBy",
"Microsoft.VSTS.Common.ActivatedBy",
"Microsoft.VSTS.Common.ResolvedBy",
"Microsoft.VSTS.Common.ClosedBy"
],
"UserMappingFile": "C:\\temp\\userExport.json"
}
