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

Overview

In this second of our two webinars on using Enterprise Architect's Document Generator, we analyze a real-world example to teach you enhanced techniques for generating document deliverables.

In this webinar you will learn how to:

REGISTER TODAY!

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

Session 1

Melbourne Wed 26 November 08:00 am
New York Tue 25 November 16:00 pm
Los Angeles Tue 25 November 13:00 pm
London Tue 25 November 21:00 pm
Auckland Wed 26 November 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

Yes. You can view the presentation video and read answers to questions from the audience on the webinar's landing page.

Editing Templates

Yes. Using the Element | Connectors | Source/Target sections:

Link Business Rules to Requirements in Enterprise Architect

Yes. You can type or copy and paste text and images that are not part of the model into report templates. This is useful when defining templates for sections such as the cover page or preamble.

Not yet. We have raised a feature request for this.

Sparx Systems can provide technical support for any product issues encountered while developing templates. However we do not provide a service for actually developing report templates. You may be interested in engaging the services of one of our training or consulting partners.

Element Discussions will be available as a report template section in the next major release, Enterprise Architect 12, which is available now in beta to registered users. Reporting discussions created with the Team Review feature is not yet supported.

You can use Bookmarks to refer to sections within your generated document and to customize how certain fields and sections are reported - for example, preventing labels being reported for empty fields. For details, see the Help topic Insert Reference Links.

As explained in the Help topic Insert Reference Links, you enclose a labeled field with .Begin and .End bookmarks.

  1. On the Diagram Properties dialog, enable the option "Document each contained element in Documentation".
  2. In your report template, enable the section Diagram > Element (even if blank).
  3. In your report template, click the Document Options toolbar icon. On the Document Options tab turn off the option "Hide <Anonymous> elements". (Notes are anonymous elements.)

Style Sheets

Version 11.

After you click OK on the Edit Stylesheet dialog, the system immediately puts you into the style editing mode and returns you to the style sheet template. You remain in that mode until you left click the Document. You will then immediately see any changes applied to text that uses the style you modified.

Medium refers to the font sizes used in that style sheet.

The easiest way is to copy one of the system-provided style sheets when you create a style sheet. Otherwise, to add numbered headings to an existing or blank style sheet:

  1. Open the style sheet template
  2. Type some text
  3. Apply the style you want from the style drop-down list
  4. Right click and select Edit | Edit Style
  5. Click OK
  6. Right click and select Paragraph | Numbering
  7. Click OK
  8. Click on the Document to apply the style.
  9. Click Save

No. See the previous webinar's Q&A for an explanation.

Custom Queries and Filters

Yes. The templates are available for download from this page as the resource arcgis-data-dictionary-document-templates.xml

Import the XML file as Enterprise Architect Reference Data. For instructions, see the Help topic Import Reference Data.

Enterprise Architect's Object Model is outlined in the Reference Help Topic, which applies to automation.

You might start with the Repository Package page.

Then refer to its Repository Class sub topic.

Although the Repository Class does not have a corresponding database table, its associated Classes generally have one. For example, the Element Class page lists the following:

Associated table in .EAP file: t_object

So an SQL query to retrieve element fields would use the t_object table as in:

SELECT Name AS ElementName FROM t_object

Also see the Help topic Create Search Definitions and the sample model on this page. The sample includes 5 templates that use custom queries. The names of those templates have the prefix "ArcGIS Data Dictionary Query".

No, but the response to the previous question lists some useful resources.

In your report template, click the Document Options toolbar icon. On the Document Options tab turn off the option "Hide <Anonymous> elements".

Depending on the nature of the queries, you might use them with Enterprise Architect's Model Search facility. The Model Search results can be reported using the Document Generator as well.

Template Fragments can optionally use an SQL query to return data. Other kinds of report template cannot do this. If you want to use an SQL query in your Template Fragment, you need to enable the Custom section, as explained in the Help Topic Custom SQL Fragments.

Virtual Documents

Version 3.6, or later.

No. The document generator only supports packages or Model Searches on Model Documents.

You set these templates when generating the Master Document. As of Enterprise Architect 11, the cover page and TOC templates can be separate to the Master Document's template. See the video presentation at 16:50 minutes.

There is a short segment on creating Virtual Documents in our video on Requirements Reporting at 8:36 minutes.

For more information about using SQL queries, see some of the previous responses on this page.

We have not published a book, but there are several online resources published by Sparx Systems that may help. In addition to this webinar, the following presentations discuss Enterprise Architect's reporting capabilities:

For written documentation on report generation see the Online Help topic Reporting.

Alternative Reports Formats

Yes. You could create a report template and enable the relevant sections of the model.

Yes. Enterprise Architect has a built-in HTML report generator, though it has a limited set of customization options compared to the document generator and it is not template-driven. Alternatively, you might save your generated document as HTML using your document editor's capabilities.

No. Enterprise Architect's document generator does not support XSLX format.

Currently there is no facility to replace specific characters in model data returned by template fields.

Use Enterprise Architect's Model Search feature to search for elements with Linked Documents. Access the Model Search feature via the main menu: Edit | Find in Project. Create a new search with the SQL Editor option. Copy this query into the editor:

SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name AS
Object, Object_Type AS [Type], Stereotype, Author, Scope,
Status, Phase, CreatedDate, ModifiedDate
FROM t_object
WHERE t_object.Style LIKE '#WC#MDoc=1#WC#'

Click the Save button in the toolbar, then run the search.

If you want to execute the query directly from Enterprise Architect's SQL scratch pad, replace #WC# with the actual wildcard for your DBMS (for example use * on an EAP file or % on a MySQL repository).

For more details on creating model searches, see the Help topic Create Search Definitions.