How to integrate Rational RequisitePro 7.1 and Rational Software Architect 7.5 to trace requirements

Create requirements traceability in a use case modeling process

Learn how to create use case requirements traceability by using an integration that links your Rational Software Architect and the IBM® Rational® RequisitePro® environments. Using the process outlined in this article can help you improve requirements traceability across your organization.

Share:

Most software development managers would like to have a greater understanding of and better control over their project's requirements traceability functions. When your team is using both the IBM® Rational® RequisitePro® and IBM® Rational® Software Architect tools, integrating the two can help you trace use case requirements. Follow the steps outlined here to get started.

Prerequisite: You must have Rational RequisitePro Version 7.1 and Rational Software Architect 7.5 or later installed on your machine and be familiar with using both.

Create project requirements in Rational RequisitePro

Rational RequisitePro software is an easy-to-use requirements management tool. It helps dispersed teams write, create, and share requirements by using familiar document-based methods. In addition, the RequisitePro environment helps you leverage database-enabled capabilities, such as requirements traceability and impact analysis.

Create a project in Rational RequisitePro

There are different ways of creating a project, based on your needs. For the purposes of this guide, you will create it in Rational RequisitePro by using a Rational Unified Process (RUP) template. This template follows IBM Rational Unified Process (RUP) methodology guidelines. It also includes required deliverables, along with appropriate document and requirement types.

  1. Open Rational RequisitePro and create a new project.
  2. When prompted, select the RUP template icon, Figure 1 shows, and then click OK.
Figure 1. Creating a project in the RequisitePro environment
Project selection in RequisitePro
  1. Provide an appropriate name for the project, and use the Browse button to select the directory and the arrow to get the drop-down menu to select the database for the project. Figure 2 shows these selections for this example:
  • Name: MyArticle
  • Directory: REQUISITEPRO\Projects\MyArticle\project
  • Database: MS Access
Figure 2. Specify the project properties
RequisitePro Project Properties screen

You can see the new requirement project in the project tree. Browse project, MyArticle, and expand the Use Cases folder, as shown in Figure 3).

Figure 3. Project view
Screen capture of the MyArticle file directory

Larger view of Figure 3.

Create Use Case requirements in RequisitePro

You can create approximately 13 different kinds of requirements in the RequisitePro tool. Here, we focus on Use Case (UC) requirements only.

For this exercise, you will work on a Driver Ticket Payment System, where drivers can pay their traffic tickets either through an Internet process or by phone. While paying tickets, they must provide their personal payment information. They might also check points for their offense in a catalog.

The following use cases have been identified for this functionality:

  • Ticket Payment by Phone
  • Ticket Payment by Internet
  • Ticket Payment
  • Capture Driver Information
  • Access Point Catalog

Now, create those requirements (use cases) in Rational RequisitePro:

  1. Select the Use Case folder as you did previously (Figure 3), right-click, and select New > Requirement from the drop-down menu.
  2. The tool will prompt you to enter the requirement (use case) name and other attributes, as Figure 4 shows:
    • Type: UC: Use Case (select from the drop-down menu).
    • Name:Ticket Payment by Phone (type).
  3. Click OK.
Figure 4. Requirement properties view
Requirement Properties work area
  1. Create the other four use cases in a similar fashion.

You can then see all five of the requirements, UC2 through UC5 (Figure 5).

Figure 5. Use Cases directory
Screen shows 5 use cases, UC2 - UC6

Larger view of Figure 5.


Create a modeling project in Rational Software Architect

  1. After opening the workspace in Rational Software Architect Version 7.5 environment, change to the Modeling perspective.
  2. Now create a modeling project by selecting File > New > Modeling Project, as in Figure 6.
  3. Name the project (for this exercise, type Use Case Modeling), and then select these options, as shown in Figure 6:
    • Check the box for "Use default location."
    • Under "Create new model from," check the box for Create new model in project, and make sure that Standard template is selected.
  4. Then select Next.
Figure 6. Create a new model project
Create Model Project screen, shows options
  1. Next, create a new model from a standard template. For this example, choose these options (see Figure 7):
    • Under Categories, select Requirements.
    • Under Templates, select Use Case Package.
  2. Then select Finish.
Figure 7. Choose a standard template
Model Project window with Requirements file opened.

You can see the created project in the Project Explorer view (Figure 8).

Figure 8. Created Use Case model
Blank Use Case Model

Integrate Rational Software Architect and Rational RequisitePro

In order to integrate your Rational Software Architect tool with your Rational RequisitePro environment, you must install the RequisitePro integration feature called Lifecycle and architecture tool integrations, which is an option among your Rational Software Architect features.

  1. Install this feature by using the Features to Install menu under Updates IBM Installation Manager, as shown in Figure 9.
Figure 9. Install the tool integrations feature
Installation Manager, Update Packages view

After this installation, you are ready to integrate Rational Software Architect with RequisitePro.

  1. To integrate use cases from the RequisitePro tool, open the requirement project from the Rational Software Architecture Requirement Explorer view.
  2. Click the icon or right-click on the Requirement Explorer pane, and select the MyArticle.rqs project (provided in MyArticle-RQS.zip, see Downloads) (see Figure 10).
Figure 10. Integration with Rational RequisitePro
Requirement Use Case Model Instructions window window
  1. Select the username (by default: Unknown, as Figure 11 shows), and click OK.
Figure 11. User name prompt
Project Logon prompt box

You can then see the two tools integrated (Figure 12).

Figure 12. View of integrated tools
Project Explorer on Left, Requirement Explorer on Right
  1. Highlight all of the use cases from the Requirement Explorer and drag them to the Project Explorer to drop them within the Use-Case Building Blocks folder, as Figure 13 illustrates.
