Skip to content

Extract

Extract (extract)

Extract fields from text using regular expressions.

Contents

Fields

FieldTypeRequiredDescription
descriptionstringdescribe this step.
conditionlua-expression (string)Only run this action if the specified condition is met.
input-fieldevent-field (string)The field containing the text.
removeboolean (bool)Remove field containing text afterwards.
suppress-warningsboolean (bool)Suppress warnings generated by this action.
dropboolean (bool)Don’t pass through failed matches.
patternregex (string)Pattern containing named groups. Default is to use the group names.
output-fieldsstringfield names to match with each matched group.
convertstringOptionally convert these fields afterwards. The field names will override fields above.
output-patternstringOptionally, do a substitution using text containing $1, $2, etc. referring to captured groups.
output-fieldevent-field (string)Write to this field if doing a substitution.