Setting up global configurations

Prerequisites

• Engineering Lifecycle Management must be installed. For more information, see Installing Jazz® Team Server and Engineering Lifecycle Management applications.
• Ensure that you understand how other configuration-enabled applications contribute to global configurations. To learn more about configuration management, see Configuration management: Concepts and capabilities.
• You must be assigned the Administrator role in the Global Configuration Management application.

About the topic

The topic describes a typical deployment, which has one Global Configuration Management instance (regardless of the number of Jazz Team Server [JTS] instances) across the deployment. If your organization has teams with isolated Engineering Lifecycle Management deployments that need to collaborate across multiple lines of business, you can set up multiple Global Configuration Management instances in a deployment so that teams can share global configurations. It's an advanced feature. To set up your deployment in this way, read the topic carefully, and then see Enabling Global Configuration Management servers to contribute configurations to other Global Configuration Management servers.

Setup

1. Run the Jazz Team Server setup, which registers and sets up all the Engineering Lifecycle Management applications that you installed on the JTS, including Global Configuration Management. In a distributed environment, you must run the JTS setup on the other JTS instances to ensure that the applications are registered correctly. For more information, see Completing the installation of Jazz Team Server and Engineering Lifecycle Management applications.
2. If the Engineering Lifecycle Management and Global Configuration Management applications are registered to the same JTS, activate configuration management as described in Setting up Engineering Lifecycle Management applications to use local configurations. Otherwise, follow the steps in Additional setup for a multiple Jazz Team Server topology.

Additional setup for a multiple Jazz Team Server topology

Some distributed deployments have multiple JTS instances, which can improve scalability, increase redundancy, or avoid a single point of failure. To set up global configurations in a distributed deployment, ensure that you read all the following steps carefully before you complete it.

Communication between Global Configuration Management and contributing applications is enabled through friend relationships. The required friend relationships depend on the contribution cache mode that is set on the Advanced Properties page of the Global Configuration Management server.

The default cache mode is set to TRS caching (Use Eclipse Amlen for contribution cache property set to false), and is appropriate for most customers. The Eclipse Amlen caching (Use Eclipse Amlen for contribution cache property set to true) is an advanced cache mode that is required for collaborating Global Configuration Management servers and deep component skew detection. Third-party contributing applications are not impacted by the cache mode setting, but still require bidirectional friendships between themselves and Global Configuration Management.

Now that you understand the requirements for setting up friend relationships between Global Configuration Management and contributing applications, you are ready to follow the steps:

1. Set up a directional friend relationship from the JTS of the Global Configuration Management application to each contributing Engineering Lifecycle Management application present on the other JTS instances (for both TRS and Eclipse Amlen cache modes).

   These friend relationships correspond to the blue arrows in the preceding diagrams.

   On the Server Administration page, on the Server tab, in the Communication section, under Friends (Outbound), add a friend relationship to each Engineering Lifecycle Management application.

   Ensure that you accept each incoming friend relationship in either of the following ways:

   1. When you create a friend.

      If you are an administrator of the contributing application that is being added as a friend, you can authorize the provisional key immediately after its creation. To authorize a friend relationship, on the Add friend wizard, after you create a friend, click Next > Grant access for the provisional key.

      In the same step, set a functional user for the authorized friend. The functional user does not require any privileges and can be any user on the remote JTS. For convenience, you can use the pre-defined application users, such as ccm_user, qm_user, rm_user, and dm_user, and gc_user for the respective Engineering Lifecycle Management application.

   2. After the friend creation, from within the respective ELM application.
      Important: The Global Configuration Management and DOORS applications authorize friend relationships through their JTS, but the Engineering Workflow Management and Engineering Test Management applications authorize their friend relationships directly.
      • For the Global Configuration Management and DOORS applications: Authorize the friend relationship on the OAuth Consumers page of the JTS of the application. On the toolbar, click Administration > Jazz Team Server Home > Manage Server > Consumers (Inbound).
      • For other applications (CCM and QM): Authorize the friend relationship on that application's administration page. On Application Administration page > Consumers (Inbound) > OAuth Consumers page.

      On the OAuth Consumers page, set a functional user for each authorized friend (one for each Engineering Lifecycle Management application). For convenience, you can use the pre-defined application users, such as ccm_user, qm_user, rm_user, and dm_user, and gc_user for the respective Engineering Lifecycle Management application.

   For more information about establishing or configuring friend relationships, and editing consumer keys, see the related tasks.

2. Set up a directional friendship from the other JTS instances to the Global Configuration Management application directly (TRS cache mode), or to each contributing Engineering Lifecycle Management application present on the same JTS instance as the Global Configuration Management application (Eclipse Amlen cache mode).

   These friend relationships correspond to the orange and green arrows in the preceding diagrams.

   Use the steps in 1 to create and accept friend relationships for the orange and green arrows in the diagrams in the same way that you did for the blue arrows.

   For more information about establishing or configuring friend relationships, and editing consumer keys, see the related tasks.

3. Set the Global Configuration Provider URL property for each JTS in the topology, except the one that Global Configuration Management is registered to so that contributing applications use the correct Global Configuration Management instance.

   This property is on the JTS server properties page, in the Global Configuration SDK set of server properties. The URL must have a fully qualified domain, for example, https://example:9443/gc/.

   For more information about configuring advanced properties, see the related task.

4. Specify the Link Index Provider URL on the JTS properties page for each JTS in the topology, except the one that LDX is registered to.

   Edit the Link Index Provider URL property in the Links Component set of server properties. The value must be a URL with a fully qualified domain, for example, https://example:9443/ldx/.

   For more information about configuring advanced properties, see the related task.

5. Activate configuration management as described in Setting up Engineering Lifecycle Management applications to use local configurations.

The setup is complete.