Create an HTML Report

If you want to create an HTML report on a package, you can select the package in the Project Browser and perform a simple procedure using the Generate HTML Report dialog. All child packages of the selected package are automatically included in the report.

Access    Project Browser package context menu | Documentation | HTML Report ( Shift+F8 )

Create an HTML report

Field/Button

Action

See also

Package

Confirm the name of the selected package, for which you are creating the HTML documentation.

If you want to change the package, close the dialog, select the new package and select the HTML report option again.

 

 

Title

Defaults to the package name. If you want the report to have a different title, overtype the field contents with your preferred text.

 

 

Output to

Type or browse for the directory path your report is to be saved to.

 

 

Style

(Optional.) Click on the drop-down arrow and select a custom web style template to apply to your documentation, in place of the default template.

Use the <default> value for the standard, system-provided template.

 

Web Style Templates

File

Specify the file extension for your HTML documentation files; the default is .htm.

 

 

Header Image

If you want the report to have an identifying image at the top, type or browse for the image file's directory path and filename.

If you do not specify a path, the image defaults to the Enterprise Architect logo.

 

 

Preserve White space in Notes

 

Select the checkbox to reproduce the spacing of any element notes. Deselect the checkbox to remove white space.

 

No Page for Note and Text Items

 

Select the text box to exclude Note elements and Text elements from the report.

 

Default Diagram

Select the appropriate radio button to begin the HTML report with:

The Default Model Diagram
The currently-selected diagram
Another diagram, for which you can browse by clicking on the browse button
No diagrams
 

 

Image Format

Select the appropriate radio button for the file format in which to store images - .PNG or .GIF.

 

 

Include

Select the appropriate checkboxes to include in your HTML document:

Test Case elements
Maintenance Items
Resource allocations
Hyperlinked files
 

 

System

Select the appropriate checkboxes to include in your HTML document the System components:

Glossary
Model Tasks
Model Issues

 

 

Generate

Click on this button to generate the report.

 

 

Progress

Shows the accumulating percentage completion of the report generation process.

 

 

View

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

 

 

View page for specific diagram or element

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:

 
http://path/path/path/Index.htm?guid=xxxxxxxxxxxx

 

Type the word guid in lower case, and do not include braces { } in the value ; for example:

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

 

To obtain the GUID, right-click on the diagram, package or element in the Project Browser and select the Copy Reference context menu option.

Browser behaviour

The display of your HTML report can be affected by the browser that you use. Specifically:

Firefox automatically converts the diagram or element page locator path (above) to a file:///C:/path protocol and actions it
Opera automatically adds file://localhost/ to the start of the page locator path, in the same way as Firefox adds the file:///C:/path protocol
Opera by default disables XMLHttpRequest when loading a file, and the HTML report detects this and prompts the user to change settings; there are no problems when the page is hosted on a web server
Microsoft Internet Explorer does not operate on the page locator path directly, but the protocol in Firefox also works in Internet Explorer; therefore, to use the absolute references without a web server, you must access the path using the file:/// protocol
If you are using 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
Chrome completely disables XMLHttpRequest when loading a file, so will not display HTML reports directly from the file system; there are no problems when the page is hosted on a webserver

Notes

To generate a demonstration HTML report right now, open the EAExample project, select the System Model package and follow the steps above
You can also select packages in your model to exclude them (and their subordinate packages) from the HTML reports you generate

Learn more

Learning Center topics

(Alt+F1) | Reporting | HTML Reports