Virtual Documents

Virtual documents enable you to structure and filter your RTF and HTML reports by selecting, grouping and ordering individual packages independent of the organization of the Project Browser.




See also


You can create separate virtual documents defining, say, Requirements, Use Cases or Design elements of a project, or you can combine these separate reports - retaining their own different formats - into a single generated document with common headers and footers and a central contents list; this combined document could apply your corporate standards

You generate virtual documents in Enterprise Architect from individual Model Document elements; you can also, if required, combine several Model Documents under a Master Document package element

You can create as many Model Documents as required, for as many combinations of information as required

Each Model Document element has its own template; for example, a specifically-designed Requirements template for a Requirements document, or a Use Case template for a section on Use Cases

For HTML, the template is identified on the report generation dialog; for RTF, the template is identified in a Tagged Value

The content of the report is defined as either:

  • A list of packages (defined as attributes) dragged onto the element in whatever order or combination is most appropriate to your requirements - you can easily add or delete packages as necessary; or
  • (Not for HTML reports) a standard model search (defined as Tagged Values) created within the Model Search facility - note that diagram searches are not supported; when you generate the document, this search captures the required data throughout the model and populates the document

The Master Document element has its own template Tagged Value, which defines the headers, footers and central contents list; you can import your corporate standards template and edit the Tagged Value to identify that

The template in the Master Document overrides the templates in the Model Documents; for example, headers and footers in the Master Document template override any header and footer definitions in the Model Document templates - this enables you to apply consistent and continuous styles and page numbering throughout the report generated through the Master Document

If you want the Model Documents to have their own styles, applied through their own RTFTemplate Tagged Values, either leave the Master Document RTFTemplate Tagged Value blank (for completely separate overall styles) or remove the definition of specific styles from the Master Document template

You can control the sequence in which information is presented in the document; see the Document Order topic

Create Model Document

Create Master Document

Add Packages to Model Document

Delete Package in Model Document

Create and Modify Searches

Import RTF Template

Document Order

Document Elements

The Master Document and Model Document elements are available from the Documentation page of the Toolbox; on the Toolbox, select More tools | Documentation (this Toolbox page also provides the Document Artifact element, which is not related to virtual documents but is used for adding a linked document to an element)




When you drag the Master Document and Model Document elements onto a diagram, the following symbols display, respectively:

MasterDoc                               d_ModelDocElement

Document Artifact


  • In a Model Document for an RTF report, you should not define both a list of packages and a search; if both are present, when you generate the RTF document Enterprise Architect works from the package list only
  • You cannot use RTF Bookmarking in Master Document elements, which effectively replace RTF Bookmarking in Word
    RTF Bookmarking requires each bookmark to be unique; when you generate a report with a standard RTF template (including in a single Model Document element), each bookmark is unique and there is a 1:1 association between the Elements-details being generated and the elements in the repository
    As Master Documents are intended to contain multiple sub-documents, the association ceases to be 1:1; there is no simple method that enables the generated data to be uniquely identified directly in association with the original element

Learn More: