This can by used to extract part(s) of a string using a regular expression.
\n| \n\n | \n\nThe internal Elixir regex library is used, which is based on PCRE (Perl Compatible Regular Expressions).\nPlease refer to the Elixir documentation for further details.\n | \n
| \n\n | \n\nIf the string is already being matched in an on or when section, a named capture in that match is usually the better choice. It avoids writing the pattern twice and can extract several submatches at once. See Named captures.\n | \n
result: LOCAL::RESULT = regex(\"<text to be matched>\", expression: \"<regex expression>\")| Position | \nKeyword | \nRequired | \nDescription | \n
|---|---|---|---|
1 | \nstring | \nX | \nString onto which the regex is applied | \n
2 | \nexpression | \nX | \nRegular Expression, needs at least one SubMatch-Pattern. e.g. \"Value: (0-9+) Seconds\" | \n
3 | \noptions | \n\n | Modifiers for creating the Regex, e.g. \"i\". A full list of modifiers is available in the Elixir documentation. | \n
| Tag | \nDescription | \n
|---|---|
result | \nExtracted substring | \n
resultN | \nNth extracted substring (optional depending on regex) | \n
result: LOCAL::RESULT = regex(\"Here is a hidden value 47.11 inside\", expression: \".*value ([0-9.]+) .*\")In this example we match a \"string\" that contains: \"Here is a hidden\nvalue 47.11 inside\". We want to extract the number value from this so\nour regex matches only numbers with a decimal point.
\nThe resulting match of the regex is \"47.11\". This value is then stored\nin the variable RESULT in the LOCAL scope.
result: LOCAL::RESULT = regex(\"${-message}\", expression: \".*value .*\")In this example, the \"-\" character is a string modifier that converts the entire string to lowercase.\nFor more string modifiers go here\n.
\nresult: LOCAL::MAJOR, result2: LOCAL::MINOR, result3: LOCAL::PATCH = regex(\"Version 4.7.0\", \"([0-9]+)\\.([0-9]+)\\.([0-9]+)\")In this example, a version number is extracted with a multi-submatch regex, so major, minor and patch numbers are extracted separately.
\nIn order to perform case-insensitive matching, you can either use the options argument or a regex literal with options:
\n# Using options argument\nresult: LOCAL::RESULT = regex(\"VaLuE: 42.0\", expression: \"value ([0-9.]+)\", options: \"i\")\n# Using regex literal\nresult: LOCAL::RESULT = regex(\"VaLuE: 42.0\", expression: /value ([0-9.]+)/i)\n\n# The options argument does not override the options of a regex\n# literal, so this is has the same result as the last line:\nresult: LOCAL::RESULT = regex(\"VaLuE: 42.0\", expression: /value ([0-9.]+)/i, options: \"\")