Configuring Rational DOORS Web Access as a TRS provider

You can configure IBM® Rational® DOORS® Web Access as a provider for tracked resource sets (TRS) by editing configuration files and running Derby batch files.

About this task

Rational DOORS Web Access and Derby are shipped with several default users and passwords for TRS enablement. If you modify the user names or passwords, you must edit the configuration parameters that are associated with those users, as described in the following procedure. The integration uses these users:
LQE Functional User
This standard Rational DOORS user handles Lifecycle Query Engine (LQE) requests from an integrated TRS consumer application to Rational DOORS Web Access. If this user has a user name and password other than the default values, those values must match entries in the festival.xml file, as described in the following procedure.
trs.db.user
This Derby database user can access the TRS database data, and is used by Rational DOORS Web Access to retrieve data from the database. If you want to use values other than the default user name and password, you must make entries in the festival.xml file. If you change the password, you must enter the new password in the Derby properties file.
derby.user.admin
This Derby database administrator currently does not provide functions for Rational DOORS Web Access. You can set a password for this user in the Derby properties file.
Important: Administrators must take action to maintain the integrity of the Derby database and prevent it from becoming corrupted. For more information, see "Maintaining database integrity" in the Derby Server and Administration Guide.

Procedure

  1. Stop all Rational DOORS Web Access components, as described in Starting, stopping, and removing Rational DOORS Web Access.
  2. Make a backup copy of the festival.xml file and open the original file in an editor. This file is located in the dwa_install\server\festival\config directory.
  3. Enter the following property values for the LQE Functional User and TRS user:
    ForceHttpsForAuthenticationForOAuth
    Set this value to true.
    functional.user.consumer.key
    This consumer key is associated with the LQE Functional User. LQE uses this key to access the Rational DOORS TRS. This key must match the Consumer Key entry in the Rational DOORS configuration Local Keys window. The default value is LQE Functional User Key. This property is required in the festival.xml file only if you use a value other than the default value.
    functional.user.consumer.secret
    This consumer secret is associated with the LQE Functional User. LQE uses this key to access the Rational DOORS TRS. This secret matches the OAuth Secret entries in the Rational DOORS configuration Local Keys window. The default value is qwert6. This property is required in the festival.xml file only if you use a value other than the default value.
    functional.user.name
    This property is the user name for the LQE Functional User. This user must be a standard Rational DOORS user who has privileges to read all Rational DOORS data that is intended for use in LQE. This value must match the Consumer Name entry in the Rational DOORS configuration Local Keys window. The default value is LQE Functional User. This property is required in the festival.xml file only if you use a value other than the default value.
    functional.user.password
    This property is the password for LQE Functional User. The default value is qwert6. This property is required in the festival.xml file only if you use a value other than the default value.
    trs.db.user
    This property is a user name for the TRS enablement. The default user name is trs. This property is required in the festival.xml file only if you use a value other than the default value.
    trs.db.password
    This property is the password for the trs.db.user. The default value is dwaTrsPa11word. This property is required in the festival.xml file only if you use a value other than the default value. If you use a value other than the default value, you must enter the new password in the Derby properties file, as described in the next steps of this procedure.
    trs.page.size
    This property indicates the number of TRS resources to include on a page. The default value is 250.
    trs.enable
    Set this value to true.
    The following extract from the festival.xml file shows an example of properties that are related to TRS:
    <f:property name="ForceHttpsForAuthenticationForOAuth" value="true"/> 
    <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"/>
  4. Save and close the festival.xml file.
  5. If you changed the default value for the trs.db.password in the festival.xml file, follow these steps:
    1. Open the derby.properties file in an editor. The file is in the dwa_install/derby directory.
    2. Replace the derby.user.trs value. The derby.properties file includes the following values:
      derby.user.trs
      This is the password for the trs.db.user property that you specified in the festival.xml file. The the default value is dwaTrsPa11word.
      derby.user.admin
      This is the password for the Derby database administrator. Currently, that user does not provide functions for Rational DOORS Web Access. The default value is dwaTrsPa11word.
  6. Start all Rational DOORS Web Access components, as described in Starting, stopping, and removing Rational DOORS Web Access.

What to do next

After the integration with a TRS consumer application is configured with OSLC friend relationships, you must register Rational DOORS as a TRS provider in the consumer application. For an example of that procedure, in the documentation for IBM Rational Engineering Lifecycle Management, see "Register applications as TRS providers for the Lifecycle Query Engines".

LQE, which is used by a TRS consumer application such as Rational Engineering Lifecycle Management, builds a master index, or database, of data from multiple lifecycle tools. Each TRS provider tool publishes its data through a TRS. LQE can collect or index the data from each tool. Teams can write queries, which are like reports, for indexed data in the SPARQL language. When you add a data source for Rational DOORS in the LQE Administration application, set these values:
  • Number of threads for initial indexing: 1
  • Number of threads for incremental indexing: 1
  • Refresh rate: 60
On the Administration tab, click Configuration > Advanced Properties and set the following HTTP timeout values. The default is 60 seconds. Increase both values:
  • Connection timeout (minimum): 5 minutes (300 seconds)
  • Socket timeout (minimum): 15 minutes (900 seconds)