This is a quick guide on how to add your Jira Server as a Data Source to your IBM Lifecycle Query Engine.
The setup of the CM Data source and Process Resources Data Source require teamwork between your Jira and ELM Administrators. Use the following color codes for these steps as extra guidance measures:

Environment

Color code

Atlassian Jira Software Server

IBM ELM Jazz

Obtain your Jira Server’s root services URL

  1. Login to your Jira Server as an Administrator.

  2. Navigate to the “Consumers” tab accessible from your OSLC Connect for Jira administration page:

  3. On the bottom of the “Consumers” page you will find the “Root Services URI”. Your IBM ELM Administrator needs this URL to be able to execute the next steps of this guide:

Add new Data Source in LQE

  1. Login to your LQE Administrator page.

  2. Navigate to the “Administration” tab and click on “Add Data Source”

  3. In the new dialog, choose “Root Services URL” from the “Data Source” property list proceed to enter the Root Services URI obtained from your Jira Administrator. Important: If you are on IBM Jazz 7.x press enter after you have pasted the URI.

Proceed to fill out the rest of the Dialog:

  1. Paste your Rootservices URI into the field: “Root Services URL”. Important: If you are on Jazz 7.x make sure to press enter after you have pasted the URI. Now choose the first Data Source: “your-jira-rootservices/rest/oslc/1.0/cm/trs.

  2. The label will be autofilled with “OSLC Connect for Jira CM Resources (TRS 2.0)”, you can leave this as is. If you plan on connecting multiple Jira servers, make sure to label them in a way for easy future identification.

  3. Choose: “Specify OAuth authentication details for this data source”

  4. Click on “Next >”

On the next page of the dialog you need to enter an OAuth consumer key and it’s secret. Follow the steps below to generate this consumer key:

  1. After you have navigated to the Consumers page within your Jira Administration/Manage Apps page, click on “Add Consumer” in the upper right corner.

  2. Enter a suitable name for this consumer. Good examples show the ELM server and datasource name as shown in the screenshot above. Leave the “Key” field empty as it will be generated automatically.

  3. Choose a secret. This secret needs to be shared with your Jazz Administrator in order to be able to complete process of adding Jira as a Data Source in LQE.

  4. Select “Tracked Resource Set” (The account can be changed later in the “Tracked Resource Set” configuration page.

  5. Make sure to tick the “Trusted” checkbox.

  6. Once you have filled out all details, click on “Add”.

You should now have a consumer OAuth key available to be shared with your Jazz Administrator.

The Jazz Administrator can now enter this new Consumer Key in the dialog as shown below:

  1. Enter the key which has just been created by your Jira Administrator.

  2. Enter the secret that has been created by your Jira Administrator.

  3. Click on “Test connection”. In the top of the dialog, it should show “The connection test succeeded. proceed to click on “Finish”.

You have now successfully added the first Data Source. You need to repeat this process again for the second Process Resources Data Source:

In your LQE Administration page click on “Add Data Source”

Proceed to fill-out the new dialog as shown below:

  1. Enter the Jira Servers Root Services URI obtained from your Jira Administrator.

  2. Choose the second Data Source: Process/TRS and leave the Label as is or enhance it with the server names of the Jira and ELM environment.

  3. Choose: “Specify OAuth authentication details for this data source”

  4. Click on “Next”.

To be able to complete the next page of this dialog, a new Consumer Key needs to be generated from within the Consumers configuration page of the Jira Administration panel. As a Jira Administrator navigate to the Consumers page which is listed under the OSLC Connect for Jira section in your Manage Apps overview:

  1. Proceed to click on “Add Consumer” in the upper right corner.

  2. Enter a suitable name for this Consumer. Good examples resemble the Jira and the ELM environment name. Leave the “Key” field blank as the key will be automatically generated.

  3. Enter and repeat a secret. Make good note of this secret as it needs to be shared with your Jazz Administrator later.

  4. Choose: “Tracked Resource Set”. (this user can be changed later but should at all times be a user that has access to all projects which need to be visible in the ELM Jazz Report Builder.

  5. Thick the “Trusted” check-box.

  6. Once you have filled-out all the details, click on “Add”.

You have now generated a new Consumer Key and secret which needs to be shared with your Jazz Administrator in order to be able to complete the OAuth dialog in Jazz:

As a Jazz Administrator, take this new Consumer Key and fill out the fields from the dialog.

  1. Once you have filled out the consumer key and its corresponding secret, click on “Test connection”.

  2. If all went well, you should see “The connection test succeeded.”

  3. Click on “Finish”.