| Info |
|---|
Site Under Construction by Santiago Aucejo Petzoldt |
| Table of Contents |
|---|
Requirements
- The user has to install a webserver where the web application will be hosted.
We recommend the use of jetty, because it is a lightweight webservlet container easy to set up and with few configuration expenses.
The web application will work on other servlet containers, too. - Deployment of the necessary libraries
Libraries which are used by the web application are integrated in the war file, therefore it runs independently to any JobScheduler instance. - a database connection
A database connection to the database which holds the transfer history has to be configured.
Installation
- a connection to the database which holds the transfer history has to be configured;
- a JobScheduler with the job chains that fill the transfer history tables of the database (not deployed with this setup).
Installation
There are two ways to install the YADE Background Service History Viewer:
- install the YADE Background Service History Viewer with a preconfigured 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 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.
Installation with a preconfigured Jetty
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.
Enter the port you want to use and click 
.
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 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 hold the configured database connection credentials.
Please refer to the documentation of your servlet container in order to configure the web application in your own 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 |
|---|
|
...
|
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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
...
This configuration is used by log4j for logging and storing the log files 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 | ||||||
|---|---|---|---|---|---|---|
| ||||||
|
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 ).
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-SNAPSHOT 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 as while using the version in the context.
- The (Web) adresse doesn´t have to be changed in the bookmarks of clients each time a new version comes out.
The configuration file has to have the same name as the war file.
jade-history-<version>.xml example
...
| borderColor | grey |
|---|---|
| borderWidth | 1 |
| borderStyle | solid |
...
This configuration is used by logback for logging and storing the log files in the location defined by the ${PATH_SET_BY_SETUP} property.