You are looking at documentation for an older release. Not what you want? See the current release documentation.
eXo Platform provides a list of ECMS caches, including:
Here are the configurations in exo.properties file:
# == ECMS Caches Configuration == #
# ECMS Cache Configuration - Query Service
# - Standalone (live time in seconds)
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.queryservice.maxnodes=5000
#exo.cache.ecms.queryservice.expirationtimeout=600000
# ECMS Cache Configuration - Drive Service
# - Standalone (live time in seconds)
#exo.cache.ecms.managedrive.capacity=5000
#exo.cache.ecms.managedrive.timetolive=600
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.managedrive.maxnodes=5000
#exo.cache.ecms.managedrive.expirationtimeout=600000
# ECMS Cache Configuration - Script Service
# - Standalone (live time in seconds)
#exo.cache.ecms.scriptservice.capacity=300
#exo.cache.ecms.scriptservice.timetolive=86400
# ECMS Cache Configuration - Templates Service
# - Standalone (time to live in seconds)
#exo.cache.ecms.templateservice.capacity=3000
#exo.cache.ecms.templateservice.timetolive=86400
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.templateservice.maxnodes=300
#exo.cache.ecms.templateservice.expirationtimeout=86400000
# ECMS Cache Configuration - Initial Webcontent
# - Standalone (time to live in seconds)
#exo.cache.ecms.webcontent.initialwebcontentplugin.capacity=300
#exo.cache.ecms.webcontent.initialwebcontentplugin.timetolive=86400
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.webcontent.initialwebcontentplugin.maxnodes=300
#exo.cache.ecms.webcontent.initialwebcontentplugin.expirationtimeout=86400000
# ECMS Cache Configuration - Fragment Cache Service (Markup Cache)
# - Standalone (time to live in seconds)
#exo.cache.ecms.fragmentcacheservice.capacity=10000
#exo.cache.ecms.fragmentcacheservice.timetolive=30
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.fragmentcacheservice.maxnodes=10000
#exo.cache.ecms.fragmentcacheservice.expirationtimeout=30000
#
# ECMS Cache Configuration - PDF Viewer Service
# - Standalone (time to live in seconds)
#exo.cache.ecms.pdfviewer.capacity=1000
#exo.cache.ecms.pdfviewer.timetolive=3600
# - Cluster (expiration in milliseconds)
#exo.cache.ecms.pdfviewer.maxnodes=1000
#exo.cache.ecms.pdfviewer.expirationtimeout=3600000
# ECMS Cache Configuration - SEO Cache
# - Standalone (time to live in seconds)
#exo.cache.ecms.seoservice.capacity=1000
#exo.cache.ecms.seoservice.timetolive=3600
# - Cluster (expirationtimeout in milliseconds)
# exo.cache.ecms.seoservice.maxnodes=1000
# exo.cache.ecms.seoservice.expirationtimeout=3600000
# ECMS Cache Configuration - Javascript Cache
# - Standalone (time to live in seconds)
#exo.cache.ecms.javascript.maxSize=1000
#exo.cache.ecms.javascript.liveTime=3600
The properties are different between Cluster mode and Standalone (single server) mode. Please read the inline comments when you configure them.
These properties are exposed via exo.properties for administrators.
The full configuration can be found in XML configuration files. For SEO Cache, the file is:
$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-extension.war!/WEB-INF/conf/wcm-extension/wcm/seo-configuration.xml (Tomcat).
$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/ecms-packaging-wcm-webapp.war!/WEB-INF/conf/wcm-extension/wcm/seo-configuration.xml
(JBoss).
For the other caches, the file is:
$PLATFORM_TOMCAT_HOME/webapps/ecm-wcm-core.war!/WEB-INF/conf/wcm-core/core-services-configuration.xml (Tomcat).
$PLATFORM_JBOSS_HOME/standalone/deployments/platform.ear!/ecms-core-webapp.war!/WEB-INF/conf/wcm-core/core-services-configuration.xml
(JBoss).
The managedrive caches visited drives of Sites Explorer by their names. When any users visit the cached drives, these drives will be directly retrieved from cache rather than the database.
The cache is invalidated when the drive is removed or added.
The cache size equals to the number of drives in cache.
The maximum heap size consumed by the cache are calculated as below:
Each item of drive cache contains: name, workspace, homePath, permission, view, icon, allowcreatefolders, viewReferences, viewNondocument, viewSidebar, showHiddenNode.
The first 7 elements are String and their length often should not be greater than 1000 bytes.
The last 4 elements are Boolean and the size of each element is 1 byte.
Thus, the maximum heap size equals to the cache size multiplied by 7004 bytes.
The scriptservice caches the ECMS Script objects. When there are any requests for cached scripts, these scripts are retrieved from cache rather than the database.
The scriptservice cache is never invalidated.
The cache size equals to the number of scripts in cache.
The maximum heap size equals to the cache size multiplied by size of the script object.
The templateservice caches the list of document nodetypes. When any users call for the cached document nodetypes, data will be retrieved from cache rather than the database.
The templateservice cache is invalidated when the document template is updated.
The cache size is 1.
The heap size consumed by the cache is unlimited. However the cache contains node names only, so it consumes less than 10KB.
The webcontent.initialwebcontentplugin caches the artifacts (nodes) that are used to initialize a new portal. When a cached artifact is called, it will be read and returned from cache rather than the database.
The cache is never invalidated because the initial artifact is never changed.
The cache size equals to the number of the cached artifacts.
The maximum heap size equals to the total size of all artifacts.
The fragmentcacheservice caches content of SCVs and CLVs. When any users call for these cached portlets, these portlets will be retrieved from cache rather than the database.
The fragmentcacheservice is invalidated when SCVs and CLVs are switched from the edit to the live mode.
The cache size equals to the number of SCVs/CLVs in cache.
The maximum heap size consumed by the cache: total size of cached SCVs/CLVs (the SCVs/CLVs size is unlimited).
The pdfviewer caches the path to a specific page of a specific PDF file. In eXo Platform, when a user views an Office document or PDF file, the viewed page is extracted into a PDF file, and REST is used to return that file content to client browser.
The pdfviewer cache is never invalidated.
The cache size equals to the number of pages viewed by users.
The maximum heap size equals to the cache size multiplied by 200 bytes (supposing that the longest file path is 200 characters).
The seoservice caches the SEO metadata of all pages in all sites. When the SEO metadata of these cached pages are called, the created pages will be got based on the page path from cache rather than the database.
The seoservice cache is never invalidated.
The cache size equals to the number of pages to which the SEO metadata is added.
The maximum heap size is calculated as follows:
Each Metadata object contains 8 String objects: uri, rbcontent, keywords, description, title, frequency, fullStatus, pageReference. Each object is usually less than 100 characters.
5 bytes (a float and a boolean) for priority and sitemap.
Thus, the total heap size equals to the cache size multiplied by 805 bytes.