This webinar has completed, the recording will be posted shortly.

Overview

Finished your analysis or design model and need to publish it as a document?
Do you need to follow a corporate style or use a document structure defined by your customer?

In this two-part webinar series, you\ll learn how to deliver customized documentation using Enterprise Architect's powerful document generator.

This webinar covers the basics. Ben Constable, Senior Analyst at Sparx Systems, teaches you how to:

REGISTER TODAY!

Don't miss this opportunity to learn more about Enterprise Architect

Session 1

Melbourne Sun 26 Oct 08:00 am
New York Sat 25 Oct 17:00 pm
Los Angeles Sat 25 Oct 14:00 pm
London Sat 25 Oct 22:00 pm
Auckland Sun 26 Oct 10:00 am

Session 2

Presenters

Ben ConstableSparx Systems

Explore the webinar resources

Example model: document-generation-enhanced-example-model.eap Download links
Document templates: arcgis-data-dictionary-document-templates.xml Download links
Generated Document: smart-meter-data-dictionary-report.docx Download links

Questions & Answers

General

Enterprise Architect 11, Build 1112.
Some of the features were introduced in version 11 – for example, the Report Specification element, Style sheets, Template Selectors and .docx file support. Other aspects of document generation in the presentation were enhanced in version 11 – for example, the cover page and table of contents previously needed to be included in the top-level template, whereas Enterprise Architect 11 provides dedicated templates for them. Most of the template editing features are available in earlier versions of Enterprise Architect.
Yes. We've made the model and templates available for download from this page.
No. The HTML report generator has a limited set of options compared to the document generator and it is not template-driven.
We will host a follow-up webinar on document generation in the last week of November. See the registration page for details.
Yes. This known issue was corrected with the release of Enterprise Architect 11, Build 1111.
No. If you don't have Enterprise Architect 11 available, you might consider a third-party add in for Enterprise Architect that is capable of generating Microsoft Word documents. For an example, see the eaDocX product listing.
Yes. You can import a generated document into another model simply by dropping it from the File Explorer onto a Diagram. The templates can also be reused across projects, as explained below.

Template Editing

Any of the Project Constants that you have defined using the Generate Documentation dialog, and any Report Constants from the context menu (Author, Date, Alias Name Source Status, Title, Version, Filename). None of the fields from other sections, however, should be used within the header or footer.
Yes. C:\Program Files (x86)\Sparx Systems\EA\DocTemplates

You can also export report templates to a file. For instructions, see the Help topic Export Reference Data. You need to export the data labelled RTF Document Templates.

Use – for example– the Project (Model) Glossary system-provided template for one of the Model Documents in a Virtual Document. Or design your own template to pull in the information you need, such as the glossary section, in your own templates.
The Report Constant named ReportVersion. It corresponds to the version of the Package being reported on. For more information, see the Help topic Report Constants.
(I have managed to do auto-resizing tables (i.e. cells auto-resizing) in previous versions of Enterprise Architect by pasting a table from Word. But does the tool now support that feature?)

No, an auto-resize option is not yet supported. You should still be able to copy and paste auto-resizing cells from Word into a report template in Enterprise Architect.

See the recorded presentation at 18:00 minutes to see how the Template Selector was added to the top-level template. At 16:00 minutes the presentation shows you how to select templates for different kinds of element. Also see the Help topics Define a Template Selector and Adding Fragments to a Document Template.
See Enterprise Architect's Help topic Define a Template Selector. (At the time of writing, the video presentation shows an additional capability to select templates by element stereotype, not shown in the help topic.)
You can see the system-provided templates in Enterprise Architect's Resources view. Access the Resources view via the Project menu > Resources. Look for the templates under the folder Document Generation | System Templates.
No.
Bitmap, JPEG, PNG, GIF, TIFF, Windows Meta files and Enhanced Meta files.

Diagrams

In the Diagram Properties dialog, select the Diagram tab. Enable the option Divide Diagram into Multiple Pages.
Not yet. We are investigating a solution.

Document Structure

Not yet. We are investigating this feature request.
Yes. You can define a Model Search that selects elements from various packages. You can report the results of that search. You can also use Virtual Documents to define a report that uses a particular Model Search and template. See the Help topics on Model Search and Model Documents.
As for the previous question.
Yes. All Relationship Matrices on a package will be documented. There is currently no way, however, to select which one(s) to document.
Yes. In the Template Editor, use the context menu Edit | Edit Section.
Yes. You can use a Model Document to specify multiple packages. You can also combine multiple Model Documents into a single report using a Master Document. The next webinar on Enhanced Document Generation will discuss these features. You might also be interested in the Help topic Virtual Documents.

Cover Page

Look under the folder Document Generation | System Templates | Cover Pages. You can copy that template by selecting it and using the context menu.

Table of Contents

You can edit the styles associated with table of contents entries in a style sheet. See the Help topic Notes on Creating Stylesheets.

Styles

See the Help topic Notes on Creating Stylesheets. You might also like to sign up for the next webinar on Enhanced Document Generation.

The next webinar on Enhanced Document Generation will include editing of style sheets.
No. Internally Enterprise Architect uses specifically named bookmarks for each section, which cannot be reliably imported from Word.

If you just need to copy say a cover page or a particular layout/style from a Word document you could first export it as an RTF (Rich Text Format) document. Then import that RTF document into a blank Enterprise Architect report template.

share this page share by email share on linkedin share on twitter share on facebook