Sunday, 27 December 2015 19:29

How to use the Enterprise Architect VBScript Library

Written by
Rate this item
(0 votes)

The Enterprise Architect VBScript Library is an open source library of VBScripts written to be used in Enterprise Architect.

This article explains how to download, import and use the library in Enterprise Architect.

Initial Import

Initial scripts

The Enterprise Architect VBScript Library contains some scripts to load and save scripts from/to your file system, but before we can use those we have to import an initial set of scripts to get started.

After downloading the file select menu option Project|Data Management|Import Reference Data and choose the downloaded file. Make sure to select Automation scriptsand click Import.

This will import the minimum set of scripts required to load other scripts from the file system



VBScript library initial script set
VBScript library initial script set

Download library from GitHub

From the Enterprise Architect VBScript Library project page on GitHub you can either choose to download the library as a zip file, or download the repository in GitHub desktop.

VBScript library github

Load library into Enterprise Architect

Select scripts folderOne of the scripts in the initial set is the scriptLoadScripts in the group Script Management. If you execute this script you can choose the library folder from the library downloaded from GitHub.

The script will then scan the entire folder tree and it will load any .vbs file it can find.

For starters it might be interesting to only load the Frameworks scripts as they have the most chance of being useful to anyone.

If the LoadScripts script finds a script that already exists in Enterprise Architect it will ask to overwrite the existing scripts.

In order to know in which group the script belongs it will look for a the group indicator in the script.

'[group=Script Management]

This will tell the script that this script should go in the group Script Management. If the script indicator is absent it will assume the group name is the name of the folder where it was found.

After loading the scripts into EA make sure to press the refresh button to make the scripts appear in the GUI.

Refresh script tree

Saving all your scripts

In the script management group there also a script to save all your scripts to the file system.

In order to control where the script should go you can add the path indicator to the script like this

'[path=\Framework\Tools\Script Management]

The path indicator will control where to place the script relative to the chosen folder.

If the path indicator is absent the name of the script group will be used as name of the folder.

Being able to save and load the scripts from/to the file system now allows us to use version control on these scripts.

The library structure

The library is structured in two main parts.

  • Projects
    Contains an assortment of various scripts written for various projects.
  • Framework
    Contains the framework scripts that are meant to be used by other scripts
    • Utils
      Contains helper scripts and classes such as TextFile, SQL, XML etc..
    • Wrappers
      Contains the wrapper classes for EA elements such as TaggedValue, Script, ScriptGroup

The scripts in the projects folder can be used for inspiration, but it is mainly the scripts in the Framework part that are useful when writing scripts.

Using the library

The first thing you need to do when you want to use any of the framework classes is to include the framework in your script

!INC Wrappers.Include

This will include the “Include” script that takes care of including all the other scripts of the framework, including those of the Utils folder.

Then you can use the classes defined in the library. For eaxample, if you want to have the user select a directory you can use following code

'get the folder from the user
dim folder
set folder = new FileSystemFolder
set folder = folder.getUserSelectedFolder("")

The classes in the library contain both properties as operations. You can use the properties as you would expect from “real” classes.

'show messagebox with the name of each subfolder
dim subfolders, subfolder
for each subfolder in folder.SubFolders
    msgbox "subfolder name: " & subfolder.Name


Have you written any VBScripts for Enterprise Architect you would like to share? If you would like to contribute to the Enterprise Architect VBScript library you can email me at This email address is being protected from spambots. You need JavaScript enabled to view it.

Read 12825 times Last modified on Sunday, 03 January 2016 22:27
Geert Bellekens

Geert Bellekens

Bellekens IT (Consultant)

Bellekens IT was founded in 2004 by Geert Bellekens and has a strong focus on UML, modelling and analysis methodology.

Geert Bellekens has helped several of the larger Belgian organizations to define and document their modelling method, train and coach the modelers and develop supporting tools.

Geert Bellekens is an acknowledged Enterprise Architect expert and has written numerous add-ins for Enterprise Architect, including the free open source EA Navigator and EA-Matic.

He is also one of the founding members and a regular speaker on the EA User Group events.


  • Comment Link Thierry Cordier Monday, 14 October 2019 15:01 posted by Thierry Cordier

    Using vbscript, I would like to change stereotype of connectors starting from selected elements on current diagram.
    All seems work except the appearance even after reloading the diagram.
    Will you please help ?

    Below an extract of my script:

  • Comment Link FatmaYB Thursday, 03 March 2016 10:42 posted by FatmaYB

    Hi Geert,
    Thank you very much for your feedback script.
    It's really helpful.
    I'm looking for a Zoom in out for diagram pages as we've created large diagrams.
    Thanks in advance for your help.


Login to post comments