Evaluate SQL result as a Package in Document template

[Pawel Zubkiewicz]

Hi,

I'm wondering whether it is possible to find a Package via sql query and make EA recognize it as a Package in document template with all sections?

I have a fragment template and in custom query I've got this simple SQL for testing purpose:

Code: [Select]

SELECT t_package.ea_guid as CLASSGUID
from t_package
where t_package.ea_guid='{F3425580-C5F4-44f7-9F1D-0ED8F3CCB5D0}';
When I execute document generation of this fragment:

Code: [Select]

package >
{Pkg.Name}
diagram >
{Diagram.DiagramImg}
< diagram
child packages >
< child packages
< package
custom >
{CLASSGUID}
< custom
Only the part inside 'custom' tag is evaluated, the rest is ignored.

Is is possible to return via SQL a "full" Package so it will be evaluated with all its contents by the template?

[Geert Bellekens]

I always use a model document for things like that.

In model documents you can either drag a package on the model document, or use a search to specify the elements that need to be used.

Geert

[Pawel Zubkiewicz]

Yes, but they are less flexible even when ad-hoc generated as you presented in http://bellekens.com/2015/11/12/tutorial-generate-complex-documents-from-enterprise-architect-with-a-two-step-semi-automated-approach/

So, Geert, to your knowledge it's not possible to achieve that without model documents?

[Geert Bellekens]

No, I don't think so.

Geert

[Pawel Zubkiewicz]

I managed to workaround this problem by using Document Script fragment which is available since EA 12.1.1224 - so pretty new feature.

Sparx says in changelog:

Document Script fragments now available:
- Allows specifying a script to be called by the generator that will return the fragment contents as RTF
- Set template type in Template Document Options
- Use with DocumentGenerator LoadDocument and GetDocumentAsRTF for dramatically increase documentation flexibility

They are quite convenient, but poorly documented. Anyway,  finally after years (no kidding!), I managed to generate documentation in nonlinear way without using virtual documents. I'm using it to include MockUp diagrams into UseCase specification. Each UseCase is traced to particular Package that contains mockups diagrams. Those Mockups can be stored anywhere in the model - finally, there is no need to store mockups in same tree branch as the use case :-)

This gives a lot of freedom and flexibility in the way repository can be structured, no need to worry about documentation generation. Of course, I use this for Mockups, but it can be used for anything.

I think I will write a blog post about this to explain it better :-)

[Pawel Zubkiewicz]

Here is my promised blog post about document generation that combines SQL and Document Script templates/fragments. Nonlinear generation of documentation in Sparx Enterprise Architect.