Displaying items by tag: vbscript

 Use C#, Java from your EA Context Menu:

This works for all EA Versions, even without Administration rights to install an Add-In or so.

EA Version 13 supports an IDE to develope in C# and Java with full EA API support and debugging. They name it Hybrid Scripting. You may use the EA 13 Hybrid Script environment or other IDEs. Going the first steps is easier with EA 13.

This article shows you with a little example how to use C# for your Scripting. After you have understood C#, it should be easy to use Java in a similar way. The main idea is to use a small wrapper you call within your VB Script. Of course, after you have understood it's also easy to write this little wrapper for JavaScipt/JScript. 

SPARX delivers two DLLs to use the EA API efficiently. With these DLLs, you can use the EA Hybrid development environment as well as any other IDE you like most. In other words: You can use the power of state of the art languages to perform your scripting. Integrating Scripting in EA is as easy as you know it from the well-known Scripting Languages VB Script, JavaScript, JScript. This without installing anything or needing Admin rights.

Just insert the line:

• 'RunCommand("myLogic.exe, "", " ")'

in your VB Script and you are done with VBScript to call your C#. Java would be similar.

Let's make a quick example with EA Version 13 and C#:

Make an EA C# ConsoleApplication

• Create a new EA Project
• Create a Package ('Select and Apply Model Pattern')
  • C#, RepositoryInterface 4.0
  • c:\temp\hybrid
• Build the Application
• Have a look in the generated Application
  • c:\temp\hybrid\RepositoryInterface 4.0\

Import VBScript wrapper to call C# 

• Configure, Transfer, Import Reference Data
• Make EA Scripting visible 
  • Code, Scripting (you may have to refresh Scripts)
• You see the new VB Scripts inside the ScriptGroup HybridScripting:
  • RunCommand
  • RunCommandTest

Run C# ConsoleApplication.exe

• Adapt VBScript RunCommandTest
  • Adapt path to 'ConsoleApplication.exe'
• See
  • Line:28/29 Needed references
  • Line:35      Path to *.exe which executes your logic
  • Line:36      The call of the wrapper, result contains the StandardOutput of the Script
• Run VBScript RunCommandTest
  • Right Click on RunCommandTest
  • Run Script

How do you use it

There are two approaches: Generates you VB Script by inserting the the wrapper Call in the EA templates at the appropriate location. The other way is to remove the template and just call the wrapper like

'result = RunCommand("myLogic.exe, "", " ")'

instead of the using the template scuffold.

Under the hood

EA delivers the two dlls:

• Interop.EA.dll
• SparxSystems.Repository.dll

They expect the Process ID, first parameter, to know which EA Instance the *.exe wants to use. So, RunCommands makes:

• Estiminate the own Process ID
• Call 'RunCommand...'
• Reads the Standard output from your *.exe
• Returns to Standard output to the caller

Inside the *.exe you have full access to the EA API.

JavaScript, JScript, Java?

With this example it's easy to migrate 'RunCommand' to JavaScript or JScript. Remember, you can use every Language supported by EA and every IDE you like most.

References

• SPARX Webinar Hybrid Scripting
  • http://www.sparxsystems.com/resources/webinar/release/ea13/videos/hybrid-scripting.html
• SPARX Tutorial Hybrid Scripting
  • http://www.sparxsystems.com/resources/user-guides/automation/hybrid-scripting.pdf
• hoTools Hybrid Scripting
  • https://github.com/Helmut-Ortmann/EnterpriseArchitect_hoTools/wiki/HybridScripting
• RunCommand.vbs (The wrapper to call your C#, Java,..)
  • https://github.com/Helmut-Ortmann/EnterpriseArchitect_hoTools/blob/master/HybridScripting/vb/RunCommand.vbs
• RunCommandTest.vbs (An Example with EA example C# Hybrid Script ConsoleApplication.exe, see Tutorial )
  • https://github.com/Helmut-Ortmann/EnterpriseArchitect_hoTools/blob/master/HybridScripting/vb/RunCommandTest.vbs

"VBScript and JScript require the Microsoft Process Debug Manager (PDM.dll) to be installed on the local machine; this is available through various Microsoft products including the free 'Microsoft Script Debugger'"

(refer to: http://sparxsystems.com/enterprise_architect_user_guide/13.0/automation/debug_scripts.html)

The issue is: Microsoft Script Debugger as is - is depricated and here is the list (not complete for sure), where PDM is part of:

* Office 2000-2007

* Visual Studio

* Visual Studio Remote Tools (PDM stays installed even after uninstall of the Remote Tools)

Depending on the used operating system of Microsoft you will find Process Debug Manager (PDM.DLL) in the following folders:

Windows Vista, Windows 7, Windows 8, Windows 8.1 (64bit)

C:\Program Files (x86)\Internet Explorer\pdm.dll

Windows Vista, Windows 7, Windows 8, Windows 8.1 (32bit)

C:\Program Files\Internet Explorer\pdm.dll

Windows 10 _before_ v1607

Windows 10 (64bit)

C:\Windows\SysWow64\F12\pdm.dll

Windows 10 (32bit)

C:\Windows\System32\F12\pdm.dll 

This file (pdm.dll) must be registerd manually using regsvr32.

Windows 10 v1607:

in this version manual installation of pdm.dll is not possible anymore. So you have to install a Microsoft Product that contains PDM.dll.

I recommend using the "Remote Tools for Visual Studio 2015 Update 3"

32bit: https://go.microsoft.com/fwlink/?LinkId=615469&clcid=0x407

64bit: https://go.microsoft.com/fwlink/?LinkId=615470&clcid=0x407

After installation you can uninstall them - because PDM.DLL resists and can be used by Enterprise Architect.

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

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

€0.00

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.

Load library into Enterprise Architect

One 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.

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.

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

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

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

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

Contributing

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.

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.

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.

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

Trace to Domain Model script

€0.00

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.

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

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.

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.

Here’s the complete code for the script.