Installation

Risk Management Toolbox is a Spring Boot application that can be deployed in multiple ways.

The software does not require external dependencies like a database or a pre-installed software. All required dependencies are packaged within the software.

See Spring Boot official's documentation for details about Spring Boot deployments.

Development setup

The delivered WAR file can be set as executable in order to be easily started from command-line on UNIX systems.

Starting Risk Management Toolbox server

> chmod +x toolbox-war-1.X.X.war
> ./toolbox-war-1.X.X.war

The configuration files application.yml, application-rmt.yml or application-rmt-custom.yml located in the same folder as the WAR file will be automatically scanned.

The server starts on port 8080.

Configuration

Temporary files directory

The software might create temporary files on the system when the system is running low memory or when it handles large files. Temporary files are created in the default system tmp directory. The directory can be changed with the system property java.io.tmpdir.

The application must have the READ/WRITE permissions on this temporary folder.

Logging

The application's logs can be configured through a Log4j2 configuration file.

The file named log4j2.xml has to be present on the application's classpath.

The example below show a basic log4j2 configuration.

log4j2.xml sample file

<?xml version="1.0" encoding="UTF-8"?>
<Configuration status="WARN" monitorInterval="30">

	<Properties>
		<Property name="appenderPattern">%d %-5 p [%c] (%t) %m %n</Property>
	</Properties>

	<Appenders>
		<Console name="console" target="SYSTEM_OUT">
			<PatternLayout pattern="${appenderPattern}" />
		</Console>

	</Appenders>

	<Loggers>
		<!-- LOG everything at INFO level -->
		<Root level="info">
			<AppenderRef ref="console" />
		</Root>

		<!-- Set logging level to DEBUG for more information about validation -->
		<Logger name="ch.sysmosoft.riskmanagement.toolbox" level="INFO" />

		<!-- Reduce logging level of packages that are too verbose -->
		<Logger name="de.redsix" level="WARN" />
    <Logger name="org.verapdf" level="WARN" />
		<Logger name="org.apache.pdfbox.pdmodel.font.PDType0Font" level="ERROR" />
	</Loggers>

</Configuration>

More details on Log4j2 official's documentation.