Configuration
ValiMate must be configured to run properly. This is done with an application.properties file that is placed next to the jar. When using the Docker image configuration can be provided through environment variables. Replace the “.” with “_” in the variable names when setting the environment variables.
The default value in the table below is the value that is used when it is not set via environment variable. In the tables confidential information is replaced by *.
General
| Name | Default | Description |
|---|
| SERVER.PORT | 8080 | Server port of the application |
| VALEXECUTION.MAXTHREADCOUNT | 3 | Count of the validations that can run parallel. |
| APP.AUTHKEY | * | UUID that is used in the header attribute “Authorization” of the validation callbacks send by ValiMate. |
Logging
| Name | Default | Description |
|---|
| LOGGING.LEVEL.ROOT | info | Lowest log level that will be printed to the log files |
| AZURE.APPLICATIONINSIGHTS.INSTRUMENTATIONKEY | not available | Instrumentation key for azure application insights |
System handling the retry attempts when a database connection failed for a request
| Name | Default | Description |
|---|
| APP.MAXRETRYATTEMPTS | 3 | Number of retry attempts. |
| APP.MAXRETRYDELAY | 500 | Delay between attempts in milliseconds. |
Database
| Name | Default | Description |
|---|
| DATABASE.USERNAME | null | DB username |
| DATABASE.PASSWORD | null | DB username password |
| DATABASE.HOST | null | DB Host address |
| DATABASE.PORT | null | Port for the DB |
| DATABASE.DBNAME | valimate | Name of the DB |
| DATABASE.USESSL | false | Whether to use SSL. If SSL is enabled the values for trust and key store has to be set. |
| DATABASE.KEYSTOREPATH | null | Path to the key store file |
| DATABASE.KEYSTOREPW | null | Password used for the key store |
| DATABASE.TRUSTSTOREPATH | null | Path to the trust store file |
| DATABASE.TRUSTSTOREPW | null | Password used for the trust store |
System handling data to be validated
| Name | Default | Description |
|---|
| MODELDATAHANDLER.TYPE | file | Whether to use file system or azure blob storage for the origin of the data to be validated |
| MODELDATAHANDLER.IMPORTBASEPATH | null | Path to the azure blob storage container. Has to be set when azure blob storage is used. |
| MODELDATAHANDLER.TOKEN | null | Access token for the azure blob storage container. Has to be set when azure blob storage is used. |
System handling reference data during validation
| Name | Default | Description |
|---|
| REFDATAHANDLER.TYPE | file | Whether to use file system or azure blob storage for the origin of the reference data during validation |
| REFDATAHANDLER.IMPORTBASEPATH | null | Path to the azure blob storage container. Has to be set when azure blob storage is used. |
| REFDATAHANDLER.TOKEN | null | Access token for the azure blob storage container. Has to be set when azure blob storage is used. |
System handling the result report data for a validation
| Name | Default | Description |
|---|
| RESULTDATAHANDLER.TYPE | file | Whether to use file system or azure blob storage for writing result reports of validations. |
| RESULTDATAHANDLER.IMPORTBASEPATH | null | Path to the azure blob storage container. Has to be set when azure blob storage is used. |
| RESULTDATAHANDLER.TOKEN | null | Access token for the azure blob storage container. Has to be set when azure blob storage is used. |
System handling the basic pre check data for a SHACL validation
| Name | Default | Description |
|---|
| PRECHECKDATAHANDLER.TYPE | file | Whether to use file system or azure blob storage for reading the SHACL-files. |
| PRECHECKDATAHANDLER.IMPORTBASEPATH | null | Path to the azure blob storage container. Has to be set when azure blob storage is used. |
| PRECHECKDATAHANDLER.TOKEN | null | Access token for the azure blob storage container. Has to be set when azure blob storage is used. |
| PRECHECKDATAHANDLER.ENABLE | false | Whether to use basic pre checks during SHACL validation. |
| PRECHECKDATAHANDLER.FILEEXTENSION | null | Sets what file extension the SHACL file have. |