Import/Export Use Cases to MS Word

Export use case to MS Word

Select File > Export > Use Case Model to MS Word... from the main menu.

The Export Use Case dialog box is displayed. Specify the output destination of the exported file.

• You can specify your own export options, please reference to the Export Options sections.

You can customize the export list by clicking

and

button.

You can customize the sequence of the exported model by clicking

and

button or selecting the order type in the checkbox.

After finish, click OK to export.

Here is the exported file sample.

Export Options

Here is the description of different export options:

•	Launch Viewer
	•	Check this option to launch the viewer(MS Word) to open the exported file.

•	Insert page break between element
	•	Check this option to insert page break between each elements (Use Case, Actor and etc.).

•	Generate TOC
	•	Check this option to insert a Table of Contents at the beginning of the exported file.

Modify the exported file

After you export the use case model, you can modify the exported file to update the use case models.

Basic modification
The model information is exported as the table format presentation, so that you can modify the information by using the common word processing knowledge.

•	Before change:


•	After change:

New use case description

If the use case model doesn't specify any use case description in VP-UML, an empty use case description table is exported under the Use Case Description section.


•	Please fill in the table to create a new use case description.


•	The user can create another use case description by copy the whole table and paste it next to the current description.

Update relations

Same as the basic modification, you can update the relations by modifying the relation table.


•	Type only support Assoication, Generalization, Include and Extends.
•	To create a new relation, move the cursor to the last element of the table and them press TAB key to insert a new row.

Creating new model

There have two ways to create the model in the document:

•

Using the exported form (only for the exported document)

•

Create the model form by yourself

Using the exported model form

After export the use case model to the MS document, there have some empty model form append to the each part. You can fill this form to create a new model when import this document back to the VP-UML. If you want to create more than one model, you can copy this form and paste it as the new model.

Here is the empty model form sample:

After fill in the form:

Create the model form by yourself

If you want to create the model form by yourself, you need to follow some specify format. This section will demonstrate how to create the model form of different model.

Properties Table

The properties table is the basic representation of the different model. The followings are the acceptable table of the properties table.

PS. You can choose one or mix them together.

Actor
1.	Insert a text ActorName - Actor and change the style of this text to Heading 1.

2.	Insert a text Actor Details and change the style of this text to Heading 2.

3.	Insert a table to specify the property of the actor, please reference to the properties table section for more details of the table format. The followings are the possible property of an actor: Name, Leaf, Root, Stereotype, Abstract and Documentation.


4.	You can apply the layout format to the content, but please remember that the level(Heading 1, Heading2...) cannot be changed.

Use Case
1.	Insert a text UseCaseName - Use Case and change the style of this text to Heading 1.

2.	Insert a text Use Case Details and change the style of this text to Heading 2.

3.	Insert a table to specify the properties of the use case, please reference to the properties table section. The followings are the possible property of a Use Case: Name, Rank, Justification, Leaf, Root, Stereotype, Abstract and Documentation.


4.	Insert a text Use Case Description and change the style of this text to Heading 2.

5.	Insert a table to specify the use case description. You can insert more than one use case description of a same use case. The followings is the use case description table format:

	PS. For the Flow of Event property, the value should be a table which contains the following format:

	Here is the sample of the use case description.


6.	Same as actor, you can change the layout format to the use case content.

Update TOC

1.	If you have generated the TOC, you can update the page number by right clicking the TOC and select Update Field.


2.	Select Update page number only or Update entire table and then click OK.

Import the use case from MS Word

Office Exchange feature allows you to import the business model from the MS Word file to VP-UML. If the source file is exported by the VP-UML and imported to same VP-UML project, the models of the project will be updated. Otherwise, the new models will created to the project.

Select File > Import > MS Word to Use Case Model... from the main menu.

Specify the source file and select OK.

If the source file is not exported by the VP-UML, the use case models are created.

	You can use these models to form a new use case diagram by dragging them to the diagram.

Real-time update

After you export the models to a MS Word file, the VP-UML will monitor the exported file. If there have any changing on the exported file, a dialog will displayed for asking update the models when you activate the VP-UML.

Related Resources

• Know more about Visual Paradigm for UML - A powerful visual UML CASE tool.
	http://www.visual-paradigm.com/product/vpuml/

• Know more about Smart Development Environment - An UML modeling extension for leading IDEs
	http://www.visual-paradigm.com/product/sde/

• Get the Free 30 Days Trial of Visual Paradigm's Products
	http://www.visual-paradigm.com/download/

Click on one of the stars below to rate this article from 1 (lowest) to 5 (highest).