Creating and Configuring a Jira System of Record

Prerequisites

  • An Atlassian account with the following permissions:
    • Read all Jira Users
    • Read all Jira Issues

Configuring Jira

  1. Go to Atlassian ID Portal and login with an account you will use to synchronize data from Jira to SGNL

    Atlassian ID Portal

  2. Enter a label for the API key, click Create, and copy the API token that is created

    Jira - Create API key

  3. Save the API key in a temporary location. You will need this API key for completing configuration in SGNL

  4. In the Atlassian Admin app, browse to Products and note the Base URL for the Jira Software

    Jira - Copy Base URL

Configuring SGNL

  1. Login to the SGNL Console

  2. From the left menu, select Systems of Record

  3. Add a New System of Record and select Jira

  4. Enter the following data into SGNL:

    • Username: The username of the user with the necessary permissions and the owner of the API key
    • API Key: The API key created in Jira above
    • Base URL: The complete URL copied in step 5 in the previous section

    SGNL - Add Jira as a System of Record

  5. Save the configuration

  6. From the Entities tab, select Configure Entities, which should open the Unconfigured Entities section

    SGNL - Configure Entities

  7. Select the entity JiraIssue and the relevant attributes you need synchronized into SGNL, and Save

  8. Repeat (7) ofr JiraUser

    SGNL - JiraIssue and JiraUser Entities Configured

  9. (If applicable) Specify the attribute(s) that will join the entities you have configured to synchronize from Jira to other entities in the SGNL Graph

    SGNL - Join Configured Entities

  10. Save the configuration

  11. Once SGNL ingests User and Issue data from Jira, the number of Users and Issues should be displayed in the SGNL dashboard as shown below

SGNL - Jira System of Record Configuration Complete