Skip to main content

Algorithm Framework: Summary (KBA7880)




KBA# 7880

At a Glance  

Location: UI: Settings - Algorithms
Algorithm Types:
  • Out-of-the-Box Algorithm Frameworks.
  • Algorithm SDK1.
  • Custom Algorithms (Legacy)1.
New and Deprecated
All Frameworks are being replaced with a new Framework starting with version  

This means that some old algorithms have been deprecated or will be in the future. See below for details. 

This is an old Framework to create Custom Algorithms. These are created by Delphix Technical Services or by one of our partners.  

Applicable Delphix Versions

Click here to view the versions of the Delphix engine to which this article applies
Major Release All Sub Releases





Delphix Algorithm Frameworks (Custom Algorithms)

Below is a listing of the default Out-of-the-Box Algorithm Framework. These are used to create Custom Algorithms.  For example, a customer can create their own version of a secure lookup algorithm by supplying their own lookup file.

Some Characteristics depend on how the algorithm was configured when it was created. 

Framework Code UL1 RI2 1:13 NSV4 AC5 Ex6 Encoding Pool Ver. KBA
Email  EMAIL n/a Yes Yes1 Yes1 Yes Yes UTF-8 - See Doc
Chaining n/a n/a n/a n/a n/a Yes Yes n/a - See Doc
Name NAME n/a Yes No No Yes Yes UTF-8 - See Doc
Full Name FN n/a Yes No No Yes Yes UTF-8 - See Doc
Payment Card PC n/a Yes Yes Yes Unk Yes Numbers - See Doc
Date Shift DS n/a YesI YesI YesI Yes Yes Numbers - See Doc
Date Replacement DR n/a Yes1 Yes1 Yes1 Yes Yes Numbers - See Doc
Date Shift
DDS n/a YesI YesI YesI Yes Yes Numbers - See Doc
Character Mapping CM n/a Yes Yes Yes Yes Yes US-ASCII 7 - See Doc
Secure Lookup (New) SL No Yes No No Yes Yes UTF-8 <500K See Doc
Binary Lookup BinarySL n/a Yes n/a YesI No No Binary - - See Doc
Free Text Redaction DA n/a Yes n/a n/a No No UTF-8II - - See Doc
Mapping MA Yes Yes Yes No No No UTF-8 <5M - KBA1328
Tokenization TA  n/a Yes Yes No No No All / US-ASCII 7 No limit - KBA1002
Min-Max MM  n/a Yes No n/a No No US-ASCII 7 - EOL KBA1754
Segment Mapping SM YesI Yes Yes No No No US-ASCII 7 <10K EOL KBA1775
Data Cleansing DC Yes Yes Yes n/a No No UTF-8 <500K EOL See Doc
Secure Lookup SL No Yes No No No No UTF-8 <500K KBA1243
  • Algorithm - Algorithm Type.
  • Type - How the masked value is generated:
    • Code - uses a hard-coded algorithm.
    • Lookup - uses a hashed lookup table.  
  • Characteristics
    • 1 Unique values in Lookup - The Lookup Values are Deduped before Load.  
    • 2 Referential Integrity - The masked value will be the same between tables, databases, and jobs.
    • 3 1:1 Mapping - The masked value will be mapped uniquely to the input value.
    • 4 Never mask to Same Value - The framework is designed so that the masked value will never be the same as the Input value.
    • 5 Algorithm Chaining - Indicates if the algorithm can be chained (see Doc). 
    • 6 Extensible - Supports the installation of plugins, written in Java (See Doc).
    • Encoding - The output character encoding. 
    • Pool - Recommended max number of records in the algorithm (the pool of lookup values).
  • Dep. - Deprecated version or if planned to be deprecated in the future.  It is recommended to not use these algorithms. 
  • Docs - Links to more specific information about the algorithm.  


  • YesI - The algorithm is designed to have these characteristics and depends on configuration.
  •  AllII - Words in Free Text Redaction have to be separated by space (or be the first or last word). This might limit the use in some languages where words are represented by one single character. 

How to Create an Algorithm Using Framework

When a custom algorithm is created, click Select Framework in the dialog.

UI: Create Algorithm  

To create an algorithm using the:

  1. Go to Settings > Algorithms.
  2. Click Add Algorithms.
  3. Select the Framework and add algorithm details.


KBA7880 - Create Algorithm UI.png


Algorithm SDK

If none of the Algorithms above meets your needs, you may need to get Delphix or a Delphix Partner to create a Custom Algorithm.

Examples of special requirements can be:

  • Retaining case from input to masked value.
  • Masking of consistently different fields with first, surname, and full name.
  • Masking a field requiring special rules or mathematical formulas. 
  • Addresses with locality rules. 
  • Multi-data type fields - for example, phone, mobile, and email in the same field.

Custom Algorithms (Legacy)

The Custom Algorithm (Mapplets) framework will be deprecated and has been replaced with the Algorithm SDK.


Related Articles