Skip to main content

Creating Jira Issues (Custom Integration)

Note: QA Sphere provides a native Jira integration which offers enhanced features and a more streamlined experience. This custom integration method should only be used in specific cases where the native integration cannot be used.

QA Sphere allows you to integrate with Jira using the Custom Issue Tracker feature as an alternative to the native integration. This integration enables you to create Jira issues directly while going through test cases in a test run.

Configuring Jira as a Custom Issue Tracker​

To integrate Jira using the custom issue tracker feature, 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. You'll be presented with a form to configure your Custom Issue Tracker. Fill it out as follows:

    • Issue Tracker Name: Enter "Jira" or a name of your choice.
    • New Issue Link: Enter the URL for creating a new issue in your Jira project. For example: 
      https://your-domain.atlassian.net/secure/CreateIssue.jspa?pid=[YOUR_PROJECT_ID]
    • Title Extraction Rule: Enter the rule that matches your Jira issue URL structure. For example: 
      https://your-domain.atlassian.net/browse/[YOUR_PROJECT_ID]-$(id:num)

  6. Click Save to add the Jira integration.

Understanding Title Extraction Rule​

The Title Extraction Rule helps QA Sphere pre-fill the Issue Title based on the URL. For Jira, you'll want to use $(project) and $(id:num) as Jira uses a combination of project key and numeric ID (e.g., "PROJ-123"). The rule you enter should match the structure of your Jira issue URLs.

Finding Your Project ID​

To find your Jira Project ID:

  1. Navigate to your project in Jira
  2. The Project ID can be found in the URL when viewing project settings
  3. Alternatively, you can use the Jira API to get a list of your projects and their IDs

Using Jira Custom Integration​

To create a Jira 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 Issue.

A new browser tab will open with the Jira issue creation page. The issue details will be pre-filled based on your extraction rule.

Complete the issue details in Jira and submit the issue. Once created, you can copy the issue URL and paste it back into QA Sphere to link the issue to your test case.

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

Comparison with Native Integration​

The custom integration has some limitations compared to the native Jira integration:

  • No automatic issue status synchronization
  • Limited field mapping capabilities
  • Manual URL copying required
  • No direct access to Jira issue types and fields

Consider using the native Jira integration unless you have specific requirements that necessitate using the custom integration.

Benefits of Custom Jira Integration​

Despite the limitations, the custom integration still offers several benefits:

  • Flexibility: Can be used when native integration requirements cannot be met
  • Simplicity: No API tokens or complex configuration required
  • Accessibility: Works with any Jira instance you can access via browser
  • Quick Setup: Can be configured in minutes without administrative access

Troubleshooting​

If you encounter any issues with the integration:

  1. Double-check that your New Issue Link is correct and includes the proper Project ID.
  2. Ensure your Title Extraction Rule correctly matches your Jira issue URL structure.
  3. Verify that you have the necessary permissions in your Jira instance.
  4. Make sure you're logged into Jira in your browser for seamless issue creation.

For further assistance, contact your QA Sphere administrator or support team at [email protected].