Technically implementing the Rational Toolset

Introduction

A question came up on the Rational discussion Forums recently about how to technically implement the full Rational Enterprise Toolset. More specifically, a project has justified all the business cases about purchasing the Rational toolset and n copies of each of each of the Rational Enterprise Suite 2002 and n copies of Rational ClearCase have arrived and the project is ready to go.

What do we do from here? How do we get going? What is the order of installation such that we have the most integrated offering from the product? This paper attempts to make a start on the answer. While this is a daunting task because of all the variables mentioned below, a definite guideline needs to be drawn in the sand, a "starter for 10" as they say in England or a straw-man which can form the basis around which all the alternatives can be detailed later. To this end this paper makes a number of assumptions and defines a process template which gives a guideline for the Process Engineer to get started.

This paper in no way defines a generic method for any situation, but rather takes an instance of a combination of variables and tries to define how to do it for this common instance. 

Business Goals of this paper

The diagram below depicts the context within which the implementing of tools takes place. Tools are intimately related to the Process. Primarily the process needs to decide which parts it is going to use and therefore which tools it will require. The Tools need process to drive their usage, which means there is a two way dependency.

The process configuration takes longer than implementing the tools, so the suggestion is to get a handle on the disciplines of implementation likely and then configure the tools for those areas. In our example in this paper, we are going for all areas and most all the tools (see assumptions)

The area circled in red above denotes the goals of the roles in this paper. We are going to concentrate on the Tools specialist who works briefly with the Process Engineer to define the toolset implementation, and then actually execute the implementation of the tools. This leaves a set of configured Enterprise Tools.

Variables

Implementing the Rational Enterprise Suite with ClearCase is a complex subject because is very linked to/constrained by all the following set of variables:

Assumptions

The assumptions that have been made for this particular paper.

Principals of enhancing an installation

Relationship between the Tools

Before getting started it might be useful to understand the tools and how they relate to each other (in simple high level terms). Below is a UML class diagram showing the Tools and their associated data or projects:

 

This is a bit on an unknown to the author of this paper and may require more investigation.

Inputs required to start

Hardware

This diagram uses a UML deployment diagram to denote the servers and roughly what they run. Here the options are slightly wild for a project of 10 people, but there is no harm in allocating say the VOB & the View Server to both reside on the same piece of hardware. You could also have the Database and ClearQuest and ReqPro all running on one server, etc. Performance is the issue here. The more the resources are distributed the better they will perform. Also each servers power will dictate the necessity to spread the load or allow more than one item to be shared.

Click on the diagram to take you back to the Activity diagram...

Execute the Toolset implementation.

Now simply follow the UML activity diagrams showing you the order of installing the tools. Items shown between the synchronisation bars can happen in any order, provided they all happen before continuing to the next step.

Click on this to Zoom into the detail for installing tools... Click on here to see the lower level diagram. Click on this to Zoom into the detail for creating integration links... The assumptions in this example are a starting point. You will want to define a more detailed list of your own and document them for review during the next iteration. Click on here to see the lower level diagram.

Install all tools.

Click on here to see the lower level diagram. A separate Paper on the importance of directory structures

Create Main Files.

Click here to return to the Toolset implementation...

Create integration links.

Click here to Zoom into the Setup Project Console... Click here to return to the Toolset implementation...

Setup Project Console.

Click here to return to Create integration links...

Ordered list of activities with more information.

Print this out and use it check off as you are going through the process if installing and configuring the various items.

Define working assumptions

As above in the assumptions section. Define your own assumptions, write them down and use them to try and resolve all likely implications before you start.

Plan hardware configuration

As per the hardware section. Define what hardware your company can afford to utilize on this project. The suggested configuration in this scenario is just one of the possible options. You have the ability to mix and match different software on different hardware. Obviously the more you put onto one server the worse the performance will be. Also you will need to balance the disk size and performance according to where most of the data is, etc.

Plan Software configuration

The idea here is to plan for all tools for this particular project. Not only Rational tools but Development languages, Utilities, third party libraries, etc. In this scenario we install MS Office, MS Project, an IDE and utilities, Web server and Web authoring software,

Order Hardware & Software

Install all hardware & operating system software

Install all tools

Install ClearCase VOB Server

Install ClearCase View Server

This software offers dynamic views of the files dependant upon the configuration specification of the user, which allows for different members of the team to be working on different collective versions. i.e. Testing may be testing the previous version, while development is building the latest version.

Install database to support ClearQuest and ReqPro

Create Directory structure for Rational product files

It is very important to have a global project directory structure which houses all Artifacts (models, source code, test scripts, etc.) for all Disciplines. Not just Designers and Implementers.

Install MS Project

Install Rational Suite Enterprise

Install Development IDE's

Install MS Word / Office

Install Web Server for Project Web

Install Web authoring tools

Create main Files

Create UCM project in ClearCase

[This section is a little unfamiliar to the author as our installations did not use UCM. So the actual data stored for this item may not all live in one little project. This area needs more investigation. Anyone in the know please send feedback.]

Create Master Schema in ClearQuest

Create User Database in ClearQuest based upon Enterprise template

Create ReqPro Project in ReqPro

Create Create Test Datastore

Create Main Rose Model

The rational project file will allow more than one Rose Model. In this scenario and for simplicity's sake with trace-ability, it is suggested that you create one Main Rose Model. This model will form the root element for all other Rose Models. The Rose Model file structure will be discussed in a separate paper. This also relates to how one configures the project directory structure. Both what is stored in ClearCase directories and that which is not stored in the ClearCase, but just on the file server.

Place under version control in ClearCase

Make sure to add these files to version control and check them in.

Create Master MS Project files

Create integration links

Create Rational Administrator Project

Link ClearQuest Database to the Rational Admin Project

Link main Rose Models to Rational Admin Project

Link ReqPro project to Rational Admin Project

Run ASCQIsetup.bat

In ReqPro setup link to Main Rose Model

In ReqPro setup link to MS Project

In MS Project permit linking to ClearQuest

Setup Project Console

Create Project Console Database

Define starter list of metrics

Setup project metrics information directory

Outputs

Issues

Conclusion

As stated at the outset this is complex because of the huge number of variables in any one implementation. Hopefully this is some sort of start which will give a backbone to further enhancements and elaborations.

Some people prefer to install all the Web based products wherever possible, such as ClearQuest Web, ClearCase Web, ReqPro Web. It makes sense because of the ease of upgrading centrally versus going around to each desktop to upgrade is far easier and less likely to get out of synchronisation. The down side is that until more recently the Web based products haven't had all the features of the more local client-server products. They may since well have become a more practical solution.

For those in the know, please offer comments and feedback on this so we can fix errors and get it much better so people can benefit by it.

Home

References

Naidoo, Om. ReqForum email. Feb 2002. Thanks for asking the Million dollar question!

Mercier, Claude. ClearQuestUserGroup email. Feb 2002. Thanks for the birds eye view template - most useful.

Rational Suite - Installation Guide version 2002.05.00.

Edwards, Charles. ProcessWave. Written Feb 2002. Last updated 3rd April 2002.