Info
Site Under Construction by Santiago Aucejo Petzoldt

Table of Contents

Requirements

a database connection
A database connection to the database which holds the transfer history has to be configured.;
a JobScheduler with the Job Chains to job chains that fill the transfer history tables of the database (not deployed with this setup).

Installation

There are two ways to install the JADE YADE Background Service History Viewer.:

Install install the JADE YADE Background Service History Viewer with a preconfigured jetty.
Status
colour Yellow
title draft
Jetty;
- This is recommended for supported platforms.
- For platforms with limited support the installer can still be used if available. However, the uses is responsible for required changes in the webservlet container start script (start.sh).
install the YADE Install the JADE Background Service History Viewer in your own webservlet container
- This is recommended for users who want to use their individual webservlet container.

After selecting the install path you are prompted to decide whether you want to install the YADE Background Service History Viewer with a preconfigured Jetty or use and already installed servlet container.

Image Added

Installation with a preconfigured Jetty

Status

colour	Yellow
title	draft

TBD

To install the YADE Background Service History Viewer, check the checkbox. The text field to choose a path will disappear and a text field to enter the port for Jetty will be shown.

Image Added

Enter the port you want to use and click Image Added.

In the next step you will be prompted to choose the database you are using and then insert the credentials for the database connection.

After the installation process has finished the new service will have been installed and be active. The name of the service will be "SOS JadeHistoryViewer" (Windows) or "jadehistoryviewer" (Linux) respectively.

Now you can use the YADE Background Service History Viewer with your Browser under the address http://[HOSTNAME]:[PORT]/JadeHistoryViewer.

Installation in your own Servlet Container

...

During the installation process you will be prompted to:
configure the path to where the war file of the webapplication web application will be stored.;
configure the credentials for the database connection to the database holding the data of the transfer history.
add the jobscheduler, which has to perform the JADE Job Chains to fill the database with the transfer history.
The war file will be stored in the configured path and holds hold the configured database connection credentials.
To Please refer to the documentation of your servlet container in order to configure the web application in your own servlet container properly please refer to the documentation of your servlet container.
Use this option to install a newer version of the web application as well.

Configuration Files

The war file jade-history-<version>jadeHistoryViewer.war contains some configuration files , which a that are updated during setup.

PfadPath	DateiFile	VerwendungUsage
/WEB-INF/classes	log4j.properties	log4j configuration to log with log4j
/WEB-INF/classes	logback.xml	logback configuration to log with logback
/WEB-INF/classes	hibernate.cfg.xml	database configuration file

hibernate.cfg.xml

Panel

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE hibernate-configuration PUBLIC "-//Hibernate/Hibernate Configuration DTD 3.0//EN"
"http://www.hibernate.org/dtd/hibernate-configuration-3.0.dtd">
<hibernate-configuration>
<session-factory>
<property name="hibernate.connection.driver_class">org.mariadb.jdbc.Driver</property>
<property name="hibernate.connection.password">DBPASSWORD</property>
<property name="hibernate.connection.url">jdbc:mysql://DBHost:DBPort/DBName</property>
<property name="hibernate.connection.username">DBUSERNAME</property>
<property name="hibernate.dialect">org.hibernate.dialect.MySQLInnoDBDialect</property>
<property name="hibernate.show_sql">false</property>
<property name="hibernate.connection.autocommit">false</property>
<property name="hibernate.format_sql">true</property>
<property name="hibernate.temp.use_jdbc_metadata_defaults">false</property>
<property name="javax.persistence.validation.mode">none</property>
<mapping class="sos.ftphistory.db.JadeFilesDBItem"/>
<mapping class="sos.ftphistory.db.JadeFilesHistoryDBItem"/>
</session-factory>
</hibernate-configuration>

This configuration will be updated with the credentials specified during the setup routine.

log4j.properties

...

The below setting for ${PATH_SET_BY_SETUP} is replaced by the installer with the path of the target directory

