Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: converted to 1.6 markup

...

Allows the user to extract values from a server response using a Perl-type regular expression. As a post-processor, this element will execute after each Sample request in its scope , applying the regular expression, extracting the requested values, generate the template string, and store the result into the given variable name.

Control Panel
http://jakarta.apache.org/jmeter/images/screenshots/regex_extractor.png

Parameters

Attribute

Description

Required

Name

Descriptive name for this element that is shown in the tree.

No

<ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="27dacc70271378b3-65b0b4bf-4af0479a-8472a7e0-f5e92626763f84b28e7895ad"><ac:plain-text-body><![CDATA[

Reference Name

The name of the JMeter variable in which to store the result. Also note that each group is stored as refname]_g#, where [refname] is the string you entered as the reference name, and # is the group number, where group 0 is the entire match, group 1 is the match from the first set of parentheses, etc.

Yes

]]></ac:plain-text-body></ac:structured-macro>

Regular Expression

The regular expression used to parse the response data. This must contain at least one set of parentheses "()" to capture a portion of the string, unless using the group $0$.

Yes

Template

The template used to create a string from the matches found. This is an arbitrary string with special elements to refer to groups within the regular expression. The syntax to refer to a group is: '$1$' to refer to group 1, '$2$' to refer to group 2, etc. $0$ refers to whatever the entire expression matches.

Yes <ac:structured-macro ac:name="unmigrated-wiki-markup" ac:schema-version="1" ac:macro-id="d718f2cb-b187-4157-a991-a23091161000"><ac:plain-text-body><![CDATA[

Match No.

Indicates which match to use. The regular expression may match multiple times. [BR][BR]

* Use a value of zero to indicate JMeter should choose a match at random.

...


* A positive number N means to select the nth match.

...


* Negative numbers are used in conjunction with the

...

ForEach controller

...

- see below.

...

| Yes |

]]></ac:plain-text-body></ac:structured-macro>

Default Value

If no matches are found, the default value is stored in the variable.

No

...

  • refName_matchNr - the number of matches found; could be 0
  • refName_n, where n = 1,2,3 etc - the strings as generated by the template
  • refName_n_gm, where m=0,1,2 - the groups for match n
  • refName - always set to the actual template value if a match is found, otherwise, the default value.
  • refName_gn - not set

Note that the refName variable is always set to the default value in this case, and the associated group variables are not set.