Jira Connector for MS Excel
In this article you will learn how to integrate Using Jira Connector you will be able to connect, read, and write data from within MS Excel. Follow the steps below to see how we would accomplish that. The driver mentioned above is part of ODBC PowerPack which is a collection of high-performance Drivers for various API data source (i.e. REST API, JSON, XML, CSV, Amazon S3 and many more). Using familiar SQL query language you can make live connections and read/write data from API sources or JSON / XML / CSV Files inside SQL Server (T-SQL) or your favorite Reporting (i.e. Power BI, Tableau, Qlik, SSRS, MicroStrategy, Excel, MS Access), ETL Tools (i.e. Informatica, Talend, Pentaho, SSIS). You can also call our drivers from programming languages such as JAVA, C#, Python, PowerShell etc. If you are new to ODBC and ZappySys ODBC PowerPack then check the following links to get started. |
Connect to Jira in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Jira using MS Excel we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using MS Excel. Perform these steps:
-
Install ZappySys ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
Create a User Data Source (User DSN) based on ZappySys API Driver
ZappySys API DriverYou should create a System DSN (instead of a User DSN) if the client application is launched under a Windows System Account, e.g. as a Windows Service. If the client application is 32-bit (x86) running with a System DSN, use ODBC Data Sources (32-bit) instead of the 64-bit version. -
When the Configuration window appears give your data source a name if you haven't done that already, then select "Jira" from the list of Popular Connectors. If "Jira" is not present in the list, then click "Search Online" and download it. Then set the path to the location where you downloaded it. Finally, click Continue >> to proceed with configuring the DSN:
JiraDSNJira -
Now it's time to configure the Connection Manager. Select Authentication Type, e.g. Token Authentication. Then select API Base URL (in most cases, the default one is the right one). More info is available in the Authentication section.
Steps to get Jira Credentials
Firstly, login into your Atlassian account and then go to your Jira profile:- Go to Profile > Security.
- Click Create and manage API tokens.
- Then click Create API token button and give your token a label.
- When window appears with new API token, copy and use it in this connection manager.
- That's it!
Fill in all required parameters and set optional parameters if needed:
JiraDSNJiraAPI Key based Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill in the parameter... Atlassian User Name (email) Fill in the parameter... API Key Fill in the parameter... Optional Parameters CustomColumnsRegex Fill in the parameter... Steps to get Jira Credentials
Copy below URL and open in browser to see instructions about creating PAT (Personal Access Token) to access JIRA data using API. https://confluence.atlassian.com/enterprise/using-personal-access-tokens-1026032365.htmlFill in all required parameters and set optional parameters if needed:
JiraDSNJiraPersonal Access Token (PAT) Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill in the parameter... Token (PAT Bearer Token) Fill in the parameter... Optional Parameters CustomColumnsRegex Fill in the parameter... OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [API Help..]
Steps to get Jira Credentials
Firstly, login into your Atlassian account and then create Jira application:- Go to Atlassian Developer area.
- Click Create app and select OAuth 2.0 (3LO) integration app to create an OAuth app.
- Give your app a name, accept the terms and hit Create.
- Then hit App details panel and copy paste Client ID and Secret into the API Connection Manager configuration grid into the proper places.
- Then go back and click Permissions panel to enable permissions/scopes for your application. You can enable them all.
- Go back again to application settings and click Authorization panel.
- Click Configure button and in Callback URL enter your own Callback URL or simply enter https://zappysys.com/oauth if you don't have one.
- Use this same Callback URL (Return URL) in a API Connection Manager configuration grid.
- In API Connection Manager enter one or more of these scopes (read more about available scopes) into Scopes property:
- offline_access (a must)
- read:jira-user
- read:jira-work
- write:jira-work
- manage:jira-project
- manage:jira-configuration
- Also configure your company's Subdomain in the properties grid.
- Click Generate Token to generate tokens.
- That's it!
Fill in all required parameters and set optional parameters if needed:
JiraDSNJiraOAuth (**Must change API Base URL to V3 OAuth**) [OAuth]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters ClientId Fill in the parameter... ClientSecret Fill in the parameter... Scope Fill in the parameter... ReturnUrl Fill in the parameter... Organization Id (Select after clicking [Generate Token]) Fill in the parameter... Optional Parameters Custom Columns for output (Select after clicking [Generate Token]) Fill in the parameter... -
Once the data source has been configured, you can preview data. Select the Preview tab and use settings similar to the following to preview data:
-
Click OK to finish creating the data source.
Video instructions
Read data in Excel from the DSN
-
In Excel click Data, then select Get Data, proceed with From Other Sources and choose From ODBC item. This will get data from ODBC data source we created:
-
A small window opens, then simply select the data source you created in previous steps:
JiraDSN -
Most likely, you will be asked to authenticate to a newly created DSN. Just select Windows authentication option together with Use my current credentials option:
JiraDSN -
Finally, you will be asked to select a table or view to get data from. Select one and load the data!
-
Finally, finally, use data extracted from Jira API in an Excel worksheet:
Advanced topics
Create Custom Stored Procedure in ZappySys Driver
You can create procedures to encapsulate custom logic and then only pass handful parameters rather than long SQL to execute your API call.
Steps to create Custom Stored Procedure in ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
-
Go to Custom Objects Tab and Click on Add button and Select Add Procedure:
-
Enter the desired Procedure name and click on OK:
-
Select the created Stored Procedure and write the your desired stored procedure and Save it and it will create the custom stored procedure in the ZappySys Driver:
Here is an example stored procedure for ZappySys Driver. You can insert Placeholders anywhere inside Procedure Body. Read more about placeholders here
CREATE PROCEDURE [usp_get_orders] @fromdate = '<<yyyy-MM-dd,FUN_TODAY>>' AS SELECT * FROM Orders where OrderDate >= '<@fromdate>';
-
That's it now go to Preview Tab and Execute your Stored Procedure using Exec Command. In this example it will extract the orders from the date 1996-01-01:
Exec usp_get_orders '1996-01-01';
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC usp_get_orders @fromdate=''1996-07-30''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Create Custom Virtual Table in ZappySys Driver
ZappySys API Drivers support flexible Query language so you can override Default Properties you configured on Data Source such as URL, Body. This way you don't have to create multiple Data Sources if you like to read data from multiple EndPoints. However not every application support supplying custom SQL to driver so you can only select Table from list returned from driver.
If you're dealing with Microsoft Access and need to import data from an SQL query, it's important to note that Access doesn't allow direct import of SQL queries. Instead, you can create custom objects (Virtual Tables) to handle the import process.
Many applications like MS Access, Informatica Designer wont give you option to specify custom SQL when you import Objects. In such case Virtual Table is very useful. You can create many Virtual Tables on the same Data Source (e.g. If you have 50 URLs with slight variations you can create virtual tables with just URL as Parameter setting.
-
Go to Custom Objects Tab and Click on Add button and Select Add Table:
-
Enter the desired Table name and click on OK:
-
And it will open the New Query Window Click on Cancel to close that window and go to Custom Objects Tab.
-
Select the created table, Select Text Type AS SQL and write the your desired SQL Query and Save it and it will create the custom table in the ZappySys Driver:
Here is an example SQL query for ZappySys Driver. You can insert Placeholders also. Read more about placeholders here
SELECT "ShipCountry", "OrderID", "CustomerID", "EmployeeID", "OrderDate", "RequiredDate", "ShippedDate", "ShipVia", "Freight", "ShipName", "ShipAddress", "ShipCity", "ShipRegion", "ShipPostalCode" FROM "Orders" Where "ShipCountry"='USA'
-
That's it now go to Preview Tab and Execute your custom virtual table query. In this example it will extract the orders for the USA Shipping Country only:
SELECT * FROM "vt__usa_orders_only"
-
Let's generate the SQL Server Query Code to make the API call using stored procedure. Go to Code Generator Tab, select language as SQL Server and click on Generate button the generate the code.
As we already created the linked server for this Data Source, in that you just need to copy the Select Query and need to use the linked server name which we have apply on the place of [MY_API_SERVICE] placeholder.
SELECT * FROM OPENQUERY([MY_API_SERVICE], 'EXEC [usp_get_orders] ''1996-01-01''')
-
Now go to SQL served and execute that query and it will make the API call using stored procedure and provide you the response.
Actions supported by Jira Connector
Jira Connector support following actions for REST API integration. If some actions are not listed below then you can easily edit Connector file and enhance out of the box functionality.Parameter | Description |
---|
Parameter | Description |
---|---|
CustomColumnsRegex |
|
Parameter | Description |
---|
Parameter | Description |
---|---|
AccountId |
|
Parameter | Description |
---|---|
ProjectIdOrKey |
|
Parameter | Description |
---|---|
ProjectIdOrKey |
|
EnableUndo |
|
Parameter | Description | ||||||
---|---|---|---|---|---|---|---|
IssueIdOrKey |
|
||||||
NotifyUsers |
|
||||||
OverrideScreenSecurity |
|
||||||
OverrideEditableFlag |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
Parameter | Description |
---|---|
Issue Key(s) or Ids - Comma Separated (PRJA-10,PRJA-13) |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
WorklogId |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
WorklogId |
|
Parameter | Description |
---|---|
Issue Key(s) or Ids - Comma Separated (PRJA-10,PRJA-13) |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Parameter | Description |
---|---|
IssueId Or Key |
|
Comma Separated ChangeLog Ids |
|
Parameter | Description |
---|---|
FieldId |
|
Parameter | Description |
---|---|
FieldId |
|
ContextId |
|
Parameter | Description |
---|---|
Url |
|
Body |
|
IsMultiPart |
|
Filter |
|
Headers |
|
Jira Connector Examples for MS Excel Connection
This page offers a collection of SQL examples designed for seamless integration with the ZappySys API ODBC Driver under ODBC Data Source (36/64) or ZappySys Data Gateway, enhancing your ability to connect and interact with Prebuilt Connectors effectively.
List issues [Read more...]
Lists all issues
SELECT * FROM Issues
List a single issue by Id [Read more...]
select * from Issues Where Id=10001
List a single issue by Key [Read more...]
List a single issue by Key or Numeric Id.
SELECT * FROM Issues WITH(Key='CS-1')
List multiple issues by Id or Key [Read more...]
List multiple issues by comma separated Key(s) or Numeric Id(s).
SELECT * FROM Issues WITH(Key='CS-1, CS-2, 10003, 10004')
List all issues for a specific project [Read more...]
List all issues for a specified project code.
SELECT * FROM Issues WITH(Project='CS')
Search issues using Advanced JQL query expression [Read more...]
List issues using JQL query expression
SELECT * FROM Issues WITH (Jql='status IN (Done, Closed) AND created > -5d' )
/*
Useful links:
https://support.atlassian.com/jira-work-management/docs/jql-fields/
https://www.atlassian.com/software/jira/guides/jql/tutorials#advanced-search
https://www.atlassian.com/blog/jira/jql-the-most-flexible-way-to-search-jira-14
Other Possible JQL expressions:
Ids (IN): key IN(10001, 10002, 10003);
Keys (IN): key IN(CS-1, CS-2, CS-3);
Projects (IN): project IN(PROJ1, PROJ2, PROJ3);
Status (EQUAL): status='Done';
Date (Expression 1): created >=-5d;
Date (Expression 2): created >=startOfMonth() AND created <=now();
Date (Expression 3): created >=startOfYear() AND created <=startOfDay();
Date (Static): created >= 2008/12/31;
Date (Static with time): created >= 2008/12/31 23:59;
Project and Status (AND + IN): project=CS AND status NOT IN ('Done', 'Open', 'Closed');
Assignee and Created Date: assignee is NOT EMPTY and created < -1d;
Text (Contains - Fuzzy): Summary ~ 'some words' OR description ~ 'some words';
Text (Contains - Fuzzy Wildcard): Summary ~ 'some*' OR description ~ 'some*';
Text (Contains - Exact): Summary ~ '\"exact words\"' OR description ~ '\"exact words\"';
Text (Does Not Contain - Fuzzy): Summary !~ 'some words' OR description !~ 'some words';
Empty OR Null: fixVersion is empty OR fixVersion is null;
Is Not Empty OR Is Not Null: fixVersion is not empty OR fixVersion is not null;
WAS Operator (previous value): status WAS "Resolved" BY (jsmith,srogen) BEFORE "2019/02/02";
WAS IN Operator: status WAS IN ("Resolved", "In Progress");
WAS NOT IN Operator: status WAS NOT IN ("Resolved", "In Progress");
WAS + BY + DURING (date range): status WAS "Resolved" BY (jsmith,srogen) DURING("2019/02/02", "2020/02/02");
CHANGED operator: assignee CHANGED;
CHANGED operator (multiple): status CHANGED FROM "In Progress" TO "Open"
*/
INSERT Issue [Read more...]
Inserts a single issue to a particular project
INSERT INTO Issues(ProjectKey, IssueTypeName, Summary, Description)
VALUES('SMP', 'Task', 'My ticket inserted through the API', 'A description about an issue')
WITH (Output=1)
UPDATE Issue [Read more...]
Updates an issue
UPDATE Issues
SET Summary = 'This is my summary'
,Description = 'Lot''s of stuff to describe'
,Labels = '[ "bugfix" ]'
,DueDate = '2029-10-10'
--WHERE Id=1234
--WHERE Id='ISSKEY'
WITH (
IssueIdOrKey='ISSKEY', --or use Id in where clause
Output=1,
NotifyUsers=0,
OverrideScreenSecurity=0,
OverrideEditableFlag=0,
ContinueOn404Error=0
)'
UPDATE multiple Issues matching with JQL search query [Read more...]
Updates multiple issues which match with certain condition (JQL). Adding Where 1=1 or some other WHERE condition invokes Lookup endpoint (refer to other example to learn about JQL - see Search issues using Advanced JQL query expression)
UPDATE Issues
SET Summary = 'This is done on <<fun_now>>'
Where 1=1
WITH (jql='status=done' , ContinueOn404Error=0)
--WITH (jql='key in(10001, 10002, 10003)' , ContinueOn404Error=0)
--WITH (jql='key in(CS-1, CS-2, CS-3)', ContinueOn404Error=0)
DELETE Issue [Read more...]
Deletes a single issue
DELETE FROM Issues
WITH (IssueIdOrKey='10020', OUTPUT=1, ContinueOn404Error=0)
DELETE multiple Issues matching with JQL search query [Read more...]
Delete multiple issues which match with certain condition (JQL). Adding Where 1=1 or some other WHERE condition invokes Lookup endpoint (refer to other example to learn about JQL - see Search issues using Advanced JQL query expression)
DELETE FROM Issues
Where 1=1
WITH (jql='status=done' , ContinueOn404Error=0)
--WITH (jql='key in(10001, 10002, 10003)' , ContinueOn404Error=0)
--WITH (jql='key in(CS-1, CS-2, CS-3)', ContinueOn404Error=0)
List comments for all issues [Read more...]
List comments for all issues
SELECT * FROM Comments
List comments for a specific issue Issue Key or Id [Read more...]
List comments for a specific issue
SELECT * FROM Comments Where IssueId=10003 --OR WITH(Key='10003')
List comments for a specific issue by Key [Read more...]
List comments for a specific issue by key
SELECT * FROM Comments WITH(Key='CS-1')
List comments for issues (search by JQL) [Read more...]
List all comments for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression)
SELECT * FROM Comments WITH (Jql='status IN (Done, Closed) AND created > -5d' )
List fields [Read more...]
Lists all fields that are used and available in issue entity
SELECT * FROM Fields
List projects [Read more...]
Lists all available projects
SELECT * FROM Projects
List worklog entries for a specific issue by Id or Key [Read more...]
List all worklog entries for a specific issue
SELECT * FROM Worklogs Where IssueId=10003 --WITH(Key='10003')
List worklogs for issues (search by JQL) [Read more...]
List all worklogs (time entries) for issues returned from a JQL search expression (refer to previous example to learn about JQL - see Search issues using Advanced JQL query expression)
SELECT * FROM Worklogs WITH (Jql='status IN (Done, Closed) AND created > -5d' )
INSERT Project [Read more...]
Inserts a single project
INSERT INTO Projects(ProjectKey, Name, ProjectTypeKey, LeadAccountId, AssigneeType)
VALUES ('TEST', 'Test Project', 'software', '70122:XXXXXXXX-XXXX-XXXX-XXXX-c5da8c98b9e2', 'PROJECT_LEAD)
WITH (Output=1)')
UPDATE Project [Read more...]
Updates a single project
UPDATE Projects
SET Name = 'My Test Kanban Project'
,ProjectCategoryId = 1
WITH (ProjectIdOrKey = 'MYPRJCT', Output=1, ContinueOn404Error=0)
DELETE Project [Read more...]
Deletes a single project
DELETE FROM Projects
WITH (ProjectIdOrKey = '10020', Output=1, ContinueOn404Error=0)
List users [Read more...]
Lists all available users
SELECT * FROM Users
INSERT User [Read more...]
Inserts a single user
INSERT INTO Users(EmailAddress, DisplayName, Name, Password)
VALUES ('my@user.com', 'John Doe', 'John', 'xhedkspstdadaothoua')
WITH (OUTPUT=1)
DELETE User [Read more...]
Deletes a single user
DELETE FROM Users
WITH (OUTPUT=1, accountId = '547059:136095a0-XXXX-XXXX-XXXX-3e4c66f26551', ContinueOn404Error=0)
List worklogs [Read more...]
Lists all worklogs from all issues
SELECT * FROM Worklogs
INSERT Worklog [Read more...]
Inserts a single worklog to a particular issue
INSERT INTO Worklogs(TimeSpentInSeconds, Comment, StartedAt)
VALUES(7200,'My Comment!','2020-02-23T16:20:30.123+0000')
WITH (IssueIdOrKey='ISSKEY-1', OUTPUT=1)
UPDATE Worklog [Read more...]
Updates a worklog
UPDATE Worklogs
SET TimeSpentInSeconds = 28800
,Comment='My Comment!'
,StartedAt='2020-01-23T16:20:30.123+0000'
WITH (IssueIdOrKey='MTK-1', WorklogId='123465', OUTPUT=1, ContinueOn404Error=0)
DELETE Worklog [Read more...]
Deletes a single worklog of an issue
DELETE FROM Worklogs
WITH (IssueIdOrKey='10020', WorklogId='123465', OUTPUT=1, ContinueOn404Error=0)
Conclusion
In this article we discussed how to connect to Jira in MS Excel and integrate data without any coding. Click here to Download Jira Connector for MS Excel and try yourself see how easy it is. If you still have any question(s) then ask here or simply click on live chat icon below and ask our expert (see bottom-right corner of this page).
Download Jira Connector for MS Excel
Documentation
More integrations
Other application integration scenarios for Jira
Other connectors for MS Excel
Download Jira Connector for MS Excel
Documentation
How to connect Jira in MS Excel?
How to get Jira data in MS Excel?
How to read Jira data in MS Excel?
How to load Jira data in MS Excel?
How to import Jira data in MS Excel?
How to pull Jira data in MS Excel?
How to push data to Jira in MS Excel?
How to write data to Jira in MS Excel?
How to POST data to Jira in MS Excel?
Call Jira API in MS Excel
Consume Jira API in MS Excel
Jira MS Excel Automate
Jira MS Excel Integration
Integration Jira in MS Excel
Consume real-time Jira data in MS Excel
Consume real-time Jira API data in MS Excel
Jira ODBC Driver | ODBC Driver for Jira | ODBC Jira Driver | SSIS Jira Source | SSIS Jira Destination
Connect Jira in MS Excel
Load Jira in MS Excel
Load Jira data in MS Excel
Read Jira data in MS Excel
Jira API Call in MS Excel