Overview
This document is largely based on the article found at: Configuring Rational DOORS and Rational Team Concert to
integrate with one another article on jazz.net.
You can configure Rational® DOORS® and Rational Team Concert™ (RTC) to integrate with one another by using Open
Services for Lifecycle Collaboration (OSLC), an open standard that IBM is developing in co-operation with business
partners and customers.
You use Rational DOORS to manage your requirements, and RTC to put your requirements under change control, preventing
uncontrolled changes to your requirement set. Strict control of requirements is mandatory under many quality systems,
and is needed if you are to keep track of the state of your requirements at any point in your product lifecycle.
The change control can be as strict or as loose as you like. After you have set up the two applications to communicate
with one another, you can set up workflows in RTC and configuration templates in Rational DOORS with as much
flexibility as you want. In this example, you will define a Requirements Change Request workflow that is based on the
IBM Rational Systems Engineering solution.
As with many configuration tasks in Rational DOORS and RTC, it is essential that you plan your integration. You cannot
set up a change control system "as you go". You must know in advance what types of work items you will want to use,
whether you want to have more than one workflow, how you want to control your change requests, and so on.
This procedure contains example values for you to enter as you follow the instructions. If you already have values of
your own, you can use them. Though the generic change management integration included in Rational DOORS works with
Rational Change, Rational ClearQuest®, and RTC, this document focuses on RTC.
Finally, this document assumes you have an intermediate knowledge of both RTC and Rational DOORS, and it is organized
sequentially to allow a single user to follow the procedure.
Supported software
The information in this document is based on Rational DOORS 9.3.0.6, Rational DOORS Web Access 1.4.0.5, and Rational
Team Concert RTC 3.0.1 running on Windows. RTC can be used with a number of browsers. The integration is supported only
with Internet Explorer and Firefox, and to make it run on Firefox you need to use the IETab2 plug-in to emulate
Internet Explorer. This is because the Rational DOORS Web Access Change Details view needs ActiveX and the Change
Details window cannot be rendered fully in Firefox without the plug-in.
Procedure
The outline of the procedure is as follows:
-
Install Rational DOORS Web Access and Rational DOORS
-
Restore the Design Control Solution (DCS) Example DOORS Archive
-
Install Rational Team Concert (RTC)
-
Restore the DCS Example Project Template in RTC
-
Configure RTC and Rational DOORS to communicate with one another
-
Define a configuration template in Rational DOORS
-
Set up the module configuration in Rational DOORS
1. Install Rational DOORS Web Access and Rational DOORS
To enable Rational DOORS to integrate with RTC, you must install and configure Rational DOORS and DOORS Web Access, and
configure the Rational DOORS database server.
Before you begin
You must have local administrator powers on your server.
Steps
Installing Rational DOORS and DOORS Web Access is almost completely automated; configuring is a manual procedure. You
must update two configuration files - the festival.xml file and the doorsRedirector.properties file. If you are using a
secure connection, you must also set up Rational DOORS Web Access to use SSL.
As part of the configuration procedure, you also configure the Rational DOORS database server by running the dbadmin
command with additional parameters.
Install and configure Rational DOORS and DOORS Web Access
To configure Rational DOORS Web Access and Rational DOORS, follow the instructions in the topics in these sections of
the Rational DOORS information center:
When you have completed all of the configuration tasks, you are ready to start Rational DOORS Web Access.
Start Rational DOORS Web Access
Follow the instructions in Starting Rational DOORS Web Access on Windows systems.
Rational DOORS and Rational DOORS Web Access are now ready for the next step of the integration.
Create DOORS users for the evaluation
You will create three new users for the evaluation:
-
Administrator / pswd (DOORS default admin)
-
Rational / Rational – database manager (New)
-
Susan / Susan – standard user (New)
-
Pete / Pete – standard user (New)
Follow the instructions in Managing Users and Groups to create new users.
2. Restore the Design Control Solution (DCS) Example DOORS Archive
The DCS information is stored in a DOORS Project Archive. Follow the instructions outlined in the DOORS online help in
Restoring Projects and Modules.
3. Install Rational Team Concert (RTC)
To enable Rational DOORS to integrate with RTC, you must install and configure Rational Team Concert and restore an RTC
Process Template onto the server.
Before you begin
You must have local administrator powers on your server.
Steps
Installing RTC is almost completely automated; configuring is a manual procedure. Configuration is all performed
through the Browser-based user interface.
Install and configure Rational Team Concert
Rational provides an Interactive Installation Guide which creates custom instructions for you based on your
installation needs. Choose the following options in the RTC Interactive Installation Guide:
-
Applications to Install: Jazz Team Server, Change & Configuration Management
-
Installation topology: Evaluation topology
-
Operating System: Microsoft Windows
-
Application Server: Apache Tomcat
-
Uncheck: LDAP
-
Database server: Derby
-
Install Rational Reporting for Development Intelligence: No
Proceed to Section 5 – Install The Server of the generated instructions.
Setup the database in RTC
Upon completion of Section 5, Proceed to Section 6 –Setup The Database of the generated instructions.
Start the Apache Tomcat Server
Upon completion of Section 6, Proceed to Section 7 – Start the Apache Tomcat Server of the generated instructions.
Run the setup wizard
Upon completion of Section 7, Proceed to Section 8 – Run the setup wizard of the generated instructions.
You have installed the server!
Upon completion of Section 8, you may choose to read Section 9 and Section 10. Because this is an evaluation, there is
no mandated action to be taken in these sections.
Create RTC users for the evaluation
You will create three new users for the evaluation:
-
ADMIN / ADMIN (RTC default admin)
-
Rational / Rational – (New)
-
Repository Permission: JazzAdmins, JazzDWAdmins, JazzProjectAdmins
-
Client License: Team Concert Developer
-
Susan / Susan – (New)
-
Repository Permission: JazzUsers
-
Client License: Team Concert Developer
-
Pete / Pete – (New)
-
Repository Permission: JazzUsers, JazzProjectAdmins
-
Client License: Team Concert Developer
Follow the instructions in Jazz Server Creating Users to create new users.
4. Restore the DCS Example Project Template in RTC
The DCS Project Template is stored in a file. Follow the instructions in Working with process templates / Importing Process Templates outlined in the RTC online
help.
5. Configure RTC and Rational DOORS to communicate with one another
To allow the integration to work correctly, both RTC and the Rational DOORS database must be set up to communicate with
one another.
In RTC:
-
Set up RTC to allow the connection from Rational DOORS
-
Add Rational DOORS to RTC as a friend
-
Add Rational DOORS to the Whitelist in RTC
-
Associate Rational DOORS with the project in RTC
You must then open Rational DOORS and set it up to allow the connection from RTC.
Before you begin
-
Get yourself database manager powers or custom user powers to manage the database in Rational DOORS.
-
Make sure that Rational DOORS Web Access is running in https mode.
-
Make sure that you have logged in to Rational DOORS Web Access at least once since it was started.
Procedure
Set up RTC to allow the connection from Rational DOORS:
-
Log in to RTC as an administrator.
-
Go to the Application Administration page for the RTC application, click Application Administration >
Application, and then, in the Communication section in the navigation menu on the left, click Consumers (Inbound).
-
Create a consumer entry for Rational DOORS. Enter a consumer name (for example, DOORS), enter a consumer secret,
and then click Register. Make a note of the consumer secret. It is used later when you set up Rational DOORS.
-
Rational DOORS is now registered in RTC as a consumer. Navigate to the list of authorized keys, and make a note of
the consumer key that has been automatically allocated. It is used later when you set up Rational DOORS.
Add Rational DOORS to RTC as a friend:
-
In the navigation menu on the left, click Friends (Outbound), and in the Friends pane, click Add.
-
Enter a name for the connection (for example, DOORS).
-
Enter the details for the Rational DOORS service. This service is hosted on Rational DOORS Web Access, and the
default URL is https://hostname:8443/dwa/public/rootservices.
-
Enter an OAuth secret (for example, DOORS). Make a note of the OAuth secret. It is used later when you set up
Rational DOORS.
-
Click Create Friend. A green confirmation message is displayed.
-
Click Next. Make a note of the Provisional key. It is used later when you configure Rational DOORS to access RTC.
-
Click Finish.
Add Rational DOORS to the Whitelist in RTC:
-
In the navigation page on the left, click Whitelist (Outbound), and click Add.
-
In the URL Whitelist pane, enter the URL of the Rational DOORS database. The default URL is https://hostname:8443/.
-
Click Add. A green confirmation message is displayed.
Associate Rational DOORS with the project in RTC:
You can create an association between a project area in RTC and a module in Rational DOORS. After you establish the
association, you can link RTC artifacts, such as work items and plans, between the project area and objects in the
module in Rational DOORS. There are two associations to create.
-
Open the project.
-
In the Team Artifacts view of the Work Items perspective, click Project areas.
-
Select the new project.
-
On the Overview page, scroll down to Associations, and click Add.
-
In Application, select the Rational DOORS connection. The name that is displayed is the name you entered in the
Friends list.
-
The Rational DOORS Web Access login screen is displayed. Log in.
-
Go back to RTC.
-
In Association, select Provides - Implementation Requests.
-
In Artifact Containers, select the Rational DOORS module you want to work with.
-
Click OK, and select the next association.
-
In Association, select Provides - Requirements Change Requests.
-
In Artifact Containers, select the Rational DOORS module you want to work with.
-
Click OK, and then click Save to save the project.
Set up Rational DOORS to allow the connection from RTC:
-
Log in to Rational DOORS as a database manager or a custom user who has the power to manage the database.
-
Right-click the database root, and select the Remote Services tab.
-
Add the RTC server to the Server List:
-
Click Add, and enter a name for the connection (for example, RTC).
-
Enter the URL for the root services of the RTC server. If there was a clean installation of RTC, enter
https://hostname:port/ccm/rootservices. If RTC was upgraded from RTC 2.x, enter https://hostname:port/jazz/rootservices.
-
Enter the consumer key and enter the consumer secret in OAuth secret. You made a note of these in step 3
and step 4 when you set up RTC.
-
Click Register. The server is added to the list.
-
Add collaboration links from RTC projects to the Rational DOORS database:
-
In the Collaboration Links pane, click Add.
-
Select the server that you registered (RTC). If a security warning is displayed, click Yes.
-
The login page to RTC is displayed. Log in.
-
Select the project you want to access from Rational DOORS, and click Add.
-
Go back to Rational DOORS. The project is displayed in the Collaboration Links pane of the Remote Services
tab.
-
A Consumer Key and OAuth Secret should have been dynamically created when you added Rational DOORS as a friend to
RTC earlier. If they have not been created, create Consumer Key and OAuth Secret for the server:
-
On the Local Keys tab of the Rational DOORS database properties, click Add.
-
Enter the name of the connection (RTC).
-
Enter the friends consumer key and in OAuth secret. You made a note of these when you added Rational DOORS
to RTC as a friend.
-
Click Register, and then click OK to close the database properties.
RTC and Rational DOORS are now configured to communicate with one another.
6. Define a configuration template in Rational DOORS
The next step is to define a configuration template in Rational DOORS.
Defining a configuration template uses the Change Management for Rational DOORS functionality that is built into
Rational DOORS. The configuration template specifies the project area in RTC, the workflow to use, and the states and
actions in RTC that are to be used by Rational DOORS.
For information about Change Management for Rational DOORS, see the Change Management for Rational DOORS manual.
Procedure
To define the configuration template:
-
Open Rational DOORS.
-
Click Change Management > Define Configuration Templates. Step 1 of the Configuration Template wizard is
displayed..
-
Enter a name for the template, for example ‘DCS_v1’.
-
Select OAuth as the authentication method.
-
Select your configured RTC project area (The DCS restored project), and click Next. The RTC login screen is
displayed. If a Security Alert window is displayed, click Yes.
-
Log in to RTC as the user Rational / Rational. Step 2 of the Configuration Template wizard in Rational DOORS is
automatically displayed.
-
Map the RTC workflow states and actions to states and actions in the Requirements Change Management workflow.
Note: You must use the internal workflow state and action identifiers, not the names that are displayed in RTC. In
using the restored process in the RTC project area, you can find internal workflow state identifiers here:
-
https://rtc:9443/ccm/oslc/workflows/project area ID/states/Workflow
-
internal workflow action identifiers here: https://rtc:9443/ccm/oslc/workflows/project area ID/actions/Workflow
In this particular example, the URLs are:
When you open these URLs, an XML file is displayed listing the state identifiers and the action identifiers, for
example:
In this example, the state is Closed, which is denoted by the dc:title, and the state identifier is
ChangeRequest.state.s1, which is denoted by the dc:identifier.
-
In Assigned State, enter the state identifier ChangeRequest.state.s2.
-
In Review State, enter the state identifier ChangeRequest.state.s6.
-
In Approved State, enter the state identifier ChangeRequest.state.s7.
-
In Applied State, enter the state identifier ChangeRequest.state.s1.
-
Select For Rational Team Concert.
-
In Apply Action Attribute, enter the action identifier ChangeRequest.action.a5.
-
In Review Action Attribute, enter the action identifier ChangeRequest.action.a12.
-
In State Attribute, enter rtc_cm:state.
-
In RCR Submit Form, select Requirement Change Request.
-
In Conflicting Proposal Behavior, select Warn user of conflict.
-
Select Show RCR Recording Report and Enable Reject button in DWA:
Procedure - cont
-
Click Next. Step 3 of the Configuration Template wizard is displayed. Select Task in Use Submit Form and Task in
Use Add Form. Task is one of the Change Management Binding Settings in RTC Project Area.
-
Click Next, leave Step 4 blank, click Next, and then click Finish.
-
The new configuration template is created.
7. Set up the module configuration in DOORS
To use the integration, you must set up the module in Rational DOORS to use the configuration template. Set up the
module to use both Requirements Change Requests and Implementation Requests.
Procedure
To configure a module:
-
Open Rational DOORS.
-
Open the PROJECT_RESTORE/01 Requirements/User Needs module, and click Change Management > Configure Module.
-
Select the previously created RTC configuration template. This defines the project in RTC that you will connect to.
-
Set Integration Status to ON.
-
Select Enable Requirements Change Management to use Requirements Change Requests. The related fields can be edited.
Leave them selected:
-
Create RCR Attrs View creates a view in the module that lists all the Requirements Change Requests that
have been implemented against individual objects.
-
Manage External Links and Manage Internal DOORS Links manage traceability. Rational DOORS has both internal
and external links, and they can be managed independently.
-
Note: If you want to use the Implementation Request feature where requirements are sent to RTC for
developers to use, then you must consider managing external links. An Implementation Request creates an
external link to the work item in RTC. If you are managing external links, you must create an
Implementation Request as part of a Requirements Change Request. If you are not managing external links,
you can open the module for unmanaged changes and raise the Implementation Request.
-
Select DOORS Attributes Managed by RCRs, choose the attributes you want to manage, and click Apply. By default, the
integration manages the changes to Object Heading and Object Text. If you want, you can select other attributes
(for example, custom attributes such as Priority, Cost, and so on).
-
Select Enable Requirements Implementation to use Implementation Requests. The related fields can be edited:
-
Select Create IR Attrs View to create a view in the module that lists all the Implementation Requests that
have been implemented against individual objects.
-
Clear Enable Requirements Gathering.
-
Select Map Attributes for CM IR Submission, choose the attributes you want to map, and click Apply. The Rational
DOORS attributes are listed. Associate the attributes with RTC values by entering the RTC values in the CM
Attribute column. By default, Object Heading is mapped to title, and Object Text to description. Custom attribute
values must match the available values in RTC. Rational DOORS does not automatically check the associations; make
sure you check them manually.
-
Click OK, and then click Save.
Module configuration is complete.
Now that you have configured a module in Rational DOORS, you can proceed to use the integration. |