Sponsor Link: EAS Training - Get training in the Essential toolset. Register your interest now. Read more
     
Home Documentation Installation Multi-User Installation
Multi-User Installation PDF
This installation guide details the process for installing Essential Architecture Manager in the Multi User mode. Multi User Install - Client Server

Essential Architecture Manager is delivered in a single Java Archive (JAR) 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.

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 (Essential Architecture Reporting tab)
  • JDBC Drivers. The relevant JDBC driver for the database server that you are using.
  • 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.
In Multi User Mode, Essential Architecture Manager operates in a client-server configuration:
  • Client software components:
    • Protege
    • Essential Widgets
  • Server software components:
    • Protege
    • Essential Widgets
    • Required JDBC drivers for your database server
    • Apache Tomcat
    • Essential Viewer
    • Essential Meta Model.
In Multi User mode, it is recommended that a database, such as MySQL, is used to manage the storage of the repository. Before proceeding, please ensure that you have access to a suitable database server, including a user name and password with rights to create schemas and tables. Note: There is a known issue with Protege v3.3.1 that makes it incompatible with Microsoft SQL Server 2005. However, Essential Architecture Manager is being used successfully with MS SQL Server 2005, using Protege 3.4 and above. First, complete the server installation then proceed with the client installation for each workstation where users will be updating your architecture models.

1. Download

Essential Architecture Manager JAR file downloadedHaving downloaded the essentialinstall.jar file from the Download section, please check that you have the software pre-requisites available.

Server Installation

1. Java Runtime Environment

Before starting the install of Essential Architecture Manager, 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.
If you do not already have a Java Runtime Environment installed, please download and install the correct JRE/JVM for your platform.

2. Install Protege

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

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

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

3. JDBC Drivers

Install the required JDBC drivers as per the instructions supplied with them. The Protege server will use these to connect to the database that will hold the repository. To enable Protege to see these drivers:
  • Copy the .jar file for your JDBC driver to the folder as driver.jar
  • If driver.jar is already being used, use driver0.jar, driver1.jar or driver2.jar
If you need the option to use more than 3 different types of database server to hold different repositories managed by the same server (i.e. you need more than 3 JDBC drivers):
  • Modify the file: /protege.lax to add the path to your JDBC driver JAR file (including the jar file itself) to the lax.class.path property.

4. 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".

4.2 Run Tomcat as Windows Service

On Microsoft Windows platforms, set Tomcat to run AUTOMATICALLY as a Windows service via the Services panel in Control Panel. For other platforms, please follow the Apache Tomcat instructions for running it as a daemon / background task.

4.3 Setup user accounts

If you wish to control access to the analysis reports of Essential Viewer, set up the required user accounts as follows:

Edit the /conf/tomcat-users.xml file to create user accounts that have the report_viewer role. e.g.
After making these changes, restart the Tomcat service.
You can deploy Essential Viewer under a different name, e.g. Essential Viewer Development, to create different environments for publishing your architecture. This can be useful if you want to share a repository that is work-in-progress with your team, while maintaining a 'published' repository view that can be viewed by your entire organisation. The Essential Architecture Reporting tab allows you to publish to any available instance of the Essential Viewer.

5. Run Essential Architecture Manager Installer

Essential Installer Welcome PanelHaving installed the pre-requisites, run the Essential Architecture Manager installer, which will guide you through the rest of the installation process. The following sections in this guide provide additional detail about the options for the installer and the questions that it will ask.

To run the installer:

Double click on the Essential Install JAR File.

If, for some reason the installer is not recognised as an executable JAR file, use the following command at command prompt/terminal window:

java -jar essentialinstall.jar
You will now see the welcome panel of the installer and will be guided through the install process.

6. Important Information and License Agreement

Essential Installer Important Information PanelThe Information Panel provides important information about the installation and pre-requisites. Please read these before proceeding to the license agreement.
Essential Installation License Panel

7. Select Essential Architecture Manager Packages to Install

Essential Installation Pack Selection PanelThe Essential Architecture Manager installer is divided into packages, enabling the installer to be used for installation possibilities.
For multi-user server installations, select all the install packages.
If you are installing the server as part of a migration from a stand-alone installation, you should still choose to install the Repository pack as this will create the location where your stand-alone repository will be moved to.

8. Specify Protege and Tomcat Locations

