Administrator Guide

All SQL Connector for Jira settings can be made on one page. Therefore, the instructions below show how to find the plugin settings page and describe all available configurations.

 

How to configure SQL Connector for Jira?

 

You can get to the application settings page in 2 options:

 

1st Option

Click SQL Connector Tab on Jira’s main menu. Then choose Administration.

2nd Option

Step 1. Go to Jira Administration tab and select Manage apps section.

Step 2. On the left side menu panel find the “SQL Connector” tab and click Plugin settings.

SQL Connector for Jira settings page

 

Below you will find a description of the SQL Connector for Jira settings:

 

 

1. Reset to defaults

This action will restore plugin settings to defaults, delete all Data Sources and user permissions.

 

2. Edit user permissions

To be able to import data from Jira into your SQL database Jira administrator should grant permission to create, edit, watch, and export connectors.

These settings grant users and groups permission.

  1. Select users - start typing to find and add relevant users.

  2. Select groups - start typing to find and add relevant users group.

  3. Select project roles - start typing to find and add relevant project roles.

  4. Save - apply permissions.

3. General Settings

Jira administrators have the ability:

  1. Set an Issues Limit - a maximum number of issues that can be exported at an instance level.

  2. Set a Fields Threshold - a maximum number of fields that can be exported without a warning message.

  3. Save to apply settings.

General Settings help to:

  • stop misuse of the addon

  • drop the considerable strain on JIRA

  • improve time to export

 

4. Logging Settings

A helpful tool for debugging the plugin. It’s recommended to turn it on only for troubleshooting cases and to turn it off right after receiving enough data to analyze issues.

  1. Enable/Disable Data Export debug mode - enable writing detailed unload log to separate file. Toggle to turn it ON and OFF (debug mode affects the instance's performance, so it’s highly recommended to turn it OFF after getting all necessary debug info).

  2. Enable/Disable Internal debug mode - enable writing detailed unload log to separate file. Toggle to turn ON/OFF for logging all actions performed with data sources except data export (creating, editing, cloning, changing owner, etc.).

  3. Data Export Log File Size Limit - Maximum log file size (0 to 100 megabytes).

  4. Internal Log File Size Limit - Maximum log file size (0 to 100 megabytes).

  5. Save to apply settings.

  6. Refresh logs.

  7. Clear logs.

  8. Download logs so you can send them to the SQL Connector for Jira support team

  9. Select file format (Log or Zip)

 

To minimize debug mode’s impact on the instance, please follow these simple steps:

  1. Create a data source with one selected table. It’s recommended to enable filtering to reduce data amount to export. See https://aserve.atlassian.net/wiki/spaces/SCFJ/pages/2685108242 if you need detailed instructions on how to create a data source.

  2. Go to Logging Settings.

  3. Clear previous logs, set a Log File limit, Save changes, and Enable debug mode.

  4. Open your SQL database, and start data export.

  5. After data export is completed, get back to Logging Settings, Disable debug mode, and download the file.

 

At the moment, the output of the following tables is being logged:

Jira Core

Jira Software

Service Management

Tempo

Insight

Xray

Tempo Budgets

Jira Core

Jira Software

Service Management

Tempo

Insight

Xray

Tempo Budgets

  • Issues (Issues, Issue Effort, Parent Issues, Epics)

  • Issue Links

  • Issue Custom Fields (Issues or custom table)

  • History (Histories, Time in Statuses, Time at Assignee)

  • Projects

  • Sprints

  • Sprint Issues

  • Boards

  • Board Charts

  • Sprint Report Charts

  • Burndown Charts

  • Board Issues

  • Approvers

  • Customer Request Type

  • Request Participants

  • Customer Request Type

  • Request Participants

  • Another Service Management Fields (Issues)

  • Tempo (Issues)

  • Teams

  • Object Schema

  • Object

  • Object Type

  • Object Type Attribute

  • Status Type

  • Role

  • Insight Attribute Value

  • Test Runs

  • Folios

  • Expenses

  • Human Resources

  • Rates

  • Allocations

5. Custom Fields Map

Select Custom Field defined as Story Points in your system. Click Save.