IBM Rational SoDA Tutorial

Size: px

Start display at page:

Download "IBM Rational SoDA Tutorial"

Sophia Snow
5 years ago
Views:

1 IBM Rational SoDA Tutorial Rational SoDA Version Section 4.7 Creating a Template to Gather RequisitePro and TestManager Data

2 TABLE OF CONTENTS INTRODUCTION... 3 PRE-REQUISITE... 3 PC SETUP... 3 DIRECTORY REFERENCES... 3 CREATING A TEMPLATE TO GATHER INFORMATION FROM REQUISITEPRO AND TESTMANAGER... 4 PART 1 CREATE A TEMPLATE THAT WILL DISPLAY REQUISITEPRO USE CASE REQUIREMENTS... 4 PART 2 GENERATING A SODA REPORT FOR A NEW TEMPLATE PART 3 MODIFYING AN EXISTING TEMPLATE TO INCORPORATE ADDITIONAL INFORMATION CONCLUSION IBM Rational software ii

3 Introduction One of the most powerful components that Rational provides customers is the integration between its tools. In this exercise, you will create a template that will report information on one of these integrations. The integration between requirements and test cases helps developers and tester insure that they have created the right requirement and are testing to the same requirement. Pre-requisite Exercise 1.4 Verifying the TestManager/RequisitePro Integration has been completed. PC Setup A test directory structure outside the SoDA provided structure is recommended for creating and testing templates. This directory can exist anywhere as long as SoDA can access the files. This folder can reside in the SoDAWord\template directory; if it does then no additional set up is required. If this is not the location you ve selected, then set the User template path via SoDA >Options after creating the directory. Set up the following directory structure: Custom\TestManager Directory references The following directory references are used in this section of the tutorial: RationalDir refers to the installation path for Rational (DriveLetter:\Program Files\Rational is the default path). InstallDir refers to the installation path for Rational SoDA (DriveLetter:\Program Files\Rational\SoDAWord is the default path). TestDir refers to the directory structure created in the PC Setup. Note The graphics used to illustrate the Microsoft Word user interface were captured using Microsoft Word Depending on the version of Word you use, these dialog boxes may look different. IBM Rational software Page 3 of 48 Exercise RequisitePro

4 Creating a Template to gather information from RequisitePro and TestManager The customer has called in with the following problem: They have Test cases in TestManager that are associated with requirements in RequisitePro. They cannot figure out how to go from the RequisitePro requirement to the TestManager Test Case. Can this be done? With TestManager the integration to RequisitePro is a one-way street from TestManager to RequisitePro. Due to this limitation, the way the template needs to be set up is different than if the customer wanted to go from TestManager to RequisitePro. To create this template additional information must be obtained prior to the creation of the template. You must know the RequisitePro project name as well as the TestManager project This exercise will have you create a template to resolve this customer s problem. Part 1 Create a Template that will display RequisitePro Use Case Requirements In this exercise, you ll create a template that will display Rational RequisitePro requirement information. IBM Rational software Page 4 of 48 Exercise RequisitePro

4.7.1.1 Start a new Microsoft Word (MS Word) document.

5 Start a new Microsoft Word (MS Word) document. From the desktop, click Start > New Office Document. IBM Rational software Page 5 of 48 Exercise RequisitePro

4.7.1.2 Attach the SoDA.dot template to the new document.

will be used so that you can be comfortable with them. Click File > New. 4.7.1.

6 Attach the SoDA.dot template to the new document. Throughout out these exercise, different methods of creating a new template will be used so that you can be comfortable with them. Click File > New The New Office Document dialog displays. IBM Rational software Page 6 of 48 Exercise RequisitePro

4.7.1.4 Click soda.dot. Note If extensions are not visible, then click on soda. Click OK. 4.7.1.5 The Microsoft Word (MS Word) application window displays.

7 Click soda.dot. Note If extensions are not visible, then click on soda. Click OK The Microsoft Word (MS Word) application window displays. Note the SoDA option on the Microsoft Menu bar. IBM Rational software Page 7 of 48 Exercise RequisitePro