Essential Install Plugins PanelEssential Architecture Manager includes plugins that must be installed into your Protege and Apache Tomcat (or alternative Java Web Application Server) installations on the server.
The installer will ask you to specify the location of both your Protege and Apache Tomcat (or alternative Java Web Application Server). An attempt to automatically find Protege and Apache Tomcat in typical installation locations will be made. If the installer cannot find your Protege and Apache Tomcat installations, please use the 'Browse...' button to specify the folders in which they are installed.
If you have multiple versions of Protege installed, use the drop-down box or the 'Browse...' button to select which version of Protege that the Essential Widgets should be installed into.
When you select an location for either Protege, the installer will verify that location to ensure that you have selected a valid folder. Select the correct deployment location for Essential Viewer in your Web Application Server installation. For Apache Tomcat, select <Tomcat Install>/webapps. For other Java Web Application Servers, please refer to your supplier's documentation for Web Application deployment to find the correct location for deploying the Essential Viewer WAR file.
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, if you can navigate to the Tomcat directory on the network server, do so from the 'Browse...' button for the Tomcat location field.

9. Install the Essential Repository

Essential Install Repository PanelBoth 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
Next, specify to the target location of your empty Essential Architecture Manager Repository. The installer will create a directory to hold the meta-model and model configuration files in the folder that you specify. 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, e.g.
/EssentialAM/Repository

10. Essential Architecture Manager Server Configuration

Essential Install Server PanelIf you are installing to a fresh installation of Protege, select the default option to install the server configuration directly into the Protege environment.
However, if you are installing Essential Architecture Manager to a machine that already has Protege installed and running as a server in a multi-user environment, you should select an alternative location at this step of the installion, e.g. your Essential Repository location, to avoid the existing server configuration being over-written.

11. Finished Installing

Essential Install Finished PanelThe installer will now install all the components of Essential Architecture Manager to the locations that you have specified in the above steps.
Essential Install Done PanelWhen the installation has completed successfully, you can create an automated installer to repeat this installation configuration, e.g. to install another verbatim copy on another machine. Select the 'Generate an automatic installation script' option and specify the name and location of your automated install script.

12. Configure the Protege Server

12.1 Setup Protege and Essential Environments

The Protege server is itself controlled by a Protege project called the 'metaproject'. This project tells the Protege server about all the projects that it is be hosting, which users are defined and which projects the users can access. Once all the server software components have been defined, the following steps should be run on the physical server in order to define the metaproject.

The installation of the 'Server' pack, above, has deployed this configuration to your chosen location. By default, the installer over-writes the Protege example configuration to make the configuration of the Protege Server simpler. However, if you have installed the 'Server' pack to an alternative location, you wish to change the default location of this metaproject so that it can be managed alongside your Essential Architecture Manager repository or you just wish to move it to a completely different area of your filesystem, you will need to do the following:

  • Copy the metaproject.pprj, metaproject.pins and metaproject.pont files from /examples/server/ to the new location, e.g. the /EssentialAM/Repository directory if moving it to be alongside your repository (Assuming that your repository is installed in /EssentialAM/Repository).
  • Update the run_protege_server.bat (on Windows) or run_protege_server.sh (on Mac OS X, Linux, Unix etc.) file and change the METAPROJECT variable so that it refers to the file you created in above.

 

12.2 Meta Project Definition

This section requires you to start working with the Protege software. This guide will take you step-by-step through the process but you may wish to read the Getting Started tutorials to help familiarise yourself with Protege before proceeding.

The Protege server uses an ontology of projects to manage the repositories that it is hosting and serving. This ontology also defines the users and access control policies for the repositories. This must be configured as follows.

  • Start the Protege GUI application.
  • When prompted to open a project, open the metaproject that you wish to use:
    • the default location for the metaproject is: /examples/server/metaproject.pprj
    • or your alternative location, e.g. /EssentialAM/Repository
Open Metaproject screenshot
Open the metaproject

 

Once the metaproject has loaded, click on the 'Instances' Tab to create new instances that define the server configuration.
The 'Server' pack includes a pre-configured metaproject that only requires the path to your repository project to be specified. You may wish to add additional users to the configuration.
Complete the project for the Essential repository.
  • Find the Project called 'Essential AM Repository'. Projects are managed under the PolicyControlledObject class - open this class in the Class Browser to find the Project instances.
  • Specify a user as the owner of this - typically this is the user who is also the administrator of the repository. You may wish to change the example configuration.
  • Specify the location of the Protege project file that is the root of the repository. This is the full path to the Repository pack that was deployed by the installer and will be a .pprj file. Even if your repository is being stored in a database, a .pprj file is required. As this is a Java environment, use the Unix-style directory separators to define the location of the repository's project file, e.g. on Windows, this would still be:
C:/EssentialAM/Repository/myRepository.pprj
Defining a New Project screenshot
Define the project for the Essential repository

 

