Chapter 7.  Configuration (pdfunit-monitor.config)

Watched folders

The configuration file pdfunit-monitor.config must contain the key WATCHED_FOLDER. Its value is the topmost directory to be monitored. All subdirectories of that directory will be watched.

The PDFUnit-Monitor searches for reference documents in a subdirectory reference/ immediately below the directory which contains the PDF under test. A referenced document has to have the same name as the PDF under test.

The following are examples for the configuration and the corresponding file structure:

#
# Base folder for PDF document which are validated.
# All subfolders will be watched too.
#
WATCHED_FOLDER = ./folder-to-watch/din5008

Logging Port

The PDFUnit-Monitor uses Log4j2 internally and therefore by default port 4445. If this port is used by another application, a different port has to be configured in the files pdfunit-monitor.config and log4j2.xml.

#
# The port defined here must be the same as in the configuration file
# for Log4J "log4j2.xml". Look for "SocketAppender" in that file.
#
PORT_TO_LISTEN = 4445

The file log4j2.xml is used to configure the logging framework. Details are described in chapter 9: “Logging with Log4j2”.

Look and Feel

The appearance of the application can be changed. By default the typical Java-Look is used, but with an entry in the file pdfunit-monitor.config it can be changed into the typical view of the operating system:

# 
# Uncomment the next line to set the general look and feel of the operating system
#LOOK_AND_FEEL = System default

Language

The PDFUnit-Monitor's graphical user interface and error messages are delivered in English and German. The default language is the language of the operating system. But the monitor can explicitly be set to the other language by using the Java system properties. Those properties must be set before the application is started.

-Duser.language=en -Duser.country=UK

The following image shows the PDFUnit-Monitor in German and in the Windows-7 Look-and-Feel:

Installation Folder of DiffPDF

When two PDF documents have different content, it's possible to show the differences with a special diff-program, called 'DiffPDF'. This program, created by Mark Summerfield, is deployed with PDFUnit in a subdirectory of PDFUNIT_MONITOR_HOME. If you want to move it to another folder, you have to change the key DIFFPDF_FOLDER in the config file pdfunit-monitor.config Hint: The name of the folder must end with a forward slash.

#
# Installation definitions for DiffPDF, the free Viewer.
# (Don't forget the trailing slash for the folder.)
# Information about DiffPDF are here: http://www.qtrac.eu/diffpdf.html
#
DIFFPDF_FOLDER     = DiffpdfPortable/
DIFFPDF_EXECUTABLE = DiffpdfPortable.exe

Delay for tooltip windows

The path of a file will be shown as a tooltip when the mouse cursor is over the filename. The delay until the tooltip was shown can be configured with the key TOOLTIP_VISIBILITY_DURATION_MILLISECONDS in pdfunit-monitor.config:

#
# The following property sets the wait time, 
# before a tooltip is visible. 
#
TOOLTIP_VISIBILITY_DURATION_MILLISECONDS = 1500

Here an example for the tooltip: