Data Masking from the Command Line
Learn more about data masking from the command line:
Overview of Steps
The automated actions used during Data Masking can be performed either using the VIP Server Controller, or from the Command Line. The recommended way is using the VIP Server Controller. If users prefer to use command-line execution, the process is described in this section of the Knowledge Base.
Much of this process has been documented in the previous sections of the knowledge base. Please use the hyperlinks above to refer to the documentation when completing these steps. The difference comes when executing the automated actions. These steps are marked with an Asterix above.
These automated actions can be run from the Command Line using Command Scripts. These scripts provide the parameters otherwise entered into The VIP Server Controller. This section of the Knowledge Base therefore provides instructions on parameterizing and executing these Command Script.
Note: "Template" scripts are shipped during the installation of VIP and the VIP Server Controller. You can copy these scripts, edit the parameters, and use them to run the actions via the Command Line.
Run GETMETADATA and SCANCOLUMNS from the Command Line
GETMETADATA and SCANCOLUMNS are typically run together from the command Line.Mark_1_Prep.cmd (C:\VIPTDM\SubsetCloneAndMaskRun\Mask\MySQL) provides a template script for running both actions together.
When executing Masking Actions from the Command Line, the Command Script provides all the parameters and arguments otherwise entered into The VIP Server Controller.
Mark_1_Prep.cmd contains the following:
call "C:\Program Files\Curiosity\Visual Integration Processor\VIPExecutor.exe"
-fp="C:\VIPTDM\SubsetCloneAndMask\SQLMask.enc.vip"
-debugMode=False
-logDir="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\Output"
-parControlExcel="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\VIPMaskSQLServer.xlsx"
-parAction="GETMETADATA,SCANCOLUMNS"
-parDatabaseType="SQL Server"
-parReportFile="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\Output\MaskReport.txt"
-parCleardownReport=True
-parCommandTimeout=600
-parSampleSize=500
-parListTableName="[Masking].[dbo].[List]"
-parSequenceSchema="[dbo]" -parSequencePrefix="CSI_"
-parApplyUpdates=True
-parScanRulesLocation="C:\VIPTDM\SubsetCloneAndMask\DataScannerRules.csv"
-parScanAllTypes=False
-parAuditTablePrefix=CSI_
-parLocale="en"
-parUseScanRules=True
-parOutputValues=False
-parSQLActionsPath="C:\VIPTDM\SubsetCloneAndMask\SQLActions.enc.vip"
-parJobEngineWorkFolder=""
-parValuesDirectory="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\Output"
-parAuditDirectory="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\Output"
-parUpdatesFile="C:\VIPTDM\SubsetCloneAndMaskRun\Mask\SQLServer\Output\Updates.sql"
-parTableName=""
-parSchemaName=""
-parWhereClause=""
-parAudit=False
-parListCSVDirectory="C:\VIPTDM\SubsetCloneAndMask\EnvironmentPrep\Seedlists"
-mode=serverExec -fcs=SubsetCloneAndMask
You should edit any mandatory parameters before running the script. For example, you will likely need to edit the location of the Control Spreadsheet, changing the "parControlExcel" parameters. You might also want to change the location to which the Report File is output. For a list of mandatory and optional parameters to edit at this point, see Mask Parameters.
Note: If you followed the default installation process, the default file directory will be C:\VIPTDM\SubsetCloneAndMaskRun\Mask\MySQL . Changing this may cause things to stop working (assuming use of an SQL Database).
To run GETMETADATA and SCANCOLUMNS, run the Command Script in Administrator mode. Messages, including error messages, will be displayed in the Command window, or outputted to the log.
If you receive an error message, please refer to this article to troubleshoot common issues. You can also run your Action on debug mode for a more detailed log. If you still cannot find the problem, please get in touch with Curiosity by writing to info@curiosity.software.
Run MASK Action from the Command Line
Before running the MASK action from the COMMAND LINE, you should complete the MaskingRules sheet as normal.
To run the Mask action, first edit the mandatory parameters in the template "Mask_2_Mask.cmd" command script. Set argument "parAction" to "MASK" and edit any remaining parameters required.
For example, you will likely need to edit the location of the Control Spreadsheet, changing the "parControlExcel" parameter. You might also want to change the location to which the Report File is outputted. For a list of mandatory and optional parameters to edit at this point, see SQL Mask Parameters.
To run the MASK, run the Command Script in Administrator mode. Messages, including error messages, will be displayed in the Command window, or outputted to the log. This runs in a command window that shows server output. When it's finished running if you go back to the Control spreadsheet, you should see the new data that has been added. By looking at the Tables tab, you will see a record of the new information that's been added in a series of columns.
If you receive an error message, please refer to this article to troubleshoot common issues. You can also run your Action on debug mode for a more detailed log. If you still cannot find the problem, please get in touch with Curiosity by writing to info@curiosity.software
TEST DATA AUTOMATION DATA MASKING