Commands for starting and stopping the application server
This section describes how to start and stop the JBoss application server.
This section only applies to ConSol CM versions 6.13.0 and higher. For older versions, please refer to the respective manuals.
JBoss on Windows
Starting JBoss on Windows
ConSol CM without CMRF
Run the following command to start the JBoss server for a setup with ConSol CM without CMRF. Alternatively you can configure JBoss to run as a service.
<JBOSS_HOME>\bin\standalone.bat -P <JBOSS_HOME>\bin\cm6-config.properties -c cm6-<DB>.xml
Replace cm6-<DB>.xml with the configuration file for your database:
- cm6-mysql-5.xml for MySQL 5
- cm6-mysql-8.xml for MySQL 8
- cm6-oracle.xml for Oracle
- cm6-mssql.xml for Microsoft SQL Server
ConSol CM with CMRF in standalone mode
Use the following command to start the JBoss which executes ConSol CM.
<JBOSS_HOME>\bin\standalone.bat -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:
- cm6-dwh-mysql-5.xml for MySQL 5
- cm6-dwh-mysql-8.xml for MySQL 8
- cm6-dwh-oracle.xml for Oracle
- cm6-dwh-mssql.xml for Microsoft SQL Server
Use the following command to start the JBoss which executes the CMRF:
<JBOSS_CMRF_HOME>\bin\standalone.bat -P <JBOSS_CMRF_HOME>\bin\cmrf-config.properties -c cmrf-<DB>.xml
Replace cmrf-<DB>.xml with the CMRF configuration file for your database:
- cmrf-mysql-5.xml for MySQL 5
- cmrf-mysql-8.xml for MySQL 8
- cmrf-oracle.xml for Oracle
- cmrf-mssql.xml for Microsoft SQL Server
ConSol CM with CMRF in overlay mode
Use the following command to start the JBoss which executes ConSol CM and the CMRF.
<JBOSS_HOME>\bin\standalone.sh -P <JBOSS_HOME>\bin\cm6-cmrf-config.properties -c cm6-cmrf-<DB>.xml
Replace cm6-cmrf-<DB>.xml with the ConSol CM configuration file for your database:
- cm6-cmrf-mysql-5.xml for MySQL 5
- cm6-cmrf-mysql-8.xml for MySQL 8
- cm6-cmrf-oracle.xml for Oracle
- cm6-cmrf-mssql.xml for Microsoft SQL Server
Shutting down JBoss on Windows
Run the following command to stop the JBoss server. Alternatively you can put it into the configuration of the Windows service.
<JBOSS_HOME>\bin\jboss-cli.bat --controller=localhost:9999 --connect --command=:shutdown
JBoss on Linux
Starting JBoss on Linux
ConSol CM without CMRF
Run the following command to start the JBoss server for a setup with ConSol CM without CMRF. Alternatively you can put it into a start script (usually init.d or systemd).
<JBOSS_HOME>/bin/standalone.sh -P <JBOSS_HOME>/bin/cm6-config.properties -c cm6-<DB>.xml
Replace cm6-<DB>.xml with the configuration file for your database:
- cm6-mysql-5.xml for MySQL 5
- cm6-mysql-8.xml for MySQL 8
- cm6-oracle.xml for Oracle
- cm6-mssql.xml for Microsoft SQL Server
ConSol CM with CMRF in standalone mode
Use the following command to start the JBoss which executes ConSol CM.
<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:
- cm6-dwh-mysql-5.xml for MySQL 5
- cm6-dwh-mysql-8.xml for MySQL 8
- cm6-dwh-oracle.xml for Oracle
- cm6-dwh-mssql.xml for Microsoft SQL Server
Use the following command to start the JBoss which executes the CMRF:
<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:
- cmrf-mysql-5.xml for MySQL 5
- cmrf-mysql-8.xml for MySQL 8
- cmrf-oracle.xml for Oracle
- cmrf-mssql.xml for Microsoft SQL Server
ConSol CM with CMRF in overlay mode
Use the following command to start the JBoss which executes ConSol CM and the CMRF.
<JBOSS_HOME>/bin/standalone.sh -P <JBOSS_HOME>/bin/cm6-cmrf-config.properties -c cm6-cmrf-<DB>.xml
Replace cm6-cmrf-<DB>.xml with the ConSol CM configuration file for your database:
- cm6-cmrf-mysql-5.xml for MySQL 5
- cm6-cmrf-mysql-8.xml for MySQL 8
- cm6-cmrf-oracle.xml for Oracle
- cm6-cmrf-mssql.xml for Microsoft SQL Server
Shutting down JBoss on Linux
ConSol CM without CMRF
Run the following command to stop the JBoss server. Alternatively you can put it into a stop script (usually init.d or systemd).
<JBOSS_HOME>/bin/jboss-cli.sh --controller=localhost:9999 --connect --command=:shutdown
General configuration
- In case -b=localhost or -b=127.0.0.1 is set as parameter, ConSol CM is only accessible from the same server, where JBoss is running.
- Enter the network IP or the network name to make ConSol CM accessible from outside the sever. In this case ConSol CM URL is not accessible from the inside using the localhost URL.
- If you enter -b=0.0.0.0 the server is accessible from the outside and inside using the server URL or using the localhost URL (take care of all required security-related precautions!).
The following JAVA_OPTS settings are used by default when setting up a new ConSol CM system.
Default memory configuration for JBoss 7.3 on Java 8 (Xms and Xmx should be set to the same value):
- -Xms4g -Xmx4g -XX:MaxMetaspaceSize=512m
These parameters are starting parameters for production systems. Depending on the size of the system it might be necessary to adjust them. The following factors are important in this context:
- number of concurrent users
- amount of tickets, customers, resources
- amount and size of emails
- amount and size of attachments
- size of the index
As an administrator, you need to check the Java heap size and the garbage collection activity using tools like jconsole or jvisualvm. If the heap size is higher than 80 - 90% of the maximum value and the garbage collection runs frequently, you need to increase the memory allocation (Xmx).
The list includes the officially supported default parameters for JBoss 6.4. They should be suitable for most installations.
- -verbose:gc
- -XX:+PrintGCDetails
- -XX:+PrintGCDateStamps
- -XX:+UseGCLogFileRotation
- -XX:NumberOfGCLogFiles=5
- -XX:GCLogFileSize=3M
- -XX:-TraceClassUnloading
- -XX:+UseCompressedOops
- -Djava.net.preferIPv4Stack=true
- -Djboss.modules.policy-permissions=true
- -Djboss.modules.system.pkgs=$JBOSS_MODULES_SYSTEM_PKGS
Depending on the individual usage of the ConSol CM system, some additional settings might be needed. The following list includes settings which are used on some systems. As these settings are not officially supported, please contact your ConSol CM consultant or the ConSol CM support before using them in your production environment.
- -server
- org.apache.tomcat.util.http.Parameters.MAX_COUNT=6000
- org.apache.coyote.http11.Http11Protocol.MAX_HEADER_SIZE=65535
- org.apache.tomcat.util.http.MimeHeaders.MAX_COUNT=200
- com.arjuna.ats.arjuna.allowMultipleLastResources=true
- -Dhttp://apache.org/xml/features/nonvalidating/load-external-dtd=false
Prevent cross-scripting attacks - -Djboss.platform.mbeanserver
Enable the JMX bean server - -Djgroups.marshalling.compatible=true
Use old JGroups protocol instead of newer one - -Dorg.jboss.resolver.warning=true
Warning when an XML entity is defined as SYSTEM and the protocol is not file:// or vfsfile:// - -Dserialization.jboss=false
Disable JBoss serialization and use standard Java serialization instead - -Dsun.rmi.dgc.client.gcInterval=3600000
- -XX:+UseParallelOldGC
Use the old garbage collection or any better matching garbage collection depending on your requirements. - -XX:+HeapDumpOnOutOfMemoryError
- -XX:HeapDumpPath=/some/path
Use a path, you cannot use a file here - -Xloggc:some/path/based/on/JbossRoot/log/gc-%t.log
- -XX:ReservedCodeCacheSize=150m
- -XX:CompressedClassSpaceSize=128m