The command-line is installed alongside the Data Masker application. To see this in action, see our samples.

Usage: DataMaskerCmdLine [options] [commands]

If no command is specified, the run command will be applied to the given PARFILE.

Options:

• PARFILE=<parfile>, --parfile <parfile> (REQUIRED for run)
  • Path to the parameter file containing the details of the masking job to run, see the parameter file section for more info.
• --version
  • Show version information.
• --help, -?, -h

  • Show help and usage information for the command-line.

Commands:

• column-template build-mapping-file
  • Builds a mapping-file using Data Catalog
• build
  
  • Builds a masking-set file
• run
  • Runs masking set

For example: 

> "C:\Program Files\Red Gate\Data Masker for SQL Server 7\DataMaskerCmdLine.exe" PARFILE=C:\MaskingSets\SamplePARFILE.txt
> "C:\Program Files\Red Gate\Data Masker for Oracle 6\DataMaskerCmdLine.exe" PARFILE="C:\Masking Sets\Sample PARFILE.txt"

The column-template build-mapping-file Command

Builds a default mapping file using information from SQL Data Catalog. By default it will mask all columns tagged with 'Static Masking' under the category 'Treatment Intent', using templates defined in the category 'Masking Data Set'. If a tag in this category is not recognised as a template, the default mapping for that datatype is used instead (see table under options).

Usage: DataMaskerCmdLine column-template build-mapping-file [options]

Options:

Default templates (see mapping file section for more information on templates) for each datatype (used when a tag in information-type-category is not recognised as a template):

The build Command

Prepares an empty masking-set file for the given connection, unless a mapping-file is provided which will populate the masking-set with default rules.

Usage: DataMaskerCmdLine build [authentication] [options]

Authentication:

• using-windows-auth
  • Use Windows authentication.
• using-sql-auth
  • Use SQL authentication.

Options:

The run Command

Run a masking set using the specified PARFILE.

Usage: DataMaskerCmdLine run [options]

Options:

• PARFILE=<parfile>, --parfile <parfile> (REQUIRED)
  • Path to the parameter file containing the details of the masking job to run, see the parameter file section for more info.
• --help, -?, -h
  • Show help and usage information for the run command.

The Parameter File

The parameter file can specify the following options:

DMSSUBVALUExx (SQL Server version) / DMOSUBVALUExx (Oracle version)

Up to twenty replacement strings can be specified in the parameter file. These runtime substitution values are designed to permit generic SQL statements to be dynamically adjusted at runtime for specific targets during batch operations.

Note: The keywords for these replacement strings are DMSSUBVALUE00 to DMSSUBVALUE19. If the text %DMSSUBVALUExx% is used in a Command rule or in the Where Clause of a masking rule, the value associated with that keyword will be replaced at runtime before the rule is executed.

For example, if a Command rule included a statement like:

TRUNCATE TABLE %DMSSUBVALUE05%_TEMP;

and the parameter file contained a line stating DMSSUBVALUE05=TESTUSER then the actual statement that would be executed would be:

TRUNCATE TABLE TESTUSER_TEMP;

The value TESTUSER would be substituted for the %DMSSUBVALUE05% text in the SQL statement immediately before the statement was executed.

Examples

MASKINGSET=C:\Program Files\Red Gate\Data Masker for SQL Server 7\Demo.DMSMaskSet 
LOGFILEDIR=C:\TEMP\Data Masker\
DATASETSDIR=C:\Program Files\Red Gate\Data Masker for SQL Server 7\DataSets 
REPORTSDIR=C:\TEMP\Data Masker\
INTERIM_REPORTS=false 
LOGINSUB=placeholder-login@DEV-DB[DataWarehouse]||DataMasker/SecurePassword@STAGING\SQL2019[DataWarehouseMasked]
-- Substitution values
DMSSUBVALUE00=DM_INVOICE_LINE_HISTORY
DMSSUBVALUE05=DM_INVOICE_LINE_HISTORY

MASKINGSET=C:\Program Files\Red Gate\Data Masker for Oracle 6\Demo.DMSMaskSet 
LOGFILEDIR=C:\TEMP\Data Masker\
DATASETSDIR=C:\Program Files\Red Gate\Data Masker for Oracle 6\DataSets 
REPORTSDIR=C:\TEMP\Data Masker\
INTERIM_REPORTS=false 
--LOGINSUB=DummyLogin@DummyServer[DummyDatabase]||DataMasker/DataMasker@DEMODB[DMTest] 
--LOGINSUB=XXXLogin@XXXServer[XXXDatabase]||DBSSourceUser/DBSSourceUser@N2KBUILD-PC\N2KTEST1[DBSSource]

DMOSUBVALUE00=DM_INVOICE_LINE_HISTORY
DMOSUBVALUE05=DM_INVOICE_LINE_HISTORY

The Mapping File

Maps columns in the database to pre-defined templates that the build command uses to create a masking set.

Currently available templates are:

Example mapping file:

{
    "source": "SQL Data Catalog",
    "mappings": [
      {
        "template": "Given name",
        "independentlyMasked": [
          { "schema": "dbo", "table": "People", "column": "F_NAME" },
          { "schema": "dbo", "table": "Employees", "column": "F_NAME" }
        ]
      },
      {
        "template": "Family name",
        "independentlyMasked": [
            { "schema": "dbo", "table": "People", "column": "S_NAME" },
            { "schema": "dbo", "table": "Employees", "column": "S_NAME" }
        ]
      }
    ]
}

Exit Codes

The command-line will return an exit code to indicate success or failure; if the run of the masking rules was successful, then this exit code will always be zero. Any non-zero exit code implies that an error occurred while opening the masking set or while running the masking rules. If a non-zero exit code is returned, the log file should always be examined to determine the error that occurred. The defined error codes are:

If an error occurs there will be more detail in the log that is created in the LOGFILEDIR directory, some information will be written to the console output. 

If running from the standard command-line then  `echo %errorlevel%` can output the exit code. For example:

C:\Program Files\Red Gate\Data Masker for SQL Server 7>DataMaskerCmdLine.exe PARFILE=C:\workspace\data-masking\DMV6\DMS_TestSets\DebugPARFILE.txt
...
C:\Program Files\Red Gate\Data Masker for SQL Server 7>echo %ERRORLEVEL%
200