Masking Report

A Masking Report is automatically generated upon the completion of every data masking run.

Optionally, you can configure reports to be generated for preview masking runs too.

You can review these reports under the Execution Reports tab as shown below.


Masking Result XML File

A complete masking result XML file is created upon a data masking run completion.

It is located in the folder corresponding to the masking run that appears in the Current and Archive tabs in the left pane.

You can open the containing folder by right clicking on a search result folder and selecting "Open in OS Application" (i.e. 'open the folder using the operating system's default application') as shown below.

Important: Please do not edit or remove the XML file. The PDF report is generated from this file and the outcome status icon depends on it (success, warning and error icons).


Current Tab

This is where each new masking run report XML and PDF file are created.

Masking results in this folder are subject to automatic file deletion. Please refer to the Masking Report Configuration section below.


Archive Tab

This folder is intended to act as a repository for results that you wish to keep indefinitely.

Masking results in this folder are never automatically deleted.


Masking Report Configuration

You can customize the PDF report that is generated and shown in the preview window (as above).

Click on the report settings icon  to display the configuration tabs below.


The File Management Tab

A masking report is always generated upon the completion of every data masking run. i.e. a run that overwrites original values.

Reports can optionally be generated for Preview masking runs.

A copy of the masking project file can optionally be saved together in the same folder as the report. Note: Only a copy of the project file is saved - copies of any external resources such as CSV files that the project file may reference are not saved.

You can set the maximum number of masking results to keep in the Current folder before the oldest are automatically deleted.


The Report Customization Tab

You can specify custom headings and which sections of a masking report you would like to include in the generated PDF.


Using the settings above, you can see where the custom labels appear in a PDF report, as shown below.

Include Logger Section

It is recommended that you keep this checkbox selected because it will include in the PDF report any warning and error messages that were generated during the masking run.

Note: These messages are never lost regardless of the setting of this checkbox. The messages are always stored in the XML file. This checkbox controls only whether those messages are included in the PDF report or not. The PDF report can be recreated at any time. See the next section below.


The Email Notification Tab

You can specify that DataVeil should send an email to one or more recipients upon the completion of a data masking run. This applies regardless of whether the masking run was performed from the GUI or command line.

You will first need to ensure that your email server settings have been configured. Please refer to the Email Server Settings section.


Recreate Existing PDF Reports

It may be that you already have an existing PDF report that you would like to customize.

This is easily accomplished. Simply set your customization parameters as described above, then right-click on the report folder in the Reports tab corresponding to the masking run and choose "Create PDF..." from the popup menu.

A dialog will ask you to confirm that you would like to replace the exiting PDF report.