Topic
Prev Next

Generate Document Reports

When you want to generate a document report on part of your model, you have a number of options for selecting the object to document, and for defining how your document is to be generated.

A document report describes an element or, more usually, a Package in the model; therefore, your first step is to select the Package or element to generate the document for, from the:

  • Project Browser
  • Diagram
  • Package Browser
  • Specification Manager
  • Diagram List or
  • Model Search

For a Package, you can also define how the diagrams in the Package are to be set out in the document; you do this in the diagram 'Properties' dialog for each diagram. When you have prepared and selected your Package, you open the 'Generate Documentation' dialog and configure the parameters for generating the document.

A tutorial for quickly creating a basic document from the Example model is provided in the second of these two tables. Repeat the tutorial with different selections in the drop-down fields, to see what the system can generate for you automatically.

Access

Select a Package or Element for which to generate documentation, then open the 'Generate Documentation' dialog using one of these methods.

Ribbon

Publish > Documentation > Document > Generate Documentation

Menu

Package | Documentation | Document Generator

Context Menu

Right-click on Package | Documentation | Generate Documentation

Keyboard Shortcuts

F8

Generating reports

Option

Detail

See also

Alternative ways to open the 'Generate Documentation' dialog

Use one of these methods:

  • Click on a Package, then select the 'Package | Documentation | Document Generator (RTF/PDF/DOCX)' menu option
  • Right-click on the Package and select the 'Documentation | Generate  Documentation' option
  • In a diagram, click on a specific element and select the 'Element | Generate Documentation' menu option
  • In the Specification Manager, click on the 'Reporting' icon drop-down arrow and select the 'Generate Documentation (RTF/PDF/DOCX)' 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 Documentation

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.

Package Browser Model Search Diagram List

Generate and view an example report immediately

Step

Action

See also

1

Open the EAExample project.

2

In the Project Browser, expand the Testing View and right-click on the Testing Package.

3

Select the 'Documentation | Generate Documentation' 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.

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

In the 'Output Format' field, click on the drop-down arrow and select 'Portable Document Format (PDF)'.

10

Click on the Generate button.

11

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

Notes

  • Reports can be configured to include all Packages within a parent Package, or just the top level

Learn more