Synchronize requirements data between Rational DOORS and Rational System Architect

Install and configure the software and synchronize the data

In enterprise architecture (EA), it is very important to keep track of the requirements associated with the EA artifacts. This article explains how to synchronize and map the EA data within the Rational DOORS requirements management software with Rational System Architect to track any requirements associated with the EA artifacts.

Krupa Sudheendra Gunhalkar (krupa.gunhalkar@in.ibm.com), System Software Engineer, IBM

author photoKrupa Gunhalkar joined the Rational DOORS team in July 2011 after working on Rational System Architect for nearly four and half years. Her interests are requirements management, Collaborative Lifecycle Management offerings, enterprise architecture modeling, DoDAF and MoDAF frameworks, security testing of web-based applications, and licensing concepts for the applications. Her hobbies include long drives, playing volleyball, watching movies and cooking shows, and visiting art exhibitions whenever she gets a chance.



06 December 2011

Also available in Chinese Russian

Overview

IBM® Rational® DOORS® is a requirements management tool, and IBM® Rational® System Architect is a tool for enterprise architecture and business process modeling. Requirements can be linked from the Department level down to the Component level to show that an enterprise architecture meets all of the high-level requirements for the EA artifacts. This article covers the entire process of integrating Rational DOORS with Rational System Architect, including staging artifacts in System Architect to send to DOORS, sending them to DOORS, and then linking them so you can view them in System Architect. Linking the artifacts helps in the traceability of the requirements that are associated with the EA artifacts. The Samples database has been used as an example for synchronization of the existing artifacts in System Architect. However, you can always create the artifacts in a new database in System Architect and synchronize them with DOORS. Synchronization and links created for the System Architect artifacts with DOORS objects can be viewed with a graphical indicator on the System Architect artifacts.


System requirements

  • Microsoft Windows Server 2003 (Standard or Enterprise), 32-bit or 64-bit

Install Rational DOORS

To install Rational DOORS, first install the server and then the client.

Install the latest version of the Rational DOORS server

  1. Run the Rational DOORS server setup.exe file.
  2. Click the Next button, and accept the license server agreement.
  3. For Setup Type, select Typical, and then click Next.
  4. Enter the Database Port number, usually 36677.
  5. Click Install.

Install the DOORS client that is the same version as the server

  1. Run the Rational DOORS client setup.exe file.
  2. Click Next, and accept the license server agreement.
  3. For Setup Type, select Typical, and then click Next.
  4. In the Database Port field, type 36677.
  5. In the Database Host field, type either the IP address or the fully qualified host name of the machine on which the Rational DOORS server is installed.

Install Rational System Architect

  1. Run the ratlSysArch_version.exe file.
  2. Click Next, and accept the license server agreement.
  3. For Setup Type, select the Typical and then click Next.
  4. Provide the License Information in the form of portnumber@hostname (where hostname is the machine name where the license server is configured).
  5. Click Next to go the Summary page.
  6. Click Finish on the Summary page to finish the installation.

Note:
The Rational System Architect DOORS link works with Rational DOORS 9.0, 9.1, and 9.2. Beginning with Rational System Architect 11.4.0.1, the Rational System Architect DOORS link works with DOORS 9.3.


Install the Rational System Architect for DOORS Interface

  1. Run the ratlSysArch_DOORSInteface_version.exe file.
  2. Click the Next button on the Welcome screen, as shown in Figure 1.
Figure 1. Rational System Architect for DOORS Interface Welcome screen
Next button selected at the bottom of the screen
  1. Continue clicking Next until you see the wizard notice of successful installation, with the Finish button at the bottom (Figure 2).
Figure 2. Wizard notification of successful installation
Installation success notice with Finish button
  1. Click Finish to complete the installation of the interface.

Synchronize the two tools

Information Center excerpt

You can port Rational System Architect modeling artifacts into DOORS so that they are viewable and so that traceability links can be created between them and DOORS objects. All linking of Rational System Architect model artifacts to DOORS objects is done in DOORS, not Rational System Architect. You can port instances of a symbol, a definition, or a diagram into DOORS. This includes line symbols.

After linking to DOORS, you can "update" Rational System Architect and view the requirements that are linked with model artifacts in a Rational System Architect encyclopedia…. You can also view a skeleton of the DOORS object in Rational System Architect and use its reporting system to view relationships between DOORS objects and model artifacts, using three reporting relationships: links to, is to be sent to, and has been sent to.

Be sure to see the excerpt from the Rational System Architect Information Center in the sidebar, which puts this information in context and gives you a quick overview.

Create the database in Rational System Architect

  1. Launch Rational System Architect.
  2. Launch the Startup Wizard from the Help menu.
  3. Click the Next button on the Welcome screen (see Figure 3).
Figure 3. Startup Wizard Welcome screen
System Architect configuration wizard
  1. On the screen that says "Configure where encyclopedia data will be stored," select the Configure advanced SQL Express options check box shown in Figure 4, and click Next.
Figure 4. Configure the Encyclopedia data
User is configuring the database settings provided internally with System Architect
  1. Click the Next button on the consecutive pages displayed after this step until you see the Summary screen with the Finish button (Figure 5).
  2. Click Finish.
Figure 5. Summary of preexisting databases and selections
Includes the Samples database list for System Architect

Open the Samples database in System Architect

  1. Open the Encyclopedia dialog window by selecting File > Open Encyclopedia from the Rational System Architect main menu.
  2. Select the Existing folder on the left.
  3. Select the Samples encyclopedia, as shown in Figure 6.
  4. Click on the OK button for Samples encyclopedia to load.
