Generator reference

This generator reference provides the details for each of the the supported generators in Tonic Structural.

Information provided for each generator

For each generator, the reference provides:

• Overview description

• A table that contains:

  • Generator characteristics that you might want to take into account when you select the generator.

  • The generator privacy ranking, which indicates the level of protection that the generator provides.

  • The generator ID to use in the Structural API. The generator ID is linked to the API details for the generator.

• Instructions for how to configure the generator

The generator characteristics include:

• Consistency - Whether you configure the generator to base the the destination values on the source values.

• Linking - Whether you can link columns that use the generator to indicate that there is a relationship between them.

• Differential privacy - Whether the generator supports differential privacy, which ensures that the source value cannot be reverse engineered from the output value.

• Data-free - Whether the generator is data-free, meaning that the output data is completely unrelated to the source data.

• Allowed for primary keys - Whether you can assign the generator to primary key columns.

• Allowed for unique columns - Whether you can assign the generator to columns that require unique values.

• Uses format-preserving encryption (FPE) - Whether the generator uses FPE to encrypt the values.

The generators are in alphabetical order by the generator name.

Here are some groupings to help to identify generators that are used for different types of values. Generator hints and tips also provides some suggestions for generators to use for specific uses cases.

Composite generators

Transform data that uses complex formats or based on a condition. For more information, go to Composite generators.

• Array JSON Mask

• Array Regex Mask

• Conditional

• CSV Mask

• HStore Mask

• HTML Mask

• JSON Mask

• Regex Mask

• Struct Mask

• XML Mask

Information type generators

These generators produce specific types of values.

• Address

• Business Name (and the deprecated Company Name)

• Email

• File Name

• FNR

• Geo

• HIPAA Address

• Hostname

• International Address

• IP Address

• MAC Address

• Name

• Phone

• Shipping Container

• SIN

• SSN

• Unique Email

• URL

Datetime value generators

These generators are used to specifically transform datetime values.

• Date Truncation

• Event Timestamps

• Random Timestamp

• Timestamp Shift Generator

Key generators

Intended for use with primary key columns. For more information, go to Primary key generators.

• Alphanumeric String Key

• ASCII Key

• Integer Key

• Numeric String Key

• UUID Key

Numeric value generators

These generators are specifically intended to work with numeric values.

• Algebraic

• Continuous

• Cross Table Sum

• Noise Generator

• Random Double

• Random Integer

• Sequential Integer

String value generators

These generators are useful for transforming string values that aren't covered by a specific information type generator.

• Categorical

• Character Scramble

• Character Substitution

• Constant - Also useable for numeric columns.

• Custom Categorical - Also useable for numeric columns.

• Find and Replace

• Regex Mask

Other value substitution and replacement generators

These generators perform other types of transformation on column values.

• Array Character Scramble

• Null

• Random Boolean

• Random Hash

• Random UUID