Skip to main content

CMRF

This section describes how to install and set up the CMRF, which is required for using CM/EBIA and the data warehouse.

Please perform the following steps:

Installing the CMRF​

There are two options for installing the CMRF:

  • Standalone mode: Execute the CMRF as a standalone Java application on the ConSol CM server machine or another server machine.
  • Overlay mode: Deploy the CMRF in the same application server as ConSol CM.

Configuring the database connection​

The database connection needs to be configured on both the ConSol CM and the CMRF side.

ConSol CM side​

The database connection is configured in the cm6-config.properties file in the application server where ConSol CM runs:

  1. Uncomment the line for the CMRF datasource in the cm6-config.properties file located in <JBOSS_HOME>\bin and provide the settings for your database:
  • cmrf.datasource.url: URL of the CMRF datasource. Example values:
    • PostgreSQL: jdbc:postgresql://localhost:5432/cmrf
    • MySQL 5: jdbc:mysql://localhost/cmrf?serverTimezone=Europe/Berlin
    • MySQL 8: jdbc:mysql://localhost/cmrf?characterEncoding=UTF-8&serverTimezone=Europe/Berlin
    • Microsoft SQL Server: jdbc:sqlserver://localhost:1433;databaseName=cmrf
    • Oracle: jdbc:oracle:thin:@localhost:1521/SERVICE_NAME
  • cmrf.datasource.username: Name of the database user for CMRF
  • cmrf.datasource.password: Password of the database user for CMRF

CMRF side​

The database connection is configured in the cmrf.properties file. This file needs to be saved in the same location from where the cmrf-standalone-<CM_VERSION>.jar is started.

  1. Uncomment the line with the JDBC connection for your database system, starting with spring.datasource.url.
  2. Enter the URL of your datasource Example values:
    • PostgreSQL: jdbc:postgresql://localhost/cmrf
    • MySQL: jdbc:mysql://localhost/cmrf
    • Microsoft SQL Server: jdbc:sqlserver://localhost;databaseName=cmrf
    • Oracle: jdbc:oracle:thin:@localhost:1521/SERVICE_NAME
  3. Provide the username and password:
    • spring.datasource.username: Name of the database user for CMRF
    • spring.datasource.password: Password of the database user for CMRF
info

If needed, you can add settings to override the default logging configuration to this file.

Starting the CMRF​

You need to start both the ConSol CM server and the CMRF server.

ConSol CM server​

Run the following commands to start the application server. Alternatively you can configure it to run as a service (similar to autostart of ConSol CM).

Example start command:

<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-postgresql.xml for PostgreSQL
  • cm6-dwh-mysql-5.xml for MySQL 5
  • cm6-dwh-mysql-8.xml for MySQL 8
  • cm6-dwh-mssql.xml for Microsoft SQL Server
  • cm6-dwh-oracle.xml for Oracle

CMRF application​

Run the following command to start the CMRF:

java -jar cmrf-standalone-<version>.jar

On MySQL, you need to provide the path to the MySQL driver in the start command. In the following example, the connector is saved in the same directory from which the application is started:

java -Dloader.path=mysql-connector-java-8.0.22.jar -jar cmrf-standalone-<version>.jar

Optional settings​

Optional settings are made using Java system properties which are provided as -D parameters to the JAVA_OPTS variable at startup. The following command can be used to set the Java properties:

set JAVA_OPTS="%JAVA_OPTS% -D<option>=<value>"

Truncation of text fields (MySQL only)​

On MySQL, the values of data fields of the type Text (string) are truncated to avoid exceeding the row size limit of MySQL (relevant when a field group contains several text fields to be transferred). By default, only the first 512 characters of the field values are written to the database.

You can modify the number of characters by adding the property cmrf.mysql.truncate.string to the start command of the CMRF, e.g.:

-Dcmrf.mysql.truncate.string=256

Next steps​

Once the CMRF is up and running, you need to enable the DWH in the Web Admin Suite, see ConSol CM Administrator Manual.