/
Configuring the OSLC Connector for Confluence to work with IBM Jazz

Configuring the OSLC Connector for Confluence to work with IBM Jazz

Owned by Rene Beckert
Last updated: May 17, 2024 by Alexander Wolf
4 min read

Before you can start managing references from Confluence to IBM Jazz, you must carry out the following configuration steps.

1. Establish the connection from Confluence to Jazz

  1. Switch to the Confluence side and navigate to the "manage apps" area. You need admin rights to do that.

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

  3. Select the "Network Configuration" tab and set path to the trust-store.

  4. Test the connection (2) with https://[ibm-jazz base url]:9443/jts/admin

NetworkConfiguration.PNG

2. Add Confluence as a Consumer on JTS Level on the Jazz Side (NON OIDC CASE)

You must add Confluence as a consumer to IBM Jazz on JTS level. Having done that, Jazz will propagate the consumer information to the application level. This means that all Jazz applications which are installed when you add Confluence as a consumer will also retrieve the consumer information.

There might be Jazz configurations that prevent the Jazz applications from inheriting from JTS. In this case you must add Jira as a consumer in every IBM Jazz application. Do this in IBM Jazz:

  1. Go to https://[ibm-jazz base url]:9443/jts/admin

  2. Select "Consumers (Inbound)" in the menu on the left

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

    2. Add a consumer secret twice. You will need to add the same secret later on the Confluence 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 Confluence side.

  3. Make sure that all Jazz applications you want to connect to with Confluence have inherited the settings. If this is not the case. You must repeat the configuration steps on application level for DOORS Next, EWM, and ETM. Note, that the consumer for DOORS Next should be registered in JTS.

3. Add the Jazz application(s) as a friend to Confluence

  1. Switch to the Confluence side and navigate to the "manage apps" area. You need admin rights to do that.

  2. Select the "Friends Management" tab.

  3. Click "Add Root Service Configuration"

    1. Enter any Name like "DOORS Next".

    2. Enter the root services url of your Jazz application's instance:

      1. DOORS Next: https://[ibm jazz base url]:9443/rm/rootservices

      2. ETM: https://[ibm jazz base url]:9443/qm/rootservices

      3. EWM: https://[ibm jazz base url]:9443/ccm/rootservices

      4. GC: https://[ibm jazz base url]:9443/gc/rootservices

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

    4. Save the friend.

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

AddRootService.PNG

4. Authorize the provisional OAuth consumer keys on the IBM Jazz side

  1. Select the "Friends (Outbound)" tab

  2. Authorize the provisional OAuth consumer keys you have added.

5. Whitelisting on the IBM Jazz Side

Whitelisting if the Application is reachable for Jazz

You must repeat the following steps for all IBM Jazz applications you want to use for linking Confluence 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://[ibm jazz base url]:9443/rm/adminETMhttps://[ibm jazz base url]:9443/qm/adminEWMhttps://[ibm jazz base url]:9443/ccm/adminGCMhttps://[ibm jazz base url]:9443/gc/admin

  2. Select "Whitelist (Inbound)" in the menu on the left.

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

  4. Click "Add".

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

Whitelisting if the Application isn’t reachable for Jazz

Sometimes the Confluence Instance isn’t reachable from the Jazz Application than you can’t add it through the Whitelist Tab, but there is stille the posibility to add it manualle threw

Advanced Properties → Jazz Web UI (Ajax Services) → Clickjacking whitelist

in that list you can just add a comma separated whitelist by urls which are included in JAZZ CSP HEADER

6. Link Type Managment

 

image-20240517-073943.png

 

  1. You can use the pre defined custom Link Types which get shipped with the Confluence Plugin and start linking your artifacts

  2. You can also define custom Link Types for Linking Artifacts.

Related content