Jira Connector for UiPathJira 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! In this article you will learn how to quickly and efficiently integrate Jira data in UiPath without coding. We will use high-performance Jira Connector to easily connect to Jira and then access the data inside UiPath. Let's follow the steps below to see how we can accomplish that! Jira Connector for UiPath is based on ZappySys API Driver which is part of ODBC PowerPack. It is a collection of high-performance ODBC drivers that enable you to integrate data in SQL Server, SSIS, a programming language, or any other ODBC-compatible application. ODBC PowerPack supports various file formats, sources and destinations, including REST/SOAP API, SFTP/FTP, storage services, and plain files, to mention a few. |
Connect to Jira in other apps
|
Create ODBC Data Source (DSN) based on ZappySys API Driver
Step-by-step instructions
To get data from Jira using UiPath we first need to create a DSN (Data Source) which will access data from Jira. We will later be able to read data using UiPath. Perform these steps:
-
Download and install ODBC PowerPack.
-
Open ODBC Data Sources (x64):
-
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.
-
Create and use User DSN
if the client application is run under a User Account.
This is an ideal option
-
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:
JiraDSNJira -
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.
Steps how to get and use Jira credentials
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!
Fill in all required parameters and set optional parameters if needed:
JiraDSNJiraAPI 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 Steps how to get and use Jira credentials
Follow official Atlassian instructions on how to create a PAT (Personal Access Token) for JIRAFill in all required parameters and set optional parameters if needed:
JiraDSNJiraPersonal 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 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:- 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!
Fill in all required parameters and set optional parameters if needed:
JiraDSNJiraOAuth (**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]) -
Once the data source connection has been configured, it's time to configure the SQL query. Select the Preview tab and then click Query Builder button to configure the SQL query:
ZappySys API Driver - JiraJira 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!JiraDSN -
Start by selecting the Table or Endpoint you are interested in and then configure the parameters. This will generate a query that we will use in UiPath to retrieve data from Jira. Hit OK button to use this query in the next step.
SELECT * FROM Issues
Some parameters configured in this window will be passed to the Jira API, e.g. filtering parameters. It means that filtering will be done on the server side (instead of the client side), enabling you to get only the meaningful datamuch faster . -
Now hit Preview Data button to preview the data using the generated SQL query. If you are satisfied with the result, use this query in UiPath:
ZappySys API Driver - JiraJira 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!JiraDSNSELECT * FROM Issues
You can also access data quickly from the tables dropdown by selecting <Select table>.AWHERE
clause,LIMIT
keyword will be performed on the client side, meaning that thewhole result set will be retrieved from the Jira API first, and only then the filtering will be applied to the data. If possible, it is recommended to use parameters in Query Builder to filter the data on the server side (in Jira servers). -
Click OK to finish creating the data source.
Video Tutorial
Read Jira data in UiPath Studio (workstation)
Here we will be reading Jira data on your workstation. To accomplish that we will create and run UiPath process package locally. Later on, we'll explore how to publish the package to Orchestrator and run it remotely. For now, let's focus on working locally and get started!
- Open UiPath Studio.
- Before we really begin the work, make sure UiPath Studio is set as your profile (blue application icon).
-
In case, it is set to UiPath StudioX, you can change it in UiPath StudioX Settings:
Simply select UiPath Studio option:
-
Start by creating a new project based on UiPath Process template:
-
Add Run Query activity in Main Sequence box:
-
Click Configure Connection... button to create an ODBC connection:
-
Continue by clicking Connection Wizard:
-
When the window opens, select ODBC-based driver, provider, and then choose ODBC data source:
JiraDSNJiraDSNYou can also select Use connection string option and use whole ODBC connection string instead. Obtain the connection string by pressing Copy Settings button in your data source configuration.
-
Once you do that, it's time to configure a SQL query:
Make sure, you enclose the query in double quotes!
-
Proceed by adding a Write CSV activity after Run Query:
In this article we are using Write CSV, but you can freely add any other destination of your choice, e.g. Write DataTable to Excel.
-
Once you do that, configure the added Write CSV, this will write Jira data to a CSV file:
-
It's time for fun! Which means it's time for debugging! Just run the package locally to debug:
-
Finally, ensure there are no execution errors!
Run UiPath package using Orchestrator (via robot)
UiPath also offers the ability to execute packages remotely using Orchestrator and a robot. This is achieved by publishing the package to UiPath Orchestrator, installing UiPath Assistant on the remote machine, connecting it to Orchestrator, enabling us to run the package remotely. It may sound complicated at first glance, but further steps will clear things out. Let's not waste our precious time and delve into the details!
Publish process package from UiPath Studio
- First of all, open the UiPath process package we created in the previous step
-
Set the option that our process package Starts in Background:
-
We are ready to Publish it:
-
Make sure, you publish it to the Shared folder in UiPath Orchestrator Tenant workspace:
-
Finally, success! We are ready for the next step - creating UiPath robot - so we can automate the job:
Create robot in UiPath Orchestrator
-
First of all, let's open UiPath Orchestrator from UiPath Automation Cloud console:
-
It's time to create a robot, which will run unattended packages:
-
But first we have to create a runtime. Choose to host our robot on-premise, not in UiPath infrastructure:
-
Let's move along and Create new machine template, this will create a machine in UiPath Orchestrator:
-
Configure the machine to run in Production environment:
-
We are ready to Create new robot account in the new machine:
-
Let's make our robot to work only on background automations:
-
Continue by selecting newly created robot:
-
Select Shared folder, so that everyone in the team can benefit from it:
This is the folder where we published our UiPath process package "MyProcess"
-
We are almost done!
We are given machine Client ID and Client secret which we will use to connect UiPath Assistant to our created machine in Orchestrator.
Let's leave this open for a while and see how we can do it in the next step.
Connect UiPath Assistant to Orchestrator
We are ready to connect UiPath Assistant to the machine we created in Orchestrator. UiPath Assistant will run our package in a remote machine. Let's connect it and give it some work!
- Connect to a remote machine (where your UiPath process package will be running).
- Install UiPath Studio there.
- Then configure ODBC data source:
If you chose Use user or system data source option in connection configuration, when creating UiPath process package, then create an identical ODBC data source on the same remote machine. Use the same configuration as the one created in your workstation in the first step.
Use Copy Settings and Load Settings buttons to make your life easier. They will help you to transfer settings between different ODBC data sources.If you chose Use connection string option, then you don't have to do anything. However, you still have to install ODBC PowerPack on the remote machine.
-
Continue by opening UiPath Assistant and going to Preferences:
-
Find Orchestrator Settings menu item and click it:
-
And here even bigger fun begins! But fear not, all you have to do is open your web browser window with Client ID & Client secret we obtained in the previous step and simply copy and paste those values into UiPath Assistant. Also, don't forget to configure Orchestrator URL:
-
Finally, we get rewarded for the hard work with the Connected as Unattended status:
Create and run UiPath process in Orchestrator
We are at the finish line! Let's create and run UiPath process. This will execute the package on your remote machine using the UiPath Assistant configured earlier.
- First of all, open UiPath Orchestrator from UiPath Automation Cloud console.
-
Then proceed by going to Process in Shared folder:
-
Continue by simply clicking on Add process button:
-
Select the process package we created in UiPath Studio:
-
Rest a while, and just hit Next, unless your package has requirements:
-
Then simply hit Create button:
-
But let's not stop here and Start the process by creating a job right away:
-
Use the same Production runtime we created before and hit Start:
-
We've reached the final step! In the CSV destination file or destination of your choice you should see Jira data:
Actions supported by Jira Connector
Learn how to perform common Jira actions directly in UiPath 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
- Generic Request
- Generic Request (Bulk Write)
Conclusion
In this article we showed you how to connect to Jira in UiPath and integrate data without any coding, saving you time and effort. It's worth noting that ZappySys API Driver allows you to connect not only to Jira, but to any Java application that supports JDBC (just use a different JDBC driver and configure it appropriately).
We encourage you to download Jira Connector for UiPath 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 UiPath Documentation
More integrations
Other connectors for UiPath
Other application integration scenarios for Jira
How to connect Jira in UiPath?
How to get Jira data in UiPath?
How to read Jira data in UiPath?
How to load Jira data in UiPath?
How to import Jira data in UiPath?
How to pull Jira data in UiPath?
How to push data to Jira in UiPath?
How to write data to Jira in UiPath?
How to POST data to Jira in UiPath?
Call Jira API in UiPath
Consume Jira API in UiPath
Jira UiPath Automate
Jira UiPath Integration
Integration Jira in UiPath
Consume real-time Jira data in UiPath
Consume real-time Jira API data in UiPath
Jira ODBC Driver | ODBC Driver for Jira | ODBC Jira Driver | SSIS Jira Source | SSIS Jira Destination
Connect Jira in UiPath
Load Jira in UiPath
Load Jira data in UiPath
Read Jira data in UiPath
Jira API Call in UiPath