Book a Demo

Author Topic: EA - Document linked Elements  (Read 5787 times)

Guy Manning

  • EA User
  • **
  • Posts: 74
  • Karma: +0/-0
  • UML Newbie :0)
    • View Profile
EA - Document linked Elements
« on: March 16, 2015, 10:30:39 pm »
I am missing something - using RTF, created a nice template for an Activity Diagram

Now in my model, I have AS IS and TO BE Versions of a process
AS IS has all the elements in
TO BE uses the elements from AS IS plus one new/modified one

If I RTF document the AS IS package it runs through nicely in package element order and all looks nice
If I use the same template on the TO BE all I get is the new element (i.e. no linked elwments from the AS IS)
In the simple RTF generator I cannor spot an option to 'Document Linked Elements)

This option IS there in the more complex generator but when I use that instead, it does not document in Package element order?

OK, please point me in the right direction!

OpenIT Solutions

  • EA User
  • **
  • Posts: 555
  • Karma: +9/-1
    • View Profile
Re: EA - Document linked Elements
« Reply #1 on: March 17, 2015, 12:25:15 am »
Hi,

I'm guessing that in your RTF template your have something like

package>
diagram>
 <diagramimage>
<diagram
element>
<name>, <notes>
<element
<package

? The RTF template is including the diagram within the selected package, but the element section will only include the details of elements in the package - ie your one new element. You need to check Diagram -> Elements in the left hand side of the template editor - then select the element name, notes etc within this section in the RTF template.

Guy Manning

  • EA User
  • **
  • Posts: 74
  • Karma: +0/-0
  • UML Newbie :0)
    • View Profile
Re: EA - Document linked Elements
« Reply #2 on: March 17, 2015, 01:03:25 am »
Hi tried adding Diagram > Element and I get a [Right click to add...] in Yellow appearing in the template,,,but I cannot seem to right click and get anything to appear in terms of new Fields to add...clues?

Uffe

  • EA Practitioner
  • ***
  • Posts: 1859
  • Karma: +133/-14
  • Flutes: 1; Clarinets: 1; Saxes: 5 and counting
    • View Profile
Re: EA - Document linked Elements
« Reply #3 on: March 17, 2015, 01:10:20 am »
Hi Guy,

Sounds like you're generating documents per diagram. If so, make sure you check "Include all Diagram Elements in Report" in the Generate Documentation dialog. Right at the bottom.

This is because diagrams are only a view of the elements and the document generator follows the package structure. So elements shown in a diagram but belonging to an out-of-scope package won't be documented unless you tick the above option.

/Uffe
My theories are always correct, just apply them to the right reality.

Guy Manning

  • EA User
  • **
  • Posts: 74
  • Karma: +0/-0
  • UML Newbie :0)
    • View Profile
Re: EA - Document linked Elements
« Reply #4 on: March 17, 2015, 01:28:00 am »
Hi,
Thanks
Yes that option is already ticked, still not working

Guy Manning

  • EA User
  • **
  • Posts: 74
  • Karma: +0/-0
  • UML Newbie :0)
    • View Profile
Re: EA - Document linked Elements
« Reply #5 on: March 17, 2015, 01:29:49 am »
This is the simple template I am editing
==========================

{ReportName}
This document provides a complete overview of all the Activity Diagram element details.
package >
{Pkg.Name}
{Pkg.Notes}

diagram >
{Diagram.Name}
{Diagram.Notes}
{Diagram.DiagramImg}
Figure: {Diagram.Figure}

< diagram
element >
{Element.Stereotype} : {Element.Name}
{Element.Notes}
< element

< package