Install the GUI
Never install DataVeil on a production server. Never connect DataVeil to a production database.
System Requirements
The DataVeil GUI includes an pre-configured OpenJDK 21.
Therefore, in order to run the DataVeil GUI, you do not need to have Java already installed on your system.
Step 1: Unzip the downloaded DataVeil software ZIP file
The DataVeil software is delivered in a ZIP file that has the version number and platform appended to it.
E.g. "dataveil_5_0_0_win_x64.zip" corresponds to DataVeil version 5.0.0 for Windows 64 bit systems.
You can perform an "Extract Here' type command because the contents of the archive are in a single root folder called "dataveil".
Note: On Windows systems, please be aware that placing the dataveil folder under a system folder, such as Program Files, may result in security-related errors when attempting to run DataVeil and that the cause of such errors may not be obvious. In such a case, just place the dataveil folder outside of any system folder.
The contents of the "dataveil" folder are:
On Linux systems, the relevant permissions on installed files shall already be set so chmod should not be necessary.
JDBC Drivers
DataVeil communicates with database servers using JDBC.
The JDBC drivers for SQL Server/Azure SQL DB/MI and PostgreSQL are already included with the DataVeil software.
However, if you will be connecting to Oracle or MySQL databases then you will need to download these drivers separately as these could not be included with the DataVeil software due to licensing restrictions. See Steps 2 and 3 below.
Step 2: Install The Oracle JDBC Driver
If you will not be connecting to Oracle databases then you can skip this step.
Otherwise, please follow the instructions in the section Install Oracle JDBC Driver.
Step 3: Install The MySQL JDBC Driver
If you will not be connecting to MySQL databases then you can skip this step.
Otherwise, please follow the instructions in the section Install MySQL JDBC Driver.
Please note that DataVeil uploads masking functions during masking and therefore if binary logging is enabled on your DBMS then you will need to set the MySQL system variable log_bin_trust_function_creators to 1. For further information see MySQL Stored Program Binary Logging.
Step 4: DataVeil Native Libraries (Optional)
If you will be masking Oracle or SQL Server databases (including Azure SQL Managed Instance) then it is recommended to install the DataVeil Native Libraries on the DBMS.
These are optional but they offer a significant performance boost for the masking functions on Oracle (approximately 2x) and SQL Server (approximately 10x). Table writer performance is unchanged.
If you do not install these Native Libraries then DataVeil shall operate normally but without the performance boost offered by the Native Libraries.
Step 5: Environment Settings
It is recommended that you review the environment settings. These are optional but will likely enhance the operation and ongoing usability of DataVeil for you.
These settings are:
* DataVeil User Data Location: Masking and discovery reports shall be generated here. Components and Discovery custom patterns are also stored here.
* Email Server Settings: Masking completion notifications and reports can be automatically sent to specified email addresses.
To configure these settings, please refer to Environment Settings.
Other System Settings
Other system settings are optional but may be useful in your environment.
These include being able to explicitly define the Java JDK folder for DataVeil to use and the default GUI font size.
Please refer to System Customization.
This concludes the installation of the DataVeil GUI.
To start the DataVeil GUI please refer to Starting the Graphical User Interface.