Name¶

See Name for more information about this algorithm framework.

Creating a Name Algorithm via API¶

Find the FrameworkId for the Extensible SL Framework. That might be done via the following EndPoint:
```
algorithm   GET /algorithm/frameworks
```
Plugin name is dlpx-core, the framework name is Name.
Involved files (particlesRoRemoveFile, paticlesToPersistFile, lookupFile) should be provided via the File Reference. For example they can be uploaded via the following EndPoint:
```
fileUpload   POST /file-uploads
```
Alternatively, those files might also be provided via HTTP / HTTPS / NFS mount URLs.

Create an Extensible Name Algorithm via the following EndPoint:

algorithm   POST /algorithms

Using the JSON formatted input, similar to the following example:

{
    "algorithmName": "NameDemo",
    "algorithmType": "COMPONENT",
    "description": "This is a new style Name algorithm",
    "frameworkId" :10,
    "algorithmExtension" :
    {
        "filterAccent" : true,
        "particlesToRemoveFile" : {"uri":"delphix-file://upload/f_1cc829ceee324113ab16c4e750dfce12/particlesToRemove.txt"},
        "maxLengthOfMaskedName" :0,
        "lookupFile":{"uri":"delphix-file://upload/f_85f082535d054ee8a11696a24ed86d65/LN_LOOKUP_100K%20(1).txt"}
    }
}

Fields description:
"algorithmName" - customer created algorithm name
"algorithmType" - should be "COMPONENT" for Extensible Algorithms
"description" - free text
"frameworkId" - the numeric value found in #1 above
"algorithmExtension" - the composite field, containing algorithm instance specific configuration parameters

Name Algorithm Extension¶

lookupFile (required)

String
Lookup file may be FileReferenceId in the one of the following four options:
- UUID value returned from the endpoint for uploading file to the Masking Engine
- NFS mounted file URL
- HTTP URL to external web located file
- HTTPS URL to external web located file
particlesToRemoveFile (optional)

String
File listing particles to remove may be FileReferenceId in the one of the following four options:
- UUID value returned from the endpoint for uploading file to the Masking Engine
- NFS mounted file URL
- HTTP URL to external web located file
- HTTPS URL to external web located file
particlesToPreserveFile (optional)

String
File listing particles to preserve may be FileReferenceId in the one of the following four options:
- UUID value returned from the endpoint for uploading file to the Masking Engine
- NFS mounted file URL
- HTTP URL to external web located file
- HTTPS URL to external web located file
inputCaseSensitive (optional)

Boolean
Setting "true" means input value case matter (i.e. "Peter" and "peter" might be masked to different values).
Setting "false" (default) makes input value case insensitive ("Peter" and "peter" would be masked to the same value).
filterAccent (optional)

Boolean
Setting "true" (default) means accented characters doesn't matter (i.e. "Adrián" and "Adrian" might be masked to the same value).
Setting "false" makes input value accdnt sensetive ("Adrián" and "Adrian" would be masked to the different values).
maskedValueCase (optional)

String
The output (masked) value case enforcing.
Enum values:
- PRESERVE_LOOKUP_FILE - use the unmodified replacement value (default).
- PRESERVE_INPUT - preserve case of input value. If mixed - use unmodified replacement value.
- ALL_LOWER - force the output to lowercase.
- ALL_UPPER - force the output to uppercase.
maxLengthOfMaskedName (optional, default=0)

Integer
Should be a non-negative number. The output (masked) value is forcibly trimmed to that length (by the number of characters).