SQL Data Masking Parameters and Actions

GetMetaData

The GETMETADATA Action retrieves the metadata from the Source Data that is needed to run the Mask. It is a composite action, made up of three sub-actions. Each sub-action be run in a single action as "GETMETADATA", or can be run separately. GETMETADATA is recommended for simplicity and speed.

Running the actions individually is valuable for closer analysis, learning, and debugging.

The TABLES Action retrieve metadata related to the tables in the Source Database.

The GETKEYS Action retrieves metadata from the Source Database.

The FINDIDENTITYCOLUMNS Action retrieves the Identity Columns for each specified table.

Note: When passed in -parActions, it should be lower case – 'getmetadata'

Mask

Applies the masking set in the MaskingRules sheet.

ScanColumns

For all the tables in the tables tab gets details about the columns. If parUseScanRules = True then the regexes in parScanRulesLocation are run against column values. The number of rows of each table sampled by the scan is set by parSampleSize

ScanColumns InsertLists

Takes seedlist files in parListCSVDirectory and inserts the data into parListTableName

parAction

String

See Yes

parApplyUpdates

Boolean

1

Updates are committed to the DB. If false update SQL is written to parUpdatesFile.

No

parAudit

Boolean

Write before and after values to .csv files in parAuditDirectory (there will be one file for each table masked). Currently only supported for SQL Server.

No

parAuditDirectory

String

AuditFiles

Directory path where parAudit values are written

No

parAuditTablePrefix

String

CSI_

Auditing works by writing data to tables, these are named based on existing table names but with a prefix

Only if parAudit is set to True

parCleardownReport

Boolean

1

Delete parReportFile before writing to it

No

parCommandTimeout

Int

600

Number of seconds before a timeout happens if executed command freezes.

No

parControlExcel

String

The Control Spreadsheet mentioned in the documentation.

Yes

parDatabaseType

String

SQL SERVER

Supported DBs are SQL Server, Oracle, MySQL, Postgres, DB2, MariaDB

Yes

parListCSVDirectory

String

Seedlists

Directory where the Seedlists are located

Only if parAction is set to "InsertLists" or List masking functions are used with UseDBFunction in the MaskingRules set to "No"

parListTableName

String

[Masking].[dbo].[List]

Name of the DB table containing seed lists

Yes, unless all List masking functions have UseDBFunction in the MaskingRules set to "No"

parLocale

String

en

Applies when using "VIP functions". For a list of parLocale values for all languages, see https://docs.microsoft.com/en-us/openspecs/windows_protocols/ms-lcid/a9eac961-e77d-41a6-90a5-ce1a8b0cdb9c

No

parOutputValues

Boolean

If True post-masking values are written to parValuesDirectory

No

parReportFile

String

MaskReport.txt

The name of the file where the Mask report is saved.

No

parSampleSize

Int

100

Number of rows to scan

No

parScanAllTypes

Boolean

Only the data types listed in the ScanParameters sheet are scanned.

No

parScanRulesLocation

String

DataScannerRules.csv

Filename (including path) where the ScanRules are located.

Only if parAction is set to "ScanColumns" and parUseScanRules is set to True

parSequencePrefix

String

CSI

For sequential list masking functions a database sequence is used names according to the table being masked, the supplied prefix is appended to the sequence name.

No

parSequenceSchema

String

dbo

Only if List masking functions are used with Parm1 set to "sequential"

parSQLActionsPath

String

SQLActions.vip

Path where the SQLAction.vip is located.

Yes

parUpdatesFile

String

Updates.SQL

Filename of the file that contains the Updates.

No

parUseScanRules

Boolean

1

Apply the regexes listed in parScanRulesLocation

No

parValuesDirectory

String

ValuesFiles

Directory where parOutputValues are written

No