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.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 wether whether you want to install the JADE YADE Background Service History Viewer with a preconfigured jetty Jetty or to use and already installed servlet container.

Installation with a preconfigured Jetty

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

Insert Enter the port you want to use and click .

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

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

Now you can use the JADE 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.

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.

To reinstall Use this option to install a newer Version version of the webapplication use this option, tooweb application as well.

Configuration Files

The war file jadeHistoryViewer.war contains some configuration files , which that are updated during setup.

hibernate.cfg.xml

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=${PATH_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  $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="${PATH_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}/JadeHistoryViewer.log</file> <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy"> <!-- daily rollover --> <fileNamePattern>${PATH_FOR_LOGFILES}/JadeHistory.%d.log</fileNamePattern> <!-- keep 7 days' worth of history --> <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  $in the location defined by the ${PATH_SET_BY_SETUP} property.