jira

This configuration section contains settings to configure the Jira Test Case Management (TCM) solution.

The following example shows the most common options within this section.

{
  ...
  "jira": {
    "tcmSolution": "JiraTcmCustomization",
    "customStepsField": {
      "field": {
        "name": "Steps To Complete"
      }
    },
    "testCaseIssueType": {
      "name": "Test Case"
    },
    "testsLinkName": "tests"
  },
  ...
}

Settings

Setting	Description	Default
jiraProduct	Jira Software product you connect to. Available values: Cloud, DataCenter	automatically detected from the server URL
tcmSolution	The Test Case Management (TCM) customization solution of the Jira project. Available values: JiraTcmCustomization, ZephyrScale	mandatory
testCaseIssueType	The Jira Issue Type used for storing Test Cases.	mandatory for JiraTcmCustomization TCM
customStepsField	Specifies details about how Test Case steps are synchronized to a custom multi-line text field. customStepsField/field/name — The name of the field customStepsField/field/id — The ID of the field	mandatory for JiraTcmCustomization TCM
testsLinkName	The name of the link type used for describing that a Test Case tests a particular requirement. Usual values are tests or tested with	tests

Example: Typical configuration for Jira TCM Customization

{
  "remote": {
    "serverUrl": "https://specsyncdemo.atlassian.net/",
    "project": "MyCalculator",
  },
  "jira": {
    "tcmSolution": "JiraTcmCustomization",
    "customStepsField": {
      "field": {
        "name": "Steps To Complete"
      }
    },
    "testCaseIssueType": {
      "name": "Test Case"
    }
  },
  ...
}

Example: Typical configuration for Zephyr Scale

{
  "remote": {
    "serverUrl": "https://specsyncdemo.atlassian.net/",
    "project": "MyCalculator",
  },
  "jira": {
    "tcmSolution": "ZephyrScale"
  },
  ...
}

Configuration reference