modifyStringField (ModifyStringField)

Takes two jsFuncs which enable the retrieval and modification of strings within items in the stream. The first jsFunc will be applied to each item within the stream and should be used to isolate the string to be manipulated, the second should apply any required mutations to the string itself.

Class names

scala: code.model.flows.processors.utils.ModifyStringFieldScannable
javascript: code_model_flows_processors_utils_ModifyStringFieldScannable

Aliases

StringMutator, StringManipulator

Input type

Output type

Config

{"bindingHint":"Allows users to manipulate strings by writing two JS Functions, one function to extract the target string from the payload and the other function to apply any modifications.","categories":[{"defaultCollapsed":true,"fields":["extractFuncConfig","applyFuncConfig"],"name":"advanced"},{"defaultCollapsed":true,"fields":["testData","testDataTransformFunc","assertionFunc"],"name":"Testing"}],"fieldName":"modifyStringField","fields":[{"default":null,"fieldName":"modifyStringField.name","hidden":false,"hideLabel":false,"name":"name","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":"modifyStringField","fieldName":"modifyStringField.classPath","hidden":false,"hideLabel":false,"name":"classPath","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"default":null,"fieldName":"modifyStringField.testDataTransformFunc","hidden":false,"hideLabel":false,"name":"testDataTransformFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"default":"${generatedId}","fieldName":"modifyStringField.id","hidden":false,"hideLabel":false,"name":"id","readonly":false,"renderStrategies":[],"type":"S","validators":[]},{"bindingHint":"A Javascript function to apply any string manipulation on the extracted string.","default":null,"fieldName":"modifyStringField.apply","hidden":false,"hideLabel":false,"label":"apply","name":"apply","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"categories":[],"fieldName":"modifyStringField.applyFuncConfig","fields":[{"choice":"default","default":{"choice":"default","config":{}},"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig","hidden":false,"hideLabel":false,"name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig","fields":[{"default":["--language=es6"],"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":["_"],"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"default":"nashorn","fieldName":"modifyStringField.applyFuncConfig.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"name":"engine","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["nashorn"],"displayOverride":{},"rule":"choices","unenforced":false}]}],"hidden":false,"hideLabel":true,"name":"overriddenConfig","readonly":false,"renderStrategies":[],"type":"O"}},"validators":[]}],"hidden":false,"hideLabel":false,"name":"applyFuncConfig","readonly":false,"renderStrategies":[],"type":"O"},{"default":null,"fieldName":"modifyStringField.testData","hidden":false,"hideLabel":false,"name":"testData","readonly":false,"renderStrategies":[],"type":"Jv","validators":[]},{"categories":[],"fieldName":"modifyStringField.extractFuncConfig","fields":[{"choice":"default","default":{"choice":"default","config":{}},"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig","hidden":false,"hideLabel":false,"name":"advancedJsConfig","readonly":false,"renderStrategies":[],"type":"CHOICE","types":{"default":{"categories":[],"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.defaultConfig","fields":[],"hidden":true,"hideLabel":true,"name":"defaultConfig","readonly":false,"renderStrategies":[],"type":"O"},"overridden":{"categories":[],"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig","fields":[{"default":["--language=es6"],"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.engineStartupParameters.engineStartupParameters","hidden":false,"hideLabel":false,"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"S","validators":[]},"name":"engineStartupParameters","readonly":false,"renderStrategies":[],"type":"A"},{"default":false,"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.preProcessPrune","hidden":false,"hideLabel":false,"name":"preProcessPrune","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":false,"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.preProcessSyntaxCompile","hidden":false,"hideLabel":false,"name":"preProcessSyntaxCompile","readonly":false,"renderStrategies":[],"type":"B","validators":[]},{"default":["_"],"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries","hidden":false,"hideLabel":false,"itemType":{"default":null,"fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.extraLibraries.extraLibraries","hidden":false,"hideLabel":false,"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["_"],"displayOverride":{},"rule":"choices","unenforced":false}]},"name":"extraLibraries","readonly":false,"renderStrategies":[],"type":"A"},{"default":"nashorn","fieldName":"modifyStringField.extractFuncConfig.advancedJsConfig.overriddenConfig.engine","hidden":false,"hideLabel":false,"name":"engine","readonly":false,"renderStrategies":[],"type":"S","validators":[{"choices":["nashorn"],"displayOverride":{},"rule":"choices","unenforced":false}]}],"hidden":false,"hideLabel":true,"name":"overriddenConfig","readonly":false,"renderStrategies":[],"type":"O"}},"validators":[]}],"hidden":false,"hideLabel":false,"name":"extractFuncConfig","readonly":false,"renderStrategies":[],"type":"O"},{"default":null,"fieldName":"modifyStringField.assertionFunc","hidden":false,"hideLabel":false,"name":"assertionFunc","readonly":false,"renderStrategies":[],"type":"Js","validators":[]},{"bindingHint":"A Javascript function to extract the string to be modified.","default":null,"fieldName":"modifyStringField.extract","hidden":false,"hideLabel":false,"label":"extract","name":"extract","readonly":false,"renderStrategies":[],"type":"Js","validators":[]}],"hidden":false,"hideLabel":false,"label":"modifyStringField","name":"modifyStringField","readonly":false,"renderStrategies":[],"type":"O"}