Prerequisites
JIRA Sub-domain
JIRA Username
JIRA API Token
Create an API Token in JIRA
Open Atlassian. Login to your account.
In the upper right corner, click your profile icon.
In the drop-down menu, click "Account Settings".
In the Atlassian Account page, navigate to the Security tab:
Scroll until you find the "API token" section, and click on "Create and manage API tokens".
Click the "Create API token" button to generate a new token. If you have existing tokens, this button will appear at the top of the page; if this is your first token, the button will appear at the bottom.
Give the API token a custom label when prompted in the pop-up window.
After assigning a label, click "Copy" and ensure that you can access this token to later paste in the Savant authentication process.
Close the pop-up window and you will see your new token listed on the API tokens page.
System Setup Instructions
Add a New System
Login to Savant.
Click on "Data" in the top menu.
Toggle to the "Systems" tab in the upper left.
Click the "New System" button. This will take you to a page with a list of all available connected systems in Savant.
Scroll or search among the selections for JIRA and select the icon, then click "Next".
Authenticate & Confirm
Enter the following information into the required fields:
Sub-domain: The portion of the URL before atlassian.net (e.g. savant-labs.atlassian.net)
Username: Atlassian username. Usually an email.
API Token: The API token you created in Atlassian
Click "Authenticate".
[Optional] Rename the System and add a Description.
Click "Confirm".
Your new JIRA system is now authenticated in Savant!
You can find your new system by going to Data > Systems:
Creating Datasets from JIRA
Connect to Authenticated JIRA System
If you are working within an analysis, on the top left side of your canvas, click the Add Dataset button shown below:
Select your JIRA system connection.
NOTE: If you are not currently within an analysis, you can add a dataset by navigating to Data and selecting New Dataset. Select your authenticated JIRA system from the list of available options and click Next.
Configure Dataset
Click the Object drop-down menu. There you will find the following options:
Issues
Worklogs
Select an Object and click "Apply".
Check the boxes next to all columns you want to include in your dataset, and uncheck the boxes next to all columns you want to exclude.
Click "Next".
NOTE: Not sure which Object to select? Refer to the "Supported Objects and Fields" section below to determine which Object contains the fields your dataset requires.
Name & Describe
[Optional] Rename the dataset and add a Description.
Click "Confirm".
Your new JIRA dataset is now added to Savant!
You can find your new dataset by going to Data > Datasets:
If you added the dataset from an analysis, you will now see the dataset icon on your canvas:
Supported Objects and Fields
Object | Fields | Notes |
Issues | (126 Total)
|
|
Worklogs | (19 Total)
| The following fields can be selected as Incremental update keys:
|
Publishing Data to JIRA
On the top left side of your canvas, click the Add Destination button:
Select your JIRA destination system from the listed options.
Give your destination a name and description and click Next.
Navigate to the destination configuration window on the right. Click the Object drop-down menu with the following options:
Issues
Worklogs
Select an Object from the drop-down menu.
In the Record Preferences section, notice that the default (and only) option is to "Upsert" the destination. This updates existing records when there is an overlap with this data and add the rest of this data as new records.
Reference the Map Fields section and set the Flow Output columns (Savant analysis) to match the Destination System fields (JIRA destination) as desired. If you would like a destination field to remain blank, select "---".
Click "Apply".
NOTE: If you need to add a new system as a destination, click New System and re-follow the authentication steps above to add your new JIRA system.
Savant is now ready to publish data to your JIRA destination!