Installing the CMRF on a separate JBoss server (standalone mode)

Introduction

ConSol CM and CMRF run on different JBoss application servers. This setup is recommended for production environments.

Installing JBoss

This installation has been performed and tested with the following software versions. With other systems or versions, the setup might be slightly different.

JBoss version:

  • Red Hat JBoss Enterprise Application Platform 7.3

ConSol CM version:

  • 6.13.0

Operating systems:

  • Windows, Linux

In the following <JBOSS_CMRF_HOME> refers to the installation directory of the JBoss application server which is used for CMRF.

Windows

  1. Extract the downloaded JBoss archive into a new folder.
  2. Edit the file <JBOSS_CMRF_HOME>\bin\standalone.conf.bat (also see standalone.conf.bat):

    • Change the Java memory options if needed:

      set "JAVA_OPTS=-Xms4g -Xmx4g -XX:MaxMetaspaceSize=512m -Djava.net.preferIPv4Stack=true"

    • Add the Java path (the path and Java version can be different on your system):

      set "JAVA_HOME=C:\Program Files\Java\jdk1.8.0_144"

      Alternatively you can add JAVA_HOME to your operating system environment variables. In this case it is not necessary to set the line above. Refer to the Java documentation on how to do this.

    • In case you want to set up a separate JBoss server on the same system where the JBoss with ConSol CM is running, add a port offset:

    • set "JAVA_OPTS=%JAVA_OPTS% -Djboss.socket.binding.port-offset=100"

Linux

  1. Extract the downloaded JBoss archive into a new folder.
  2. Edit the file <JBOSS_HOME>/bin/standalone.conf (also see standalone.conf):

    • On most Linux Systems the JAVA_HOME environment variable should already be set. If you wish to use the system standard Java version you do not need to specify the JAVA_HOME environment variable.

      If in your case the variables are not set or you wish to specify a path to a specific Java installation add the following line (the path and Java version can be different on your system):

      JAVA_HOME="/opt/java/64/jdk1.8.0_144"

      You can use echo $JAVA_HOME to check if the variable is set correctly.

    • Adjust the JVM memory options, the -Xmx value should be at least 4G. If you want to set the options only when no JAVA_OPTS have been set yet, then use the following statement:

      ## Specify options to pass to the Java VM.#

      if [ "x$JAVA_OPTS" = "x" ]; then

      JAVA_OPTS="-Xms4g -Xmx4g -XX:MaxMetaspaceSize=512m -Djava.net.preferIPv4Stack=true"

      JAVA_OPTS="$JAVA_OPTS -Djboss.modules.system.pkgs=$JBOSS_MODULES_SYSTEM_PKGS -Djava.awt.headless=true"

      else

      echo "JAVA_OPTS already set in environment; overriding default settings with values: $JAVA_OPTS"

      fi

      If you want to overwrite existing JAVA_OPTS, do not put the JAVA_OPS= statements into the if clause

    • If the JBOSS_HOME environment variable is already set to a path other than your server path, add the following line at the top of <JBOSS_CMRF_HOME>/bin/standalone.conf. Remember that <JBOSS_CMRF_HOME> is the path to your JBoss installation.

      JBOSS_HOME=<JBOSS_CMRF_HOME>

  3. Change owner to a non-admin Linux user (example: hotline) and make the files executable:

    • chown -R hotline <JBOSS_CMRF_HOME>/bin
    • chmod 755 -R <JBOSS_CMRF_HOME>/bin

Installing CMRF

  1. Extract the CMRF distribution cmrf-package-distribution-<CM_VERSION>-wildfly_jboss.zip into <JBOSS_CMRF_HOME>.
  2. Overwrite the 4 subfolders bin, domain, modules and standalone, i.e. confirm the overwriting of existing files.

Configuring the database connection

This section only applies to ConSol CM versions 6.13.0 and higher. For older versions, please refer to the respective manuals.

The database connection needs to be configured for ConSol CM and for CMRF.

Starting the server

You need to start both the ConSol CM server and the CMRF server. Run the following commands to start the JBoss servers. Alternatively you can configure JBoss to run as a service (similar to autostart of ConSol CM, see Autostarting the CM server).

ConSol CM

Run the following command to start the JBoss server:

Windows

<JBOSS_HOME>\bin\standalone.bat -P <JBOSS_HOME>\bin\cm6-config.properties -c cm6-dwh-<DB>.xml

Linux

<JBOSS_HOME>/bin/standalone.sh -P <JBOSS_HOME>/bin/cm6-config.properties -c cm6-dwh-<DB>.xml

Replace cm6-dwh-<DB>.xml with the ConSol CM configuration file for your database:

CMRF

Run the following command to start the JBoss server:

Windows

<JBOSS_CMRF_HOME>\bin\standalone.bat -P <JBOSS_CMRF_HOME>\bin\cmrf-config.properties -c cmrf-<DB>.xml

Linux

<JBOSS_CMRF_HOME>/bin/standalone.sh -P <JBOSS_CMRF_HOME>/bin/cmrf-config.properties -c cmrf-<DB>.xml

Replace cmrf-<DB>.xml with the CMRF configuration file for your database: