website logo
โŒ˜K
๐Ÿ“Introduction
๐Ÿ“Essential Overview
Getting Started (What is Essential?)
The Essential Information Eco System
๐Ÿ“How to be Successful with Essential
Identify Stakeholders and Concerns
Prioritise Delivery
Identify/Define the Views that will support Delivery
Identify any Meta Model extensions required and the impacts
Identify the data required, data sources, and population method
Plan Training/Consultancy
Extend Launchpad and build integrations and views as required
Complete Portal and Repository set-up
Capture data
๐Ÿ“„Embed EA data management process to ensure data is maintained
Measure Value
๐Ÿ“How To Use Essential
Using Essential Overview
๐Ÿ“„Logging In and The Homepage
๐Ÿ“„Capturing and Maintaining Data
๐Ÿ“„Everyone's Essential Editors
๐Ÿ”Hints & Tips
๐Ÿ“„Bulk Data Imports
๐Ÿ“„Essential Import Utility - To Bulk Load Data
๐Ÿ“„Essential Viewer
๐Ÿ“„Set Up Support Tools
๐Ÿ“„Extending the Essential Meta Model
๐Ÿ“„System Administration
๐Ÿ“„Repository Administration
๐Ÿ“„Managing User Security
๐Ÿ“„Essential Product Releases and Updates
๐Ÿ“EA Tutorials
๐ŸŽ“Business Architecture
๐ŸŽ“Application Architecture
๐ŸŽ“Technology Architecture
๐ŸŽ“Information Architecture
๐Ÿ“„EA Support/Utilities
๐ŸŒEssential Meta Model Diagrams
Essential Meta Model (Overview)
Business Layer
Application Layer
Information/Data Layer
Technology Layer
EA Support
Meta Model Constructs
Essential Modelling Patterns/Definitions
๐Ÿ“How to Populate Essential Views
Roadmap Enablement and Scoping Frameworks
Enterprise Views
Business Views
Information Views
Application Views
Technology Views
๐Ÿ“Open Source
Open Source Overview
๐Ÿ› ๏ธOpen Source Multi-User
โš’๏ธOpen Source Installation
Accessing Essential OS
Essential OS Buttons
โ“FAQs
Modelling in Essential
Data Capture, Maintenance and Releases
Viewer
User Management and Security
Launchpad and Import Utility
Open Source Configuration
Docs powered by
Archbee
Open Source
Open Source Installation

Configuring Memory

6min

Right now, our current recommendation for a server is a multi-core processor such as an i5/i7 or Xeon equivalent and more importantly plenty of RAM. 4GB is a minimum but 8GB is more practical. Youโ€™ll struggle to use the Import Utility and Viewer together on a system with only 4GB of RAM. Assuming youโ€™re running all the components on the same server (which is perfectly fine and can yield great performance) then hereโ€™s how weโ€™d allocate the RAM across the main componentsโ€ฆ

Tomcat running Essential Viewer โ€“ 2GB RAM Tomcat running Essential Import Utility โ€“ 2GB RAM Weโ€™d install the Essential Import Utility on a separate instance running on a different port e.g. 9080 as it improves stability and performance If running both on a single instance then allocate 4GB RAM to Tomcat Protege โ€“ 1.5GB RAM If running a Database configuration weโ€™ll ensure thereโ€™s about 1GB for that We need some memory for the OS to run smoothly so about 1GB for that This adds up to about 7.5GB. In reality, youโ€™ll rarely use all that RAM simultaneously however this configuration is one weโ€™ve used countless times with excellent performance.

So, now youโ€™ve got plenty of RAM then how do you configure the components to use that.

First up, make sure youโ€™re using the 64bit versions of all your components. If youโ€™re running 32bit versions, youโ€™ll max out a 1.5GB which will work whilst the repository is small but will cause you problems later on.

Protege

On Windows:

Start Protege. Go to File->Preferences->Protege.lax Update the row for the property โ€˜lax.nl.java.option.java.heap.size.maxโ€™ This is set in bytes, so set this to 2048000000 for installs with the 64-bit Java environment. Click OK Restart Protege

On Mac: If you run Protege on a Mac by double-clicking an icon, you need to edit the Info.plist file that is hidden within that icon. Right-click the icon (or ^-click for one-button mouses) and click โ€œshow package contentsโ€. A new finder window will come up. Double click โ€œContentsโ€ and then โ€œInfo.plistโ€. Traverse down the tree as follows: โ€œRootโ€ โ€“> โ€œJavaโ€ โ€“> โ€œVMOptionsโ€. In VMOptions edit the -Xmx line to indicate the correct memory usage, e.g. 2048M. Note that this can be specified in megabytes by using the โ€˜Mโ€™ value.

For example, here are typical settings: VMOptions -Xms250M -Xmx2048M -XX:MaxPermSize=512m Save the changes that youโ€™ve made and restart Protege for these to take effect.

This principle also applies to the Protege server. If you have not already, update the โ€˜run_protege_server.batโ€™ / โ€˜run_protege_server.shโ€™ file to increase the maximum memory JVM option as follows by setting the -Xmx parameter:

For Unix / Mac / Linux:

MAX_MEMORY=-Xmx2048M -XX:MaxPermSize=512m On 64-bit Windows platforms (with the 64-bit Java installation):

set MAX_MEMORY=-Xmx2048M On 32-bit JVMs on 64/32-bit Windows, thereโ€™s a limit to how much memory can be allocated:

set MAX_MEMORY=-Xmx1536M

Tomcat / Essential Viewer / Essential Import Utility The memory settings for the Tomcat that is running the Essential Viewer should also be set to around 2GB for 64-bit Java environments.

On Windows

If you are running Tomcat as a Windows service, you can set the upper memory limit using the tomcat8w.exe program. Youโ€™ll find this either in the start menu or in the install folder of Tomcat. This will pop up a configuration panel.

Select the โ€˜Javaโ€™ tab and then set the parameter for the Maximum memory pool to 2048 Click Apply restart Tomcat for these settings to take effect. On Mac

If running the Viewer Tomcat on a Mac / Linux platform, you can set these using the โ€˜sentenv.shโ€™ file in /bin and set the CATALINA_OPTS variable, e.g.:

export CATALINA_OPTS=โ€-Xms128m -Xmx2048m -XX:MaxPermSize=512mโ€ export JAVA_OPTS=โ€-Djava.awt.headless=trueโ€

If this file doesnโ€™t exist then simply create a new text file and save it as setenv.sh with these lines in it.

Again, you must restart Tomcat for these settings to take effect.

Troubleshooting

If things arenโ€™t working as expected, then the Log files are your friends. The Protege log is in the Protege install folder under logs and is called protege_###.log. The Tomcat log is in the Tomcat install folder under logs and is called catalina.out. What youโ€™re looking for is anything that mentions โ€œmemoryโ€ or โ€œheapโ€. If youโ€™re seeing these errors then you havenโ€™t properly configured the settings.

As always, you can post your questions on the Essential Forums at http://enterprise-architecture.org/forums and weโ€™ll answer as quickly as we can. Donโ€™t forget to use the search too as there are over five years of posts and thereโ€™s a good chance your question has been answered before.

Once youโ€™ve got these settings right, you should have many years of stability and performance from your Essential Install. If youโ€™re still having problems though and would like some professional support then contact EAS via the Services menu for more information on how we can help.

Updated 03 Mar 2023
Did this page help you?
PREVIOUS
Multi-User Installation
NEXT
Using a Database with Standalone
Docs powered by
Archbee
TABLE OF CONTENTS
Protege
Troubleshooting
Docs powered by
Archbee