How to integrate Jira using SSIS

Integrate SSIS and Jira
Integrate SSIS and Jira

Learn how to quickly and efficiently connect Jira with SSIS for smooth data access.

Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required. You can do it all using the high-performance Jira Connector for SSIS. We'll walk you through the entire setup.

Ready to dive in? Download the product to jump right in, or follow the step-by-step guide below to see how it works.

Video Tutorial

This video covers the following topics and more, so please watch carefully. After watching the video, follow the steps outlined in this article:

  • How to download and install the required PowerPack for Jira integration in SSIS
  • How to configure the connection for Jira
  • Features of the ZappySys API Source (Authentication / Query Language / Examples / Driver UI)
  • How to use the Jira in SSIS

Prerequisites

Before we begin, make sure the following prerequisites are met:

  1. SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
  2. Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
  3. SSIS PowerPack is installed (if you are new to SSIS PowerPack, then get started!).

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.

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

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • 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.

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

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

  5. Select New Connection to create a new connection:

    API Source - New Connection

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

  7. Now it's time to configure authentication. Firstly, configure authentication settings in Jira service and then proceed by configuring API Connection Manager. Start by expanding an authentication type:

    API Key based Authentication

    Jira authentication
    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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to API Key based Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

    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:

    1. Set Authentication Type to Personal Access Token (PAT) Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

    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:

    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:

      Set callback URL for OAuth app in Atlassian

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

    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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    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])
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

  8. Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.

    API Source - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    API Source - Select Endpoint

  9. That's it! We are done! Just in a few clicks we configured the call to Jira using Jira Connector.

    You can load the source data into your desired destination using the Upsert Destination , which supports SQL Server, PostgreSQL, and Amazon Redshift. We also offer other destinations such as CSV , Excel , Azure Table , Salesforce , and more . You can check out our SSIS PowerPack Tasks and components for more options. (*loaded in Trash Destination)

    Execute Package - Reading data from Jira and load into target

Write data to Jira using SSIS (Import data)

In this section we will learn how to configure and use Jira Connector in the API Destination to write data to Jira.

Video tutorial

This video covers following and more so watch carefully. After watching this video follow the steps described in this article.

  • How to download SSIS PowerPack for Jira integration in SSIS
  • How to configure connection for Jira
  • How to write or lookup data to Jira
  • Features about SSIS API Destination
  • Using Jira Connector in SSIS

Step-by-step instructions

In upper section we learned how to read data, now in this section we will learn how to configure Jira in the API Source to POST data to the 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.

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

    • SSIS ToolBox on left side bar
    • Solution Explorer and Property Window on right bar
    • Control flow, data flow, event Handlers, Package Explorer in tab windows
    • 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.

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

  4. Read the data from the source, using any desired source component. You can even make an API call using the ZappySys JSON/XML/API Source and read data from there. In this example, we will use an OLE DB Source component to read real-time data from a SQL Server database.

  5. From the SSIS Toolbox drag and drop API Destination (Predefined Templates) on the Data Flow Designer surface and connect source component with it, and double click to edit it.
    SSIS API Destination (Predefined Templates) - Drag and Drop

  6. Select New Connection to create a new connection:

    API Destination - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    API Destination - Jira

  7. To configure the Jira connector, choose one of the following methods:

    • Choose from Popular Connector List: Select a pre-installed service directly from the dropdown menu.
    • Search Online: Use this to find and download a new connector file to your computer.
    • Use Saved/Downloaded File: Once the file is downloaded, browse your local drive to load it into the configuration.

    After that, just click Continue >>:

    Jira
    API Destination -

  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.

    API Key based Authentication

    Jira authentication
    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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to API Key based Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

    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:

    1. Set Authentication Type to Personal Access Token (PAT) Authentication [Http]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Finally, hit OK button:
    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
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys Http Connection

    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:

    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:

      Set callback URL for OAuth app in Atlassian

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

    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!
    API Connection Manager configuration

    Just perform these simple steps to finish authentication configuration:

    1. Set Authentication Type to OAuth (**Must change API Base URL to V3 OAuth**) [OAuth]
    2. Optional step. Modify API Base URL if needed (in most cases default will work).
    3. Fill in all the required parameters and set optional parameters if needed.
    4. Press Generate Token button to generate the tokens.
    5. Finally, hit OK button:
    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])
    RetryMode RetryWhenStatusCodeMatch
    RetryStatusCodeList 429
    RetryCountMax 5
    RetryMultiplyWaitTime True
    ZappySys OAuth Connection

  9. Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.

    API Destination - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    API Destination - Jira

  10. Finally, map the desired columns:

    API Destination - Jira
    Read and write Jira data effortlessly. Track, manage, and automate issues, projects, worklogs, and comments — almost no coding required.
    API Destination - Jira

  11. That's it; we successfully configured the POST API Call. In a few clicks we configured the Jira API call using ZappySys Jira Connector

    Execute Package

Load Jira data into SQL Server using Upsert Destination (Insert or Update)

Once you configured the data source, you can load Jira data into SQL Server using Upsert Destination.

Upsert Destination can merge or synchronize source data with the target table. It supports Microsoft SQL Server, PostgreSQL, and Redshift databases as targets. Upsert Destination also supports very fast bulk upsert operation along with bulk delete.

Upsert operation - a database operation which performs INSERT or UPDATE SQL commands based on record's existence condition in the target table. It inserts records that don't have matching records in the target table or updates them, if they do, by matching them by key columns.

Upsert Destination supports INSERT, UPDATE, and DELETE operations, so it is similar to SQL Server's MERGE command, except it can be used directly in SSIS package.

  1. From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.

  2. Connect your SSIS source component to Upsert Destination.

  3. Double-click on Upsert Destination component to open configuration window.

  4. Start by selecting the Action from the list.

  5. Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.

  6. Then select a table from the Target Table list or click New button to create a new table based on the source columns.

  7. Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).

  8. Finally, click Map All button to map all columns and then select the Key columns to match the columns on:

    Configure SSIS Upsert Destination component to merge data with SQL Server, PostgreSQL, or Redshift table

  9. Click OK to save the configuration.

  10. Run the package and Jira data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:

    Execute Package - Reading data from API Source and load into target

  11. Done!

Deploy and schedule SSIS package

After you are done creating SSIS package, most likely, you want to deploy it to SQL Server Catalog and run it periodically. Just follow the instructions in this article:

Running SSIS package in Azure Data Factory (ADF)

To use SSIS PowerPack in ADF, you must first prepare Azure-SSIS Integration Runtime. Follow this link for detailed instructions:

Supported Jira Connector actions

Got a specific use case in mind? We've mapped out exactly how to perform a variety of essential Jira operations directly in SSIS, so you don't have to figure out the setup from scratch. Check out the step-by-step guides below:

Conclusion

In this article we showed you how to connect to Jira in SSIS and integrate data without writing complex code — all of this was powered by Jira Connector.

Download SSIS PowerPack now or ping us via chat if you have any questions or are looking for a specific feature (you can also reach out to us by submitting a ticket):

Download Chat

Explore SSIS connectors

All
Big Data & NoSQL
Database
CRM & ERP
Marketing
Collaboration
Cloud Storage
Reporting
Commerce
API & Files

More Jira integrations

All
Data Integration
Database
BI & Reporting
Productivity
Programming Languages
Automation & Scripting
ODBC applications