How to read Jira data in ODBC application?

In this section we will learn how to configure and use Jira Connector in the API Driver to extract data from the Jira.

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

Step-by-step instructions

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

1. Install ZappySys ODBC PowerPack.

2. Open ODBC Data Sources (x64):

   

3. 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.

4. 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

   

5. 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 [Http]

   Steps how to get and use Jira credentials
   Firstly, login into your Atlassian account and then go to your Jira profile:

   1. Go to Profile > Security.
   2. Click Create and manage API tokens.
   3. Then click Create API token button and give your token a label.
   4. When window appears with new API token, copy and use it in this connection manager.
   5. That's it!

   Fill in all required parameters and set optional parameters if needed:

   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 [Http]

   Steps how to get and use Jira credentials
   Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRA

   Fill in all required parameters and set optional parameters if needed:

   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**) [OAuth]

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

   Steps how to get and use Jira credentials
   Firstly, login into your Atlassian account and then create Jira application:

   1. Go to Atlassian Developer area.

   2. Click Create and select OAuth 2.0 integration item to create an OAuth app:

      

   3. Give your app a name, accept the terms and hit Create:

      

   4. To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears:

      

   5. Continue by hitting Edit Scopes button to assign scopes for the application:

      

   6. Select these scopes or all of them:

      

   7. Then click Authorization option on the left and click Add button:

      

   8. Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:

      

   9. Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step):

      

   10. 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).
   11. Click Generate Token to generate tokens.
   12. Finally, select Organization Id from the drop down.
   13. That's it! You can now use Jira Connector!

   Fill in all required parameters and set optional parameters if needed:

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

   

6. 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:
   

7. Click OK to finish creating the data source.

Video instructions

Reading data from client application

1. Firstly, to get data from ODBC data source based on ZappySys ODBC driver, in your client application, you would need to connect to ODBC source and then from the list select the data source.

2. Finally, to read the data just read tables/views in your app or enter a SQL statement to extract data, e.g.:

   SELECT * FROM Fields

Jira Connector Examples

The ZappySys API Driver is a user-friendly interface designed to facilitate the seamless integration of various applications with the Jira API. With its intuitive design and robust functionality, the ZappySys API Driver simplifies the process of configuring specific API endpoints to efficiently read or write data from Jira.

Click here to find more Jira Connector 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.

Consume Data inside your App / Programming Language

ODBC inside ETL / Reporting / BI Tools

• Power BI
• Tableau
• Excel
• Informatica PowerCenter
• QlikView
• SQL Server / Linked Server
• SSRS (SQL Server Reporting Services)

ODBC inside Programming Languages

• C# (CSharp)
• JAVA
• PHP
• PowerShell
• Python
• T-SQL / SQL Server Linked Server

Key features of the ZappySys API Driver include:

The API ODBC driver facilitates the reading and writing of data from numerous popular online services (refer to the complete list here) using familiar SQL language without learning complexity of REST API calls. The driver allows querying nested structure and output as a flat table. You can also create your own ODBC / Data Gateway API connector file and use it with this driver.

1. Intuitive Configuration: The interface is designed to be user-friendly, enabling users to easily set up the specific API endpoints within Jira without requiring extensive technical expertise or programming knowledge.

2. Customizable Endpoint Setup: Users can conveniently configure the API endpoint settings, including the HTTP request method, endpoint URL, and any necessary parameters, to precisely target the desired data within Jira.

3. Data Manipulation Capabilities: The ZappySys API Driver allows for seamless data retrieval and writing, enabling users to fetch data from Jira and perform various data manipulation operations as needed, all through an intuitive and straightforward interface.

4. Secure Authentication Integration: The driver provides secure authentication integration, allowing users to securely connect to the Jira API by inputting the necessary authentication credentials, such as API tokens or other authentication keys.

5. Error Handling Support: The interface is equipped with comprehensive error handling support, ensuring that any errors or exceptions encountered during the data retrieval or writing process are efficiently managed and appropriately communicated to users for prompt resolution.

6. Data Visualization and Reporting: The ZappySys API Driver facilitates the seamless processing and presentation of the retrieved data from Jira, enabling users to generate comprehensive reports and visualizations for further analysis and decision-making purposes.

Overall, the ZappySys API Driver serves as a powerful tool for streamlining the integration of applications with Jira, providing users with a convenient and efficient way to access and manage data, all through a user-friendly and intuitive interface.