If you are using Rational® Engineering
Lifecycle Manager, configuration steps are required to set up the
products as TRS providers and to give the Lifecycle Query Engine access
to their data.
After you install and configure all the applications, and after
you create friend relationships between applications on remote servers,
set each application as a Tracked Resource Set (TRS) provider so that
the Lifecycle Query Engine (LQE) can access their data to create the index.
Prerequisites: - Start the server for each application you want to configure
Important: If your application is on a different Jazz™ Team Server than LQE, the keys
that are generated in this task are reused later when you add data
sources to the Lifecycle Query Engine as described in:
Generate the LQE index. Note carefully
the name and secret of each key.
Assign the TRS Consumer-Internal license
Assign
the TRS Consumer-Internal license to the lqe_user and jts_user functional
users.
- Open the JTS administration console at https://host_name:port/jts/admin
- Select Users > Active Users.
- Click the lqe_user link. On the lqe_user page,
go to the Client Access License area and select TRS
Consumer-Internal, and click Save.
- Return to the Active Users page. Click
the jts_user link. On the jts_user page,
go to the Client Access License area and select TRS
Consumer-Internal.
- Click Save.
Configure TRS for CLM applications
If these
applications are deployed to the same Jazz Team
Server as LQE, it is not necessary to create inbound consumers. Complete
these steps only if the CCM, QM, and RM applications are on a separate Jazz Team Server.
- Create the LQE Inbound Consumer key for CCM. Open the CCM administration
page: https://host_name:port/ccm/admin
- On the Application page, select Communication
>Consumers (Inbound) and create
a new OAuth Consumer key for LQE:
- Name: LQE
- Secret: xyz
- Trusted: yes
Click Register.
- Go to the Authorized Keys list and edit
the LQE entry by clicking the pencil icon.
- In the Edit Consumer Key Properties dialog,
click the Select User... link.
- Enter lqe in the filter field, and select lqe_user from
the list of matching users. Click Add and Close,
and then Finish.
- Create the LQE Inbound Consumer key for QM. Open the QM administration
page: https://host_name:port/qm/admin, and
then complete steps 7 through 10 again.
- Create the LQE Inbound Consumer key for DOORS® Next Generation if this is your RM application.
Open the RM administration page: https://host_name:port/rm/admin,
and then complete steps 7 through 10 again.
- Register the applications as TRS providers and generate their
index. Open the Lifecycle Query Engine administrative page: https://host_name:port/lqe/web.
- Click Administration > Data Sources > Add Data Source.
- In the Add Data Source dialog, select https://host_name:port/ccm/oslc/workitem/trs and
add the label RTC. Accept the remaining defaults
(if you have a large amount of data to index, increase the number
of threads for initial indexing to 4) and click Finish.
- Register QM as a TRS provider and generate its index. On the Data
Sources page, click Add Data Source.
- In the Add Data Source dialog, select https://host_name:port/qm/trs and
add the label RQM. Accept the remaining defaults
and click Finish.
- Register RM as a TRS provider and generate its index. On the Data
Sources page, click Add Data Source.
- In the Add Data Source dialog, select https://host_name:port/rm/trs and
add the label DNG. Accept the remaining defaults
and click Finish.
Your Rational Team Concert™, Rational Quality
Manager, and Rational DOORS Next Generation applications
are now indexed and available to Rational Engineering
Lifecycle Manager. For more information on preferences for ongoing indexing, see: Indexing
your data with the Lifecycle Query Engine
Configure DOORS and DOORS Web Access as TRS providers
Rational DOORS Web Access comes with several default
users and passwords for the TRS enablement. You must edit configuration
parameters that are associated with these users, as described in the
following procedure. The integration uses the following users:
- LQE Functional User. This user handles LQE requests from
an integrated TRS consumer application to Rational DOORS Web
Access. This user must exist in the Rational DOORS database. You must specify
parameters for this user in the festival.xml file.
- trs.db.user. This is a Derby database user who has access
to the TRS database data. It is used by Rational DOORS Web
Access to retrieve data from the database.
- derby.user.admin. This is a Derby database administrator.
Currently, this user does not provide functions for Rational DOORS Web
Access or the Derby database. You can set a password for this user
in the Derby properties file.
- Open [DWA_path]\server\festival\config\festival.xml.
- Search for the Configurable system properties section.
- Add the properties that are listed in the following table.
Properties
formatting:
<f:property name="property_listed_in_table" value="appropriate_value_or_default_listed_in_table" />
Table 1. Festival.xml file properties
for TRS and LQE| Property |
Description/Value |
| functional.user.consumer.key |
The consumer key that is associated with the
LQE Functional User. It is used by the Lifecycle Query Engine to access
the DOORS Tracked Resource
Set (TRS). This key must be on the Rational DOORS configuration Local
Keys tab. |
| functional.user.consumer.secret |
The consumer secret that is associated with
the LQE Functional User. It is used by the Lifecycle Query Engine
to access the DOORS Tracked
Resource Set (TRS). This secret must be on the Rational DOORS configuration Local
Keys tab. |
| functional.user.name |
The user name for the LQE Functional User. This
user name must be a valid Rational DOORS user. Ensure that the DOORS user ID that you use in
the festival.xml file exists, and has full access
to the projects and artifacts that you expose in the working set. |
| functional.user.password |
The password for LQE Functional User. |
| trs.db.user |
A user name for the TRS enablement. For simplicity,
use the default user name trs.db.user. If this property
is not specified, the system uses the default values. |
| trs.db.password |
The password for the trs.db.user.
You must also specify this password in the Derby properties file.
The default value is dwaTrsPa11word. If this property
is not specified, the system uses the default values. |
| trs.page.size |
The number of TRS resources to include on a
page. The default value is 250. If this property
is not specified, the system uses the default values. |
| trs.enable |
Set this value to true. |
The following extract from the
festival.xml file
shows an example of the properties that are related to TRS:
<f:property name="functional.user.consumer.key" value="xyz" />
<f:property name="functional.user.consumer.secret" value="xyz" />
<f:property name="functional.user.name" value="Administrator" />
<f:property name="functional.user.password" value="qwert6" />
<f:property name="trs.enable" value="true" />
- Optional: Open the derby.properties file
in an editor. This file is in the dwa_install/derby directory.
- Optional: Replace the password values for the parameters in the
following table.
Table 2. Derby properties file parameters
for TRS| Parameter |
Description |
| derby.user.trs |
The password for the trs.db.user that
you specified in the festival.xml file. The default
value is dwaTrsPa11word. |
| derby.user.admin |
The password for the Derby database administrator.
Currently, this user does not provide functions for Rational DOORS Web
Access or the Derby database. The default value is dwaTrsPa11word. |
- Initialize the TRS database. Run the following scripts:
- Log on to the Rational DOORS client as a user of type Database
Manager, or Administrator.
- Select . In the Local
Keys window, click Add. Use the
values that are specified in the festival.xml file.
- Consumer name: Any name. LQE is
recommended.
- Consumer key: The value set for the functional.user.consumer.key property.
- Consumer secret: The value set for the functional.user.consumer.secret property.
Click Register and then OK.
- Select . In the Select Project window,
select the projects, folders, and modules that you want to expose
to LQE.
- Select all the required modules in the Select Modules pane.
Click Apply.
Configure LQE to use DOORS Web
Access as a data source
- Browse to https://hostname:port/lqe/web
- Select Administration in the toolbar menu.
- On the Data Sources page, select Add
Data Source
- In the Add Data Source dialog, select the
Root Services document URL option. Enter the DOORS root services URL. Select the TRS URL.
Enter a label, and select Specify authentication details.
- Root Services URL: https://doorsserver:port/dwa/public/rootservices
- Select https://doorsserver:port/dwa/rm/trs
- Label: DOORS
- Enter the consumer key and secret.
Note: The Consumer Key and
Secret must match the values in the DOORS Web
Access
festival.XML file. In the example below,
the value
xyz is an example.
<f:property name="functional.user.consumer.key" value="xyz"/>
<f:property name="functional.user.consumer.secret" value="xyz"/>
- Set the number of threads to 1 for first time and incremental
indexing and click Finish. Occasional errors
can occur if more than one thread is used for indexing.
Configure TRS for the Rhapsody Design Manager application
- Go to https://hostname:port/jts/admin
Note: Design
Manager inbound consumers are defined in the Jazz Team Server administrative console, not
the Design Manager console.
- Select Server > Consumers (Inbound) and
enter the following and click Register:
- Name: LQE
- Secret: xyz
- Trusted: yes
- Go to the Authorized Keys list, and edit
the LQE entry by clicking the pencil icon.
- In the Edit Consumer Key Properties dialog,
click the Select User... link.
- Enter lqe in the filter field, and select lqe_user from
the list of matching users. Click Add and Close,
and then Finish.
- Go to https://hostname:port/dm/web
- Log in as the administrative user.
- Select your project area, and select Manage Project
Properties from the Administration drop-down
menu (the gear icon). Select Default OSLC Context,
then click Select. Click your project name,
then press OK, and then Save.
- Register Rhapsody® DM
as a TRS provider and generate its index. Open the Lifecycle Query
Engine administrative page: https://lqe_host_name:port/lqe/web.
- Click Administration > Data Sources > Add Data Source.
- In the Add Data Source dialog, select http://rdm_host_name:9443/dm/trs and
add the label RDM. Accept the remaining defaults
(if you have a large amount of data to index, increase the number
of threads for initial indexing to 4), and click Finish.
Configure TRS for the Rational Engineering Lifecycle Manager application
If
your installation is new, you do not have any data to index. You can
create a sample project and product so that you can verify that the
index is created successfully.
- Open the Lifecycle Query Engine administrative page: https://lqe_host_name:port/lqe/web.
- Click Administration > Data Sources > Add Data Source.
- In the Add Data Source dialog, select http://relm_host_name:port/productdef/resource/tracked_resource_set and
add the label RELM. Accept the remaining defaults
(if you have a large amount of data to index, increase the number
of threads for initial indexing to 4), and click Finish.
- To test the index, open Rational Engineering
Lifecycle Manager: https://relm_host_name:port/relm/web
- Select a sample project. From the Queries menu
select Shared Queries.
- Expand the Sample node and select All Artifacts.
You might be prompted to authorize all the applications you are running
the query against. On the User Authorization page, https://relm_host_name:port/lqe/web/auth,
click Authorize beside each application you
want to query.
- The query result displays the sample product that you created.
Configure TRS for Jazz Team
Server users
- Open the Lifecycle Query Engine administrative page: https://lqe_host_name:port/lqe/web.
- Click Administration > Data Sources > Add Data Source.
- In the Add Data Source dialog, select http://host_name:port/jts/trsUsers and
add the label Users. Accept the remaining defaults
and click Finish.
What to do next
After you configure your applications as TRS providers, follow
the steps in Run a query to test or debug to
validate your configuration.