Learn how to set up issue tracking in Jira for Rainforest tests.

Rainforest supports using Jira to automatically create a ticket when a test fails. This document walks through step-by-step instructions to set up your Jira integration.


Required Jira Fields

To post issues to Jira, you must enable the following fields for your project:

  • Issue Type
  • Summary Description

Note: No other fields can be marked as required.

Setting Up a Jira Integration with Rainforest

Configuring a Jira integration with Rainforest takes place in two phases:

  1. Set up a Rainforest Application link in Jira
  2. Configure Jira in Rainforest

Setting Up a Rainforest Application Link in Jira

Before you can set up Rainforest as an application link, you need Jira admin access. If you do not see application links in your Jira instance, contact your Jira admin to request access.

  1. From Jira’s main view, click the Settings icon (gear) and select “Products” in the modal.

Jira’s Settings modal.

  1. Click “Application links” in the left sidebar.

Selecting “Application links.”

  1. In the code sample below, click the clipboard icon to copy the URL.
  1. Click the Create new link button.
    Note: You might see an error stating, “No response was received from the URL you entered.” Ignore it and proceed with the configuration.
  2. Enter a name for the application, leave all other fields on the popup blank, and click Continue.

Enter an Application Name and select Continue.

  1. In the list of application links, click the pencil icon to the right of your link to edit.
  2. Select “Incoming Authentication.”
  1. In the code sample below, click the clipboard icon to copy the consumer key.
  1. Paste the key into the Consumer Key field and press Enter.
  2. Enter a consumer name.
  1. In the code sample below, click the clipboard icon to copy the public key.

-----END PUBLIC KEY-----
  1. Paste the key into the Public Key field and press Enter.
  2. Click the Save button.

Configuring Jira on the Rainforest Integrations Page

  1. Go to your Rainforest Settings > Integrations Page and start a new Test Failure integration.
  2. Enter the project key from your project (found in the Key column in the main Jira view).
  3. Key in your Jira project’s URL.

Jira test failure integration.

  1. In the OAuth Server URL field, key in the URL for your Jira project again.
  2. Click the Approve Access button.
    Note: You must be logged in as an administrator in Jira and Rainforest.
  3. Click the Allow button on the next page.
  4. On your Rainforest Settings page, click Test in your Jira integration to ensure there are no errors.
    Note: Clicking “Enable manual error reporting” allows you to submit an error to Jira while viewing it in the Rainforest UI.

Enabling manual error reporting.

Oauth Server URL is often the same URL as your Jira integration’s URL.

For the Request Token Path, Authorization Path, and Access Token Path fields, key in the path only; you do not need to include a fully qualified URL.

If you have any questions, reach out to us at [email protected].