Configuring Rational Suite

Transcription

1 Cofigurig Ratioal Suite Product Versio Ratioal Suite Release Date April 2000 Part Number

2 IMPORTANT NOTICE Copyright Notice Copyright 1998, 1999, 2000 Ratioal Software Corporatio. All rights reserved. Trademarks Ratioal, the Ratioal logo, ClearCase, PureCoverage, Purify, Quatify, Ratioal Rose, ad SoDA are trademarks or registered trademarks of Ratioal Software Corporatio i the Uited States ad i other coutries. All other ames are used for idetificatio purposes oly ad are trademarks or registered trademarks of their respective compaies. FLEXlm ad GLOBEtrotter are trademarks or registered trademarks of GLOBEtrotter Software, Ic. Licesee shall ot icorporate ay Globetrotter software (FLEXlm libraries ad utilities) ito ay product or applicatio the primary purpose of which is software licese maagemet. Microsoft, MS, ActiveX, BackOffice, Developer Studio, Visual Basic, Visual C++, Visual IterDev, Visual J++, Visual Studio, Wi32, Widows, ad Widows NT are trademarks or registered trademarks of Microsoft Corporatio. Ratioal Purify is licesed uder Su Microsystem s U.S. Pat. No 5,404,499. Oracle, Oracle7, ad Oracle 8 are trademarks or registered trademarks of Oracle Corporatio. Sybase ad SQL Aywhere are trademarks or registered trademarks of Sybase Corporatio. U.S. Govermet Rights Use, duplicatio, or disclosure by the U.S. Govermet is subject to restrictios set forth i the applicable Ratioal Licese Agreemet ad i DFARS (a) ad (a) (1995), DFARS (c)(1)(ii) (Oct 1988), FAR (a) 1995, FAR , or FAR , as applicable. Patet U.S. Patet Nos. 5,193,180 ad 5,335,344 ad 5,535,329 ad 5,835,701. Additioal patets pedig. Warraty Disclaimer This documet ad its associated software may be used as stated i the uderlyig licese agreemet, ad, except as explicitly stated otherwise i such licese agreemet, Ratioal Software Corporatio expressly disclaims all other warraties, express or implied, with respect to the media ad software product ad its documetatio, icludig without limitatio, the warraties of merchatability or fitess for a particular purpose or arisig from a course of dealig, usage or trade practice.

3 CONFIGURING RATIONAL SUITE Cotets Preface 1 Welcome to Ratioal Suite Ratioal Suite Editios Ratioal Suite Admiistratio Istallig Ratioal Suite Software Licesig Ratioal Suite Before You Pla Developig a Database Pla Creatig ad Maagig a Ratioal Repository Writig Sychroizer Rules Customizig Exteded Help Creatig a Ratioal Repository What is a Ratioal Repository? Plaig the Repository Which Ratioal Tools Will the Team Use? Which Commercial Databases Will You Use? Will You Use Existig Ratioal Data? Usig the Ratioal Admiistrator Settig Up the Repository High-Level Steps for Settig Up a Ratioal Repository Upgradig Existig Data Istallig ad Cofigurig Databases Decidig Where to Locate the Repository Creatig the Repository Addig Oe or More Projects iii

4 Addig Users, Groups, ad Computers Attachig Existig Rose Models Placig Data uder Cofiguratio Cotrol Usig Ratioal Suite without a Repository Cofigurig the Itegratio for ClearQuest ad RequisitePro Overview: Settig Up the Itegratio Creatig a Ratioal Repository Cofigurig the ClearQuest Schema Repository Databases Upgradig the ClearQuest Schema Repository Database Upgradig the ClearQuest User Database Cofigurig the RequisitePro Repository Project Upgradig the RequisitePro Repository Project Collectig Setup Iformatio Updatig the ASCQISetup.bat file Ruig the Batch File Upgradig the Associatios Ratioal Sychroizer Overview of Usig the Sychroizer Example Creatig ad Updatig Items I this Chapter Usig the Sychroizer Startig the Sychroizer Startup Cotext: What to Expect Workig with the Sychroizer Admiistratio for the Sychroizer Importig Rules Writig Sychroizer Rules iv Cofigurig Ratioal Suite

5 6 Ratioal Suite Out-of-the-Box Tools RequisitePro Out-of-the-Box Project Creatig a Project Based o a Existig Project The Ratioal Rose RUP Model Tool Metors Exteded Help Viewig Exteded Help Customizig Exteded Help Additioal Resources Olie Release Notes Error Message EHRegister Idex v

6 vi Cofigurig Ratioal Suite

7 CONFIGURING RATIONAL SUITE Tables Table 1: Ratioal Suite Tools Table 2: Commercial Database Choices Table 3: ClearQuest RequisitePro Cofiguratio Table 4: Sample Rules Table 5: Sychroizer Rule Sytax Table 6: Ratioal Suite Sample Projects Table 7: RequisitePro Out-of-the-Box Project Table 8: Valid Product Subtool Combiatios vii

8 viii Cofigurig Ratioal Suite

9 CONFIGURING RATIONAL SUITE Preface This maual describes how to set up Ratioal Suite for use by a developmet team. Ratioal Suite delivers a comprehesive set of itegrated tools that embody software egieerig best practices ad spa the etire software developmet life cycle. Ratioal Suite s uparalleled level of itegratio improves commuicatio both withi teams ad across team boudaries, reducig developmet time ad improvig software quality. Audiece This guide is iteded for Ratioal Suite admiistrators. Other Resources Olie Help is available for Ratioal Suite. From a Suite tool, select a optio from the Help meu. All mauals are available olie, either i HTML or PDF format. The olie mauals are o the Ratioal Solutios for Widows Olie Documetatio CD. If you istall Ratioal Suite DevelopmetStudio RealTime Editio, PDF versios of the mauals for Rose RealTime are istalled i %ROSERT_HOME%\help. All other mauals are available o the Ratioal Solutios for Widows Olie Documetatio CD. For more iformatio o traiig opportuities, see the Ratioal Uiversity Web site: 9

