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 document format or web page format.

Report Generation Facilities

Facility

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 templates that support many different aspects of your model, or develop your own, customized templates to meet your specific requirements
•Use system-provided or user-customized Stylesheets, Tables of Contents and Cover Pages to further tailor individual reports or sets of reports, independent of the template used
•Link a Package to a 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 Documents

 
Exclude Package From Report

 

Document Templates

 

Generate Documentation

 

Save As Document

 

Virtual Documents

Document Reports

You can generate Document reports in a number of document formats, which you can tailor using templates and Stylesheets to alter the content and appearance of the generated output.

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

•Powerful WYSIWYG template editor support
•An easy-to-use document generator
•An embedded viewer that enables you to view documents generated within the system

 

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 styles.

 

Document Reports

 

Generate Documents

Design Custom Document Templates

 

 

 

Virtual Documents

 

System Reports

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

 

System Documents

Web 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 Web pages, and also create web style templates to customize the web page output.

 

Web Reports

Charts

You can capture statistical information on a range of element properties across the model, and display this information on a diagram in one of several formats, such as a pie chart, bar chart or 3-D column chart.  You can also print and distribute the charts you have created, using the standard Diagrams Only Report facility.

 

Charts

 

Diagrams Only Report

Learning Center topics

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