Having defined the Essential Architecture Manager repository project to the Protege Meta Project, we need to add the Annotations Project for Essential Architecture Manager to the Meta Project. The Annotations Project manages collaboration capabilities including tracking all changes to the repository and is created automatically by Protege when you choose to show the collaboration panel. If you have not already enabled the Collaboration in your Essential Architecture Manager repository project, see the Enabling Collaboration article for how to do this.

Using the Annotations Project is optional but recommended for multi-user installations. You can create the Annotations Project after you have completed this Meta Project configuration. Protege Server will raise warnings if it cannot find the specified Annotations Project but you can continue to work with your repository in multi-user mode when Protege cannot find the annotations project.

Find the Project instance for the 'Essential AM Annotations' Project. This project contains the list of all the changes and collaborative activity that is taking place on the repository. Follow the same steps as those for the Essential Architecture Manager repository project, above, to find the definition of the annotations project and remembering to specify a location of the annotations project file.
  • The location of this annotations project should be in the same directory as the repository project, and will normally be named using a prefix of 'annotation' on the repository project name, e.g.
C:/EssentialAM/Repository/annotation_essential_am_repository.pprj
Define the Annotations Project screenshot
Define the Annotations project to track changes in the Essential repository

 

  • Go back to the Project instance for the repository project, e.g. 'Essential AM Repository'.
    • In the field called AnnotationProject at the bottom of the form, select the Annotations project that you defined above, e.g. 'My EA Repository Annotations'.
  • You can delete the example users.
  • Save the metaproject, using the Save button on the Protege client.
Set Annotations Project for Essential Repository screenshot
Setting the Annotations Project for the Essential Repository project

13. Repository Database Configuration

It is recommended that in Multi User mode, the Essential Repository is stored in a relational database. From within Protege, this means converting your repository project to be of the type "Protege database".

To configure your database server, we recommend that you use the graphical administration tools for your database server, e.g. for MySQL, the GUI tools. Alternatively, when using a managed database service, ask your DBAs to create the user accounts and empty database for Protege.

On your database server, create a user account for the Protege server that has rights to create schemata and tables. Then create an empty database for the repository named, e.g, 'essentialdb'. You are now ready to convert your repository to use the database, so ensure that you have the following details:

  • User name - e.g. essential
  • Password - e.g. e55ential
  • Database name - e.g. essentialdb
  • JDBC Driver class name - e.g. for MySQL, this is com.mysql.jdbc.Driver
  • JDBC URL, e.g. if the database server is a MySQL database installed on the same server as the Protege server: jdbc:mysql://localhost/essentialdb.
  • Table - the name of your repository. Give this a meaningful name that describes you architecture repository, e.g. 'myEARepository'.
The following database set up should be followed when migrating an existing stand alone repository project to a multi user repository.

To use the database to host the repository:

  • Stop the Protege server if it is running
  • Back up the existing file-based repository (PINS, PONT and PPRJ files) if you have already been working with the repository using the standard project files.
  • Open the file-based Protege Project that you wish to have hosted in the database.
  • Select File->Convert Project to Format
  • Select Protege Database from the list of options and complete the dialog form using the database details listed above.
Protege will then create the a table in the database you specified with the name you supplied for the repository and write the entire repository into that table.
IMPORTANT. Do not edit the database contents directly, e.g. via database management tools. Always use the Protege software to update the repository.

14. Starting the Protege Server

Once the metaproject has been defined, the server is ready to be used. Starting the server is simply a case of running the run_protege_server.bat or run_protege_server.sh file that is found in the directory. You can create a shortcut to this batch or script file on your desktop. This batch file starts 2 child processes:

  • The Java RMI Registry to broker client connection requests.
  • The Protege Server

15. Running the Server as a Windows Service

It is important that the Essential repository server is always running and able to serve requests from its clients, so it should be configured to run as a Service on Windows server platforms. Currently, the Protege software does not include the capability to run as a native Windows service, so the Microsoft SrvAny tool from the Windows Resource Kit should be used.

Warning: The following steps include editing the Windows Registry and should be only be attempted by qualified personnel. If in any doubt, please consult your systems administrator. The Essential Project can accept no responsibility for any errors or failures resulting from editing the registry.
To use the Microsoft SrvAny tool, the Windows Resource Kit must be installed, as follows:
  • Download and run rktools.exe. This is available from Microsoft's website.
  • Install the Resource Kit to the default location, normally C:\Program Files\Windows Resource Kits\Tools
  • Open a Command Prompt.
  • At the command line enter the following commands (each on a single line) 
    cd c:\Program Files\Windows Resource Kits\Tools
    instsrv.exe "Essential AM Server" C:\"Program Files\Windows Resource Kits\
    Tools\srvany.exe"

