Introducing SER

-
SER stands for Sparx systems Enterprise architect Repository.  This is an open source repository on Github which can be found here.

The main reason for creating the repository is that I have created a number of resources for EA over the years, and I didn't have a proper way or place to manage them.  Additionally, the idea is that in open sourcing these resources, then it would be easier to use them in any organisation that I may work for in the future.

The naming of the repository is deliberate in that it does not refer specifically to me, in that it does not use my name.  In not branding the repository to me, I aim to make the repository as accessible as possible in the hope that others may contribute to it in the future.  The open source license that I have used is the Apache 2.0 license, owned by me, but I would be happy to transfer it to an Apache Foundation style organisation if such a thing was possible in the future.  And if all fails, the repository can just remain as a place where I keep my stuff (technically speaking).

I'd like to keep all EA related resources in the repository.  Plugin sources are an obvious thing to include in it.  I'm also planning to store within-EA resources.  For example, scripting files, profiles, templates, etc, which will most likely be exports from EA.  I haven't decided on docs, spreadsheets and other non-code artefacts, but these will probably also be stored in the repository.

I've played with the idea of making an EA repository available from AWS and hence making these resources available through EA rather than Github, but there is a cost involved in hosting it in AWS.  Also I'm reluctant to open such a thing to the internet, dealing with performance/stability concerns as well as security.  So anyway, just a stray idea at this very moment.

To begin with the SER repository will have the following.
  • ~/src/main/scripting - A set of jscript/javascript modules which I have developed over time.  Mainly utility modules that you can build your own scripts on top off.  Includes utilities for namespacing, logging and a unit test framework.
  • Ser.Aws - An AWS plugin for EA.  Written in C#.  I'll provide a description of this in a separate blog.
Please let me know if there is anything else that you think could also be included in the repository, or if you would like to contribute to it.

[Originally posted here.]

Comments

Post a Comment

Popular posts from this blog

Creating Items in Sparx EA via Java

-
Introduction This short post provides guidance on how to create "things" in a Sparx EA model via the Java API. Theory Creating "things" in EA via Java is driven by the Add New method and the Collection class. The first example in the code is adding a "view" to an existing root node. The code below will retrieve the root GUID if the "i" variable is set to 0; rootPackageID = rep . GetModels (). GetAt ( i ). GetPackageGUID (); After obtaining the root GUID it is possible to create a view under the root node. Note the process of retrieving the packages under the root and placing them in a collection. The Add New process is driven from the Collection. Importantly, for a view, the code needs to set a flag which indicates a particular icon. This process is only required for views. org . sparx . Package root = rep . GetPackageByGuid ( rootPackageID ); // get the root Collection < org . sparx . Package > subPackages = r...
Read more

Flexible Method Pattern

-
This is the first in a series of posts on some of the coding patterns that I have been using with Peso .  I use the term 'pattern' loosely, referring to common code patterns that are repeated through out the implementation of the framework. The intent of the Flexible Method Pattern is to give callers of the framework functions/methods as much flexibility as possible, minimise the amount of boiler plate code required to use the framework, and keep the code as streamlined and simple as possible.  This pattern is made up of two parts. Type Specific Handling Often we might need to have the same logical operation being performed, pretty much the same way, for two or more different types corresponding to the same logical input. For example, a common operation is to retrieve an element given an ElementID or an ElementGUID.  There are two different methods on the Repository object to do this.  In the framework we can do a bit better than this.  We can write ...
Read more

Traversing a EA Model via Java

-
Traversing an Enterprise Architect model from Sparx Systems is relatively simple. This blog introduces the concept of model traversal via the Java API. For information on Java Set-Up see this blog entry . The first step is to obtain the repository object as it provides the anchor from which all other operations are derived. In the example below, a repository is held on the file system. The variable "repoLocation" holds the file system location of the "eap" file.   rep = new Repository();  // get a repository   rep.OpenFile(repoLocation);  //open the repository file At the top of a model is a root node and it is typically where you want to start when traversing a model. From the root node you can then obtain a collection of packages. At this point, it is easy to traverse the collection pulling in the packages via a loop and in this example printing out their names. To see the complete example, go to GitHub .   org.sparx.Package my...
Read more