Tfs Export Users For Mapping Processor

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

Last updated: September 10, 2025 | Edit this page | Discuss this page

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

top

Options

Parameter
Type
Required
Description
Default Value
Parameter:
Enabled
Type:
Boolean
Required:
true
Description:
If set to true then the processor will run. Set to false and the processor will not run.
Default:
missing XML code comments
Parameter:
Enrichers
Type:
List
Required:
false
Description:
List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.
Default:
missing XML code comments
Parameter:
ExportAllUsers
Type:
Boolean
Required:
false
Description:
Set to true, 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 UserExportFile.
Default:
missing XML code comments
Parameter:
OnlyListUsersInWorkItems
Type:
Boolean
Required:
false
Description:
OnlyListUsersInWorkItems
Default:
true
Parameter:
RefName
Type:
String
Required:
false
Description:
Refname will be used in the future to allow for using named Options without the need to copy all of the options.
Default:
missing XML code comments
Parameter:
SourceName
Type:
String
Required:
true
Description:
This is the IEndpoint that will be used as the source of the Migration. Can be null for a write only processor.
Default:
missing XML code comments
Parameter:
TargetName
Type:
String
Required:
true
Description:
This is the IEndpoint that will be used as the Target of the Migration. Can be null for a read only processor.
Default:
missing XML code comments
Parameter:
UserExportFile
Type:
String
Required:
false
Description:
Path to export file where all source and target servers’ users will be exported. Users are exported only if ExportAllUsers is set to true.
Default:
missing XML code comments
Parameter:
WIQLQuery
Type:
String
Required:
false
Description:
WIQL (Work Item Query Language) query used to select the work items from which user information should be extracted.
Default:
missing XML code comments
top

Samples

top

Sample

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

Defaults

There are no defaults! Check the sample for options!
top

Classic

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

Metadata

top

Schema

This is the JSON schema that defines the structure and validation rules for this configuration.

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://devopsmigration.io/schema/schema.processors.tfsexportusersformappingprocessor.json",
  "title": "TfsExportUsersForMappingProcessor",
  "description": "ExportUsersForMappingContext is a tool used to create a starter mapping file for users between the source and target systems.\r\n Use `ExportUsersForMappingConfig` to configure.",
  "type": "object",
  "properties": {
    "Enabled": {
      "description": "If set to `true` then the processor will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "Enrichers": {
      "description": "List of Enrichers that can be used to add more features to this processor. Only works with Native Processors and not legacy Processors.",
      "type": "array"
    },
    "ExportAllUsers": {
      "description": "Set to `true`, if you want to export all users in source and target server.\r\n The lists of user can be useful, if you need tu manually edit mapping file.\r\n Users will be exported to file set in `UserExportFile`.",
      "type": "boolean"
    },
    "OnlyListUsersInWorkItems": {
      "description": "`OnlyListUsersInWorkItems`",
      "type": "boolean",
      "default": "true"
    },
    "RefName": {
      "description": "`Refname` will be used in the future to allow for using named Options without the need to copy all of the options.",
      "type": "string"
    },
    "SourceName": {
      "description": "This is the `IEndpoint` that will be used as the source of the Migration. Can be null for a write only processor.",
      "type": "string"
    },
    "TargetName": {
      "description": "This is the `IEndpoint` that will be used as the Target of the Migration. Can be null for a read only processor.",
      "type": "string"
    },
    "UserExportFile": {
      "description": "Path to export file where all source and target servers' users will be exported.\r\n Users are exported only if `ExportAllUsers` is set to `true`.",
      "type": "string"
    },
    "WIQLQuery": {
      "description": "WIQL (Work Item Query Language) query used to select the work items from which user information should be extracted.",
      "type": "string"
    }
  },
  "required": [
    "enabled",
    "sourceName",
    "targetName"
  ]
}
Project Information
Azure DevOps Marketplace
YouTube Channel
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Getting Support
Community Support
Questions & Discussions

The first place to look for usage, configuration, and general help.

Commercial Support

We provide training, ad-hoc support, and full service migrations through our professional services.

Azure DevOps Migration Services
Documentation