Prerequisites

Edit online

You must understand the following prerequisites before you enable contributions between Global Configuration Management servers.

  • Global configuration provider URL: If a Jazz® Team Server doesn’t have a Global Configuration Management application registered to it, and applications registered to that Jazz Team Server want to use global configurations, the applications must define the Global configuration provider URL value on the Jazz Team Server Advanced Properties page.
  • Message Queuing Telemetry Transport (MQTT) broker: Your deployment must include an MQTT broker. Ensure that the broker is running and available. Only Eclipse Amlen is supported, which is available only for Linux servers.

    If you already have Eclipse Amlen installed to support Engineering Workflow Management clustering, you can use the same Eclipse Amlen instance, or install another instance on a different host to prevent a single point of failure.

    Eclipse Amlen is not part of the Engineering Lifecycle Management installation. You must obtain and install it separately. For more information, see the related link to the interactive installation guide. When you answer the questions in the guide, in the Supporting applications section, select Global Configuration Management, and click Yes for at least one of the questions in that section. In the generated instructions, click the link to the section about installing Eclipse Amlen.

  • Friends: Identify which friend connections you must configure on each server.

    Applications that are registered to the same Jazz Team Server as the home Global Configuration Management server are friends by default. Ask the configuration leads which applications contribute to global configurations but are not registered to the home server's Jazz Team Server.

    Friend relationships are required between the Jazz Team Server and contributing applications as directed by the arrows in the following diagrams:

    Image of friend relationships for two JTS instances
    Image of friend relationships for three JTS instances
  • Lifecycle Query Engine and LDX: Ensure that you have one Lifecycle Query Engine (Lifecycle Query Engine) instance and one Link Index Provider instance.
    • Ensure that each Global Configuration Management instance is added as a data source in both Lifecycle Query Engine and LDX.
    • Ensure that Lifecycle Query Engine and LDX have the same list of data sources.

    All the global and local configurations that can be in one Global Configuration Management hierarchy, from no matter how many instances of Global Configuration Management or Engineering Lifecycle Management applications, must be indexed by the same Lifecycle Query Engine and LDX servers.

    Lifecycle Query Engine and LDX applications generate indexes for different uses. Lifecycle Query Engine indexes artifacts so that team members can report on related artifacts in a global configuration that has external contributions. LDX indexes artifacts so that team members can see links between different types of artifacts, such as between test cases and requirements.

    Typically, only one LDX instance is needed across multiple Jazz Team Server instances. All applications that are friends must use the same LDX instance so team members can see incoming links in applications that use a different home Global Configuration Management server. For example, team members who are working in a global configuration context can see links to Engineering Test Management test artifacts when they work with Engineering Requirements Management DOORS® Next requirements.

    If your deployment uses multiple LDX servers, consider consolidating them. You might keep the LDX instance on the Jazz Team Server that has the most applications registered. One Jazz Team Server instance will have LDX registered with it, and the others will not. If you choose to maintain more than one LDX instance, you must ensure that they have the same data sources listed so that the indexes are complete for each LDX instance. Later, you consolidate LDX servers, see step 4 in the Steps topic.

  • Project area associations: Identify which project areas provide or can provide configurations (global and local) to global configurations in a project area so you can define project area associations between the project areas.
    • To identify the project areas that currently provide configurations, use the following sample SPARQL query that you can run in Report Builder by using the Lifecycle Query Engine data source.
      PREFIX process: <http://jazz.net/ns/process#>
PREFIX rdf: <http://www.w3.org/1999/02/22-rdf-syntax-ns#>
PREFIX dcterms: <http://purl.org/dc/terms/>
PREFIX oslc_config: <http://open-services.net/ns/config#>
PREFIX oslc: <http://open-services.net/ns/core#>


SELECT DISTINCT
  ?oslc_config_Configuration2_server
  ?oslc_config_Configuration2_paTitle
  ?label
  ?oslc_config_Configuration1_server
  ?oslc_config_Configuration1_paTitle
WHERE{
  bind("contributes to" as ?label) .
  ?oslc_config_Configuration1_uri oslc_config:contribution ?oslc_config_Configuration1_contribution.
  ?oslc_config_Configuration1_contribution oslc_config:configuration ?oslc_config_Configuration2_uri.
  ?oslc_config_Configuration1_uri rdf:type oslc_config:Configuration.
  ?oslc_config_Configuration1_uri dcterms:title ?oslc_config_Configuration1_title.
  ?oslc_config_Configuration1_uri oslc_config:component ?oslc_config_Configuration1_uri_component.
  ?oslc_config_Configuration1_uri_component process:projectArea ?oslc_config_Configuration1_paUri.
  FILTER( !bound(?oslc_config_Configuration1_paUri) || NOT EXISTS{ ?oslc_config_Configuration1_paUri oslc:archived true. })
  ?oslc_config_Configuration2_uri rdf:type oslc_config:Configuration.
  ?oslc_config_Configuration2_uri dcterms:title ?oslc_config_Configuration2_title.
  ?oslc_config_Configuration2_uri oslc_config:component ?oslc_config_Configuration2_uri_component.
  ?oslc_config_Configuration2_uri_component process:projectArea ?oslc_config_Configuration2_paUri.
  FILTER( !bound(?oslc_config_Configuration2_paUri) || NOT EXISTS{ ?oslc_config_Configuration2_paUri oslc:archived true. })
  FILTER (?oslc_config_Configuration1_paUri != ?oslc_config_Configuration2_paUri)
  ?oslc_config_Configuration1_paUri dcterms:title ?oslc_config_Configuration1_paTitle .
  ?oslc_config_Configuration2_paUri dcterms:title ?oslc_config_Configuration2_paTitle .
  bind(replace(str(?oslc_config_Configuration1_paUri),"([^:]+://[^/]+/[^/]+)/.*","\u00241") as ?oslc_config_Configuration1_server)
  bind(replace(str(?oslc_config_Configuration2_paUri),"([^:]+://[^/]+/[^/]+)/.*","\u00241") as ?oslc_config_Configuration2_server)
}
    • To identify project areas that might contribute configurations in the future, ask the configuration leads of each project area.
  • SSO: All the applications that contribute local or global configurations are recommended to use single sign-on (SSO) authentication. For details, see the related link about single sign-on authentication in Engineering Lifecycle Management.

    If you don’t configure SSO, people might receive multiple log-in prompts, and might have to try the tasks again after being prompted to log in.

    Important: If your deployment uses Lightweight Third-Party Authentication (LTPA) SSO authentication, in which friend connections are available in addition to the registered applications, you must add the root URLs (https://hostname:port) to the Jazz Authentication Proxy SSO allowlist property on the Jazz Team Server Advanced Properties page (https://hostname:portjts/admin). You don't need to add the URLs to the same property in the Global Configuration Management application.

Next, understand the example.