In this article you will learn how to integrate Using Jira Connector you will be able to connect, read, and write data from within Power BI. 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. |
See also
|
Video Tutorial - Integrate Jira data in Power BI
This video covers following and more so watch carefully. After watching this video follow the steps described in this article.
- How to download / install required driver for
Jira integration in Power BI - How to configure connection for
Jira - Features about
API Driver (Authentication / Query Language / Examples / Driver UI) - Using
Jira Connection in Power BI
Create ODBC Data Source (DSN) based on ZappySys API Driver
To get data from Jira using Power BI we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using Power BI. 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... 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 based Authentication [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.
Read Jira data in Power BI using ODBC
-
Once you open Power BI Desktop click Get Data to get data from ODBC:
-
A window opens, and then search for "odbc" to get data from ODBC data source:
-
Another window opens and asks to select a Data Source we already created. Choose JiraDSN and continue:
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 extracted data from Jira in a Power BI report:
Import Jira data into Power BI from SQL Query
If you wish to import Jira data from SQL query rather than selecting table name then you can use advanced options during import steps (as below). After selecting DSN you can click on advanced options to see SQL Query editor.
If you type invalid SQL, Power BI may revert to table mode rather than import from Query. Make sure you do not use "$"
it as a table name in SELECT...FROM $
. You can use "_root_"
instead (e.g., SELECT .. FROM _root_). Consider using Custom Object to wrap custom SQL in a Virtual Table. This way, you can see a virtual table in Table mode where you can import multiple objects using the same connection rather than creating a new connection for each custom SQL.
Edit Query / Using Parameters in Power BI (Dynamic Query)
let
vKey=paraAPIKey,
Source = Odbc.Query(
"dsn=ZS-OData Customers",
"SELECT * FROM value WITH (SRC='http://httpbin.org/post',"
& "METHOD='POST',"
& "HEADER='Content-Type:application/json',"
& "BODY=@'{""CallerId"":1111, ""ApiKey"":""" & vKey & """}')")
in
Source
Edit Query Settings after Import
There will be a time you need to change initial Query after dataset import in Power BI. Not to worry, just follow these steps to edit your SQL.
Using DirectQuery Option rather than Import
So far we have seen how to Import Jira data into Power BI but what if you have too much data and you dont want to import but link it. Power BI Offers very useful feature for this scenario. Its called DirectQuery Option. In this section we will explore how to use DirectQuery along with ZappySys Drivers. Out of the box ZappySys Drivers wont work in ODBC Connection Mode so you have to use SQL Server Connection rather than ODBC if you wish to use Live data using DirectQuery option. See below step by step instructions to enable DirectQuery mode in Power BI for Jira data. Basically we will use ZappySys Data Gateway its part of ODBC PowerPack. We will then use Linked Server in SQL Server to Link API Service and then we will issue OPENROWSET queries from Power BI to SQL Server and it will then call Jira via ZappySys Data Gateway.Step-By-Step - How to query Jira API in SQL Server
- First read this article carefully, How to query Jira API in SQL Server.
- Once linked server is configured we are ready to issue API query in Power BI.
- Click Get Data in Power BI, select SQL Server Database
- Enter your server name and any database name
- Select Mode as DirectQuery
-
Click on Advanced and enter query like below (we are assuming you have created Jira Data Source in Data Gateway and defined linked server (Change name below).
Select * from OPENQUERY([JIRA_LINKED_SERVER],'SELECT * FROM Customers')
- Click OK and Load data ... That's it. Now your Jira API data is linked rather than imported.
Working with Gateways in Power BI (Schedule Import)
If the data needs to be updated, it is necessary to create a gateway on-premises. In this new section, we will install a Power BI Gateway and in the next section schedule it to update the Jira information.- In the last section, we Published the report. Power BI may ask you to SIGN IN.
- Select the Workspace and select Datasets
- Right-click the report and select Settings.
- The system will ask for a Gateway. Stay here.
-
Use the following link to install a Data Gateway:
https://docs.microsoft.com/en-us/power-bi/service-gateway-onprem
- Run the installer and press Next
- Select the option On-premises data gateway (recommended). This option allows access to multiple users and can be used by more applications than Power BI.
- The installer will show a warning message.
- Select the path to install and check the I accept the terms.
- Specify the email address to use the gateway.
- After entering the email, write the gateway name and a recovery key. Make sure to confirm the recovery key.
Manage gateways and configure the schedule
Once that the gateway is installed we will configure it and add the connection strings.- The next step is to go to manage gateway
- In order to get the connection string, we will need the connection string of the ZappySys API Driver. In the first section of this post, we explained how to configure it. Press Copy Connection String
- Once that the data is copied, add a New data Source. In Data Source Name, enter the Data Source Name of the ZappySys API Driver in step 13 and in Data Source Type, select ODBC. In connection string copy and paste from the clipboard of the step 13 and press Add.
- Once added the gateway. You can see the schedule refresh to On and Add another time to add the time where you want to refresh the data.
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.
Conclusion
In this article we discussed how to connect to Jira in Power BI and integrate data without any coding. Click here to Download Jira Connector for Power BI 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 Power BI
Documentation
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 |
---|---|
IssueIdOrKey |
|
WorklogId |
|
Parameter | Description |
---|---|
IssueIdOrKey |
|
WorklogId |
|
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 |
|
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 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
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)
DELETE Project [Read more...]
Deletes a single project
DELETE FROM Projects
WITH (ProjectIdOrKey = '10020', Output=1)
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'')
List issues [Read more...]
Lists all available issues across all projects
SELECT * FROM Issues
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'
WITH (IssueIdOrKey='ISSKEY', OUTPUT=1)'
DELETE Issue [Read more...]
Deletes a single issue
DELETE FROM Issues
WITH (IssueIdOrKey='10020', OUTPUT=1)
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)
DELETE Worklog [Read more...]
Deletes a single worklog of an issue
DELETE FROM Worklogs
WITH (IssueIdOrKey='10020', WorklogId='123465', OUTPUT=1)
Other App Integration scenarios for Jira
Other Connectors for Power BI
Download Jira Connector for Power BI
Documentation
How to connect Jira in Power BI? How to get Jira data in Power BI? How to read Jira data in Power BI? How to load Jira data in Power BI? How to import Jira data in Power BI? How to pull Jira data in Power BI? How to push data to Jira in Power BI? How to write data to Jira in Power BI? How to POST data to Jira in Power BI? Call Jira API in Power BI Consume Jira API in Power BI Jira Power BI Automate Jira Power BI Integration Integration Jira in Power BI Consume real-time Jira data in Power BI Consume real-time Jira API data in Power BI Jira ODBC Driver | ODBC Driver for Jira | ODBC Jira Driver | SSIS Jira Source | SSIS Jira Destination Connect Jira in Power BI Load Jira in Power BI Load Jira data in Power BI Read Jira data in Power BI Jira API Call in Power BI