Establishing cross-server communication by creating friend links

For products on the Jazz™ platform to interact with each other, each server must have the other servers on its list of friends. The link between two servers is called a friend link.

Before you begin

You must be logged in to the product with an account that has Jazz Administrator privileges. An example of the URL for the Jazz Team Server page is https://fully_qualified_host_name:9443/jts/admin.

To authorize the provisional key that the friend server generates, you must have Jazz Administrator privileges on the friend server.

About this task

Friend links between servers indicate that any requests coming from these servers can be trusted. Create and configure these links to establish communication between servers. By configuring friend links, the Design Management Server can communicate with other servers that support OAuth authentication to find artifacts or artifacts to link to.

For example, you can link model artifacts with requirements and requirements-related artifacts. All stakeholders in the application and systems engineering lifecycle can collaborate on designs and ensure that design models remain relevant and aligned with business and design requirements.


  1. On the design management Server Administration page, click the Server tab.
  2. From the menu on the left side of the page, under Communication, click Friends (Outbound).
  3. In the Friends List section, click Add.
  4. In the Add Friend dialog box, specify values for the fields:
    1. Name: Specify a name for this relationship to help you identify it in a list. For example, if you are creating a friend relationship with an installation of Rational® Requirements Composer that is hosted on a computer named, then you might specify RRC on
    2. Root Services URI: Specify the Uniform Resource Identifier (URI) for the root services document.
      Consider the following examples of URIs for root services documents for Jazz applications in different contexts, hosted on a server named
      • Jazz Team Server:
      • Rational Requirements Composer:
      • Rational Team Concert®:
      • Rational Quality Manager:
      • Other Design Management servers:
      • Rational DOORS®:
    3. OAuth Secret and Re-type Secret: Specify a string that contains one or more words and special characters, and that does not exceed 50 characters. This string is never displayed in the user interface, and you do not enter this string again. This string, also called an OAuth consumer secret, acts as a password to access the friend server.
    4. Select the Trusted check box.
      Note: Trusted consumers can share authorization with other trusted consumers and do not require user approval to access data.
    5. Click Create Friend.
    If the friend is added successfully, a message indicating that a provisional key was generated is displayed.
  5. Click Next.
  6. In the Authorize Provisional Key dialog box, click Grant access for the provisional key. If the account that you used to log in does not have administrator privileges on the friend server, a login window for the friend server is displayed.
  7. In the Authorize Provisional Key dialog box, click Approve. A message is displayed indicating that the provisional key has been marked as Approved.
  8. Click Finish. On the Friends page, the friend relationship is established and the relationship is displayed in the list of friends.
    Tip: To edit the properties of a friend server, or delete it from the list, select a friend and, in the Actions column, select an action to complete.


To view the hover help, also known as UI Preview, for the artifacts on a friend server, you must configure a similar outbound friend link on that server. When you hover the cursor over links to artifacts on friend servers, either a login link or more information about the resource on that server is displayed. For most Jazz products such as Rational Team Concert, Rational Quality Manager, or Rational Requirements Composer, the steps to configure an outbound friend link are similar to the steps in this topic.