RSM Wizard Tutorial
Loading Files and Executing Report

The first step in building a metrics set is to set the solution name by pressing the Load button. A solution is the grouping of the file list, output name and the report used.

Enter the name of your solution and press open.

The solution name is now set.

RSM Reports require an input file list of source code files.

Creating a list of files requires the specification of the source code files in the Selection Tree of the user interface.

The selection process can be in Path or Files mode. The Path mode sets a input path into the file list. If Path is used RSM will rollup summary LOC metrics for these directories of path. The following is an example of the result form path mode. This example will use Path mode for one directory and Files mode for another.

Select Path Mode

Next you must select the Path or directory to process. Check the recurse box if you want RSM to recurse the directory processing all the file extensions specified in the extension input area. These extensions must be support by the RSM configuration, rsm.cfg file. Pressing the Set Path button shows a Windows directory selection dialog.

Now the path is set in the Path input area. Pressing the Path to List button sets this directory into the file list area.

Switching to Files mode, we set the Path to a new directory and Acquire the files to the file selection tree. To append files to our previous file to list operation, check the Append box.

Now is the best time to save your file list to a different name other than the default name rsm_file_list.lst by pressing the Save button.

We have now:

The next step is to select a report to process from the report listing or create your own report.

A report determines the output file type txt, html, csv, or xml. When you set the output file name, the file extention must match the output mode. Press the set button to name the output file.

We are almost ready to execute the solution. Save the solution file use the Save button under the Solution section.

The RSM Wizard is ready to execute and launch the report.

The Auto line provides the command line syntax which is past into the RSM tool. If you want to copy and past the region into a script file, diable the Auto check box and the region is cut, copy and paste active. When the Auto check box is disabled the RSM command line will not be updated from the RSM Wizard GUI.

We have now:

Press Execute or double click the report name.

When a Path mode directory is specified in the file list, the metrics for this directory are sub-totaled in the metrics report.

The RSM Wizard stores its files by default to the users profile directory as shown in the following folder structure.

For Example:
c:\My Documents and Settings\JohnB\M2 RSM Wizard

These folder settings along with other key settings for the RSM Wizard can be found in Edit - Wizard - Preferences

We would hightly recommend a free open source text and code editor called Notepad++ which can be found at:
http://notepad-plus.sourceforge.net/uk/site.htm