Skip to main content

Manage BDD test cases with Jira integration

This article shows you how to configure Katalon BDD custom fields in Jira.


Create Katalon BDD fields in Jira

  • You must have the Jira admin access.

To create Katalon BDD fields in Jira, follow theses steps:
  1. From Jira settings, select Issues. In the Fields section, select Custom fields > Create custom field.
  2. Depending on your Jira products: Jira Cloud or Jira Data Center (Jira Server), you need to write your BDD scenarios in a different field type:
    • For Jira Data Center (Jira Server): Select Katalon Gherkin.

    • For Jira Cloud: Select Paragraph (supports rich text).

    This custom field lets you write descriptions for your test cases and stories in Gherkin syntax. Gherkin keywords such as Given, When, Then will be highlighted automatically.
  3. Click Next.
  4. In the new window, provide a name and a description (optional). Then click Create.
  5. Choose which screens to display and select Update to finish adding your new custom field.
    Choose display screens for custom BDD fields
You have successfully created a Katalon BDD custom field in Jira.

Enable the BDD custom field with the Katalon add-on

To enable the BDD custom field with the Katalon add-on, follow these steps:
  1. Open your Jira project.
  2. In the left panel, go to Project settings. Scroll down to the bottom and select Katalon BDD.
  3. Select the field you have created, then click Add.
  4. Select issue types to show this field with BDD editor.
    Add BDD custom fields with Katalon addon
  5. Click Save.

Write BDD scenarios in Jira tickets

With the newly added BDD custom fields, you can now write BDD scenarios in Jira tickets. To do so, follow these steps:
  1. Open a Jira issue.
  2. Click More (...), select Katalon BDD Fields.
  3. To edit content in Katalon BDD Field, click Edit (pencil icon) and write a Gherkin content. Make sure the content starts with Feature.
    Write BDD scenarios in Jira tickets
  4. Click Save (check icon).
You have successfully created a BDD test case in Jira.
Next, to import BDD test cases for execution in Katalon Studio, you need to configure Jira integration in Katalon Studio.