Document Validation Quick Start for Java¶

Welcome to the Document Validation Quick Start Guide! This guide will take you through installing, configuring and running Document Validation directly on the Java JVM.

System Requirements¶

Document Validation was built and tested using the Eclipse Temurin OpenJdk version 17. It is recommend to install this version, but other versions may work as well.

Configuration¶

Available Environment Variables¶

Variable	Description
`DOCUMENTVALIDATION_REGULARURL`	(Required) URL of the Regula server.
`DOCUMENTVALIDATION_LOGREQUESTS`	Enable/disable logging of requests. Values: `true` (default) or `false`.
`DOCUMENTVALIDATION_LOGREQUESTSDIRECTORY`	Directory to store logs. Default: `logs/request`.
`DOCUMENTVALIDATION_REGULACLEANUP`	When using `transactionId` and set to `true`, the transaction on the Regula server is permanently deleted after processing.

Linux Examples¶

export SERVER_PORT=8080
export DOCUMENTVALIDATION_REGULARURL=https://document.aware-demos.com  
export DOCUMENTVALIDATION_LOGREQUESTS=false
export DOCUMENTVALIDATION_LOGREQUESTSDIRECTORY="LOGS/REQUESTS"
export DOCUMENTVALIDATION_REGULACLEANUP="false"

Windows Examples¶

set SERVER_PORT=8080
set DOCUMENTVALIDATION_REGULARURL=https://document.aware-demos.com  
set DOCUMENTVALIDATION_LOGREQUESTS=false
set DOCUMENTVALIDATION_LOGREQUESTSDIRECTORY="logs/request"
set DOCUMENTVALIDATION_REGULACLEANUP="false"

Running the Application¶

The application is an executable jar, and the following command can be used to start it:

java -jar target\document-validation-{VERSION}.jar

Where {VERSION} is the version number of the release.

You can query the /version endpoint from the command line to ensure it is running correctly:

curl http://localhost:8080/documentValidation/version