BABOK® Guide v3 Tutorial: Using Documents

When working with documents in Enterprise Architect you have numerous options, of which we will cover the two most preferred options:

The benefit of the internal Document Artifact is that you can create new Elements that are hyperlinked to text of your document.

The benefits of the OLE Accessible document are:

  • Any file type can be used (including spreadsheets)
  • For text documents you can drag text onto the diagram and automatically create Elements from this. The Document remains intact and un-altered (it can be updated in Word if preferred).

Using Internal Documents

This covers creating an internal Document Artifact that uses the internal Editor for updating it. From this we will create new glossary entries and create new hyperlinked Elements.

The document formats that you can use are .docx and .rtf.

View

Process

Step 1:

BABOKŪ Guide v3 Tutorial: Using Internal Documents

In an Document Analysis diagram create a new Document Element.

  • From the Toolbox select: Artifacts | Document
  • Drag this onto the diagram.

Step 2:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - New Template for Linked Document

Double-Click on the Document.

In the New Template for Linked Document dialog, click on the Cancel button.

Select in the Ribbon: Document Edit | File | File | Import File

In the File dialog select the document to import

Step 3:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - create Glossary terms and Elements

With access to your document in the internal document editor, you can now start to create Glossary terms and Elements from the text.

Step 4:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - create a Model Glossary term

To create a Model Glossary term from the document:

  • Block select some text covering your new term
  • Select Create | Glossary Definition from the context menu.

In the Glossary Detail dialog add your description text.

Step 5:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - new Requirement Element

To create an Requirement Element using the text of the document:

  • Block select some text covering your new Requirement name.
  • Select Create | New | Requirement from the context menu.

Step 6:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - Create new linked Element

This creates an Element of that name in the Project Browser.

The text used to create this is now a hyperlink to the new Element.

Step 7:

BABOKŪ Guide v3 Tutorial: Using Internal Documents - Requirement definition

Now add the definition of the Requirement by selecting the specific text to be added to the Requirement Element:

  • Block the text
  • Copy it (Ctrl+C)
  • Open the Element Properties (double-click on the Element in the Project Browser)
  • Paste the text to the Notes.

The new Element can be placed on a diagram or it can be viewed in the Specification Manager.

More Information:

For more information see:

Linked Documents - Enterprise Architect User Guide

Using OLE Documents

The benefit of the OLE Accessible document is that you can drag text onto the diagram and automatically create Elements from this. The Document remains intact and unaltered - it can also be updated via a Word Processor if preferred.

The following steps will guide you through a simple process of importing a document and creating Elements from it in the model.

View

Process

Step 1:

BABOKŪ Guide v3 Tutorial: Using OLE Documents - Import document file

It is assumed that you have Document Analysis diagram open.

  • Open the File Explorer.
  • Select the file to be imported.
  • Drag this onto the diagram - from the prompt select the Artifact Internal

This will create a Document Artifact Element containing the Document.

Step 2:

BABOKŪ Guide v3 Tutorial: Using OLE Documents - Document Artifact Element

Double-click on the Document Artifact Element to open the external Word Processor.

Step 3:

BABOKŪ Guide v3 Tutorial: Using OLE Documents - create an Element

To create an Element from the text (for example a Requirement):

  • Block some text in the Word Processor
  • Drag the text to the diagram

You will be Prompted to select an Element Type.

Step 4:

BABOKŪ Guide v3 Tutorial: Using OLE Documents - New Requirements element

Your Requirement Element is now contained in the model.

Tools & Techniques for BABOK Guide v3 Tutorials:
Getting Started - A guide for the Business Analyst Introducing the Tools & Techniques for BABOK Guide® v3 View Tutorial
Create a Model using a Template Create models using the Model Wizard View Tutorial
Adding a Worked Example Create smarter models to cover specific techniques View Tutorial
Using Documents Learn about Document Artifacts and document editing options View Tutorial
Creating Your Own Diagrams Use Model Patterns to start your requirements project View Tutorial
Tutorial Handout Download this tutorial series in PDF format (5.5Mb) Download PDF
Additional Resources:
Product Overview Tools & Techniques for BABOK® Guide v3 Read More
Product Overview MDG Technology for BABOK Guide v3 Read More
Product Overview Pro Cloud Server Read More
Webinar Recording Tools & Techniques for BABOK Guide v3 View Webinar
Product Brochure (PDF) Enterprise Architect Tools & Techniques for BABOK Guide v3 Download Brochure
Sparx Insights Blog Enterprise Architect Tools & Techniques for BABOK Guide v3 View Blog
Strategic Alliance Partnership International Institute of Business Analysis (IIBA®) & Sparx Systems Read More