10 Ratioal Suite Documetatio Roadmap 10 Cofigurig Ratioal Suite

11 Cotactig Ratioal Techical Publicatios To sed feedback about documetatio for Ratioal products, please sed to our techical publicatios departmet at Cotactig Ratioal Techical Support If you have questios about istallig, usig, or maitaiig this product, cotact Ratioal Techical Support as follows: Ratioal Techical Support Iformatio Locatio Cotact Iformatio Notes U.S. ad Caada Europe +31 (0) Whe sedig Specify the product ame i the subject lie, for example, Ratioal Suite. For existig issues, iclude your case ID i the subject lie. Asia Pacific support@apac.ratioal.com Preface 11

12 12 Cofigurig Ratioal Suite

13 CONFIGURING RATIONAL SUITE Welcome to Ratioal Suite Ratioal Suite is a itegrated set of software developmet products. It combies best-i-class tools with the idustry s best practices ecapsulated by the Ratioal Uified Process. This book shows you how to cofigure Ratioal Suite, icludig how to set up databases for Ratioal Suite products, how to use ad customize the Sychroizer ad Exteded Help, ad how to use predefied projects to get started quickly. Additioal iformatio for each Ratioal Suite product is located i each product s olie Help ad i prited documetatio. See also Tool Metors o page 57, which describes features to help you use the Ratioal Uified Process with Ratioal Suite. Ratioal Suite Editios Ratioal Suite is available i these editios, tailored for each member of your team: Ratioal Suite AalystStudio optimized for the aalyst Ratioal Suite DevelopmetStudio optimized for the developer Ratioal Suite DevelopmetStudio RealTime Editio optimized for the developer of real-time, embedded systems. Ratioal Suite TestStudio optimized for the quality egieer Ratioal Suite PerformaceStudio optimized for the performace test egieer Ratioal Suite Eterprise complete set of software developmet tools 13

14 The followig table lists the products i each Ratioal Suite editio. Table 1: Ratioal Suite Tools Ratioal Tool Aalyst Studio Developmet Studio (Widows/Uix) Developmet Studio - RealTime Editio Test Studio Performace Studio Eterprise Ratioal Uified Process X X X X X X RequisitePro X X X X X X ClearQuest X X X X X X SoDA X X X X X X Rose Modeler Editio Eterprise Editio RealTime Editio Eterprise Editio Eterprise Editio Robot X X X TestFactory X X X PureCoverage X X X X X Purify X X X X X Quatify X X X X X LoadTest Performace Architect X X 14 Cofigurig Ratioal Suite

15 CONFIGURING RATIONAL SUITE Ratioal Suite Admiistratio This chapter provides a overview of the tasks typically performed by a Ratioal Suite admiistrator. Istallig Ratioal Suite Software The Ratioal Software Setup program istalls Ratioal Suite ad other Ratioal Software products, usig a cosistet ad familiar istallatio wizard. You ca fid additioal details about Ratioal Software istallatio i Istallig Ratioal Suite, icluded with your Ratioal Suite media kit. See the Ratioal Widows Setup olie Help for assistace while usig the program. Licesig Ratioal Suite Ratioal Suite uses FLEXlm licesig services from GLOBEtrotter, Ic. For more iformatio about licesig, please refer to oe of the followig sources: Admiisterig Liceses for Ratioal Suite, icluded with your Ratioal Suite media kit. Olie Help for the Ratioal Licese Key Admiistrator. This provides step-by-step istructios for istallig startup licese keys ad requestig permaet cliet ad server licese keys. Before You Pla Before you set up your data stores ad repositories, you should pla. Before you ca pla, though, you eed to uderstad logical relatioships amog the databases used by Ratioal Suite products, as show i the followig figure. 15

16 Ratioal Suite Database Relatioships Some otes cocerig the figure: The arrows betwee the Master database ad the two user databases idicate logical coectios; iformatio i the user databases are subsets of iformatio i the Master database. The arrow betwee the Master database ad the ClearQuest user database idicates access to the user databases through the Master database. The arrow betwee the two RequisitePro databases idicate that both databases are actually the same database. The arrow betwee the two model files idicate that both files are actually the same file. 16 Cofigurig Ratioal Suite

17 Developig a Database Pla As a admiistrator, you eed to decide which database maagemet system(s) (DBMS) to use with Ratioal Suite products. Creatig a Ratioal Repository o page 19 provides more iformatio about plaig for ad istallig databases. Istallig Ratioal Suite, icluded with your Ratioal Suite media kit, describes the istallatio, cofiguratio, ad admiistratio of differet database maagemet systems, particularly for use with ClearQuest. Creatig ad Maagig a Ratioal Repository Writig Sychroizer Rules A Ratioal repository is a logical collectio of data stores that associates the data you use o a Ratioal Suite project. Oce you create a repository, you ca take advatage of itegratios amog Ratioal Suite tools. Creatig a Ratioal Repository o page 19 provides more iformatio about creatig ad cofigurig a repository. The Usig Ratioal Admiistrator maual, icluded with your Ratioal Suite media kit, describes how to maage a repository. The Ratioal Sychroizer helps maitai project cosistecy, resultig i improved team commuicatio. The Sychroizer works by creatig ad updatig a project s related items based o the existece of other items i your project. As a admiistrator, you may be resposible for aalyzig your team s developmet process ad usig the results of the aalysis to develop Sychroizer rules. For more iformatio about this process, please see Ratioal Sychroizer o page 39. Ratioal Suite Admiistratio 17

18 Customizig Exteded Help Exteded Help provides a coectio betwee Ratioal Suite tools ad the Ratioal Uified Process. You ca augmet Exteded Help with your ow team s process descriptios. For more iformatio about customizig Exteded Help, please see Ratioal Suite Out-of-the-Box Tools o page Cofigurig Ratioal Suite

