Edit an external description

You can describe database and model items (models, objects, groups, etc.) using formatted documents or other files and save these documents in the Documentation attribute. If you are using the Microsoft® Word file formats DOC and DOCX, a preview is available and the Edit Edit button is available. Existing documents can be edited directly from the Documentation attribute.

Prerequisite

You are using a method filter that contains the Documentation attribute.

Warning

Due to technical restrictions external descriptions cannot be locked if they are open in the editor. Therefore, it is possible that a user deletes an external description in ARIS while it is being edited by another user in the editor. In this case, all changes of the description are deleted without the editing user being notified.

Procedure

  1. In the Attributes window open the item you assigned a description to.

  2. Navigate to the Documentation attribute, in which a file added in the format DOC or DOCX.

  3. Click Edit Edit.

  4. Microsoft Word is launched and the document opens.

  5. Edit and save the document.

  6. Close Microsoft® Word and activate ARIS.

  7. Click Refresh Refresh from the Documentation attribute.

The refreshed document of the Documentation attribute is displayed.

See also

Create an external description

Insert an external description

External description: Refresh preview

Display external descriptions read-only

Which technical requirements exist for external descriptions?