Prev Next

Generate the Document

When you have created one or more Model Document elements and, if necessary, a Report Package element, and you have set the document order and established any section numbering you want to apply, you can generate printable documentation from these elements.

You can also use a Model Document element containing a number of separate Packages to generate an XML file for export to another model. See the Generate Model Document XML Help topic.

Access

Select a Report Package or a Model Document element either in the Browser window or on a diagram, and display the Generate Documentation dialog in one of these ways:

Ribbon

Publish > Model Reports > Report Builder > Generate Documentation

Keyboard Shortcuts

F8

Context Menu

In a diagram, right-click on the Model Document element | Documentation | Generate Documentation

In the Browser window : Hamburger arrow. | Documentation | Generate Documentation (RTF/PDF/DOCX)

Generate virtual documentation

Step

Action

See also

1

On the 'Generate Documentation' dialog, set the generating options for your document as required.

Generate Documentation

2

Click on the Generate button to create the documentation.

The Report Generator works through the defined content of the Report Package element and/or the Model Document elements and pulls in the information from either the listed Packages or the executed searches, formatted according to the templates identified in the RTFTemplate Tagged Value for each Model Document element.

3

If you have not selected the 'View Document on Completion' checkbox, click on the View button to view the documentation.

Learn more