Jira is an issue-tracking platform by Atlassian. With the Jira integration, you can connect a Ranorex Studio solution to a Jira project.
After the integration is configured, Ranorex Studio can automatically create and update Jira issues, or you can create issues manually for failed test cases directly from a test report.
This article explains how to set up the integration with the Jira wizard, how manual and automatic issue handling work, and how to configure required, optional, and custom fields.
Set up the Jira integration with the Jira wizard
To set up the integration, use the Jira wizard in Ranorex Studio.
To start the wizard:
- With a solution open in Ranorex Studio, click Tools > Jira integration > Start Jira wizard.
- The wizard opens with the Connect to Jira screen.
To connect to Jira Cloud, enter your Jira URL, email address, and API token. Click Sign in.
Note: Your credentials will be saved in the Windows Credential Manager on this machine. Deleting them is explained further below.
- After signing in successfully, click Continue.
- If you want to activate manual issue handling, switch on Enable issue buttons in report and select the type of issue that should be created by default.
- Click Continue.
- To activate automatic issue handling, switch on Enable automatic handling and select the default issue type and open/closed states. Click Finish to complete setup.
Jira Configuration File
After you complete the integration with the Jira wizard, you can configure additional Jira options.
These settings are saved in the Jira.jsd configuration file, which is stored in the Solution Items folder. This file contains the information required for the Jira integration.
To open the configuration file:
Click Tools > Jira integration > Configure integration.
The Configure Jira Integration opens in the projects view under the Jira.jsd.
The configuration screen contains two tabs:
- Manual issue handling
- Automatic issue handling
In both tabs, you can specify default values for various fields. Ranorex Studio uses these values either when you create an issue manually from the report or when it creates and updates issues automatically.
Manual issue handling
In the Manual issue handling tab, you can define the default values used when creating issues manually from the report.
Variable editor: Click [x] to open the variable editor dialog box. It lists the available variables and their descriptions.
When manual issue handling is enabled, the test report includes a Create Jira issue button next to each failed test case.
Clicking this button opens the linked Jira project and the dialog for creating a new issue. The default issue type is the one selected in the Jira wizard or in the Jira integration configuration. You can also enter values for other Jira issue fields before creating the issue.
Automatic issue handling
In the Automatic issue handling tab, you can configure Ranorex Studio to create and update Jira issues automatically for test cases.
Automatic issue creation and updating works as follows.
For example, suppose the issue type is set to Bug, the open state is set to To do, and the closed state is set to Done.
If a test case fails:
- Ranorex Studio creates a new Jira issue and sets it to the open state.
- If an open issue with the same test case tag already exists, no new issue is created.
- If a closed issue with the same test case tag exists, Ranorex Studio reopens the issue and sets it to the open state.
By default, the issue summary is the test case name, and the description contains the unique test case tag used by Ranorex Studio for identification. Ranorex Studio also attaches the test report automatically.
If a test case succeeds:
- No issue is created.
- If an issue with the same test case tag exists, Ranorex Studio sets its state to the configured closed state.
Note: Automatic issue handling identifies issues by the test case tag. This also works for manually created issues, as long as the tag is included. If you later enable automatic issue handling, Ranorex Studio can continue updating those issues automatically.
Attention: For automatic issue handling to work, at least one field, such as Description, must contain the variable $TestCaseTag. Otherwise, Ranorex Studio cannot identify and update issues automatically.
You can identify the field type by hovering over the field with the mouse pointer.
Upload Attachments
You can include attachments in Jira issues.
To add attachments:
- Click Add Files.
- In the dialog that opens, select the files you want to include.
The selected files are listed in the Attachments section. To remove an attachment, click the trash bin icon on the right of the file path.
Some field types cannot be configured automatically. These fields must be filled in manually when you create an issue from the report. For automatic issue handling, these fields remain empty unless you update the issue manually later in Jira.
Jira Custom Fields
Ranorex supports Jira custom fields.
If the selected Jira project contains custom fields, they are displayed in the Jira integration configuration.
For dropdown custom fields, you can select a value in Ranorex Studio. Other custom field types are also displayed, but their values cannot be changed in Ranorex Studio.
Sign out
Signing out removes the saved Jira credentials from the current machine. The credentials are stored in the Windows Credential Manager.
To sign out:
- In Ranorex Studio, click Tools > Jira integration > Sign out.
- Confirm the dialog.
Remove connection to Jira
Removing the Jira connection deletes the Jira.jsd file. All Jira integration settings are lost.
To remove the connection:
- In Ranorex Studio, click Tools > Jira integration > Remove connection to Jira.
- Confirm the dialog.
Note: When a Jira connection is started, you can switch projects that are under the same connection. You need to sign out to remove the credentials. Selecting Remove connection to Jira only deletes the Jira.jsd file and its configuration settings. The saved Jira credentials remain in the Windows Credential Manager until you sign out.