SSE/RELM - Configuring data source providers in federated topology

Overview

The following article describes required steps when configuring Rational Lifecycle Engineering Manager (RELM) in federated topology architecture. For this article to be easily understood familiarity with RELM, System & Software Engineering solution (SSE), Jazz and Open Services for Lifecycle Collaboration (OSLC) technologies is assumed.

To complete RELM cross tooling configuration it is required to add data source providers to RELM index engine that is Lifecycle Query Engine (LQE). Online documentation is available for understanding how to complete this task. For more details please refer to Register applications as Data Source Providers: single JTS, and Register applications as Data Source Providers: multiple JTS server.

In this article you will find additional, not documented details discovered and collected while completing such configuration in federated topology environment.

SSE installation

This article describes configuration steps required after installing SSE solution using federated topology. For more details on how to install the SSE solution please refer to Installing Rational Engineering Lifecycle Manager

About federated topology

SSE solution is a collection of tools connected using RESTfull and OSLC APIs. Deployment architecture of SSE tools can be varied according to various factors including ease of installation, performance consideration, security constraints and more. In federated topology each tool is installed on a dedicated machine (physical or virtual) along with web server and dedicated Jazz Team Server (JTS) application foundation.

The following diagram demonstrates an optional federated architecture. Please note Collaborative Lifecycle Management (CLM) server CLM_SERVER could have been further split into multiple machines. One that is dedicated to RTC application and the other to RQM

Required steps during RELM data source provider configuration

• TRS internal consumer license is required for each application that is also Data Source Provider. However, such license is not provided out of the box. How to get it?
• Add TRS consumer license to Jazz application
• Apply TRS consumer internal license to internal Jazz functional user
• Create OSLC inbound consumer key and apply internal Jazz user to it
• Understand differences between RDM and CLM applications when it comes to OSLC friendship configuration

How to get TRS internal consumer license

TRS internal consumer license is provided only as part of RELM installation. However, it is required by all Jazz applications intended to be configured as Data Source Provider for RELM. The license is included with RELM installation as a jar file. The following steps explain how to use it

1. On the machine where RELM application is installed, browse to its installation folder and search for TRS internal consumer license file named TRS_Consumer_Internal.jar. Typical location might be: ..\server\tomcat\webapps\lqe\WEB-INF\classes\META-INF\licenses
2. Copy the license file to each machine where data source provider application is installed. You can select any destination location for that file

How to add TRS consumer license to Jazz application

With any Jazz based application, new licenses are imported using the underlying JTS administration application. To complete license import follow these steps:

• Navigate to JTS administration application (i.e. https://[fully qualified server name ]:[port]/jts/admin)

• Open License Key Management page and launch the Upload License Files dialog

• Browse and select to upload previously copied TRS consumer license file and click Finish button

Apply TRS consumer internal license to internal Jazz functional user

Internal functional users are created as part of any Jazz based application installation. To apply TRS consumer internal license to such user follow these steps:

• Navigate to JTS administration application (i.e. https://[fully qualified server name ]:[port]/jts/admin)
• Dropdown top menu Users and select Active Users
• Locate user named jts_user and click it to enter edit mode
• In the licenses list located to the right check TRS internal license and click Save button

This process should be completed for each Jazz application planned to be configured as data source provider for RELM

TIP

• Some related documents recommend creating new internal functional user for data source provider application. However, this step might not be possible if application already configured to use external authentication management tool (e.g. LDAP). The simplest approach is using already created internal user jts_user instead. It is created as part of JTS installation and can be used for LQE indexing activities as required from any data source provider

Create OSLC inbound consumer key and apply internal Jazz user to it

Setting a tool as data source provider for RELM includes also configuring friendship between the two parties. Applying such configuration is described in the following article: Register applications as Data Source Providers: multiple JTS server

As suggested in this article, use jts_user as internal functional user when creating consumer (inbound) keys.

Differences between RDM and CLM applications regarding OSLC configuration

Creating OSLC friendship is done in the administration section of each data source provider application. Due to different internal architecture, for RDM application you have to create friendship in the administration section of the underlying JTS application.

Follow this list to access the administration section of these SSE tools: