Prev Next

Documents Toolbox

The 'Documents' page of the Diagram Toolbox provides a variety of model elements to use for documenting various aspects of the system you are modeling.  The different types of document artifact are detailed in the Types of Document Artifact table.

Types of Document Artifact

Type

Description

See also

Document Artifact

A Document Artifact is an Artifact having a stereotype of «document». You can create the Document Artifact using the Documentation, SysML or Zachman Framework pages of the Diagram Toolbox, and associate it with an RTF document or CSV file.

Double-click on the element to display the Linked Document Editor. When you have created the Linked Document, the Document Artifact element on the diagram shows an 'A' symbol in the bottom right corner.

Linked Documents Add Quick Linker Definition To Profile

Custom Document Artifact

A Custom Document is a form of Linked Document, and therefore is associated with an element in the model. However, Linked Documents usually contain static information specific to the host element, whereas the main feature of a Custom Document is that it contains automatically refreshed information on several objects from anywhere in the model. Therefore, the main method of creating a Custom Document also generates a Document Artifact element to host the document, in a selected Package.

A Custom Document Artifact represents a document that is made up of a range of model elements and their properties, where every time you open the document the content is dynamically refreshed from the model objects you have included and from the template instructions.

A custom document can have three types of content:

  • Content contained in the document template - including a title page, table of contents and paragraph text
  • Dynamic Content that is dragged into the document from the Browser - including Packages, diagrams, elements and features
  • Static Content that a user types or pastes into the document

For example, at any point in the document where a diagram is needed or a list of items is required that exist in the model, these can simply be dragged in from the Browser window. How these items are rendered is determined by the selection of an appropriate document template.

Create a Custom Document

Encrypted Document Artifact

An Encrypted Document Artifact is used to create and hold a Linked Document that is automatically encrypted, and that cannot be opened and automatically decrypted within Enterprise Architect without entering a password. You can therefore use the generated Artifact element to record sensitive information, which you protect from general access by assigning a password.

When you drag the 'Encrypted Document' icon onto the diagram from the 'Documentation' page of the Toolbox, a prompt displays to type in a password. When you enter the password, you can create the Linked Document. Thereafter, if any user attempts to open the document, the same password prompt displays. If the user does not provide the password that you originally specified, the document will not open. If the correct password is provided, the document is decrypted and opened.

The Encrypted Document Artifact is indicated in the Toolbox page, diagram and Browser window by a red 'document' icon - Encrypted icon.

Linked Documents

Report Specification Artifact

A Report Specification Artifact encapsulates a report definition. When you have created the element on the diagram, you double-click on it to display the 'Generate Documentation' dialog, on which you enter the report parameters and, if required, generate the report.

After you create the Report Specification, each time you double-click on the Artifact element the 'Generate Documentation' dialog again displays with the same report parameters. You can continue to generate the same report, or alter the parameters if necessary. If you change the parameters, they are re-presented until such time as you change them again.

Generate Documentation

Reading List Artifact

The Reading List Artifact provides a list of elements that contain information of particular significance to a task or process. The intention is for the information from each element to be displayed in the 'Dynamic Document' view, in the sequence in which the elements are organized in the Reading List.

Using the Reading List Artifact

User Story Artifact

A User Story Artifact provides a means of documenting a business Use Case, in the context of Agile methodologies such as Extreme Programming (XP). In the Linked Document, you define the functions a business system must provide; it captures the 'who', 'what' and 'why' of a requirement in a simple, concise format. The User Story Artifact behaves as a Document Artifact, prompting you to select a Linked Document template to base the document on.

User Story

Learn More