Dev Space

Customize & extend the power of Alteryx. SDKs, APIs, custom tools, and more!
SOLVED

JIRA Connector

Coxta45
11 - Bolide

JIRA Connector (Macro)

 

jira.png   

 

 

 

 

 

Public Gallery Link:  https://gallery.alteryx.com/#!app/JIRA-Connector/58d87c2feffc2a0dd0b5ed8f

 

I've published a JIRA Connector to the public gallery and hope it will be useful for those using JIRA that are looking for a way to quickly download issues for their JIRA projects.  It's pretty straightforward, but here's a preview and quick guide:

 

30 Second Preview:

 

 

Installation & Configuration

 

Download and import to your Macros folder

 

import.png

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

As long as your macro folder has been mapped (Options -> User Settings -> Edit User Settings -> Macros), you should find the JIRA Connector tool in the Connectors category on the tool palette the next time you open Alteryx.

 

pallete.png

 

 

 

 

 

 

 

Tool Configuration

 

3 Tabs:  Site & Login, Project & Issues, Fields

 

Site & Login

 

Enter the URL for your JIRA site along with your username and password.  Email logins will work, but your actual username is preferable because it enables the "Only My Issues" option to work (next tab).

 

login.png

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Project & Issues

 

You'll need to run the workflow at least once with the "Refresh Project List" option selected before being able to use the "Download Issues" option.  This loads a list of available JIRA projects that will show in the dropdown under the Download Issues option on subsequent runs.

 

refresh_projects.png

 

 

 

 

 

 

 

 

 

 

 

 

 

Once an available project list has loaded, you can select a project to download issues from.  You'll also notice some options for filtering issues that belong to yourself or another specific assignee.  You can also paginate through large result sets in 1,000 record increments.

 

download_issues.png

 

Fields

 

Lastly, select one of three options for returned fields and parsing methods.

 

  1. Standard - Formatted
    •  Includes the commonly used JIRA system fields and utilizes more practical parsing and formatting methods
  2. Standard - Raw
    • Includes all JIRA system fields and transposes/flattens multi-dimensional arrays (to a certain extent/depth)
    • Can yield wide results
  3. The Kitchen Sink
    • Includes all system fields, as well as custom fields
    • Parsed results for this option will likely be very wide and cumbersome

 

fields.png

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Output

 

Summary (S) - a brief summary of the results (record counts, etc.)

Raw JSON (J)  - direct JSON response from the JIRA REST API

Parsed Results (P) - the parsed results

canvas.png

 

That's it!  Once again, I hope this will be useful and look forward to getting some decent feedback.  I've only been able to test this on our company's [cloud hosted] JIRA projects and honestly have no idea if it will work for private server hosted JIRA environments.  

 

Please feel free to leave feedback and/or report any runtime errors below.  I'll do my best to publish new versions to the gallery with essential fixes.

 

Taylor Cox

82 REPLIES 82
GreggD
8 - Asteroid

Thanks Tom,

Really appreciate you sharing your solution.
This is a really impactful contribution.

You are helping a lot of people with this one.

 

Thanks again

Gregg

bhaushedbale
8 - Asteroid

Thanks this is really helpful, I am able to build python code for same

voovovo
8 - Asteroid

Hi All,

 

I just submitted this connector for a new API and added worklog download function.

https://gallery.alteryx.com/#!app/JIRA-Connector-/5de07bdf826fd30fa06e2f3a

 

For existing function, I simply modified REST API reference from "/rest/api/latest" to "/rest/api/2"

 

Thanks, Taylor. And please feel free to improve this macro.

brian_ye22
5 - Atom

Hi,

 

Thanks for sharing this. Are you able to share this workflow? I'm getting a "The field schema for the output [Output Name] changed between iterations" error and don't understand why.

rrana
5 - Atom

Hi,

 

Thanks for all the info in setting up the JIRA connector.

 

When I ran the workflow with the URL and my credentials, I got the following error:

 

Error: JIRA Connector (1): Tool #227: JIRA API error --> HTTP/1.1 404

 

rrana_0-1599840039818.png

 

 

Any idea what could be causing it?


Thanks

Darrin-Pilkington
6 - Meteoroid

I have been running the Jira Connector successfully for some time now and just last week began getting the same error message as above.

 

Error: JIRA Connector (145): Tool #229: JIRA API error --> HTTP/1.1 403

 

Does anyone know what would suddenly cause this?

 

Thanks,

rrana
5 - Atom

Hi Darrin, I had my issue resolved. Try checking the URL you are entering for the JIRA site - it should end in .com (without any extended links at the end of it). Please let us know if this helps resolve. Thanks

Darrin-Pilkington
6 - Meteoroid

Thanks @rrana , but that is not the issue.

 

Come to find out it had to do with a password change and needing to log back in via the browser to get past the captcha.
suzb
6 - Meteoroid

@gec @Coxta45 I second the need to view more than one project at a time. Ideally, I would like to view all projects I have access to. Am considering learning how to write a macro myself, but will continue through this discussion thread to see what has happened since May 2019.

ZackvdMerwe
5 - Atom

Hi,

 

Can you please assist tried multiple JQL statements and tested on the JQL on JIRA and returns values, but the connector doesn't seem to be returning any values. Would be great if you can assist as the Jason API connector is limiting us to query 100 record extraction at a time.