updateable diagrams in Linked Documents ??

[JohnDoe]

Hello,

I have created a diagram and put an Artifact which links to linked document. Now I have opened the document and edited some text. I can use the context menu to create new UML elements (class, requirements, issues, diagram etc.) directly out of the linked document and they appear in the repository. That's fine.

Now my question:

If I drag an element from the repository and drop it into the linked document, I see the name of the element entered into the document and it is written in blue letters being underlined; when I move my mouse of the text, the cursor switches to a hand symbol; if I double click, my repository view jumps to the element; So far so good.

How can I embed a diagram into my linked document ? If I copy and paste a diagram it doesn't get syncronized if the diagram in the repository changes.

So I actually want to drag and drop elements from the repository into a linked document and create a summary document out of my repository elements.

Is it possible to update diagrams in a linked document automatically ?

Regards
Bernd

[Jan Pacovsky]

I'm not sure whether this solves your problem but you can try "Model Document".

1) Create new class and select stereotype called "model document".
2) Drag&drop any package from project browser on this class
3) Select this class and use function Element -> Rich Text Format report
4) Create your document

This will generate document (RTF report) with diagrams and elements that are included in selected packages.

Hope this will help...

[Jan Pacovsky]

And how about to try to create new diagram, drag&drop all elements from different packages, and then generate documentation? I think that it is possible to set either documentation or diagram feature, which turns on documenting of elements that are only linked and not directly included in specific package.
Currently I don't have EA, I'll try it tomorrow and let you know.

[JohnDoe]

Thank you Jan,

oops, I didn't know that feature (there are so many hidden features in EA; as good as the product is, as bad is the presentation of its features). And sometimes EA usage philosophy reminds me of using a Unix Terminal instead of a visual GUI  

Back to the topic: This only works with packages and it includes every diagram, every requirement etc. Initially I wanted to pick single elements and put them into a report.

The problem with this Element->CreateRTFReport feature is, that all diagrams in these packages are rendered using the same template. From some diagrams I need details in the report and other diagrams should leave details out. Another question is how to switch the ordering of the elements inside the packages (it is alphabetical, but that is not optimal).

Any more ideas anyone ?

Regards
Bernd

[Jan Pacovsky]

I'm afraid that I don't have any other idea how to solve your problem. The only solution is one template for all diagrams/elements...
Anyway, the solution I talked about yesterday works (except those different templates). Create new package with new diagram (let's say custom type) and drag&drop all elements you want to document. Right-click on diagram background and open Diagram properties. On the Diagram tab check "Document each contained element in RTF" checkbox. Then put your new package into Model document class and use above-described feature for element RTF documenting.

Regarding element order... You can always use green arrows (up/down) in project browser to change the element order in package. And this order also affects order in documentation.

[JohnDoe]

Jan,

thanks for that !

EA always suprises me with all these nice but hidden functions.

Regards
Bernd  

[«Midnight»]

I'm afraid that I don't have any other idea how to solve your problem. The only solution is one template for all diagrams/elements...
Anyway, the solution I talked about yesterday works (except those different templates). Create new package with new diagram (let's say custom type) and drag&drop all elements you want to document. Right-click on diagram background and open Diagram properties. On the Diagram tab check "Document each contained element in RTF" checkbox. Then put your new package into Model document class and use above-described feature for element RTF documenting.

Regarding element order... You can always use green arrows (up/down) in project browser to change the element order in package. And this order also affects order in documentation.

Bernd,

You might want want to ensure that you've set the Free Sorting and cleared the Sort <whatever> alphabetically options. You'll find the former on the main Tools | Options dialog main page, and the others on the Objects page.

David

[JohnDoe]

#@hmpfh!gr!!

>>>  You might want want to ensure that you've set the Free Sorting [...]
That is what I am talking about. There is no real intuitive way in using that software. There are so many features thrown all over the menues without an intuitive workflow oriented menu structure. If EA wouldn't have all these fantastic features (as soon as you know that it is there and how to use it), I would have left EA long ago !!

@thomas:
Again, thanks for this !

Regards
Bernd

[JohnDoe]

Just received this information from the support:

>>>

Hello Bernd,

Thank you for your e-mail. This is a deficiency of the shape script that
is used to draw BPMN activities. The BPMN language has its own composite
indicator - a '+' symbol in a box centred at the bottom of the shape. To
get that to appear, set the ActivityType tagged value to "Sub-Process".
I hope this helps.


Best Regards,

Neil Capey
Sparx Systems Pty Ltd
[email protected]
http://www.sparxsystems.com.au

<<<

[Oliver F.]

Jan,

thanks for that !

EA always suprises me with all these nice but hidden functions.

Well, those are not hidden at all- one is the virtual documents feature (mentioned in the online help and the RTF RTF white paper from the sparx web site) and the other is one of my favorite pitfalls for cross package documentation (check the box, check the box, check the box... ).

The problem with documenting elements from the diagrams: You get only a subset of possible contents, namely missing are linked documents, scenarios, requirements, etc.

Regards,

Oliver

[JohnDoe]

You are right, they are not really hidden.

But EA often reminds me of a huge store, where everything is stacked and packed and when you enter the store, you dont walk into the back rooms to search for things there.

The question is, what functionality EA has and how simple you find these functions during a working session. The problem is, that EA functions dont unfold along the workflow. It is a little like modeling with blender (http://www.blender.org). This is also a superb tool, but doesnt seduce the users during there work.

Of course, you can surf around in documentation, but IMHO a GUI should arrange the application's features using menues and toolboxes to enable intuitive workflows for the users.

Regards
Bernd

[gpc]

Hi Bernd,
I don't think there's any way to have an active link to diagrams, so you'll always need to process something to generate an updated doc.
I spent quite some time trying to massage the rtf output into something I could use, but just couldn't get it to suit my needs. I've recently been using the automation interface, which provides the possibility of a completely customisable output, for example only show state diagrams, only print diagrams with a particular tag, etc.
The new version (7.1) has a little more enhanced handling of rtf documents with the concept of a master document, but I think I'll be sticking with the automation interface - I'm very impressed by how easy and quick it is to generate something useful.

[JohnDoe]

Hi,

the only thing that I would like to have is:

a) open a linked document
b) open the repository
c) drag an element from the repository
d) get a popup and choose which aspects to transfer (tags, attributes, notes, diagram ...)
e) paste it in the linked document
f) back to c) and so forth

So, I would generate manually an array of elements, which I would like to have in my report. When reopening the report, all these elementds should be reloaded, so that the report  always contains the latest diagrams and data.

Regards
Bernd

[JohnDoe]

Please have a look at this demonstration and you know, what I would like to have in EA !!

http://www.visual-paradigm.com/product/vpuml/demos/reports/adhocreport.jsp

Regards
Bernd

[«Midnight»]

You only need to tell us in one thread Bernd.