$Tip: It is always recommended, when working with SoDA templates to enable the formatting function (Show\Hide ) If you can t see the paragraph formatting mark at the top of the document, you must make$

8 Show formatting marks in the document. Tip: It is always recommended, when working with SoDA templates to enable the formatting function (Show\Hide ) If you can t see the paragraph formatting mark at the top of the document, you must make them visible. To view the paragraph marks ( ) in the document: If you re using Word 2000, on the toolbar, click Show\Hide ( ), or use <Ctrl>+<Shift>+<8>. If you re using Word 2002, click SoDA > Show\Hide Commands. If your using Word 2003, either method will work depending on what default setting you have used. MS Word 2003 can be set to have the look and feel of either 2002 or MS Word 2000 Show/Hide MS Word 2002 Show/Hide This type of template cannot be setup as generic, it will require an OPEN for both the RequisitePro project and the TestManager project. Click SoDA > Add Command. IBM Rational software Page 8 of 48 Exercise RequisitePro

4.7.1.8 Connect to the TestManager Domain. The Select Command To Add dialog displays. Click OPEN Command. 4.7.1.9 Click OK. 4.7.1.10 The OPEN Command dialog displays.

9 Connect to the TestManager Domain. The Select Command To Add dialog displays. Click OPEN Command Click OK The OPEN Command dialog displays. Expand the TestManager node (click ). IBM Rational software Page 9 of 48 Exercise RequisitePro

4.7.1.11 When no object has been selected in the left pane, the Arguments list is blank. The OPEN Command dialog refreshes with the TestManager node expanded. 4.7.1.12 Click Project.

10 When no object has been selected in the left pane, the Arguments list is blank. The OPEN Command dialog refreshes with the TestManager node expanded Click Project The OPEN Command dialog refreshes with the Arguments list populated. Click Browse. IBM Rational software Page 10 of 48 Exercise RequisitePro

$4.7.1.14 The Open dialog displays. Use the pull down selector and traverse to C:Classics\Projects\Webshop folder. 4.7.1.15 The Open dialog refreshes showing the contents of this folder.$

11 The Open dialog displays. Use the pull down selector and traverse to C:Classics\Projects\Webshop folder The Open dialog refreshes showing the contents of this folder. IBM Rational software Page 11 of 48 Exercise RequisitePro

4.7.1.16 Click Webshop.rsp. 4.7.1.17 The Open dialog displays showing the File name field defined. Click Open. 4.7.1.18 The OPEN Command dialog displays.

12 Click Webshop.rsp The Open dialog displays showing the File name field defined. Click Open The OPEN Command dialog displays. Click OK. IBM Rational software Page 12 of 48 Exercise RequisitePro

4.7.1.19 The TestManager Login dialog displays. 4.7.1.20 In the Username field, type admin.

13 The TestManager Login dialog displays In the Username field, type admin. Leave the Password field blank. Click OK. IBM Rational software Page 13 of 48 Exercise RequisitePro

4.7.1.21 With a successful login into TestManager, the MS Word application window displays with an OPEN comment visible in the body. 4.7.1.22 Add an OPEN command for the RequisitePro project.

14 With a successful login into TestManager, the MS Word application window displays with an OPEN comment visible in the body Add an OPEN command for the RequisitePro project. Click SoDA > Add Command. IBM Rational software Page 14 of 48 Exercise RequisitePro

15 The Add Command dialog displays. Click OPEN command. Click OK The Open Command dialog displays Expand the RequisitePro node (click ). IBM Rational software Page 15 of 48 Exercise RequisitePro

The OPEN Command dialog refreshes with the list of Arguments required

16 The OPEN Command dialog displays with the RequisitePro node expanded showing the classes that can be selected for this domain. Click Project Complete the OPEN argument list. The OPEN Command dialog refreshes with the list of Arguments required for the object selected in the left pane. Click Browse The Open dialog box displays. IBM Rational software Page 16 of 48 Exercise RequisitePro

