Alphanumeric String Key (AlphaNumericPkGenerator)

The Alphanumeric String Key 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 object is populated from the BaseMetadata object.

preservePrefix identifies a specific string that, when it occurs at the beginning of the source values, must be preserved in the destination values.

numSuffixCharacters identifies the number of characters at the end of each source value to preserve in the destination value.

maskDigitsOnly indicates whether to only mask the numeric characters.

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

Example replacement

The following example replacement configures a column to use the built-in generator preset for the Alphanumeric String Key generator.

When a source value starts with test_, the destination value also starts with test_.

The destination values do not preserve any of the ending characters from the source values.

The generator masks both alphabetical and numeric characters.

The generator is not consistent.

{
  "name": "workclass",
  "schema": "public",
  "table": "employees",
  "links": [
    {
      "schema": "public",
      "table": "employees",
      "column": "workclass",
      "metadata": {
        "presetId": "AlphaNumericPkGenerator",
        "generatorId": "AlphaNumericPkGenerator",
        "preservePrefix": "test_",
        "numSuffixCharacters": 0,
        "maskDigitsOnly": false,
        "isConsistent": false
      }
    }
  ]
}