Jira Connector for SSISJira 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 SSIS without coding. We will use high-performance Jira Connector to easily connect to Jira and then access the data inside SSIS. Let's follow the steps below to see how we can accomplish that! Jira Connector for SSIS is based on ZappySys API Connector Framework which is a part of SSIS PowerPack. It is a collection of high-performance SSIS connectors that enable you to integrate data with virtually any data provider supported by SSIS, including SQL Server. SSIS PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few (if you are new to SSIS and SSIS PowerPack, find out more on how to use them). |
Connect to Jira in other apps
|
Video Tutorial - Integrate Jira data in SSIS
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:
- SSIS designer installed. Sometimes it is referred as BIDS or SSDT (download it from Microsoft).
- Basic knowledge of SSIS package development using Microsoft SQL Server Integration Services.
- 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.
-
Begin with opening Visual Studio and Create a New Project.
-
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
Note: If you don't see ZappySys SSIS PowerPack Task or Components in SSIS Toolbox, please refer to this help link. -
Now, Drag and Drop SSIS Data Flow Task from SSIS Toolbox. Double click on the Data Flow Task to see Data Flow designer.
-
From the SSIS toolbox drag and API Source (Predefined Templates) on the data flow designer surface, and double click on it to edit it:
-
Select New Connection to create a new connection:
-
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 -
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:
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:
JiraAPI Key based Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill-in the parameter... Atlassian User Name (email) Fill-in the parameter... API Key Fill-in the parameter... Optional Parameters CustomColumnsRegex Jira authentication
Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRAAPI 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:
JiraPersonal Access Token (PAT) Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill-in the parameter... Token (PAT Bearer Token) Fill-in the parameter... Optional Parameters CustomColumnsRegex 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 ismycompany.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:
JiraOAuth (**Must change API Base URL to V3 OAuth**) [OAuth]https://[$Subdomain$].atlassian.net/rest/api/3Required 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]) -
Select the desired endpoint, change/pass the properties values, and click on Preview Data button to make the API call.
API Source - JiraJira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details -
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)
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.
-
Read the data from the source, being any desired source component. In example we will use ZappySys Dummy Data Source component.
-
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.
-
Select New Connection to create a new connection:
API Destination - JiraJira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details -
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 -
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.
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:
JiraAPI Key based Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill-in the parameter... Atlassian User Name (email) Fill-in the parameter... API Key Fill-in the parameter... Optional Parameters CustomColumnsRegex Jira authentication
Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRAAPI 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:
JiraPersonal Access Token (PAT) Authentication [Http]https://[$Subdomain$].atlassian.net/rest/api/3Required Parameters Subdomain Fill-in the parameter... Token (PAT Bearer Token) Fill-in the parameter... Optional Parameters CustomColumnsRegex 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 ismycompany.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:
JiraOAuth (**Must change API Base URL to V3 OAuth**) [OAuth]https://[$Subdomain$].atlassian.net/rest/api/3Required 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]) -
Select the desired endpoint, change/pass the properties values, and go to the Mappings tab to map the columns.
API Destination - JiraJira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details -
Finally, map the desired columns:
API Destination - JiraJira connector can be used to read, write, delete Issues, Users, Worklogs, Comments, Projects, Custom fileds and many other details -
That's it; we successfully configured the POST API Call. In a few clicks we configured the Jira API call using ZappySys Jira Connector
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
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.
-
From the SSIS Toolbox drag-and-drop Upsert Destination component onto the Data Flow designer background.
-
Connect your SSIS source component to Upsert Destination.
-
Double-click on Upsert Destination component to open configuration window.
-
Start by selecting the Action from the list.
-
Next, select the desired target connection or create one by clicking <New [provider] Connection> menu item from the Target Connection dropdown.
-
Then select a table from the Target Table list or click New button to create a new table based on the source columns.
-
Continue by checking Insert and Update options according to your scenario (e.g. if Update option is unchecked, no updates will be made).
-
Finally, click Map All button to map all columns and then select the Key columns to match the columns on:
-
Click OK to save the configuration.
-
Run the package and Jira data will be merged with the target table in SQL Server, PostgreSQL, or Redshift:
-
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:
Actions supported by Jira Connector
Learn how to perform common Jira actions directly in SSIS with these how-to guides:
- Create Issue Comment
- Create Issues
- Create Project
- Create User
- Create Worklog
- Delete Issue
- Delete Issue Comment
- Delete Project
- Delete User
- Delete Worklog
- Get custom field context options
- Get custom field contexts
- Read Application Roles
- Read Changelog Details
- Read Changelogs
- Read Changelogs by IDs
- Read Comments
- Read Custom Fields
- Read Fields
- Read Groups
- Read Issue Types
- Read Issues
- Read Projects
- Read Resources
- Read Users
- Read Worklogs
- Update Issue
- Update Issue Comment
- Update Worklog
- Upsert Project
- Make Generic API Request
- Make Generic API Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Jira in SSIS and integrate data without any coding, saving you time and effort.
We encourage you to download Jira Connector for SSIS and see how easy it is to use it for yourself or your team.
If you have any questions, feel free to contact ZappySys support team. You can also open a live chat immediately by clicking on the chat icon below.
Download Jira Connector for SSIS Documentation