Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Reporting

creating_documents

As you develop your models in Enterprise Architect, you will want to report on, review and disseminate information on a number of aspects of the model through both online and printed documentation. Enterprise Architect provides a powerful mechanism for generating high quality, customized documentation directly from the model, in RTF, PDF or HTML format.

Report Generation Facilities

Topic

Detail

See also

Specifying Content

There are many ways to specify the model content being documented; you can:

•Document a package and/or its child packages by manually highlighting the package and selecting a documentation control
•Specify embedded packages for exclusion if child packages are recursively documented
•Generate your documentation using a range of system-provided RTF templates that support many different aspects of your model, or develop your own, customized templates to meet your specific requirements
•Link a package to an RTF document template to simplify generating consistent types of documentation (for example, Use Case reports) using the Resource Documents feature
•Select, group and order packages in a different organization from the Project Browser by creating 'Virtual' Documents, either linked through a master document with headers, footers and contents list, or as separate individual documents

 

 

Generate RTF Documents

 
Exclude Package From Report

 

RTF Templates

 

Save As Document

 

Virtual Documents

RTF Documentation

Rich text reports are documents produced by Enterprise Architect in Rich Text Format (RTF), which can be modified directly with style templates to alter the look and feel of generated output.

Enterprise Architect has a fully-featured RTF document generator that features:

•Powerful WYSIWYG RTF style template editor support
•An easy-to-use document generator
•An embedded RTF viewer that enables you to view RTF documents generated by Enterprise Architect within the system
•The option to generate the output in PDF format

 

Using Virtual Documents, you can draw out information on structurally separate model elements in a set of individual reports, or in a combined report under a master document with common headers, footers and contents list.

You can also further enhance the separate RTF documents output from the model by connecting and interweaving them with external text in an MS Word master document.

 

RTF Documents

 

Generate RTF Documents

Design Custom RTF Templates

 

 

 

 

Virtual Documents

 

 

Use MS Word

RTF Reports

You can also generate a number of system-provided RTF reports on different aspects of your model, such as the elements in a package in Implementation relationships or in Dependency relationships.

 

Other Documents

HTML Documentation

It is possible to provide automated web-based publishing of your Enterprise Architect models, making it simple to explore large models efficiently on-line.

You can export an entire model or a single branch of the model to HTML Web pages, and also create web style templates to customize the HTML output.

 

HTML Reports

Learning Center topics

•(Alt+F1) | Reporting | Rich Text Reports | Generate an RTF Report
•(Alt+F1) | Reporting | Virtual Documents | Generate RTF
•(Alt+F1) | Reporting | Virtual Documents | Generate HTML
•(Alt+F1) | Reporting | HTML | Generating an HTML Report