Field Literal Map

Maps a literal (static) value to a target field, useful for setting constant values across all migrated work items.

Last updated: June 25, 2025 | Edit this page | Discuss this page

Maps a literal (static) value to a target field, useful for setting constant values across all migrated work items.

top

Options

Parameter 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
targetField String Gets or sets the name of the target field that will be set to the specified literal value. missing XML code comments
value String Gets or sets the literal value that will be assigned to the target field during migration. missing XML code comments
top

Samples

top

Sample

Sample

{
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "FieldMappingTool": {
        "FieldMaps": [
          {
            "FieldMapType": "FieldLiteralMap",
            "ApplyTo": [
              "SomeWorkItemType"
            ],
            "targetField": "Custom.SomeField",
            "value": "New field value"
          }
        ]
      }
    }
  }
}
top

Defaults

Defaults

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

Classic

Classic

{
  "$type": "FieldLiteralMapOptions",
  "targetField": "Custom.SomeField",
  "value": "New field value",
  "ApplyTo": [
    "*",
    "SomeWorkItemType"
  ]
}
top

Metadata

Project Information
Azure DevOps Marketplace
YouTube Channel
Maintainer

Created and maintained by Martin Hinshelwood of nkdagility.com

Documentation Versions
Production Azure DevOps Migration Tools Release Version
Preview Azure DevOps Migration Tools Preview Version
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