Tools : StringManipulatorTool

Ref

  

Less than 1 minute to read

  

2024-12-04 17:20:47 +0000

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 set to `true` then the tool will run. Set to `false` and the processor will not run.	missing XML code comments
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

Examples

sample

This is an example of what your config might look like once configured.

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "StringManipulatorTool": {
        "Enabled": "True",
        "Manipulators": [
          {
            "$type": "RegexStringManipulator",
            "Description": "Remove invalid characters from the end of the string",
            "Enabled": "True",
            "Pattern": "[^( -~)\n\r\t]+",
            "Replacement": ""
          }
        ],
        "MaxStringLength": "1000000"
      }
    }
  }
}
    

defaults

These are the default values for this configuration. If you do not set it in your config the default always applies. You can overide by adding a diferent value in your config.

    {
  "MigrationTools": {
    "Version": "16.0",
    "CommonTools": {
      "StringManipulatorTool": {
        "Enabled": "True",
        "Manipulators": null,
        "MaxStringLength": "1000000"
      }
    }
  }
}
    

classic

We have moved to a new config format, and you will need to update your old configs. This entry is a strate seralisation of the object and is here for legacy, and may provide value for debugging issues.

    {
  "$type": "StringManipulatorToolOptions",
  "Enabled": true,
  "MaxStringLength": 1000000,
  "Manipulators": [
    {
      "Enabled": true,
      "Pattern": "[^( -~)\n\r\t]+",
      "Replacement": "",
      "Description": "Remove invalid characters from the end of the string"
    }
  ]
}