EA Project Glossary in the Add-In

[Dobrin]

Hello all,

I want to integrate a Project Glossary in an Add-In. Is that possible?

e.g I have an exported Glossary.xml file and I want to integrate it in the add-in so that it will be available for multiple projects.

Thank you in advance for your answer(s)!

Gruß,
Dobrin

[Geert Bellekens]

Yes

You can .
Here's what I use in my Excel importer

Code: [Select]

'-------------------------------------------------------------
' Author:   Geert Bellekens
' Date:     30/04/2013
' Description: adds or updates the Term with the given type,name
'   and meaning in the Glossary.
'-------------------------------------------------------------
Public Function addOrUpdateTerm(name As String, termType As String, meaning As String) As EA.Term
    Dim myTerm As EA.Term
    'try to find existing Term with the given name
    Set myTerm = getTermByName(name)
    If myTerm Is Nothing Then
        'no existing Term, create new
        Set myTerm = EARepos.Terms.AddNew(name, termType)
    End If
    'set properties
    myTerm.Type = termType
    myTerm.meaning = meaning
    'save Term
    myTerm.Update
    'refresh glossary collection
    EARepos.Terms.Refresh
    'return Term
    Set addOrUpdateTerm = myTerm
End Function

[qwerty]

You can import the XML via

Code: [Select]

xmlres = Respository.CustomCommand("Repository", "ImportRefData", sXML);It is also possible to fiddle around with the table t_glossary directly by using Repository.SQLQuery for reading and Repository.Execute for modifying it.

q.

[Dobrin]

Thank you guys. I'll try that and keep you posted.
Dobrin.

[Dobrin]

Thank you guys. I'll try that and keep you posted.
Dobrin.

I do not know if I have formulated the correct question..
So I only want to install an existing glossary.xml file so that it will be available for all the projects.
Is there any way to do that using C# add-in for EA? Do I have to parse all the file to retrieve the type, meaning, etc... and then create new terms?

Is there a way to call the "Import Reference Data" from Project--> Model Import / Export ?

Thanks,
Dobrin

[qwerty]

Sure. It's a menu option. Right where you exported it.

q.

[Dobrin]

Sure. It's a menu option. Right where you exported it.

q.

Yes, that I knwew.
You can acces the EA menu from the Add-in in order to do that each time project is opened (e.g on EA_Connect function)?

Dobrin

[qwerty]

There is no API to control what is in the menus. Just (some/most?) functions are also available via API. E.g. you can import reference data like described above. For other menus you'd need to hack Windoze (IIRC there's a thread where someone described how he did that). You may catch the EA_FileOpen event in order to perform things when a repository is opened.

I wonder if that makes sense for the glossary. It's loaded once and only if a new version is available it should be reloaded. So definitely not at each opening. If you use a shared model it wouldn't make sense anyway.

q.

[Dobrin]

There is no API to control what is in the menus. Just (some/most?) functions are also available via API. E.g. you can import reference data like described above. For other menus you'd need to hack Windoze (IIRC there's a thread where someone described how he did that). You may catch the EA_FileOpen event in order to perform things when a repository is opened.

I wonder if that makes sense for the glossary. It's loaded once and only if a new version is available it should be reloaded. So definitely not at each opening. If you use a shared model it wouldn't make sense anyway.

q.

So then I could use the above method to import the glossary into the add-in and after that, parse the data in order to add new terms in the dictionary?

Yes the glossary will be loaded once, and then maintained.. so I do not need to do this all the time.

Thanks,
Dobrin

[qwerty]

The method in my first post will read the entire glossary as the Import menu would have done. You supply the XML as string parameter.

q.