IBM Rational SoDA Tutorial ®

IBM Rational® SoDA Tutorial
Rational® SoDA
Version 2003.06.00
Exercise 4.10 – Creating a SoDA Template for Rose UC and RequisitePro
UCRequirements
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
TABLE OF CONTENTS
INTRODUCTION........................................................................................................................................................................................................ 3
PRE-REQUISITE ........................................................................................................................................................................................................... 3
PC SETUP .................................................................................................................................................................................................................... 3
DIRECTORY REFERENCES ........................................................................................................................................................................................... 3
CREATING A SODA TEMPLATE TO DOCUMENT THE INTEGRATION BETWEEN ROSE AND REQUISITEPRO.......................... 4
PART 1 – MODIFY A SODA TEMPLATE TO DOCUMENT REQUISITEPRO REQUIREMENTS ........................................................................................... 4
PART 2 – ADDING ADDITIONAL COMMANDS TO THE TEMPLATE .............................................................................................................................. 58
PART 3 – MODIFYING A SODA COMMAND WITHIN A TABLE................................................................................................................................... 87
CONCLUSION .......................................................................................................................................................................................................... 97
IBM Rational software
ii
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Introduction
The ability to report on information from two separate tools that is related is one of the powerful features for SoDA. In this exercise, you will gather
ifnoramtion from Rational RequisitePro and Rational Rose.
Pre-requisites
Rational RequisitePro and Rational Rose have been installed on the same computer as SoDA.
The integration between Rose and RequisitePro must be set up. This exercise will not discuss how to set up the integration, nor will it cover how to create
link between a Rose Use Case and a RequisitePro requirement, see Exercise 1.3 – Setting up the Rose Use Case and RequisitePro UC Requirements
Integration for step by step instructions.
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\Rose
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 2000. Depending on the version of Word you
use, these dialog boxes may look different.
IBM Rational software
Page 3 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Creating a SoDA Template to document the integration between Rose and RequisitePro
Part 1 – Modify a SoDA Template to document RequisitePro Requirements
In this exercise, you’ll start from an existing Rose template and modify it to include RequisitePro UC Requirements.
IBM Rational software
Page 4 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.1
Start Microsoft Word and load the
out of the box template “use case
model survey.doc.”
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
From the desktop, click Start > Open Office
Document.
Page 5 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.2
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Open Office Document dialog displays.
Use the pull down menu to traverse to the
InstallDir. By default, the install directory is:
C:\\Program Files\Rational\SoDAWord.
4.10.1.3
In the InstallDir, click template.
In the template directory, click rose.
IBM Rational software
Page 6 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Use Case Steps
4.10.1.4
Details
Display
The rose directory displays showing the
contents of this folder.
Click “use case model survey.doc.”
Click Open.
4.10.1.5
Show formatting marks in the
document.
The Microsoft Word (MS Word) application
window displays showing the SoDA template.
Tip: It is always recommended,
If you can’t see the paragraph formatting
when working with SoDA templates marks, you must make them visible.
to enable the formatting function
To view the paragraph marks ( ¶ ) in the
(Show\Hide ¶).
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 2000.
IBM Rational software
Page 7 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.6
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Use the scroll bar to locate the heading “Use
Cases.”
Page 8 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.7
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click between [ENDMAST33] and
[ENDREP34].
If you have difficulty getting this exact
placement, use the arrow keys on your
keyboard.
Press Enter.
IBM Rational software
Page 9 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.8
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window displays
showing a paragraph return after the
[ENDMAST33].
The cursor is blinking at the beginning of the
line that starts with [ENDREP34].
IBM Rational software
Page 10 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.9
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Add the SoDA commands to display Click SoDA > Add Command.
the RequisitePro requirement and its
attributes.
4.10.1.10
IBM Rational software
The Select Command To Add dialog
displays.
Page 11 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.11
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click OPEN Command.
Click OK.
4.10.1.12
The OPEN Command dialog displays.
Expand the RequisitePro node (click ).
4.10.1.13
The OPEN Command displays showing the
contents of this node.
Click Project.
IBM Rational software
Page 12 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.14
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The OPEN Command dialog displays
showing the list of required arguments in the
Arguments pane.
Click Advanced.
4.10.1.15 Create a calculated OPEN to use the
stored value in Rose for the
RequisitePro Project.
The OPEN command dialog displays
showing the Kind field. The default value for
Kind is Literal.
Click Literal.
This is a toggle that switches between Literal
and Calculated.
4.10.1.16
The OPEN command dialog displays
showing the Kind field’s value as
“Calculated.”
Click the green area for the Value field.
IBM Rational software
Page 13 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.17
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The OPEN Command dialog displays
showing the short cut menu for the Value
field.
Expand UseCase (click
).
4.10.1.18
The OPEN Command dialog displays
showing the contents for the UseCase node.
4.10.1.19
Use the scroll bar to locate
RequisiteProProjectPath.
Click RequisiteProProjectPath.
IBM Rational software
Page 14 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.20
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The OPEN Command dialog displays
showing the Argument value defined.
Click OK.
4.10.1.21
IBM Rational software
The MS Word application window displays
showing the additional SoDA command.
Page 15 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.22 Add a SoDA command to display
the name of ….
Click SoDA > Add Command.
4.10.1.23
The Select Command To Add dialog
displays.
Keep the default selection of DISPLAY
Command.
Click OK.
IBM Rational software
Page 16 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.24
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The DISPLAY Command dialog displays.
Click Name (may already be highlighted).
Click OK.
4.10.1.25
IBM Rational software
The MS Word application window displays
showing the addition of this SoDA command.
Page 17 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.26
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In order to view the information, you may
want to place some white space around the
area you are inserting the SoDA commands.
If you are using MS Word 2002, turn off the
SoDA Show/Hide Commands option, click
SoDA > Show/Hide Commands.
IBM Rational software
Page 18 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.27 It is highly suggested when doing
calculated OPENs that you test the
environment to ensure correct
function. To test a template, run a
Generate Report.
4.10.1.28
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click File > Save As.
Note You cannot generate a report or
document until all modifications have been
saved.
The Save As dialog displays.
Page 19 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.29
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Use the pull down menu to traverse to the
TestDir directory.
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.
4.10.1.30
IBM Rational software
The Save As dialog displays showing the
contents of this folder.
Page 20 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.31
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In the File name field, type “RP” at the end of
the document name (before the .doc
extension).
Click Save.
4.10.1.32
IBM Rational software
The MS Word application window displays.
Page 21 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click SoDA > Generate Report.
4.10.1.33 For testing purposes, the Generate
Report option is the best, it
generates from the template, in a top
down mode. It always gathers
information directly from the
source(s). It does not do any
verification or validation. It
generates faster than the Generate
Document option.
4.10.1.34
The Identify Model dialog displays.
Click Browse.
IBM Rational software
Page 22 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.35
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Open dialog displays.
Use the pull down menu to traverse to the
C:\Classics\Projects\Webshop\Rose folder.
4.10.1.36
The Open dialog displays showing the
contents of this folder.
Click ClassicsCD_WinDNA.mdl.
Click Open.
4.10.1.37
The Identify Model dialog displays showing
the argument list defined.
Click OK.
IBM Rational software
Page 23 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.38 If security is enabled on
RequisitePro, a login screen will
require a valid user and password
for that project.
The RequisitePro Login dialog displays.
4.10.1.39
In the Username field, type “admin.”
Click OK.
4.10.1.40
The MS Word application window minimizes
during the generation process and the SoDA
Progress Indicator displays in the lower right
corner of your desktop.
Note During the generation process, do not use
the clipboard (i.e. copy/paste functions) for any
other Microsoft 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 24 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.41 If there are issues with either the
template or the data being retrieved,
an error report will be created.
The SoDA for WordXXXX (where XXXX is
the version of MS Word) displays.
4.10.1.42
The MS Word application window displays
showing the SoDA error report.
Click Yes.
Review the errors listed, in this instance, they
are all the same error:
Unable to evaluate OPEN command.
IBM Rational software
Page 25 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click on the hyperlink for any of the errors.
4.10.1.43 Debug tip: using the error report
can help determine where the
problem resides. When the
hyperlink goes to the template, the
problem is usually with the
template. If the hyperlink goes to the
generated report, then the problem is
usually related to the data and must
be fixed in the source tool.
IBM Rational software
Page 26 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.44
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window displays
showing the SoDA template, the cursor is
positioned at the point causing the error to
occur.
You may need to turn the paragraph show/hide
, for MS Word
function back on. (click
2002 users click SoDA > Show/Hide
Commands).
IBM Rational software
Page 27 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Highlight from [OPEN34] through
4.10.1.45 The problem is with the calculated
OPEN SoDA Command. It is failing [ENDDISP36].
when there is no associated
RequisitePro requirement. You need
to add a LIMIT around the
RequisitePro information.
4.10.1.46
IBM Rational software
Click SoDA > Add Command.
Page 28 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.47
The Select Command To Add dialog
displays.
4.10.1.48
Click LIMIT Command.
Click OK.
IBM Rational software
Page 29 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.49
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The LIMIT Command dialog displays.
Note The Name field is blank.
4.10.1.50
IBM Rational software
Expand the UseCase node (click
Page 30 of 97
).
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.51
The LIMIT Command dialog box displays
showing the contents of the UseCase node.
4.10.1.52
Click Self.
The LIMIT Command dialog displays
showing the Where Is A field defined.
IBM Rational software
Page 31 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.53
In the And Where > Left Operand field,
click “Click here to add.”
4.10.1.54
The Left Operand short cut menu displays.
Expand Self (click
IBM Rational software
).
Page 32 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.55
The Left Operand short cut menu displays
showing the contents for the Self node.
4.10.1.56
Use the scroll bar to location
RequisiteProProjectPath.
IBM Rational software
Page 33 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.57
Click RequisiteProProjectPath.
4.10.1.58
The LIMIT Command dialog displays
showing the Left Operand value defined.
Click the Operator value.
Note Insure that you are on the correct line
when you make this selection, otherwise, the
LIMIT Command will error when saved.
IBM Rational software
Page 34 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.59
The LIMIT Command dialog displays
showing the short cut menu for the Operator.
4.10.1.60
Click != (not equal).
IBM Rational software
Page 35 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.61
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The LIMIT command dialog displays
showing the new Operator value.
In the And Where > Right Operand field,
click “Click here to add.”
Note Insure that you are on the correct line
when you make this selection, otherwise, the
LIMIT Command will error when saved.
4.10.1.62
The LIMT Command dialog displays
showing the And Where > Right Operand
short cut menu.
Click Literal.
IBM Rational software
Page 36 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.63
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Right Operand field is now able to
accept input from the keyboard.
Press Enter.
4.10.1.64
The LIMIT Command dialog displays
showing the And Where > Right Operand
value defined as “empty.”
Click in the Name field.
IBM Rational software
Page 37 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.65
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Type “LimRPPath.”
Click OK.
4.10.1.66
IBM Rational software
The MS Word application window displays
showing the addition of the SoDA LIMIT
Command surrounding the highlighted text.
Page 38 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.67 Generate the report – what you are
attempting to verify with this step is
if the LIMIT has been set up
correctly.
Click SoDA > Generate Report.
4.10.1.68 Since the only change made was to
add a LIMIT, you do not have to
save this as a new version, though
you can.
The SoDA for WordXXXX dialog displays.
IBM Rational software
Click Yes.
Page 39 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.69 Since you’ve already logged into
RequisitePro with the previous
generation, and you have not closed
MS Word; SoDA remembers the
successful connection and does not
require you to log back in.
4.10.1.70
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application saves the template
using the existing name.
The MS Word application window minimizes
the SoDA Progress Indicator displays in the
lower right corner of the desktop.
Upon completion of the generation process,
MS Word application displays showing the
results from the generation process.
Page 40 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.71
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Use the scroll bar to locate the use cases.
Arrange Shipment has an associated
RequisitePro requirement.
Compare this to what is shown in the Rose
model.
After you have completed your review of the
data, close the generated report (click ).
IBM Rational software
Page 41 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.72
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
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.
IBM Rational software
Page 42 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.73 Start the SoDA Template View.
Click SoDA > Template View.
4.10.1.74
The SoDA Template View dialog displays.
IBM Rational software
Page 43 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.75
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In the left pane, click D DISPLAY
RequisitePro_Project.Name.
In the right pane, click R Requirements.
4.10.1.76
If multiple objects are available, the Class
Selection dialog displays.
Keep the default selection of Requirement.
Click OK.
IBM Rational software
Page 44 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.77
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Template View displays showing the
selected command inserted into the left pane.
Click D FullTag.
4.10.1.78
The Template View displays showing the
selected command inserted into the left pane.
Click D Text.
IBM Rational software
Page 45 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.79
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Template View displays showing the
selected command inserted into the left pane.
In the left pane, click on the REPEAT
Requirement, a Requirement…
Right click.
4.10.1.80
The SoDA short cut menu displays.
Click Modify.
4.10.1.81
The REPEAT Command dialog displays.
Click Advanced.
IBM Rational software
Page 46 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.82
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The REPEAT Command dialog displays
showing three additional sections.
In the And Where > Left Operand field,
click “Click here to add.”
4.10.1.83
The REPEAT Command dialog displays
showing the And Where > Left Operand
short cut menu.
Expand Self (click
IBM Rational software
).
Page 47 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.84
The REPEAT Command dialog displays
showing the contents of the Self node.
4.10.1.85 Depending on how the model is set
up the RequisitePro reference may
need to be the text field. In this
example, the Name field works; but
if the results come back blank, try
the text field for the left operand.
Use the scroll to locate Name.
IBM Rational software
Click Name.
Page 48 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.86
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The REPEAT Command dialog displays
showing the And Where > Left Operand
field defined.
In the And Where > Right Operand field,
click “Click here to add.”
Note Insure that you are over the correct line
when you make this selection, otherwise, the
REPEAT Command will error when saved.
4.10.1.87
The REPEAT Command dialog displays
showing the And Where > Right Operand
short cut menu.
Expand UseCase (click
IBM Rational software
).
Page 49 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.88
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The Right Operand short cut menu displays
showing the contents for the UseCase node.
Click Name.
4.10.1.89
The REPEAT Command dialog displays
showing the And Where > Right Operand
value defined.
Click OK.
IBM Rational software
Page 50 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.90
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
The Template View displays showing the new
REPEAT criteria.
Click
4.10.1.91
IBM Rational software
Display
to close the Template View.
The MS Word application window displays.
Page 51 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.92 Save the template
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Remember, if you are using MS Word 2002
toggle off the SoDA > Show/Hide Commands
prior to saving the template.
Click File > Save.
4.10.1.93
IBM Rational software
The Save As dialog displays.
Page 52 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.94
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In the File name field, replace the 1 with a 2.
Click Save.
4.10.1.95
IBM Rational software
The MS Word application window displays.
Page 53 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.1.96 Generate the report
Click SoDA > Generate Report.
4.10.1.97
The MS Word application window minimizes
the SoDA Progress Indicator displays in the
lower right corner of the desktop.
IBM Rational software
Page 54 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.98
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Upon completion of the generation process,
MS Word application window displays
showing the results.
Page 55 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.99
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Use the scroll bar to locate section 3.2 Arrange
Shipment.
Compare this to what is shown in the Rose
model.
After you have completed your review of the
data, close the generated report (click ).
IBM Rational software
Page 56 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.1.100
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
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 modified an existing template to include some information from RequisitePro. In the next part, you will add
additional SoDA commands to display the attributes for the requirement.
IBM Rational software
Page 57 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Part 2 – Adding additional commands to the template
In this exercise, you’ll add additional SoDA commands to display the attributes for the requirement
Use Case Steps
4.10.2.1
Details
Display
If you closed MS Word, open
Word and open the SoDA
template created in the previous
part.
IBM Rational software
Page 58 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.2
In order to improve readability,
indent the SoDA commands that
you’ve added today.
4.10.2.3
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Use the scroll bar to locate [ENDDISP27],
starting with the next line highlight through
[ENDMAST45].
Click Increase Indent.
Page 59 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.4
The MS Word application window displays
showing the application of the indentation to
the selected lines.
4.10.2.5
Locate [ENDREP44].
Click to the left of [ENDREP44].
IBM Rational software
Page 60 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.6
Add the attributes for each linked
requirement in a table format.
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click Table > Insert > Table.
Remember, when creating
dynamically generated tables, the
table must be created first.
IBM Rational software
Page 61 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.7
The Insert Table dialog displays.
4.10.2.8
Modify the Number of columns to 2.
Leave all other fields with the default setting.
Click OK.
IBM Rational software
Page 62 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.9
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window displays
showing a blank table.
Page 63 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.10
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In the first cell of the first row, type “Attribute
Name.”
Press Tab.
IBM Rational software
Page 64 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.11
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
In the second cell of the first row, type
“Attribute Value.”
Page 65 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.12
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Highlight the entire first row.
Page 66 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.13
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click Bold.
Page 67 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.14
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click the down arrow for Font size.
Page 68 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.15
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click “12” in the drop down list.
Page 69 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.16
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window displays
with the new font styles applied to the table’s
first row.
Click in the table first cell of the second row.
IBM Rational software
Page 70 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.17
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Highlight the second row of the table.
Page 71 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.18
Click SoDA > Add Command.
4.10.2.19
The Select Command To Add dialog displays.
IBM Rational software
Page 72 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.20
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click REPEAT Command.
Click OK.
4.10.2.21
The REPEAT Command dialog displays.
Leave the Requirement > Attributes selected.
Click OK.
IBM Rational software
Page 73 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Use Case Steps
4.10.2.22 Check the locations of the SoDA
annotations distinguishable by the
format of Pink text on yellow
background. The placement of
these annotations are critical to
successful table generation.
Details
Display
The MS Word application window displays.
Check to see that the following annotations are
in the correct locations in the template
document:
•
MASTER must be located above the table.
•
REPEAT must be in the first cell of the repeating
row (second row).
•
ENDREP must be in the last cell of the repeating
row.
•
ENDMAST must be located below the table.
Warning You cannot cut and paste these
commands into the correct locations. If your
table does not look like this, delete the table and
all associated commands, and start over.
IBM Rational software
Page 74 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.23
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click between [REPEAT45] and the end of
cell marker in the first cell of the second row.
Page 75 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.24
Click SoDA > Add Command.
4.10.2.25
The Select Command To Add dialog displays.
Keep the default DISPLAY Command
selected.
Click OK.
IBM Rational software
Page 76 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.26
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The DISPLAY Command dialog displays.
Leave the AttributeValue > Label selected.
Click OK.
4.10.2.27
IBM Rational software
The MS Word application window displays
showing the SoDA command in the first cell of
the second row.
Page 77 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.28
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click to the left of [ENDREP48].
Page 78 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.29
Click SoDA > Add Command.
4.10.2.30
The Select Command To Add dialog displays.
Keep the default setting for DISPLAY
Command.
Click OK.
IBM Rational software
Page 79 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.2.31
The DISPLAY Command dialog displays.
4.10.2.32
Click Text.
Click OK.
IBM Rational software
Page 80 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.33
IBM Rational software
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window displays
showing the SoDA command in the second cell
of the second row.
Page 81 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.34 Save the template.
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Remember, if you are using MS Word 2002
toggle off the SoDA > Show/Hide Commands
prior to saving the template.
Click File > Save As.
4.10.2.35
IBM Rational software
The Save As dialog displays.
Page 82 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.36
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Replace the 1 with a 2 at the end of the file
name.
Click Save.
The MS Word application window displays.
4.10.2.37 Generate the SoDA report.
IBM Rational software
Click SoDA > Generate Report.
Page 83 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.38
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
The MS Word application window minimizes
and the SoDA Progress Indicator displays in
the lower right corner of the desktop.
Upon completion of the generation, MS Word
application window displays showing the results.
IBM Rational software
Page 84 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.39 Compare the data in the report to
the original data in the source
tools.
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Compare this data to the Rose model and
RequisitePro project.
After you have completed your review of the
data, close the generated report (click ).
Do not close MS Word.
IBM Rational software
Page 85 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.2.40
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
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 modified an existing template to gather Use Case information from Rose and any associated information from
RequisitePro. In the next part you will modify the template to exclude the RequisitePro’s Rose integration information (RoseItemID, RoseModelPath, and
RoseType). These items are not necessary in this report.
IBM Rational software
Page 86 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Part 3 – Modifying a SoDA Command within a Table
In this exercise, you’ll modify the REPEAT surrounding the table. It displays some information that is not necessary for this report.
Use Case Steps
Details
Display
4.10.3.1 If you closed MS Word, open Word
and open the SoDA template created
in the previous part.
IBM Rational software
Page 87 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Click to the right [MASTER44].
4.10.3.2 Modify the REPEAT surrounding
the table to access Visible Attributes
instead of Attributes.
In order to modify a command from
the command line, you must be
within the comments of that
command and outside the comments
of any other command. For a
REPEAT that means you must be
between the [MASTER] and
[ENDMAST] for that REPEAT.
IBM Rational software
Page 88 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.3.3
Click SoDA > Modify Command.
4.10.3.4
The REPEAT Command dialog displays.
Note The object that is selected is Attributes.
4.10.3.5
Use the scroll bar to locate VisibleAttrValues.
Click VisibleAttrValues.
Click OK.
Note The value in the Name field and the Where
Is A field do not change.
IBM Rational software
Page 89 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.3.6 Since the name and type of object of The MS Word application window displays.
the REPEAT (from the previous
step) did not change, no other
modifications need to be made.
In most cases, all nested commands
(REPEATs, DISPLAYs and
LIMITs) would need to be checked
when a REPEAT is modified.
IBM Rational software
Page 90 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.3.7 Save the template.
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Remember, if you are using MS Word 2002
toggle off the SoDA > Show/Hide Commands
prior to saving the template.
Click File > Save As.
4.10.3.8
IBM Rational software
The Save As dialog displays.
Page 91 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
4.10.3.9
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Replace the 2 with a 3 at the end of the file
name.
Click Save.
4.10.3.10
IBM Rational software
The MS Word application window displays.
Page 92 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.3.11 Generate the SoDA report.
Click SoDA > Generate Report.
4.10.3.12
The MS Word applciaiton window minimizes
and the SoDA Progress Indicator displays in
the lower right corner of the desktop.
IBM Rational software
Page 93 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
Upon completion of the generation, MS Word
application window displays showing the results.
IBM Rational software
Page 94 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Use Case Steps
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Details
Display
4.10.3.13 Compare the data in the report to the Compare this data to the Rose model the
original data in the source tools.
RequisitePro project.
4.10.3.14
Open use case model surveyRP2Rpt.doc.
Locate Arrange Shipment in both documents,
in the latest version, the Rose integration
attributes are no longer shown.
After you have completed your review of the
data, close the generated reports (click ).
4.10.3.15 Close MS Word.
IBM Rational software
Click File > Exit.
Page 95 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Congratulations, you have successfully modified the template to show only the visible attributes for RequisitePro.
IBM Rational software
Page 96 of 97
Exercise 4.10 - Rose
Version 2003.06.00
Creating a SoDA Template for Rose UC and RequisitePro UCRequirements
Conclusion
Congratulations! You have successfully modified an existing template to display the associated RequisitePro requirement.
You used the SoDA for Word to:
•
Find an existing template that had SoDA commands for the Rose domain
•
Modify the template to gather any associated RequisitePro information
•
Add a LIMIT command so that the template will not error out when there is no associated RequisitePro information
•
Modify the template to exclude information that is not relevant to the association between RequisitePro and Rose
IBM Rational software
Page 97 of 97
Exercise 4.10 - Rose