1 of 64

Assign generators to columns

Requires the Advanced API. The Advanced API requires an Enterprise license.

Getting the generator IDs and available metadata

Requires the Advanced API. The Advanced API requires an Enterprise license.

When you use the API to assign generators, you use the generator identifier.

To retrieve the list of generators, use:

In the results, the message body is an array of GeneratorMetadataResponseModel objects.

The information for each generator includes the generator ID. It also specifies whether the generator supports configuration options such as linking, consistency, differential privacy configuration, and partitioning.

Updating generator configurations

Requires the Advanced API. The Advanced API requires an Enterprise license.

Getting the generator configuration for a table

To get the current generator configuration, use:

Generator API reference

In this reference, each generator is identified by its name and, in parenthesis, its generator ID. You use the generator ID to identify the generator in the API.

For each generator, this reference shows the structure of a link object, and provides an example of a replacement object.

Additional resources:

Address (AddressGenerator)

The generator replaces the source value with a random string based on the type of address data that the column contains.

Link object structure

The Address generator can be self-consistent or consistent with another column. You cannot configure differential privacy. It can be linked to other columns.

The metadata object is populated from .

For the Address generator, you specify the type of address value that is in the source column. Here is the basic structure of a link object for the Address generator.

Algebraic (AlgebraicGenerator)

The generator identifies the algebraic relationship among three or more numeric values and generates new values to match. At least one of the values must be a non-integer.

The Algebraic generator must be linked to at least two other columns.

Link object structure

The Algebraic generator does not support consistency. You cannot configure differential privacy.

There is no generator-specific configuration.

Alphanumeric String Key (AlphaNumericPkGenerator)

The generator can be applied to primary key columns. It generates unique alphanumeric strings of the same length as the input.

For example, for the origin value ABC123, the output value is a six-character alphanumeric string such as D24N05.

Link object structure

The Alphanumeric String Key generator can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata

Array Character Scramble (ArrayTextMaskGenerator)

The generator is intended for array values. It replaces letters with random other letters, and numbers with random other numbers. It preserves punctuation and whitespace from the original value.

Link object structure

The Array Character Scramble generator can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

Array JSON Mask (ArrayJsonMaskGenerator)

The generator is a composite generator. It is a version of the JSON Mask generator that can be used for array values. It runs a selected generator on values that match a specified JSONPath.

Link object structure

For the Array JSON Mask generator, you provide a link object for each sub-generator configuration.

The generator does not itself support consistency or differential privacy.

The metadata object is populated from the

ASCII Key (AsciiPkGenerator)

The generator can be applied to primary key columns. It generates unique alphanumeric strings based on any printable ASCII characters.

Link object structure

The ASCII Key generator can be configured to be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

There is no generator-specific configuration.

Business Name (BusinessNameGenerator)

The generator generates a random company name-like string.

Link object structure

The Business Name generator does not support linking. It can be self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

There is no generator-specific configuration.

Categorical (CategoricalGenerator)

The Categorical generator creates values at the same frequency and using the same values, including NULL values, as the underlying data. In other words, it shuffles the existing values within a field.

Link object structure

The Categorical generator does not support consistency. You can configure differential privacy. You can link columns.

The metadata object is populated from the CategoricalMetadata object. It contains the epsilon field, which provides the .

Example replacement

The following example replacement shows a single, un-linked column. Differential privacy is enabled, and epsilon is set to 1.

Character Scramble (TextMaskGenerator)

The Character Scramble generator replaces letters with random other letters and numbers with random other numbers. It preserves punctuation, whitespace, and mathematical symbols.

Link object structure

You can configure the Character Scramble generator to be self-consistent, but not consistent to another column. You cannot configure differential privacy.

The metadata object is populated from the BaseMetadata object.

There is no generator-specific configuration.

Example replacement

The following replacement for a Character Scramble generator has consistency disabled.

Character Substitution (StringMaskGenerator)

The Character Substitution generator performs a random character replacement that preserves formatting (spaces, capitalization, and punctuation).

Characters are replaced with other characters from within the same Unicode Block.

Link object structure

The Character Substitution generator is implicitly consistent. You cannot configure consistency or differential privacy. There is no generator-specific configuration.

{
  "schema": "string",
  "table": "string",
  "column": "string",
  "path": "string",  //JSON fields only
  "dataType": "string",  //MongoDB, Amazon DynamoDB, and JSON fields only
  "metadata": {
    "generatorId": "StringMaskGenerator",
    "encryptionProcessor": "x-on", //To use configured Structural data encryption
    "customValueProcessor": "string" //If custom value processor applied
  }
}

Example replacement

The following example replacement assigns the Character Substitution generator to a column.

Company Name (CompanyNameGenerator)

The Company Name generator is deprecated. Use the generator instead.

The generator generates a random company name-like string.

Link object structure

Constant (ConstantGenerator)

The Constant generator uses a single value to mask all of the values in the column.

Link object structure

The Constant generator does not support linking or consistency. You cannot configure differential privacy.

The metadata object is populated from the ConstantMetadata object.

The constant field specifies the value to use to populate the column.

Example replacement

In the following example replacement, the education-num column value is replaced by the value 10.

Continuous (GaussianGenerator)

The generator generates a continuous distribution to fit the underlying data.

Link object structure

The Continuous generator supports linking. It cannot be made consistent, but you can configure differential privacy.

The metadata object is populated from the object.

The Continuous generator does support partitioning, which is configured in the

Custom Categorical (CustomCategoricalGenerator)

The Custom Categorical generator is a version of the Categorical generator that selects from values that you provide instead of shuffling the original values.

Link object structure

The Custom Categorical generator supports linking. It can be made self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the CustomCategoricalMetadata object. You use the customCategories field to provide a list of the values to use for the column in the destination database. The values are provided on a single line, separated with newline characters (\n). For example, "Small\nMedium\nLarge". To include NULL as an available value, use {NULL}.

Example replacement

In this example replacement for the Custom Categorical generator, the values to use are Red, Yellow, Blue, and White. The generator is not linked.

Consistency is disabled.

Date Truncation (DateTruncationGenerator)

The generator truncates a date value or a timestamp to a specific part. For a date or a timestamp, you can truncate to the year, month, or day. For a timestamp, you can also truncate to the hour, minute, or second.

Link object structure

The Date Truncation generator does not support linking or consistency. You cannot configure differential privacy.

The metadata object is populated from the object. The generator-specific configuration includes the part of the datetime value to truncate to, and whether to change all dates that are more than 90 years before the generation date to a date exactly 90 years before the generation date.

Event Timestamps (EventGenerator)

The Event Timestamps generator generates timestamps that fit an event distribution. The source timestamp must include a date. It cannot be a time-only value.

Link object structure

You can link columns to create a sequence of events across multiple columns. This generator can be partitioned by other columns.

The Event Timestamps generator does not support consistency. You cannot configure differential privacy.

The metadata object is populated from the object. You use eventOrder to specify the sequence of the generated datetime values in the linked columns.

The Event Timestamps generator does support partitioning, which is configured in the .

Example replacement

In this replacement example for the Event Timestamps generator, the date_event1 and date_event2 columns are linked. date_event1 occurs first, and date_event2 occurs second. The values are not partitioned.

File Name (FileNameGenerator)

The generator scrambles characters, but preserves formatting and keeps the file extension intact.

Link object structure

The File Name generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

There is no generator-specific configuration.

Find and Replace (FindAndReplaceGenerator)

The Find and Replace generator replaces all instances of a specified find string with a specified replace string.

Link object structure

The Find and Replace generator does not support linking or consistency. You cannot configure differential privacy.

The metadata object is populated from the FindAndReplaceMetadata object. The generator-specific configuration includes:

The find string.
Whether the find string is a regular expression.
The replace string.

Example replacement

In this example replacement for the Find and Replace generator, the value yes is replaced by the value no. The find string is not a regular expression.

Finnish Personal Identity Code (FinnishPicGenerator)

The generator generates a valid Finnish Personal Identity Code (PIC) that was generated during a specified date range.

Link object structure

The Finnish Personal Identity Code generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

