Skip to main content

Replace all

This function masks all characters from the input values.

This function can be used on Strings.

When using the FF1 with AES and FF1 with SHA-2 methods, the input values must contain at least two characters to mask. Otherwise, the function returns null.

Option Description
Method The Randomly method randomly selects a character. As a result, two identical input values can be masked with the different output values.

When the same value appears twice in the input data, the Consistently method ensures that the function outputs the same masked value in the same Job execution.

This function can encrypt the output masked values in the same format as the input values, using Format-Preserving Encryption (FPE) methods:

  • FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
  • FF1 with SHA-2 relies on the secure hash function HMAC-256.

The FPE methods are bijective methods, except when using tweaks.

The FF1 with AES and FF1 with SHA-2 methods require a password to generate encrypted and repeatable masked values. Those FPE methods do not use a seed.

You can specify this password in the Password or 256-bit key for FF1 methods field, from the Advanced Settings of the component.

Extra parameter

The optional extra parameter must be a character.

The following table shows examples of masked values depending on the input value, the method, and the extra parameter.
Input value Method Alphabet Extra parameter Example of a masked value Details
Jack Randomly - "a" aaaa All characters are replaced with the character defined as an extra parameter.
S1000D Randomly - "4" 444444 All characters are replaced with the character defined as an extra parameter.
S1000D FF1 with SHA-2 Best guess - 2MTW72 The masked value contains characters from all alphabets represented in the input value.

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!