Panel
borderColor grey
borderWidth 1
borderStyle solid
`# Set the log level of the root logger to WARN`
`log4j.rootLogger=DEBUG, consoleAppender, fileAppender`
`# Direct log messages to the console`
`log4j.appender.consoleAppender=org.apache.log4j.ConsoleAppender`
`log4j.appender.consoleAppender.layout=org.apache.log4j.PatternLayout`
`log4j.appender.consoleAppender.layout.ConversionPattern=%5p [%t] (%F:%L) - %m%n`
`# Direct log messages to a file`
`# Set the file appender to a rolling file appender with a date configuration`
`log4j.appender.fileAppender=org.apache.log4j.DailyRollingFileAppender`
`# Set the type of the pattern layout to EnhancedPatternLayout to display local timezone`
`log4j.appender.fileAppender.layout=org.apache.log4j.EnhancedPatternLayout`
`# Set the pattern layout`
`log4j.appender.fileAppender.layout.ConversionPattern=%-5p [%d{yyyy-MM-dd HH:mm:ss,SSS Z}]: [%t] (%F:%L) - %m%n`
`# Set the output file an its path`
`log4j.appender.fileAppender.File=${java.io.tmpdirPATH_SET_BY_SETUP}/JadeHistoryJadeHistoryViewer.log`
`# Set the append to true, should not overwrite`
`log4j.appender.fileAppender.Append=true`
`# Set the immediate flush to true`
`log4j.appender.fileAppender.ImmediateFlush=true`
`# Set the threshold to debug mode`
`log4j.appender.fileAppender.Threshold=debug`
`# Set the date pattern when the rollover should happen (daily at midnight)`
`log4j.appender.fileAppender.DatePattern='.'yyyy-MM-dd`
This configuration is used by log4j for log4j logging and stores storing the log files to the ${java.tmp.dir}. When using jetty, ${java.tmp.dir} will point to path of the working copy where jetty upacks the war file.
...
in the location defined by the ${PATH_SET_BY_SETUP} property.

logback.xml

The below setting for ${PATH_SET_BY_SETUP} is replaced by the installer

Panel

borderColor	grey
borderWidth	1
borderStyle	solid

<configuration debug="true">
<property name="PATH_FOR_LOGFILES" value="${java.io.tmpdirPATH_SET_BY_SETUP}"/>
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder>
<pattern>%-5level [%d{yyyy-MM-dd HH:mm:ss.SSS}]: [%thread] %logger [%file:%line] - %msg%n</pattern>
</encoder>
</appender>
<appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">
<file>${PATH_FOR_LOGFILES}/JadeHistoryJadeHistoryViewer.log</file>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">

<fileNamePattern>${PATH_FOR_LOGFILES}/JadeHistory.%d.log</fileNamePattern>

<maxHistory>7</maxHistory>
</rollingPolicy>
<encoder>
<pattern>[%-5level] [%d{yyyy-MM-dd HH:mm:ss.SSS}]: [%thread] %logger [%file:%line] - %msg%n</pattern>
</encoder>
</appender>
<root level="debug">
<appender-ref ref="STDOUT" />
<appender-ref ref="FILE"/>
</root>
</configuration>

This configuration is used by logback for logback logging and stores storing the log files to the ${java.tmp.dir}. When using jetty, ${java.tmp.dir} will point to path of the working copy where jetty upacks the war file.

Configuration of the web application

The web application is configured in a xml file, which

contains the configuration of the context of the web application.
is named the same as the war file.
resides in the same directory as the war file (deployment with Jetty, Tomcat has a separate directory for context files ).

Image Removed

In the configuration set the context to /jade-history-viewer to make sure the web application is reachable at http://<host>:<port>/jade-history-viewer .

When no context is configured there is still the fallback to the default setting which simply uses a context with the same name as the war file (e.g. jade-history-viewer-1.8.0 or jade-history-viewer-1.8-4236-26901), which

contains version information and therefore will get quite confused after some time.
changes with each new version(e.g. update of version 1.8.0 to 1.8.1).

Using a context configuration has the following advantages:

The (Web) adresse is easier to read.
The (Web) adresse doesn´t have to be changed in the bookmarks of clients each time a new version comes out.

jade-history-<version>.xml example for a jetty context configuration

...

borderColor	grey
borderWidth	1
borderStyle	solid

...

in the location defined by the ${PATH_SET_BY_SETUP} property.

Space shortcuts

Page tree

Versions Compared

Old Version 14

New Version Current

Key

Requirements

Installation

Installation with a preconfigured Jetty

Installation in your own Servlet Container

Configuration Files

hibernate.cfg.xml

log4j.properties

logback.xml

Configuration of the web application

jade-history-<version>.xml example for a jetty context configuration

Space shortcuts

Page tree

Page History

Versions Compared

Old Version 14

New Version Current

Key

Requirements

Installation

Installation with a preconfigured Jetty

Installation in your own Servlet Container

Configuration Files

hibernate.cfg.xml

log4j.properties

logback.xml

Configuration of the web application

jade-history-<version>.xml example for a jetty context configuration