Text
Below is a list of available text mask functions.
Format preserving encryption (FPE)
The Format preserving encryption (FPE) function utilizes the FF3 algorithm to encrypt sensitive data while preserving its original format and length. This makes it ideal for fields where the data's structure must remain intact (e.g., credit card numbers or dates). Note that it preserves data format during encryption and supports unique and randomized subsets for varied datasets​. The values are generated in a consistent manner.
Parameters
Alphabet: By default, it contains all ASCII letters, uppercase and lowercase and numbers.
Example
If you configure:
Alphabet: abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ 0123456789The results will be:
0kVRnFWud,
uCgInrq6,
772edmb G,
...
Numeric hasher
The Numeric hasher function provides secure hashing for categorical values. This method replaces original values with a hashed representation, ideal for ensuring data privacy while maintaining referential integrity in numerical datasets. Note that It maintains the original structure of hashed fields. and the minimum number of characters depends on the size of the alphabet used, typically resulting in a minimum of 4 characters in a consistent manner. To ensure accurate ordering, please see ordering and indexing considerations.
Parameters
No parameters.
Example
If you configure:
The results will be:
Random character swap
The Random character swap function replaces individual characters in categorical values while preserving the structure of punctuation, spaces, and symbols. Characters are swapped within their respective categories (letters with letters, digits with digits), ensuring that the field's overall format remains usable, or in other words, the original data type and structure of each field (letters, numbers, symbols) are preserved. Note that it preserves non-alphabetic characters (e.g., punctuation, spaces)​.
Parameters
Consistent mapping: Random character swap supports consistent mapping. When enabled, each input character is always mapped to the same output character. The mapping is case-preserving: if a lowercase character is mapped to another lowercase character, the corresponding uppercase character is mapped to the uppercase version of that same output character. For example, ifais mapped toz, thenAis mapped toZ.
Example
If you configure:
The results will be:
Shuffle
The Shuffle function shuffles existing text values while preserving the overall frequency of values.
Shuffle works batch-wise. Each generated batch is shuffled independently, based on the configured Batch size.
NULL values are treated as a distinct value and are shuffled like any other value.
Parameters
Rare Category Protection: Enables protection for infrequent values during shuffling. Configure its threshold and replacement value.
Rare category protection
The Rare category protection generator replaces infrequent text values with a user-defined replacement value.
Use this standalone Mask generator when you need to protect rare values without shuffling the column. You can also enable it as a parameter of Shuffle.
Parameters
Rare category protection threshold: Values occurring at or below this frequency are replaced. The default is10.Rare category replacement value: The value that replaces rare values. The default is*.
Rare category protection works per generated batch. A smaller Batch size makes values more likely to meet the threshold.
Free text PII obfuscation
Caution: this feature can slow down your data generation jobs significantly.
The Free text PII obfuscation function detects and obfuscates PII in columns containing free text information.
Select the correct Locale to ensure Syntho uses the right language models for detection.
If Replace PII with mock data is enabled, detected entities are replaced with mock values. If it is disabled, detected entities are annotated with a PII label.
For setup details, see Free text PII obfuscation. For supported entities, see Supported PII entities.
Parameters
LocaleReplace PII with mock data
Last updated
Was this helpful?