INDEX


Setup a new connection to Jira

You can connect to Jira either by using OAuth (default) or basic-auth. Keep in mind that basic-auth is not supported on jira-cloud.

For both Basic Auth and OAuth connection there are more options which you can access when clicking on the checkbox "Advanced Settings".



This will show additional fields which you can modify:

NameDescription
OptionsEnable / disable TSL certificate check. If you have Jira setup with a self-signed certificate, you may have to disable the check here to be able to connect.
Custom TimeoutTimeout in seconds for HTTP request to the ALM tool. Must be a value between 5 and 60. The default is 5 second.

Basic Auth

  1. Click on "Switch to Basic Auth" on the top right



  2. Fill in the username and password of a Jira-user. Keep in mind that this user will be used to create sprints, issues etc in Jira from the piplanning app. So make sure that this user has the appropriate permissions.

OAuth

  1. Fill out the basic connection details. To start the OAuth-dance click "Connect to Jira"

    NameDescription
    Connection nameName for the connection. That is just for the user to give a friendly name.
    Instance URL

    Url to your Jira. Use http or https as schema.

  2. In the OAuth popup, follow the steps mentioned in the video.

    The user with which you are logged in to Jira while setting up the OAuth connection will be used to to do all the sync-work between Jira and the piplanning-app. Make sure that this user has appropriate permissions.

    Hint: The keys used in the OAuth connection are the same overall Jira connections created by the same piplanning-app company. Those keys are generated at first usage.

Step-by-Step guide

  1. Login to your Jira with a user which has Jira admin rights.

  2. Go to: Jira Settings -> Products -> Application Links

  3. Create a new application-link by entering 'https://piplanning.io' in the field on the top of the page. Click "Create new Link".




  4. In the newly opened popup, press "Continue"




  5. Enter the application name 'piplanning.io' in the top field. Make sure you hit the checkbox 'Create incoming link' before clicking Continue.




  6. Enter the Consumer Key (needs to be exact) and Consumer Name 'piplanning.io'.

  7. Copy the Public-Key from the piplanning setuptool (Setup oAuth screen). Click Continue.




  8. On the piplanning setup tool page, click "Authenticate".




  9. Follow the steps displayed in the Jira page.




  10. Close the JIRA window and click "Check & Close" on the piplanning.io setup page.