User Guide
Before you start
Jira Cloud administrator should grant you permission to create, edit, watch and export connectors. If you don't have access to these actions, please contact your Jira Cloud Administrator to grant SQL Connector for Jira permissions first. Jira Administrators can always access application configurations.
3 steps to export data from Jira to SQL
1. Create a Jira API Token
Go to Account settings
2. Click a Create and manage API tokens link in the Security tab
3. Click the Create API token button
4. Enter an API token name and click Create
5. Make sure you copy your new API token. You won’t be able to see the token again.
6. Go to Apps > SQL Connector for Jira
7. Enter the token into Tokens > Jira API token, and click Validate & Save.
2. Create a Data Source in SQL Connector for Jira
To create a Data Source, open SQL Connector for Jira and click on the Create Data Source button.
Below you can find a description of the fields, buttons, and settings of the data source creating page:
Title section
Allows you to do operations with creating such fields as:
1. Name - Enter data source name
2. Description - Enter data source description
3. Share settings - You may share this data source with users or groups of users who have permission to use the application. To share the data souce click Share settings button.
Select groups - select and add relevant users group
Select users - select and add relevant users
Save - click to apply changes.
Please note! Other users who have access to SQL Connector for Jira app might not get all data from this data source due to different Jira permissions.
Filter issues section
This section is suitable for applying the filter groups which are presented in the screenshot:
4. All - choose if you want to export all existing issues.
5. Select by JQL - choose if you want to use JQL to create your own request and filter data.
JQL, or Jira Query Language, is a flexible tool that allows you to search for issues, projects, etc in Jira and pinpoint exactly what you are looking for.
Enter the JQL expression and click Validate JQL button to validate it.
Please note! Without JQL validation you won’t be able to create data source (button Save will be disabled).
6. Basic - choose if you want to use standard fields filters. To set up Basic filter click Issue filter button.
Select issue filters from the list of available:
Projects
Issue Types
Statuses
Also you are able to select from the list the time intervals in which the issue was created or updated:
Created from
Created to
Updated from
Updated to
Click Apply to apply the filter.
Select Fields section
Provides you to to apply such a possibilities:
7. Search field - enter the field name that you want to find and add for exporting
8. Magnifier - click to search the required item you want to add to your data source.
9. Clear the search field
10. View options — tap to sort issues by their Names/IDs/Types.
11. Tabs with Jira Fields - displays a list of all Jira fields and tables you can export.
Note! The list of fields and items you can export is determined by your current Jira edition and add-ons.
12. Issues - one of the issue files subsection. Choose if you want to add all fields in a certain subsection.
13. Checkbox - check the box with the required field.
The “Apply” section
After editing a data source, you can choose one of the options for what to do with it:
14. Save- click to create a data source.
15. Preview - Click to check the source name/description/issue filters/export items.
16. Preview ERD - Click to see the Entity Relationship Diagram for your Connector for the tables and fields you’ve selected.
17. Close - leave data source creating page. Changes you’ve made will not be saved.
When selecting the Preview button(15) you will see all changes you’ve done in the pop-up window so that you can ensure that all displayed changes are correct and no more changes are needed.
Preview ERD(16) shows you an Entity Relationship Diagram for the tables and fields selected in the connector.
3. Export Data into the Database
In the SQL Connector for Jira find the data source you want to export and click the Export data button.
2. If it’s the first time you’re exporting data from this data source, you’ll see a prompt asking you to either set a new connection or use an existing one.
3. Select or configure the connection and click Save.
4. Click the Export data button again. You won’t need to click this button twice once the connection is set up. The button status will change to Cancel export while the data is loading, so you can cancel it anytime. The data source can have statuses: Not Exported, Exported, Loading, or Error (in this case, you can click the info icon near the error and see what’s wrong).
If you’re using SQL Connector for Jira, find a few minutes to leave us honest review.
Additional Features
Click Auto-Export To set up daily data autorefresh, select the Auto-Export option.
To make changes to the Connector, select Edit item.
To remove the data source, press the Delete option.
To distribute the Data Source to users who have permissions to use this plugin, select the Share option.
To make a copy of the data source, choose the Clone option.
To transfer the data source's ownership, click the Change owner option.
To set the connection to DB, select the Set SQL Database option.
How to Set Up Auto-Export
Go to the right menu of the data source, and click Auto-Export. Now you can enable/disable the automatic data export to the selected database and set the time for the daily autorefresh. Please note that the time is set in the UTC format.
How to View Entity Relationship Diagram
SQL Connector for Jira automatically builds relations between tables and fields in SQL. When you upload your Jira data into SQL, all tables will be connected in relations based on the logical key field. Thus, users don’t need to relate tables, which is time-consuming manually.
You can preview ERD while creating a data source to ensure that the application's relations will be correctly built. To do this, you can use one of the options below.
During data source creation, click the Preview ERD button below before you save the data source.
You will see the ERD for the selected data source.
How to Change the Owner of the Data Source
SQL Connector for Jira allows a change of owner for the data sources. In this case, the person who created the data source will no longer see this data source in his/her list, but the data source will appear in another user's list.
The new owner can see, edit, delete and share the data source.
To change the selected data source owner, go to the right menu and click Change owner.
Select the user you wish to give ownership to the data source → click Submit.
How to Share the Data Source with Other Users
Jira user who has created the data source can share it with other Jira users and/or user groups having permissions to work with SQL Connector for Jira, granted by the Jira admin.
Go to the right menu of the data source you need to distribute and click Share.
Select users and/or user groups you wish to share the data source with, then click Save.
When you’re done, the users will see this data source in the Shared with me tab.
How to View the Data Sources History
Go to Administration → Data Sources History. It displays all changes performed to the data sources by all users, such as creating, editing the fields or filters, sharing, changing owner, etc.
