Documentation - Links to embedded items

[Luigi2021]

Hi,

After struggling for a while I finally got my document generation working including links to specific items. Now I wonder if it’s possible to link to “embedded” items as well. In my case I would like to link to items in the “t_objecttests” table. The reason that I want this is that I want the tests to be in another part of my documentation then the requirements.

Thanks in advance!

Kind regards,

Luigi

[PeteC]

Within the document template editor, there is a section under Package -> Element called Embedded Elements and there is also one called Child Elements. Depending how you have built the model, does either of those help?

When I recently wanted to improve my documentation output I initially used the Model Report to see what was generated and replicated the bits I needed in my own templates. It looks the Model Report attempts to document everything so I found it a good way to see what was possible - if it appears in the output from that, then there is clearly a way to report on it.

[Luigi2021]

I am not sure if I understand you answer correct. The problem is not that I don't know how to report the embedded elements. The problem is that I don't know if it's possible to link to the embedded elements and if it's possible how to do it.

What I want is this:

Requirments Chapter:

REQ.0001 Some Requirement (References TST.1234, TST.1235) <== I want that the references are links to the specific TST item in the Tests chapter.
REQ.0002 Some Other Requirement (References TST.1236, TST.1237)

Some other chapter:
Bla bla bla

Tests Chapter:
TST.1234
TST.1235
TST.1236
TST.1237

[PeteC]

So it looks like you are trying to report on elements related to another by some relationship.

There is a section in the document template for "external requirements" - it's not clear to me what information that is extracting from the description in the document reports guidance. For me it does extract requirements that are linked to blocks but I don't know why or how EA decides to include objects so whether it will report on tests linked to requirements is not clear to me.

It might just be worth generating a document from your Requirements package using the Model Report and also the Requirements Report - Details templates - if they produce the output that you want (but not necessarily in your desired layout) then it will be clear that you can get the output directly from EA.

There may be some other built-in way to extract that I am not aware of, but if there isn't then it is possible to write a script to extract information based on the element (so your script will be given the requirement that is being reported on and you can write a script that will return the tests that are referenced by the requirement). I know that will work as I have used scripts to extract info from related elements when creating a report on requirements.

[Luigi2021]

Thank you for your tips! If I find some solution I will post it here. Thanks again!