Mandatory Parameters

Search Knowledge Base by Keyword

< Back

Each Subset Action draws upon a set of optional and mandatory parameters. These are specified either in the VIP Server Controller or a .cmd script.

If using the VIP Server Controller, you can save a parameterized Action as a VIP Server Config File. This allows you to easily re-run a paramaterized Action in future, editing the configuration spreadsheet as required. The default “Executor.cfg” config file additionally provides a set of default parameters that you can edit and re-use quickly.

This article provides an overview of the mandatory and optional parameters that can be set when running a Subsetting Action. It then provides instructions on how to specify these parameters and run them using the VIP Server Controller or via .cmd files and the command line.

Mandatory Parameters

For each Subset Action, there are a set of mandatory parameters that must be specified, either in the VIP Server Controller or in a .cmd file.

A set of default parameters are specified, but it is advisable to specify the mandatory parameters yourself. Saving a VIP Server Config File or a re-usable .cmd script makes it easy to then repeat Actions using the same parameters.

For each Subset Action, you must specify the following mandatory parameters:

  1. The database type
  2. The location of the Subset.enc.vip flow that will execute the Subsetting
  3. If using the VIP Server Controller, you must enter the location of the parSQLActionsPath.enc.vip
  4. The location of the Basic Control Spreadsheet
  5. The Actions that will be executed
  6. The location where the Log file will be saved
  7. The location where the Subset Report will be saved

Static Parameters

Many parameters remain the same for multiple Actions involved in a Data Subset. Some furthermore remain static across jobs unless the unedited files used during Subsetting are moved. This is indicated in the Full Parameter List.

When using the VIP Server Controller, you can therefore re-use a Configuration file to load in these static, default parameters, parameterising new actions quickly.

The “Executor.cfg” config file additionally provides a set of default parameters that you can edit and re-use quickly for each supported data source type.

If executing Actions from the Command script, you can often re-use the default Command Scripts to set these same static parameters.

In both instances, the parameters will point to files saved in the default installation location (a folder within C:\VIPTDM\).