Full Parameter List

May 20, 2019
|By Thomas Pryce

Search Knowledge Base by Keyword

Created OnMay 20, 2019
byThomas Pryce
< Back

There are also several optional parameters that can be defined in VIP Server Controller or a re-usable .cmd script. The optional and mandatory parameters are listed in the table below. Mandatory here means that you should edit the parameter for each and every Subset Action, as otherwise the defaults will be used. For all other parameters, there will either be a default, or it is wholly optional.

In the VIP Server Controller, some parameters are set from fields in the UI. This is flagged up in the below table. All other parameters are set as “Arguments”.

When executing Actions via a Command script, all parameters must be specified in the Command script.

Parameter NameMandatoryDescriptionExamples
-fp=YesSpecifies the location of the .vip workflow that will execute the Subset Action.

When using the VIP Server Controller this is specified in the “Flow Path” field of the “Run Flow” tab.

The default flow location is:
"C:\VIPTDM\SubsetCloneAndMask\SQLSubset.enc.vip"

If you keep the static files in the default location, this parameter will be set by the re-usable command scripts or Executor.cfg configuration file.

Note: The folder that contains the flow is the “Flow Directory”. This is what is "set" when executing via a Command Script.
-fp="C:\Users\VIP1\Documents\Subsetting documentation\SQLSubset.enc.vip"


-C:\Users\VIP1\Documents\Subsetting documentation\SQLSubset.enc.vip
-logDir=YesSpecifies the location into which the Log File will be created.

When using the VIP Server Controller this is specified in the “Log Directory” field of the “Run Flow” tab.		-logDir="C:\Users\VIP1\Documents\Subsetting documentation\Subset Files"


-C:\Users\VIP1\Documents\Subsetting documentation\Subset Files
parActionYesYou must specify the Actions that the automation will run. These are the Subset Actions listed in the Process Overview.

Possible actions are GETMETADATA, PREPENV, BUILDMODEL, SUBSET, ADDPKEYS, ADDFKEYS, ADDKEYS, DELETEORPHANS, DROP, DROPFKEYS, DROPPKEYS, DROPKEYS, GETKEYS, TABLES, FINDIDENTITYCOLUMNS, TRUNCATE, VALIDATEFKEYS, VALIDATEPKEYS, and VALIDATEKEYS.

Multiple actions can be executed in one run. Simply comma separate the required actions.		-parAction=”TABLES,GETKEYS”
parCleardownReportNoThis specifies whether the Action(s) will empty the Subset Report file when one already exists.

If set to True, the Subset Report file will be overwritten.

If set to False, then the Report will be appended to the end of the existing Subset Report File. 		-parCleardownReport=False
parCommandTimeoutNoTime (in seconds) before a SQL command times out. Defaulted to 600.- parCommandTimeout=400
parContolExcelYesYou must specify the location of the Control Spreadsheet that will be used to drive the action.-parControlExcel=” C:\Users\VIP1\Documents\Subsetting documentation\VIPsubsetSample_init.xlsx”
parDatabaseTypeYesMySQL, SQL Server, Postgres or Oracle.-parDatabaseType="SQL Server"
parPrepenvAllTablesNoIf set to “False”, it will only PREPENV will only create tables in the Staging Database when are needed to fulfil the Subset Criteria and relationships in the Database Model.

If set to “True”, it will create all tables set to “Active” in the Tables sheet.

If set to “False”, you must have run your BUILDMODEL.

Defaulted to “True”.		- parPrepenvAllTables=False
par1, par2, par3, par4, par5NoAnother way to specify Substitution Variables.

If specified as parameters, these values will override the Substitution Variables specified in the Control Spreadsheet.

This provides a quick way to change the values when running an Action.

Substitution variables available for use in SQLCriteria and FoundCriteria.		-par1=”onpromotion”
parReportFileYesThis specifies the name and location of the Subset Report. The file name is defaulted to SubsetReport.txt

To set the location where the Subset file will be generated, specify the whole file directory.

If naming the file, you should include the file extension in the file name.		-parReportFile=” C:\Users\VIP1\Documents\Subsetting documentation\SubsetRun2.txt”
parSQLActionsPathThis parameter is mandatory when using the VIP Server Controller.This parameter specifies the location of the SQLActions.enc.vip workflow. This is used alongside the SQLSubset.enc.vip workflow.

It must be specified as an argument when using the VIP Server Controller.		-parSQLActionsPath=C:\VIPTDM\SubsetCloneAndMask\SQLActions.enc.vip
parOverrideBuildmodelRequirementNoThis parameter allows the SUBSET action to run even if the flow reports that the database model has changed. Defaulted to False.

When the SUBSET action, VIP first checks whether the database model is up-to-date. They use the HashCodes sheet to check if the Control Spreadsheet has been changed in a way that will effect the database model. If BUILDMODEL has not been run since such a change, you will need to re-run BUILDMODEL to register the updated model. Alternatively, you can set this parameter to “True” to run SUBSET Action anyway.		- parOverrideBuildmodelRequirement=True