Skip to main content

User Guide

Substitute Text

This section provides a comprehensive description of the Substitute Text Rule.

For a summary of the rule and its compatibility with Privitar jobs and execution environments, see masking-rules.png Masking Rule Types.

Data Types

The supported data types for this rule are:

  • Text

Description

The input value is replaced with a mapped substitute value from a Mappings file uploaded locally. For example, a typical file is:

John, Gary
Bob, Joshua
Christian, Daniel
Louis, Thomas
David, Craig
Samuel, Samuel

This file could be used by the rule to map the following input values to new output values:

Input value

Output value (mapping)

John

Gary

Samuel

Samuel

Christian

Daniel

David

Craig

Select Mappings to upload a file containing name-value pairs that determine how an input value is substituted. If there is no mapping for a particular input, then the value supplied in Default Value is used instead.

Note

The substitute value cannot be the string/text "NULL" (or any variation of this string, such as "null" or "NuLL".)

Masking Behavior

The options are described in the following table:

Option

Description

Mappings

The mappings file to upload. The file should be a CSV file. (The size of the file can be up to 100k rows.)

The format of the file is:

Original value,Mapped value

For example:

Chicago,Area_1

Default Value

A default mapping value to use if no mapping value is found in the mappings file for a particular input value.

Tokenization Behavior