How To Generate Documents

Ribbon

Publish > Model Reports > Report Builder > Generate Documentation

Browser window Toolbar

  | Documentation | Generate Documentation (RTF/PDF/DOCX)

Keyboard Shortcuts

F8

Alternative ways to open the 'Generate Documentation' dialog

Use one of these methods:

• In the Specification Manager, click on the 'Specification - Specify > Element > Documentation > Generate Documentation (RTF/PDF/DOCX)' ribbon option
• In the Diagram List, Package Browser or Model Search, select one or more items, right-click and select either 'Documentation | Generate Documentation for each selected Item' or 'Documentation | Generate Documentation for selected Items'

Generate report on elements from Package Browser or Model Search

When you select to create a report from the Diagram List, Package Browser or Model Search tools, you can generate an element-level report rather than a Package-level report, and you have additional flexibility in selecting:

• The type of element to report on
• The specific elements to report on, together or separately, whether in the same Package or not

For example, you might want to find all elements with test cases, with the intention of reporting on some or possibly all such elements; with the Diagram List or Package Browser, you would identify these elements yourself within the list of all elements in a selected diagram or Package, but with the Model Search you can automatically pick out the elements across a section of the model or across the whole model, as required.

The search filtering could be for specific test cases; however, the results are by element so if there are test cases outside the range in any element that has a filtered test, these elements are listed as well.

Having generated the list of elements, you can select individual elements, blocks of elements, or all elements from it and then use the context menu to generate one report on all of the selected elements, or a separate report on each element.

1

Open the EAExample project.

2

In the Browser window, expand the Testing View and click on the Testing Package.

3

Select the 'Publish > Model Reports > Report Builder > Generate Documentation' ribbon option.

The 'Generate Documentation' dialog displays.

4

In the 'Output to file' field, click on the button and browse for a convenient file location in which to hold the generated report. Include the appropriate file extension to set the document format (PDF, RTF, DOCX) of the generated report.

5

In the 'Template' field, click on the drop-down arrow and select 'Basic Report'.

6

In the 'Table of Contents' field, click on the drop-down arrow and select 'TOC (portrait)'.

7

In the 'Stylesheet' field, click on the drop-down arrow and select 'Styles - Print Medium'.

8

In the 'Cover Page' field, click on the drop-down arrow and select 'Cover Page (portrait)'.

9

Click on the Generate button.

10

When the report has been generated, click on the View button and examine the report.