Book a Demo

Author Topic: Report on Linked Document of Target Element  (Read 2896 times)

Daniel Malherbe

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
  • systems engineer
    • View Profile
Report on Linked Document of Target Element
« on: June 18, 2015, 10:38:30 pm »
Is it possible to report on the linked document of a target element?

I am using the .rtf document generator to report on Use Case elements. Some custom generic information (that, in some cases, include tables and diagrams) need to be linked to use cases. It is important to re-use this custom information among different Use Cases. I created Document Artifact elements to stored the generic information as Linked Documents. The Document Artifacts are then related to Use Cases as necessary.

When the rtf generator reports on a Use Case element, how can I get it to report on the Document Artifact Linked Document? Can this be done with a template fragment / custom script? If so, examples will be very helpful.
do not underrate the value of natural language

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Report on Linked Document of Target Element
« Reply #1 on: June 18, 2015, 10:50:52 pm »
I would probably create a model document for these elements. You use a search in the model document that returns the linked document artifacts based on the use case you are using.

Put this model document together with the "main" model document for your use case into a master document package and "voila" you can generate a document that includes both the use case details as the linked document artifacts linked documents.

For extra bonus points: Write a script that creates the whole master document/model document structure at the press of a button for a selection of use cases or other elements.

Geert

Daniel Malherbe

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
  • systems engineer
    • View Profile
Re: Report on Linked Document of Target Element
« Reply #2 on: June 18, 2015, 11:01:57 pm »
Thanks Geert,

Just to clarify, "create a model document for these elements". The Use Case elements or the Document Artifact elements?

Also, how do I use a search in a model document to return the linked document artifacts based on the use case I'm using? Can this be done with the Linked Document section of the associated document template or do I need to develop a query / script for this?

Do you mean "nesting" model documents. I have not tried that - will do so now and see what happens.
do not underrate the value of natural language

Geert Bellekens

  • EA Guru
  • *****
  • Posts: 13523
  • Karma: +574/-33
  • Make EA work for YOU!
    • View Profile
    • Enterprise Architect Consultant and Value Added Reseller
Re: Report on Linked Document of Target Element
« Reply #3 on: June 18, 2015, 11:12:18 pm »
Hi malherbe,

I meant create a model document for the document artifacts.

Look in the help file for "Virtual Documents"

In the tagged values of the model document you can define a template, a search and a search term. The search and the search term are used to define the elements being reported for this section.

So you can define a search (I would go for an SQL search) that returns the document artifacts linked to a certain use case. Then in the search value you can enter the GUID of the usecase or something like that.

Geert

Daniel Malherbe

  • EA Novice
  • *
  • Posts: 3
  • Karma: +0/-0
  • systems engineer
    • View Profile
Re: Report on Linked Document of Target Element
« Reply #4 on: June 18, 2015, 11:23:47 pm »
Thanks Geert, time to dig in and get my hands dirty. I may reply again... after I've learned something.
do not underrate the value of natural language