19 CONFIGURING RATIONAL SUITE Creatig a Ratioal Repository This chapter describes how to create a Ratioal repository for use with Ratioal Suite. What is a Ratioal Repository? A Ratioal repository is a logical collectio of data stores that associates the data you use o a Ratioal Suite project. A Ratioal repository cosists of: Oe Ratioal Test database Zero or oe ClearQuest databases Oe or more projects cotaiig: Oe Ratioal Suite Sychroizer rules file Oe RequisitePro database Zero, oe, or more Rose model files Oce you create a Ratioal repository, you ca take advatage of product itegratios. For example, a repository allows you to: Use Test Maager to view test requiremets stored i RequisitePro. From Ratioal LogViewer, geerate a defect i ClearQuest. Work with the Ratioal Sychroizer to create or update project data based o the existece of other data. The amout of itegratio you ca achieve ofte depeds o the ClearQuest database schema you use; see the book, Admiisterig Ratioal ClearQuest for more iformatio. Plaig the Repository Before you create a repository, you eed to do some iitial plaig, as described i the remaider of this sectio. 19

20 Which Ratioal Tools Will the Team Use? Your team may wat to use all the products i Ratioal Suite or just a subset of the products. Determie which Suite products your group plas to use. Which Commercial Databases Will You Use? For each Suite product you are usig, decide which commercial database to use. You ca use differet databases for differet Suite products. The followig table summarizes the choices based o the size of the user group plaed for each product; please refer to product documetatio for more details about each choice. Table 2: Commercial Database Choices ClearQuest RequisitePro Ratioal Test Microsoft Access Small groups Small or medium groups Small groups SYBASE SQL Aywhere Server Medium or large groups N/A Medium or large groups Microsoft SQL Server Large groups Large groups N/A Oracle Large groups Large groups N/A Database performace depeds o factors such as: umber of users, etwork respose time, umber of records i the database, ad database tuig. Microsoft Access Rutime is automatically istalled whe you istall at least oe Ratioal Suite product o your machie. (The Access developmet eviromet is ot istalled.) Also, Sybase SQL Aywhere is available o the product CD, but it is cofigured to work oly with Ratioal products. 20 Cofigurig Ratioal Suite

21 Will You Use Existig Ratioal Data? Does your project iclude existig data created with earlier versios of Ratioal Software? If so, collect iformatio about which data you wat to use ad where it s located. For example, if you ve used earlier versios of Ratioal tools, you might wat to cotiue usig the followig types of data: ClearQuest chage requests or schema repositories SQA Maager defects RequisitePro or SQA Maager requiremets Rose models We recommed that you upgrade existig data before you start productio work o your project; see Upgradig Existig Data o page 22. Usig the Ratioal Admiistrator To create or maage a Ratioal repository, you use the Ratioal Admiistrator. To start the Admiistrator, click the Start butto, the click Programs > Ratioal Suite > Ratioal Admiistrator. The Ratioal Admiistrator Creatig a Ratioal Repository 21

22 Settig Up the Repository This chapter does ot provide complete iformatio about the Admiistrator. For more iformatio, refer to the Admiistrator s olie Help or to the book, Usig the Ratioal Admiistrator. This sectio describes, at a high level, how to set up a Ratioal repository. As you set up a repository, if you eed more details, please see the documetatio for your commercial database, for a idividual Suite product, or for the Ratioal Admiistrator. High-Level Steps for Settig Up a Ratioal Repository To set up a Ratioal repository, perform the followig steps, which are described i the remaider of this sectio: 1 Upgrade ay existig data. 2 Istall ad cofigure databases. 3 Decide where to locate the repository. 4 Create the repository. 5 Add oe or more projects. 6 Add users, groups, ad computers. 7 Attach existig Rose models. 8 Place data uder cofiguratio cotrol. Upgradig Existig Data If you wat your group s repository to use data you ve created with earlier versios of Ratioal tools, the you first eed to upgrade the existig data. You may also eed to upgrade the commercial database you are usig. Geeral steps are as follows: 22 Cofigurig Ratioal Suite

23 1 Back up existig data. Make sure that you keep a safe copy of your data so that you ca revert to it if you ru ito problems durig the upgrade. 2 If ecessary, upgrade the databases used for your data. Depedig o the database you have decided to use, there may be a ewer versio available. For your coveiece, we recommed that you upgrade your database before you create the repository. The remaider of this sectio describes steps to take for specific products. Upgradig ClearQuest Data To cotiue usig data created i a earlier versio of ClearQuest, upgrade by usig the ClearQuest Maiteace tool. This tool: Upgrades the schema repository. Upgrades the user database. Optioally moves the schema repository to a ew database. To start the ClearQuest Maiteace tool, click the Start butto, the click Programs > Ratioal Suite > Ratioal ClearQuest > Ratioal ClearQuest Maiteace Tool. Refer to Istallig Ratioal Suite for additioal ClearQuest upgrade ad cofiguratio iformatio. Upgradig RequisitePro Data To cotiue usig data created i a earlier versio of RequisitePro, upgrade by usig the RequisitePro upgrade wizard. The wizard: Works with existig databases from RequisitePro 2.x ad later. Makes a backup copy of the origial database. Upgrades i place, overwritig the existig database (but ot the backup copy). The wizard starts whe you ope a RequisitePro project that cotais data created with a older versio of RequisitePro. Creatig a Ratioal Repository 23