You configure the start and end dates for the date range.

FNR (FnrGenerator)

The generator transforms Norwegian national identity numbers.

Link object structure

The metadata object is populated from the object.

preserveDate indicates whether to preserve the birthdate values from the source database in the destination database. If the birthdate values are not preserved, the destination values are still within the same range as the source values.

Geo (GeoGenerator)

The generator is used to mask latitude or longitude values.

Link object structure

The Geo generator supports linking. Typically, the Geo generator is assigned to a latitude column and a longitude column and then the columns are linked.

The Geo generator does not support consistency. You cannot configure differential privacy.

The metadata object is populated from the object.

HIPAA Address (HipaaAddressGenerator)

The generator can be used to generate cities, states, zip codes, and latitude/longitude values that follow HIPAA guidelines for safe harbor.

Link object structure

The HIPAA Address generator can be linked. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object, which includes: The type of address value that is in the column How to generate zip codes. You can generate zip codes that replace the last two digits with zeros, or use a real zip code from the same state.

Hostname (HostnameGenerator)

The Hostname generator generates random host names, based on the English language.

Link object structure

The Hostname generator does not support linking. It can be either self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the BaseMetadata object.

There is no generator-specific configuration.

{
  "schema": "string",
  "table": "string",
  "column": "string", 
  "path": "string",  //JSON fields only
  "dataType": "string",  //MongoDB, Amazon DynamoDB, and JSON fields only
  "metadata": {
    "presetId": "string",
    "generatorId": "HostnameGenerator",
    "isConsistent": boolean,
    "consistencyColumn": "string",
    "encryptionProcessor": "x-on", //To use configured Structural data encryption
    "customValueProcessor": "string"  //If custom value processor assigned
  }
}

Example replacement

In the following example replacement for the Hostname generator, consistency is disabled.

Integer Key (IntegerPkGenerator)

The generator generates integer values that are between 0 and 2^32 - 1. The input values must be in the range 0 to 2^31 - 1.

Link object structure

The Integer Key generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object, which includes:

International Address (InternationalAddressGenerator)

The generator can generator the following international address values:

Canadian street name.
Canadian postal code.
United Kingdom (UK) postal code.

MAC Address (MACAddressGenerator)

The generator generates a string that is formatted as a MAC address.

Link object structure

The MAC Address generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object. bytesPreserved specifies the number of bytes to preserve in the generated address.

Name (NameGenerator)

The Name generator generates a random name string from a dictionary of first and last names.

Link object structure

The Name generator cannot be linked. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the NameClassifierMetadata object, which includes:

The type of name value.
Whether to preserve the capitalization from the source value.

Example replacement

In the following example replacement for the Name generator, the name format is Last, First (for example - Smith, John).

Capitalization is preserved.

Consistency is disabled.

Noise Generator (NoiseGenerator)

The masks values in numeric columns. It adds or multiplies the original value by random noise.

Link object structure

The Noise Generator does not support linking. It can be either self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object. The generator configuration includes:

Null (NullGenerator)

The generator generates NULL values to fill the rows of the specified column.

Link object structure

The Null generator does not support linking or consistency. You cannot configure differential privacy.

There is no generator-specific configuration.

Numeric String Key (NumericStringPkGenerator)

The Numeric String Key generator generates unique numeric strings of the same length as the input value.

Link object structure

The Numeric String Key generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the BaseMetadata object.

There is no generator-specific configuration.

Example replacement

In the following example replacement for the Numeric String Key generator, consistency is disabled.

Passthrough (PassthroughGenerator)

The Passthrough generator is the default. It passes through the value from the source database to the destination database without masking it.

You do not usually retrieve or provide a replacement that assigns the Passthrough generator to a column. You might specifically assign the Passthrough as a sub-generator for a composite generator.

When you use the GET api/Workspace/{workspace ID}/replacements/{schema}/{table} to get the column configuration for a table, columns that are assigned Passthrough are not included in the results.

For the PUT /api/Workspace/{workspaceId}/update_replacements/{schema}/{table} endpoint, which replaces the configuration for an entire table, any column that is not included in the message body is automatically assigned Passthrough.

To revert an individual column to Passthrough, you use the DELETE api/Workspace/{workspace ID}/replacement/{replacement ID} endpoint to remove the replacement that contains the column configuration.

Phone (USPhoneNumberGenerator)

The generator generates a random telephone number that matches the country or region of the input telephone number and maintains the format.

Link object structure

The Phone generator does not support linking. It can be made self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object, which includes a setting to indicate whether to replace invalid telephone numbers with valid telephone numbers.

Random Boolean (RandomBooleanGenerator)

The Random Boolean generator assigns a random boolean value.

Link object structure

The Random Boolean generator does not support linking or consistency. You cannot configure differential privacy.

The metadata object is populated from the RatioMetadata object. The ratio field indicates the percentage (as a decimal value between 0 and 1.0) of values to set to true.

Example replacement

In the following example replacement for the Random Boolean generator, 40% of the destination values are true, and 60% are false.

Random Double (RandomDoubleGenerator)

The generator generates a random double number between the specified minimum (inclusive) and maximum (exclusive).

Link object structure

The Random Double generator does not support linking or consistency. You cannot configure differential privacy.

The metadata object is populated from the object. You specify the minimum and maximum values.

Random Hash (RandomStringGenerator)

The Random Hash generator generates a random hash string.

Link object structure

The Random Hash generator does not support linking or consistency. You cannot configure differential privacy.

There is no generator-specific configuration.

{
  "schema": "string",
  "table": "string",
  "column": "string",
  "path": "string",  //JSON fields only
  "dataType": "string",  //MongoDB, Amazon DynamoDB, and JSON fields only
  "metadata": {
    "generatorId": "RandomStringGenerator",,
    "encryptionProcessor": "x-on", //To use configured Structural data encryption
    "customValueProcessor": "string"  //If custom value processor applied
  }
}

Example replacement

Here is an example replacement for the Random Hash generator.

Random UUID (UUIDGenerator)

The Random UUID generator generates a random UUID-like string.

Link object structure

The Random UUID generator does not support linking or consistency. You cannot configure differential privacy.

There is no generator-specific configuration.

{
  "schema": "string",
  "table": "string",
  "column": "string",
  "path": "string",  //JSON fields only
  "dataType": "string",  //MongoDB, Amazon DynamoDB, and JSON fields only
  "metadata": {
    "generatorId": "UUIDGenerator",
    "encryptionProcessor": "x-on", //To use configured Structural data encryption
    "customValueProcessor": "string"  //If custom value processor applied
  }
}

Example replacement

The following example replacement applies the Random UUID generator to a column.

Sequential Integer (UniqueIntegerGenerator)

The generator returns integer values that increment by 1 for each row in the destination database.

Link object structure

The Sequential Integer generator can be linked. You provide a link object for each linked column. The generator does not support consistency. You cannot configure differential privacy.

The metadata object is populated from the object. startingPoint

Shipping Container (ShippingContainerGenerator)

The generator generates values of ISO 6346 compliant shipping container codes. All generated codes are in the freight category ("U").

Link object structure

The Shipping Container generator does not support linking. It can be self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

SIN (SINGenerator)

The generator generates a new valid Canadian Social Insurance Number that preserves the formatting of the original value.

Link object structure

The SIN generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

There is no generator-specific configuration.

SSN (SsnGenerator)

The generator generates a new valid United States Social Security number.

Link object structure

The SSN generator does not support linking. It can be self-consistent or consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object.

For the SSN generator, ratio

Unique Email (UniqueEmailGenerator)

The generator generates unique email addresses. It replaces the username with a randomly generated GUID, and either uses a specified domain or uses a character scramble to mask the domain.

Link object structure

The Unique Email generator does not support linking. It can be self-consistent, but not consistent with another column. You cannot configure differential privacy.

The metadata object is populated from the object. You can configure:

URL (UrlGenerator)

The generator is a substitution cipher that preserves formatting, but keeps the URL scheme and top-level domain intact.

Link object structure

The URL generator does not support linking or consistency. You cannot configure differential privacy.

There is no generator-specific configuration.