Components

Overview

DataVeil Components enable the user to define re-usable masking definitions.

Each Component definition is saved as a separate XML text file to the Component Home directory so that it can be conveniently referenced by other DataVeil masking project files. The directory location can be anywhere, such as on a convenient network server, and is specified in the Directories Option. Component Home can also be conveniently set by clicking on the Settings icon in the Components tab.

Component definitions are not saved within a project file. Only the references from a project to Component definitions are saved in a project file.

Therefore, if a Component definition's configuration is later modified by the user then all masking projects referencing the Component will automatically pick-up the new configuration of the Component.

Types

There are three types of Components: Mask, Macro and DataSet.
 

Mask Component

A Mask Component is an ordinary DataVeil mask whose configuration parameters are saved as a Component definition.

For example, A Randomize mask with specific partial masking parameters could be saved as "my_randomize_mask". Now, instead of defining multiple copies of a Randomize mask and having to manually define the same required parameters each time, the user can just use a reference to the Component mask "my_randomize_mask".
 

Macro Component

A Macro Component is DataVeil macro that is saved as a Component. A DataVeil macro is a variable name beginning with "#" that specifies text substitution in the masking project.

For example, if there is a Where condition that is commonly used among masks (even within other Components) such as "PK >= 1000 AND PK < 10000" then instead of having to specify this explicit condition in every mask that needs it, the user could just define a Macro "#my_where_pk_range" whose value shall be "PK >= 1000 AND PK < 10000" and now each mask's Where condition can simply specify #my_where_pk_range. If at some time in the future this condition needs to change to say "PK >= 500 AND PK < 5000" then it only needs to be updated in the Macro Component definition and all project references shall automatically use the updated value.

Macros can be overridden at different scope levels (column, table, database, project or Component). Alternate values for the same Macro variable can be defined according to the DBMS type.
 

DataSet Component

A DataSet Component defines the location of a CSV file and how it is to be parsed, such as which row is a heading row (if any), separators, etc.

DataSet masks in any masking project that need to access this CSV file can then simply refer to the DataSet Component. In future, if the location or structure of the file changes then only the single DataSet Component definition needs to be updated.

Note: A DataSet Component is functionally similar to the DataSet definitions that can be defined under the DataSets tab. The difference is that a DataSet Component is saved in the Component Home directory as a separate XML text file and can be access by any project whereas the definitions under the DataSets tab are saved within the project file and are private to the project in which they were defined.

Component Home and Paths

DataVeil saves all created Components to the folder defined by the Component Home path. This is also the folder searched for any Component references when a masking project is executed.

Caution: Component Home does not necessarily correspond to the components displayed in the Components tab. The displayed components are those found at the Browse Path. The Restore Home icon will only be visible if the Browse Path is not the same as Component Home. It is recommended to always restore the Browse Path to Component Home after any browsing of components in other folders in order to avoid confusion later or for the next user.