24 Upgradig Ratioal Test Data SQA Suite 6.x preceded Ratioal Test. To cotiue usig data created i SQA 6.x, esure that: SQA Suite 6.x is istalled o the machie where you are creatig the repository. The SQA Suite repository is accessible from the machie where you are creatig the repository. Whe you create the repository, the Admiistrator coverts the SQA 6.x data to its ew format. After you create the repository, you ca remove SQA Suite 6.x from the system cotaiig the repository. For more iformatio, pleased see Upgradig a SQA 6.x Repository i Usig the Ratioal Admiistrator. Upgradig Rose Data To cotiue usig data created i Rose 3.x, use the curret versio of Rose to ope the model. Rose coverts the model. Make sure that you save the model before closig Rose. Istallig ad Cofigurig Databases I the plaig phase, you chose the commercial databases to work with (see Table 2 o page 20). It is ow time to istall ad set up those databases, followig these guidelies: This step is madatory if you are usig Sybase SQLAywhere, Microsoft SQL Server, or Oracle. Istall the database, the perform ay set-up activities (such as settig privileges ad tuig the database) appropriate for that database. For more iformatio, refer to the documetatio for the database ad to documetatio for the product with which you will use the database. If you are usig Microsoft Access o a server, istall it o the server before creatig the repository. Alterately, istallig Ratioal Suite o ay machie automatically istalls Access Rutime. For Access, you do ot have to perform database set-up activities before you create the repository. 24 Cofigurig Ratioal Suite

25 Decidig Where to Locate the Repository Determie where the repository will reside, followig these guidelies: The Test database must reside i the repository directory structure. The disk that will cotai the repository must have eough space to cotai at least the Test database. The repository cotais poiters to the other tools databases. Therefore, these databases ca reside aywhere o your etwork system. Before proceedig, create the top-level directory of the repository. Make sure the directory is empty ad make it a shared directory. If you do ot share the directory, the repository will ot be available to members of your team. Creatig the Repository To create the repository: 1 Esure that you have Widows NT Admiistrator privileges. 2 Start the Ratioal Admiistrator: click the Start butto, the click Programs > Ratioal Suite > Ratioal Admiistrator. 3 From the Admiistrator meu, click File > Create Repository. 4 I the Create Repository Path dialog box, eter the ame of the top-level directory that you created i Decidig Where to Locate the Repository o page 25. Click Next. 5 Cofigure the repository by specifyig: The database you pla to use for Ratioal Test Whether to create a ew Ratioal Test database or whether to use existig data Whether to use ClearQuest, ad if so, whether to create a ew ClearQuest database or attach to a existig oe. Creatig a Ratioal Repository 25

26 Addig Oe or More Projects Whe you create a repository, the Ratioal Admiistrator creates a default project (amed Default Project) cotaiig: A referece to a empty RequisitePro database A referece to a Sychroizer rules file. (The rules file does ot actually get created util you ru the Sychroizer, import rules, ad save the rules file.) We recommed that you use a project with a more meaigful ame. To create a ew project: 1 From the Admiistrator meu, click Isert > Project. 2 Follow the prompts. You are asked to: Supply the project ame. Idicate whether to create a ew RequisitePro database or use a existig oe. Choose the Rose model or models to iclude. You ca attach Rose models later. 3 Optioally, delete Default Project. (A repository requires the existece of at least oe project.) Addig Users, Groups, ad Computers Cofigure Ratioal Test, ClearQuest, ad RequisitePro as described i the followig sectios. Ratioal Test Use the Ratioal Admiistrator to add users, groups, ad computers to the Ratioal Test database. If you iitialized the Test database with data from a existig Test or SQA repository, the users, groups, ad computers defied i the existig data appear i the ew repository. ClearQuest If you are usig ClearQuest, use the ClearQuest Desiger to set up user ad group access to the ClearQuest database. Refer to the ClearQuest Desiger olie Help for more iformatio. 26 Cofigurig Ratioal Suite

27 RequisitePro If you are usig RequisitePro, you ca use project security for the RequisitePro database. Refer to the RequisitePro olie Help for more iformatio. Attachig Existig Rose Models You ca attach Rose models to a project after you create the project. This feature allows you to create models after you create the repository. 1 From the Ratioal Admiistrator, right-click o a project. 2 O the shortcut meu, click Attach Rose Model. 3 Use the File Browse dialog box to select the model to use. You caot share a Rose model amog more tha oe project. You ca attach up to seve Rose models to a repository project. Placig Data uder Cofiguratio Cotrol We recommed that you use a cofiguratio cotrol program such as ClearCase to maage the repository ad the databases associated with the repository. Usig Ratioal Suite without a Repository We recommed that you use a repository to work with Ratioal Suite. It is possible to use some editios of Ratioal Suite, specifically those editios that do ot use Ratioal Test, without a repository. Ratioal Test requires a repository. To use Ratioal Suite AalystStudio or Ratioal Suite DevelopmetStudio without a repository: 1 Set up ClearQuest, RequisitePro, ad Rose models as if you were usig them i stad-aloe mode. 2 Use Ratioal Sychroizer without a repository, as detailed i the chapter o the Sychroizer. Creatig a Ratioal Repository 27

28 28 Cofigurig Ratioal Suite

29 CONFIGURING RATIONAL SUITE Cofigurig the Itegratio for ClearQuest ad RequisitePro The itegratio betwee ClearQuest ad RequisitePro allows you to associate qualified ehacemet requests or defects with related requiremets. After you collect stakeholder feedback as ehacemet requests or defects, you validate, or qualify, the requests you wish to implemet. The use the itegratio to establish associatios betwee the origiatig ehacemet request or defect ad related requiremets. Usig the itegratio provides a seamless combiatio of ClearQuest ad RequisitePro. Workig i ClearQuest, you ca associate or create ew requiremets from ehacemet requests or defects. Workig i RequisitePro, you ca view the origial ehacemet requests or defects o which the requiremet is based, as well as establish ew associatios. The itegratio allows you to track stakeholder iput durig the requiremets phase. This esures that all qualified stakeholder iput is addressed. Overview: Settig Up the Itegratio This sectio provides a summary of the steps for cofigurig Ratioal ClearQuest ad RequisitePro to eable data associatio betwee the two software products. Note: This guide assumes that you istalled Ratioal software o the C drive. Substitute your actual istallatio drive ame, as eeded. Table 3, ClearQuest RequisitePro Cofiguratio, summarizes the steps for settig up the ClearQuest ad RequisitePro itegratio. The remaider of this chapter describes these steps i detail. 29

