FieldMaps : FieldValueMap

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.

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

Options

Parameter name	Type	Description	Default Value
ApplyTo	List	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.	missing XML code comments
defaultValue	String	Gets or sets the default value to use when no mapping is found for the source field value.	missing XML code comments
sourceField	String	Gets or sets the name of the source field to read values from during migration.	missing XML code comments
targetField	String	Gets or sets the name of the target field to write mapped values to during migration.	missing XML code comments
valueMapping	Dictionary	Gets or sets the dictionary that maps source field values to target field values. Key is the source value, value is the target value.	missing XML code comments

Examples

sample

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

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

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.

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

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": "FieldValueMapOptions",
  "sourceField": "System.State",
  "targetField": "System.State",
  "defaultValue": "StateB",
  "valueMapping": {
    "StateA": "StateB"
  },
  "ApplyTo": [
    "*",
    "SomeWorkItemType"
  ]
}