Installation....................................................................................................................... 3

Starting the installation................................................................................................ 3

The installation instructions ........................................................................................ 3

Welcome.................................................................................................................. 3

Software License Agreement .................................................................................. 3

Choose Destination Location .................................................................................. 4

Select Program Folder............................................................................................. 4

Copying Files .......................................................................................................... 5

Setup Complete ....................................................................................................... 5

Running Reviewer........................................................................................................... 6

Exploring a comment in more detail ............................................................................... 8

Reports ............................................................................................................................ 9

Summary report....................................................................................................... 9

Type report .............................................................................................................. 9

Category report........................................................................................................ 9

Review categories ......................................................................................................... 10

Componentization ................................................................................................. 10

Correctness ............................................................................................................ 10

Completeness ........................................................................................................ 10

Standards ............................................................................................................... 10

Style....................................................................................................................... 10

Reporting............................................................................................................... 10

Tailoring Reviewer to your organizational standards ................................................... 11

Select the report to change/customize................................................................... 11

Configure the review options ................................................................................ 11

Add and remove entire reviews............................................................................. 11

Tailor a review ...................................................................................................... 12

2

Explore how the reviews can be tailored .............................................................. 13

Checking organizational development standards .......................................................... 14

Exemptions.................................................................................................................... 15

Logging exemptions...................................................................................................... 16

Click the clipboard icon next to the review comment........................................... 16

Enter the exemption details ................................................................................... 16

Examine exemption reports................................................................................... 16

Annotate review comments........................................................................................... 17

Publish/save reports....................................................................................................... 18

Remove exemption........................................................................................................ 19

Refresh reports .............................................................................................................. 20

Remove all unused exemptions..................................................................................... 21

3

Installation

Starting the installation 1. Start Windows.

2. Place the CD-ROM in CD-ROM drive.

3. The installation will begin automatically. Follow the instructions on screen.

If the installation does not begin automatically

1. Click Start on the Windows toolbar, then click Run.

2. Type d:\setup, where d is the letter of your CD-ROM drive.

3. Click OK.

4. The installation will begin automatically. Follow the instructions on screen.

The installation instructions

Welcome After reading the welcome screen click Next to begin the installation.

Software License Agreement You must accept the license agreement to continue with the installation.

4

Choose Destination Location Choose the appropriate installation path.

Select Program Folder Choose the name of the program folder that Reviewer will be installed under.

5

Copying Files The installation files will then be installed onto you machine.

Setup Complete Once setup has finished you may be prompted to reboot. It is advisable that you do reboot before running Reviewer.

6

Running Reviewer Once installed Reviewer can be run from Start menu under the program group selected during installation.

Open a Rose model file,

users can then choose a report,

and perform a Review of the model.

7

Reviewer will produce five different report documents (summary, type, package, exemption and exemption summary). Clicking on the hotlink for each of the report types will take you to the report.

8

Exploring a comment in more detail

There may be a review comment where the brief description is unclear. The heading for the review comment provides a hotlink to a more detailed explanation of the cause of the comment and its resolution.

If the information provided by the Review Assistant still isn’t clear then the Web Assistant (accessed from the bottom toolbar) will take you to a web page with additional information and hotlinks to websites that may provide more information.

9

Reports

There are two types of Reviewer report; reports that detail review comments and reports that detail exemptions. An exemption report details review comments which have been "signed off" as acceptable, we will look at exemptions later.

There are three types of report that detail the review comments.

Summary report

This report provides statistics and management information about the review comments, breaking them down by type, category and review. The purpose of this report is to provide planning information about the progress of development and highlight the types of problems with the model.

At the start of the development process the comments will indicate correctness problems and incomplete areas. As the process progresses more of the problems will revolve around adding details to the model.

This report also provides information so that the project manager can gauge the likely risks in stopping design and moving into construction early, helping prevent analysis paralysis.

Type report

This report breaks down the review comments only by review type. To see the details of each review use the contents list at the top of the report.

Category report Review comments are sorted according to category and type. This allows you to see which parts of the system are responsible for which errors.

10

Review categories

Each review falls into one of a number of categories:

Componentization

Component based development is key to building large-scale maintainable enterprise solutions. Componentization reviews check that the dependencies are correct between components, report what the interaction is between components and if there are redundant dependencies between components.

Correctness

Particularly important at design time these reviews check that the model can be implemented.

Supports C++, Java,Visual Basic and Forté specific reviews.

Completeness

Checks for undefined functionality. These reviews are the main guiding force for analysis and design; they provide the roadmap for how to reach the destination.

Standards

We recognize that development teams have their own internal standards and we provide customizable reviews to enforce common internal design standards.

Style

Just because it can be done it doesn’t always mean that it should. These reviews help guide developers into using best-practices and, once again, these can be customized to meet internal standards.

Reporting

Provides focused reports for checking detailed workings of the model. Allows architectural reviews to check componentization strategy, distribution issues and error handling.

11

Tailoring Reviewer to your organizational standards

Many of the reviews can be tailored to fit your organization’s development standards/guidelines and architectural framework.

