Create an HTML Report

To create an HTML report, follow the steps below

How To:



See Also


In the Project Browser, right-click on the root package for the report (all child packages are included in the output).

The context menu displays.



Select the Documentation | HTML Report menu option.

The Generate HTML Report dialog displays.

Generate HTML Report dialog


In the Output to field, select an output directory for your report.

Set any other required options.



Click on the Generate button to generate the report.

The Progress field shows total percentage complete.



Once the report is complete, click on the View button to launch your default HTML viewer and view the web pages.





See also


The web report produced is compatible with any standard web server, on either Unix or Windows platforms. Simply bundle up the entire output directory and place it within the context of your web server. All path names should be relative and case sensitive.

When you view the HTML report in your HTML viewer, you can switch directly to a page for a specific diagram or element by specifying the appropriate GUID after the report web address. That is:


The word guid must be in lower case, and the value must not include braces { }. For example:

http:// .../path/Index.htm?guid=DC62B0DA-0D60-4447-85E6-B9BBAE7FC90F

You can obtain the GUID for the diagram or element using the Copy Reference option on the Project Browser Diagram, Element and Package context menu options.

The page locator does not work directly in Internet Explorer. Firefox automatically converts the path to file:///C:/path protocol, and actions it. That protocol also works in Internet Explorer. Therefore, to use the absolute references without a web server you must access the path using the file:/// protocol.

Diagram Menu

Element Menu

Package Menu

Quick Start

To generate an HTML report right now, follow the steps above on the System Model package of the EAExample project.



  • If you are using Microsoft Internet Explorer 7.0 or later, and you do not have it open, its security profile might block the report display; click on the explanation banner at the top of the screen and select the Allow Blocked Content context menu option