Author Topic: Reporting on Note links  (Read 3799 times)

PeteC

  • EA User
  • **
  • Posts: 91
  • Karma: +1/-0
    • View Profile
Reporting on Note links
« on: June 11, 2021, 05:43:23 pm »
I'm creating a documentation output of a section of a model. Looking at the Model Report has given me lots of inspiration on how I can do this in a complex way and is mostly working well, except for Notes.

On diagrams I may have general Note elements with no links and Note elements linked to specific elements. Where there is a link I would like to include in the report what element the Note is linked to.

I've done a simple experiment -  a State Machine diagram. On the diagram are two States and one Note. From one state I have a Transition relationship to the other State and also to the Note (yes I know that you can't transition to a Note! It's just an experiment). I also have a "Link" from the Note to the second State (using the Note's Quicklinker).

Using the Model Report template to generate output, under State1 it documents the outgoing behavioural links to State2 and Note. But under State2 it does not document any link to the Note.

Looking at the Model Report, it ultimately includes the Fragment Behavioural and that then includes fragments for various types of relationship including one called General Relationship. I would rather expect that the Link to a Note would appear under General Relationship.

Is there a way to report on the existence of a Note's Link?

In many cases I could (and probably will) include the contents of my Note in the Notes field of the relevant element, but in some cases the note is linked to more than one element and it would be more relevant to include as a Note and list in the document output which elements it is referring to.

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13387
  • Karma: +566/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Reporting on Note links
« Reply #1 on: June 11, 2021, 06:49:29 pm »
It is definitely possible.

I wouldn't look at the standard model report templates though, but simply build your own.

There might be a possibility that notelinks are for some reason excluded from the standard relationships documentation.
In that case you might need to look into creating an SQL fragment for it.

Geert

PeteC

  • EA User
  • **
  • Posts: 91
  • Karma: +1/-0
    • View Profile
Re: Reporting on Note links
« Reply #2 on: June 11, 2021, 09:48:59 pm »
Thanks for confirming that. For completeness: With a bit more digging and copying the built-in fragment, the "NoteLink" connector has been added into the Exclude list. Removing this it all works.

I have been crafting my own documents, but used the Model Report for reference (to see what can be done) and inspiration (in some cases to copy what I want) plus a small amount of re-use of the built-in fragments.