30 Table 3: ClearQuest RequisitePro Cofiguratio Actio Create a Ratioal repository Cofigure the ClearQuest database Cofigure the RequisitePro project or projects Edit ad ru the setup file Upgrade the Associatios Commet This repository must cotai the ClearQuest database ad the RequisitePro project which will be itegrated. New packages have bee developed to support data associatio with RequisitePro. New attributes are added which are the shared resource betwee ClearQuest ad RequisitePro. This file cotais a descriptio of your Ratioal eviromet, icludig file locatios ad ames. Upgrade the Repository, ClearQuest, ad RequisitePro for logo iformatio. Creatig a Ratioal Repository The ClearQuest database ad the RequisitePro projects must be part of the same Ratioal repository before the itegratio is active. For more iformatio o settig up a Ratioal repository, see Chapter 3, Creatig a Ratioal Repository, o page 19. Cofigurig the ClearQuest Schema Repository Databases Each ClearQuest user database cotaiig related data is associated with a schema repository database (also called a master database). Both databases must be cofigured to access the packages specific to the itegratio betwee ClearQuest ad RequisitePro. If you are creatig ew ClearQuest databases to be used for your developmet project, Ratioal provides several out-of-the-box (OOTB) schemas that cotai all ecessary packages to make the itegratio available. Those schemas are amed AalystStudio, TestStudio, DevelopmetStudio, ad Eterprise schemas. Use ay of these schemas to create your ew schema ad the ClearQuest schema database cofiguratio is complete. For more iformatio o usig the out-of-the-box compoets, see Chapter 6, Ratioal Suite Out-of-the-Box Tools, o page Cofigurig Ratioal Suite

31 If you have used the itegratio i a earlier Suite versio, you eed oly to upgrade your ClearQuest databases to iclude additioal packages. Upgradig the ClearQuest Schema Repository Database To upgrade your existig AalystStudio schema database, begi by cosultig the sectio o upgradig the database i the guide, Admiisterig Ratioal ClearQuest. This documet provides detailed recommedatios about upgradig your schema database. Note: Before upgradig, we strogly recommed that you back up the followig data: ClearQuest Schema Repository database ClearQuest User database The etire tree of directories ad files belogig to the Ratioal Repository To upgrade the ClearQuest schema repository database: 1 Use the ClearQuest Desiger to log o to your schema repository database with a admiistrator profile. The Ope Schema widow appears. Click Cacel. 2 From the ClearQuest Desiger meu, click Package > Package Wizard. The Package Wizard widow appears. 3 I the Select a Package list, idetify the latest versio of the RequisitePro package (the package with the highest versio umber). 4 Click More Packages. If there is a RequisitePro package with a higher versio umber tha the oe you idetified i step 3, select it. Click OK to retur to the Select a Package list. 5 Select the latest versio of the RequisitePro package. Click OK. 6 I the Package Wizard, click Next. Select the AalystStudio schema. Click Next agai. 7 Place a check mark i all record types that you will use i the itegratio. We recommed that you select at least Defect ad EhacemetRequest. Click Fiish. Cofigurig the Itegratio for ClearQuest ad RequisitePro 31

32 8 From the ClearQuest meu, select File > Checki to check this ew package ito your schema. Click OK after verifyig your choice. Click OK agai i the ClearQuest checki cofirmatio dialog box. 9 Repeat this procedure to add the latest versio of the RequisitePro Supplemet package. Upgradig the ClearQuest User Database To upgrade the ClearQuest user database: 1 Back up your database before upgradig it. 2 From the ClearQuest meu, select Database > Upgrade Database ad click Yes to cotiue. 3 I the Upgrade Database widow, select the database istace that is icluded i your Ratioal repository ad that has a previous AalystStudio schema. Click Next. 4 Select the latest versio of the schema (the schema with the highest versio umber). Click Fiish. 5 Click OK ad close the ClearQuest Desiger. Your ClearQuest databases are ow cofigured to use the ClearQuest RequisitePro itegratio. Cofigurig the RequisitePro Repository Project Each RequisitePro project cotaied i a Ratioal repository must be cofigured to share data with ClearQuest s ehacemet request ad defect records. To eable this data sharig, you eed to add two ew attributes to the project or projects. These attributes display the ClearQuest record ID associated with the requiremet i the RequisitePro database view. You ca create ew associatios from the requiremet to a related defect or ehacemet request. 32 Cofigurig Ratioal Suite

33 If you are creatig a ew RequisitePro project, Ratioal provides a out-of-the-box (OOTB) RequisitePro Project Template that cotais the ecessary attributes to make the itegratio available. Use this template to create your ew project ad the RequisitePro project itegratio cofiguratio is complete. For more iformatio o usig the out-of-the-box compoets, see Chapter 6, Ratioal Suite Out-of-the-Box Tools, o page 55. Upgradig the RequisitePro Repository Project To upgrade the RequisitePro project: 1 Back up your RequisitePro project before begiig the upgrade. 2 Lauch RequisitePro ad ope the related Ratioal repository project. 3 From the RequisitePro Tool Palette click Project > Properties. 4 O the Attributes tab, from the Requiremet Type list, select the FEAT requiremet type. Click Add. Note: If you are ot usig the OOTB RequisitePro project, you may eed to create a FEAT (feature) requiremet type. For istructios o completig this task, see the RequisitePro olie Help. Alterately, see Updatig the ASCQISetup.bat file o page 35 to lear about settig up customized requiremet types. 5 I the Add Attribute widow: I the Label field, eter EhacemetRequest. From the Type list, select ClearQuest itegratio. Click OK. 6 O the Project Properties widow, click Add to retur to the Add Attribute widow. 7 I the Add Attribute widow: I the Label field, eter Defect. From the Type list, select ClearQuest itegratio. Click OK. 8 Save ad close the RequisitePro project. Cofigurig the Itegratio for ClearQuest ad RequisitePro 33

