Documentation with the "Hyperlinks" diagram in Enterprise Architect?
I am trying to get all the necessary (and only necessary) information in the documentation of my Enterprise Architect project. Exactly: we modeled various requirements and mapped the original "standards" for those requirements in our diagrams using the "hyperlink" element from the common toolbar. (This allows us to capture the title, the site the documentation is on, and the description of that documentation).
Now this element is visible in the diagram, but not as a package of our model, and it is not generated in the documentation of our word (docx).
I see this can be obtained from the documentation because the "Model Report" which basically prints everything prints the hyperlinks. But I cannot find what I have to select in my template (in the package tree view, like package field, item field, or chart field) to get this printout. I can't just use the model report as it basically dumps the entire database in the document and reverse engineered this model report, which proved too complicated for me. Actually I would expect it to be some kind of documentation for EA, but can't find such a thing with this level of detail ... is there a reproducible way to find such things in further cases? (I'm using EA 11.0 by the way)
[sorry, there were illustrations here, but I can't download them ...]
source to share
As Geert pointed out, there is a difference between "correct" items and chart-only items. This is actually reflected in the Document Template Editor where the Chart section has an Element section inside . This will produce results for all chart elements, regardless of whether they are in the project browser.
Here is an example of information you can extract from your hyperlinks. For a hyperlinked chart:
... and a template that outputs the name, alias and hyperlink for each chart element:
... EA will create a document with the following content:
So, if you want the hyperlink to lead to a hyperlink in the document, use the HyperlinkAlias field.
What can be a little confusing is that, in addition to the hyperlink element type in the Common toolbar, EA diagrams allows you to create hyperlinks in regular elements (in the Element Properties dialog, Linked Tab: files that can be local files or web address).
In fact, I would recommend using those of your requirement items, not just graphical hyperlinks, if traceability is a priority in your model. On the other hand, chart-based hyperlinks give you a clearer visual representation.
Choosing a subset of the elements in the diagram ("just the information you want") is a little more involved and depends on how your model is structured. The template snippets will be executed, but you can achieve the desired result simply by using the filters in the document creation dialog.
source to share
A hyperlink is an element that is stored in the same package as the diagram being used, it simply does not appear in the project browser (similar to the note element).
There's a good chance it doesn't have a name, so make sure you don't omit unnamed items.
So, if you print the entire package element containing the diagram, you can also print the hyperlink.
In case of failure, you might want to create a template snippet based on an SQL query or script. They offer a lot of flexibility to print whatever you need, even if it's in a different package.
source to share
[Edited 5/4/15 to reflect Uffe's comment and provide a final solution]
Ok, based on Geerts answer using the following custom query snippet in the diagram section:
select
t_object.ea_guid as CLASSGUID,
t_object.Object_Type as CLASSTYPE,
t_object.Object_Id as OBJECTID,
t_object.name as HL_Name,
t_object.Stereotype as HL_Stereotype,
t_object.object_type as HL_Type,
t_object.Alias as HL_Alias,
Note as Notes
--,t_object.*
from t_object
left join t_diagramobjects on (t_object.Object_ID = t_diagramobjects.Object_ID)
left join t_diagram on (t_diagram.Diagram_ID = t_diagramobjects.Diagram_ID)
where t_diagram.Diagram_ID = '#DIAGRAMID#'
and t_object.Object_Type='Text'
I managed to get a list of hyperlinks by diagram, this is a snippet:
custom >
{HL_Alias}: {HL_Name}
{Notes}
< custom
"Notes" can be printed by getting the attribute directly from the t_object table. Don't be confused as I was at first: autocomplete on t_object and results (t_object. *) DO NOT SHOW the Note-Attribute, but it exists, when you write it to the query, it is generated to the document.
source to share