Skip to content

Commit 39aaca6

Browse files
committed
Add ProjectCollectionValidUsersGroupName parameter
Updated TfsUserMappingTool configuration to include a new parameter, `ProjectCollectionValidUsersGroupName`, in the YAML and JSON schema files. Clarified documentation for `MatchUsersByEmail` while keeping its functionality unchanged. These changes enhance the tool's ability to reference the valid users group during user mapping processes.
1 parent dd3ca8d commit 39aaca6

File tree

3 files changed

+14
-1
lines changed

3 files changed

+14
-1
lines changed

docs/data/classes/reference.tools.tfsusermappingtool.yaml

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,8 @@ configurationSamples:
7171
"Microsoft.VSTS.Common.ClosedBy"
7272
],
7373
"UserMappingFile": "C:\\temp\\userExport.json",
74-
"MatchUsersByEmail": false
74+
"MatchUsersByEmail": false,
75+
"ProjectCollectionValidUsersGroupName": "Project Collection Valid Users"
7576
}
7677
sampleFor: MigrationTools.Tools.TfsUserMappingToolOptions
7778
description: 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.
@@ -90,6 +91,10 @@ options:
9091
type: Boolean
9192
description: By default, users in source are mapped to target users by their display name. If this is set to true, then the users will be mapped by their email address first. If no match is found, then the display name will be used.
9293
defaultValue: missing XML code comments
94+
- parameterName: ProjectCollectionValidUsersGroupName
95+
type: String
96+
description: This is the regionalized "Project Collection Valid Users" group name. Default is "Project Collection Valid Users".
97+
defaultValue: missing XML code comments
9398
- parameterName: UserMappingFile
9499
type: String
95100
description: This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file.

docs/static/schema/configuration.schema.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1444,6 +1444,10 @@
14441444
"description": "By default, users in source are mapped to target users by their display name. If this is set to true, then the users will be mapped by their email address first. If no match is found, then the display name will be used.",
14451445
"type": "boolean"
14461446
},
1447+
"projectCollectionValidUsersGroupName": {
1448+
"description": "This is the regionalized \"Project Collection Valid Users\" group name. Default is \"Project Collection Valid Users\".",
1449+
"type": "string"
1450+
},
14471451
"userMappingFile": {
14481452
"description": "This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file.",
14491453
"type": "string"

docs/static/schema/schema.tools.tfsusermappingtool.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,10 @@
1717
"description": "By default, users in source are mapped to target users by their display name. If this is set to true, then the users will be mapped by their email address first. If no match is found, then the display name will be used.",
1818
"type": "boolean"
1919
},
20+
"projectCollectionValidUsersGroupName": {
21+
"description": "This is the regionalized \"Project Collection Valid Users\" group name. Default is \"Project Collection Valid Users\".",
22+
"type": "string"
23+
},
2024
"userMappingFile": {
2125
"description": "This is the file that will be used to export or import the user mappings. Use the ExportUsersForMapping processor to create the file.",
2226
"type": "string"

0 commit comments

Comments
 (0)