Configuring Algorithms

This section provides information on configuring algorithms using the API.

Masking Client Algorithm Model

• algorithmName (maxLength=201)
  

  String
  Equivalent to the algorithm name saved by the user through the GUI. For out of the box algorithms, this will be a similar name as that in the GUI, but presented in a more user-friendly format.

• algorithmType
  

  String
  The type of algorithm
  Enum values:
  - BINARY_LOOKUP
  - CLEANSING
  - COMPONENT
  - LOOKUP
  - MAPPLET
  - MAPPING
  - MINMAX
  - REDACTION
  - SEGMENT
  - TOKENIZATION

• createdBy (optional; readOnly; maxLength=255)
  

  String
  The name of the user that created the algorithm

• description (optional; maxLength=255)
  

  String
  The description of the algorithm

• frameworkId
  

  Integer
  The frameworkId, corresponding to the framework that extensible algorithm is built upon. This field is to be used only for the Extensible Algorithms.

• algorithmExtension (optional)
  

  Object
  Contains algorithm instance specific configuration parameters. See specific framework for more details.

Algorithm Extension for Extensible Algorithms

It uses the generic Object, defined in the base AlgorithmExtension. Depending on the Extensible Algorithm design it currently supports following implementations (or their mix):

• fileReference(s) (optional, name is defined by Extensible Algorithm creator)
  

  single fileReference or array[FileReference]
  A JSON formatted file reference or list of file references. Each file reference may be 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
  

• calledExtendedAlgorithm(s) (optional, name is defined by Extensible Algorithm creator)
  

  single algorithmName or array[AlgorithmName]
  A JSON formatted name or a list of extensible algorithms names