$4.7.1.29 Use the pull down menu to traverse to the RequisitePro file (.rqs): c:\classics\projects\webshop\requisitepro Click ClassicsWebShop.RQS. 4.7.1.30 The Open dialog refreshes with the File Name field defined.$

17 Use the pull down menu to traverse to the RequisitePro file (.rqs): c:\classics\projects\webshop\requisitepro Click ClassicsWebShop.RQS The Open dialog refreshes with the File Name field defined. Click Open Security may be enabled on this project, if so, the RequisitePro Login dialog displays. In the User name field, type admin. Leave the Password field blank. Click OK. IBM Rational software Page 17 of 48 Exercise RequisitePro

4.7.1.32 After the RequisitePro Project Login dialog closes, the SoDA program attempts to make a connection to the RequisitePro environment accessing the specified RequisitePro project.

18 After the RequisitePro Project Login dialog closes, the SoDA program attempts to make a connection to the RequisitePro environment accessing the specified RequisitePro project. If a successful connection is made, then Microsoft Word window displays. If the following error displays, check the user name and password: Authentication failed Click OK. If a successful connection is not made then an error is displayed The RequisitePro Login redisplays with the original values populating the fields. The typical types of problems are: Incorrect spelling of either the Username or Password Wrong password for this user No password when there should be one A password was entered when none should be supplied Incorrect Capitalization on the password (passwords are case sensitive) Correct this issue before going on. Click OK. IBM Rational software Page 18 of 48 Exercise RequisitePro

4.7.1.34 The OPEN Command dialog box refreshes with the Argument list completed. Click OK. 4.7.1.35 The MS Word application window displays.

19 The OPEN Command dialog box refreshes with the Argument list completed. Click OK The MS Word application window displays. IBM Rational software Page 19 of 48 Exercise RequisitePro

20 Add a REPEAT command for the Use Case requirement type. Click SoDA > Add Command The Select Command To Add dialog displays. IBM Rational software Page 20 of 48 Exercise RequisitePro

4.7.1.38 Click REPEAT Command. Click OK. 4.7.1.39 The REPEAT Command dialog displays. 4.7.1.40 In order to limit the amount of data returned, a first level of filtering will be applied.

41 The Where Is A drop down selector displays. Click UCRequirement.

21 Click REPEAT Command. Click OK The REPEAT Command dialog displays In order to limit the amount of data returned, a first level of filtering will be applied. This is done through the Where Is A field. In the Where Is A field, click the down arrow The Where Is A drop down selector displays. Click UCRequirement. IBM Rational software Page 21 of 48 Exercise RequisitePro

4.7.1.42 The REPEAT Command dialog displays with the Where Is A field defined. Note The Name field also changed. Click OK. 4.7.1.43 The MS Word application window displays showing the REPEAT comments.

22 The REPEAT Command dialog displays with the Where Is A field defined. Note The Name field also changed. Click OK The MS Word application window displays showing the REPEAT comments. IBM Rational software Page 22 of 48 Exercise RequisitePro

4.7.1.44 Start the SoDA Template View. Click SoDA > Template View. 4.7.1.45 Listed below are the definitions of what the Letter in front of the value means: O Open Command D Display Command The Template View dialog displays.

23 Start the SoDA Template View. Click SoDA > Template View Listed below are the definitions of what the Letter in front of the value means: O Open Command D Display Command The Template View dialog displays. Depending on what object is highlighted in the left pane, the contents of the right pane may vary from what is shown in this graphic. Click R REPEAT in the left pane. R Repeat Command Additional values (will expand when selected) - Go back one level IBM Rational software Page 23 of 48 Exercise RequisitePro

24 Review the attributes, note that there is nothing that is remotely related to the TestManager environment. There are no DISPLAYs or REPEATs for Test. This is due to the way the integration works, RequisitePro does not know, nor care, that TestManager is integrated. The integration is established through Rational Administrator. The Template View dialog displays showing the attributes available for the UCRequirement type. Use the scroll bar to review what attributes are available Add DISPLAYs for the following use case requirement attributes: Full Tag Name Text Priority Status In the right pane, click D FullTag. IBM Rational software Page 24 of 48 Exercise RequisitePro

