Enable TestOps - Jira integration for test management

Katalon TestOps provides a seamless Jira integration that allows you to:

• Link Jira requirements and Jira defects

• Link test runs to Jira releases

• Write BDD scenarios in Jira tickets

• View test results from linked Katalon Studio test cases in Jira

This article shows you how to configure Jira integration in Katalon TestOps.

Requirements

• In Jira, install this plugin from the Atlassian Marketplace website: Katalon Studio and TestOps integration.

• You must be the Owner or Admin of the Account.

Enable TestOps - Jira integration in Katalon TestOps

You can configure TestOps - Jira integration in Katalon TestOps.

1. Sign in to Katalon TestOps and go to your project.
   The project Dashboard page appears.
2. Select Configuration > Integration.
   The Integrations page appears. There is a dropdown menu on the page for a full list of integration options.
3. Select Jira in the dropdown menu.
   The Jira page appears as below.

   

4. Enter Jira URL, Username, and Password.

   For Jira Cloud:

   • Jira URL must be in the form of https://<site_name>.atlassian.net.

   • In the Username section, enter the email address you have registered for your Jira Cloud account.

   • In the Password section, enter an Atlassian Cloud's API token. See instructions for API tokens in the Atlassian document: API tokens.

   For Jira Server:

   • Jira URL must be in the form of http(s)://domain, without any trailing parts. For example, /secure.

   • In the Username section, enter your Username instead of your email address.

   • In the Password section, enter your Password.

5. Click Test Connection to see if the connection is successful.
6. Click Save.

You have successfully enabled TestOps - Jira integration in Katalon TestOps. You can now link test cases to Jira requirements, Jira defects or link test runs to Jira releases.

Create webhook for TestOps - Jira integration

• You must be the Owner or Administrator of your organization

We use Jira webhook to notify Katalon Platform when specific events happen in Jira. For instance, Jira can alert Defect Reports when a defect-linked Jira issue's status or priority is updated. By using a webhook, Jira issue lifecycle changes can be reflected on Katalon Platform in real-time without any manual intervention from users. This allows for seamless and efficient coordination between Jira and Katalon Platform, providing users with up-to-date information without any delay.

1. On TestOps, go to Configurations > Integrations > Jira/Xray, scroll down to Webhook.
   If you don't see the Webhook section, set up Jira integration first.
2. Select Create Webhook, and copy the Webhook URL.
3. Open your Jira portal, go to Jira Settings > Webhook > Create a Webhook. Paste the Webhook URL from TestOps to the URL field.
4. Set up Jira events scope for the Webhook by selecting Issue: created, updated, deleted.
   Uncheck the Exclude Body option: Finally, select Create at the bottom of the screen.

The Jira Webhook is created successfully.

Enable TestOps - Jira integration in Jira software

You can configure TestOps - Jira integration for test management in Jira. This configuration allows you to write BDD scenarios in Jira tickets and view test results from linked Katalon Studio test cases in Jira.

• This integration is only available for Jira Cloud.

To enable TestOps - Jira integration in Jira software, follow these steps:

1. Open your Jira projects. Your Jira page name follows the following syntax: <sitename>.atlassian.net.
2. At the bottom of the left panel, click Project settings.
3. Scroll down the left panel, expand the App section and select Katalon Settings. The Katalon settings page appears as below.
   
4. Fill in the information as follows:

   • Email: Enter the email address you have registered for your Katalon account.

   • API Key: Enter a TestOps API key. To learn more about generating a TestOps API key, you can refer to this document: Katalon API Key in Katalon TestOps.

5. Click Fetch organizations, then select your organization from the dropdown list.
6. Click Save.

You have successfully enabled TestOps - Jira integration in Jira software. You can now write BDD test cases in Jira tickets or view test results in Jira tickets and gadgets.