Select the report to change/customize

You select the report using the drop down Run Report button on the toolbar.

Configure the review options

Select Configure from the command toolbar button.

Add and remove entire reviews

There may be some reviews that simply aren’t appropriate to your development process. For example, perhaps your organization does not show default constructors on class diagrams. You would therefore deselect the "Has default constructor" review.

12

Some of the reviews are disabled in the review options. This indicates a review that is available with SELECT Reviewer but not with Rose Reviewer.

When configuring the review options an exclusive lock is placed on the settings files being edited. If all of the reviews are disabled in the review options this means that another user is currently configuring the review options and has already locked the settings files.

Tailor a review

Many of the reviews can be tailored, in fact some of them only become useful once you have tailored them (e.g. giving Reviewer a list of valid framework base classes).

One review that you will find useful to tailor is the "Required override" review.

On the standards tab select the "Required override" review. Click the "Details…" button. You will be presented with a list of operations that should be overridden for any class derived from the corresponding base class.

13

Add some required overrides of you own for your organizations class library.

Explore how the reviews can be tailored

Click on each of the reviews in turn to see which reviews can be tailored (the "Details..." button becomes enabled) and launch the details screens. This will show you ways that you can make Reviewer more relevant to your development process.

You can find out about each of the reviews from the Help, Reviews menu option. This will take you to a list of all of the reviews. Clicking on a review name will explain it in more detail.

14

Checking organizational development standards Every developer can check your organization’s development standards (held by Reviewer) by selecting the Standards report from the report menu.

Then run the report like you would a review report by clicking on the Run button.

The standards can then be printed off and distributed to team members or published on your intranet page.

15

Exemptions

An exemption is a "signed off" review comment. The comment will not appear in further reviews. Reviewer will log the name of the developer who raised the exemption and their explanation of why the exemption was raised. These exemptions are added to the exemption report.

There are several reasons why an exemption might be raised for a comment:

• The comment is not a problem at all and can be safely ignored. An example of this would be the "Long operation name" comment – long operation names sometimes indicate a problem but often they are valid. An exemption would be raised for the valid names.

• Report item comments raised might be checked by the developer leader. For example, the abstract class without subclasses might be checked by a development leader who knows about its intended future use. Once checked an exemption would be raised, effectively signing-off the comment.

• The review comment is highlighting something that should be done in a perfect world but pragmatism dictates that it won’t be done this time. An example of this would be detail fields - constraints on many operations might be useful but may be ignored because of schedule pressure.

• The comment is erroneous. The limitations of Rose and Reviewer may mean that you’ve had to find workarounds to the way that the tools work, which go against the expectations of Rose and Reviewer. An example of this would be a use case without OSD where you may have found that in design you can use exactly the same OSD for two use cases. Rose will not allow you to have two parent use cases for an OSD so you may wish to raise an exemption for the second use case detailing the reason why it doesn't have an OSD.

The exemption report is then a document that can be printed out, checked and signed off when a stage of your development process is completed.

16

Logging exemptions

Click the clipboard icon next to the review comment

Click the clipboard icon next to the review comment that you wish to raise the exemption for.

If an exemption has already been raised for the comment and the report has not been refreshed, then nothing will happen. If it has not been raised the exemption details dialog will be shown.

Enter the exemption details

You will be prompted to enter some details about the exemption. These details will be added to the exemption log. You should use this space to enter some notes that will be useful when the exemption log is signed off later.

Examine exemption reports

The exemption report shows who raised the exemption and the reason why. The exemption summary report provides statistics and management information about the exemptions that have been raised. This will highlight whether the category and type of exemptions that are being raised are appropriate.

17

Annotate review comments

Click the picture of a notepad next to the review that you wish to annotate. A dialog will then be presented where the annotation can be entered.

The annotated comment will then appear with the annotation below it when you refresh the report or when anyone re-runs the review.

Example of annotated review comment:

18

Publish/save reports

This can be used to export the reports as HTML files for integration on your Intranet. This is especially useful if not all developers have licenses to use Reviewer.

Upon selecting this facility you will be prompted to choose a directory to export the HTML files to. The report files will then be saved to this directory.

The filenames are:

Summary report ReviewSm.html

Reviews sorted by type ReviewTy.html

Reviews sorted by package ReviewPk.html

Exemption summary report ReviewEs.html

Exemption report ReviewEt.html

19

Remove exemption

Sometimes an exemption will be logged by mistake or a change in the model will mean that the exemption will need to be fixed.

To remove an exemption click on the button in the exemption report. The exemption will not appear in future exemption logs but instead will appear in future reviews (assuming it is still a problem).

20

Refresh reports

When exemptions get logged or annotations get made you may wish to refresh the contents of your reports without re-running the report. The "Refresh" option has the same effect as "Refresh" in an internet browser - it refreshes the data on the current screen.

21

Remove all unused exemptions

As your model evolves sometimes problems that needed exemptions raising for them disappear. This means that there are spurious exemptions in the exemption report. Selecting the "remove unused exemptions" option cleans the exemption log. This will read all exemptions and remove those that should no longer appear in a review.