You should receive the following message: "The service was successfully added!"

If you receive the "Unable to find the file at the given path" message, then modify the drive and directory to point to the location of the srvany.exe file

Next edit the registry entry for the new service as follows:
  • Press Start->Run and type regedit
  • Locate the following subkey in your registry display:
    • HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EssentialAM Server
  • Right-click the Essential AM Server subkey, and click New --> Key.
  • Enter the following command: Parameters
  • Right-click the Parameters subkey, and click New --> String Value.
  • Enter the following command: AppDirectory
  • Right-click the AppDirectory subkey, and click Modify.
  • Enter the following command, where C:\Program Files\Protege_3.4\ is the path to where you have installed Protege:
    • C:\Program Files\Protege_3.4\
  • Right-click the Parameters subkey, and click New --> String Value.
  • Enter the following command: Application
  • Right-click the Application subkey, and click Modify.
  • Enter the following command: run_protege_server.bat
  • Close the registry editor.

Next, open the Services panel from Start->Settings->Control Panel->Administrative Tools->Services. In the list of services, you will see "Essential AM Server". Start this service to start the Protege Server. Then, double click on this service and set it to have Startup Type set to "Automatic".

NOTE: It is normal for this to show in the list of services as not started, even when the Protege Server is actually running because the service invokes a batch file, which in turn invokes a batch file.
This solution, Windows Server 2003 Resource kit, enables a batch file to be started via a Service. Full Service-style behaviour may not operate as expected (e.g. start / stop) as the Essential server startup program is a Windows batch file that invokes 2 separate executables. To this end, a shutdown command is provided to gracefully stop the Protege server. Stopping the service from the control panel will NOT stop Protege server.

15.1 Defining Essential AM Server Service Dependencies

Where a database-based repository is used, the Essential Server will not start up correctly if it cannot establish a connection to the database that is now hosting the repository. To help with the automatic startup of the Essential Server, define a dependency between the Essential AM Server service and another service, such as your database server instance (if it is co-located with Essential) or with Tomcat (used for the Essential Viewer):

  • Start->Run->regedit32
  • Go to HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\EssentialAM Server
    • Click Edit -> New Multi Size String Value (REG_MULTI_SZ)
    • Value name must be 'DependOnService' [without the ' ']
    • Double click to edit its data value and a dialog asking for data values will appear.
    • Enter the name of the service that Essential depends on - 1 per line
      • For MySQL, enter MySQL
      • For Tomcat, enter Tomcat5
  • Exit from regedit
  • Check that the dependency appears correctly in the Control Panel, Services entry for the Essential AM Server.

16. Running automatically on Unix-based platforms

When Essential Architecture Manager is deployed on Mac OS X, Unix and Linux platforms, the run_protege_server.sh script file should be included in the start-up scripts / schedules so that it is restarted when the physical server platform is re-started.

17. Starting and Stopping the Protege Server

17.1 Starting the server manually

To start the server from a login at the server's desktop, navigate to the directory and then:

  • On Windows: run run_protege_server.bat, e.g. via a shortcut on the desktop.
  • Mac OS X, Linux or Unix: from a terminal window, run run_protege_server.sh

17.2 Starting the server automatically

Preferably, start the Essential Server via a Windows Service (see Section 11) or configured in the Unix/Linux start up scripts (see Section 12). If the server platform has already started and the Essential Server is not running, start the Windows Service via the Services control panel or run the run_protege_server.sh script as a background job,

./run_protege_server.sh &

17.3 Stopping the Protege Server

Steps 18 and 19 cover stopping the Protege Server on Windows and other platforms, respectively.

18. Stopping the Protege Server - Windows

To stop the Essential Server:

  • Go to the directory
  • Run the shutdown_protege_server.bat file. A hostname can be passed to this batch file to terminate a remote server. Use with care.

 

To completely stop all components of the Essential Server the Java RMIRegistry must also be stopped. Ensure that the Protege Server has been stopped before stopping the RMIRegistry.

A desktop shortcut can be defined to the shutdown_protege_server.bat file to make it clearer how to stop the repository server. Give that shortcut an icon like the red box with the white "off" symbol on it.

To stop the RMI Registry:

  • Open the Windows Task Manager:
  • Find the process called "rmiregistry". Terminate this process.

 

A restart of the Protege Server without first stopping the RMIRegistry will not cause any problems, as the RMIRegistry will only start if an existing RMIRegistry is not already running (it implements a Singleton pattern).

