Automatically trace elements to domain model in Enterprise Architect

Enterprise Architect version 15.2

My Profile

Help

Hot Topics

Top Community Contributors

Extending the ArchiMate metamodel in Enterprise Architect
Written by Bert Dingemans

Social Media Channels

Tuesday, 17 November 2015 04:08

Written by Geert Bellekens

font size decrease font size increase font size
Print
Email

Rate this item

(2 votes)

This script will search the text in the comments, scenario’s and linked document of the selected elements for terms in the domain model. If it finds a match it will create a trace from your selected element to the element in the domain model.

The idea is that when we write descriptions and scenario’s we often use terms already defined in the domain model, so it would be good if we had a real trace from the element in the domain model and the element using it in its description.

Link to domain model example

But it is hard to keep the descriptions and scenario’s in sync with the traces to the domain model. This script does the hard part for us and keeps those traces in sync. All you need to do is type your description and run the script. The script will find the referenced elements in the domain model and create a trace link to it. It will also remove any automatic traces that are not valid anymore.

Next to the Name, Notes, and the Linked Document, this script will also search the scenarios, both theScenario Description, as the structured Scenario Steps. In case of a Scenario Step the script will insert to the name of the domain model element in the Uses column. Link to domain model scenario

Note that the script is case sensitive. That is the reason why RoomType does not appear in the uses column. Enterprise Architect itself isn’t that picky, and it underlines Roomtype anyway because it finds a relationship to RoomType.

In order to execute the script you have to select either one or more elements in the project browser, or select a package in the project browser.

Then select Script|Link To Domain Model

Free download

The script

In the first part we ask the user to select the domain model package.
If you want to use this script on a particular model you may want to replace that by a hard coding the Domain models GUID into the script.
Since this script may run for a while on a large model, we also create an output tab so we can inform the user of our progress.

sub main
    'let the user select the domain model package
    dim response
    response = Msgbox ("Please select the domain model package", vbOKCancel+vbQuestion, "Selecte domain model")
    if response = vbOK then
         
        dim domainModelPackage as EA.Package
        set domainModelPackage = selectPackage()
        if not domainModelPackage is nothing then
            Repository.CreateOutputTab "Link to Domain Model"
            Repository.ClearOutput "Link to Domain Model"
            Repository.EnsureOutputVisible "Link to Domain Model"
            'link selected elements to the domain model elements
            linkSelectionToDomainModel(domainModelPackage)
            'tell the user we are done
            Repository.WriteOutput "Link to Domain Model", "Finished!", 0
        end if
    end if
end sub

Next we create a dictionary of all classes in domain model package and all of the sub-packages recursively.

'first get the pattern from all the classes in the domain model
dim dictionary
Set dictionary = CreateObject("Scripting.Dictionary")
 
'create domain model dictionary
'tell the user what we are doing
Repository.WriteOutput "Link to Domain Model", "Creating domain model dictionary", 0
addToClassDictionary domainModelPackage.PackageGUID, dictionary

Based on this dictionary we can create one large Regular Expression that will tell us which of the terms in the dictionary are used in a certain text.

' and prepare the regex object
dim pattern
'create the pattern based on the names in the dictionary
pattern = createRegexPattern(dictionary)
Dim regExp  
Set regExp = CreateObject("VBScript.RegExp")
regExp.Global = True  
regExp.IgnoreCase = False
regExp.Pattern = pattern

Then we check what is selected in the project browser. If the user has selected one or more elements we start process those elements. If a package is selected then we process the elements in the selected package.

' Get the type of element selected in the Project Browser
dim treeSelectedType
treeSelectedType = Repository.GetTreeSelectedItemType()
' Either process the selected Element, or process all elements in the selected package
select case treeSelectedType
    case otElement
        ' Code for when an element is selected
        dim selectedElements as EA.Collection
        set selectedElements = Repository.GetTreeSelectedElements()
        'link the selected elements with the 
        linkDomainClassesWithElements dictionary,regExp,selectedElements 
    case otPackage
        ' Code for when a package is selected
        dim selectedPackage as EA.Package
        set selectedpackage = Repository.GetTreeSelectedObject()
        'link use domain classes with the elements in the selected package
        linkDomainClassesWithElementsInPackage dictionary, regExp,selectedPackage
    case else
        ' Error message
        Session.Prompt "You have to select Elements or a Package", promptOK
end select

Here’s the complete code for the script.

option explicit
 
!INC Local Scripts.EAConstants-VBScript
 
