Map users - ExportUsersForMapping?

[maf-soft]

Title: ExportUsersForMapping
Class File: /src/VstsSyncMigrator.Core/Execution/MigrationContext/ExportUsersForMapping.cs
Class Config File: /src/MigrationTools/_EngineV1/Configuration/Processing/ExportUsersForMappingConfig.cs

Hi, I need to map users between the source and target system and found ExportUsersForMapping - is that the way to go?

I tried it out and it exported a nice json file with all users. I assume I have to fill in the blanks. And then?

The source and target users are from different ADs and have different email addresses.

[maf-soft]

https://stackoverflow.com/questions/77561854/how-to-map-users-from-tenant-1-to-tenant-2-while-migrating-project-between-these
This is very related but when looking at ExportUsersForMapping I hope there is a much easier solution?

[MrHinsh]

There is no load from file.

We should trigger if the field is an identity field, but this functionality does not currently exist.

note: This does not block migration.

[maf-soft]

So you mean copying the above block for each field? I did that now and it works.
And are there any other fields I should add? I have the 6 from above.

[MrHinsh]

No, I mean that we need to build this functionally into the tool.

[maf-soft]

I was referring to your "note: This does not block migration" - until this is implemented, is what I am doing the best I can do, or can I improve it?

[MrHinsh]

We now have this new functionality #1973

[Nopesound]

This doesn't work for me, like you, I have users in the source project who have a different name in the target project. I tried to do what you do but without success, basically, I'm left with the old username, which doesn't exist in the new project. I tried to create a processor for extracting users, but it gives me an error when I try to run it. I assume that the source name and destination name are what I see on the screen, right?

This is my code...
"MappingTools": [
{
"$type": "WorkItemFieldMappingTool",
"Enabled": true,
"WorkItemFieldMaps": [
{
"$type": "FieldValueMapConfig",
"WorkItemTypeName": "*",
"sourceField": "System.CreatedBy",
"targetField": "System.CreatedBy",
"valueMapping": {
"Carlo Magno": "Ivan Persiani",
"Ivan Persiani": "Ivan Persiani",
"Filippo Rossi": "Ivan Persiani",
"Jacob Black": "Ivan Persiani"
}
},

[MrHinsh]

#1973

Added in: https://github.com/nkdAgility/azure-devops-migration-tools/releases/tag/v15.0.1-Preview.1

There was a request to have the ability to map users to try and maintain integrity across different systems. We added a TfsUserMappingEnricherthat allows you to map users from Source to Target... this is not free and takes some work. Runnin theExportUsersForMappingConfig` to get the list of users will produce:

[
  {
    "Source": {
      "FriendlyName": "Martin Hinshelwood nkdAgility.com",
      "AccountName": "[email protected]"
    },
    "target": {
      "FriendlyName": "Hinshelwood, Martin",
      "AccountName": "[email protected]"
    }
  },
  {
    "Source": {
      "FriendlyName": "Rollup Bot",
      "AccountName": "[email protected]"
    },
    "target": {
      "FriendlyName": "Service Account 4",
      "AccountName": "[email protected]"
    }
  },
  {
    "Source": {
      "FriendlyName": "Another non mapped Account",
      "AccountName": "[email protected]"
    },
    "target": null
  }
]

How it works

1. Run ExportUsersForMappingConfig which will export all of the Users in Soruce Mapped or not to target.
2. Run WorkItemMigrationConfig which will run a validator by detail to warn you of missing users. If it finds a mapping it will convert the field...

Notes

• Applies to all identity fields specified in the list
• It really sucks that we have to match on Display name! Email is included for internal matching
• On 'ExportUsersForMappingConfigyou can setOnlyListUsersInWorkItems` to filter the mapping based on the scope of the query. This is greater if you have many users.
• Both use the TfsUserMappingEnricherOptions setting in CommonEnrichersConfig to know what to do.

{
  "ChangeSetMappingFile": null,
  "Source": {
    "$type": "TfsTeamProjectConfig",
    "Collection": "https://dev.azure.com/nkdagility/",
    "Project": "AzureDevOps-Tools",
    "ReflectedWorkItemIDFieldName": "nkdScrum.ReflectedWorkItemId",
    "AllowCrossProjectLinking": false,
    "AuthenticationMode": "Prompt",
    "PersonalAccessToken": "",
    "PersonalAccessTokenVariableName": "",
    "LanguageMaps": {
      "AreaPath": "Area",
      "IterationPath": "Iteration"
    }
  },
  "Target": {
    "$type": "TfsTeamProjectConfig",
    "Collection": "https://dev.azure.com/nkdagility-preview/",
    "Project": "migrationTest5",
    "ReflectedWorkItemIDFieldName": "nkdScrum.ReflectedWorkItemId",
    "AllowCrossProjectLinking": false,
    "AuthenticationMode": "Prompt",
    "PersonalAccessToken": "",
    "PersonalAccessTokenVariableName": "",
    "LanguageMaps": {
      "AreaPath": "Area",
      "IterationPath": "Iteration"
    }
  },
  "FieldMaps": [],
  "GitRepoMapping": null,
  "LogLevel": "Debug",
  "CommonEnrichersConfig": [
    {
      "$type": "TfsUserMappingEnricherOptions",
      "Enabled": true,
      "UserMappingFile": "C:\\temp\\userExport.json",
      "IdentityFieldsToCheck": [
        "System.AssignedTo",
        "System.ChangedBy",
        "System.CreatedBy",
        "Microsoft.VSTS.Common.ActivatedBy",
        "Microsoft.VSTS.Common.ResolvedBy",
        "Microsoft.VSTS.Common.ClosedBy"
      ]
    }
  ],
  "Processors": [
    {
      "$type": "ExportUsersForMappingConfig",
      "Enabled": 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",
      "OnlyListUsersInWorkItems": true
    }
  ],
  "Version": "15.0"
}