Articles in this section

See more

Applitools Eyes Jira integration

Avatar
Yarden Naveh
  • Updated

In this article we will learn how to create a new Jira issue directly from the Applitools Eyes test result

There are three main steps in the process

  1. Retrieve Jira project details

  2. Configure Applitools and Jira server

  3. Create a new Jira issue directly from the Applitools Eyes test result.

Retrieve Jira project details (pid and issueType) from Jira dashboard

  1. Open JIRA dashboard

  2. ​(Top-Right corner) JIRA Administration -> Projects

  3. Click on the project you wish to connect

  4. Click on Details and grab the PID from the URL and put it in Applitools settings

  5. Click on Bug (example issue type) and grab the issuetype ID from the URL and put it in Applitools settings

 

Configure Jira next-gen:

Step 1: go to https://<YOUR_JIRA_SERVER>/rest/api/3/project/
 
Step 2: in the JSON, search for the project and find its ID field
 
Step 3: go to https://<YOUR_JIRA_SERVER>/rest/api/3/project/<PROJECT_ID>
 
step 4: in the JSON note the IDs of the issue types that you’d like to use
 
Set the extracted values in the issuetype text box in applitools admin panel.
 

Configure Applitools and Jira server

The first step is to set up the integration between Applitools Eyes and Jira:

To enable the integration, navigate to Admin panel and locate your team.

Under the Jira section, enable the integration and enter the following details:

  1. JIRA Server URL

  2. pid (Project ID) - in which new issue will be created

  3. issuetype - id of the type of issue you create as defined in your Jira project


Optionally - adding custom issue fields can be achieved by clicking on the add button, use the dropdown to select built in fields or directly type the name of custom fields in the text box.



To learn more about how to identify Jira issue fields and theirs possible values read the link.

# You can click the preview link at any time to test your configuration.


 

If your team is developing different application that required different Jira settings click the "Add application specific settings" button to add an application specific configuration that will override the default one.

Once you are done click the save button to save the configuration.

After the integration is configured , you can easily create Jira issues directly from Applitools Eyes issue regions.


For example: Create a "missing" issue :

To create a matching Jira issue , click the "Create new Jira issue" which open the Jira create issue form in a new tab with the details of the issue, the test and any others fields you configured in the Admin panel.




At this point if you are ready to create the Jira issue, you can click on the create button.

The resulting Jira issue includes:
* The name of the test
* The batch name
* The steps description
* The created time
* The execution environment details
* And any custom properties you define for the test.

Clicking the "View in Applitools Eyes" open the corresponding Applitools Eyes issue when you can zoom in on changes, see the issue in the context of the entire UI page and compare it with the baseline.



You can also linked the new Jira issue with your Applitools Eyes issue by entering its id in the "Link in Jira issue" - this will allow you to load the Jira issue by clicking the "View in Jira" button directly from the issue region.


If needed you can replace the current link of Jira issue with another or disconnect an existing link.

 
 

Related articles