'
' Script Name: Link to Domain Model
' Author: Geert Bellekens
' Purpose: Link elements with classes in the domain model based on their name.
' Date: 15/11/2015
'
 
 
sub main
    'let the user select the domain model package
    dim response
    response = Msgbox ("Please select the domain model package", vbOKCancel+vbQuestion, "Selecte domain model")
    if response = vbOK then
         
        dim domainModelPackage as EA.Package
        set domainModelPackage = selectPackage()
        if not domainModelPackage is nothing then
            Repository.CreateOutputTab "Link to Domain Model"
            Repository.ClearOutput "Link to Domain Model"
            Repository.EnsureOutputVisible "Link to Domain Model"
            'link selected elements to the domain model elements
            linkSelectionToDomainModel(domainModelPackage)
            'tell the user we are done
            Repository.WriteOutput "Link to Domain Model", "Finished!", 0
        end if
    end if
end sub
 
'this is the actual call to the main function
main
 
function linkSelectionToDomainModel(domainModelPackage)
    'first get the pattern from all the classes in the domain model
    dim dictionary
    Set dictionary = CreateObject("Scripting.Dictionary")
     
    'create domain model dictionary
    'tell the user what we are doing
    Repository.WriteOutput "Link to Domain Model", "Creating domain model dictionary", 0
    addToClassDictionary domainModelPackage.PackageGUID, dictionary
     
    'tell the user what we are doing
    Repository.WriteOutput "Link to Domain Model", "Interpreting dictionary", 0
    ' and prepare the regex object
    dim pattern
    'create the pattern based on the names in the dictionary
    pattern = createRegexPattern(dictionary)
    Dim regExp  
    Set regExp = CreateObject("VBScript.RegExp")
    regExp.Global = True  
    regExp.IgnoreCase = False
    regExp.Pattern = pattern
     
    ' Get the type of element selected in the Project Browser
    dim treeSelectedType
    treeSelectedType = Repository.GetTreeSelectedItemType()
    ' Either process the selected Element, or process all elements in the selected package
    select case treeSelectedType
        case otElement
            ' Code for when an element is selected
            dim selectedElements as EA.Collection
            set selectedElements = Repository.GetTreeSelectedElements()
            'link the selected elements with the 
            linkDomainClassesWithElements dictionary,regExp,selectedElements 
        case otPackage
            ' Code for when a package is selected
            dim selectedPackage as EA.Package
            set selectedpackage = Repository.GetTreeSelectedObject()
            'link use domain classes with the elements in the selected package
            linkDomainClassesWithElementsInPackage dictionary, regExp,selectedPackage
        case else
            ' Error message
            Session.Prompt "You have to select Elements or a Package", promptOK
    end select
end function
 
'this function will get all elements in the given package and subpackages recursively and link them to the domain classes
function linkDomainClassesWithElementsInPackage(dictionary,regExp,selectedPackage)
    dim packageList 
    set packageList = getPackageTree(selectedPackage)
    dim packageIDString
    packageIDString = makePackageIDString(packageList)
    dim getElementsSQL
    getElementsSQL = "select o.Object_ID from t_object o where o.Package_ID in (" &amp; packageIDString &amp; ")"
    dim usecases
    set usecases = getElementsFromQuery(getElementsSQL)
    linkDomainClassesWithElements dictionary,regExp,usecases
end function
 
 
function linkDomainClassesWithElements(dictionary,regExp,elements)
    dim element as EA.Element
    'loop de elements
    for each element in elements
        'tell the user what we are doing
        Repository.WriteOutput "Link to Domain Model", "Linking element: " &amp; element.Name, 0
        'first remove all automatic traces
        removeAllAutomaticTraces element
        'match based on notes and linked document
        dim elementText
        'get full text (name +notes + linked document + scenario names + scenario notes)
        elementText = element.Name
        elementText = elementText &amp; vbNewLine &amp; Repository.GetFormatFromField("TXT",element.Notes)
        elementText = elementText &amp; vbNewLine &amp; getLinkedDocumentContent(element, "TXT")
        elementText = elementText &amp; vbNewLine &amp; getTextFromScenarios(element)
        dim matches
        set matches = regExp.Execute(elementText)
        'for each match create a «trace» link with the element
        linkMatchesWithelement matches, element, dictionary
        'link based on text in scenariosteps
        dim scenario as EA.Scenario
        'get all dependencies left
        dim dependencies
        set dependencies = getDependencies(element)
        'loop scenarios
        for each scenario in element.Scenarios
            dim scenarioStep as EA.ScenarioStep
            for each scenarioStep in scenario.Steps
                'first remove any additional terms in the uses field
                scenarioStep.Uses = removeAddionalUses(dependencies, scenarioStep.Uses)
                set matches = regExp.Execute(scenarioStep.Name)
                dim classesToMatch 
                set classesToMatch = getClassesToMatchDictionary(matches, dictionary)
                dim classToMatch as EA.Element
                for each classToMatch in classesToMatch.Items