Guideline: Configuring the RTC/DOORS Integration
This guideline describes the main configuration aspects related to the DOORS/RTC integration.
Relationships
Related Elements
Main Description

1. Configure RTC and Rational DOORS to communicate with one another

To allow the integration to work correctly, both RTC and the Rational DOORS must be set up to communicate with one another.

Before you begin

  • Make sure the Jazz Team Server is started on <evalserver>
  • Make sure the DOORS database server is started on <evalserver>
  • Make sure the DWA Broker, Interoperation Server and DWA server are started on <evalserver>
  • Make sure that you have logged into Rational Team Concert, DOORS and DOORS Web Access at least once since the servers were started but log out of any open applications before you begin.

Procedure

Set up RTC to allow the connection from Rational DOORS:

  1. Open Internet Explorer and navigate to :https://evalserver:9443/ccm/admin; where <evalserver> is the name of the machine hosting your RTC server.
  2. Log in to RTC as as user 'rational' (password 'rational')
  3. You should arrive at the Application Administration page
  4. In the Communication section in the navigation menu on the left, click Consumers (Inbound)
  5. Create a consumer entry for Rational DOORS
    1. Enter the Consumer Name: DOORS
    2. Enter the Consumer Secret: abc123 (remember this Secret, it is used later)
    3. Enter the Consumer Secret in the Re-Type Consumer Secret field
    4. Check the Trusted check-box
    5. Click Register
  6. 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:

  1. In the navigation menu on the left, click Friends (Outbound), and in the Friends pane, click Add.
  2. Enter the Name: DOORS.
  3. Enter the Root Services URI: https://evalserver:8443/dwa/public/rootservices where <evalserver> is the name of the machine hosting the DWA server.
  4. Enter an OAuth Secret: abc123. Make a note of the OAuth secret. It is used later when you set up Rational DOORS.
  5. Re-type Secret: abc123
  6. Verify that Trusted is checked and then click Create Friend. A green confirmation message is displayed.
  7. Click Next. Make a note of the Provisional key. It is used later when you configure Rational DOORS to access RTC.
  8. Click Finish.

