Field Value Map

Maps field values based on a lookup table, allowing specific source values to be translated to different target values.

Last updated: July 28, 2025 | Edit this page | Discuss this page

Maps field values based on a lookup table, allowing specific source values to be translated to different target values.

top

Options

Parameter
Type
Description
Default Value
Parameter:
ApplyTo
Type:
List
Description:
A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use “*” to apply to all Work Item Types.
Default Value:
missing XML code comments
Parameter:
defaultValue
Type:
String
Description:
Gets or sets the default value to use when no mapping is found for the source field value.
Default Value:
missing XML code comments
Parameter:
Enabled
Type:
Boolean
Description:
If set to true then the Fieldmap will run. Set to false and the processor will not run.
Default Value:
missing XML code comments
Parameter:
sourceField
Type:
String
Description:
Gets or sets the name of the source field to read values from during migration.
Default Value:
missing XML code comments
Parameter:
targetField
Type:
String
Description:
Gets or sets the name of the target field to write mapped values to during migration.
Default Value:
missing XML code comments
Parameter:
valueMapping
Type:
Dictionary
Description:
Gets or sets the dictionary that maps source field values to target field values. Key is the source value, value is the target value.
Default Value:
missing XML code comments
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "FieldMappingTool": {
        "FieldMaps": [
          {
            "FieldMapType": "FieldValueMap",
            "ApplyTo": [
              "SomeWorkItemType"
            ],
            "defaultValue": "StateB",
            "sourceField": "System.State",
            "targetField": "System.State",
            "valueMapping": {
              "StateA": "StateB"
            }
          }
        ]
      }
    }
  }
}
top

Defaults

Defaults

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "FieldMappingTool": {
        "FieldMaps": [
          {
            "FieldMapType": "FieldValueMap",
            "ApplyTo": [
              "*"
            ]
          }
        ]
      }
    }
  }
}
top

Classic

Classic

{
  "$type": "FieldValueMapOptions",
  "sourceField": "System.State",
  "targetField": "System.State",
  "defaultValue": "StateB",
  "valueMapping": {
    "StateA": "StateB"
  },
  "ApplyTo": [
    "*",
    "SomeWorkItemType"
  ]
}
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.fieldmaps.fieldvaluemap.json",
  "title": "FieldValueMap",
  "description": "Maps field values based on a lookup table, allowing specific source values to be translated to different target values.",
  "type": "object",
  "properties": {
    "applyTo": {
      "description": "A list of Work Item Types that this Field Map will apply to. If the list is empty it will apply to all Work Item Types. You can use \"*\" to apply to all Work Item Types.",
      "type": "array"
    },
    "defaultValue": {
      "description": "Gets or sets the default value to use when no mapping is found for the source field value.",
      "type": "string"
    },
    "enabled": {
      "description": "If set to `true` then the Fieldmap will run. Set to `false` and the processor will not run.",
      "type": "boolean"
    },
    "sourceField": {
      "description": "Gets or sets the name of the source field to read values from during migration.",
      "type": "string"
    },
    "targetField": {
      "description": "Gets or sets the name of the target field to write mapped values to during migration.",
      "type": "string"
    },
    "valueMapping": {
      "description": "Gets or sets the dictionary that maps source field values to target field values. Key is the source value, value is the target value.",
      "type": "object"
    }
  }
}
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