OCEE documentation
OCEE documentation

Quick Start

This page gives an overview of the basic OCEE installation and configuration. For more details, see the corresponding sections in this documentation.

As already described in the overview page, Alkacon consists of several features. Each of them has to configured individually if you want to use them. But first, you need to install OCEE in general. To do this, perform the following steps:

  • Unzip the OCEE distribution zip somewhere (not in your OpenCms web application)
  • Install the module org.opencms.ocee.base contained in the modules/ folder of the distribution using the OpenCms module manager
  • Copy all the *.jar files from the lib/ folder of the distribution to the WEB-INF/lib folder of your OpenCms web application
  • Restart your servlet container

If you have older OCEE versions (OCEE 5.x or smaller) installed, you will need to remove them first before you can install a more recent OCEE version. To do this, perform the following steps:

  • Undo all OCEE configuration steps in your WEB-INF/config folder
  • Restart the servlet container and uninstall all old OCEE modules using the module manager in the OpenCms workplace
  • Double check whether the WEB-INF/lib folder contains any of the following files, and if so, remove them:
    • org.opencms.ocee.ldap.jar
    • org.opencms.ocee.cache.jar
    • org.opencms.ocee.cluster.jar
    • org.opencms.ocee.replication.jar

In order to activate your OCEE installation, you need to get a valid production subscription key. When OCEE is installed for the first time, you usually have an evaluation or a provisional subscription key which is OpenCms instance independent, but valid for a restricted time only. To obtain a production subscription key, you must send the activation key to Alkacon Software. You will then receive the production license key for this activation key.

Please note  that we can not generate a production key without the activation key. This activation procedure must be repeated for each OpenCms cluster that requires a production subscription key.

The activation key is displayed in the OCEE Subscription app in the workplace. It is also written to the servlet container log file.

Please send the OCEE activation key to opencms-support@alkacon.com.
For more details about the OCEE licensing mechanism, see the Subscription Manager documentation.

  • Copy all sample-config/ocee-*.xml files to your ${OPENCMS_HOME}/WEB-INF/config folder.
  • You will have at least to:
    • Configure your product subscription in order to activate the product, for this edit directly your ocee-license.xml file and check the documentation
    • Configure your LDAP provider in the ocee-ldap.xml file as described in the LDAP Connector documentation.
    • Configure your Cluster servers in the ocee-cluster.xml file as described in the Cluster Manager documentation.
    • Configure your Replication services in the ocee-replication.xml file as described in the Replicator documentation.
  • Add all new nodes from the sample-config/opencms.xml.part file in your ${OPENCMS_HOME}/WEB-INF/config/opencms.xml file.
  • Replace all nodes listed in the sample-config/opencms-system.xml.part file in your ${OPENCMS_HOME}/WEB-INF/config/opencms-system.xml file.
  • Add/replace all keys listed in the sample-config/opencms.properties.part file in your ${OPENCMS_HOME}/WEB-INF/config/opencms.properties file.
    Related to the replication:
    Here you have to use the correct SQL manager for your db provider in the 'Configuration of the database driver manager' section:
    • MS SQL Server: org.opencms.ocee.replication.db.mssql.CmsSqlManager
    • MySql:  org.opencms.ocee.replication.db.mysql.CmsSqlManager
    • Oracle: org.opencms.ocee.replication.db.oracle.CmsSqlManager
    • Postgresql: org.opencms.ocee.replication.db.oracle.CmsSqlManager
    • Make sure the URL of each pool points to different databases.
    • Make sure you set up the replication just in the master server, and not in the slave server (in a work-live configuration).
    • Also set the correct user name and password for the replication pool.
    • Finally, do not forget to install the slave server with exactly the same parameters you have used to configure the replication pool.

In case your OCEE installation does not require LDAP, adjust the installation as follows:

  • Remove the org.opencms.ocee.ldap.CmsLdapConfiguration entry from the opencms.xml file.
  • Remove the ldap value from the driver.user key in the opencms.properties, as
    well as the complete ‘Configuration of the LDAP driver’ section.
  • Set the class attribute of the validationhandler node in the opencms-system.xml to its default value
    org.opencms.security.CmsDefaultValidationHandler

In case you do not want to use replication, adjust the installation as follows:

  • Do not configure the org.opencms.ocee.replication.db.*.CmsSqlManager in opencms.properties.
  • Remove the org.opencms.ocee.replication.CmsReplicationConfiguration entry from the opencms.xml file.
  • Remove the replication value from the driver.user, driver.project and db.pools keys in the opencms.properties, as well as the complete ‘Configuration of the replication drivers’ and 'Configuration of the replication database pool’ sections.
  • While setting up the slave server, ensure to use the same database configuration as for the master server.

Here are the most important steps:

  • Use the same database configuration during the installation.
  • Do not import any module.
  • Copy the configuration files (most important is that the ocee-cluster.xml files are all identical) from the first cluster server to this new installation, as well the resources and export folders.

Here are the most important steps:

  • Do not use the same database configuration during the installation process like the master server.
  • Copy the configuration files (most important is that the ocee-cluster.xml files are all identical) from the first cluster server to this new installation, as well the resources and export folders.
  • Be sure replication services are not enabled in the slave servers. Best if you remove the org.opencms.ocee.replication module node from the opencms-modules.xml configuration file.
  • Since the slave server has no offline project, remove the /opencms/search/indexes/index[name=Offline project (VFS)] node from the ${OPENCMS_HOME}/config/opencms-search.xml. Remove all additional functions that need to access the Offline project, including scheduled jobs.