25 The Template View displays with the left pane updated with the new SoDA command. In the right pane, click D Name The Template View displays with the left pane updated with the new SoDA command. In the right pane, click D Text. IBM Rational software Page 25 of 48 Exercise RequisitePro

26 The Template View displays with the left pane updated with the new SoDA command. In the right pane, click D Priority The Template View displays with the left pane updated with the new SoDA command. In the right pane, click D Status. IBM Rational software Page 26 of 48 Exercise RequisitePro

27 The Template View displays with the left pane updated with the new SoDA command. Click to close the Template View The MS Word application window displays. If you are using MS Word 2002, turn off the SoDA Show/Hide Commands option, click SoDA > Show/Hide Commands. IBM Rational software Page 27 of 48 Exercise RequisitePro

4.7.1.54 Save the SoDA template. Click File > Save As. 4.7.1.55 The Save As dialog displays.

28 Save the SoDA template. Click File > Save As The Save As dialog displays. IBM Rational software Page 28 of 48 Exercise RequisitePro

4.7.1.56 Use the drop down menu and traverse to TestDir. You were instructed to create this directory prior to starting this tutorial.

29 Use the drop down menu and traverse to TestDir. You were instructed to create this directory prior to starting this tutorial. If you need further information, please see the PC Setup section at the beginning of the document Click on TestDir Name. IBM Rational software Page 29 of 48 Exercise RequisitePro

30 The TestDir displays showing the contents of this folder In the File name field, type UCRequirementsToTMTestCase.doc Click Save. IBM Rational software Page 30 of 48 Exercise RequisitePro

31 The MS Word application window displays Leave MS Word and this document open, you will generate the report in the next section. Do not close MS Word. Congratulations, you have successfully created the RequisitePro portion of the template. In the next part, you ll generate the report to validate the template. IBM Rational software Page 31 of 48 Exercise RequisitePro

32 Part 2 Generating a SoDA Report for a new Template In this exercise, you ll generate the template you created in the previous section If you closed MS Word, open MS Word and open the SoDA template created in the previous part. IBM Rational software Page 32 of 48 Exercise RequisitePro

33 Click SoDA > Generate Report. IBM Rational software Page 33 of 48 Exercise RequisitePro

4.7.2.3 The MS Word application window minimizes during the generation process and the SoDA Progress Indicator displays in the lower right corner of your screen.

34 The MS Word application window minimizes during the generation process and the SoDA Progress Indicator displays in the lower right corner of your screen. Note During the generation process, do not use the clipboard (i.e. copy/paste functions) for any other Office product as this could result in catastrophic corruption of both the report that is being generated and the template document Upon completion of the generation, MS Word application window displays showing the results from the generation process. Compare this data to the Rose RealTime model. After you have completed your review of the data, close the generated report (click ). IBM Rational software Page 34 of 48 Exercise RequisitePro

35 Leave MS Word open. The MS Word application window displays showing the SoDA Template. If you are using MSWord 2002, turn on the SoDA Show/Hide Commands option, click SoDA > Show/Hide Commands. Congratulations, you have successfully generated the template you created in part one. In the next part, you will add the SoDA commands to access the TestManager TestCases. IBM Rational software Page 35 of 48 Exercise RequisitePro

36 Part 3 Modifying an existing template to incorporate additional information In this exercise, you ll add the SoDA commands for the TestManager environment to the template you created in part two If you closed MS Word, open Word and open the SoDA template created in the previous part. If you are using MSWord 2002, turn on the SoDA Show/Hide Commands option, click SoDA > Show/Hide Commands. IBM Rational software Page 36 of 48 Exercise RequisitePro

37 Start the SoDA Template View. Click SoDA > Template View The Template View displays. If it is not already highlighted, click the last DISPLAY in the left pane. IBM Rational software Page 37 of 48 Exercise RequisitePro

38 Right click. The Template View short cut menu displays Click Add. IBM Rational software Page 38 of 48 Exercise RequisitePro

