Jira Connector for SSIS

Jira Connector can be used to integrate Jira and your defined data source, e.g. Microsoft SQL, Oracle, Excel, Power BI, etc. Get, write, delete Issues, Users, Worklogs, Comments just in a few clicks!
You can use this connector to integrate Jira data inside SSIS and SQL Server. Let's take a look at the steps below to see how exactly to accomplish that.

Download Documentation

Video Tutorial - Integrate Jira data in SSIS

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 SSIS
  • How to configure connection for Jira
  • Features about API Source (Authentication / Query Language / Examples / Driver UI)
  • Using Jira Connection in SSIS

Prerequisites

Before we perform steps listed in this article, you will need to make sure following prerequisites are met:
  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft site).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. Make sure ZappySys SSIS PowerPack is downloaded and installed (download it). Check Getting started section for more information.

Read data from Jira in SSIS (Export data)

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

  1. Begin with opening Visual Studio and Create a New Project.

  2. Select Integration Service Project and in new project window set the appropriate name and location for project. And click OK.

  3. In the new SSIS project screen you will find the following:

    1. SSIS ToolBox on left side bar
    2. Solution Explorer and Property Window on right bar
    3. Control flow, data flow, event Handlers, Package Explorer in tab windows
    4. Connection Manager Window in the bottom
    SSIS Project Screen
    Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link.

  4. Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
    SSIS Data Flow Task - Drag and Drop

  5. From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
    SSIS API Source (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:
    API Source - New Connection

  7. Use a preinstalled Jira Connector from Popular Connector List or press Search Online radio button to download Jira Connector. Once downloaded simply use it in the configuration:

    Jira
    Jira Connector Selection

  8. Proceed with selecting the desired Authentication Type. Then select API Base URL (in most cases default one is the right one). Finally, fill in all the required parameters and set optional parameters if needed. You may press a link Steps to Configure which will help set certain parameters. More info is available in Authentication section.

    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!

    Configuring authentication parameters
    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
    ZappySys Http Connection
    Steps how to get and use Jira credentials
    Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRA
    Configuring authentication parameters
    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
    ZappySys Http Connection

    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: Create OAuth integration app in Atlassian
    3. Give your app a name, accept the terms and hit Create: Name OAuth app in Atlassian
    4. To enable permissions/scopes for your application, click Permissions tab, then hit Add button, and click Configure button, once it appears: Enable scopes in OAuth app in Atlassian
    5. Continue by hitting Edit Scopes button to assign scopes for the application: Edit scopes in OAuth app in Atlassian
    6. Select these scopes or all of them: Add Jira scopes in OAuth app in Atlassian
    7. Then click Authorization option on the left and click Add button: Add authorization in OAuth app in Atlassian
    8. Enter your own Callback URL (Redirect URL) or simply enter https://zappysys.com/oauth, if you don't have one:
    9. Set callback URL for OAuth app in Atlassian
    10. Then hit Settings option and copy Client ID and Secret into your favorite text editor (we will need them in the next step): Get Jira data via REST API and OAuth
    11. 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).
  9. Click Generate Token to generate tokens.
  10. Finally, select Organization Id from the drop down.
  11. That's it! You can now use Jira Connector!

Configuring authentication parameters
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])
ZappySys OAuth Connection