Processors : TfsExportUsersForMappingProcessor

Ref

  

Less than 1 minute to read

  

2025-06-19 13:46:05 +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.

ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems. Use ExportUsersForMappingConfig to configure.

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	If set to `true` then the processor will run. Set to `false` and the processor will not run.	missing XML code comments
ExportAllUsers	Boolean	Set to , if you want to export all users in source and target server. The lists of user can be useful, if you need tu manually edit mapping file. Users will be exported to file set in .	missing XML code comments
OnlyListUsersInWorkItems	Boolean	`OnlyListUsersInWorkItems`	true
SourceName	String	This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.	missing XML code comments
TargetName	String	This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.	missing XML code comments
UserExportFile	String	Path to export file where all source and target servers' users will be exported. Users are exported only if is set to .	missing XML code comments
WIQLQuery	String	WIQL (Work Item Query Language) query used to select the work items from which user information should be extracted.	missing XML code comments

Examples

sample

This is an example of what your config might look like once configured.

    There is no sample, but you can check the classic below for a general feel.
    

defaults

These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.

    There are no defaults! Check the sample for options!
    

classic

We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.

    {
  "$type": "TfsExportUsersForMappingProcessorOptions",
  "Enabled": false,
  "WIQLQuery": null,
  "OnlyListUsersInWorkItems": true,
  "ExportAllUsers": false,
  "UserExportFile": null,
  "SourceName": null,
  "TargetName": null
}