Product Knowledge Base

Space shortcuts

Page tree

Versions Compared

Old Version 16

changes.mady.by.user Santiago Aucejo Petzoldt

Saved on

compared with

New Version 17

changes.mady.by.user Alan Amos

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Minor corrections to text
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 that fill the transfer history tables of the database (not deployed with this setup).

Installation

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

  • Install install the JADE Background Service History Viewer with a preconfigured jetty.Jetty;
  • Install install the JADE Background Service History Viewer in your own webservlet container.

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

...

To install the JADE 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.

...

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.

PfadPathDateiFileVerwendungUsage
/WEB-INF/classeslog4j.propertieslog4j configuration to log with log4j
/WEB-INF/classeslogback.xmllogback configuration to log with logback
/WEB-INF/classeshibernate.cfg.xmldatabase configuration file

...

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 example

Panel
borderColorgrey
borderWidth1
borderStylesolid

<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.