Skip to end of metadata
Go to start of metadata

In Enterprise Studio you can easily document your models, and refer to other objects, documents or intranet sites.


On this page:


Documentation

All elements of a model package, including diagrams and views and even models, can be documented. It is done in the documentation field located on a tab in the Documentation pane.

To add documentation to an element, select the element in the model browser or in the active diagram or view, and type the text in the documentation field. You can also copy and paste text from other Office programs (Word, PowerPoint, Excel, etc.).


Documentation for an ArchiMate® object

Documentation text formatting

By using the commands in the Font group on the Home ribbon tab you can format the texts in the Documentation window, for instance fonts, styles and alignment. The standard font for documentation can be set at the General options.



Find and replace in documentation

You can find and/or replace text in a documentation field by clicking Home > Find in the ribbon, or pressing Ctrl+F (find) or Ctrl+H (find and replace). It opens the following window, in which you can specify and perform your search.


Restoring default documentation values

To remove documentation from an element, it needs to be restored to it's default value. Any information added to the documentation field will be removed, resulting in an empty documentation field, or a field with a predefined default value, depending on your tool configuration.

Regardless of the location of the element for which the documentation is restored, it will affect all copies of the element: the element itself in the model browser, and any element references in diagrams and views (if applicable).

To restore an element's documentation to its default values, do as follows:

  • Select the element, right-click its documentation field, and click Reset to default values.
    If the Documentation pane has multiple documentation tabs available, you can also click Reset all to default values to reset the documentation on all tabs at once.

Clearing a documentation field by simply removing the text will not suffice. You need to use the reset function.

Defining your own documentation fields

By default, elements have one documentation field for adding documentation. If desired, you can define your own additional documentation fields, which will be located on separate tabs. Additional documentation fields can be added per element type by creating custom documentation fields using the The Metamodeler.

The order of the documentation fields is determined by Enterprise Studio. If you want them to be shown in alphabetical order, select the option Sort documentation fields in alphabetical order at the Enterprise Studio Options.


Example of multiple documentation fields, sorted alphabetically.

References

In documentation fields and profiles you can include references (hyperlinks) to websites, external files and other elements in the model package, but also links to send an e-mail message. Any links created can later be viewed and easily be maintained using the The Link table.

References in documentation

To create a reference in a documentation field, follow these steps:

  1. Place the cursor in the documentation field and press Ctrl+K, or click  (Insert link) in the Font group on the Home ribbon tab. You can also select a text in the documentation field and then press Ctrl+K. The link editor appears.



  2. In the link editor, specify the details of the reference.

  3. Optional: If you create a reference to a file of a graphical format, you can choose to embed the file in an InSite Lite or RTF report by selecting the Embed target in reports check box. If embedded, the actual picture instead of the link will be added to the report when you create a report of the model.

  4. Click OK to close the link editor.

References in profiles

Besides in documentation, hyperlinks can be added to almost all objects. You can use these to refer to documents that have to be used while performing a particular action. You can also refer to intranet or Internet addresses.

To add a reference to a model element, follow these steps:


  1. In the diagram, view or model browser, select the object to which you want to add a reference .

  2. Go to the object's the Properties window and on the Properties tab, expand Basic profile and then references.



  3. Double-click link. The link editor appears.



  4. In the link editor, specify the details of the reference.

  5. Optional: If you create a reference to a file of a graphical format, you can choose to embed the file in an InSite Lite or RTF report by selecting the Embed target in reports check box. If embedded, the actual picture instead of the link will be added to the report when you create a report of the model.

  6. Click OK to close the link editor.


ArchiMate® is a registered trademark of The Open Group.