Installation as WAR file

In operating environments in which Java and Tomcat are already present, Cadenza Web can be installed and updated as an additional application through a WAR file.

The Cadenza Web configuration files and repositories can be maintained independently of the Cadenza Web installation. Updates to Cadenza Web are therefore quick and easy.

This document assumes you have the CadenzaWeb Docker ZIP file accessible through your Cadenza distribution. You can also use the disy Registry to download disy Cadenza.

You will need credentials (username/password) to be able to pull the Cadenza zip file. Please get in touch with your account representative to receive these credentials.

Requirements

Eclipse Temurin 21
Apache Tomcat 10.1

Contents of the zip file

README file
WAR file with Cadenza Web
Directory cadenza-config with a sample configuration for Cadenza Web
Changelog file

Installation

Install the Tomcat server.
Save the WAR file in the webapps directory of the Tomcat installation.
If you do not yet have your own configuration files for Cadenza Web, move the supplied sample configuration to its directory (the path to the storage location is specified during configuration).
Configure the Tomcat installation with the required and recommended settings listed below.
Make sure that Cadenza Web has write access to the Tomcat directories temp and logs.
Start the Tomcat server.

Update

Save the WAR file in Tomcats webapps directory.
Delete the "cadenza" directory with the previous Cadenza web version.
Configure the Tomcat installation with the required settings listed below and, if necessary, with the recommended settings.
Make sure that Cadenza Web has write access to the Tomcat directories temp and logs.
Start the Tomcat server.

Please also check the size of the temp directory regularly and delete the files if necessary — outside of operational hours!

Configuration

Required Tomcat Configuration

The following configuration should be changed or added in your Tomcat server.xml configuration file:

<Connector> Configuration

On the <Connnector> element set the following properties:

compression should be set to on
compressibleMimeType should be set to a sensible value, see the example for a recommendation.

An example <Connector> definition would be:

    <Connector port="8080" protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443"
               URIEncoding="UTF-8"
               compression="on"
               compressibleMimeType="text/html,text/xml,text/plain,text/css,text/javascript,application/x-javascript,application/javascript,application/json,text/json,application/vnd.disy.grid.square+json,text/html+fragment,application/vnd.disy.isochrone+json,application/vnd.disy-postmessage+json,application/problem+json,application/vnd.disy.route+json,application/vnd.disy.selection.features+json,application/vnd.disy.timeline+json,application/vnd.disy.vector-layer.features+json,application/vnd.disy.wfs+json" />

Required Cadenza settings

Command line options are configured:

for Cadenza Web as a Windows service: in the service.bat file for the parameter -JvmOptions
in all other cases: in the file setenv.bat or setenv.sh for the parameters Java_opts and Catalina_opts

Paths and file names can either be defined as Java system properties or as environment variables of the operating system:

as Java System Properties: in the file setenv.bat or setenv.sh
as an environment variable:
- under Linux: Either export the variables in the setenv.sh file or make sure that the variables are already defined beforehand, for example via a .profile file or a .bashrc file.
- under Windows: You can configure the variables in the Environment variables system setting of Windows.

If a path or a file name is defined via both, Java system property and an environment variable, the value of the Java system property is used.

Command line options

The following command line options must be added for the -JvmOptions parameter:

Setting Value

Setting	Value
Disabling the headless mode The Java VM must not run in headless mode, as Cadenza Web partially uses the AWT UI Toolkit to render images in maps.	`-Djava.awt.headless=false`

Disabling the headless mode

The Java VM must not run in headless mode, as Cadenza Web partially uses the AWT UI Toolkit to render images in maps.

-Djava.awt.headless=false

Path to configuration files (Config directory)

Environment variable

CADENZA_CONFIG_PATH

Java System Property

CADENZA_CONFIG_PATH

Default value

<Cadenza working directory>/config

All other properties you can set are documented in the Administration Documentation for the Cadenza Version you downloaded.

Recommended settings

The command line options can be configured:

if Cadenza Web is running as a Windows service: in the file service.bat
in all other cases: in the file setenv.bat or setenv.sh

Maximum memory available for Cadenza Web.

The default values are usually too low.

-Xmx<memory in MB or GB>

Examples:

-Xmx2000M -Xmx2g

Language of the user interface.

If no explicit setting is made (recommended), the language setting of the operating system is used.

-Duser.language=<language code> -Duser.country=<country code>

Example:

-Duser.language=de

-Duser.country=DE

Other possible settings

The settings can either be defined as Java system properties or as environment variables of the operating system:

as Java System Properties: in the file setenv.bat or setenv.sh
as an environment variable:
- under Linux: Either export the variables in the setenv.sh file or make sure that the variables are already defined beforehand, for example via a .profile file or a .bashrc file.
- under Windows: You can configure the variables in the Environment variables system setting of Windows.

If a path or a file name is defined via both, Java system property and an environment variable, the value of the Java system property is used.

Ending the Cadenza web session after closing the browser

After closing the browser window without logging out, the Cadenza web session is ended after a certain time. The time must be specified in minutes and should only be a few minutes.

Environment variable

CADENZA_SESSION_TIMEOUT

Java System Property

CADENZA_SESSION_TIMEOUT

Default value

The value set in webapps/cadenza/WEB-INF/web.xml

Ending an inactive Cadenza web session

A Cadenza web session is ended after a certain period of time without user input. A corresponding message is displayed. The time must be specified in minutes.

Environment variable

CADENZA_MAXKEEPALIVEINTERVAL

Java System Property

CADENZA_MAXKEEPALIVEINTERVAL

Default value

The value set in webapps/cadenza/WEB-INF/web.xml