Jira ODBC Driver

Jira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details

In this article you will learn how to quickly and efficiently integrate Jira data in ODBC without coding. We will use high-performance Jira Connector to easily connect to Jira and then access the data inside ODBC.

Let's follow the steps below to see how we can accomplish that!

Download Documentation

Jira ODBC Driver is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few.

Create ODBC Data Source (DSN) based on ZappySys API Driver

Step-by-step instructions

To get data from Jira using ODBC we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using ODBC. Perform these steps:

Download and install ODBC PowerPack.
Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ZappySys API Driver:

ZappySys API Driver
- Create and use User DSN if the client application is run under a User Account. This is an ideal option in design-time, when developing a solution, e.g. in Visual Studio 2019. Use it for both type of applications - 64-bit and 32-bit.
- Create and use System DSN if the client application is launched under a System Account, e.g. as a Windows Service. Usually, this is an ideal option to use in a production environment. Use ODBC Data Source Administrator (32-bit), instead of 64-bit version, if Windows Service is a 32-bit application.
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:

JiraDSN

Jira

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.

API Key based Authentication

Jira authentication

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!

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to API Key based Authentication [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

JiraDSN

Jira

API Key based Authentication [Http]

https://[$Subdomain$].atlassian.net/rest/api/3

Required Parameters
Subdomain	Fill-in the parameter...
Atlassian User Name (email)	Fill-in the parameter...
API Key	Fill-in the parameter...
Optional Parameters
CustomColumnsRegex

Personal Access Token (PAT) Authentication

Jira authentication

Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRA

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to Personal Access Token (PAT) Authentication [Http]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Finally, hit OK button:

JiraDSN

Jira

Personal Access Token (PAT) Authentication [Http]

https://[$Subdomain$].atlassian.net/rest/api/3

Required Parameters
Subdomain	Fill-in the parameter...
Token (PAT Bearer Token)	Fill-in the parameter...
Optional Parameters
CustomColumnsRegex

OAuth (Must change API Base URL to V3 OAuth)

Jira authentication

OAuth App must be created in Atlassian Developer Console. It is found at https://developer.atlassian.com/console/myapps/ [API reference]

Firstly, login into your Atlassian account and then create Jira application:

Go to Atlassian Developer area.
Click Create and select OAuth 2.0 integration item to create an OAuth app:
Give your app a name, accept the terms and hit Create:
To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears:
Continue by hitting Edit Scopes button to assign scopes for the application:
Select these scopes or all of them:
Then click Authorization option on the left and click Add button:
Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:
Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step):
Now go to SSIS package or ODBC data source and in OAuth authentication set these parameters:
- For ClientId parameter use Client ID value from the previous steps.
- For ClientSecret parameter use Secret value from the previous steps.
- For Scope parameter use the Scopes you set previously (specify them all here):
  - offline_access (a must)
  - read:jira-user
  - read:jira-work
  - write:jira-work
  - manage:jira-project
  - manage:jira-configuration
  NOTE: A full list of available scopes is available in Atlassian documentation.
- For Subdomain parameter use your Atlassian subdomain value (e.g. mycompany, if full host name is mycompany.atlassian.net).
Click Generate Token to generate tokens.
Finally, select Organization Id from the drop down.
That's it! You can now use Jira Connector!

API Connection Manager configuration

Just perform these simple steps to finish authentication configuration:

Set Authentication Type to OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]
Optional step. Modify API Base URL if needed (in most cases default will work).
Fill in all the required parameters and set optional parameters if needed.
Press Generate Token button to generate the tokens.
Finally, hit OK button:

JiraDSN

Jira

OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]

https://[$Subdomain$].atlassian.net/rest/api/3

Required 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])

Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:

ZappySys API Driver - Jira

Jira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details

JiraDSN
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in ODBC to retrieve data from Jira. Hit OK button to use this query in the next step.
```
SELECT * FROM Issues
```
Some parameters configured in this window will be passed to the Jira API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful data much faster.
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in ODBC:
ZappySys API Driver - Jira

