Yuval Pecht

Jira On Demand integration & setup instructions (updated)

Discussion created by Yuval Pecht Employee on Jul 12, 2015

See both sides of the integration here: Now Available: Enhanced JIRA Integration - Setup Instructions

 

Integration between Samanage and Jira Project and Issue Tracking, Cloud version, provides you with the ability to create create a Jira issue in a specific Jira project from within a Samanage incident. The connection between the Samanage incident and Jira issue is maintained until the issue is closed in Jira where upon a private comment is created in the Samanage incident to reflect the closure.

Jira integration instructions

In order to setup this integration, we need to authenticate between Samanage and Jira and then map the selected Jira project.

JIRA uses RSA encryption as part of its OAuth setup. Before you can do the authentication, you have to set up a consumer app in the JIRA install.

JIRA calls the OAuth consumer app "Application Link", which requires RSA keys for signing the API calls. Before you can authenticate or communicate with a JIRA instance, you need to set up this "Application Link" and the RSA keys to be used for signing. **We recommending using service accounts in both systems for setting up the integration rather than an individual’s accounts.**

To set up the consumer app, do the following (Note: You will need to have administrator access to your JIRA account):

Step 1: Go to Application Links in Jira

Log in to your JIRA account and, in the Administration list (click on the cog icon in the top right), head to Add-ons.




Click on Manage add-ons




Click on Application Links




Step 2: Enter the URL of your Samanage account

Enter the url of your Samanage account (e.g. https://company.samanage.com) into the field at the top of the "Configure Applications Link" page, and click Create new link.




You will be presented with the following warning message, please disregard it and click Continue.




Step 3: Enter required parameters in Link Applications

In the "Link Applications" modal window, enter the following parameters:

  1. In the Application Name field enter Samanage (uppercase first letter)

  2. Select Generic Application from the Application Type dropdown.

  3. Enter Samanage (uppercase first letter), for the Service Provider Name

  4. Enter samanage for the "Consumer key" and the "Shared secret" (note the use of lower case here).

  5. For the Request Token URL, Access token URL and the Authorize URL, enter the url of your Samanage account (e.g. https://company.samanage.com).

  6. Check the checkbox for Create incoming link

  7. Click the "Continue" button





You will now be presented with the following screen, but do not fill it as yet:




The next step is back in Samanage...
Step 4: Generate a public key

In the Samanage, Jira setup screen where we started, enter the URL of your Jira account (e.g https://company.atlassian.net) in the box below and then click Generate Public Key to create a public key which you will paste back in Jira in the next step.






This is the screen in Samanage showing a generated public key which is selected and ready to copy to the clipboard:




Now back to Jira again...

Step 5: Create application link in Jira

Enter Consumer Key (alphanumeric - note the lowercase) and a Consumer Name (note the uppercase 1st letter), and paste the RSA public key you generated in Samanage into the "Public Key" field and then click "Continue":





You should now be presented with the following screen which confirms that the application link was created successfully:




Step 6: Activate integration in Samanage

Back in Samanage, we can now click on the "Activate" button as below:




On the following next screen, please click the "Allow" button:





Now back in Samanage, choose the Jira project to map top and then click on the "Finish Activation" button to connect between Samanage and Jira. Note - The destination JIRA project must have an issue type of "Task".




The following indication will inform you that the integration was completed successfully and the selected Jira project has been mapped:







Optional - step 7:


If you wish, you can receive notifications upon closure of an associated  issue in Jira. To enable this, follow the following instructions.

  • First copy the URL generated in Samanage as in this screenshot:

jira-web-hooks-6png



  • Then, in Jira Go to System under the cog wheel

jira-web-hooks-1png

  • Then choose WebHooks on the side menu

jira-web-hooks-2png



  • Then choose "Create a WebHook"

jira-web-hooks-3png

  • On the following screen, enter the following:

    • Give it a name (e.g. Samanage)

    • Then paste the url copied earlier from Samanage to the URL field

    • Then enter under "events": summary ~ "Samanage"

    • And in the issue - click checkbox for event "updated"

    • Then scroll down and click create

jira-web-hooks-4png

 

Once back in Samanage - you can select the user in whose name the private comment will be added.  The default user selected is the currently defined account owner.
At your service,

 

The Samanage Team

Outcomes