39 The short cut menu expands with a list of all the SoDA commands. Click REPEAT The REPEAT Command dialog displays. Minimize the UCRequirement node (click ) The REPEAT Command dialog displays with all nodes minimized. IBM Rational software Page 39 of 48 Exercise RequisitePro

40 Expand the TestManager_Project node (click ) The REPEAT Command refreshes showing the objects for TestManager_Project Use the scroll bar to locate TestPlans, click TestPlans. Click OK. IBM Rational software Page 40 of 48 Exercise RequisitePro

41 The Template View displays with the left pane updated with the new SoDA command. Click R TestCaseFolders The Template View displays with the left pane updated with the new SoDA command. Click R TestCases. IBM Rational software Page 41 of 48 Exercise RequisitePro

42 The Template View displays with the left pane updated with the new SoDA command. Click R TestCaseInputs The Template View displays with the left pane updated with the new SoDA command. Click on each DISPLAY available for the TestInputs. IBM Rational software Page 42 of 48 Exercise RequisitePro

4.7.3.16 The Template View displays with the left pane updated with the new SoDA commands.

43 The Template View displays with the left pane updated with the new SoDA commands. Close the Template View, click in the upper right corner of the Template View dialog The MS Word application window displays. IBM Rational software Page 43 of 48 Exercise RequisitePro

4.7.3.18 Generate the SoDA Report. Click File > Save As. Remember, if you are using MS Word 2002 toggle off the SoDA > Show/Hide Commands prior to saving the template. 4.7.3.19 The Save As dialog displays.

44 Generate the SoDA Report. Click File > Save As. Remember, if you are using MS Word 2002 toggle off the SoDA > Show/Hide Commands prior to saving the template The Save As dialog displays. Type a 1 after the name of the file, this will be the first revision to the template. Click Save. IBM Rational software Page 44 of 48 Exercise RequisitePro

4.7.3.20 Once the MS Word application window displays, click SoDA > Generate Report. 4.7.3.21 The MS Word application window minimizes and the SoDA Progress Indicator displays in the lower right corner of the desktop.

45 Once the MS Word application window displays, click SoDA > Generate Report The MS Word application window minimizes and the SoDA Progress Indicator displays in the lower right corner of the desktop. Note During the generation process, do not use the clipboard (i.e. copy/paste functions) for any other Office product as this could result in catastrophic corruption of both the report that is being generated and the template document. IBM Rational software Page 45 of 48 Exercise RequisitePro

4.7.3.22 Upon completion of the generation, MS Word application window displays showing the results from the generation process. Review the results. Use the Edit > Find function to locate TestInput.

46 Upon completion of the generation, MS Word application window displays showing the results from the generation process. Review the results. Use the Edit > Find function to locate TestInput. Does this search indicate any matches? If so, then something was not set up correctly in this template. In the next exercise, you will resolve this issue. After you have completed your review of the data, close the generated report (click ). IBM Rational software Page 46 of 48 Exercise RequisitePro

47 The MS Word application window displays showing the SoDA template. If you are using MSWord 2002, turn on the SoDA Show/Hide Commands option, click SoDA > Show/Hide Commands Do not close MS Word. Congratulations, you have successfully added SoDA commands to display TestManager information, unfortunately, no data was returned. In the next exercise, you will debug this template. IBM Rational software Page 47 of 48 Exercise RequisitePro

48 Conclusion Congratulations! You have successfully created a template that accesses the RequisitePro domain to display UCRequirement information. You attempted to access the TestManager data as well, but there is an issue with the template. Can you think of why this could be? In the next exercise, you will start learning debugging skills in order to resolve this problem. IBM Rational software Page 48 of 48 Exercise RequisitePro

IBM Rational SoDA Tutorial

IBM Rational SoDA Tutorial Rational SoDA Version 2003.06.00 Exercise 1.4 Verifying the TestManager/RequisitePro Integration TABLE OF CONTENTS INTRODUCTION... 3 PRE-REQUISITE... 3 PC SETUP... 3 DIRECTORY