Jira integration

This document shows you how to create an integration for Jira within Katalon TestOps.

requirements

To set up Jira integration, the Account Admin or System Admin must first connect a Jira account or organization, and then link the desired projects to TestOps. Go to Roles for more information.

Connect a Jira account to TestOps

You must have the Account Admin or System Admin role to perform this action.

To set up the connection:

1. Go to Admin Settings. (You can find Admin Settings in the upper right corner of the page.)
2. Navigate to System > Integrations, then click + Create Integration.

3. In the Available Integration list, choose Jira.

   ✅ A green check mark indicates that the integration is currently available.

   

4. Fill in the required fields to establish the connection.

   • Integration Name: A custom name for the integration (max 50 characters).
   • Organization URL: The Jira Organization URL.
     • Example: https://katalon-product-demo.atlassian.net
     • Must start with https://
   • Personal Access Token (PAT): Enter your Jira PAT. To generate a PAT, refer to this documentation. Please make sure the PAT has required permissions.
   • Description (Optional): Brief description of the integration (max 255 characters).

   🔁 Service Hooks will be automatically created at the project level for real-time syncing and automation.

5. Click Test Connection to validate the integration.
6. Once validated, click Save, or click Cancel to exit without saving any changes.

Result

To verify if the connection is active, navigate to Admin > System > Integrations. Your Jira integration will be listed under the Integration list.

• If the status initially shows as Inactive, reload the page to update the status to Active.
• If the status shows Error, verify all required configuration fields, especially the Personal Access Token (PAT), and confirm it is valid and configured correctly in the account-level integration.

Configure Jira integration at Project level

warning

Once an Account Admin or System Admin sets up the Jira connection, only Project Admin can configure project-level settings by linking specific repositories, branches, or directories to Katalon TestOps.

1. Navigate to your specific project's UI > Settings > Integrations.

2. Click the right edge of your linked connection and select New configuration (Setting icon).

3. Fill in the required fields:

   Step 1: Select the Project and Board

   • Project: Select the Jira Project to link from the dropdown list. This defines which work items will be synced to Katalon TestOps.
   • (Optional) Board: Select a board to link to enhance collaboration.
   • (Optional) Description: Brief description of the linked project (max 255 characters).
   
   

   Step 2: Additional integration settings

   This section helps you customize synchronization between Katalon TestOps and Jira for streamlined traceability across test cases, requirements, and bugs.

   • Tick on Pull Requirements (enable generation of test cases from requirements and links requirements with test cases for traceability) to enable this feature.
   • Tick on Bug Mapping (Pull bugs from Jira) to enable this feature.
   
   
   notes

   Ticking on either feature will enable/disable the corresponding section in the next steps.

   
   

   Step 3: Release and Sprint Mapping

   note

   This step is enable only if Pull Requirements and/or Bug Mapping is selected (Step 2)

   In this step, you define how Release and Sprint data will be mapped from your Jira project.

   Note: Sprint will be disable if no board is selected (Step 1).

   
   

   Step 4: Common Fields and Values Mapping

   notes

   This step is enable only if Pull Requirements and/or Bug Mapping is selected (Step 2)

   This section allows you to map priority for effective issue prioritization and resource allocation, ensuring clear prioritization based on urgency (e.g., High, Medium, Low). Consistent mapping helps maintain workflow efficiency and prevents misalignment that could lead to inefficiencies.

   Map Jira Priority levels your chosen TestOps Priority levels based on your workflow.

   
   

   Step 5: Requirement Fields and Value Mapping

   notes

   This step is enable only if Pull Requirements and/or Bug Mapping is selected (Step 2)

   This section allows you to select up to three date fields to set the Release Date, with the system using the first available date in your order of selection. You can also set an Jira State's equivalent TestOps Status.

   • Release Date for Requirement (Optional): Select three Jira fields as potential sources for the release date of a requirement. These fields are used in a priority order (left to right) to determine the release date:

     • Field 1 (e.g., Fix Version Date): This is the highest priority field. The system will first check if this date is available for the work item. If it is, this will be used as the release date.
     • Field 2 (e.g., Sprint End Date): If Field 1 is not available or empty, the system will fall back to this second-priority field to determine the release date.
     • Field 3 (e.g., Resolved Date): If both Field 1 and Field 2 are unavailable, the system will use this third-priority field as the release date.

   • Map Jira Status to your chosen TestOps State

   • Work Item Types: Select Jira Work Item Types to be synced.

   
   

   Step 6: Bug Fields and Values Mapping

   notes

   This step is enable only if Pull Requirements and/or Bug Mapping is selected (Step 2)

   This section allows you to map the fields and values of bugs to the corresponding fields and values in Katalon TestOps.

   • Map Jira Severity levels to your chosen TestOps Severity levels based on your workflow.

   • Map Jira Status levels to your chosen TestOps Status.

   • Select either Jira Resolution or Jira Status to your chosen TestOps Status.

   
   

4. Click Proceed to sync data and finalize the connection.

   • If the status initially shows as Inactive, reload the page to update the status to Active.
   • If you modify the connection details and click Save, your changes will be saved, but the status may remain Inactive. To sync data and finalize the connection, click Proceed.

5. [Optional] To edit an existing linked Jira integration, click the Edit (pen) icon, make the necessary changes, and click Proceed. After editing, reload the page to ensure data is refreshed.

Result

Your Jira integration is now active within your project.

View release plans synced from linked Jira Integration

To view release plans synced from linked Jira integration:

1. Navigate to your specific project's UI > Plans.
2. In the top-right dropdown menu, select the linked Jira integration.
3. Click the Sync button next to the selected integration to fetch the latest data.

Archive a linked Jira integration

You must have the Project Admin role to perform this action.

info

When an integration is archived:

• The status changes to Archived.
• The integration no longer appears in the Plans module.

To archive a linked Jira integration:

1. Navigate to your specific project's UI > Settings > Integrations.

2. Hover over the right edge of your linked repository and click the Archive icon.
   

3. A confirmation dialog will appear. Click Archive if you want to move forward.
   

Unarchive a linked Jira integration

You must have the Project Admin role to perform this action.

info

After you unarchive an integration:

• The status might appear as Inactive. Reload the page to update it to Active.
• If the status shows Error, verify all required configuration fields and make necessary corrections.

To unarchive a linked Jira integration:

1. Navigate to your specific project's UI > Settings > Integrations.

2. Hover over the right edge of your linked repository and click the Unarchive icon.
   

3. A confirmation dialog will appear. Click Unarchive if you want to move forward.
   

Related topics

• View your Jira-synced Release timeline within TestOps

• View your Jira-synced Requirements or its details

• Learn about linkages to link requirements or test cases

• Generate test cases with AI