Configure your Test Modeller workspace for JIRA X-Ray

Watch the video below to learn how to configure your Test Modeller workspace for your instance of JIRA X-Ray.

Inside of Test Modeller, navigate to ProfileConnectors. Click Add Connection to start the connection wizard.

Details Tab

Under the details tab, select Xray (JIRA Cloud) - Tests as the Connector Type. Then, give your connection profile a name. You’ll add in more details under the Connection tab later after creating a Project Key.

Connections Tab

Under the connections tab, provide the following information:

  • URL - this is your the URL for your Jira Instance

  • Jira Username

  • Jira API key - please see instructions below

  • Project Key - please see instructions below

  • Xray Client ID - please see instructions below

  • Xray Secret Key - please see instructions below

Create a Jira API Key

Inside of Jira, navigate to your Profile and Account Settings.

Then navigate to Security and Create and Manage API Tokens.

Click Create a New API Token and follow the instructions to generate the token. Copy and paste this token into Test Modeller under Jira API key.

Create a Xray Client ID and Secret Key

Inside of Jira, navigate to SettingsApps.

On the left hand side of the application list, there is a section for Xray. Under Xray, there is a section called API Keys. Click Create API Key to generate a Client ID and Client Secret Key.

Select a Project Key

Once the credentials and API keys have been provided, you can then select the project you’d like to use. Inside of Test Modeller, select the project you’d like to connect to from the Project Key dropdown.

Click Validate to ensure the connector is working properly. A success panel will show in the upper right hand corner.

Field Mappings Tab

In the field mappings tab you can select the fields that map between Test Modeller and Xray’s Issue Fields and Test Step Fields.

The Refresh button will populate any fields that are present inside of Xray, and any custom fields. The minimum information needed for an Issue is the Summary and Description. The value the fields are mapped to are selectable through the dropdown under Mapped Value.

Click Save once your fields are mapped.

Exporting to Jira

Inside of Test Modeller, open up a model. Add a New profile underneath Test GenerationProfile. Name the Profile Xray Tests and click save.

Continuing in Test Modeller, click the Plane icon to Generate Paths.

With the Paths generated, click the blue view arrow in the Test Cases pane to preview to pop-up the Export Test Suite settings. In the setting select the Connector Profile from the dropdown. You can define a Relationship is needed and a Parrent (Key) for the tricket. Of the many Relationahip Types you can select Disabled and the hit Export.

You can Show Log as the job is processing to see information and prcoess as the export is being undertaken, which also can be downloaded. Remember to hit the close button.

Now, next to each test a link icon appears. Don’t click that link, but instead click the cog icon and in the context menu choose Links. This pops up the Test Links box and displays a clickable link which can be opened up.

Inside of the Xray ticket, we can see the number of steps, the step name, step description and the expected result. The steps are available to view in detail using the Xray plugin.