Skip to content

Mapping

See Mapping for more information about this algorithm framework.

Creating a Mapping Algorithm via API

  1. Retrieve the frameworkId for the Mapping Framework. This information can be retrieved using the following endpoint:

    algorithm   GET /algorithm/frameworks
    

    The framework information should look similar to the following:

    {
        "frameworkId": 15,
        "frameworkName": "Mapping",
        "frameworkType" : "STRING",
        "plugin" :
        {
            "pluginId" : 7,
            "pluginName" : "dlpx-core"
        }
    }
    
  2. Create a Mapping algorithm instance via the following endpoint:

    algorithm   POST /algorithms
    

    Configure a new algorithm using the JSON formatted input similar to the following:

    {
        "algorithmName": "MyMappingAlgo",
        "algorithmType": "COMPONENT",
        "frameworkId": 15,
        "algorithmExtension": {
            "ignoreCharacters": [],
            "mappingSet": {
                "host": "mypostgreshost.mydomain.com",
                "port": 5432,
                "schema": "mySchema",
                "database": "myDb",
                "isRemote": true,
                "algorithmName": "mappingTestRemote",
                "propertiesRef": {
                  "uri": "delphix-file://upload/f_6ce20b134d5c4891bf90ccf7bd22d9b1/mapping.properties"
                }
            }
        }
    }
    

Info

The above is an example of a remote mapping algorithm. See the extension options below for more information.

Mapping Algorithm Extension

  • ignoreCharacters (optional; minimum=32; maximum=126)

    array[Integer]
    The integer ASCII values of characters to ignore in the column data to map

  • mappingSet (required)

    mappingSet object
    An object that contains information about where the algorithm should find the mappings. See below for object property details.

MappingSet object

  • algorithmName (required)

    string
    The name of the algorithm this mappingSet corresponds to.

  • isRemote

    boolean
    Indicates if the mappings to be used for this algorithm are on the Masking Engine or if they are stored remotely. false if on the engine, true otherwise.

  • host

    string
    The host where the mapping database is running. Must be provided if isRemote is set to true.

  • port

    string
    The port to connect to the mapping database on the host. Must be provided if isRemote is set to true.

  • database

    string
    The name of the mapping database. Must be provided if isRemote is set to true.

  • schema

    string
    The schema where the mappings are. Must be provided if isRemote is set to true.

  • propertiesRef

    string
    The reference UUID value returned from the endpoint for uploading files to the Masking Engine. The file must be a properties file containing any further connection information for the database. Must be provided if isRemote is set to true.