When you are developing elements in your model, you might want to provide extensive documentation on an element, to provide more structured text than you can create in the element 'Notes' field. In this case, you can create a formatted document that is linked to the element. You can create a Linked Document from scratch, or from one of a range of Linked Document Templates that you define with the Linked Document Template Editor. The Linked Documents are held within the model.
Working with Linked Documents
Create Linked Documents
You can create a Linked Document either:
The advantages of using a Document Artifact to host the Linked Document include:
The advantages of using a Linked Document directly on an element include:
|Create Document Artifact Create Linked Document on an Element
Create Linked Document templates
You can base your Linked Document on one of a range of system-provided templates, each of which represents a project document type.
You can also create and use your own Linked Document templates in the Resources window, within the Document Generation > Linked Document Templates folder.
|Create Linked Document Templates
Edit Linked Documents
You can define the style, format and layout of your Linked Document both in the template from which you create the document and in the document itself. You can edit the Linked Document from a selected element in either the Document Editor or the Document Window.
|The Document Window Edit Linked Document Templates Edit Linked Documents
Create hyperlinks in Linked Documents
Linked Documents are intimately associated with specific elements, but you can also create hyperlinks in the document directly to other elements in the model. Having followed the link, you can perform any normal operation on that element.
Similarly, you can create new elements or diagrams to link to.
You can also create hyperlinks to other forms of documentation.
|Hyperlink From Linked Document Create Element From Document
Include Linked Documents in RTF reports
Linked Documents, however they are created, are rendered into document reports when you select the 'Linked Document' checkbox in the Document Template Designer.
|Reporting Linked Documents
Locate Linked Documents
In diagrams, any element that has a Linked Document is marked with an 'A' symbol in the bottom right corner.
You can also use the Model Search facility to search for elements that have Linked Documents, by creating a custom search containing this SQL Query:
SELECT ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE, Name AS Object, Object_Type AS [Type], Stereotype, Author, Scope, Status, Phase, CreatedDate, ModifiedDate
WHERE t_object.Style LIKE '#WC#MDoc=1#WC#'
|Create Search Definitions
Delete Linked Documents
You can completely remove a Linked Document from an element, or you can remove the contents of the document and replace them with the contents of an external file.
|Replace or Delete Linked Documents
- You can create a Document Artifact element to contain a Linked Document in all editions of Enterprise Architect
- You can create and link a document to any UML element in the model, in the Professional, Corporate, Unified and Ultimate editions of Enterprise Architect
- You can work on Linked Documents through the Automation Interface, using the methods GetLinkedDocument(), DeleteLinkedDocument(), SaveLinkedDocument(string Filename) and LoadLinkedDocument(string Filename)