Skip to main content
waffle.svg
Domo Knowledge Base

JIRA Connector

Version 20

 

Intro

JIRA is a proprietary issue tracking product, developed by Atlassian. It provides bug tracking, issue tracking, and project management functions. Use Domo's JIRA connector to compile reports on users or tickets opened or modified in the last month. You can also create your own queries to compile custom reports. To learn more about the JIRA API, see https://developer.atlassian.com/jira...e-query-issues

The JIRA connector is a "Cloud App" connector, meaning it retrieves data stored in the cloud. In the Data Center, you can access the connector page for this and other Cloud App connectors by clicking Cloud App in the toolbar at the top of the window.

You connect to your JIRA account in the Data Center. This topic discusses the fields and menus that are specific to the JIRA connector user interface. General information for adding DataSets, setting update schedules, and editing DataSet information is discussed in Adding a DataSet Using a Data Connector.

Primary Use Cases

  • Tracking progress and movement of tickets

  • Number of tickets assigned to specific users or groups

  • Seeing if too many tickets of a certain type are open (bugs)

Primary Metrics

  • Bug / issue / ticket tracking (by age, type, status, submitter)

  • Completed tickets per team

  • Ticket resolution time

  • Project management metrics (tracking individual tasks of a larger project or epic).

Primary Company Roles

Product managers

Average Implementation Time

This can vary wildly depending on the implementation and the user's level of knowledge of their JIRA system.

Ease of Use (on a 1-to-10 scale with 1 being easiest)

7

Best Practices

  • You should usually use "Replace" with the JIRA connector, as "Append" does not work well.

  • If the query is for data across a long time period, scheduling should be kept to a minimum (once a day). For shorter queries, more frequent updates are appropriate. 

Prerequisites

To connect to your JIRA account and create a DataSet, you must have the following:

  • The username and password you use to log into JIRA

  • The URL for your company's JIRA instance

  • The JQL query you will use to pull data (if you are building a custom report)

Credentials are received upon account creation. A JIRA Admin is likely to have created username and passwords for most users in your company if you use an on-premise JIRA implementation.

SSO

Single Sign-On (SSO) credentials will NOT work. However, you can work around SSO limitations by doing the following:

  1. Have your JIRA administrator create a local account with a username and password specifically for API use.

  2. Create an API key at http://id.atlassian.com/

  3. On the JIRA connector page in Domo, enter the API key you created instead of the password. (Depending on the account, you may need to enter your username or JIRA account email address as the username.) 

Connecting to Your JIRA Instance

This section enumerates the options in the Credentials and Details panes in the JIRA Connector page. The components of the other panes in this page, Scheduling and Name & Describe Your DataSet, are universal across most connector types and are discussed in greater length in Adding a DataSet Using a Data Connector.

Credentials Pane

This pane contains fields for entering credentials to connect to your JIRA instance. The following table describes what is needed for each field:  

Field

Description

Username

Enter the username you use to log into your JIRA instance.

Password

Enter the password you use to log into your JIRA instance.

Server URL

Enter the URL for your JIRA instance.

Once you have entered valid JIRA credentials, you can use the same account any time you go to create a new JIRA DataSet. You can manage connector accounts in the Accounts tab in the Data Center. For more information about this tab, see Managing User Accounts for Connectors.

Data Selection Pane

In the Data Selection pane, you are first asked whether you want to pull JIRA issues data or admin data. Different reports are available depending on your selection. Also, if you want to create a custom query, you should select issues data. 

Get JIRA Issue Data 

When you select Get JIRA Issue Data, a JQL Query Builder appears on the screen. Here you can build JIRA queries to returns columns for nearly every JIRA ticket parameter, like issue summary and description, creation date, resolution date, impacted customer name, and environment. You can also create a JQL query in JIRA and paste it into the query builder.

The JQL Query Builder automatically suggests your JIRA fields and values, enabling you to easily create JQL queries.

You may also select from the suggested queries on the right side of the Query Builder. Simply click on a suggested query and it will populate the JQL Query Builder. You may edit the query if desired afterwards.

One query example is as follows:

(issuetype = Bug OR issuetype = defect OR issuetype = Improvement) AND status != Closed ORDER BY createdDate DESC

This query retrieves all open issues that are classified as bugs, defects, or Improvements and sorts them by their creation dates.

For more information about writing JQL queries, see https://confluence.atlassian.com/dis...nced+Searching.

JIRA Issue Reports

If you would prefer to pull in premade reports rather than build custom queries, you can do so by expanding the Report Selection tab then choosing the desired report type. The following reports are available:

Report

Description

Comments Report

Returns JIRA tickets with their related comments.

Changelog Report

Returns changelogs per issue applicable to the query.

Labels Report

Returns labels for issues applicable to the query.

Linked Issues Report

Returns linked issues for issues applicable to the query.

Standard Ticket Report

Returns columns for nearly every parameter for JIRA tickets, such as issue summary and description, creation date, resolution date, impacted customer name, environment, etc.

Ticket History Report

Returns historical information about tickets.

Worklog Report

Returns worklogs per issue applicable to the query.

Get JIRA Admin Data

The Get JIRA Admin Data option provides access to a number of JIRA admin-level reports. This option does not let you build custom queries. If you want to build custom queries, select Get JIRA Issue Data instead. 

The following reports are available:

Report

Description

Fields

Returns a list of fields used in the user's JIRA account.

Group Members

Returns a list of users that belong to a specified group. Admin access is required to run this report.

Projects

Returns a list of all projects the user has access to.

Project Versions

Returns a list of all versions of the specified project.

Other Panes

For information about the remaining sections of the connector interface, including how to configure scheduling, retry, and update options, see Adding a DataSet Using a Data Connector.

Troubleshooting

  • Jira requires a fair amount of configuration from the side of the JIRA admin to ensure that API access is enabled. Common issues include setting the timeouts too short or not providing sufficient resources to the JIRA server.

  • If users have trouble understanding how to format JQL, the easiest thing is to log into the JIRA front end. Via the search bar, JIRA provides a tool that can construct a JQL query with preset filters. After constructing your query, if you hit the Advanced button, JIRA presents you with your selections in JQL format.