How do I get started with Essential Metrics?
Once you have installed Essential Metrics firstly read the README.txt which gives you instructions on how to use the tool. After this run emetrics at the command line (with no switches) and this will give you the available options.
How do I generate reports?
The reports from Essential Metrics are generated through the use of command line switches.
This will create a single page html report in the file c:\single.html.
Note: filelist.txt is a text file containing a list of source files. myProject is the name that has been given to your project.
How do I install a license?
You do not need a license to evaluate Essential Metrics - to test the product simply download from our website. This downloaded version gives the functionality of the full product but limits the number of source files to 5. If you supply more than 5 files the first 5 will be analyzed.
When you purchase the tool you will receive an email with an attached license file. To use Essential Metrics extract the "license.dat" file from the zip file attached to the email. Save this "license.dat" file in the directory you installed Essential Metrics and then run emetrics.
This report gives all of the metrics about a symbol (file, class etc.) in an individual grid per symbol. This is very useful if you are looking for all of the metric information for a specific symbol.
Grid HTML Report
The grid report gives metric results in one large table where each symbol is one row in the table. This is useful for comparing metric results across several symbols.
Each of these reports (Symbol HTML and Grid HTML) come in either a multiple page format or in a single page format. The multiple page format allows browsing between the symbols, while the single page format displays all of the relevent information in one page.
What can the CSV report be used for?
The CSV report gives comma seperated values of the metrics for your project. This can be imported into a spreadsheet to produce other types of reports or graphs.
What about the XML report?
The XML report stores all of the metric information for your project in an XML file. This allows the results to be manipulated or displayed in a browser using an XSL transformation.
Host locked license allows a copy of Essential metrics to be run on one computer.
Floating
With floating licensing, a license server is purchased and then a number of user license is purchased. These can then be used over a network allowing that number of user to concurrently use the product. This licensing model is often used to allow access to Essential Metrics throughout a project or organization.