Jira Connector
Documentation
Version: 11
Documentation

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. Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.

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

  3. Select New Connection to create a new connection:

    API Destination - Jira
    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!
    API Destination - New Connection

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

  5. 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!

    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
    ODBC DSN HTTP Connection Configuration
    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
    ODBC DSN HTTP Connection Configuration

    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).
  6. Click Generate Token to generate tokens.
  7. Finally, select Organization Id from the drop down.
  8. 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])
ODBC DSN Oauth Connection Configuration

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

    API Destination - Jira
    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!
    API Destination - Select Endpoint

  • Finally, map the desired columns:

    API Destination - Jira
    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!
    API Destination - Columns Mapping

  • 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 - Reading data from API Source and load into target