Configuration Jira - IBM ELM

Step 1. Jira: Add the Jazz Certificate

  1. In the Jira admin area, click "manage apps". You need Jira admin rights to do that.

  2. Put the Jazz certificate to the trust-store on the Jira server.

  3. Select the "Network Configuration" tab and set path to the trust-store and click “apply”. If the trust store text fiels is not visible, switch the SSL parameters to “No SSL” and back to “default settings”.

  4. Test the connection with https://[jazzBaseUrl]:9443/jts/admin

The steps 2, 3, 5, 6 are about making sure that these aspects correspond:

  • Add a consumer in Jazz and make sure that there is a corresponding friend in Jira. This means that the consumer key and secret used with the Jazz consumer must also be used for the Jira friend.

  • Add a friend in Jazz and make sure that there is a corresponding friend in Jira. This means that the consumer key and secret used for the Jazz friend must also be added to the Jira consumer.

Step 2: IBM ELM: Add a Consumer

  1. Consumers must be registered for all Jazz applications you want to integrate with Jira. So, the following steps must be performed for all of these applications:
    DOORS Next  https://[jazzBaseUrl]:9443/jts/admin   
    ## Note: The DNG consumer must be registered in JTS
    ETM  https://[jazzBaseUrl]:9443/qm/admin
    EWM  https://[jazzBaseUrl]:9443/ccm/admin
    You do not have to do the following steps for GCM.

  2. Click the server tab

  3. Select Consumers (Inbound) in the menu on the left

    1. Add any consumer name, e.g. "Jira".

    2. Add a consumer secret twice. You will need to add the same secret later on the Jira side.

    3. Check "trusted".

    4. Click "register". The consumer should be added to the list of consumers below.

    5. Copy the consumer key from the newly-added consumer. You will need it on the Jira side.

Step 3: Jira: Add a corresponding Friend

  1. Select the Friends Management tab.

  2. Click Add OSLC Source Configuration and do the following steps for all Jazz applications you want to connect to to Jira

    1. Enter any Name like "DOORS Next OSLC Source".

    2. Enter the root services url of your Jazz applications’ instance:
      DOORS Next  https://[jazzBaseUrl]:9443/rm/rootservices
      ETM  https://[jazzBaseUrl]:9443/qm/rootservices
      EWM  https://[jazzBaseUrl]:9443/ccm/rootservices
      GCM  https://[jazzBaseUrl]:9443/gc/rootservices

    3. Select the correct OSLC domain: "RM" for DOORS Next, "QM" for ETM, "CCM" for EWM, "GC" for GCM.

    4. Paste the consumer key copied in step 2.3.e. and add the secret from 2.3.b.

    5. Save the friend.

    6. Use the Test button to test if the IBM Jazz root service can be accessed from Jira. The log should show a status "200".

Step 4: Jira: Configure the Link Types

General: Links will only be visible if your OSLC connector knows the link types. This is just as true for Jazz as it is for the OSLC Connector for Jira. A link type is uniquely defined by a URI, e.g., http://jazz.net/ns/dm/linktypes#derives (Derives Architecture Element).

  1. Navigate into a DOORS Next module.

  2. From the admin menu select Manage Component Properties.

  3. Select the Links tab. You will see a list of all valid link types for the selected component.

  4. Add a new link type or re-use an existing one. We recommend this link type for linking e.g. DOORS Next artifacts and Jira issues:

  5. Make sure that the same link type URI is also defined on the Jira side.

Step 5: IBM ELM: Add a Friend

  1. Go to https://[jazzBaseUrl]:9443/jts/admin

  2. Select Friends (Outbound) in the menu on the left.

  3. Click Add in the upper right corner of the screen.

  4. Add the root services file URL of Jira: https://[jira-base-url]/rest/jirarestresource/1.0/rootservices. Add a name if it is not generated automatically, e.g. "Jira".
    If you are not sure what the correct url for the root services file is, you can also look up the value in the Friends Management tab of the OSLC Connector for Jira. You need Jira admin rights to do that.

  5. Add a name for the friend definition if it is not automatically generated.

  6. Click Next.

  7. Add a secret. You will need the secret later on the Jira side.

  8. Check the Trusted checkbox.

  9. Click Create Friend.
    You must check if all the Jazz applications have inherited the friends definition from the JTS level. There are configurations in Jazz that do not allow that. In this case, you must add the friend from every Jazz application to Jira manually. You can do this via these domains:
    DOORS Next  https://[jazzBaseUrl]:9443/rm/admin
    ETM  https://[jazzBaseUrl]:9443/qm/admin
    EWM  https://[jazzBaseUrl]:9443/ccm/admin
    GCM  https://[jazzBaseUrl]:9443/gc/admin

  10. The user will now be able to add associations to a Jira project.

Step 6: Jira: Manage Consumers

  1. Navigate to Admin -> Manage Apps -> Consumers Management.

  2. There should be a provisional key listed on top of the page. Authorize this provisional key.

Step 7: IBM ELM: Whitelist Jira

You must repeat the following steps for all IBM Jazz applications you want to use for linking Jira model elements and IBM Jazz artifacts. If you are using global config management, you must also do the whitelisting in the global config management application.

  1. Go to the admin page of an IBM Jazz application where you want to add a whitelisting. These are the typical URLs:
    DOORS Next:  https://[jazzBaseUrl]:9443/rm/admin#action=com.ibm.team.repository.admin.proxyConfiguration
    ETM:
    https://[jazzBaseUrl]:9443/qm/admin#action=com.ibm.team.repository.admin.proxyConfiguration
    EWM:
    https://[jazzBaseUrl]:9443/ccm/admin#action=com.ibm.team.repository.admin.proxyConfiguration
    GCM:
    https://[jazzBaseUrl]:9443/gc/admin#action=com.ibm.team.repository.admin.proxyConfiguration

  2. Enter the base URL of the Jira instance you want to whitelist.

  3. Click Add.

You do not have to add a whitelisting on JTS level. This will allow Jira to display delegated UIs from an IBM Jazz application.