JIRA Cloud Connector

Intro

JIRA helps teams to get organized and work together to build incredible products, but product teams are just one part of your organization. With Domo, you can combine data from multiple sources into a single platform—pulling data from product development, marketing, sales, operations, and finance for a real-time, holistic view of your business.
Once your data is in Domo, you can get stunning, dynamic JIRA visualizations with real-time data, on any device.
Domo’s JIRA Cloud connector allows you to connect to your JIRA account to extract data from JIRA. You can import data including issue tracking, completed tickets per team, ticket resolution time, and project management metrics, using either custom or predefined queries. To learn more about the JIRA API, see https://developer.atlassian.com/jiradev/jira-apis/jira-rest-apis/jira-rest-api-tutorials/jira-rest-api-example-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 Cloud account in the Data Center. This topic discusses the fields and menus that are specific to the JIRA Cloud 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

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 Cloud account and create a DataSet, you must have:

• The domain of your JIRA Cloud account (Jira Server accounts are not supported for OAuth).

You can authenticate to the Jira Cloud connector with the same credentials you use to log into your Jira account online.

Connecting to Your JIRA Cloud Account

This section enumerates the options in the Credentials and Details panes on the Jira Cloud 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 (third-party tool) account. The following table describes what is needed for each field:

Field	Description
Domain	The domain of your JIRA Cloud account. Jira Server accounts are not supported for OAuth.

Once you have entered valid JIRA Cloud credentials, you can use the same account any time you go to create a new JIRA Cloud 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.

Details Pane

This pane contains a primary Reports menu, along with various other menus which may or may not appear depending on the report type you select.

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.

Note: You need to always add order by clause in the query. On the Jira side, there is a limitation that does not sort the issues in any order, causing the connector to miss and duplicate some items.

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/display/JIRA/Advanced+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 and then choosing the desired report type. The following reports are available:

Field	Description
Report
JQL Query	Enter a JQL query to pull custom data. For information see, Jira Documentation.
Data Option
Filter Type	Select to include or exclude specific fields from the returned dataset.
Flatten All Fields	Select this checkbox to flatten all sublists.
Sublists To Flatten	Enter the sublists to be flattened. Note: If you clear the Flatten All Fields checkbox, the Sublists To Flatten field appears.
Include All Sprints	Select this checkbox to pull data for all sprints. If not selected, only data for active sprints will be retrieved.
Reset Schema	Select this checkbox to only include columns that have been imported in the current execution. Please note this option only works for the Replace update method.
Group Name	Enter the group that contains the users you wish to retrieve. This report requires an Administrator account.
Project	Select the JIRA Project you want to retrieve data for.

FAQ

When should I use this connector?

The JIRA Cloud Connector connects to JIRA Cloud instances using OAuth. Use this connector if your JIRA instance does not allow local usernames and passswords, and if you are using a JIRA Cloud instance.

Which endpoint(s) does each report call in this connector?

Report Name	Endpoint URL
Issue Query	/rest/api/2/search
Fields	/rest/api/2/field
Group Members	/rest/api/2/group/member/
Projects	/rest/api/2/project
Project Versions	/rest/api/2/project//versions
Users Groups	/rest/api/2/user/groups

What kind of credentials do I need to power up this connector?

You need the domain of your JIRA Cloud account. The Jira Cloud connector supports OAuth2 authentication. You can authenticate to this connector with the same credentials you use to log into your Jira account online.

How frequently will my data update?

Data from Jira’s servers are usually made available to the API immediately.

How do I know if my query is right?

Jira’s platform provides a handy tool to verify if your query is valid. An easy way to access this tool is simply to do a search in Jira’s search bar. Once on the search screen, you will see a green check box next to the query string for your search to indicate that it is valid. Otherwise, you will see a red X. You can switch back to the basic search functionality to build a query from the available selectors, and then switch again to advanced to see the resulting query.

Can this connector pull custom fields?

Because Jira returns so much data, the connector enables you to specify fields either as inclusive or exclusive. If you choose inclusively, only the fields you specify will be returned. If you choose exclusive, all fields will be returned except for those that you specify.

Note: Field ids must be entered. If the field names are entered, then they will be ignored.

Why will the connectors not reset the schema?

Connectors will not reset the schema of what has already been imported, which may result in blank columns appearing, if the customer has the dataset set to run on a Replace. This is due to the need to maintain backwards compatibility.

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.

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.