Figure 6. Open the Samples encyclopedia
Open Encyclopedia dialog window
  1. After the Samples encyclopedia is loaded, you can see the All pane Explorer window on the right side.
  2. Expand the Diagrams tree node on the All pane of the Explorer view in System Architect.
  3. Further expand the Business Process diagram type (see Figure 7).
  4. Double-click Reservations to open the view of the diagram.
Figure 7. Reservations business process diagram opened
Diagrams listed on left, Reservations tab on right
  1. Create a project for staging and sending the artifacts. Before you begin staging, sending, and linking the artifacts in Rational System Architect, you must follow these steps to create a project in DOORS that will be kept open:
    1. Log in to Rational DOORS.
    2. Create a new project named SADATA.
    3. With the SADATA project open, switch back to the System Architect diagram window.

Stage artifacts to send to DOORS from System Architect

  1. Select a symbol on the diagram.
  2. Right-click and, from the drop-down menus, select DOORS > Stage Symbol to DOORS (Figure 8).
Figure 8. Staging Symbol for DOORS
User is staging the symbol to be sent to DOORS using context menu option

Larger view of Figure 8.

After you select the Staging option, you will see the DOORS Select Transfer Units window shown in Figure 9.

  1. The Module Name pane shows a pre-created unit, TU1, so select that unit.
  2. For the first time, you need to create a transfer unit of any name of your choice by clicking the New button provided on the Select Transfers Unit dialog window shown in Figure 9.

Tip:
By default, the transfer unit gets created in the project opened in DOORS previously. You can have multiple transfer units in a single project or projects of your choice, and those should be available before creating the transfer units in System Architect.

Figure 9. Select Transfer Unit created while staging artifacts
TU1 selected in the Module Name pane
  1. Click OK.

Send artifacts to DOORS from System Architect

  1. After staging the symbol, right-click on the symbol.
  2. Select DOORS > Send to DOORS from the drop-down menus, as shown in Figure 10.
Figure 10. Select the System Architect artifacts to send to DOORS
Selections on drop-down menus in the diagram pane

Larger view of Figure 10.

  1. Select the TU1 transfer unit.
  2. Click OK.

Figure 11 shows the transfer progress pop-up window that Rational DOORS will display.

Figure 11. Transfer in progress
Bar shows status of transfer

Larger view of Figure 11.

After the transfer is finished, a report is generated in System Architect generates a saying that one item has been transferred to DOORS, as shown in Figure 12.

Figure 12 . DOORS integration report
Confirmation notice on the right

Larger view of Figure 12.

  1. Open the DOORS SADATA project that you created for the integration in DOORS .
  2. Open the TU1 transfer unit, which will be displayed as a module of DOORS.
  3. User can now see all of the items sent from System Architect to DOORS in this transfer unit.
  4. From the Process Symbols listed in the SA Integration Proxy pane, select Take Reservation Details. Then from the drop-down menus, click Link > Start Link from the drop-down windows to make a start link to one of the transferred artifacts, as shown in Figure 13.
Figure 13. Create a Start Link for System Architect artifacts
Drop-down menus with selections described

Larger view of Figure 13.

  1. Next, with the same process symbol selected, make a link from Start to another transferred artifact by clicking Start > Make Link from Start in the drop-down menus, as shown in Figure 14.
Figure 14 . Create a DOORS link to another System Architect artifact
Two drop-down menus with selections described

Larger view of Figure 14.

The yellow incoming and red outgoing arrows on the DOORS Module Window indicate links created on the System Architect artifacts (Figure 15).

Figure 15. Arrows show the Start link and the Link to Start link
Screen capture shows tiny colored arrows

Larger view of Figure 15.

Synchronize data between DOORS and System Architect

  1. After the artifacts are staged, sent, and linked in DOORS, right-click on the diagram workspace, and then click DOORS > Update from DOORS on the menu, as shown in Figure 16.
Figure 16. Update Data from DOORS
Drop-down menu selections on the diagram

Larger view of Figure 16.

  1. When the Update from the DOORS menu item is clicked, you will be prompted to save module changes, so click Yes to do that.
  2. Reopen the diagram after updating the data from DOORS.

Figure 17 shows the diagram workspace. The arrows indicate links for the symbols that have been staged to transfer to DOORS and linked in DOORS to System Architect. The links will be shown on two symbols as the links have been created for two symbols of System Architect in the DOORS module. The yellow arrow on the symbol indicates the Start link, and the red arrow indicates the link to the start link. Hence, links will be displayed for two symbols on the diagram that is opened. Upon reopening the diagram, the updated data from DOORS will be visible.

Figure 17 . Linked artifacts
Link symbols (arrows) on diagram elements

Larger view of Figure 17.

Resources

Learn

Get products and technologies

Discuss

Comments

developerWorks: Sign in

Required fields are indicated with an asterisk (*).


Need an IBM ID?
Forgot your IBM ID?


Forgot your password?
Change your password

By clicking Submit, you agree to the developerWorks terms of use.

 


The first time you sign into developerWorks, a profile is created for you. Information in your profile (your name, country/region, and company name) is displayed to the public and will accompany any content you post, unless you opt to hide your company name. You may update your IBM account at any time.

All information submitted is secure.

Choose your display name



The first time you sign in to developerWorks, a profile is created for you, so you need to choose a display name. Your display name accompanies the content you post on developerWorks.

Please choose a display name between 3-31 characters. Your display name must be unique in the developerWorks community and should not be your email address for privacy reasons.

Required fields are indicated with an asterisk (*).

(Must be between 3 – 31 characters.)

By clicking Submit, you agree to the developerWorks terms of use.

 


All information submitted is secure.

Dig deeper into Rational software on developerWorks


static.content.url=http://www.ibm.com/developerworks/js/artrating/
SITE_ID=1
Zone=Rational
ArticleID=778712
ArticleTitle=Synchronize requirements data between Rational DOORS and Rational System Architect
publish-date=12062011