areaPath

This configuration section contains settings to configure how the test case area path field should be updated.

Read more about the setting the area path and iteration path fields in the Add new test cases to an Area or an Iteration concept description.

The following example shows the available options within this sub-section.

{
  ...
  "synchronization": {
    ...
    "areaPath": {
      "mode": "setOnLink",
      "value": "\\MyArea"
    },
    ...
  },
  ...
}

The areaPath setting is a shortcut for configuring the synchronization/fieldUpdates section. The example above is equivalent to the following fieldUpdates setting:

{
  "synchronization": {
    "fieldUpdates": {
      "System.AreaPath": {
        "value": "project-name\\MyArea",
        "update": "onCreate"
      }
    }
  },
}

Settings

Setting	Description	Default
mode	Specifies how the area path of the test case should be updated. Available options: notSet and setOnLink. (Default: notSet) notSet: the path is not set setOnLink: set the path when the test case created and linked to the scenario, but not to update later on.	notSet
value	The area path to set for test cases (e.g. \\MyArea). The project name prefix can be omitted.	mandatory for mode setOnLink

synchronizationConfiguration reference