Getting started with Jira


How to set up the connection to your Jira instance
Access the preferences dialog from the main menu and fill out the required fields. After you are done, you can test the connection to your Jira account by hitting the “test connection” key.

Another way to set up your Jira connection is to open the webtestit.json file of your project and set the parameters in the jiraCredentials section.

    "host": "jira-sandbox",
    "issueType": "Task",
    "password": "",
    "projectKey": "WTP",
    "protocol": "http",
    "statusCompletedName": "Done",
    "statusToDoName": "To Do",
    "strictSSL": false,
    "username": ""

Regarding the “username” field, for Jira server edition, please use your Jira username.
Jira cloud uses your dedicated email address, as explained in this Atlassian Community post.

Regarding the password field, use your Jira account password for server edition. For Jira cloud edition requires an API Token to be created and used in the password field. To create an API Token follow these steps:

  1. Log in to

  2. Click Create API token

  3. From the dialog that appears, enter a memorable and concise Label for your token and click Create

  4. Click Copy to clipboard , then paste the token to your script, or elsewhere to save:

How Ranorex Webtestit is used with Jira
Test cases can only connect to one Jira issue at a time. The link information is stored next to test case as a comment, including all necessary information and can be edited if needed. The best thing is you don’t need to take care of this, just keep the comments in place and Ranorex Webtestit does everything for you.

If the comment is available, the report offers multiple actions:

  • Create Issue
    You can create new Jira issues once a test case failed. Therefore open the report and navigate to the failed test case, expand it and click the button “Create Issue”. Ranorex Webtestit does not create new Jira issues automatically in order not to spam your Jira project.

  • Show Issue in Browser
    After a test case is linked to a Jira issue, the report shows the button “Show Issue in Browser” which opens the Jira issue in your default browser.

  • Resolve Issue
    Next time the test case succeeds, the report lets you resolve the issue. Simply click the button “Resolve Issue” and the Jira issue gets closed with the completed status statusCompletedName defined in the webtestit.json file.
    Resolving the issue will not remove the link information (additional data) from the test case.

  • Reopen Issue
    Of course, it can happen that bugs show up again. If this is the case, the issue can be reopened by clicking the button “Reopen Issue” in the report. Please make sure that your Jira project supports this workflow transition.

Additional buttons:

As you’ve probably noticed on the screenshots above, we introduced more options. Wondering what’s that all about? The purpose was to help the users to make the testing process highly efficient and less time-consuming.

  • Jump to test case

    The user is now able to jump to the test-case containing the error directly from the stack trace. The test is opened in the editor and the line containing the error is highlighted and focused. This makes the debugging and the testing process itself faster and more efficient!

  • Run test in diagnostics mode

    We introduced the option to run tests in diagnostic mode which helps the user with debugging of tests by keeping the browser open after test execution. This way it is possible to analyze the failing test and explore the status of the application under test at specific test steps.

JIRA parameters shall be grouped
Get started with JIRA documentation is not opened when link in Report window is clicked
unlisted #2