Ticketing Tools
      Back to home
      1. Help Center
      2. Integrations
      3. Ticketing Tools

      Jira Issue Tracking - User Guide

      In this article, you will understand step by step how to easily integrate with Jira

      Permissions

      Permissions for API actions are inherited from the creator of the key. The permissions scope are:

      • read:jira-work
      • read:jira-user
      • read:permission:jira

      Prerequisites

      The user creating an API token needs Jira Administrator permissions to access workflow data. The Org Admin, who is the default owner in your organization, or a user with Product admin permissions can create the token. You can assign these permissions as needed.
      • Navigate to the users directory in Atlassian Administration and select the user you want to assign the role to.
       


      • Click on Grant access.

      • Select Product admin under Jira Administration, and then click Grant access.

       
      2. You should define at least one Done status in your workflows. Scytale only collects resolved tickets from Jira, so without any resolution (green) status in your workflow, it will be unable to collect any tickets.

      2.1 Ensure that the Resolution is set to the correct value when transitioning to a resolution state. For instance, when transitioning the ticket to a Done status, the Resolution should also be set to Done. Here's how you can verify it.
        • Go to Edit menu of the workflow
        • Click on the transition to resolution status and on the Post Functions

       

        • Make sure the Resolution is set to a proper value when issue is being moved to resolution status

       

      Connecting Scytale & Jira

      1. Generate API token in Jira

      1. To create API tokens, click on the below link: https://id.atlassian.com/manage-profile/security/api-tokens
      2. Click on "Create API token" button


       

      3. Enter token name and click “Create”

       

      4. Copy the token and save it in a notepad for safekeeping


       

      2. Set up the connection in Scytale

      1. In Scytale menu, navigate to the "integrations" page
      2. Click on Connect Jira Issue Tracking
      3. Fill in the fields:
      3.1  API Toke - Paste the API token you created
      3.2 Domain URL - Paste your domain url, to get it you can go to your Jira and copy the part of url that goes before “jira”, it should look like this: https://scytalemodel.atlassian.net

      3.3 Email - Enter the email address of the Jira user who generated the API token

      4. Add a name for the connection
      5. Click on Connect


        6. Select the Jira projects that are relevant to the audit. The closed tickets will be collected automatically by Scytale.

        Note: if you don't select projects, the connection will not be completed and we cannot collect evidence.

         

        7. Click Confirm
         

         Troubleshooting

        1.) Resolving "No Done Status Defined" Error

        While connecting you may get such error:

        ”We could not find any status in Done resolution defined for tickets in certain projects. Please address this in Jira settings before proceeding.”

        (add screenshot from Mor)

        Steps to resolve:

        • In Jira, go to Projects → Workflows → diagram

         

         

         

        • Make sure at least one 'Done' status is defined in at least one of your workflows. In the diagram, it should be marked with a green color. Add a 'Done' status if one is not already defined.

        2.) Data Collection Issues After Successful Connection

        • If you have an issue, data not being collected, after a successful connection, you can test the connection within the Scytale application.
        • This test may help identify the cause of the issue, such as the absence of resolved tickets in your project(s).
        • Select 'Test connection'.

        3.) Project Selection Errors Caused by Permission Schemes

        • If you receive an error after selecting projects, it may be caused by a custom permission scheme configured for those projects, restricting our access.

        Steps to solve:

        • As an administrator, go to Jira, click the Settings icon in the top right corner, and select 'Issues'.

        • In the left-hand sidebar, select 'Permission Schemes'.

        • Find the permission scheme assigned to the problematic project.

        • Open the scheme, find the 'Browse Projects' permission, and click 'Update'.
        • In the dialog that appears, select 'Single user', and choose the user account used to connect to the Scytale platform. Click 'Update' to save the changes.