Figure 13. Drag all of the use cases to Use-Case Building Block
Arrow shows direction to drag selected use cases

Model the five use cases in Rational Software Architect

After linking use cases in the Project Explorer, it is time to finish the use case modeling.

First, you will create these two actors in the Versatile Actors package:

  • Driver who can pay the ticket by phone, called Phone-Driver
  • Driver who can pay ticket by using the Internet, called Internet-Driver
  1. Create an Actor diagram by right-clicking and selecting Add UML > Actor for all of the actors. As Figure 14 shows, you will then see all created actors.
  2. Now double-click the Versatile Actors diagram to open it.
  3. Drag all of the actors in diagram so that you associate Internet-Driver and Phone-Driver with the parent actor that is simply called Driver.
Figure 14. Create and model the actors
Screen capture of the Versatile Actors tab, opened

Larger view of Figure 14.

  1. Next, under the Use-Case Building Blocks package, copy and paste the ${functional.area} package icon and rename as Driver Ticket Payment.
  2. Select to move all use cases to that new Driver Ticket Payment package, as Figure 15 shows.
Figure 15. Move all of the use cases to the functional.area folder
Picture shows the Project Explorer tab with the functional are Use Cases file opened.
  1. Double-click the ${functional.area} Use Cases Unified Modeling Language (UML) diagram to open the editor. Drag all of the Use Cases and Actors from the project explorer to the editor, as shown in Figure 16.
Figure 16. Use case model diagram
Shows the functional area Use Cases area opened

Larger view of Figure 16.

Create associations

Now you can create associations between use cases and actors according to the requirements. Figure 17 shows the Driver Ticket Payment Use Cases tab with the Use Cases open for viewing.

Figure 17. Use case modeling with associations
Diagram that shows all actors and use cases

Larger view of Figure 17.

Internet-Driver and Phone-Driver are specializations of the actor called Driver. In this scenario, a <Generalization> relationship can be established between these parent and child elements.

There are two concrete use cases: Ticket Payment by Internet and Ticket Payment by Phone. These use cases are variations of the abstract use case called just Ticket Payment.

The Access Point Catalog is an optional sequence [behavior ] for the Ticket Payment use case; therefore, an <extend> relationship is established between them. "Capture Driver information" is a mandatory behavior of Ticket Payment; without this, the payment process cannot be completed. Therefore, an <include> relationship is established between them.

Use Case Model Overview, Actors Overview, and Context diagrams

The Use Case Model Overview is the final output of the use case modeling. It consists of the Actors Overview and the Context diagram for a particular system.

  • The Actors Overview includes only actors that belong to that functionality. It is different from the Versatile Actor Diagram, where all the actors of the system are defined.
  • The Context Diagram also represents the scope of the particular function or the overall system.
  1. To create the Actors Overview, drag the appropriate actors from the Versatile Actor package onto the Actors Overview diagram, as shown in Figure 18.
Figure 18. Actors Overview diagram
Actors Overview tab, open

Larger view of Figure 18.

  1. For the Context diagram, drag all of the Use Cases and Actors from the appropriate packages, and create a logical grouping (represent the scope) by putting them in the square box, as Figure 19 shows.
Figure 19. Context diagram
Context Diagram tab opened to show the diagram

Larger view of Figure 19.


Establish requirements traceability

Requirements traceability is a relationship between two requirements that implies the source, derivation, or dependencies between the artifacts.

You can use traceability relationships to determine the extent to which your project requirements are satisfied. As elements or their associated requirements change, you can use traceability relationships to monitor the impact of these changes.

Let's assume that Ticket Payment is one of the Feature (FEAT) requirements for which all of the use cases have been created.

  1. From the Requirement Explorer tab of Rational Software Architect (or from Rational RequisitePro), create a FEAT requirement (see Figure 20): Within the MyArticle project, expand the 02 – Visions and Features folder so that you can select FEAT1 Ticket Payments.
Figure 20. Feature creation from Rational Software Architect
Screen shows the Requirement Explorer tab open

Create traceability

Now create traceability between these features and use cases:

  1. Double-click FEAT1 Ticket Payments in the Requirement Explorer view.
  2. Then click the Add button in the Traces From pane, and add all use cases for Ticket Payment (see Figure 21):
    • Ticket Payment by Phone
    • Ticket Payment by Internet
    • Ticket Payment
Figure 21. Traceability creation
Requirements Explorer and Requirement FEAT1 pane

Larger view of Figure 12.

View the results

Now, to trace requirements:

  1. Right-click on FEAT1 Ticket Payment.
  2. Then select Query >Impact Analysis > Clients to create a diagram that shows traceability.

Note:
You can also see the traceability in the Requirement Trace View and Requirement Query Results, as shown in Figure 22.

Figure 22. Traceability results
Traceability diagram

Larger view of Figure 22.


Summary

After following the steps outlined in this article, you now know how to integrate your Rational RequisitePro and Rational Software Architect environments for use case requirements, use case modeling, and requirement traceability. This process not only bridges the gap between business and IT but also synchronizes requirements from one tool to another. For further reference, in your Rational Software Architect tool, watch the integration and use case modeling video, or open the zipped project interchange file (RSA-ReqPro-PIF.zip) for the use case modeling project. Resources are available in your Rational RequisitePro environment under the zipped project file (MyArticle-RQS.zip). You can also view these YouTube videos: RequisitePro and Rational Integration and Use Case Modeling.


Downloads

DescriptionNameSize
Project filesMyArticle-RQS.zip353KB
Project Interchange FileRSA-ReqPro-PIF.zip12KB

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=461261
ArticleTitle=How to integrate Rational RequisitePro 7.1 and Rational Software Architect 7.5 to trace requirements
publish-date=01142010