Configuring the JIRA Integration

Contents

Introduction

The Betterworks JIRA integration captures data from JIRA and automatically updates progress of your key results in Betterworks every 30 minutes. Any JIRA issue can be supported, including including stories and epics. Linking these items to a key result in Betterworks via the integration can be accomplished in two ways:

  • Manually adding issues via a basic search or JQL query
  • Setting up a JQL query to capture all the issues matching the string

Anyone who uses JIRA to track tasks, features or projects in their workflow can benefit from this integration. For instance, engineers use it to show bugs that they have to squash and product managers use it to track the shipment of features by setting up a JQL query to capture overall progress.

1.png

Setup

To add the JIRA integration to Betterworks, you'll need to connect a JIRA user in the Betterworks integration page.

1. Create a JIRA user with the appropriate set of permissions for Betterworks users.

    • Read-only permissions are sufficient. Users within Betterworks will be able to see the JIRA issue, name and resolution for every project that is available to that JIRA user. No other details from the JIRA instance are captured by Betterworks. For more information on creating JIRA users, see JIRA’s documentation.

2. Go to the Betterworks Integrations page:

Admin → Platform Configuration → Integrations Third-party integrations → JIRA →Set Up

2.png

3. If your JIRA installation is hosted by Atlassian (in the cloud):

    • Generate an API token in JIRA

    • Go back to Betterworks and input the full username (email address) in the username field

    • Input the API token created from JIRA into the password field

      • Note: The password field is automatically encrypted.

    • Enter an "Instance Name"
    • Add your JIRA host URL

4. If your organization hosts your JIRA instance (on premises):

    • Input the username (email address) and password into their respective fields

      • Note: The password field is automatically encrypted.

    • Enter an "Instance Name"
    • Add your JIRA host URL
      • If your instance is behind a firewall, your IT department must determine a port to use and open it in for allow Betterworks to access your JIRA instance

      • Include the port number at the end of the URL (i.e. http://JIRA.yourcompany.com:1234)

      • You may also need to add the Betterworks IPs to your firewall's whitelist:

        • 18.235.225.62/32

        • 54.198.90.129/32

        • 54.237.162.217/32

5. Click "Save".

Notes:

  • If you'd like to connect multiple JIRA instances, click "Add another instance" and repeat the previous steps.
  • In order to see the JIRA integration at work, you need to log out of your Betterworks instance and log back in. The integration will not appear until you've done this.

Locate the JIRA Integration

The JIRA integration option can be found as follows...

If you're creating a key result from scratch, go to the "Objectives" module and click the "Create Objective" button. Once on the objective creation page, go to the key result to view the integration options:

3.png

If you're editing an existing key result, go to the "Objectives" module and click "..." (Additional Actions). Select "Quick edit" from the drop-down menu view the integration options:

4.png

5.png

Troubleshooting

Please see the FAQs in this article.