StringManipulatorEnricher

Ref

  

Less than 1 minute to read

  

2024-09-06 09:35:04 +0100

draft

This page is in draft and may include errors or omissions. Please check the discussions for any pending updates and changes to the content or to suggest your own changes.

Used to process the String fields of a work item. This is useful for cleaning up data. It will limit fields to a max length and apply regex replacements based on what is configured. Each regex replacement is applied in order and can be enabled or disabled.

Options

Parameter name	Type	Description	Default Value
Enabled	Boolean	If enabled this will run this migrator	true
Manipulators	List	List of regex based string manipulations to apply to all string fields. Each regex replacement is applied in order and can be enabled or disabled.	{}
MaxStringLength	Int32	Max number of chars in a string. Applied last, and set to 1000000 by default.	1000000
RefName	String	For internal use	missng XML code comments

Example

A basic sample for StringManipulatorEnricher configuration.

{
  "$type": "StringManipulatorEnricherOptions",
  "Enabled": true,
  "MaxStringLength": 1000000,
  "Manipulators": [
    {
      "$type": "RegexStringManipulator",
      "Enabled": false,
      "Pattern": "[^( -~)\\n\\r\\t]+",
      "Replacement": "",
      "Description": "Remove all non-ASKI characters between ^ and ~."
    }
  ]
}