34 Collectig Setup Iformatio These two ew attributes i RequisitePro ca ow be populated with ClearQuest record IDs whe a requiremet is associated with a defect or a ehacemet request. This makes it possible to track the origi of the associated requiremet as well as the realizatio of the ehacemet request or the resolutio of the defect. Cotiue cofigurig the itegratio by ruig a batch file cotaiig commads that use the followig variables. Use this form to record your project s values. You will use this iformatio to update the batch file. Batch Commad Descriptio Your Values set CQDatabaseName = set H = set U = set P = set RP = set RQS = The ame of your ClearQuest User database The hard drive letter where RequisitePro is istalled, followed by a colo (for example C:) The logo ame for the ClearQuest database, the RequisitePro project, ad the Ratioal Repository The path to your local Ratioal istallatio directory The ame of the RequisitePro project The full path to the RequisitePro *.rqs file set Help= The full path to the ClearQuest - RequisitePro Itegratio help file (Program Files\Ratioal\ RequisitePro\ Help\CQI.hlp) 34 Cofigurig Ratioal Suite

35 Updatig the ASCQISetup.bat file Now use the iformatio i the precedig table to complete the ASCQISetup.bat file. The file is i the directory Program Files\Ratioal\Commo. Begi by copyig the ASCIQSetup.bat file to a ew file such as MySetup.bat to preserve the origial file. To edit the batch file, locate it i Widows Explorer, right-click the file, ad select Edit from the cotext meu. A text editor opes the file. Locate each set commad ad edit it to cotai the iformatio i the precedig table. The followig example of a completed MySetup.bat has bee edited to work with the itegratio for the Classics Olie project, used throughout Gettig Started with Ratioal Suite AalystStudio. All edited or updated fields are i bold. The REM commad precedes a commet. Note: Text i this fot is commetary ad is ot part of the batch file, itself. REM Before you lauch this batch file, please update the followig iformatio: REM **** INFORMATION TO UPDATE **** REM Update the ame of the ClearQuest database set CQDatabaseName=CLSIC REM Update the hard drive letter where your local Ratioal products are istalled set H=C: REM Update the SuperUser logi ame for ClearQuest database, RequisitePro ad Ratioal Repository set U=admi REM Update the path to your local Ratioal istallatio directory set P=\Program Files\Ratioal\ REM Update the ame of your RequisitePro project set RP= Order Processig ad Fulfillmet System Cofigurig the Itegratio for ClearQuest ad RequisitePro 35

36 REM Update the full ame to your RequisitePro.rqs file. REM It should be a UNC path if you wat to access your project from differet machies set RQS=C:\Program Files\Ratioal\Classics Demo\ClassicsRepo\Project\ ClassicsPOS\requisite\requisite.rqs REM Update the path to the cqi.hlp file REM It should be a UNC path if it is o a differet machie. set Help=C:\Program Files\Ratioal\RequisitePro\help\cqi.hlp REM **** BEGINNING OF THE SCRIPT **** %H% cd %P%\commo If you are eablig multiple RequisitePro projects for the itegratio, copy the lie cotaiig set RP= XXXX to here. Update this commad with the ame of the RequisitePro project. Add oe set RP = lie here for each RequisitePro project that you wat to itegrate with ClearQuest. Also copy the lie cotaiig set RQS = XXXX to here ad update it to reflect the full path to your RequisitePro *.RQS file. Add oe set RQS = lie for each RequisitePro project that you wat to itegrate with ClearQuest. Use a UNC pathame for projects that are located o other machies o your etwork. REM Creatio of the associatio betwee the Defect ClearQuest record type ad the RequisitePro attribute Defect of the Feature requiremet type ASCQISetup.exe -c %U% %CQDatabaseName% Defect Requiremets_List Defects_list RepoProject Modify "Associate Defects" "%Help%" 2 "%RP%" "%RQS%" FEAT Defect 3 REM Creatio of the associatio betwee the EhacemetRequest ClearQuest record type ad the attribute EhacemetRequest of the Feature requiremet type ASCQISetup.exe -c %U% %CQDatabaseName% EhacemetRequest Requiremets_List EhacemetRequests_list RepoProject Modify "Associate Ehacemet Requests" "%Help%" 2 "%RP%" "%RQS%" FEAT EhacemetRequest 3 36 Cofigurig Ratioal Suite

37 If you have used RequisitePro requiremet types ad attributes ames other tha the oes show i the above commads, copy the etire ASCQISetup.exe commad ad paste it here. Update the requiremet type ad the attribute ame. Replace FEAT with your requiremet type, ad Defect or EhacemetRequest with your customized attribute. Copy ad update this commad here for each requiremet type ad attribute ame to iclude i the itegratio. pause The batch file eds with a pause statemet. Ruig the Batch File Upgradig the Associatios Ru your MySetup.bat file to create the idicated records ad to supply the iformatio specific to your developmet eviromet. As the batch file rus, it pauses after each creatio of a setup record ad prompts you to Press ay key to cotiue... Press RETURN util the batch file eds. The fial step i cofigurig the ClearQuest RequisitePro itegratio is to upgrade the existig associatios, the oes created from a previous versio of the AalystStudio schema. 1 Select Start > Ru from the Widows task bar ad browse to Program Files\Ratioal\Commo\ASCQIUpgrade.exe. 2 Add the path to your Ratioal Repository project to the ed of this commad, eclosig the path i quotes. Click OK. (For example: Program Files\Ratioal\Commo\ASCQIUpgrade.exe C:\Program Files\Ratioal\Classics Demo\ClassicsRepo ). 3 You may be prompted by each Ratioal product ivolved i the itegratio (Ratioal Repository, ClearQuest ad RequisitePro) for logo iformatio. Log o with a admiistrator profile. Your ClearQuest RequisitePro itegratio has ow bee cofigured ad is ready for use i your developmet project. For more iformatio about usig the ClearQuest RequisitePro itegratio, refer to the documet Gettig Started with Ratioal Suite AalystStudio cotaied o your documetatio CD. Cofigurig the Itegratio for ClearQuest ad RequisitePro 37

