Use Case RTF Template to list participating Actors

[Chris Boreen]

Hi,

I am new to EA and am trying to create an RTF template for my Use Cases.  As part of each Use Case, I wanted to list the Actors that were participants in the use case.  

I noticed that the examples just print out a list of all the actors in a different section of the document.  Is there a way to do this using the templates?  I expect everything is possible via the automation interface?

[Oliver F.]

Hi,

I am new to EA and am trying to create an RTF template for my Use Cases.  As part of each Use Case, I wanted to list the Actors that were participants in the use case.  

I noticed that the examples just print out a list of all the actors in a different section of the document.  Is there a way to do this using the templates?  I expect everything is possible via the automation interface?

The RTF enging doing nothing else than to walk through the packages in the hierarchy and print out those element details which are referenced in the template.
That said in your case the use cases are printed when all use case elements are found and the actors are printed when the section with the actors is reached. Which is not the same location so the report is somehow split.
You can do the following:

A) Put a use case and its actors in one package. I know this is the most ineffective solution as most actors will appear in several use cases but I mention it just for reference.
B) Have one diagram per use case and show its relation to its actors, then check the "document each diagram element" in the diagram properties dialog and add the "elements" section for diagrams in the document template. This will document the elements in the diagram together (Notes, Names, etc. if set).
C) Most complicated method: Add connector target elements to the template (check Element->Connector->Target->Element).
Note that this will also document all other dependency connectors from other elements in the model so you might want to restrict the document option settings to use cases and actors only.

I hope this helps. It is not very descriptive but it should give an idea where to start.

Oliver

[Dermot]

Hi,

The latest version of EA – 7.1 available for download, supports creating Virtual documents that contain multiple model templates.

You can combine several Model Documents under a Master Document package element.
Each Model Document element provides a separate template; for example, an Actor Section for the Actors and a Use Case template for a section on Use Cases. The Master Document links any number of Model Documents into a single generated document, and provides headers and footers and a central table of contents.

See: http://www.sparxsystems.com.au/EAUserGuide/virtualdocuments.htm

[TLC]

Hi,

The latest version of EA – 7.1 available for download, supports creating Virtual documents that contain multiple model templates.

You can combine several Model Documents under a Master Document package element.
Each Model Document element provides a separate template; for example, an Actor Section for the Actors and a Use Case template for a section on Use Cases. The Master Document links any number of Model Documents into a single generated document, and provides headers and footers and a central table of contents.

See: http://www.sparxsystems.com.au/EAUserGuide/virtualdocuments.htm

I was looking at this section for few hours as I just don't understand the concept   Sorry I'm very new to EA. But I strongly believe EA is a powerful tool to generate great customized document from the UC modelling.

Is there any example of virtual documents, master document, model document that I can refer to?

[Dermot]

Hello TLC,

Unfortuantely I cannot send an XMI copy of a template-package across the forum, however below is list of the steps to create a Virtual-template-Package:

Creating a Master Document:
The Master Document defines the general template for the Table of Contents and Headers and Footers etc.
Steps:
1)      Open the Tagged Values view  (Ctrl-Shift+6)
2)      Create a Master Document Package using either:
      Under a Package Create a new diagram of type: Model document
      From the toolbar select: Documentation
Or
      On an existing Diagram:
      From the Toolbar select: Toolbar | More tools | Extended | Documentation
3)      Drag a Master Document Package onto the diagram. This will prompt for a package name and will create a Package and a Diagram.

4)      Open the created Diagram (the Toolbar will now display Documentation).
5)      From the Toolbar Documentation - drag on a Model Document Element. Give the Element an appropriate name (e.g. the sub-document section name: “Requirements”).
6)      Select the Element:
      In the Tagged Values window; under RTFTemplate;  set the Template using the drop-down.
      Set the packages to report or  a filter:
Either:
•      Drag the packages to be reported onto the Element
Or
•      Set a filter in the Tagged Values window by creating a Tagged Value of type SearchName, then  select an existing Search in SearchName.  
•      If the Search requires a filter value, create a Tagged Value of type SearchValue and set the Filter Value in this Tagged Value.

Repeat steps 5- 6 for each new sub-document required.

I hope this is of help.

[TLC]

Thanks Dermot!

Is it possible to pull out the 'Project Name' (e.g. SystemA) somewhere and have 'SystemA' appears in the generated document?

[Dermot]

Hello TLC,

When you say 'Project Name', what are you refering to - The root-node of the packages, the repository name or ...?

[TLC]

Hello TLC,

When you say 'Project Name', what are you refering to - The root-node of the packages, the repository name or ...?

I'm referring to the root-node of the packages.

[Dermot]

The root Node package name will be rendered using the package Section:
package>Pkg.Name
<package
If you are primarily reporting on sub-packages from below the Root node then it would be best to create a Virtual document and either set the Master Document or a Sub-document to just report the Root name using the above (i.e. drag across the Root package to the model document class).  
In the Editor - Unset the Section: Child Package - then it will only parse the first entry.

I hope this is of help.