OSCL Connector for Smartfacts Connecting to IBM ELM

Steps to Associate Content

Before you can start managing links between IBM Jazz and Smartfacts, you must carry out the following steps to associate IBM Jazz content with Smartfacts content.

Step 1: On the IBM Jazz side, add Smartfacts as a Consumer (Inbound) on JTS Level

You must add Smartfacts as a consumer to IBM Jazz at the 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 Smartfacts as a consumer will also retrieve the consumer information.

Do this in IBM Jazz:

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

2. Select the "Server" tab

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

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

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

Step 2: On the Smartfacts side, add the IBM Jazz Applications as Friends to Smartfacts

Do this in Smartfacts:

1. Open the MWH profile from the main menu. You need to have Account Manager rights for this.

2. Select the "Friends (Outbound)" tab.

3. Click "+" to add a friend.

   1. Add any name for the friend, e.g. "IBM ELM DOORS Next".

   2. Select the appropriate domain, e.g. "RM" for DOORS Next.

   3. Add the URL of the OSLC source, e.g. "https://[IBM Jazz base url]:9443/rm/rootservices".

   4. Add the consumer key you have copied on the IBM Jazz side in step 1.3e.

   5. Add the same consumer secret as in IBM Jazz in step 1.3b.

4. The newly-created friend should now be listed.

5. Click the very right icon to test if the root services file can be accessed. If this is not the case, then Smartfacts cannot access the IBM Jazz instance. As the root services file is accessible without authentication, this issue must be solved before you continue.

6. If you use Global Config Management, you must make sure that you have also added GCM as a friend on the Smartfacts side, therefor:

   Click "+" to add a friend.

   1. Add any name for the friend, e.g. "IBM ELM GCM".

   2. Select the appropriate domain, e.g. "GC" for GCM.

   3. Add the URL of the OSLC source, e.g. "https://[IBM Jazz base url]:9443/gc/rootservices".

   4. Add the consumer key you have copied on the IBM Jazz side in step 1.3e.

   5. Add the same consumer secret as in IBM Jazz in step 1.3b.

Steps 1 and 2 allow Smartfacts to retrieve data form the IBM Jazz instance.

Step 3: On the Smartfacts side, define an external Server if you use Global Configuration Management

1. Open the Modelwarehouse Profile, select the External Servers tab and add new external server.

2. Select OSLC as a source type

3. Add the url of the global config management server of Jazz: https://[ibm-jazz_base_url]:9553/gc/rootservices

4. Select Jazz Auth as authentication method

5. Add the security check URL: https://[ibm_jazz_base_url]:9443/jts/j_security_check

6. Add a technical username and password

Step 4: On the IBM Jazz side, add Smartfacts as a Friend (Outbound) on JTS Level

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

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

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

   1. Add the root services file URL of Smartfacts (https://[genoslc base url]/rootservices). You will find this URL in Smartfacts in the MWH profile in the Smartfacts tab.

   2. Add a name if it is not generated automatically, e.g. "Smartfacts".

   3. Click "Next".

   4. Add any secret.

   5. Check "Trusted".

   6. Click "Create Friend".

Important! 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 friendship from every Jazz application to Smartfacts manually. You can do this via these domains:

The user will now be able to add associations to a Smartfacts project or to add models to a GC on the IBM Jazz side.

Step 5: Whitelisting on the IBM Jazz Side

You must repeat the following steps for all IBM Jazz applications you want to use for linking Smartfacts 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 application URLs:

   DOORS Next: https://[ibm jazz base url]:9443/rm/admin
   Engineering Test Management: https://[ibm jazz base url]:9443/qm/admin
   Engineering Workflow Management: https://[ibm jazz base url]:9443/ccm/admin
   Global Config Management: https://[ibm jazz base url]:9443/gc/admin

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

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

4. Click "Add".

You do not have to add a whitelisting at the JTS level.

This will allow Smartfacts to display delegated UIs from an IBM Jazz application.