Book a Demo
Prev Next

Create Model Document

If you want to create a single document that captures details from specific but separate 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 Report Package 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.

You can also set up a Model Document element to collate a number of separate Packages to be included in an XML file for export to another model. See the Generate Model Document XML Help topic.

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 Report Package element you have created or
  • If you are creating separate Model Documents, create a new Documentation diagram ('All Perspectives | Extended | ModelDocument' 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' (this option is outlined in Step 2).

Create Report Packages Add New Diagrams

2

You can create a Model Document element directly in a Package (perhaps separate from the diagram, in which case you would add the Model Document to a diagram - or more than one diagram - at a later point). To create the Model Document element, click on the ribbon option 'Publish > Model Reports > Model Documents'. You can then choose either:

  • New, to create the Model Document element through the 'New Element' dialog with the perspective and element type already defaulted to the appropriate values, or
  • New From Pattern, to create the element from a Pattern in the Model Wizard (create from Pattern tab of the Start Page); again, the perspective and pattern list default to values appropriate to Model Documents

Alternatively, create the Model Document element directly on the diagram, by dragging the 'Model Document' icon onto the diagram from the 'Documentation' page of the Toolbox. (If the diagram is not a Documentation diagram, to show the 'Documentation' page click on Search to display the 'Find Toolbox Item' dialog and specify 'Documentation', then click on the Activate Toolbox button.)

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 'Element' tab of the Properties window (the 'Start > All Windows > Design > Create > Properties' ribbon option) and click on the Model Document element.

Expand the <<modelDocument>>. section. A number of Tagged Values are available, the first set of which you can use to define the Report Constants for the cover page details, if this Model Document element defines a stand-alone document:

  • ReportAlias
  • ReportAuthor
  • ReportKeywords
  • ReportName
  • ReportSource
  • ReportStatus
  • ReportSummary
  • ReportTitle
  • ReportVersion

In the remaining Tagged Values you define the template and, if appropriate, Model Search to use to generate the document:

  • RTFTemplate
  • SearchName
  • SearchValue
Add Packages to Model Document

4

The value of the RTFTemplate Tagged Value defaults to 'Model Report' as the template to use for this Model Document. If you want to use a different template, click on the drop-down arrow at the right of the value field and select the required template.

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 Tagged Value, 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 Tagged Value.

7

Create further Model Document elements as required.

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

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
  • As you work on Model Documents and Document Packages (or Report Packages) over time, you might need to locate the elements in the model; you can search for and list the elements using the Model Search with the 'Publish' search group, as described in the Pre-defined Searches Help topic

Learn more