38 38 Cofigurig Ratioal Suite

39 CONFIGURING RATIONAL SUITE Ratioal Sychroizer The Ratioal Sychroizer helps maitai project cosistecy, resultig i improved team commuicatio. The Sychroizer works by creatig ad updatig a project s related items based o the existece of other items i your project. For example, the Sychroizer might create a test requiremet based o the existece of a feature requiremet. Or it might create a test script based o the existece of a test requiremet. The Sychroizer works with the requiremets (Ratioal RequisitePro), modelig (Ratioal Rose), ad test (Ratioal Test) domais. Overview of Usig the Sychroizer Geerally, whe you start the Sychroizer, it displays the Fid Wizard. The Fid Wizard helps you arrow the scope of items to work with. Whe you fiish usig the Fid Wizard, the Sychroizer presets a list of items it proposes to create, update, or delete. You select oly those items that you wat to chage. The Sychroizer carries out the chages for the items you chose. The Sychroizer works by usig rules to determie which chages are eeded. Ratioal provides some sample rules to get you started. Your admiistrator or project leader aalyzes your developmet eviromet to decide which rules to use, ad whether to write ew rules or to edit existig oes. Example For example, say that you wat to esure that every test requiremet i RequisitePro has a correspodig test script i Ratioal Test. The Sychroizer ca eforce this costrait with a rule. Whe you ru the Sychroizer it fids all test requiremets for which there is o test script. Whe you istruct the Sychroizer to proceed, it creates ad iitializes the test script. 39

40 As a result, ew developmets i the requiremets domai are commuicated accurately ad promptly to the team resposible for testig. Creatig ad Updatig Items You ca use the Sychroizer to: Create items i oe domai that are related to items i aother domai or i the same domai. Whe the Sychroizer creates items, it uses the work of oe team to jump-start aother team s efforts. For example, the Sychroizer ca create test requiremets i RequisitePro that correspod to Rose iterfaces. As a result, the testig team is automatically otified of ew work they eed to reflect i test plaig. Copy the values of attributes betwee items, allowig chages i oe applicatio to be visible i aother. For example, the Sychroizer ca cause a ame chage i a Rose use case to trigger a correspodig chage to a related requiremet i RequisitePro. Copyig attribute values esures that chages i oe item are propagated to related items. This feature elimiates error-proe maual updatig. I this Chapter The remaider of this chapter discusses: Usig the Sychroizer (read this sectio if you pla to use the Sychroizer to create or update items) Admiistratio for the Sychroizer (read this sectio if you pla to set up a project to use the Sychroizer or if you pla to edit Sychroizer rules) Compariso with previous itegratios (read this sectio if you have used earlier versios of Ratioal software) 40 Cofigurig Ratioal Suite

41 Usig the Sychroizer You have the Ratioal Sychroizer if you have istalled ay editio of Ratioal Suite or ay of the followig tools: RequisitePro 4.0 or later Rose 98i, Rose 2000, or later Ratioal Test 7.1 or later Startig the Sychroizer As a user, start the Sychroizer by takig oe of the followig actios: From the RequisitePro or TestMaager meu, click Tools > Ratioal Sychroizer. From the Rose meu, click Tools > Sychroize. From the Widows Start meu, click Programs > Ratioal Suite > Ratioal Sychroizer. As a admiistrator, you ca also start the Sychroizer as follows: I the Ratioal Admiistrator, select a repository ad click Tools > Ratioal Sychroizer. Startup Cotext: What to Expect If you have istalled Ratioal Suite, your project admiistrator has probably used the Ratioal Admiistrator to defie a repository project for your team. A repository project associates the followig items: Oe Ratioal Test database Zero or oe ClearQuest databases Oe or more projects cotaiig: Oe Ratioal Suite Sychroizer rules file Oe RequisitePro database Zero, oe, or more Rose model files If your work is part of a repository project, i most cases whe you start the Sychroizer, the Fid Wizard immediately appears. Ratioal Sychroizer 41

42 I some cases, the Setup Cotext dialog box appears first, promptig you to idetify the repository project to use. Log i to the project, usig iformatio supplied by your project admiistrator. The Fid Wizard appears. If you are ot workig with a repository project, you caot permaetly idetify the set of rules to use whe sychroizig. Whe you start the Sychroizer, the Setup Cotext dialog box allows you either to use rules that are already defied or to create ew rules. Workig with the Sychroizer To use the Sychroizer, you first ru the Fid Wizard which helps you idetify the items to work with. The Sychroizer displays a list of items based o the selectios you make. Each of these items represets a actio to create or update part of your project. You review the list to uderstad the impact of the chages. You select the items you wat sychroized. The Sychroizer creates or updates, causig the selected items to become cosistet across your project. For more iformatio about workig with the Sychroizer, please see olie Help for the Sychroizer. Admiistratio for the Sychroizer If your team is usig Ratioal Suite, admiistratio tasks for the Ratioal Sychroizer cosist of the followig activities: Creatig a repository project for your team. (For a brief descriptio of a repository project, see page 41. For more detailed iformatio about workig with repository projects, see the maual Usig the Ratioal Admiistrator.) Importig rules for your project to use. Aalyzig your project s developmet process to determie which Sychroizer rules you eed. Editig existig rules or creatig ew rules. If your team is ot usig Ratioal Suite, a admiistrator may idetify which rules to use, but users eed to import those rules every time they start the Sychroizer. 42 Cofigurig Ratioal Suite

43 Importig Rules How Rules are Stored Sychroizer rules are text descriptios of Sychroizer actios. You ca store oe or more rules i a rule defiitio file, a text file with file type.rsd. The Sychroizer ships with sample rule defiitio files, located i: <Istall Path>\Commo\OutOfTheBox\sychroizer rules\. For your project, you will probably create ew rules which you may base o the sample rules. You ca edit a rule defiitio file with Notepad or aother text editor. For more iformatio, see Writig Sychroizer Rules o page 44. To use a rule i the Sychroizer, you first import it ito a Sychroizer Rules Project, a file with file type.rsr. Importig a rule coverts it (compiles it) ito the iteral represetatio used by the Sychroizer. The Sychroizer Rules Project stores rules i their iteral represetatio. If you edit a rule, you eed to re-import it to make your chages effective. Usig Ratioal Suite: Importig Rules If your team is workig with Ratioal Suite, we recommed that you start from the Ratioal Admiistrator to import rules for your etire project. A placeholder for a Sychroizer Rules Project (a cotaier for imported rules) is created automatically whe you create a ew project i the Ratioal Admiistrator. The file is actually created the first time you import rules ad save the file. The Rules Project is amed Ratioal Sychroizer Rules.rsr. It is created i the folder repository ame\project\curret project\, where repository ame is the Ratioal repository ad curret project is the project of iterest. To start the Sychroizer from Ratioal Admiistrator, click Tools > Sychroizer. For each project, the first time you start the Sychroizer from the Ratioal Admiistrator, the Sychroizer displays the followig prompt: There are o rules defied. Would you like to import rule defiitios? To import rules, select Yes. Ratioal Sychroizer 43

44 Workig without Ratioal Suite: Importig Rules If you do ot have a editio of Ratioal Suite istalled, you ca still use the Sychroizer betwee domais. You first create the Rules Project file, the import rules ito it. Whe you ext start the Sychroizer, use the Setup Cotext dialog box to ope the same Rules Project. I more detail: 1 Start the Sychroizer (from the Widows Start meu, click Programs > Ratioal Suite > Ratioal Sychroizer). The Ratioal Sychroizer Setup Cotext dialog box appears. 2 Select Sychroize without usig the Ratioal Repository, the select Create a Sychroizer Rules Project. Click OK. 3 I the Create Sychroizer Rules Project dialog box, specify a directory ad file ame for the Rules Project. Click Save. The Sychroizer appears. Also, a message appears askig whether you wat to import rule defiitios. If you click Yes, you are prompted to select the rules to import, ad the to save the rules project. Whe you ext start the Sychroizer, the Setup Cotext dialog box agai appears. To use the same Rules Project, select Sychroize without usig the Ratioal Repository, the Ope a existig Sychroizer Rules Project. The olie Help for the Sychroizer provides more details about workig with rules. Writig Sychroizer Rules This sectio describes how to desig ad write Sychroizer rules. Uderstadig Your Developmet Process Before you start to write rules, you eed to aalyze your developmet process to uderstad your group s eeds. The followig steps provide a overview of the aalysis: 44 Cofigurig Ratioal Suite

45 1 Write a arrative descriptio of how your group works with items such as requiremets, model elemets, ad test scripts. 2 From the descriptio, idetify the item types you work with ad the domai they come from. 3 Select oly those items that you wat to relate to other items. 4 For each pair of items you wat to relate, specify the actio to take: create or update. Also describe the properties you wat to sychroize, the directio of data flow, the timig of the sychroizatio, ad coditios uder which to sychroize. From this iformatio, you ca create tables that serve as specificatios for the rules you eed to write. A white paper, Usig the Ratioal Sychroizer, elaborates o these steps ad provides a example. This paper is available from your Ratioal techical represetative. What Ca You Specify i a Rule? You ca write rules to perform the followig actios: item creatio These actios create a item (for example, a RequisitePro requiremet or Rose use case) that correspods to aother item. data sychroizatio These actios trasfer iformatio betwee two correspodig items. You ca use data sychroizatio actios oly for two items that are already related. You ca write a rule that both creates a item ad causes data sychroizatio. You ca also write a rule that just creates a item. This sectio presets a aotated Sychroizer rule. This rule is part of the Sample rule set supplied with the Sychroizer, described i the ext sectio. For referece, we preset the rule first without aotatios: Ratioal Sychroizer 45

46 Sample Rule without Aotatios # File: tr_requiremet_to_test_script.rsd # Purpose: Sample rule to create a test script i a Ratioal Test domai # project that correspods to a test requiremet i a Ratioal # RequisitePro domai project. This rule associates the test # script with the requiremet whe viewed i the Ratioal # TestMaager. begi rule "Create Test Script from Test requiremet" descriptio { For each test requiremet i the RequisitePro domai that has the attribute AutoTest set to True, create a test script object i the Ratioal Test domai. } ed rule projects RequisitePro to TestStudio items "Test Requiremet Type" to Script properties source.text iit target.name source."test Notes" to target."descriptio" source.object iit target.requiremet applies whe AutoTest = "True" Sample Rule with Aotatios Note I the aotated rule, text i this fot is commetary ad is ot part of the rule, itself. # File: tr_requiremet_to_test_script.rsd # Purpose: Sample rule to create a test script i a Ratioal Test domai # project that correspods to a test requiremet i a Ratioal # RequisitePro domai project. This rule associates the test # script with the requiremet whe viewed i the Ratioal # TestMaager. You ca isert commets aywhere i the rule defiitio file. A commet exteds from a # character to the ed of the lie. 46 Cofigurig Ratioal Suite