FieldMaps : TreeToTagFieldMap

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 work item area path or iteration path hierarchies to tags, allowing tree structures to be represented as flat tag collections.

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
timeTravel	Int32	Gets or sets the number of months to travel back in time when looking up historical area path values. Use 0 for current values.	missing XML code comments
toSkip	Int32	Gets or sets the number of levels to skip from the root when converting area path hierarchy to tags. For example, if set to 2, "ProjectName\Level1\Level2\Level3" would skip "ProjectName\Level1" and start from "Level2".	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.

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "FieldMappingTool": {
        "FieldMaps": [
          {
            "FieldMapType": "TreeToTagFieldMap",
            "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": "TreeToTagFieldMapOptions",
  "toSkip": 0,
  "timeTravel": 0,
  "ApplyTo": [
    "*"
  ]
}