Add Rational DOORS to the Whitelist in RTC:

  1. In the navigation page on the left, click Whitelist (Outbound).
  2. In the URL Whitelist pane, enter the URL of the Rational DOORS database. The default URL is https://evalserver:8443/ .
  3. 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.

  1. Open the Infusion Pump project administration:
    1. Select Project Areas -> Active Project Areas and then select your Infusion Pump Example A project.
  3. On the Overview page, scroll down to Associations, and click Add. You will see the Add Association dialog (see Figure 1 below, note that the name in brackets in the Application field will be the name of the machine that is hosting DOORS in your installation).
  4. In Application, select the Rational DOORS connection. The name that is displayed is the name you entered in the Friends list.
  5. The Rational DOORS Web Access login screen is displayed. Log in as user "rational', password 'rational'.
  6. Go back to RTC.
  7. In Association, select Provides - Implementation Requests.
  8. In Artifact Containers, select the Services for DOORS Medical Device Solution Repository. (Note: the default name for the DOORS repository is "Rational DOORS ERS Repository, but we changed this during the DOORS/DWA installation and configuration when we updated the festival.xml file).
  9. Click OK.
  10. In the Associations section, Click Add to add another association
  11. In the Add Association dialog, select DOORS from the Application drop-down list
  12. In Association, select Provides - Requirements Change Requests.
  13. In Artifact Containers, select the Services for DOORS Medical Device Solution Repository.
  14. Click OK.
  15. Scroll to the top of the RTC web page and click Save to save your changes to the Infusion Pump Example A Project. 

 

          Figure 1: Add Association Dialog

Set up Rational DOORS to allow the connection from RTC:

  1. Log in to Rational DOORS as the user 'rational' (password 'rational').
  2. Right-click the database root, select Properties, and select the Remote Services tab.
  3. Add the RTC server to the Server List:
    1. Click Add, and enter a name for the connection (for example, RTC).
    2. Enter the URL for the root services of the RTC server: https://evalserver:9443/ccm/rootservices.
    3. Enter the consumer key and enter the consumer secret in OAuth secret. You made a note of these in the previous step when you set up RTC.
    4. Click Register. The server is added to the list.
  4. Add collaboration links from RTC projects to the Rational DOORS database:
    1. In the Collaboration Links pane, click Add.
    2. Select the server that you registered (RTC). If a security warning is displayed, click Yes.
    3. The login page to RTC is displayed. Log in as user 'rational' (password 'rational').
    4. In the Service Providers: field expand the Change Management node and select the Infusion Pump Example A project.
    5. In the Link Types: field multi-select the 'Affected by ...', "Implemented by..." and "Tracked by..." link types, and click Add.
    6. Confirm that all three link types appear in the Collaboration Links pane of the Remote Services tab.
    7. Click Apply.
  6. A Consumer Key and OAuth Secret should have been dynamically created when you added Rational DOORS as a friend to RTC earlier.
    1. On the Local Keys tab of the Rational DOORS database properties, click Add.
    2. Enter the name of the connection (RTC).
    3. 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.
    4. Click Register, and then click OK to close the database properties. 

RTC and Rational DOORS are now configured to communicate with one another.

2. 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:

  1. Make sure you are logged into Rational DOORS as user 'rational'.
  2. Click Change Management > Define Configuration Templates.
  3. The Define Configuration Templates wizard should start (Note: it may open minimized on the taskbar).
  4. Click Create.
  5. Step 1 of the Configuration Template wizard is displayed.
  6. Enter a name for the template, for example ‘DCS_v1’.
  7. Select OAuth as the authentication method.
  8. In the 'Select a CM Tool:' drop-down list, select the Infusion Pump Example A projectand click Next.
  9. The RTC login screen may be displayed. If a Security Alert window is displayed, click Yes and Log in to RTC as the user rational / rational if needed 
  10. Step 2 of the Configuration Template wizard in Rational DOORS is automatically displayed.
  11. Enter the values the following values and click Next (See Figure 2, below to see the completed dialog).
    1. In Assigned State, enter the state identifier ChangeRequest.state.s2.
    2. In Review State, enter the state identifier ChangeRequest.state.s6.
    3. In Approved State, enter the state identifier ChangeRequest.state.s7.
    4. In Applied State, enter the state identifier ChangeRequest.state.s1.
    5. Select For Rational Team Concert.
    6. In Apply Action Attribute, enter the action identifier ChangeRequest.action.a5.
    7. In Review Action Attribute, enter the action identifier ChangeRequest.action.a12.
    8. In State Attribute, enter rtc_cm:state.
    9. In RCR Submit Form, select Requirement Change Request
    10. In Conflicting Proposal Behavior, select Warn user of conflict
    11. Select Show RCR Recording Report and Enable Reject button in DWA
  12. Click Next
  13. Step 3 of the wizard will be presented
  14. For User Submit Form select 'Task'
  15. For 'Use Add Form' select 'Task'
  16. Click Next
  17. Step 4 of the wizard will be presented
  18. Leave the Default Query String Blank (we will not be using the Requirements Gathering capabilities in this beta evaluation).
  19. Click Next
  20. You will be presented a summary of all of the settings. Click Finish
  21. Confirm that the DCS_v1 template appears in the list of templates and Close the Define Configuration Template dialog.  

  

                       Figure 2: Completed dialog for Step 2 of the DOORS Configuration wizard

3. 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 the User needs module:

  1. Open Rational DOORS.
  2. Open the DOORS Database/Infusion Pump Demo/01 Requirements/User Needs module
  3. Click Change Management > Configure Module.
  4. Select the DCS_v1 template.
  5. Set Integration Status to ON.
  6. Select Enable Requirements Change Management to use Requirements Change Requests. The related fields can be edited. Leave them selected:
    1. Create RCR Attrs View creates a view in the module that lists all the Requirements Change Requests that have been implemented against individual objects.
    2. Manage External Links and Manage Internal DOORS Links manage traceability. Rational DOORS has both internal and external links, and they can be managed independently.
    3. 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.
  7. 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). Use the setting shown in Figure 3, below.
  8. Click Save.
  9. The module will be configured and the Select Default RCR dialog will appear. Close the Select Default RCR dialog and close the User Needs module.

           Figure 3: Recommended Attributes for Change Control

Procedure

To configure the Product Requirements module:

  1. Open Rational DOORS.
  2. Open the DOORS Database/Infusion Pump Demo/01 Requirements/Product Requirements module, and click Change Management > Configure Module.
  3. Select the previously created RTC configuration template. This defines the project in RTC that you will connect to.
  4. Set Integration Status to ON.
  5. Select Enable Requirements Implementation to use Implementation Requests. The related fields can be edited:
    1. 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.
    2. Clear Enable Requirements Gathering.
  6. Select Map Attributes for CM IR Submission, choose the attributes you want to map, and click Apply. The Rational DOORS attributes are listed (Object Heading, Object Text). 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.
  7. 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.

©  Copyright IBM Corp. 1987, 2010.  All Rights Reserved.