Configuring Rational DOORS as a TRS provider

You can configure IBM® Rational® DOORS® as a provider for Tracked Resource Sets (TRS) by editing configuration files and running Derby batch files.

Before you begin

To use TRS and LQE, you must be using a Rational DOORS 9.4.0.1 or later database server, and the server must be configured to exclude Rational DOORS clients earlier than 9.4.0.1. To exclude these clients, set the minimum client version on the Login Policy tab of the database properties to 9.4.0.1.

About this task

Rational DOORS and Derby are shipped with several default users and passwords for the TRS enablement. You must edit configuration parameters associated with these users, as described in the procedure below. The integration uses the following users:
Note: Administrators must take action to maintain the integrity of the Derby database and prevent it from becoming corrupted. See "Maintaining database integrity" in the Derby Server and Administration Guide.

Procedure

  1. Open the Rational DOORS Web Access festival.xml file in an editor. This file is located in the dwa_install\server\festival\config directory.
  2. Enter property values for the LQE Functional User and TRS user, as described in the following table. See the example of these properties at the end of this topic.
    Table 1. Festival.xml file properties for TRS and LQE
    Property Description/Value
    ForceHttpsForAuthenticationForOAuth Set this value to true.
    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 window. The default value is LQE Functional User Key.
    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 window. The default value is qwert6.
    functional.user.name The user name for the LQE Functional User. This user name must be a valid Rational DOORS user. The default value is LQE Functional User.
    functional.user.password The password for LQE Functional User. The default value is qwert6.
    trs.db.user A user name for the TRS enablement. For simplicity, use the default user name trs.
    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.
    trs.page.size The number of TRS resources to include on a page. The default value is 250.
    trs.enable Set this value to true.
  3. Open the derby.properties file in an editor. This file is located in the dwa_install/derby directory.
  4. 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. The default value is dwaTrsPa11word.
  5. Run the following batch file: dwa_install/derby.start.bat.
  6. Run the following batch file: dwa_install/derby/scripts/init_trs.bat.
  7. Enable the Data Change Notifications (DCN) parameters to configure the Rational DOORS database server to communicate with the Rational DOORS Web Access broker and the Rational DOORS Web Access server.
  8. Log on to Rational DOORS by using these credentials:
    • User name: LQE Functional User or the functional user name that you specified in the festival.xml file.
    • Password: qwert6 or the functional user password that you specified in the festival.xml file.
  9. Select File > Local Keys and note that the window contains the consumer key and secret that you specified in the festival.xml file.

Example

The following extract from the festival.xml file shows an example of the properties that are related to TRS:
<f:property name="ForceHttpsForAuthenticationForOAuth" value="true"/> 
<f:property name="oauth.domain" value="https://[server]:[port]/dwa"/>
<f:property name="functional.user.consumer.key" value="LQE Functional User Key"/> 
<f:property name="functional.user.consumer.secret" value=qwert6"/> 
<f:property name="functional.user.name" value="LQE Functional User"/> 
<f:property name="functional.user.password" value="qwert6"/> 
<f:property name="trs.enable" value="true"/>

What to do next

After the integration with TRS consumer applications is configured with OSLC friend relationships, you must register Rational DOORS as a TRS provider in the consumer application. For example, see one of the following topics in the IBM Rational Engineering Lifecycle Management information center:
The Lifecycle Query Engine (LQE), which is used by a TRS consumer application, such as Rational Engineering Lifecycle Management, builds a master index (database) of data from multiple lifecycle tools. Each TRS provider tool publishes its data through a Tracked Resource Set. LQE can collect or 'index' the data from each tool. Teams can write queries (reports) for indexed data in the SPARQL language. When you add a data source for Rational DOORS in the LQE Administration application, be sure to set the following values:
  • Number of Threads for initial indexing: 1
  • Number of Threads for incremental indexing: 1
  • Refresh Rate: 60
Set the following HTTP timeout values on the Administration tab > Configuration > Advanced Properties. The default is 60 seconds. BOTH should be increased to 10 minutes, 600 seconds.
  • Connection Timeout (minimum): 10 minutes (600 seconds)
  • Socket Timeout (minimum): 10 minutes (600 seconds)

Feedback