Sparx Systems Forum

Enterprise Architect => Automation Interface, Add-Ins and Tools => Topic started by: J.D. Baker on February 27, 2022, 07:32:10 am

Title: Review Report
Post by: J.D. Baker on February 27, 2022, 07:32:10 am

I'm looking for some help on how to compile a document that includes the result of one or more reviews.  We need to be able to provide the results of a review to SMEs and management who for whatever reason can't explore the model contents.  So far the best I can do is write a SQL query but I'm hoping there is a better solution.

Title: Re: Review Report
Post by: Sunshine on February 27, 2022, 08:57:13 am

Have a look at the publishing manuals.
https://www.sparxsystems.com/resources/user-guides/15.2/index.html#publish (https://www.sparxsystems.com/resources/user-guides/15.2/index.html#publish)
It provides instructions on creating charts, documents etc.
If you want to put your SQL into a word document then have a look at Template Fragments in https://www.sparxsystems.com/resources/user-guides/15.2/publish/document-reports.pdf (https://www.sparxsystems.com/resources/user-guides/15.2/publish/document-reports.pdf)
You can generate MS Word docs with templates. If you want to produce a document with lots of different sections formatted differently such as one with tables and another with header sections then you can use virtual documents which is basically a collection of templates referencing different packages with in the model.
The hierarchy of document generation is something like this where you can generated a report from document template that can include template fragments.
Virtual Document
   Document Template
      Template Fragments

Hope that helps

Title: Re: Review Report
Post by: J.D. Baker on February 28, 2022, 08:28:27 am

Thanks for the reply.  I have created a number of reports over the years and I am familiar with templates and fragments.  What I need specific help with is reporting on the information captured during a Review.  That information does not appear to be exposed in the Object Model - at least I haven't found it.  I can expose the information by opening the EA project in Access but that option is not going to work with EA 16, so I'm hoping to find a more robust option.

Title: Re: Review Report
Post by: Geert Bellekens on February 28, 2022, 04:22:58 pm

you can use SQL fragments in your templates to get the information from the reviews into a document.

Geert