Dynamic Documents to document diagrams

[Modesto Vega]

I am trying to use a dynamic documents template, DD - Diagram Details, to document individual diagrams. The nearest I got to get this working is to add the diagram I would like to document as a diagram frame or a diagram reference and use Start\Windows\Document to view\export\print the document. However, there are 2 problems:

• I don't seem to find a way of identifying which template is used (or to set the dynamic template)
• The template does not display an image of the diagram, or a list of the displayed elements with descriptions

Could somebody send please send me in the right documentation direction?

P.S.: I am using v13 for this.

[Geert Bellekens]

Here's the documentation for version 15

https://sparxsystems.com/enterprise_architect_user_guide/14.0/modeling_tools/dynamic_docs.html

Geert

[Modesto Vega]

Thanks Geert, after reading through this 3 times,and locating the v13 equivalent - https://sparxsystems.com/enterprise_architect_user_guide/13.0/modeling_tools/dynamic_docs.html - I managed to make some progress. However, I am still not where I think I could be.

The key part on both help pages is

Using the Dynamic Document tab

Initially, when you open the Document Window at the 'Dynamic Document' tab, the window displays the Notes text from the currently-selected element, using the default Dynamic Document style sheet.

If you want to display information for a different aspect of the element:


1. Click on the '[Reading] - <element name>' header
2. Click on the 'Select Dynamic Style' option. The 'Dynamic Document Selector' dialog displays.

There is a screenshot after point 2 and, friendly tip to Sparx Systems, a screenshot after point 1 showing and highlighting where the '[Reading] - <element name' header is will be helpful.

When I click on Select Dynamic Style (which is a bit misleading), I get presented with a list showing the following entries: DD_Testing, DD_Resources, DD_Details, DD_ChangeManagement, DD_Basic, DD_Support, and DD_Relationships. None of these values map against a Dynamic System Templates or are editable.

Somehow I concluded that if I select DD-Details for a diagram, it will use the DD-Diagram Details system template. But it does not, no elements are listed. I have verified that the right template is used by following these steps:

• Override the dynamic document template and rename the resulting template to DD-Diagram Details2
• Modify these template with some text to differentiate from the previous one
• Created a new Dynamic Style Template, called Test123 and point it to Diagram::DD-Diagram Details2 as per the help

The end result is a document without the elements been listed. At this point, I am once again lost.

[Ian Mitchell]

(declared interest - I am the author of the tool mentioned below)
I'm not sure if it's exactly what you want, but eaDocX can create a document from a single diagram.
Just right-click on the document, and choose eaDocX / Quick document.
It will use your current Word default template, and include the diagram image, and all the elements which are contained in the diagram. It uses some default formatting, to make sure everything appears, but you can then add/remove content and change formatting, as you require.

[Modesto Vega]

Thanks Ian, I know how to create a template for a single diagram. What I am trying to establish is if some functionality offered by Sparx does not work or I am just missing something.

I know we are talking about v13 but this functionality has been there for a considerable amount of time.

I would welcome somebody from Sparx contributing to this discussion (or anybody else sharing their much appreciated wisdom).

[jfzouain]

Hi Modesto

In my eBook I show how to create master documents for a BRD, also we sell the XML file to create the documentation.
Check https://leanpub.com/uml-erpworkshop
UML ERP Workshop - Writing a BRD with Enterprise Architect - Full BRD

[Modesto Vega]

Once again, the problem is not "how to do it" but "why built-in templates do not work".

The code of the DD-Diagram Details dynamic template is below. When executed the code ignores the 'element>< element' section, everything else works fine.

My question is, why?

Code: [Select]

package >
diagram >
{Diagram.Name}
{Diagram.Type} Diagram {Diagram.Stereotype} [ {Diagram.Version} ]

{Diagram.Notes}

Image
{Diagram.DiagramImg}

element >
Displayed Elements
Type Stereotype Name
{Element.Type} {Element.StereotypeEx} {Element.Name}
< element
< diagram
< package