Command-line syntax

To invoke the command-line interface, open a command prompt to the directory that contains the application command file, or include the directory in the PATH environment variable.

The command-line process uses the following syntax:

{ IOQMASKINGTOOL.BAT | IOQMASKINGTOOL.SH } 
{--INPUT| -I} configuration_file_path [{--HADOOP | -H}] 
[{--DEBUG-LEVEL | -D} { SEVERE | WARNING | INFO | FINE | FINER | FINEST | ALL } ] 
[{--DEBUG-FILE | -F } debug_file_path ] 
[{--REPORTING-PERCENT | -P}  percentage ] [{--REPORT | -R}]

IOQMASKINGTOOL.BAT

For Windows platforms only. The data privacy application batch script command file, located in the \mod\MODApp installation directory of the data privacy application.

IOQMASKINGTOOL.SH

For Linux® platforms only. The data privacy application shell script command file, located in the /mod/MODApp installation directory of the data privacy application.

--INPUT (or -I)

The location of the configuration file.

--HADOOP (or -H)

Indicates that the configuration file is on a Hadoop file system.

Important: If you use the IOQHadoopMasking.sh file, described in Masking in Hadoop, to mask data, do not specify the --HADOOP (or -H) syntax. The --HADOOP or -H syntax is not needed in that case because the edited IOQHadoopMasking.sh file includes that syntax. The --HADOOP (or -H) syntax is required only if you use the IOQMASKINGTOOL.SH file to mask data in Hadoop.

--DEBUG-LEVEL (or-D)

Specifies the type of log messages to produce. A lower level of severity also includes log messages from higher-severity levels. Enter one of the following options, which are listed in descending order of severity.

SEVERE

Log only serious errors, such as when masking fails because the mask string is invalid.

WARNING

Log warning messages that require a warning, such as when there are duplicate keywords in the configuration file.

INFO

Log information messages, such as when the application starts.

FINE

Log tracing information.

FINER

Log fairly detailed tracing information.

FINEST

Log highly detailed tracing information.

ALL

Log all messages.

--DEBUG-FILE (or -F)

The location of the log file.

--REPORTING-PERCENT (or -P)

Specifies the frequency at which the console generates status messages during the masking process. Enter a percentage value in the range 1 - 100. For example, if you specify 10, the console generates a message for every 10% of masking that is complete.

--REPORT (or -R)

Specifies that the process report will not open in a browser after the masking process completes.