Book a Demo

Author Topic: Glossary - how to help needed  (Read 4699 times)

skiwi

  • EA Expert
  • ****
  • Posts: 2081
  • Karma: +46/-82
    • View Profile
Glossary - how to help needed
« on: December 08, 2009, 10:55:24 am »
We are looking at maintaining a technical/business glossary in EA.
This would allow an individual document to excerpt individual terms from the shared glossary.

While there is a "Project Glossary" built into the tool (Project | Documentation | Glossary) its not clear to me how selected items from this could be included in an RTF document.

For use in one document only a "Glossary" package with a number of classes (artifacts) where the class name is the "term" and the note is the "definition" works well for document generation.

However
  • a link to the the "term" class from another document doesn't appear in a generated document
  • model documents work at the package level, rather than the class level, and it doesn't seem quite right to have every term being a package
How have other people addressed this?

tia

Simon
Orthogonality rules
Position and Team disestablished, thanks austerity.
Now itinerant.

nestevao

  • EA User
  • **
  • Posts: 38
  • Karma: +0/-0
  • I love YaBB 1G - SP1!
    • View Profile
Re: Glossary - how to help needed
« Reply #1 on: December 11, 2009, 01:50:37 am »
You may include a Glossary section in your RTF templates.

Unfortunately, I thinks there's no way to filter the glossary terms to include in the generated document as I don't see anything related with terms in the document option filters.

Katarzyna

  • EA Novice
  • *
  • Posts: 7
  • Karma: +0/-0
    • View Profile
Re: Glossary - how to help needed
« Reply #2 on: December 12, 2009, 06:57:58 am »
Currently I investigate precisely the same problem. My Business Object Model document should contain glossary of business terms only. I struggle for a while to create an appropriate RTF template, but without any success so far.
I managed to create SQL query that filters the  business terms:
SELECT t_glossary.Term, t_glossary.Meaning
FROM t_glossary
WHERE T_glossary.Type='Business'
but this query is not processed by a model document which I use as template for glossary terms. I run out of ideas and begin to believe that EA does not support this.

Dermot

  • EA Administrator
  • EA User
  • *****
  • Posts: 591
  • Karma: +7/-0
    • View Profile
Re: Glossary - how to help needed
« Reply #3 on: December 14, 2009, 12:30:53 pm »
To use Search queries in the RTF reporting make sure you stick to the the Note in: http://www.sparxsystems.com/uml_tool_guide/uml_modeling_tool_features/creating_filters.html
(Include in your select statement: ea_guid AS CLASSGUID, Object_Type AS CLASSTYPE).

Dermot

  • EA Administrator
  • EA User
  • *****
  • Posts: 591
  • Karma: +7/-0
    • View Profile
Re: Glossary - how to help needed
« Reply #4 on: December 14, 2009, 12:34:11 pm »
Also If you do want to vary away from the standrad Glossary format - I suggest you look at using a Package - "Glossary" or "Business Glossary" to define terms in Elements.  This gives many more options for your definitions - including using tagged Values.
« Last Edit: December 14, 2009, 12:34:47 pm by Dermot »