The following sections describe installing PDFUnit-XML, PDFUnit-Java and iText. All of these components are needed to run PDFUnit-XML.
Download the file
pdfunit-xml-VERSION.zip from the project site:
If you have purchased a license, you get the ZIP file by mail.
Unzip the file in a folder which is refered to in the following text as
The following table describes the directory structure.
ANT build script:
||Place the iText and PDFUnit-Java runtime libraries into this folder. They are necessary to run PDFUnit-XML.|
||Style sheets that are needed to process PDFUnit-XML|
||XML schema file to validate the PDFUnit tests|
||License information for all libraries used by PDFUnit|
||Examples. You should place your own tests here.|
||PDF documents for the test examples. You can also store your own test documents here.|
The following figure illustrates this structure.
PROJECT_HOME/index.xml contains links to useful
files in the project.
The installation comes with the start-script
This ANT script can run on Windows and Linux.
You can start the script as described in the next chapter.
The test results can be reached from the page
It is possible to start the project with other scripting languages. Please write a mail to support[at]pdfunit.com if you need help.
PDFUnit-XML requires PDFUnit-Java at runtime. It can be downloaded here: PDFUnit-Java. Make sure that the PDFUnit-Java version matches the PDFUnit-XML version. Which versions work together are documented in the file 'readme.txt'.
Unzip the downloaded ZIP file and copy the resulting folder so it is subfolder of
This folder is called
PDFUNITJAVA_HOME in the following text.
You need iText version 5.3.3 or higher. Download it from here (http://sourceforge.net/projects/itext/files/iText/).
Unzip the iText ZIP file and also copy the resulting folder so it is a subfolder of
Note that iText requires a license for commercial use.
You are welcomed to evaluate PDFUnit. In this case, a message box appears showing a simple math calculation you have to solve. If you calculate successfully the test will run, otherwise you have to restart your test and calculate again.
Sometimes the message box is covered by other applications. Then the ANT or Maven script is blocked. Minimize all applications to look for the message box.
PDFUnit comes with some utility programs to extract information from PDF documents. These tools do not need a license key.
If you use PDFUnit in a commercial context you need a license. Write a mail to license[at]pdfunit.com and ask for a license. You will receive an answer as soon as possible.
The license fee is calculated individually. A small company should not pay as much as a big company, and someone testing only a few PDF documents, of course, pays less. And if you want to get a free license, give us some reasons. It is not impossible.
If you have ordered a license you will receive a ZIP file and a separate file
license-key_pdfunit-java.lic. Copy this file to
Any change to the license file makes it unusable. If this happens contact PDFUnit.com and ask for a new license file.
If you have a problem with the configuration start the script
You will get a detailed problem analysis. See chapter
11.5: “Verifying the Configuration”.