JMeter – Boundary Extractor

JMeter - Boundary Extractor Logo

After discussing the dynamic data handling in the previous post in detail, let’s move to the next post-processor element called ‘Boundry Extractor’. In JMeter, the purpose of Boundary Extractor is as same as for Regular Expression Extractor i.e. to get the dynamic value from the response, but the way of implementation is different. In Regular Expression Extractor, we use the regular expression (statement) to fetch the dynamic value but in Boundary Extractor, instead of using one-linear regular expression statement with a complex token we just need to provide left and right boundaries of the dynamic value which needs to be captured.

If we compare Regular Expression Extractor and Boundary Extractor with LoadRunner correlation functions then we find that Regular Expression Extractor acts as web_reg_save_param_regexp() while Boundary Extractor element acts as normal correlation function of LoadRunner i.e. web_reg_save_param(). If you want to get more details on how and why dynamic values need to correlate then refer to the previous post.

JMeter - Boundary Extractor
Figure 01: Boundary Extractor

How to add ‘Boundary Extractor’?

Follow the below steps:

  1. Select the ‘Sampler’ element whose response contains the dynamic value and you want to capture it.
  2. Right-click on the element
  3. Hover the mouse on ‘Add’
  4. Hover the mouse on ‘Post Processors’
  5. Click ‘Boundary Extractor’

What are the input fields of the ‘Boundary Extractor’?

‘Boundary Extractor’ has following input fields:

  1. Name: To provide the name of the post-processor
  2. Comments: To provide arbitrary comments (if any)
  3. Apply to: To define the search scope of dynamic value. 
    1. Main sample and sub-samples: In case, the request is redirected then use this search scope, so that dynamic content can be searched in the response of both main and re-directed request.
    2. Main sample only: When the request is not re-directed or dynamic value is present only in the response of the main request then use this search scope.
    3. Sub-samples only: When the request is re-directed and dynamic value is available in the response of re-directed request then you can use this search scope.
    4. JMeter Variable Name to use: If the dynamic value needs to be extracted from the value of any JMeter variable then you need to select this option and provide the JMeter Variable name in the text field. 
  1. Field to check: It refines the search scope and instructs JMeter to search the dynamic value in the specific part of a sample, sub-sample or JMeter variable depends on the option you selected in “Apply to” section. 
    1. Body: This option instructs JMeter to search in the body of the response. The header of the response does not include in the search scope.
    2. Body (unescaped): The search includes all the HTML escaped code like &amp, &quot, &lt etc. This search scope impacts JMeter performance, hence it is recommended to select this option when really required.
    3. Body as a Document: This option allows JMeter to search the dynamic value in the document returned by the server.
    4. Response Headers: The search will be conducted only on the header part of the response and captured the dynamic value. This option does not apply to the non-HTTP request.
    5. Request Headers: This option instructs JMeter to search in the header part of the request. It is helpful when the request is redirected and the dynamic value is passed in the header of sub-request. This option does not apply for non-HTTP request.
    6. URL: The search scope will be URL only when you select this option. This option is used when the request is re-directed and dynamic value is available in the URL part. The best example of this is OAuth access token capturing.
    7. Response Code: This option is used to capture the response code. Let’s say you have two transaction flows and selection of any flow depends on the pass (Response code = 200) and Fail (Response code != 200) staus of the previous request. In such a scenario you can choose “Response Code” as an option which returns the response code.
    8. Response Message: To capture the response message this option is used. The response message could be like OK, Gateway Timeout etc.
  1. Name of created variable: The name of the variable in which dynamic value will be stored. This is also called a RegEx variable.
  2. Left Boundary: The left boundary of the dynamic value. The value of the left boundary attribute is case-sensitive and do not support regular expressions. This is a mandatory attribute.
  3. Right Boundary: The right boundary of the dynamic value. The value of the right boundary attribute is case-sensitive and do not support regular expressions. This is a mandatory attribute. 
  4. Match No. (0 for random): If more than 1 strings are matched in a response data and you need to capture a dynamic value which comes at a particular place (say 4th place) then you have to give 4 as an input and JMeter will recognize all the matched values on the page but store only 5th value in the regular expression variable. It is as same as the ordinal in the LoadRunner. ‘-1’ is used to capture all the values while ‘0’ is used to pick a random value from the list of match dynamic values.
  5. Default Value: If the regular expression does not match, then the regex variable will be set to the default value (e.g. Not_Found). This is particularly useful for debugging tests.
  6. Use empty default value: If this checkbox is selected then JMeter set the empty string for regular expression variable. This is not recommended because you can not identify whether regular expression working properly or not?

Leave a Reply

Your email address will not be published. Required fields are marked *