Create 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. To do so, you can create the documents directly from the Documentation attribute.

Prerequisite

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

Procedure

  1. Open the Attributes window for the item you want to assign a description to.

  2. Navigate to the Documentation attribute that is not yet assigned any file.

  3. Click Edit Edit in the attribute value cell of the attribute. The word processor is run and a new document opens.

  4. Finish the description and save the document. You are offered the name of the item to be described with the file extension .doc or .docx as a name for saving the document.

  5. Close the word processor.

  6. If necessary, click Refresh Refresh external document.

The document is added to the Documentation attribute and a preview is displayed.

See also

Insert an external description

Edit an external description

External description: Refresh preview

Display external descriptions read-only

Which technical requirements exist for external descriptions?