TfsUserMappingEnricher

Ref

  

Less than 1 minute to read

  

2024-09-06 09:35:04 +0100

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 TfsUserMappingEnricher 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 enabled this will run this migrator	true
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
RefName	String	For internal use	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

Example

A basic sample for TfsUserMappingEnricher configuration.

{
  "$type": "TfsUserMappingEnricherOptions",
  "Enabled": false,
  "IdentityFieldsToCheck": [
    "System.AssignedTo",
    "System.ChangedBy",
    "System.CreatedBy",
    "Microsoft.VSTS.Common.ActivatedBy",
    "Microsoft.VSTS.Common.ResolvedBy",
    "Microsoft.VSTS.Common.ClosedBy"
  ],
  "UserMappingFile": "usermapping.json"
}