Jira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details

JiraDSN
```
SELECT * FROM Issues
```
You can also access data quickly from the tables dropdown by selecting <Select table>.

A WHERE clause, LIMIT keyword will be performed on the client side, meaning that the whole result set will be retrieved from the Jira API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Jira servers).
Click OK to finish creating the data source.

Video Tutorial

Centralized data access via Data Gateway

In some situations, you may need to provide Jira data access to multiple users or services. Configuring the data source on a Data Gateway creates a single, centralized connection point for this purpose.

This configuration provides two primary advantages:

Centralized data access
The data source is configured once on the gateway, eliminating the need to set it up individually on each user's machine or application. This significantly simplifies the management process.
Centralized access control
Since all connections route through the gateway, access can be governed or revoked from a single location for all users.

	Data Gateway	Local ODBC data source
Simple configuration
Installation	Single machine	Per machine
Connectivity	Local and remote	Local only
Connections limit	Limited by License	Unlimited
Central data access
Central access control
More flexible cost

If you need any of these requirements, you will have to create a data source in Data Gateway to connect to Jira, and to create an ODBC data source to connect to Data Gateway in ODBC.

Let's not wait and get going!

Creating Jira data source in Gateway

In this section we will create a data source for Jira in Data Gateway. Let's follow these steps to accomplish that:

Search for gateway in Windows Start Menu and open ZappySys Data Gateway Configuration:
Go to Users tab and follow these steps to add a Data Gateway user:
- Click Add button
- In Login field enter username, e.g., john
- Then enter a Password
- Check Is Administrator checkbox
- Click OK to save
Now we are ready to add a data source:
- Click Add button
- Give Datasource a name (have it handy for later)
- Then select Native - ZappySys API Driver
- Finally, click OK
JiraDSN

ZappySys API Driver
When the ZappySys API Driver configuration window opens, configure the Data Source the same way you configured it in ODBC Data Sources (64-bit), in the beginning of this article.
Very important step. Now, after creating or modifying the data source make sure you:
- Click the Save button to persist your changes.
- Hit Yes, once asked if you want to restart the Data Gateway service.
This will ensure all changes are properly applied:

Skipping this step may result in the new settings not taking effect and, therefore you will not be able to connect to the data source.

Creating ODBC data source for Data Gateway

In this part we will create ODBC data source to connect to Data Gateway from ODBC. To achieve that, let's perform these steps:

Open ODBC Data Sources (x64):
Create a User data source (User DSN) based on ODBC Driver 17 for SQL Server:

ODBC Driver 17 for SQL Server

If you don't see ODBC Driver 17 for SQL Server driver in the list, choose a similar version driver.
Then set a Name of the data source (e.g. Gateway) and the address of the Data Gateway:

GatewayDSN

localhost,5000

Make sure you separate the hostname and port with a comma, e.g. localhost,5000.
Proceed with authentication part:
- Select SQL Server authentication
- In Login ID field enter the user name you used in Data Gateway, e.g., john
- Set Password to the one you configured in Data Gateway
Then set the default database property to JiraDSN (the one we used in Data Gateway):

JiraDSN
Continue by checking Trust server certificate option:
Once you do that, test the connection:
If connection is successful, everything is good:
Done!

We are ready to move to the final step. Let's do it!

Accessing data in ODBC via Data Gateway

Finally, we are ready to read data from Jira in ODBC via Data Gateway. Follow these final steps:

Go back to ODBC.
Open your ODBC client application and use GatewayDSN to connect to Jira.
Read the data the same way we discussed at the beginning of this article.
That's it!

Now you can connect to Jira data in ODBC via the Data Gateway.

If you are asked for authentication details, use Database authentication or SQL Authentication option and enter credentials you used when configuring Data Gateway, e.g. john and your password.