19. Stopping the Essential Server - Mac OS X, Unix and Linux

To stop the Essential Server:

  • Go to the directory
  • Run the shutdown_protege_server.sh file. A hostname can be passed to this batch file to terminate a remote server. Use with care.

To completely stop all components of the Essential Server the Java RMIRegistry must also be stopped. Ensure that the Essential Server has been stopped before stopping the RMIRegistry.

At a terminal command line, type:

ps -ef grep rmiregistry

Find the process ID of 'rmiregistry' by using the following command at a terminal prompt:

kill -9

where is the process ID of the rmiregistry process.

A restart of the Protege Server without first stopping the RMIRegistry will not cause any problems, as the RMIRegistry will only start if an existing RMIRegistry is not already running (it implements a Singleton pattern).

20. Server Installation Complete

Your server installation of Essential Architecture Manager is now complete. Now complete the Client Installation on each of the workstations that you need to provide access to update the architecture model.

Client Installation

Overview

Installing Essential Architecture Manager on the clients that will be creating and maintaining the architecture only requires the first 3 steps of the installation process to be performed on each client workstation or notebook. This consists of:

  • Ensuring that a Java Runtime Environment is installed on the client workstation.
  • Installing Protege
  • Installing the Essential Widgets.

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

2. Install Protege

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

2.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 1, 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.

2.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 1, 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 1 using the "Choose Another" button.
  • NOTE: You must select the specific java.exe file to use.
  • Select 'Next' until the installation completes.

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

3. Run Essential Architecture Manager Installer

Essential Installer Welcome PanelHaving installed the pre-requisites, run the Essential Architecture Manager installer, which will guide you through the rest of the installation process. The following sections in this guide provide additional detail about the options for the installer and the questions that it will ask.

To run the installer:

Double click on the Essential Install JAR File.

If, for some reason the installer is not recognised as an executable JAR file, use the following command at command prompt/terminal window:

java -jar essentialinstall.jar
You will now see the welcome panel of the installer and will be guided through the install process. Follow the installer through to the Package selection panel.

4. Select Essential Architecture Manager Packages to Install

Essential Install Widgets PanelThe Essential Architecture Manager installer is divided into packages, enabling the installer to be used for installation possibilities.
For client installations in multi-user installations, just select the 'Widgets' pack and un-select all the other packs..

5. Specify Protege Location

Essential Install Protege Path PanelEssential Architecture Manager includes plugins that must be installed into your Protege installation.
The installer will ask you to specify the location of your Protege installation on each client. An attempt to automatically find Protege in typical installation locations will be made. If the installer cannot find your Protege installation, please use the 'Browse...' button to specify the folders in which they are installed.
If you have multiple versions of Protege installed, use the drop-down box or the 'Browse...' button to select which version of Protege that the Essential Widgets should be installed into.
When you select an location for Protege, the installer will verify that location to ensure that you have selected a valid folder.

6. Select Location for Uninstaller and Install Summary

Essential Install Un-install Path PanelThe installer will create an un-install program on each client.
Next, specify to the target location where the installer should put the Essential Architecture Manager Uninstaller. The installer will create a directory to put this in the folder that you specify, e.g.
/EssentialAM

7. Finished

Essential Install Finished PanelThe installer will now install all the required components of Essential Architecture Manager to the locations that you have specified in the above steps.
Essential Install Done PanelWhen the installation has completed successfully, you can create an automated installer to repeat this installation configuration on other clients. Select the 'Generate an automated installation script' option and specify the name and location of your automated install script.
See the Automated Installer article for how to use this installation script.

8. Client Installation Complete

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

Opening a Protege project in Multi User mode is slightly different to opening a Stand Alone, file-based project. For more information, see the Accessing the Repository in Multi User Mode tutorial.

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.

 

Troubleshooting

  • On Windows Vista or Windows 7 platforms, if the installer fails to install the Essential Architecture Manager plugins to the Protege install folder in Program Files, right-click on the installer program and use the 'run as administrator' facility.
  • After installation, if Essential Viewer is not responding or the Report Service is not responding, check that the essential_viewer.war has been extracted and deployed to your web application server (e.g. Apache Tomcat) webapps folder. If the WAR file does not extract when you restart Apache Tomcat, you can deploy the WAR using the Tomcat Manager.

 

Running the Essential Architecture Manager installer simplifies the installation process and helps to ensure that the Essential software components are installed correctly. However, should you encounter any problems with the install the manual installation guide provides a useful starting point, as it contains extensive details and background into what the installer is doing.

< Prev   Next >
 
Related Articles