Extracting Data From Jira

Prior to setting up data extraction from Jira familiarize yourself with the latest implementation notes at Jira Connector.

To extract data from Jira

1. On the Home page select a space or create a new one. This is the space to which the data will be uploaded.
2. Go to Admin - Define Sources - Application Connectors. Alternatively, click the Use Extractors link on the Admin Navigation page.
3. Click New in the Connections panel.
4. In Connection Details name the connection.
5. Select Jira as the Connector Type.
6. Set the Connector API Version.

For new spaces, select the latest API version (highest version number). 

For existing spaces, test the latest API version before changing from the default API version to the latest API version.

Birst determines which version is the default. If the selected API version is no longer available in Birst, the default API version will be automatically assigned. If the default API version is selected, when Birst changes to a new API version as the default, existing spaces will be automatically upgraded to the new default API version.

g. Enter your email address and API token.
Tips:Your user account must have Administrator permissions.
h. Enter the Jira base URL that your company uses to connect to your Jira site, such as https://myCompany.atlassian.net.
i. Click Test Connection to verify the login and URL.
j. Specify a Source File Prefix. This alphanumeric string will be prepended to the data source names so that you can easily recognize them and differentiate objects that may have similar names from different data sources. For example, use the string "JIRA" to easily identify Jira objects.
k. Click Save Connection. The Data Sources panel appears under the Connections panel.  
12. Click Add Object.
13. Enter the Object Name from Jira. For the list of supported objects see About the Jira Connector.
14. Enter the Object Label to use in Birst. Do not use the same name as an existing saved object in the Data Sources list.
If you edit an object and change the object label, a new object will be created with this name.
15. Click Get Columns.
Birst populates the Columns and Mapping fields. The Columns field contains each of the columns in the source separated by commas, and uses the "technical name" from Jira. The Mapping field contains the name of each column in the source, an equal sign, then the name it will be mapped to in Birst. By default the Mapping field is the "friendly name" from Jira.

16. Edit the Columns field to specify only the columns you need for reporting by deleting ones you don't need. For example, you may not need all of the custom fields.
17.  Edit the Mapping field list so that it contains only the mappings for the columns in the Columns field.
18. Optionally, change the name of the column in Birst by changing the name after the equal sign.  
Important: Do not modify the =true or =false texts.
Tip: Once you change a column name in the Mapping field, and Birst extracts the column and lists it in the Columns tab of the Manage Sources page, you cannot change it again. If you change the column name in the Mapping field again, then extract again, the column name in Birst will not be changed. You can change the Mapping field column name in the Columns tab of Manage Sources, if necessary.
19. Optionally, enter Selection Criteria that will filter the result set. Use the Jira Query Language (JQL).
Tip: You can copy and paste a query from the Jira UI.
20. Click Validate to validate the syntax. 
21. Click Save. Birst adds it to the list of objects to be extracted in the Data Sources table, ready for extraction. 

Tip: To edit the object, click on the hyperlinked name.
22. Optionally, select the row and enter the name of one or more extract groups, separated by commas, in the Extract Group Name(s) field. Extract groups make it possible to extract specific objects and process them separately from other objects.  See Creating Extract Groups.  

Important: Use the same extract group for Issue and its sub-objects.



Click Save after adding extract group names.
23. Click Extract to upload the selected objects to Birst. The Extract Groups dialog prompts you to select the extract group or groups to use. If you did not define extract groups it defaults to All.

Selecting All in the Extract Group dialog box will extract all selected objects, including those that do not belong to extract groups.
24. Click Continue. Birst displays an indicator to show that the extraction is in progress.

Depending on the size of the data objects, the extraction may take a few minutes. When the extraction completes Birst lists the date and time of the extraction in the Data Sources table of the Show Selected Objects view.

Tips:

You can safely log out of Birst while the extraction takes place and log back in later.

To cancel the extraction, click the Cancel Extract link under the progress bar. 

Click the Last Extract Log link to view the logs from the data extraction and check for errors. 

To remove an object from the Data Sources list, select the row and click Remove on the right.

Next Steps

Look at the raw data in Manage Sources page. Iterate the extraction process, if needed, to get the data you expect.  

Process the data in the Process Data - Process New Data page. See Processing Data.

Set up scheduling in the Process Data - Schedule Data Processing page. See Scheduling Extraction and Data Processing for Cloud Applications.