Ebase Cache Configuration

Introduction

Ebase uses Ehcache to maintain caches of Ebase objects. There are three distinct caches, each one of which can be configured as both/either an in memory or disk cache; when the in memory cache is full, the disk cache is used.

Entities Cache is a cache containing designed Ebase objects e.g. forms, scripts, resources, lists, presentation templates etc. This is the most important cache, and has the largest impact on system performance by minimising accesses to the Ebase Repository Database. Performance may be improved by adjusting the cache size parameters, particularly for large systems. See configuration parameters Ufs.cache.entity.MemorySpace and Ufs.cache.entity.MaxDiskSpace below.

Runtime Headless Cache contains internal Ebase runtime form objects. Caching these objects avoids the overhead of recreating them for each new form invoked by a user. This cache should be large enough to contain all forms. See configuration parameters Ufs.cache.headless.MemorySpace and Ufs.cache.headless.MaxDiskSpace below.

Runtime Mapping Cache is used to keep track of multiple versions of runtime objects, for example when new versions are imported and the objects they replace are still in use for active forms.

Configuration Parameters

Caching parameters can be configured in two places: UFSSetup.properties and ebaseCache.xml. These files are both located in WEB-INF/classes within the web application directory. The full path is usually …UfsServer\tomcat\webapps\ufs\WEB-INF\classes.

Un-clustered system

For an un-clustered Ebase system, the recommendation is to configure the cache using just the following parameters in UFSSetup.properties. The parameters in ebaseCache.xml should not be changed.

Ufs.cache.entity.MemorySpace

The maximum number of Ebase designer objects contained within the Entities Cache in memory. When the number of loaded designer objects exceeds this number, the oldest objects are written to disk. An initial value of 1000 is recommended for this parameter. A value of 0 indicates that the cache size is unlimited i.e. all objects are cached. This number may need to be increased on large systems. The default value is 0.

Ufs.cache.entity.MaxDiskSpace

The maximum number of Ebase designer objects contained within the Entities Cache on disk. This disk cache is used when the Entities memory cache is full. There is no default value – if not specified, disk caching is disabled. Specifying a value of 0 indicates that the cache size is unlimited i.e. all objects are cached.

Ufs.cache.headless.MemorySpace

The maximum number of runtime objects contained within the Runtime Headless Cache in memory. When this number is exceeded, the oldest objects are written to disk. The system is distributed with an initial value of 20, and this number may need to be increased if more than 20 forms are in regular production use. The default value is 0 which indicates that the cache size is unlimited i.e. all objects are cached.

Ufs.cache.headless.MaxDiskSpace

The size of Runtime Headless Cache on disk. This is used when the Runtime Headless memory cache is full. There is no default value – if not specified, disk caching is disabled. Specifying a value of 0 indicates that the cache size is unlimited i.e. all objects are cached.

Ufs.cache.mapping.MemorySpace

This is an internal cache used by the Ebase system. The distributed initial value is 0 and should not be changed.

Ufs.cache.mapping.MaxDiskSpace

This is an internal cache used by the Ebase system. The distributed initial value is 0 and should not be changed.

Clustered system

When Ebase servers are clustered, the caching system needs to be explicitly configured to support this.

This documentation is not yet available. Please contact Ebase support for assistance.