Skip to main content

Custom Issue Trackers Overview

QA Sphere provides flexible integration with virtually any issue tracking system through its Custom Issue Tracker feature. This guide explains how to configure custom issue trackers and provides examples for popular systems.

Configuring Custom Issue Trackers​

To integrate any issue tracker into QA Sphere, follow these steps:

  1. Go to Settings by clicking the gear icon Settings wheel in the top right corner.
  2. Select Issue Trackers from the left sidebar.
  3. A list of all available projects will be displayed. Click the + button next to the appropriate project to add integration.
  4. Choose Custom from the list of available integrations.
  5. Provide the required details:
    1. Issue Tracker Name - A name to identify your issue tracker integration.
    2. New Issue Link - The URL for creating new issues on your issue tracker. QA Sphere will offer an option to easily navigate to this page while testing.
    3. Title Extraction Rule - Allows QA Sphere to easily extract the issue identifier and title from its link.
  6. Click Add to complete the integration.
Adding Custom Issue integration

Capturing Groups and Title Extraction Rule​

The Title Extraction Rule in custom issue tracker configuration uses capturing groups to properly parse and store issue information. These rules help QA Sphere understand the structure of your issue tracker's URLs.

Basic Syntax​

The basic syntax for capturing groups includes:

  • $(id) - Captures any characters until the next delimiter
  • $(id:num) - Captures only numeric characters
  • $(title) - Captures the issue title
  • $(project) - Captures the project identifier

Examples of Capturing Groups​

  • Basic numeric ID - https://yourtool.com/issues/$(id:num)
  • Title and ID combination - https://yourtool.com/$(title)-$(id)
  • Project and issue number - https://yourtool.com/$(project)/issues/$(id:num)

Using Custom Issue Trackers​

Once configured, the Custom Issue Tracker integration enables you to link issues from your issue tracker to test case results in QA Sphere. To link an issue during testing:

  1. Within your project, navigate to the Test Runs section.
  2. Select an existing test run or create a new one.
  3. Choose a test case within the run.
  4. When changing the status of the test case, click + Add Custom Issues and select one of the following options:
    1. Link issue - Add a link to an existing issue in the issue tracker. QA Sphere will use the configured title extraction rule for the issue tracker to automatically populate the issue title, which can be updated if needed.
    2. Generate with AI - Use test case details and result comments to auto-generate an issue title and description with the help of AI. Use these details to manually create an issue in the issue tracker, then enter the corresponding URL in QA Sphere. QA Sphere will again use the configured title extraction rule for the issue tracker to automatically populate the issue title, which can be updated if required.

All issues linked to the test case will be saved under the Action History for this test run, providing a clear documentation trail.

note
  • AI issue generation may fail if there is insufficient context from the test case details and result comments to accurately determine the issue observed during testing.
  • AI issue generation is not available when batch-adding results for multiple test cases simultaneously.

Available Integration Examples​

We provide detailed configuration guides for many popular issue tracking systems:

Click on any of the links above to view detailed configuration instructions for that specific issue tracker.

Troubleshooting​

If your custom issue tracker integration isn't working as expected:

  • URL Structure: Verify that your New Issue Link is correct and accessible.
  • Extraction Rule: Ensure your Title Extraction Rule matches the actual URL structure of your issues.
  • Permissions: Check that you have the necessary permissions in both QA Sphere and the target issue tracker.
  • Special Characters: If issues contain special characters, ensure they're properly handled in your extraction rules.

For further assistance, contact QA Sphere support at [email protected].