Installation

This installation guide details the process for installing Essential Architecture Manager in the Stand Alone mode. Stand Alone Workstation / Notebook

Essential Architecture Manager is delivered as a single ZIP file containing all the software from the Essential Project and is for use on all computing platforms, Windows, Mac OS X, Linux, Unix. This installation guide takes you through the process of installing and configuring all the pre-requisite software, such as Protege and Apache Tomcat, and then installing the Essential Architecture Manager software.

 
A useful blog article is available which can help with the configuration of some of the software pre-requisites. You can read the article here

Components to install

The following components are required to install Essential Architecture Manager.
  • Protege. This is the core modelling tool platform for Essential AM. The "Full Protege" package is recommended.
  • Essential Widgets. A set of extension components from the Essential Project that are plugged into Protege. These include:  
    • AutoTextWidget
    • ReportTabWidget 
  • Apache Tomcat. The application server environment for running the Essential Viewer software.
  • Essential Viewer
  • Essential Meta Model. The core meta model and base repository for Essential Architecture Manager.

1. Download

Essential Architecture Manager ZIP file downloadedHaving downloaded the essential_architecture_manager.zip from the Download section, please check that you have the software pre-requisites available.

2. Unpack Downloaded Essential Architecture Manager file

Unpack the essential_architecture_manager.zip file, which will contain 7 files;
  • essential_widgets.zip
  • essential_viewer.war
  • essential_metamodel.zip
  • shutdown_protege_server.bat (only used for Windows installations)
  • COPYING.txt (the license for Essential Architecture Manager)
  • README.txt
  • releaseNotes.txt
Essential Architecture Manager ZIP unpacked

3. Java Runtime Environment

Before starting the install of Protege, confirm whether or not a JVM has been installed. From a command prompt, type:
java -version
The resulting message from Java should show a JVM version at or above version 1.5.x. If a JVM is already present that meets the required version, there is no need to install the JVM that is provided with Protege.

4. Install Protege

If you have not already installed Protege, install it by running the installation program.
 

4.1 Microsoft Windows

The following steps should be followed to install Protege on a Microsoft Windows Platform.
  • Run the install_protege.exe file. 
  • Select the option to install "Everything" as this will include the optional tab widgets that may prove useful at a later date, e.g. Prompt, Jambalaya.
  • Select the installation folder, preferably take the default in Program Files\Protege_x.x.x
  • Select the JVM that Protege should use. If from Step 3, a suitable JVM (version 1.5 or above) has already been installed, select that JVM.
    • Select either from the list show or find the version discovered in Step 3 using the "Choose Another" button. This may require investigation of the Java Control Panel in the Windows Control Panel. NOTE: You must select the specific java.exe file to use.
  • Select 'Next' until the installation completes.
 

4.2 Other platforms - Mac OS X, Linux, Unix

Run the Protege installer for your platform and follow these steps:
  • Select the option to install "Everything" as this will include the optional tab widgets that may prove useful at a later date, e.g. Prompt, Jambalaya.
  • Select the installation folder, preferably take the default 
  • Select the JVM that Protege should use. If from Step 3, a suitable JVM (version 1.5 or above) has already been installed (this will be the case on Mac OS X), select that JVM.                                     
    • Select either from the list shown or find the version discovered in Step 3 using the "Choose Another" button.
  • NOTE: You must select the specific java.exe file to use.
  • Select 'Next' until the installation completes.

 

4.3 Configure Protege

Please open Protege now.

  • Go to the 'File' menu and select 'Preferences'.
  • Un-select the option 'Sort class tree (Classes Tab)' to ensure that the Essential Meta Model class hierarchy is shown in the correct order.
  • Click OK and exit Protege.
This configuration is not required in Protege 3.3.1 and the preference is not available

5. Essential Widgets

Microsoft Windows platforms: Extract essential_widgets.zip to the <Protege_Install>/plugins directory (where <Protege_Install> is the location where you installed Protege in Step 3).

All other platforms: unpack or uncompress essential_widgets.zip.

This will create a directory, called com.enterprise_architecture.essential.widgets, in which the Essential Widgets are stored.

Microsoft Windows: This will be in the <Protege_Install>/plugins directory already (assuming you extracted it directly to this directory). If you have extracted the ZIP file anywhere else, simply copy the directory as follows for all other platforms.

All other platforms: Simply copy the com.enterprise_architecture.essential.widgets folder into <Protege_Install>/plugins.

Installing the Essential Widgets - screenshot

6. Apache Tomcat Java Application Server

If you do not already have Tomcat (or an alternative Java Application Server that can run Java Servlets) installed, please install it by running the installation program for your platform.

Install Apache Tomcat by running apache-tomcat-5.x.x.x.exe, which will ask for the location of your preferred Java Virtual Machine (JVM).

Like Protege, Tomcat requires Java v1.5 or above. For simplicity, select the same JVM that was selected Essential Architecture Manager Installation Guide during the Protege installation. In this case when prompted by the Tomcat installer, select the path to the folder "jre".
 

 

6.1 Remove POST size limit

When the repository is published from the Essential Modeler (Protege running an Essential project) to the Essential Viewer, a snapshot of the repository is sent to a Servlet running on Tomcat. The repository can get large, so Tomcat must be configured to accept large amounts of data being sent to it.
Edit the <Tomcat>/conf/server.xml file as follows:
  • Find the <Connector> tag entry for the HTTP 8080 connector
  • Add the maxPostSize="" attribute and value to this tag such that it looks like:
<Connector port="8080"
 maxHttpHeaderSize="8192"
 maxThreads="150"
 minSpareThreads="25"
 maxSpareThreads="75"
 enableLookups="false"
 redirectPort="8443"
 acceptCount="100"
 connectionTimeout="20000"
 disableUploadTimeout="true"
 maxPostSize="0" />

7. Install Essential Viewer

Deploy the essential_viewer.war to your Tomcat (or other Java Server). You can do this by:
  • Copying essential_viewer.war to the <Tomcat>/webapps directory
  • Deploying the essential_viewer.war via the Tomcat Manager web page.
If you want to share your Essential Viewer with others in your organization, you can deploy the Essential Viewer to an instance of Tomcat that is running on a network server, using the same steps described above.

8. Install the Essential Meta Model

Both the meta-model and the model for Essential Architecture Manager are contained in the repository which is controlled from a Protege project file, and has the file extension, .pprj
 

Installing the base repository

Create a directory to hold the meta-model and model configuration files. In stand-alone mode, we recommend using the file-based datastore for the repository. This directory will also contain the data files for the model and meta-model. Create a directory for your repository, e.g.
  • /EssentialAM/Repository
Unpack the file essential_metamodel.zip and copy the files into your new repository directory. The file that you will open with Protege is essential_baseline_v1.pprj.
Essential Meta Model Unpacked screenshot

Installation Complete

Your stand-alone installation of Essential Architecture Manager is now complete. Now go to the Getting Started Tutorials to find out more about capturing and analysing your architecture with Essential Architecture Manager.

The Essential Baseline repository is an empty project in which you can start capturing details of your architecture. Download and explore the latest Sample Repository for an example of how to use Essential Architecture Manager.