DataVeil Data Masking User Guide
DataVeil Data Masking User Guide

Install for Command Line Usage

Never install DataVeil on a production server. Never connect DataVeil to a production database.

 

Overview

DataVeil data masking projects can be run from the command line of Windows and Linux systems.

This is done by running the DvWorker.jar file that is supplied in the DataVeil software distribution.


System Requirements

DvWorker requires Java JDK and is compatible with versions from Java 17 to 23 inclusive.

The JDK can be on the OS default path or the JDK path can be explicitly specified in the run command. See Command Line Execution for details.

Note that the DataVeil GUI already uses a pre-configured OpenJDK 21 that is supplied with the software. It is found under the folder jdk/ so you could also use this for the command line execution, if you do not already have a JDK configured on your system

DvWorker will also need access to the relevant JDBC drivers for database connectivity as described below.

You can either run DvWorker.jar directly from the delivered commandline/ directory, or you can copy DvWorker.jar and the drivers/ directory to another environment where you intend to run DataVeil from the command line.

 

Directory Structure

The DataVeil software distribution contains a directory called commandline/ as shown below.

commandline/

├── DvWorker.jar

├── drivers/
│    ├── mssql-jdbc_auth-10.2.1.x64.dll (1)
│    ├── mssql-jdbc-10.2.1.jre11.jar
│    ├── postgresql-42.7.5.jar
│    ├── mysql-connector-java-8.0.29 (2)
│    ├── ojdbc11.jar (3)
│    └── orai18n.jar  (3)

└── examples/
      ├── run_dvworker.bat  (4)
      ├── run_dvworker.ps1  (4)
      └── run_dvworker.sh  (4)

 

DvWorker.jar

 

DataVeil command-line execution engine

 

drivers/

 

JDBC drivers for supported databases.

 

examples/

 

 

 

 

This contains sample command-line files for their respective environments that you can copy and customize for your needs.
(4) run_dvworker.bat and run_dvworker.ps1 will only be included for Windows distributions.

    run_dvworker.sh will only be included for Linux distributions.

 

 

JDBC Drivers

DvWorker loads database drivers from the drivers/ directory.

Drivers for the following platforms are included in the commandline/drivers/ directory in the DataVeil distribution:

Microsoft SQL Server

 

 

 

mssql-jdbc-10.2.1.jre11.jar

mssql-jdbc_auth-10.2.1.x64.dll (1)

(1) This is only required for Windows if Integrated Authentication is used.

 

PostgreSQL

 

postgresql-42.7.5.jar

 

 

Due to licensing restrictions, if connectivity is required to the following DBMS platforms, then you must download the following drivers from Oracle and place these in the <drivers-dir> directory described in Command Line Execution.

(2) MySQL

 

 

mysql-connector-java-8.0.29

See Install MySQL JDBC Driver

 

(3) Oracle

 

 

 

ojdbc11.jar
orai18n.jar

See Install Oracle JDBC Driver

 

 

 

The DataVeil command line run command will need to specify the path to the JDBC drivers directory. Please refer to <drivers-dir> in Command Line Execution.

 

This concludes the installation and preparation for running DataVeil from the command line.