Enable TestOps - Jira integration for test management (Legacy)

Attention

This document covers TestOps Legacy version only.

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

Follow the steps to configure and enable TestOps - Jira integration in Katalon TestOps.

1. Sign in to Katalon TestOps and go to your project.
2. In the Dashboard, select Settings > Integrations.
   The Integrations page appears. Expand the menu to the left in the page for a full list of integration options.
3. Select Jira by typing it in the search bar or by clicking ALM & Test Management and then selecting Jira/Xray.

   

4. Enter your 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 check if the connection is successful.
   
6. Link your Jira project by selecting it from the drop-down menu. This step is required as this is the source from where your tickets will be fetched.
   Note:

   • You can click Refresh Data if your projects are not showing or if you want to fetch your data again.

7. Click Save.

A pop-up notification at the upper right corner will confirm that you have connected to Jira. 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 are the Owner or Administrator of your organization

Utilizing a Jira WebHook enables the automatic synchronization of Jira issue lifecycle changes with the Katalon Platform in real time. This automation eliminates the need for manual user intervention, thus facilitating a seamless integration between Jira and the Katalon Platform.

1. In TestOps, go to Settings > Integrations > Jira/Xray. Click on the WebHook tab.
   
2. Select Create WebHook and input your WebHook name. The label "Sample WebHook" is used as shown in the image below.
3. Click Create.
4. A WebHook URL is generated. Click Copy.
5. Open your Jira portal, go to Jira Settings > System > WebHooks > Create a WebHook. Paste the WebHook URL from TestOps into the URL field.
6. Set up Jira events scope for the Webhook by selecting the following items under the Issue column: created, updated, deleted.
   Uncheck the Exclude Body option:
7. Click Create.

You have successfully created a JIra WebHook.

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.

Configure installed Jira projects

Enabling the Katalon - Test Automation plugin on Jira shows the Katalon Manual Tests (Beta) feature and a section for Katalon Platform's tests by default in all Jira projects. This can be reconfigured to be hidden instead.

• You have installed the Katalon - Test Automation plugin. To learn how to install a marketplace app, see: Atlassian's guide.

• You must be a Jira system administrator.

Some users may prefer to hide the Katalon - Test Automation plugin's features in certain Jira projects.

To do so, follow these steps:

1. Log in to your Jira account.
2. Click on Apps at the top menu bar.
   1. Select the Katalon plugin.
      
   This brings you to the Project Configuration page.
3. Tick on the projects you would like to modify.
   1. Select either Enable Katalon for Jira or Disable Katalon for Jira depending on which setting you prefer.
   

You have successfully configured your Katalon - Test Automation plugin to be hidden in selected Jira projects.