Tfs Export Users For Mapping Processor

[MrHinsh]

This discussion is for questions, feedback, and community support related to the Tfs Export Users For Mapping Processor.

Quick Reference

• Documentation: Tfs Export Users For Mapping Processor

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.

[ptc-96]

Hello,
I'm a bit confused about this process. Here is my configuration file:

"Processors": [ { "ProcessorType": "TfsExportUsersForMappingProcessor", "Enabled": true, "WIQLQuery": "SELECT [System.Id] FROM WorkItems WHERE [System.TeamProject] = @TeamProject ", "OnlyListUsersInWorkItems": true, "ExportAllUsers": false, "UserExportFile": "C:\\temp\\UserExportFile.json", "SourceName": "SourceProject", "TargetName": "TargetProject" }, { "ProcessorType": "TfsTeamSettingsProcessor", "Enabled": false, "MigrateTeamSettings": true, "UpdateTeamSettings": true, "PrefixProjectToNodes": true, "MigrateTeamCapacities": true, "Teams": [ "*" ], "UseUserMapping": true, "SourceName": "Source", "TargetName": "Target" } ], "CommonTools": { "TfsTeamSettingsTool": { "Enabled": true, "MigrateTeamSettings": true, "UpdateTeamSettings": true, "MigrateTeamCapacities": true, "UseUserMapping": true, "Teams": [ "*" ] } , "TfsUserMappingTool": { "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\\UserExportFile.json", "MatchUsersByEmail": false } }

I've executed the migration and here are my logs and what I can understand from them regarding also the code:
...
[10:53:39 INF] [16.2.9] Processed 38684 work items from Source
[10:54:52 DBG] [16.2.9] TfsUserMappingTool::GetUsersInSourceMappedToTargetForWorkItems [workItemUsers|182]

--->>>>>> He found 386684 wor Itemss in the source and 182 different users from all of them

[10:54:52 INF] [16.2.9] TfsUserMappingTool::GetUsersInSourceMappedToTarget Loading identities from source server
[10:54:52 INF] [16.2.9] TfsUserMappingTool::GetUsersListFromServer Found 301 identities (users and groups) in server.
[10:55:11 INF] [16.2.9] TfsUserMappingTool::GetUsersListFromServer 196 user identities are applicable for mapping

--->>>>>> He found 301 identities in source project, where only 196 are of type users : SourceUsers = 196

       identity != null && ((identity.Type == IdentityType.WindowsUser) || (identity.Type == IdentityType.UnknownIdentityType))

[10:55:11 INF] [16.2.9] TfsUserMappingTool::GetUsersInSourceMappedToTarget Loading identities from target server
[10:55:12 INF] [16.2.9] TfsUserMappingTool::GetUsersListFromServer Found 1952 identities (users and groups) in server.
[10:57:10 INF] [16.2.9] TfsUserMappingTool::GetUsersListFromServer 1131 user identities are applicable for mapping

--->>>>>> He found 1952 identities in target project, where 1131 are of type users : TargetUsers = 1131

[10:57:10 DBG] [16.2.9] TfsUserMappingTool::GetUsersInSourceMappedToTargetForWorkItems [mappedUsers|196]

--->>>>>> He constructs a map as follows

	foreach (var sourceUser in sourceUsers)
	{
		IdentityItemData targetUser = null;
		targetUser ??= targetUsers.SingleOrDefault(x => x.DisplayName == sourceUser.DisplayName);
		identityMap.Add(new IdentityMapData { Source = sourceUser, Target = targetUser });
	}
	return new()
	{
		IdentityMap = identityMap,
		SourceUsers = sourceUsers,
		TargetUsers = targetUsers
	};

so my Identity map should be :

            IdentityMap = MAP FOR EACH SOURCE USER AS SOURCE + TARGET IF THERE IS A DISPLAY NAME EQUAL IN THE SOURCE (196)
            SourceUsers = ORIGINAL SOURCEUSERS (196)
            TargetUsers = ORIGINAL TARGETUSERS (1131)

[10:57:10 INF] [16.2.9] Found 107 total mapped
--->>>>>> From the 196 mapped users, 107 appears in WI.

       mappedUsers.IdentityMap = mappedUsers.IdentityMap.Where(x => workItemUsers.Contains(x.Source.DisplayName)).ToList();

Now:
IdentityMap = [107]
SourceUsers = [196]
TargetUsers = [1131]

[10:57:10 INF] [16.2.9] Filtered to 29 total viable mappings
--->>>>>> From the 107 mapped users, 29 have different displayNames in source and in target

       List<IdentityMapData> usersToMap = data.IdentityMap.Where(x => x.Source.DisplayName != x.Target?.DisplayName).ToList();

Until here, the behaviour is comprehensible for me, then my doubts came when I regard to my exported file.
[10:57:10 INF] [16.2.9] User mappings writen to: C:\temp\UserExportFile.json

--->>>>>> I see in the code that the following transformation is performed:

        foreach (IdentityMapData userMapping in usersToMap)
        {
            // We cannot use ToDictionary(), because there can be multiple users with the same display name and so
            // it would throw with duplicate key. This way we just overwrite the value – last item in source wins.
            usermappings[userMapping.Source.DisplayName] = userMapping.Target?.DisplayName;
        }

Then:

     TfsUserMappingTool.SerializeUserMap(CommonTools.UserMapping.Options.UserMappingFile, usermappings, Log);

In the file, I see 29 users, all in this format:

{
"User 1": null,
"User 2": null,
"User 2": null,
"User 4": null,
....
"User 29": null
}

Which for me, means that they are source project users, that have null displayName in tarjet project.

However, the users User 1, User 2 etc are correctly appearing in my target project. How can we explain that? What is actually the content of that file?

Thanks in advance for any help.