Create Model Document

If you want to create a single document that captures specific details from specific areas of your model, you can define that document using a Model Document element. You can also create a number of individual documents and combine them as sections of a larger document, defining the larger document in a Master Document element. You can create as many Model Document elements as are necessary to provide the independent documents or the sections of the document you require.

Prerequisites

Before you create a Model Document element, you might have to:

Create the appropriate document or web page template to define the structure and appearance of the document
For a document, determine whether to provide the content of the document using selected Packages or a Model Search and - if necessary - create the Model Search to use
 

Create a Model Document element

Step

Action

See also

1

Either:

Open the child Custom diagram of the Master Document element you have created or
If you are creating separate Model Documents, create a new Documentation diagram (Extended | Documentation in the New Diagram dialog)
 

The new diagram can live anywhere in the model hierarchy, outside the Packages you are adding to the document; you could create a diagram called Documentation within a specific Documentation Package, and use this to hold the independent Model Document elements for your virtual documents.

You can also create Model Documents on any other convenient type of diagram, changing the Toolbox page to Documentation (step 2).
 

Create Master Document

Add New Diagrams

2

From the Documentation page of the Toolbox (More tools | Documentation) drag the Model Document icon onto the diagram to create a new Model Document element.

Give the element an appropriate name; for example, if the documentation is relevant to the shopping cart requirements of a model, you could call it ShoppingCartReqDocumentation.

Click on the OK button.

 

 

3

If you are creating a Model Document element for a web report, go now to the Add Packages to Model Document topic.

Otherwise, open the Tagged Values window (View | Tagged Values) and click on the Model Document element.

The RTFTemplate, SearchName and SearchValue Tagged Values display in the window.

 

Add Packages to Model Document

4

Click on the drop-down arrow to the right of the RTFTemplate field, and click on the template to use for this Model Document.

 

 

5

If you are creating a list of Packages for the Model Document, go now to the Add Packages to Model Document topic.

Otherwise, click on the drop-down arrow to the right of the SearchName field, and click on the model search type to populate this Model Document.

In a Model Document for a document report, do not define both a list of Packages and a search; if both are present, when you generate the document it is created from the Package list only.

 

Add Packages to Model Document

6

If necessary for your Model Search, type a search term in the SearchValue field.

 

 

7

Create further Model Document elements as required.

Your Model Document element appears in the Project Browser with a Class icon, as shown below:

 

VirtualDoc-ProjectTree

 

When you have created all the required Model Document elements, go to the Document Order topic.

 

 

 

 

 

 

Document Order

Notes

Diagram Searches are not supported
Custom SQL searches are supported if they are returning elements; the SQL must include ea_guid AS CLASSGUID (case sensitive) and the object type
 

Learn more

Learning Center topics

Alt+F1 | Enterprise Architect | Reporting | Virtual Documents |
Create from a Search
Generate RTF