root
/
jmeter
mirror of https://github.com/apache/jmeter.git
1
0
Fork 0
Code Issues Actions 4 Packages Projects Releases Wiki Activity
jmeter/docs/usermanual/component_reference.html

6674 lines
566 KiB
HTML
Raw Blame History

<!DOCTYPE html SYSTEM "about:legacy-compat">
<html lang="en"><head><META http-equiv="Content-Type" content="text/html; charset=iso-8859-15"><title>Apache JMeter
-
User's Manual: Component Reference</title><meta name="viewport" content="width=device-width, initial-scale=1"><link href="http://fonts.googleapis.com/css?family=Merriweather:400normal" rel="stylesheet" type="text/css"><link rel="stylesheet" type="text/css" href="../css/new-style.css"></head><body role="document"><a href="#content" class="hidden">Main content</a><div class="header"><!--
APACHE LOGO
--><div><a href="http://www.apache.org"><img title="Apache Software Foundation" width="290" height="75" src="../images/asf-logo.png" alt="Logo ASF"></a></div><!--
PROJECT LOGO
--><div><a href="http://jmeter.apache.org/"><img src="../images/logo.jpg" alt="Apache JMeter"></a></div><div class="twitter"><div><a href="https://twitter.com/share" class="twitter-share-button" data-text="Powerful Load Testing with Apache #JMeter" data-via="ApacheJMeter" data-lang="en-gb" data-size="large">Tweet</a><script>
(function(d,s,id){
var js,
fjs=d.getElementsByTagName(s)[0],
p=/^http:/.test(d.location)?'http':'https';
if (!d.getElementById(id)) {
js=d.createElement(s);
js.id=id;
js.src=p+'://platform.twitter.com/widgets.js';
fjs.parentNode.insertBefore(js,fjs);
}
})(document, 'script', 'twitter-wjs');
</script></div><div><a href="https://twitter.com/ApacheJMeter" class="twitter-follow-button" data-show-count="false" data-lang="en-gb" data-size="large">Follow</a><script>(function(d,s,id){
var js,
fjs=d.getElementsByTagName(s)[0],
p=/^http:/.test(d.location)?'http':'https';
if (!d.getElementById(id)) {
js=d.createElement(s);
js.id=id;
js.src=p+'://platform.twitter.com/widgets.js';
fjs.parentNode.insertBefore(js,fjs);
}
})(document, 'script', 'twitter-wjs');
</script></div></div><div class="banner"><iframe src="http://www.apache.org/ads/bannerbar.html" style="border-width:0;" frameborder="0" scrolling="no"></iframe><div class="clear"></div></div></div><div class="nav"><ul class="menu"><li><div class="menu-title">About</div><ul><li><a href="../index.html">Overview</a></li><li><a href="http://twitter.com/ApacheJMeter">JMeter on Twitter<img src="../images/twitter.png" alt="Icon for JMeter on Twitter"></a></li><li><a href="../issues.html">Issue Tracking</a></li><li><a href="http://projects.apache.org/feeds/rss/jmeter.xml">Subscribe to What's New</a></li><li><a href="http://www.apache.org/licenses/">License</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Download</div><ul><li><a href="../download_jmeter.cgi">Download Releases</a></li><li><a href="../nightly.html">Developer (Nightly) Builds</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Documentation</div><ul><li><a href="../changes.html">Changes per version</a></li><li><a href="../usermanual/get-started.html">Get Started</a></li><li><a href="../usermanual/index.html">User Manual</a></li><li><a href="../usermanual/best-practices.html">Best Practices</a></li><li><a href="../usermanual/component_reference.html">Component Reference</a></li><li><a href="../usermanual/functions.html">Functions Reference</a></li><li><a href="../api/index.html">Javadocs</a></li><li><a href="../building.html">Building JMeter and Add-Ons</a></li><li><a href="http://wiki.apache.org/jmeter">JMeter Wiki</a></li><li><a href="http://wiki.apache.org/jmeter/JMeterFAQ">FAQ (Wiki)</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Tutorials (PDF format)</div><ul><li><a href="../usermanual/jmeter_distributed_testing_step_by_step.pdf">Distributed Testing</a></li><li><a href="../usermanual/jmeter_proxy_step_by_step.pdf">Recording Tests</a></li><li><a href="../usermanual/junitsampler_tutorial.pdf">JUnit Sampler</a></li><li><a href="../usermanual/jmeter_accesslog_sampler_step_by_step.pdf">Access Log Sampler</a></li><li><a href="../extending/jmeter_tutorial.pdf">Extending JMeter</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Community</div><ul><li><a href="http://wiki.apache.org/jmeter/JMeterCommitters">Contributors</a></li><li><a href="../mail.html">Mailing Lists</a></li><li><a href="../svnindex.html">SVN Repositories</a></li></ul></li></ul><ul class="menu"><li><div class="menu-title">Foundation</div><ul><li><a href="http://www.apache.org/">ASF</a></li><li><a href="http://www.apache.org/foundation/getinvolved.html">Get Involved in the ASF</a></li><li><a href="http://www.apache.org/foundation/sponsorship.html">Sponsorship</a></li><li><a href="http://www.apache.org/foundation/thanks.html">Thanks</a></li></ul></li></ul></div><div class="main" id="content"><ul class="pagelinks"><li><a href="boss.html">&lt; Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="functions.html">Next &gt;</a></li></ul><ul class="section-index"><li><a href="#introduction">18.0 Introduction</a><ul></ul></li><li><a href="#samplers">18.1 Samplers</a><ul><li><a href="#FTP_Request">FTP Request</a></li><li><a href="#HTTP_Request">HTTP Request</a></li><li><a href="#JDBC_Request">JDBC Request</a></li><li><a href="#Java_Request">Java Request</a></li><li><a href="#SOAP/XML-RPC_Request">SOAP/XML-RPC Request</a></li><li><a href="#WebService(SOAP)_Request_(DEPRECATED)">WebService(SOAP) Request (DEPRECATED)</a></li><li><a href="#LDAP_Request">LDAP Request</a></li><li><a href="#LDAP_Extended_Request">LDAP Extended Request</a></li><li><a href="#Access_Log_Sampler">Access Log Sampler</a></li><li><a href="#BeanShell_Sampler">BeanShell Sampler</a></li><li><a href="#BSF_Sampler">BSF Sampler</a></li><li><a href="#JSR223_Sampler">JSR223 Sampler</a></li><li><a href="#TCP_Sampler">TCP Sampler</a></li><li><a href="#JMS_Publisher">JMS Publisher</a></li><li><a href="#JMS_Subscriber">JMS Subscriber</a></li><li><a href="#JMS_Point-to-Point">JMS Point-to-Point</a></li><li><a href="#JUnit_Request">JUnit Request</a></li><li><a href="#Mail_Reader_Sampler">Mail Reader Sampler</a></li><li><a href="#Test_Action">Test Action</a></li><li><a href="#SMTP_Sampler">SMTP Sampler</a></li><li><a href="#OS_Process_Sampler">OS Process Sampler</a></li><li><a href="#MongoDB_Script">MongoDB Script</a></li></ul></li><li><a href="#logic_controllers">18.2 Logic Controllers</a><ul><li><a href="#Simple_Controller">Simple Controller</a></li><li><a href="#Loop_Controller">Loop Controller</a></li><li><a href="#Once_Only_Controller">Once Only Controller</a></li><li><a href="#Interleave_Controller">Interleave Controller</a></li><li><a href="#Random_Controller">Random Controller</a></li><li><a href="#Random_Order_Controller">Random Order Controller</a></li><li><a href="#Throughput_Controller">Throughput Controller</a></li><li><a href="#Runtime_Controller">Runtime Controller</a></li><li><a href="#If_Controller">If Controller</a></li><li><a href="#While_Controller">While Controller</a></li><li><a href="#Switch_Controller">Switch Controller</a></li><li><a href="#ForEach_Controller">ForEach Controller</a></li><li><a href="#Module_Controller">Module Controller</a></li><li><a href="#Include_Controller">Include Controller</a></li><li><a href="#Transaction_Controller">Transaction Controller</a></li><li><a href="#Recording_Controller">Recording Controller</a></li><li><a href="#Critical_Section_Controller">Critical Section Controller</a></li></ul></li><li><a href="#listeners">18.3 Listeners</a><ul><li><a href="#Sample_Result_Save_Configuration">Sample Result Save Configuration</a></li><li><a href="#Graph_Results">Graph Results</a></li><li><a href="#Spline_Visualizer">Spline Visualizer</a></li><li><a href="#Assertion_Results">Assertion Results</a></li><li><a href="#View_Results_Tree">View Results Tree</a></li><li><a href="#Aggregate_Report">Aggregate Report</a></li><li><a href="#View_Results_in_Table">View Results in Table</a></li><li><a href="#Simple_Data_Writer">Simple Data Writer</a></li><li><a href="#Monitor_Results">Monitor Results</a></li><li><a href="#Distribution_Graph_(alpha)">Distribution Graph (alpha)</a></li><li><a href="#Aggregate_Graph">Aggregate Graph</a></li><li><a href="#Response_Time_Graph">Response Time Graph</a></li><li><a href="#Mailer_Visualizer">Mailer Visualizer</a></li><li><a href="#BeanShell_Listener">BeanShell Listener</a></li><li><a href="#Summary_Report">Summary Report</a></li><li><a href="#Save_Responses_to_a_file">Save Responses to a file</a></li><li><a href="#BSF_Listener">BSF Listener</a></li><li><a href="#JSR223_Listener">JSR223 Listener</a></li><li><a href="#Generate_Summary_Results">Generate Summary Results</a></li><li><a href="#Comparison_Assertion_Visualizer">Comparison Assertion Visualizer</a></li><li><a href="#Backend_Listener">Backend Listener</a></li></ul></li><li><a href="#config_elements">18.4 Configuration Elements</a><ul><li><a href="#CSV_Data_Set_Config">CSV Data Set Config</a></li><li><a href="#FTP_Request_Defaults">FTP Request Defaults</a></li><li><a href="#DNS_Cache_Manager">DNS Cache Manager</a></li><li><a href="#HTTP_Authorization_Manager">HTTP Authorization Manager</a></li><li><a href="#HTTP_Cache_Manager">HTTP Cache Manager</a></li><li><a href="#HTTP_Cookie_Manager">HTTP Cookie Manager</a></li><li><a href="#HTTP_Request_Defaults">HTTP Request Defaults</a></li><li><a href="#HTTP_Header_Manager">HTTP Header Manager</a></li><li><a href="#Java_Request_Defaults">Java Request Defaults</a></li><li><a href="#JDBC_Connection_Configuration">JDBC Connection Configuration</a></li><li><a href="#Keystore_Configuration">Keystore Configuration</a></li><li><a href="#Login_Config_Element">Login Config Element</a></li><li><a href="#LDAP_Request_Defaults">LDAP Request Defaults</a></li><li><a href="#LDAP_Extended_Request_Defaults">LDAP Extended Request Defaults</a></li><li><a href="#TCP_Sampler_Config">TCP Sampler Config</a></li><li><a href="#User_Defined_Variables">User Defined Variables</a></li><li><a href="#Random_Variable">Random Variable</a></li><li><a href="#Counter">Counter</a></li><li><a href="#Simple_Config_Element">Simple Config Element</a></li><li><a href="#MongoDB_Source_Config">MongoDB Source Config</a></li></ul></li><li><a href="#assertions">18.5 Assertions</a><ul><li><a href="#Response_Assertion">Response Assertion</a></li><li><a href="#Duration_Assertion">Duration Assertion</a></li><li><a href="#Size_Assertion">Size Assertion</a></li><li><a href="#XML_Assertion">XML Assertion</a></li><li><a href="#BeanShell_Assertion">BeanShell Assertion</a></li><li><a href="#MD5Hex_Assertion">MD5Hex Assertion</a></li><li><a href="#HTML_Assertion">HTML Assertion</a></li><li><a href="#XPath_Assertion">XPath Assertion</a></li><li><a href="#XML_Schema_Assertion">XML Schema Assertion</a></li><li><a href="#BSF_Assertion">BSF Assertion</a></li><li><a href="#JSR223_Assertion">JSR223 Assertion</a></li><li><a href="#Compare_Assertion">Compare Assertion</a></li><li><a href="#SMIME_Assertion">SMIME Assertion</a></li></ul></li><li><a href="#timers">18.6 Timers</a><ul><li><a href="#Constant_Timer">Constant Timer</a></li><li><a href="#Gaussian_Random_Timer">Gaussian Random Timer</a></li><li><a href="#Uniform_Random_Timer">Uniform Random Timer</a></li><li><a href="#Constant_Throughput_Timer">Constant Throughput Timer</a></li><li><a href="#Synchronizing_Timer">Synchronizing Timer</a></li><li><a href="#BeanShell_Timer">BeanShell Timer</a></li><li><a href="#BSF_Timer">BSF Timer</a></li><li><a href="#JSR223_Timer">JSR223 Timer</a></li><li><a href="#Poisson_Random_Timer">Poisson Random Timer</a></li></ul></li><li><a href="#preprocessors">18.7 Pre Processors</a><ul><li><a href="#HTML_Link_Parser">HTML Link Parser</a></li><li><a href="#HTTP_URL_Re-writing_Modifier">HTTP URL Re-writing Modifier</a></li><li><a href="#HTML_Parameter_Mask_(DEPRECATED)">HTML Parameter Mask (DEPRECATED)</a></li><li><a href="#User_Parameters">User Parameters</a></li><li><a href="#BeanShell_PreProcessor">BeanShell PreProcessor</a></li><li><a href="#BSF_PreProcessor">BSF PreProcessor</a></li><li><a href="#JSR223_PreProcessor">JSR223 PreProcessor</a></li><li><a href="#JDBC_PreProcessor">JDBC PreProcessor</a></li><li><a href="#RegEx_User_Parameters">RegEx User Parameters</a></li></ul></li><li><a href="#postprocessors">18.8 Post-Processors</a><ul><li><a href="#Regular_Expression_Extractor">Regular Expression Extractor</a></li><li><a href="#CSS/JQuery_Extractor">CSS/JQuery Extractor</a></li><li><a href="#XPath_Extractor">XPath Extractor</a></li><li><a href="#Result_Status_Action_Handler">Result Status Action Handler</a></li><li><a href="#BeanShell_PostProcessor">BeanShell PostProcessor</a></li><li><a href="#BSF_PostProcessor">BSF PostProcessor</a></li><li><a href="#JSR223_PostProcessor">JSR223 PostProcessor</a></li><li><a href="#JDBC_PostProcessor">JDBC PostProcessor</a></li></ul></li><li><a href="#Miscellaneous_Features">18.9 Miscellaneous Features</a><ul><li><a href="#Test_Plan">Test Plan</a></li><li><a href="#Thread_Group">Thread Group</a></li><li><a href="#WorkBench">WorkBench</a></li><li><a href="#SSL_Manager">SSL Manager</a></li><li><a href="#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder
(was:
HTTP Proxy Server
)
</a></li><li><a href="#HTTP_Mirror_Server">HTTP Mirror Server</a></li><li><a href="#Property_Display">Property Display</a></li><li><a href="#Debug_Sampler">Debug Sampler</a></li><li><a href="#Debug_PostProcessor">Debug PostProcessor</a></li><li><a href="#Test_Fragment">Test Fragment</a></li><li><a href="#setUp_Thread_Group">setUp Thread Group</a></li><li><a href="#tearDown_Thread_Group">tearDown Thread Group</a></li></ul></li></ul><div class="section"><h1 id="introduction">18.0 Introduction<a class="sectionlink" href="#introduction" title="Link to here">&para;</a></h1>
<div class="description">
<p>
</p>
<div class="clear"></div><div class="note">
Several test elements use JMeter properties to control their behaviour.
These properties are normally resolved when the class is loaded.
This generally occurs before the test plan starts, so it's not possible to change the settings by using the __setProperty() function.
</div><div class="clear"></div>
<p>
</p>
</div>
</div><div class="section"><h1 id="samplers">18.1 Samplers<a class="sectionlink" href="#samplers" title="Link to here">&para;</a></h1>
<div class="description">
<p>
Samplers perform the actual work of JMeter.
Each sampler (except Test Action) generates one or more sample results.
The sample results have various attributes (success/fail, elapsed time, data size etc) and can be viewed in the various listeners.
</p>
</div>
<div class="component"><h2 id="FTP_Request">FTP Request<a class="sectionlink" href="#FTP_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ftptest/ftp-request.png"><img src="../images/screenshots/ftptest/ftp-request.png" width="861" height="278" alt="Screenshot for FTP Request"></a></div>
<div class="description">
This controller lets you send an FTP "retrieve file" or "upload file" request to an FTP server.
If you are going to send multiple requests to the same FTP server, consider
using a <a href="../usermanual/component_reference.html#FTP_Request_Defaults">FTP Request Defaults</a> Configuration
Element so you do not have to enter the same information for each FTP Request Generative
Controller. When downloading a file, it can be stored on disk (Local File) or in the Response Data, or both.
<p>
Latency is set to the time it takes to login (versions of JMeter after 2.3.1).
</p>
</div>
<div class="properties"><h3 id="FTP_Request_parms1">
Parameters
<a class="sectionlink" href="#FTP_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Server Name or IP</div><div class="description req-true">Domain name or IP address of the FTP server.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port to use. If this is &gt;0, then this specific port is used, otherwise JMeter uses the default FTP port.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Remote File:</div><div class="description req-true">File to retrieve or name of destination file to upload.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Local File:</div><div class="description req-true">File to upload, or destination for downloads (defaults to remote file name).</div><div class="required req-true">Yes, if uploading (*)</div></div>
<div class="property"><div class="name req-true">Local File Contents:</div><div class="description req-true">Provides the contents for the upload, overrides the Local File property.</div><div class="required req-true">Yes, if uploading (*)</div></div>
<div class="property"><div class="name req-true">get(RETR) / put(STOR)</div><div class="description req-true">Whether to retrieve or upload a file.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use Binary mode ?</div><div class="description req-true">Check this to use Binary mode (default Ascii)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Save File in Response ?</div><div class="description req-true">
Whether to store contents of retrieved file in response data.
If the mode is Ascii, then the contents will be visible in the Tree View Listener.
</div><div class="required req-true">Yes, if downloading</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">FTP account username.</div><div class="required req-false">Usually</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">FTP account password. N.B. This will be visible in the test plan.</div><div class="required req-false">Usually</div></div>
</div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="test_plan.html#assertions">Assertions</a></li><li><a href="../usermanual/component_reference.html#FTP_Request_Defaults">FTP Request Defaults</a></li><li><a href="build-ftp-test-plan.html">Building an FTP Test Plan</a></li></ul></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Request">HTTP Request<a class="sectionlink" href="#HTTP_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-request.png"><img src="../images/screenshots/http-request.png" width="900" height="686" alt="Screenshot for HTTP Request"></a></div>
<div class="description">
<p>This sampler lets you send an HTTP/HTTPS request to a web server. It
also lets you control whether or not JMeter parses HTML files for images and
other embedded resources and sends HTTP requests to retrieve them.
The following types of embedded resource are retrieved:</p>
<ul>
<li>images</li>
<li>applets</li>
<li>stylesheets</li>
<li>external scripts</li>
<li>frames, iframes</li>
<li>background images (body, table, TD, TR)</li>
<li>background sound</li>
</ul>
<p>
The default parser is htmlparser.
This can be changed by using the property "htmlparser.classname" - see jmeter.properties for details.
</p>
<p>If you are going to send multiple requests to the same web server, consider
using an <a href="../usermanual/component_reference.html#HTTP_Request_Defaults">HTTP Request Defaults</a>
Configuration Element so you do not have to enter the same information for each
HTTP Request.</p>
<p>Or, instead of manually adding HTTP Requests, you may want to use
JMeter's <a href="../usermanual/component_reference.html#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder</a> to create
them. This can save you time if you have a lot of HTTP requests or requests with many
parameters.</p>
<p><b>There are two different test elements used to define the samplers:</b>
<ul>
<li>AJP/1.3 Sampler - uses the Tomcat mod_jk protocol (allows testing of Tomcat in AJP mode without needing Apache httpd)
The AJP Sampler does not support multiple file upload; only the first file will be used.
</li>
<li>HTTP Request - this has an implementation drop-down box, which selects the HTTP protocol implementation to be used:</li>
<ul>
<li>Java - uses the HTTP implementation provided by the JVM.
This has some limitations in comparison with the HttpClient implementations - see below.</li>
<li>HTTPClient3.1 - uses Apache Commons HttpClient 3.1.
This is no longer being developed, and support for this may be dropped in a future JMeter release.</li>
<li>HTTPClient4 - uses Apache HttpComponents HttpClient 4.x.</li>
<li>Blank Value - does not set implementation on HTTP Samplers, so relies on HTTP Request Defaults if present or on jmeter.httpsampler property defined in jmeter.properties</li>
</ul>
</ul>
</p>
<p>The Java HTTP implementation has some limitations:</p>
<ul>
<li>There is no control over how connections are re-used.
When a connection is released by JMeter, it may or may not be re-used by the same thread.</li>
<li>The API is best suited to single-threaded usage - various settings
are defined via system properties, and therefore apply to all connections.</li>
<li>There is a bug in the handling of HTTPS via a Proxy (the CONNECT is not handled correctly).
See Java bugs 6226610 and 6208335.
</li>
<li>It does not support virtual hosts.</li>
<li>It does not support the following methods: COPY, LOCK, MKCOL, MOVE, PATCH, PROPFIND, PROPPATCH, UNLOCK, REPORT, MKCALENDAR.</li>
<li>It does not support client based certificate testing with Keystore Config.</li>
</ul>
<p>Note: the FILE protocol is intended for testing purposes only.
It is handled by the same code regardless of which HTTP Sampler is used.</p>
<p>If the request requires server or proxy login authorization (i.e. where a browser would create a pop-up dialog box),
you will also have to add an <a href="../usermanual/component_reference.html#HTTP_Authorization_Manager">HTTP Authorization Manager</a> Configuration Element.
For normal logins (i.e. where the user enters login information in a form), you will need to work out what the form submit button does,
and create an HTTP request with the appropriate method (usually POST)
and the appropriate parameters from the form definition.
If the page uses HTTP, you can use the JMeter Proxy to capture the login sequence.
</p>
<p>
In versions of JMeter up to 2.2, only a single SSL context was used for all threads and samplers.
This did not generate the proper load for multiple users.
A separate SSL context is now used for each thread.
To revert to the original behaviour, set the JMeter property:
<pre>
https.sessioncontext.shared=true
</pre>
By default, the SSL context is retained for the duration of the test.
In versions of JMeter from 2.5.1, the SSL session can be optionally reset for each test iteration.
To enable this, set the JMeter property:
<pre>
https.use.cached.ssl.context=false
</pre>
Note: this does not apply to the Java HTTP implementation.
</p>
<p>
JMeter defaults to the SSL protocol level TLS.
If the server needs a different level, e.g. SSLv3, change the JMeter property, for example:
<pre>
https.default.protocol=SSLv3
</pre>
</p>
<p>
JMeter also allows one to enable additional protocols, by changing the property <tt>https.socket.protocols</tt>.
</p>
<p>If the request uses cookies, then you will also need an
<a href="../usermanual/component_reference.html#HTTP_Cookie_Manager">HTTP Cookie Manager</a>. You can
add either of these elements to the Thread Group or the HTTP Request. If you have
more than one HTTP Request that needs authorizations or cookies, then add the
elements to the Thread Group. That way, all HTTP Request controllers will share the
same Authorization Manager and Cookie Manager elements.</p>
<p>If the request uses a technique called "URL Rewriting" to maintain sessions,
then see section
<a href="build-adv-web-test-plan.html#session_url_rewriting">6.1 Handling User Sessions With URL Rewriting</a>
for additional configuration steps.</p>
</div>
<div class="properties"><h3 id="HTTP_Request_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Server</div><div class="description req-true">
Domain name or IP address of the web server. e.g. www.example.com. [Do not include the http:// prefix.]
Note: in JMeter 2.5 (and later) if the "Host" header is defined in a Header Manager, then this will be used
as the virtual host name.
</div><div class="required req-true">Yes, unless provided by HTTP Request Defaults</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port the web server is listening to. Default: 80</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connect Timeout</div><div class="description req-false">Connection Timeout. Number of milliseconds to wait for a connection to open.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Response Timeout</div><div class="description req-false">Response Timeout. Number of milliseconds to wait for a response.
Note that this applies to each wait for a response. If the server response is sent in several chunks, the overall
elapsed time may be longer than the timeout.
A <a href="../usermanual/component_reference.html#Duration_Assertion">Duration Assertion</a> can be used to detect responses that take too long to complete.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Server (proxy)</div><div class="description req-false">Hostname or IP address of a proxy server to perform request. [Do not include the http:// prefix.]</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port the proxy server is listening to.</div><div class="required req-false">No, unless proxy hostname is specified</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">(Optional) username for proxy server.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">(Optional) password for proxy server. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Implementation</div><div class="description req-false">Java, HttpClient3.1, HttpClient4.
If not specified (and not defined by HTTP Request Defaults), the default depends on the value of the JMeter property
<span class="code">jmeter.httpsampler</span>, failing that, the HttpClient4 implementation is used.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Protocol</div><div class="description req-false">HTTP, HTTPS or FILE. Default: HTTP</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Method</div><div class="description req-true">GET, POST, HEAD, TRACE, OPTIONS, PUT, DELETE, PATCH (not supported for
JAVA implementation). With HttpClient4, the following methods related to WebDav are also allowed: COPY, LOCK, MKCOL, MOVE,
PROPFIND, PROPPATCH, UNLOCK, REPORT, MKCALENDAR.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Content Encoding</div><div class="description req-false">
Content encoding to be used (for POST, PUT, PATCH and FILE).
This the the character encoding to be used, and is not related to the Content-Encoding HTTP header.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Redirect Automatically</div><div class="description req-false">
Sets the underlying http protocol handler to automatically follow redirects,
so they are not seen by JMeter, and thus will not appear as samples.
Should only be used for GET and HEAD requests.
The HttpClient sampler will reject attempts to use it for POST or PUT.
<b>Warning: see below for information on cookie and header handling.</b>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Follow Redirects</div><div class="description req-false">
This only has any effect if "Redirect Automatically" is not enabled.
If set, the JMeter sampler will check if the response is a redirect and follow it if so.
The initial redirect and further responses will appear as additional samples.
The URL and data fields of the parent sample will be taken from the final (non-redirected)
sample, but the parent byte count and elapsed time include all samples.
The latency is taken from the initial response (versions of JMeter after 2.3.4 - previously it was zero).
Note that the HttpClient sampler may log the following message:<br>
"Redirect requested but followRedirects is disabled"<br>
This can be ignored.
<br>
In versions after 2.3.4, JMeter will collapse paths of the form '/../segment' in
both absolute and relative redirect URLs. For example http://host/one/../two =&gt; http://host/two.
If necessary, this behaviour can be suppressed by setting the JMeter property
<span class="code">httpsampler.redirect.removeslashdotdot=false</span>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use KeepAlive</div><div class="description req-false">JMeter sets the Connection: keep-alive header. This does not work properly with the default HTTP implementation, as connection re-use is not under user-control.
It does work with the Apache HttpComponents HttpClient implementations.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use multipart/form-data for HTTP POST</div><div class="description req-false">
Use a multipart/form-data or application/x-www-form-urlencoded post request
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Browser-compatible headers</div><div class="description req-false">
When using multipart/form-data, this suppresses the Content-Type and
Content-Transfer-Encoding headers; only the Content-Disposition header is sent.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Path</div><div class="description req-true">The path to resource (for example, /servlets/myServlet). If the
resource requires query string parameters, add them below in the
"Send Parameters With the Request" section.
<b>
As a special case, if the path starts with "http://" or "https://" then this is used as the full URL.
</b>
In this case, the server, port and protocol fields are ignored; parameters are also ignored for GET and DELETE methods.
Also please note that the path is not encoded - apart from replacing spaces with %20 -
so unsafe characters may need to be encoded to avoid errors such as URISyntaxException.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Send Parameters With the Request</div><div class="description req-false">The query string will
be generated from the list of parameters you provide. Each parameter has a <i>name</i> and
<i>value</i>, the options to encode the parameter, and an option to include or exclude an equals sign (some applications
don't expect an equals when the value is the empty string). The query string will be generated in the correct fashion, depending on
the choice of "Method" you made (ie if you chose GET or DELETE, the query string will be
appended to the URL, if POST or PUT, then it will be sent separately). Also, if you are
sending a file using a multipart form, the query string will be created using the
multipart form specifications.
<b>See below for some further information on parameter handling.</b>
<p>
Additionally, you can specify whether each parameter should be URL encoded. If you are not sure what this
means, it is probably best to select it. If your values contain characters such as the following then encoding is usually required.:
<ul>
<li>ASCII Control Chars</li>
<li>Non-ASCII characters</li>
<li>Reserved characters:URLs use some characters for special use in defining their syntax. When these characters are not used in their special role inside a URL, they need to be encoded, example : '$', '&', '+', ',' , '/', ':', ';', '=', '?', '@'</li>
<li>Unsafe characters: Some characters present the possibility of being misunderstood within URLs for various reasons. These characters should also always be encoded, example : ' ', '&lt;', '&gt;', '#', '%', ...</li>
</ul>
</p>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">File Path:</div><div class="description req-false">Name of the file to send. If left blank, JMeter
does not send a file, if filled in, JMeter automatically sends the request as
a multipart form request.
<p>
If it is a POST or PUT or PATCH request and there is a single file whose 'Parameter name' attribute (below) is omitted,
then the file is sent as the entire body
of the request, i.e. no wrappers are added. This allows arbitrary bodies to be sent. This functionality is present for POST requests
after version 2.2, and also for PUT requests after version 2.3.
<b>See below for some further information on parameter handling.</b>
</p>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Parameter name:</div><div class="description req-false">Value of the "name" web request parameter.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">MIME Type</div><div class="description req-false">MIME type (for example, text/plain).
If it is a POST or PUT or PATCH request and either the 'name' attribute (below) are omitted or the request body is
constructed from parameter values only, then the value of this field is used as the value of the
content-type request header.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Retrieve All Embedded Resources from HTML Files</div><div class="description req-false">Tell JMeter to parse the HTML file
and send HTTP/HTTPS requests for all images, Java applets, JavaScript files, CSSs, etc. referenced in the file.
See below for more details.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use as monitor</div><div class="description req-false">For use with the <a href="../usermanual/component_reference.html#Monitor_Results">Monitor Results</a> listener.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Save response as MD5 hash?</div><div class="description req-false">
If this is selected, then the response is not stored in the sample result.
Instead, the 32 character MD5 hash of the data is calculated and stored instead.
This is intended for testing large amounts of data.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Embedded URLs must match:</div><div class="description req-false">
If present, this must be a regular expression that is used to match against any embedded URLs found.
So if you only want to download embedded resources from http://example.com/, use the expression:
http://example\.com/.*
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use concurrent pool</div><div class="description req-false">Use a pool of concurrent connections to get embedded resources.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Size</div><div class="description req-false">Pool size for concurrent connections used to get embedded resources.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Source address type</div><div class="description req-false">
<i>[Only for HTTP Request with HTTPClient implementation]</i> <br>
To distinguish the source address value, select the type of these:
<ul>
<li>Select <i>IP/Hostname</i> to use a specific IP address or a (local) hostname</li>
<li>Select <i>Device</i> to pick the first available address for that interface which
this may be either IPv4 or IPv6</li>
<li>Select <i>Device IPv4</i>To select the IPv4 address of the device name (like eth0, lo, em0, etc.)</li>
<li>Select <i>Device IPv6</i>To select the IPv6 address of the device name (like eth0, lo, em0, etc.)</li>
</ul>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Source address field</div><div class="description req-false">
<i>[Only for HTTP Request with HTTPClient implementation]</i> <br>
This property is used to enable IP Spoofing.
It override the default local IP address for this sample.
The JMeter host must have multiple IP addresses (i.e. IP aliases, network interfaces, devices).
The value can be a host name, IP address, or a network interface device such as "eth0" or "lo" or "wlan0".<br>
If the property <b>httpclient.localaddress</b> is defined, that is used for all HttpClient requests.
</div><div class="required req-false">No</div></div>
</div>
<p>
<b>N.B.</b> when using Automatic Redirection, cookies are only sent for the initial URL.
This can cause unexpected behaviour for web-sites that redirect to a local server.
E.g. if www.example.com redirects to www.example.co.uk.
In this case the server will probably return cookies for both URLs, but JMeter will only see the cookies for the last
host, i.e. www.example.co.uk. If the next request in the test plan uses www.example.com,
rather than www.example.co.uk, it will not get the correct cookies.
Likewise, Headers are sent for the initial request, and won't be sent for the redirect.
This is generally only a problem for manually created test plans,
as a test plan created using a recorder would continue from the redirected URL.
</p>
<p>
<b>Parameter Handling:</b><br>
For the POST and PUT method, if there is no file to send, and the name(s) of the parameter(s) are omitted,
then the body is created by concatenating all the value(s) of the parameters.
Note that the values are concatenated without adding any end-of-line characters.
These can be added by using the __char() function in the value fields.
This allows arbitrary bodies to be sent.
The values are encoded if the encoding flag is set (versions of JMeter after 2.3).
See also the MIME Type above how you can control the content-type request header that is sent.
<br>
For other methods, if the name of the parameter is missing,
then the parameter is ignored. This allows the use of optional parameters defined by variables.
(versions of JMeter after 2.3)
</p>
<br>
<p>Since JMeter 2.6, you have the option to switch to Post Body when a request has only unnamed parameters
(or no parameters at all).
This option is useful in the following cases (amongst others):
<ul>
<li>GWT RPC HTTP Request</li>
<li>JSON REST HTTP Request</li>
<li>XML REST HTTP Request</li>
<li>SOAP HTTP Request</li>
</ul>
Note that once you leave the Tree node, you cannot switch back to the parameter tab unless you clear the Post Body tab of data.
</p>
<p>
In Post Body mode, each line will be sent with CRLF appended, apart from the last line.
To send a CRLF after the last line of data, just ensure that there is an empty line following it.
(This cannot be seen, except by noting whether the cursor can be placed on the subsequent line.)
</p>
<figure><a href="../images/screenshots/http-request-raw-single-parameter.png"><img src="../images/screenshots/http-request-raw-single-parameter.png" width="902" height="421" alt="Figure 1 - HTTP Request with one unnamed parameter"></a><figcaption>Figure 1 - HTTP Request with one unnamed parameter</figcaption></figure>
<figure><a href="../images/screenshots/http-request-confirm-raw-body.png"><img src="../images/screenshots/http-request-confirm-raw-body.png" width="908" height="212" alt="Figure 2 - Confirm dialog to switch"></a><figcaption>Figure 2 - Confirm dialog to switch</figcaption></figure>
<figure><a href="../images/screenshots/http-request-raw-body.png"><img src="../images/screenshots/http-request-raw-body.png" width="905" height="423" alt="Figure 3 - HTTP Request using Body Data"></a><figcaption>Figure 3 - HTTP Request using Body Data</figcaption></figure>
<p>
<b>Method Handling:</b><br>
The POST, PUT and PATCH request methods work similarly, except that the PUT and PATCH methods do not support multipart requests
or file upload.
The PUT and PATCH method body must be provided as one of the following:
<ul>
<li>define the body as a file with empty Parameter name field; in which case the MIME Type is used as the Content-Type</li>
<li>define the body as parameter value(s) with no name</li>
<li>use the Post Body tab</li>
</ul>
If you define any parameters with a name in either the sampler or Http
defaults then nothing is sent.
PUT and PATCH require a Content-Type.
If not using a file, attach a Header Manager to the sampler and define the Content-Type there.
The GET and DELETE request methods work similarly to each other.
</p>
<p>Upto and including JMeter 2.1.1, only responses with the content-type "text/html" were scanned for
embedded resources. Other content-types were assumed to be something other than HTML.
JMeter 2.1.2 introduces the a new property <b>HTTPResponse.parsers</b>, which is a list of parser ids,
e.g. <b>htmlParser</b> and <b>wmlParser</b>. For each id found, JMeter checks two further properties:</p>
<ul>
<li>id.types - a list of content types</li>
<li>id.className - the parser to be used to extract the embedded resources</li>
</ul>
<p>See jmeter.properties file for the details of the settings.
If the HTTPResponse.parser property is not set, JMeter reverts to the previous behaviour,
i.e. only text/html responses will be scanned</p>
<b>Emulating slow connections:</b><br>
HttpClient31, HttpClient4 and Java Sampler support emulation of slow connections; see the following entries in jmeter.properties:
<pre>
# Define characters per second &gt; 0 to emulate slow connections
#httpclient.socket.http.cps=0
#httpclient.socket.https.cps=0
</pre>
<p><b>Response size calculation</b><br>
Optional properties to allow change the method to get response size:<br>
<ul><li>Gets the real network size in bytes for the body response
<pre>sampleresult.getbytes.body_real_size=true</pre></li>
<li>Add HTTP headers to full response size
<pre>sampleresult.getbytes.headers_size=true</pre></li></ul>
<div class="clear"></div><div class="note">
The Java and HttpClient3 inplementations do not include transport overhead such as
chunk headers in the response body size.<br>
The HttpClient4 implementation does include the overhead in the response body size,
so the value may be greater than the number of bytes in the response content.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">Versions of JMeter before 2.5 returns only data response size (uncompressed if request uses gzip/defate mode).
<br>To return to settings before version 2.5, set the two properties to false.</div><div class="clear"></div>
</p>
<p>
<b>Retry handling</b><br>
In version 2.5 of JMeter, the HttpClient4 and Commons HttpClient 3.1 samplers used the default retry count, which was 3.
In later versions, the retry count has been set to 1, which is what the Java implementation appears to do.
The retry count can be overridden by setting the relevant JMeter property, for example:
<pre>
httpclient4.retrycount=3
httpclient3.retrycount=3
</pre>
</p>
<p>
<b>Note: Certificates does not conform to algorithm constraints</b><br>
You may encounter the following error: <i>java.security.cert.CertificateException: Certificates does not conform to algorithm constraints</i>
if you run a HTTPS request on a web site with a SSL certificate (itself or one of SSL certificates in its chain of trust) with a signature
algorithm using MD2 (like md2WithRSAEncryption) or with a SSL certificate with a size lower than 1024 bits.
</p><p>
This error is related to increased security in Java 7 version u16 (MD2) and version u40 (Certificate size lower than 1024 bits), and Java 8 too.
</p><p>
To allow you to perform your HTTPS request, you can downgrade the security of your Java installation by editing
the Java <b>jdk.certpath.disabledAlgorithms</b> property. Remove the MD2 value or the constraint on size, depending on your case.
</p><p>
This property is in this file:
<pre>JAVA_HOME/jre/lib/security/java.security</pre>
See <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=56357">
Bug
56357</a> for details.
</p>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="test_plan.html#assertions">Assertion</a></li><li><a href="build-web-test-plan.html">Building a Web Test Plan</a></li><li><a href="build-adv-web-test-plan.html">Building an Advanced Web Test Plan</a></li><li><a href="../usermanual/component_reference.html#HTTP_Authorization_Manager">HTTP Authorization Manager</a></li><li><a href="../usermanual/component_reference.html#HTTP_Cookie_Manager">HTTP Cookie Manager</a></li><li><a href="../usermanual/component_reference.html#HTTP_Header_Manager">HTTP Header Manager</a></li><li><a href="../usermanual/component_reference.html#HTML_Link_Parser">HTML Link Parser</a></li><li><a href="../usermanual/component_reference.html#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder</a></li><li><a href="../usermanual/component_reference.html#HTTP_Request_Defaults">HTTP Request Defaults</a></li><li><a href="build-adv-web-test-plan.html#session_url_rewriting">HTTP Requests and Session ID's: URL Rewriting</a></li></ul></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JDBC_Request">JDBC Request<a class="sectionlink" href="#JDBC_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jdbctest/jdbc-request.png"><img src="../images/screenshots/jdbctest/jdbc-request.png" width="466" height="334" alt="Screenshot for JDBC Request"></a></div>
<div class="description"><p>This sampler lets you send an JDBC Request (an SQL query) to a database.</p>
<p>Before using this you need to set up a
<a href="../usermanual/component_reference.html#JDBC_Connection_Configuration">JDBC Connection Configuration</a> Configuration element
</p>
<p>
If the Variable Names list is provided, then for each row returned by a Select statement, the variables are set up
with the value of the corresponding column (if a variable name is provided), and the count of rows is also set up.
For example, if the Select statement returns 2 rows of 3 columns, and the variable list is <span class="code">A,,C</span>,
then the following variables will be set up:
<pre>
A_#=2 (number of rows)
A_1=column 1, row 1
A_2=column 1, row 2
C_#=2 (number of rows)
C_1=column 3, row 1
C_2=column 3, row 2
</pre>
If the Select statement returns zero rows, then the A_# and C_# variables would be set to 0, and no other variables would be set.
</p>
<p>
Old variables are cleared if necessary - e.g. if the first select retrieves 6 rows and a second select returns only 3 rows,
the additional variables for rows 4, 5 and 6 will be removed.
</p>
<p>
<b>Note:</b> The latency time is set from the time it took to acquire a connection.
</p>
</div>
<div class="properties"><h3 id="JDBC_Request_parms1">
Parameters
<a class="sectionlink" href="#JDBC_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Variable Name</div><div class="description req-true">
Name of the JMeter variable that the connection pool is bound to.
This must agree with the 'Variable Name' field of a JDBC Connection Configuration.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Query Type</div><div class="description req-true">Set this according to the statement type:
<ul>
<li>Select Statement</li>
<li>Update Statement - use this for Inserts and Deletes as well</li>
<li>Callable Statement</li>
<li>Prepared Select Statement</li>
<li>Prepared Update Statement - use this for Inserts and Deletes as well</li>
<li>Commit</li>
<li>Rollback</li>
<li>Autocommit(false)</li>
<li>Autocommit(true)</li>
<li>Edit - this should be a variable reference that evaluates to one of the above</li>
</ul>
<div class="clear"></div><div class="note">
When "Prepared Select Statement", "Prepared Update Statement" or "Callable Statement" types are selected, a Statement Cache per connection is used by JDBC Request.
It stores by default up to 100 PreparedStatements per connection, this can impact your database (Open Cursors).
</div><div class="clear"></div>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">SQL Query</div><div class="description req-true">
SQL query.
Do not enter a trailing semi-colon.
There is generally no need to use { and } to enclose Callable statements;
however they mey be used if the database uses a non-standard syntax.
[The JDBC driver automatically converts the statement if necessary when it is enclosed in {}].
For example:
<ul>
<li>select * from t_customers where id=23</li>
<li>CALL SYSCS_UTIL.SYSCS_EXPORT_TABLE (null,?, ?, null, null, null)
<ul>
<li>Parameter values: tablename,filename</li>
<li>Parameter types: VARCHAR,VARCHAR</li>
</ul>
</li>
The second example assumes you are using Apache Derby.
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameter values</div><div class="description req-true">
Comma-separated list of parameter values. Use ]NULL[ to indicate a NULL parameter.
(If required, the null string can be changed by defining the property "jdbcsampler.nullmarker".)
<br>
The list must be enclosed in double-quotes if any of the values contain a comma or double-quote,
and any embedded double-quotes must be doubled-up, for example:
<pre>"Dbl-Quote: "" and Comma: ,"</pre>
<div class="clear"></div><div class="note">There must be as many values as there are placeholders in the statement even if your parameters are OUT ones, be sure to set a value even if the value will not be used (for example in a CallableStatement).</div><div class="clear"></div>
</div><div class="required req-true">Yes, if a prepared or callable statement has parameters</div></div>
<div class="property"><div class="name req-true">Parameter types</div><div class="description req-true">
Comma-separated list of SQL parameter types (e.g. INTEGER, DATE, VARCHAR, DOUBLE) or integer values of Constants when for example you use custom database types proposed by driver (-10 for OracleTypes.CURSOR for example).<br>
These are defined as fields in the class java.sql.Types, see for example:<br>
<a href="http://docs.oracle.com/javase/6/docs/api/java/sql/Types.html">Javadoc for java.sql.Types</a>.<br>
[Note: JMeter will use whatever types are defined by the runtime JVM,
so if you are running on a different JVM, be sure to check the appropriate document]<br>
<b>If the callable statement has INOUT or OUT parameters, then these must be indicated by prefixing the
appropriate parameter types, e.g. instead of "INTEGER", use "INOUT INTEGER".</b> <br>
If not specified, "IN" is assumed, i.e. "DATE" is the same as "IN DATE".
<br>
If the type is not one of the fields found in java.sql.Types, versions of JMeter after 2.3.2 also
accept the corresponding integer number, e.g. since OracleTypes.CURSOR == -10, you can use "INOUT -10".
<br>
There must be as many types as there are placeholders in the statement.
</div><div class="required req-true">Yes, if a prepared or callable statement has parameters</div></div>
<div class="property"><div class="name req-false">Variable Names</div><div class="description req-false">Comma-separated list of variable names to hold values returned by Select statements, Prepared Select Statements or CallableStatement.
Note that when used with CallableStatement, list of variables must be in the same sequence as the OUT parameters returned by the call.
If there are less variable names than OUT parameters only as many results shall be stored in the thread-context variables as variable names were supplied.
If more variable names than OUT parameters exist, the additional variables will be ignored</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Result Variable Name</div><div class="description req-false">
If specified, this will create an Object variable containing a list of row maps.
Each map contains the column name as the key and the column data as the value. Usage:<br>
<span class="code">columnValue = vars.getObject("resultObject").get(0).get("Column Name");</span>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Handle ResultSet</div><div class="description req-false">Defines how ResultSet returned from callable statements be handled:
<ul>
<li>Store As String (default) - All variables on Variable Names list are stored as strings, will not iterate through a ResultSets when present on the list.</li>
<li>Store As Object - Variables of ResultSet type on Variables Names list will be stored as Object and can be accessed in subsequent tests/scripts and iterated, will not iterate through the ResultSet </li>
<li>Count Records - Variables of ResultSet types will be iterated through showing the count of records as result. Variables will be stored as Strings.</li>
</ul>
</div><div class="required req-false">No</div></div>
</div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="build-db-test-plan.html">Building a Database Test Plan</a></li><li><a href="../usermanual/component_reference.html#JDBC_Connection_Configuration">JDBC Connection Configuration</a></li></ul></div>
<div class="clear"></div><div class="note">Versions of JMeter after 2.3.2 use UTF-8 as the character encoding. Previously the platform default was used.</div><div class="clear"></div>
<div class="clear"></div><div class="note">Ensure Variable Name is unique accross Test Plan.</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Java_Request">Java Request<a class="sectionlink" href="#Java_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/java_request.png"><img src="../images/screenshots/java_request.png" width="563" height="347" alt="Screenshot for Java Request"></a></div>
<div class="description"><p>This sampler lets you control a java class that implements the
<b><span class="code">org.apache.jmeter.protocol.java.sampler.JavaSamplerClient</span></b> interface.
By writing your own implementation of this interface,
you can use JMeter to harness multiple threads, input parameter control, and
data collection.</p>
<p>The pull-down menu provides the list of all such implementations found by
JMeter in its classpath. The parameters can then be specified in the
table below - as defined by your implementation. Two simple examples (JavaTest and SleepTest) are provided.
</p>
<p>
The JavaTest example sampler can be useful for checking test plans, because it allows one to set
values in almost all the fields. These can then be used by Assertions, etc.
The fields allow variables to be used, so the values of these can readily be seen.
</p>
</div>
<div class="clear"></div><div class="note">Since JMeter 2.8, if the method teardownTest is not overriden by a subclass of AbstractJavaSamplerClient, its teardownTest method will not be called.
This reduces JMeter memory requirements.
This will not have any impact on existing Test plans.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">The Add/Delete buttons don't serve any purpose at present.</div><div class="clear"></div>
<div class="properties"><h3 id="Java_Request_parms1">
Parameters
<a class="sectionlink" href="#Java_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler
that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Classname</div><div class="description req-true">The specific implementation of
the JavaSamplerClient interface to be sampled.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Send Parameters with Request</div><div class="description req-false">A list of
arguments that will be passed to the sampled class. All arguments
are sent as Strings. See below for specific settings.</div><div class="required req-false">No</div></div>
</div>
<p>The following parameters apply to the <b>SleepTest</b> and <b>JavaTest</b> implementations:</p>
<div class="properties"><h3 id="Java_Request_parms2">
Parameters
<a class="sectionlink" href="#Java_Request_parms2" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Sleep_time</div><div class="description req-true">How long to sleep for (ms)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Sleep_mask</div><div class="description req-true">How much "randomness" to add:<br>
The sleep time is calculated as follows:<br>
totalSleepTime = SleepTime + (System.currentTimeMillis() % SleepMask)
</div><div class="required req-true">Yes</div></div>
</div>
<p>The following parameters apply additionaly to the <b>JavaTest</b> implementation:</p>
<div class="properties"><h3 id="Java_Request_parms3">
Parameters
<a class="sectionlink" href="#Java_Request_parms3" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Label</div><div class="description req-false">The label to use. If provided, overrides Name</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">ResponseCode</div><div class="description req-false">If provided, sets the SampleResult ResponseCode.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">ResponseMessage</div><div class="description req-false">If provided, sets the SampleResult ResponseMessage.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Status</div><div class="description req-false">If provided, sets the SampleResult Status. If this equals "OK" (ignoring case) then the status is set to success, otherwise the sample is marked as failed.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">SamplerData</div><div class="description req-false">If provided, sets the SampleResult SamplerData.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">ResultData</div><div class="description req-false">If provided, sets the SampleResult ResultData.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="SOAP/XML-RPC_Request">SOAP/XML-RPC Request<a class="sectionlink" href="#SOAP/XML-RPC_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/soap_sampler.png"><img src="../images/screenshots/soap_sampler.png" width="426" height="276" alt="Screenshot for SOAP/XML-RPC Request"></a></div>
<div class="description"><p>This sampler lets you send a SOAP request to a webservice. It can also be
used to send XML-RPC over HTTP. It creates an HTTP POST request, with the specified XML as the
POST content.
To change the "Content-type" from the default of "text/xml", use a HeaderManager.
Note that the sampler will use all the headers from the HeaderManager.
If a SOAP action is specified, that will override any SOAPaction in the HeaderManager.
The primary difference between the soap sampler and
webservice sampler, is the soap sampler uses raw post and does not require conformance to
SOAP 1.1.</p>
<div class="clear"></div><div class="note">For versions of JMeter later than 2.2, the sampler no longer uses chunked encoding by default.<br>
For screen input, it now always uses the size of the data.<br>
File input uses the file length as determined by Java.<br>
On some OSes this may not work for all files, in which case add a child Header Manager
with Content-Length set to the actual length of the file.<br>
Or set Content-Length to -1 to force chunked encoding.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="SOAP/XML-RPC_Request_parms1">
Parameters
<a class="sectionlink" href="#SOAP/XML-RPC_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler
that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">URL</div><div class="description req-true">The URL to direct the SOAP request to.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Send SOAP action</div><div class="description req-false">Send a SOAP action header? (overrides the Header Manager)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use KeepAlive</div><div class="description req-false">If set, sends Connection: keep-alive, else sends Connection: close</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Soap/XML-RPC Data</div><div class="description req-false">The Soap XML message, or XML-RPC instructions.
Not used if the filename is provided.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Filename</div><div class="description req-false">If specified, then the contents of the file are sent, and the Data field is ignored</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="WebService(SOAP)_Request_(DEPRECATED)">WebService(SOAP) Request (DEPRECATED)<a class="sectionlink" href="#WebService(SOAP)_Request_(DEPRECATED)" title="Link to here">&para;</a></h2><div class="deprecated">
*** This element is deprecated. Use
<a href="../usermanual/component_reference.html#HTTP_Request">HTTP_Request</a>
instead ***
</div><div class="screenshot"><a href="../images/screenshots/webservice_sampler.png"><img src="../images/screenshots/webservice_sampler.png" width="943" height="648" alt="Screenshot for WebService(SOAP) Request (DEPRECATED)"></a></div>
<div class="description"><p>This sampler has been tested with IIS Webservice running .NET 1.0 and .NET 1.1.
It has been tested with SUN JWSDP, IBM webservices, Axis and gSoap toolkit for C/C++.
The sampler uses Apache SOAP driver to serialize the message and set the header
with the correct SOAPAction. Right now the sampler doesn't support automatic WSDL
handling, since Apache SOAP currently does not provide support for it. Both IBM
and SUN provide WSDL drivers. There are 3 options for the post data: text area,
external file, or directory. If you want the sampler to randomly select a message,
use the directory. Otherwise, use the text area or a file. The if either the
file or path are set, it will not use the message in the text area. If you need
to test a soap service that uses different encoding, use the file or path. If you
paste the message in to text area, it will not retain the encoding and will result
in errors. Save your message to a file with the proper encoding, and the sampler
will read it as java.io.FileInputStream.</p>
<p>An important note on the sampler is it will automatically use the proxy host
and port passed to JMeter from command line, if those fields in the sampler are
left blank. If a sampler has values in the proxy host and port text field, it
will use the ones provided by the user. This behavior may not be what users
expect.</p>
<p>By default, the webservice sampler sets SOAPHTTPConnection.setMaintainSession
(true). If you need to maintain the session, add a blank Header Manager. The
sampler uses the Header Manager to store the SOAPHTTPConnection object, since
the version of apache soap does not provide a easy way to get and set the cookies.</p>
<p><b>Note:</b> If you are using CSVDataSet, do not check "Memory Cache". If memory
cache is checked, it will not iterate to the next value. That means all the requests
will use the first value.</p>
<p>Make sure you use &lt;soap:Envelope rather than &lt;Envelope. For example:</p>
<pre>
&lt;?xml version="1.0" encoding="utf-8"?&gt;
&lt;soap:Envelope
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema"
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"&gt;
&lt;soap:Body&gt;
&lt;foo xmlns="http://clients-xlmns"/&gt;
&lt;/soap:Body&gt;
&lt;/soap:Envelope&gt;
</pre>
<div class="clear"></div><div class="note">The SOAP library that is used does not support SOAP 1.2, only SOAP 1.1.
Also the library does not provide access to the HTTP response code (e.g. 200) or message (e.g. OK).
To get round this, versions of JMeter after 2.3.2 check the returned message length.
If this is zero, then the request is marked as failed.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="WebService(SOAP)_Request_(DEPRECATED)_parms1">
Parameters
<a class="sectionlink" href="#WebService(SOAP)_Request_(DEPRECATED)_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler
that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">WSDL URL</div><div class="description req-false">The WSDL URL with the service description.
Versions of JMeter after 2.3.1 support the file: protocol for local WSDL files.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Web Methods</div><div class="description req-false">Will be populated from the WSDL when the Load WSDL button is pressed.
Select one of the methods and press the Configure button to populate the Protocol, Server, Port, Path and SOAPAction fields.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Protocol</div><div class="description req-true">HTTP or HTTPS are acceptable protocol.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Server Name or IP</div><div class="description req-true">The hostname or IP address.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Port Number</div><div class="description req-true">Port Number.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Timeout</div><div class="description req-false">Connection timeout.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Path</div><div class="description req-true">Path for the webservice.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">SOAPAction</div><div class="description req-true">The SOAPAction defined in the webservice description or WSDL.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Soap/XML-RPC Data</div><div class="description req-true">The Soap XML message</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Soap file</div><div class="description req-false">File containing soap message</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Message(s) Folder</div><div class="description req-false">Folder containing soap files. Files are choose randomly during test.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Memory cache</div><div class="description req-true">
When using external files, setting this causes the file to be processed once and caches the result.
This may use a lot of memory if there are many different large files.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Read SOAP Response</div><div class="description req-false">Read the SOAP reponse (consumes performance). Permit to have assertions or post-processors</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use HTTP Proxy</div><div class="description req-false">Check box if http proxy should be used</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Server Name or IP</div><div class="description req-false">Proxy hostname</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Port Number</div><div class="description req-false">Proxy host port</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
Webservice Soap Sampler assumes that empty response means failure.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="LDAP_Request">LDAP Request<a class="sectionlink" href="#LDAP_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ldap_request.png"><img src="../images/screenshots/ldap_request.png" width="621" height="462" alt="Screenshot for LDAP Request"></a></div>
<div class="description">This Sampler lets you send a different Ldap request(Add, Modify, Delete and Search) to an LDAP server.
<p>If you are going to send multiple requests to the same LDAP server, consider
using an <a href="../usermanual/component_reference.html#LDAP_Request_Defaults">LDAP Request Defaults</a>
Configuration Element so you do not have to enter the same information for each
LDAP Request.</p> The same way the <a href="../usermanual/component_reference.html#Login_Config_Element">Login Config Element</a> also using for Login and password.
</div>
<p>There are two ways to create test cases for testing an LDAP Server.</p>
<ol><li>Inbuilt Test cases.</li>
<li>User defined Test cases.</li></ol>
<p>There are four test scenarios of testing LDAP. The tests are given below:</p>
<ol>
<li>Add Test</li>
<ol><li>Inbuilt test :
<p>This will add a pre-defined entry in the LDAP Server and calculate
the execution time. After execution of the test, the created entry will be
deleted from the LDAP
Server.</p></li>
<li>User defined test :
<p>This will add the entry in the LDAP Server. User has to enter all the
attributes in the table.The entries are collected from the table to add. The
execution time is calculated. The created entry will not be deleted after the
test.</p></li></ol>
<li>Modify Test</li>
<ol><li>Inbuilt test :
<p>This will create a pre-defined entry first, then will modify the
created entry in the LDAP Server.And calculate the execution time. After
execution
of the test, the created entry will be deleted from the LDAP Server.</p></li>
<li>User defined test
<p>This will modify the entry in the LDAP Server. User has to enter all the
attributes in the table. The entries are collected from the table to modify.
The execution time is calculated. The entry will not be deleted from the LDAP
Server.</p></li></ol>
<li>Search Test</li>
<ol><li>Inbuilt test :
<p>This will create the entry first, then will search if the attributes
are available. It calculates the execution time of the search query. At the
end of the execution,created entry will be deleted from the LDAP Server.</p></li>
<li>User defined test
<p>This will search the user defined entry(Search filter) in the Search
base (again, defined by the user). The entries should be available in the LDAP
Server. The execution time is calculated.</p></li></ol>
<li>Delete Test</li>
<ol><li>Inbuilt test :
<p>This will create a pre-defined entry first, then it will be deleted
from the LDAP Server. The execution time is calculated.</p></li>
<li>User defined test
<p>This will delete the user-defined entry in the LDAP Server. The entries
should be available in the LDAP Server. The execution time is calculated.</p></li></ol></ol>
<div class="properties"><h3 id="LDAP_Request_parms1">
Parameters
<a class="sectionlink" href="#LDAP_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Server Name or IP</div><div class="description req-true">Domain name or IP address of the LDAP server.
JMeter assumes the LDAP server is listening on the default port(389).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Port</div><div class="description req-true">default port(389).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">root DN</div><div class="description req-true">DN for the server to communicate</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">LDAP server username.</div><div class="required req-false">Usually</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">LDAP server password. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">Usually</div></div>
<div class="property"><div class="name req-true">Entry DN</div><div class="description req-true">the name of the context to create or Modify; may not be empty Example: do you want to add cn=apache,ou=test
you have to add in table name=cn, value=apache
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Delete</div><div class="description req-true">the name of the context to Delete; may not be empty</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Search base</div><div class="description req-true">the name of the context or object to search</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Search filter</div><div class="description req-true"> the filter expression to use for the search; may not be null</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">add test</div><div class="description req-true"> this name, value pair to added in the given context object</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">modify test</div><div class="description req-true"> this name, value pair to add or modify in the given context object</div><div class="required req-true">Yes</div></div>
</div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="build-ldap-test-plan.html">Building an Ldap Test Plan</a></li><li><a href="../usermanual/component_reference.html#LDAP_Request_Defaults">LDAP Request Defaults</a></li></ul></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="LDAP_Extended_Request">LDAP Extended Request<a class="sectionlink" href="#LDAP_Extended_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ldapext_request.png"><img src="../images/screenshots/ldapext_request.png" width="619" height="371" alt="Screenshot for LDAP Extended Request"></a></div>
<div class="description">This Sampler can send all 8 different LDAP request to an LDAP server. It is an extended version of the LDAP sampler,
therefore it is harder to configure, but can be made much closer resembling a real LDAP session.
<p>If you are going to send multiple requests to the same LDAP server, consider
using an <a href="../usermanual/component_reference.html#LDAP_Extended_Request_Defaults">LDAP Extended Request Defaults</a>
Configuration Element so you do not have to enter the same information for each
LDAP Request.</p> </div>
<p>There are nine test operations defined. These operations are given below:</p>
<ol>
<li><b>Thread bind</b></li>
<p>Any LDAP request is part of an LDAP session, so the first thing that should be done is starting a session to the LDAP server.
For starting this session a thread bind is used, which is equal to the LDAP "bind" operation.
The user is requested to give a username (Distinguished name) and password,
which will be used to initiate a session.
When no password, or the wrong password is specified, an anonymous session is started. Take care,
omitting the password will not fail this test, a wrong password will.
(N.B. this is stored unencrypted in the test plan)</p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Servername</div><div class="description req-true">The name (or IP-address) of the LDAP server.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">The port number that the LDAP server is listening to. If this is omitted
JMeter assumes the LDAP server is listening on the default port(389).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">DN</div><div class="description req-false">The distinguished name of the base object that will be used for any subsequent operation.
It can be used as a starting point for all operations. You cannot start any operation on a higher level than this DN!</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">Full distinguished name of the user as which you want to bind.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password for the above user. If omitted it will result in an anonymous bind.
If is is incorrect, the sampler will return an error and revert to an anonymous bind. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
</div>
<br>
<li><b>Thread unbind</b></li>
<p>This is simply the operation to end a session.
It is equal to the LDAP "unbind" operation.</p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<br>
<li><b>Single bind/unbind</b></li>
<p> This is a combination of the LDAP "bind" and "unbind" operations.
It can be used for an authentication request/password check for any user. It will open an new session, just to
check the validity of the user/password combination, and end the session again.</p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Username</div><div class="description req-true">Full distinguished name of the user as which you want to bind.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password for the above user. If omitted it will result in an anonymous bind.
If is is incorrect, the sampler will return an error. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
</div>
<br>
<li><b>Rename entry</b></li>
<p>This is the LDAP "moddn" operation. It can be used to rename an entry, but
also for moving an entry or a complete subtree to a different place in
the LDAP tree. </p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Old entry name</div><div class="description req-true">The current distinguished name of the object you want to rename or move,
relative to the given DN in the thread bind operation.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">New distinguished name</div><div class="description req-true">The new distinguished name of the object you want to rename or move,
relative to the given DN in the thread bind operation.</div><div class="required req-true">Yes</div></div>
</div>
<br>
<li><b>Add test</b></li>
<p>This is the ldap "add" operation. It can be used to add any kind of
object to the LDAP server. </p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Entry DN</div><div class="description req-true">Distinguished name of the object you want to add, relative to the given DN in the thread bind operation.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Add test</div><div class="description req-true">A list of attributes and their values you want to use for the object.
If you need to add a multiple value attribute, you need to add the same attribute with their respective
values several times to the list.</div><div class="required req-true">Yes</div></div>
</div>
<br>
<li><b>Delete test</b></li>
<p> This is the LDAP "delete" operation, it can be used to delete an
object from the LDAP tree </p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Delete</div><div class="description req-true">Distinguished name of the object you want to delete, relative to the given DN in the thread bind operation.</div><div class="required req-true">Yes</div></div>
</div>
<br>
<li><b>Search test</b></li>
<p>This is the LDAP "search" operation, and will be used for defining searches. </p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Search base</div><div class="description req-false">Distinguished name of the subtree you want your
search to look in, relative to the given DN in the thread bind operation.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Search Filter</div><div class="description req-true">searchfilter, must be specified in LDAP syntax.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Scope</div><div class="description req-false">Use 0 for baseobject-, 1 for onelevel- and 2 for a subtree search. (Default=0)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Size Limit</div><div class="description req-false">Specify the maximum number of results you want back from the server. (default=0, which means no limit.) When the sampler hits the maximum number of results, it will fail with errorcode 4</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Time Limit</div><div class="description req-false">Specify the maximum amount of (cpu)time (in miliseconds) that the server can spend on your search. Take care, this does not say anything about the responsetime. (default is 0, which means no limit)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Attributes</div><div class="description req-false">Specify the attributes you want to have returned, seperated by a semicolon. An empty field will return all attributes</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Return object</div><div class="description req-false">Whether the object will be returned (true) or not (false). Default=false</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Dereference aliases</div><div class="description req-false">If true, it will dereference aliases, if false, it will not follow them (default=false)</div><div class="required req-false">No</div></div>
</div>
<br>
<li><b>Modification test</b></li>
<p>This is the LDAP "modify" operation. It can be used to modify an object. It
can be used to add, delete or replace values of an attribute. </p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Entry name</div><div class="description req-true">Distinguished name of the object you want to modify, relative
to the given DN in the thread bind operation</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Modification test</div><div class="description req-true">The attribute-value-opCode triples. The opCode can be any
valid LDAP operationCode (add, delete/remove or replace). If you don't specify a value with a delete operation,
all values of the given attribute will be deleted. If you do specify a value in a delete operation, only
the given value will be deleted. If this value is non-existent, the sampler will fail the test.</div><div class="required req-true">Yes</div></div>
</div>
<br>
<li><b>Compare</b></li>
<p>This is the LDAP "compare" operation. It can be used to compare the value
of a given attribute with some already known value. In reality this is mostly
used to check whether a given person is a member of some group. In such a case
you can compare the DN of the user as a given value, with the values in the
attribute "member" of an object of the type groupOfNames.
If the compare operation fails, this test fails with errorcode 49.</p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Entry DN</div><div class="description req-true">The current distinguished name of the object of
which you want to compare an attribute, relative to the given DN in the thread bind operation.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Compare filter</div><div class="description req-true">In the form "attribute=value"</div><div class="required req-true">Yes</div></div>
</div>
</ol>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="build-ldapext-test-plan.html">Building an LDAP Test Plan</a></li><li><a href="../usermanual/component_reference.html#LDAP_Extended_Request_Defaults">LDAP Extended Request Defaults</a></li></ul></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Access_Log_Sampler">Access Log Sampler<a class="sectionlink" href="#Access_Log_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/accesslogsampler.png"><img src="../images/screenshots/accesslogsampler.png" width="613" height="318" alt="Screenshot for Access Log Sampler"></a></div>
<center><h2>(Beta Code)</h2></center>
<div class="description"><p>AccessLogSampler was designed to read access logs and generate http requests.
For those not familiar with the access log, it is the log the webserver maintains of every
request it accepted. This means every image, css file, javascript file, html file....
The current implementation is complete, but some features have not been enabled.
There is a filter for the access log parser, but I haven't figured out how to link to the pre-processor.
Once I do, changes to the sampler will be made to enable that functionality.</p>
<p>Tomcat uses the common format for access logs. This means any webserver that uses the
common log format can use the AccessLogSampler. Server that use common log format include:
Tomcat, Resin, Weblogic, and SunOne. Common log format looks
like this:</p>
<p>127.0.0.1 - - [21/Oct/2003:05:37:21 -0500] "GET /index.jsp?%2Findex.jsp= HTTP/1.1" 200 8343</p>
<div class="clear"></div><div class="note">The current implementation of the parser only looks at the text within the quotes that contains one of the HTTP protocol methods (GET, PUT, POST, DELETE...).
Everything else is stripped out and ignored. For example, the response code is completely
ignored by the parser. </div><div class="clear"></div>
<p>For the future, it might be nice to filter out entries that
do not have a response code of 200. Extending the sampler should be fairly simple. There
are two interfaces you have to implement:</p>
<ul>
<li>org.apache.jmeter.protocol.http.util.accesslog.LogParser</li>
<li>org.apache.jmeter.protocol.http.util.accesslog.Generator</li>
</ul>
<p>The current implementation of AccessLogSampler uses the generator to create a new
HTTPSampler. The servername, port and get images are set by AccessLogSampler. Next,
the parser is called with integer 1, telling it to parse one entry. After that,
HTTPSampler.sample() is called to make the request.
<pre class="source">
samp = (HTTPSampler) GENERATOR.generateRequest();
samp.setDomain(this.getDomain());
samp.setPort(this.getPort());
samp.setImageParser(this.isImageParser());
PARSER.parse(1);
res = samp.sample();
res.setSampleLabel(samp.toString());
</pre>
The required methods in LogParser are:
<ul>
<li>setGenerator(Generator)</li>
<li>parse(int)</li>
</ul>
Classes implementing Generator interface should provide concrete implementation
for all the methods. For an example of how to implement either interface, refer to
StandardGenerator and TCLogParser.
</p>
</div>
<div class="properties"><h3 id="Access_Log_Sampler_parms1">
Parameters
<a class="sectionlink" href="#Access_Log_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Server</div><div class="description req-true">Domain name or IP address of the web server.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port the web server is listening to.</div><div class="required req-false">No (defaults to 80)</div></div>
<div class="property"><div class="name req-true">Log parser class</div><div class="description req-true">The log parser class is responsible for parsing the logs.</div><div class="required req-true">Yes (default provided)</div></div>
<div class="property"><div class="name req-false">Filter</div><div class="description req-false">The filter class is used to filter out certain lines.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Location of log file</div><div class="description req-true">The location of the access log file.</div><div class="required req-true">Yes</div></div>
</div>
<p>
The TCLogParser processes the access log independently for each thread.
The SharedTCLogParser and OrderPreservingLogParser share access to the file,
i.e. each thread gets the next entry in the log.
</p>
<p>
The SessionFilter is intended to handle Cookies across threads.
It does not filter out any entries, but modifies the cookie manager so that the cookies for a given IP are
processed by a single thread at a time. If two threads try to process samples from the same client IP address,
then one will be forced to wait until the other has completed.
</p>
<p>
The LogFilter is intended to allow access log entries to be filtered by filename and regex,
as well as allowing for the replacement of file extensions. However, it is not currently possible
to configure this via the GUI, so it cannot really be used.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_Sampler">BeanShell Sampler<a class="sectionlink" href="#BeanShell_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/beanshellsampler.png"><img src="../images/screenshots/beanshellsampler.png" width="848" height="566" alt="Screenshot for BeanShell Sampler"></a></div>
<div class="description"><p>This sampler allows you to write a sampler using the BeanShell scripting language.
</p><p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p>
<p>
The test element supports the ThreadListener and TestListener interface methods.
These must be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
<p>
From JMeter version 2.5.1, the BeanShell sampler also supports the Interruptible interface.
The interrupt() method can be defined in the script or the init file.
</p>
</div>
<div class="properties"><h3 id="BeanShell_Sampler_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
This is intended for use with script files; for scripts defined in the GUI, you can use whatever
variable and function references you need within the script itself.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the BeanShell script to run.
The file name is stored in the script variable FileName</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The BeanShell script to run.
The return value (if not null) is stored as the sampler result.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
N.B. Each Sampler instance has its own BeanShell interpeter,
and Samplers are only called from a single thread
</p><p>
If the property "beanshell.sampler.init" is defined, it is passed to the Interpreter
as the name of a sourced file.
This can be used to define common methods and variables.
There is a sample init file in the bin directory: BeanShellSampler.bshrc.
</p><p>
If a script file is supplied, that will be used, otherwise the script will be used.</p>
<div class="clear"></div><div class="note">
JMeter processes function and variable references before passing the script field to the interpreter,
so the references will only be resolved once.
Variable and function references in script files will be passed
verbatim to the interpreter, which is likely to cause a syntax error.
In order to use runtime variables, please use the appropriate props methods,
e.g. props.get("START.HMS"); props.put("PROP1","1234");
<br>
BeanShell does not currently support Java 5 syntax such as generics and the enhanced for loop.
</div><div class="clear"></div>
<p>Before invoking the script, some variables are set up in the BeanShell interpreter:
</p>
<p>The contents of the Parameters field is put into the variable "Parameters".
The string is also split into separate tokens using a single space as the separator, and the resulting list
is stored in the String array bsh.args.</p>
<p>The full list of BeanShell variables that is set up is as follows:</p>
<ul>
<li>log - the Logger</li>
<li>Label - the Sampler label</li>
<li>FileName - the file name, if any</li>
<li>Parameters - text from the Parameters field</li>
<li>bsh.args - the parameters, split as described above</li>
<li>SampleResult - pointer to the current SampleResult</li>
<li>ResponseCode = 200</li>
<li>ResponseMessage = "OK"</li>
<li>IsSuccess = true</li>
<li>ctx - <a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a></li>
<li>vars - <a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a> - e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.remove("VAR3"); vars.putObject("OBJ1",new Object());</li>
<li>props - JMeterProperties (class java.util.Properties)- e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
</ul>
<p>When the script completes, control is returned to the Sampler, and it copies the contents
of the following script variables into the corresponding variables in the <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>:</p>
<ul>
<li>ResponseCode - for example 200</li>
<li>ResponseMessage - for example "OK"</li>
<li>IsSuccess - true/false</li>
</ul>
<p>The SampleResult ResponseData is set from the return value of the script.
Since version 2.1.2, if the script returns null, it can set the response directly, by using the method
SampleResult.setResponseData(data), where data is either a String or a byte array.
The data type defaults to "text", but can be set to binary by using the method
SampleResult.setDataType(SampleResult.BINARY).
</p>
<p>The SampleResult variable gives the script full access to all the fields and
methods in the SampleResult. For example, the script has access to the methods
setStopThread(boolean) and setStopTest(boolean).
Here is a simple (not very useful!) example script:</p>
<pre>
if (bsh.args[0].equalsIgnoreCase("StopThread")) {
log.info("Stop Thread detected!");
SampleResult.setStopThread(true);
}
return "Data from sample with Label "+Label;
//or, since version 2.1.2
SampleResult.setResponseData("My data");
return null;
</pre>
<p>Another example:<br> ensure that the property <b>beanshell.sampler.init=BeanShellSampler.bshrc</b> is defined in jmeter.properties.
The following script will show the values of all the variables in the ResponseData field:
</p>
<pre>
return getVariables();
</pre>
<p>
For details on the methods available for the various classes (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>, <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a> etc) please check the Javadoc or the source code.
Beware however that misuse of any methods can cause subtle faults that may be difficult to find ...
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_Sampler">BSF Sampler<a class="sectionlink" href="#BSF_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/bsfsampler.png"><img src="../images/screenshots/bsfsampler.png" width="848" height="590" alt="Screenshot for BSF Sampler"></a></div>
<div class="description"><p>This sampler allows you to write a sampler using a BSF scripting language.<br>
See the <a href="http://commons.apache.org/bsf/index.html">Apache Bean Scripting Framework</a>
website for details of the languages supported.
You may need to download the appropriate jars for the language; they should be put in the JMeter <b>lib</b> directory.
</p>
<div class="clear"></div><div class="note">
The BSF API has been largely superseded by JSR-223, which is included in Java 6 onwards.
Most scripting languages now include support for JSR-223; please use the JSR223 Sampler instead.
The BSF Sampler should only be needed for supporting legacy languages/test scripts.
</div><div class="clear"></div>
<p>By default, JMeter supports the following languages:</p>
<ul>
<li>javascript</li>
<li>jexl (JMeter version 2.3.2 and later)</li>
<li>xslt</li>
</ul>
<div class="clear"></div><div class="note">Unlike the BeanShell sampler, the interpreter is not saved between invocations.</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="BSF_Sampler_parms1">
Parameters
<a class="sectionlink" href="#BSF_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Scripting Language</div><div class="description req-true">Name of the BSF scripting language to be used.
N.B. Not all the languages in the drop-down list are supported by default.
The following are supported: jexl, javascript, xslt.
Others may be available if the appropriate jar is installed in the JMeter lib directory.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Script File</div><div class="description req-false">Name of a file to be used as a BSF script, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">List of parameters to be passed to the script file or the script.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">Script to be passed to BSF language</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
If a script file is supplied, that will be used, otherwise the script will be used.</p>
<div class="clear"></div><div class="note">
JMeter processes function and variable references before passing the script field to the interpreter,
so the references will only be resolved once.
Variable and function references in script files will be passed
verbatim to the interpreter, which is likely to cause a syntax error.
In order to use runtime variables, please use the appropriate props methods,
e.g. props.get("START.HMS"); props.put("PROP1","1234");
</div><div class="clear"></div>
<p>
Before invoking the script, some variables are set up.
Note that these are BSF variables - i.e. they can be used directly in the script.
</p>
<ul>
<li>log - the Logger</li>
<li>Label - the Sampler label</li>
<li>FileName - the file name, if any</li>
<li>Parameters - text from the Parameters field</li>
<li>args - the parameters, split as described above</li>
<li>SampleResult - pointer to the current <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a></li>
<li>sampler - pointer to current Sampler</li>
<li>ctx - <a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a></li>
<li>vars - <a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a> - e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.remove("VAR3"); vars.putObject("OBJ1",new Object());</li>
<li>props - JMeterProperties (class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>
The <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a> ResponseData is set from the return value of the script.
If the script returns null, it can set the response directly, by using the method
SampleResult.setResponseData(data), where data is either a String or a byte array.
The data type defaults to "text", but can be set to binary by using the method
SampleResult.setDataType(SampleResult.BINARY).
</p>
<p>
The SampleResult variable gives the script full access to all the fields and
methods in the SampleResult. For example, the script has access to the methods
setStopThread(boolean) and setStopTest(boolean).
</p>
<p>
Unlike the BeanShell Sampler, the BSF Sampler does not set the ResponseCode, ResponseMessage and sample status via script variables.
Currently the only way to changes these is via the <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a> methods:
<ul>
<li>SampleResult.setSuccessful(true/false)</li>
<li>SampleResult.setResponseCode("code")</li>
<li>SampleResult.setResponseMessage("message")</li>
</ul>
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_Sampler">JSR223 Sampler<a class="sectionlink" href="#JSR223_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jsr223-sampler.png"><img src="../images/screenshots/jsr223-sampler.png" width="846" height="630" alt="Screenshot for JSR223 Sampler"></a></div>
<div class="description">
<p>
The JSR223 Sampler allows JSR223 script code to be used to perform a sample.
</p>
<p>
The JSR223 test elements have a feature (compilation) that can significantly increase performance.
To benefit from this feature:
<ul>
<li>Use Script files instead of inlining them. This will make JMeter compile them if this feature is available on ScriptEngine and cache them.</li>
<li>Or Use Script Text and fill in script cache key property, ensure it is unique across Test Plan as JMeter will use it to cache result of compilation.
<div class="clear"></div><div class="note">When using this feature, ensure you script code does not use JMeter variables directly in script code as caching would only cache first replacement. Instead use script parameters.</div><div class="clear"></div>
<div class="clear"></div><div class="note">To benefit fomr Caching and compilation, language engine used for scripting must implement JSR223 Compilable interface (Groovy is one of these, java, beanshell and javascript are not)</div><div class="clear"></div>
</li>
</ul>
Cache size is controlled by the following jmeter property (jmeter.properties):
<ul>
<li>jsr223.compiled_scripts_cache_size=100</li>
</ul>
For details, see <a href="../usermanual/component_reference.html#BSF_Sampler">BSF Sampler</a>.
</p>
<div class="clear"></div><div class="note">Unlike the BeanShell sampler, the interpreter is not saved between invocations.</div><div class="clear"></div>
<div class="clear"></div><div class="note">
Since JMeter 2.8, JSR223 Test Elements using Script file or Script text + cache key are now Compiled if ScriptEngine supports this feature, this enables great performance enhancements.
</div><div class="clear"></div>
</div>
<div class="clear"></div><div class="note">
JMeter processes function and variable references before passing the script field to the interpreter,
so the references will only be resolved once.
Variable and function references in script files will be passed
verbatim to the interpreter, which is likely to cause a syntax error.
In order to use runtime variables, please use the appropriate props methods,
e.g. props.get("START.HMS"); props.put("PROP1","1234");
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="TCP_Sampler">TCP Sampler<a class="sectionlink" href="#TCP_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/tcpsampler.png"><img src="../images/screenshots/tcpsampler.png" width="827" height="521" alt="Screenshot for TCP Sampler"></a></div>
<div class="description">
<p>
The TCP Sampler opens a TCP/IP connection to the specified server.
It then sends the text, and waits for a response.
<br>
If "Re-use connection" is selected, connections are shared between Samplers in the same thread,
provided that the exact same host name string and port are used.
Different hosts/port combinations will use different connections, as will different threads.
If both of "Re-use connection" and "Close connection" are selected, the socket will be closed after running the sampler.
On the next sampler, another socket will be created. You may want to close a socket at the end of each thread loop.
<br>
If an error is detected - or "Re-use connection" is not selected - the socket is closed.
Another socket will be reopened on the next sample.
<br>
The following properties can be used to control its operation:
</p>
<ul>
<li>tcp.status.prefix - text that precedes a status number</li>
<li>tcp.status.suffix - text that follows a status number</li>
<li>tcp.status.properties - name of property file to convert status codes to messages</li>
<li>tcp.handler - Name of TCP Handler class (default TCPClientImpl) - only used if not specified on the GUI</li>
</ul>
The class that handles the connection is defined by the GUI, failing that the property tcp.handler.
If not found, the class is then searched for in the package org.apache.jmeter.protocol.tcp.sampler.
<p>
Users can provide their own implementation.
The class must extend org.apache.jmeter.protocol.tcp.sampler.TCPClient.
</p>
<p>
The following implementations are currently provided.
<ul>
<li>TCPClientImpl</li>
<li>BinaryTCPClientImpl</li>
<li>LengthPrefixedBinaryTCPClientImpl</li>
</ul>
The implementations behave as follows:
</p>
<p><b>TCPClientImpl</b><br>
This implementation is fairly basic.
When reading the response, it reads until the end of line byte, if this is defined
by setting the property <b>tcp.eolByte</b>, otherwise until the end of the input stream.
You can control charset encoding by setting <b>tcp.charset</b>, which will default to Platform default encoding.
</p>
<p><b>BinaryTCPClientImpl</b><br>
This implementation converts the GUI input, which must be a hex-encoded string, into binary,
and performs the reverse when reading the response.
When reading the response, it reads until the end of message byte, if this is defined
by setting the property <b>tcp.BinaryTCPClient.eomByte</b>, otherwise until the end of the input stream.
</p>
<p><b>LengthPrefixedBinaryTCPClientImpl</b><br>
This implementation extends BinaryTCPClientImpl by prefixing the binary message data with a binary length byte.
The length prefix defaults to 2 bytes.
This can be changed by setting the property <b>tcp.binarylength.prefix.length</b>.
</p>
<p><b>Timeout handling</b>
If the timeout is set, the read will be terminated when this expires.
So if you are using an eolByte/eomByte, make sure the timeout is sufficiently long,
otherwise the read will be terminated early.
</p>
<p><b>Response handling</b>
<br>
If tcp.status.prefix is defined, then the response message is searched for the text following
that up to the suffix. If any such text is found, it is used to set the response code.
The response message is then fetched from the properties file (if provided).
<br>
For example, if the prefix = "[" and the suffix = "]", then the following repsonse:
<br>
[J28] XI123,23,GBP,CR
<br>
would have the response code J28.
<br>
Response codes in the range "400"-"499" and "500"-"599" are currently regarded as failures;
all others are successful. [This needs to be made configurable!]
</p>
<div class="clear"></div><div class="note">The login name/password are not used by the supplied TCP implementations.</div><div class="clear"></div>
<br>
Sockets are disconnected at the end of a test run.
</div>
<div class="properties"><h3 id="TCP_Sampler_parms1">
Parameters
<a class="sectionlink" href="#TCP_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-false">TCPClient classname</div><div class="description req-false">Name of the TCPClient class. Defaults to the property tcp.handler, failing that TCPClientImpl.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">ServerName or IP</div><div class="description req-true">Name or IP of TCP server</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Port Number</div><div class="description req-true">Port to be used</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Re-use connection</div><div class="description req-true">If selected, the connection is kept open. Otherwise it is closed when the data has been read.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Close connection</div><div class="description req-true">If selected, the connection will be closed after running the sampler.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">SO_LINGER</div><div class="description req-false">Enable/disable SO_LINGER with the specified linger time in seconds when a socket is created. If you set "SO_LINGER" value as 0, you may prevent large numbers of sockets sitting around with a TIME_WAIT status.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">End of line(EOL) byte value</div><div class="description req-false">Byte value for end of line, set this to a value outside the range -128 to +127 to skip eol checking. You may set this in jmeter.properties file as well with eolByte property. If you set this in TCP Sampler Config and in jmeter.properties file at the same time, the setting value in the TCP Sampler Config will be used.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connect Timeout</div><div class="description req-false">Connect Timeout (milliseconds, 0 disables).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Response Timeout</div><div class="description req-false">Response Timeout (milliseconds, 0 disables).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Set Nodelay</div><div class="description req-true">See java.net.Socket.setTcpNoDelay().
If selected, this will disable Nagle's algorithm, otherwise Nagle's algorithm will be used.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Text to Send</div><div class="description req-true">Text to be sent</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Login User</div><div class="description req-false">User Name - not used by default implementation</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password - not used by default implementation (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JMS_Publisher">JMS Publisher<a class="sectionlink" href="#JMS_Publisher" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jmspublisher.png"><img src="../images/screenshots/jmspublisher.png" width="854" height="796" alt="Screenshot for JMS Publisher"></a></div>
<div class="clear"></div><div class="note">BETA CODE - the code is still subject to change</div><div class="clear"></div>
<div class="description">
<p>
JMS Publisher will publish messages to a given destination (topic/queue). For those not
familiar with JMS, it is the J2EE specification for messaging. There are
numerous JMS servers on the market and several open source options.
</p>
<br>
<div class="clear"></div><div class="note">JMeter does not include any JMS implementation jar; this must be downloaded from the JMS provider and put in the lib directory</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="JMS_Publisher_parms1">
Parameters
<a class="sectionlink" href="#JMS_Publisher_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">use JNDI properties file</div><div class="description req-true">use jndi.properties.
Note that the file must be on the classpath - e.g. by updating the user.classpath JMeter property.
If this option is not selected, JMeter uses the "JNDI Initial Context Factory" and "Provider URL" fields
to create the connection.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">JNDI Initial Context Factory</div><div class="description req-false">Name of the context factory</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Provider URL</div><div class="description req-true">The URL for the jms provider</div><div class="required req-true">Yes, unless using jndi.properties</div></div>
<div class="property"><div class="name req-true">Destination</div><div class="description req-true">The message destination (topic or queue name)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Setup</div><div class="description req-true">The destination setup type. With At startup, the destination name is static (i.e. always same name during the test), with Each sample, the destination name is dynamic and is evaluate at each sample (i.e. the destination name may be a variable)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Authentication</div><div class="description req-true">Authentication requirement for the JMS provider</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">User</div><div class="description req-false">User Name</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Expiration</div><div class="description req-false">
The expiration time (in milliseconds) of the message before it becomes obsolete.
If you do not specify an expiration time, the default value is 0 (never expires).
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Priority</div><div class="description req-false">
The priority level of the message. There are ten priority levels from 0 (lowest) to 9 (highest).
If you do not specify a priority level, the default level is 4.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Number of samples to aggregate</div><div class="description req-true">Number of samples to aggregate</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Message source</div><div class="description req-true">Where to obtain the message:
<ul>
<li>From File : means the referenced file will be read and reused by all samples</li>
<li>Random File from folder specified below : means a random file will be selected from folder specified below, this folder must contain either files with extension .dat for Bytes Messages, or files with extension .txt or .obj for Object or Text messages</li>
<li>Text area : The Message to use either for Text or Object message</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Message type</div><div class="description req-true">Text, Map, Object message or Bytes Message</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Use non-persistent delivery mode?</div><div class="description req-false">
Whether to set DeliveryMode.NON_PERSISTENT (defaults to false)
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">JMS Properties</div><div class="description req-false">
The JMS Properties are properties specific for the underlying messaging system.
You can setup the name, the value and the class (type) of value. Default type is String.
For example: for WebSphere 5.1 web services you will need to set the JMS Property targetService to test
webservices through JMS.
</div><div class="required req-false">No</div></div>
</div>
<p>
For the MapMessage type, JMeter reads the source as lines of text.
Each line must have 3 fields, delimited by commas.
The fields are:
<ul>
<li>Name of entry</li>
<li>Object class name, e.g. "String" (assumes java.lang package if not specified)</li>
<li>Object string value</li>
</ul>
For each entry, JMeter adds an Object with the given name.
The value is derived by creating an instance of the class, and using the valueOf(String) method to convert the value if necessary.
For example:
<pre>
name,String,Example
size,Integer,1234
</pre>
This is a very simple implementation; it is not intended to support all possible object types.
</p>
<p>
<div class="clear"></div><div class="note">
The Object message is implemented since 2.7 and works as follow:
<ul>
<li>Put the JAR that contains your object and its dependencies in jmeter_home/lib/ folder</li>
<li>Serialize your object as XML using XStream</li>
<li>Either put result in a file suffixed with .txt or .obj or put XML content direclty in Text Area</li>
</ul>
Note that if message is in a file, replacement of properties will not occur while it will if you use Text Area.
</div><div class="clear"></div>
</p>
<p>
The following table shows some values which may be useful when configuring JMS:
<table>
<tr>
<th>Apache <a href="http://activemq.apache.org/">ActiveMQ</a></th>
<th>Value(s)</th>
<th>Comment</th>
</tr>
<tr><td>Context Factory</td><td>org.apache.activemq.jndi.ActiveMQInitialContextFactory</td><td>.</td></tr>
<tr><td>Provider URL</td><td>vm://localhost</td><td></td></tr>
<tr><td>Provider URL</td><td>vm:(broker:(vm://localhost)?persistent=false)</td><td>Disable persistence</td></tr>
<tr><td>Queue Reference</td><td>dynamicQueues/QUEUENAME</td>
<td><a href="http://activemq.apache.org/jndi-support.html#JNDISupport-Dynamicallycreatingdestinations">Dynamically define</a> the QUEUENAME to JNDI</td></tr>
<tr><td>Topic Reference</td><td>dynamicTopics/TOPICNAME</td>
<td><a href="http://activemq.apache.org/jndi-support.html#JNDISupport-Dynamicallycreatingdestinations">Dynamically define</a> the TOPICNAME to JNDI</td></tr>
</table>
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JMS_Subscriber">JMS Subscriber<a class="sectionlink" href="#JMS_Subscriber" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jmssubscriber.png"><img src="../images/screenshots/jmssubscriber.png" width="709" height="498" alt="Screenshot for JMS Subscriber"></a></div>
<div class="clear"></div><div class="note">BETA CODE - the code is still subject to change</div><div class="clear"></div>
<div class="description">
<p>
JMS Publisher will subscribe to messages in a given destination (topic or queue). For those not
familiar with JMS, it is the J2EE specification for messaging. There are
numerous JMS servers on the market and several open source options.
</p>
<br>
<div class="clear"></div><div class="note">JMeter does not include any JMS implementation jar; this must be downloaded from the JMS provider and put in the lib directory</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="JMS_Subscriber_parms1">
Parameters
<a class="sectionlink" href="#JMS_Subscriber_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">use JNDI properties file</div><div class="description req-true">use jndi.properties.
Note that the file must be on the classpath - e.g. by updating the user.classpath JMeter property.
If this option is not selected, JMeter uses the "JNDI Initial Context Factory" and "Provider URL" fields
to create the connection.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">JNDI Initial Context Factory</div><div class="description req-false">Name of the context factory</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Provider URL</div><div class="description req-false">The URL for the jms provider</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Destination</div><div class="description req-true">the message destination (topic or queue name)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Durable Subscription ID</div><div class="description req-false">The ID to use for a durable subscription. On first
use the respective queue will automatically be generated by the JMS provider if it does not exist yet.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Client ID</div><div class="description req-false">The Client ID to use when you you use a durable subscription.
Be sure to add a variable like ${__threadNum} when you have more than one Thread.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">JMS Selector</div><div class="description req-false">Message Selector as defined by JMS specification to extract only
messages that respect the Selector condition. Syntax uses subpart of SQL 92.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Setup</div><div class="description req-true">The destination setup type. With At startup, the destination name is static (i.e. always same name during the test), with Each sample, the destination name is dynamic and is evaluate at each sample (i.e. the destination name may be a variable)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Authentication</div><div class="description req-true">Authentication requirement for the JMS provider</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">User</div><div class="description req-false">User Name</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Number of samples to aggregate</div><div class="description req-true">number of samples to aggregate</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Read response</div><div class="description req-true">should the sampler read the response. If not, only the response length is returned.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Timeout</div><div class="description req-true">Specify the timeout to be applied, in milliseconds. 0=none.
This is the overall aggregate timeout, not per sample.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Client</div><div class="description req-true">Which client implementation to use.
Both of them create connections which can read messages. However they use a different strategy, as described below:
<ul>
<li>MessageConsumer.receive() - calls receive() for every requested message.
Retains the connection between samples, but does not fetch messages unless the sampler is active.
This is best suited to Queue subscriptions.
</li>
<li>MessageListener.onMessage() - establishes a Listener that stores all incoming messages on a queue.
The listener remains active after the sampler completes.
This is best suited to Topic subscriptions.</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Stop between samples?</div><div class="description req-true">
If selected, then JMeter calls Connection.stop() at the end of each sample (and calls start() before each sample).
This may be useful in some cases where multiple samples/threads have connections to the same queue.
If not selected, JMeter calls Connection.start() at the start of the thread, and does not call stop() until the end of the thread.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Separator</div><div class="description req-false">
Separator used to separate messages when there is more than one (related to setting Number of samples to aggregate).
Note that \n, \r, \t are accepted.
</div><div class="required req-false">No</div></div>
</div>
<p>
<b>NOTE:</b> JMeter 2.3.4 and earlier used a different strategy for the MessageConsumer.receive() client.
Previously this started a background thread which polled for messages. This thread continued when the sampler
completed, so the net effect was similar to the MessageListener.onMessage() strategy.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JMS_Point-to-Point">JMS Point-to-Point<a class="sectionlink" href="#JMS_Point-to-Point" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jms/JMS_Point-to-Point.png"><img src="../images/screenshots/jms/JMS_Point-to-Point.png" width="882" height="804" alt="Screenshot for JMS Point-to-Point"></a></div>
<div class="clear"></div><div class="note">BETA CODE - the code is still subject to change</div><div class="clear"></div>
<div class="description">
<p>
This sampler sends and optionally receives JMS Messages through point-to-point connections (queues).
It is different from pub/sub messages and is generally used for handling transactions.
</p>
<p>
<b>Request Only</b> will typically used to put load on a JMS System.<br>
<b>Request Response</b> will be used when you want to test response time of a JMS service that processes messages sent to the Request Queue as this mode will wait for the response on the Reply queue sent by this service.<br>
</p>
<p>
Versions of JMeter after 2.3.2 use the properties java.naming.security.[principal|credentials] - if present -
when creating the Queue Connection. If this behaviour is not desired, set the JMeter property
<b>JMSSampler.useSecurity.properties=false</b>
</p>
<br>
<div class="clear"></div><div class="note">JMeter does not include any JMS implementation jar; this must be downloaded from the JMS provider and put in the lib directory</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="JMS_Point-to-Point_parms1">
Parameters
<a class="sectionlink" href="#JMS_Point-to-Point_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">QueueConnection Factory</div><div class="description req-true">
The JNDI name of the queue connection factory to use for connecting to the messaging system.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">JNDI Name Request queue</div><div class="description req-true">
This is the JNDI name of the queue to which the messages are sent.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">JNDI Name Reply queue</div><div class="description req-false">
The JNDI name of the receiving queue. If a value is provided here and the communication style is Request Response
this queue will be monitored for responses to the requests sent.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">JMS Selector</div><div class="description req-false">
Message Selector as defined by JMS specification to extract only
messages that respect the Selector condition. Syntax uses subpart of SQL 92.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Communication style</div><div class="description req-true">
The Communication style can be <b>Request Only</b> (also known as Fire and Forget) or <b>Request Response</b>:
<ul>
<li><b>Request Only</b> will only send messages and will not monitor replies. As such it can be used to put load on a system.</li>
<li><b>Request Response</b> will send messages and monitor the replies it receives. Behaviour depends on the value of the JNDI Name Reply Queue.
If JNDI Name Reply Queue has a value, this queue is used to monitor the results. Matching of request and reply is done with
the message id of the request and the correlation id of the reply. If the JNDI Name Reply Queue is empty, then
temporary queues will be used for the communication between the requestor and the server.
This is very different from the fixed reply queue. With temporary queues the sending thread will block until the reply message has been received.
With <b>Request Response</b> mode, you need to have a Server that listens to messages sent to Request Queue and sends replies to
queue referenced by <span class="code">message.getJMSReplyTo()</span>.</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use alternate fields for message correlation</div><div class="description req-true">
These check-boxes select the fields which will be used for matching the response message with the original request.
<ul>
<li><b>Use Request Message Id</b> - if selected, the request JMSMessageID will be used,
otherwise the request JMSCorrelationID will be used.
In the latter case the correlation id must be specified in the request.</li>
<li><b>Use Response Message Id</b> - if selected, the response JMSMessageID will be used,
otherwise the response JMSCorrelationID will be used.
</li>
</ul>
There are two frequently used JMS Correlation patterns:
<ul>
<li>JMS Correlation ID Pattern -
i.e. match request and response on their correlation Ids
=&gt; deselect both checkboxes, and provide a correlation id.</li>
<li>JMS Message ID Pattern -
i.e. match request message id with response correlation id
=&gt; select "Use Request Message Id" only.
</li>
</ul>
In both cases the JMS application is responsible for populating the correlation ID as necessary.
<div class="clear"></div><div class="note">if the same queue is used to send and receive messages,
then the response message will be the same as the request message.
In which case, either provide a correlation id and clear both checkboxes;
or select both checkboxes to use the message Id for correlation.
This can be useful for checking raw JMS throughput.</div><div class="clear"></div>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Timeout</div><div class="description req-true">
The timeout in milliseconds for the reply-messages. If a reply has not been received within the specified
time, the specific testcase failes and the specific reply message received after the timeout is discarded.
Default value is 2000 ms.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Expiration</div><div class="description req-false">
The expiration time (in milliseconds) of the message before it becomes obsolete.
If you do not specify an expiration time, the default value is 0 (never expires).
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Priority</div><div class="description req-false">
The priority level of the message. There are ten priority levels from 0 (lowest) to 9 (highest).
If you do not specify a priority level, the default level is 4.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Use non-persistent delivery mode?</div><div class="description req-true">
Whether to set DeliveryMode.NON_PERSISTENT.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Content</div><div class="description req-false">
The content of the message.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">JMS Properties</div><div class="description req-false">
The JMS Properties are properties specific for the underlying messaging system.
You can setup the name, the value and the class (type) of value. Default type is String.
For example: for WebSphere 5.1 web services you will need to set the JMS Property targetService to test
webservices through JMS.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Initial Context Factory</div><div class="description req-false">
The Initial Context Factory is the factory to be used to look up the JMS Resources.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">JNDI properties</div><div class="description req-false">
The JNDI Properties are the specific properties for the underlying JNDI implementation.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Provider URL</div><div class="description req-false">
The URL for the jms provider.
</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JUnit_Request">JUnit Request<a class="sectionlink" href="#JUnit_Request" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/junit_sampler.png"><img src="../images/screenshots/junit_sampler.png" width="397" height="536" alt="Screenshot for JUnit Request"></a></div>
<div class="description">
The current implementation supports standard Junit convention and extensions. It also
includes extensions like oneTimeSetUp and oneTimeTearDown. The sampler works like the
JavaSampler with some differences.
<ul>
<li>rather than use Jmeter's test interface, it scans the jar files for classes extending junit's TestCase class. That includes any class or subclass.</li>
<li>Junit test jar files should be placed in jmeter/lib/junit instead of /lib directory.
In versions of JMeter after 2.3.1, you can also use the "user.classpath" property to specify where to look for TestCase classes.</li>
<li>Junit sampler does not use name/value pairs for configuration like the JavaSampler. The sampler assumes setUp and tearDown will configure the test correctly.</li>
<li>The sampler measures the elapsed time only for the test method and does not include setUp and tearDown.</li>
<li>Each time the test method is called, Jmeter will pass the result to the listeners.</li>
<li>Support for oneTimeSetUp and oneTimeTearDown is done as a method. Since Jmeter is multi-threaded, we cannot call oneTimeSetUp/oneTimeTearDown the same way Maven does it.</li>
<li>The sampler reports unexpected exceptions as errors.
There are some important differences between standard JUnit test runners and JMeter's
implementation. Rather than make a new instance of the class for each test, JMeter
creates 1 instance per sampler and reuses it.
This can be changed with checkbox "Create a new instance per sample".</li>
</ul>
The current implementation of the sampler will try to create an instance using the string constructor first. If the test class does not declare a string constructor, the sampler will look for an empty constructor. Example below:
<div class="example"><div class="title">Junit Constructors<a class="sectionlink" href="#junit_constructor_example" title="Link to here">&para;</a></div>
Empty Constructor:
<pre>
public class myTestCase {
public myTestCase() {}
}
</pre>
String Constructor:
<pre>
public class myTestCase {
public myTestCase(String text) {
super(text);
}
}
</pre>
</div>
By default, Jmeter will provide some default values for the success/failure code and message. Users should define a set of unique success and failure codes and use them uniformly across all tests.
<div class="clear"></div><div class="note">
<h3>General Guidelines</h3>
If you use setUp and tearDown, make sure the methods are declared public. If you do not, the test may not run properly.
<br>
Here are some general guidelines for writing Junit tests so they work well with Jmeter. Since Jmeter runs multi-threaded, it is important to keep certain things in mind.
<ul>
<li>Write the setUp and tearDown methods so they are thread safe. This generally means avoid using static memebers.</li>
<li>Make the test methods discrete units of work and not long sequences of actions. By keeping the test method to a descrete operation, it makes it easier to combine test methods to create new test plans.</li>
<li>Avoid making test methods depend on each other. Since Jmeter allows arbitrary sequencing of test methods, the runtime behavior is different than the default Junit behavior.</li>
<li>If a test method is configurable, be careful about where the properties are stored. Reading the properties from the Jar file is recommended.</li>
<li>Each sampler creates an instance of the test class, so write your test so the setup happens in oneTimeSetUp and oneTimeTearDown.</li>
</ul>
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="JUnit_Request_parms1">
Parameters
<a class="sectionlink" href="#JUnit_Request_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Search for JUnit4 annotations</div><div class="description req-true">Select this to search for JUnit 4 tests (@Test annotations)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Package filter</div><div class="description req-true">Comma separated list of packages to show. Example, org.apache.jmeter,junit.framework.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Class name</div><div class="description req-true">Fully qualified name of the JUnit test class.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Constructor string</div><div class="description req-true">String pass to the string constructor. If a string is set, the sampler will use the
string constructor instead of the empty constructor.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Test method</div><div class="description req-true">The method to test.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Success message</div><div class="description req-true">A descriptive message indicating what success means.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Success code</div><div class="description req-true">An unique code indicating the test was successful.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Failure message</div><div class="description req-true">A descriptive message indicating what failure means.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Failure code</div><div class="description req-true">An unique code indicating the test failed.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Error message</div><div class="description req-true">A description for errors.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Error code</div><div class="description req-true">Some code for errors. Does not need to be unique.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Do not call setUp and tearDown</div><div class="description req-true">Set the sampler not to call setUp and tearDown.
By default, setUp and tearDown should be called. Not calling those methods could affect the test and make it inaccurate.
This option should only be used with calling oneTimeSetUp and oneTimeTearDown. If the selected method is oneTimeSetUp or oneTimeTearDown,
this option should be checked.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Append assertion errors</div><div class="description req-true">Whether or not to append assertion errors to the response message.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Append runtime exceptions</div><div class="description req-true">Whether or not to append runtime exceptions to the response message. Only applies if "Append assertion errors" is not selected.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Create a new Instance per sample</div><div class="description req-true">Whether or not to create a new JUnit instance for each sample. Defaults to false, meaning JUnit TestCase is created one and reused.</div><div class="required req-true">Yes</div></div>
</div>
<p>
The following JUnit4 annotations are recognised:
<ul>
<li>@Test - used to find test methods and classes. The "expected" and "timeout" attributes are supported.</li>
<li>@Before - treated the same as setUp() in JUnit3</li>
<li>@After - treated the same as tearDown() in JUnit3</li>
<li>@BeforeClass, @AfterClass - treated as test methods so they can be run independently as required</li>
</ul>
</p>
<p>
Note that JMeter currently runs the test methods directly, rather than leaving it to JUnit.
This is to allow the setUp/tearDown methods to be excluded from the sample time.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Mail_Reader_Sampler">Mail Reader Sampler<a class="sectionlink" href="#Mail_Reader_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/mailreader_sampler.png"><img src="../images/screenshots/mailreader_sampler.png" width="547" height="409" alt="Screenshot for Mail Reader Sampler"></a></div>
<div class="description">
<p>
The Mail Reader Sampler can read (and optionally delete) mail messages using POP3(S) or IMAP(S) protocols.
</p>
</div>
<div class="properties"><h3 id="Mail_Reader_Sampler_parms1">
Parameters
<a class="sectionlink" href="#Mail_Reader_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Server Type</div><div class="description req-true">The protocol used by the provider: e.g. pop3, pop3s, imap, imaps.
or another string representing the server protocol.
For example <span class="code">file</span> for use with the read-only mail file provider.
The actual provider names for POP3 and IMAP are <span class="code">pop3</span> and <span class="code">imap</span>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Server</div><div class="description req-true">Hostname or IP address of the server. See below for use with <span class="code">file</span> protocol.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port to be used to connect to the server (optional)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Username</div><div class="description req-true">User login name</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Password</div><div class="description req-true">User login password (N.B. this is stored unencrypted in the test plan)</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Folder</div><div class="description req-true">The IMAP(S) folder to use. See below for use with <span class="code">file</span> protocol.</div><div class="required req-true">Yes, if using IMAP(S)</div></div>
<div class="property"><div class="name req-true">Number of messages to retrieve</div><div class="description req-true">Set this to retrieve all or some messages</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Fetch headers only</div><div class="description req-true">If selected, only the message headers will be retrieved.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Delete messages from the server</div><div class="description req-true">If set, messages will be deleted after retrieval</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Store the message using MIME</div><div class="description req-true">Whether to store the message as MIME.
If so, then the entire raw message is stored in the Response Data; the headers are not stored as they are available in the data.
If not, the message headers are stored as Response Headers.
A few headers are stored (Date, To, From, Subject) in the body.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use no security features</div><div class="description req-true">Indicates that the connection to the server does not use any security protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use SSL</div><div class="description req-true">Indicates that the connection to the server must use the SSL protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use StartTLS</div><div class="description req-true">Indicates that the connection to the server should attempt to start the TLS protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Enforce StartTLS</div><div class="description req-true">If the server does not start the TLS protocol the connection will be terminated.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Trust All Certificates</div><div class="description req-true">When selected it will accept all certificates independent of the CA.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use local truststore</div><div class="description req-true">When selected it will only accept certificates that are locally trusted.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Local truststore</div><div class="description req-true">Path to file containing the trusted certificates.
Relative paths are resolved against the current directory.
<br>Failing that, against the directory containing the test script (JMX file).
</div><div class="required req-true"></div></div>
</div>
<p>
Messages are stored as subsamples of the main sampler.
In versions of JMeter after 2.3.4, multipart message parts are stored as subsamples of the message.
</p>
<p>
<b>Special handling for "file" protocol:</b><br>
The <span class="code">file</span> JavaMail provider can be used to read raw messages from files.
The <span class="code">server</span> field is used to specify the path to the parent of the <span class="code">folder</span>.
Individual message files should be stored with the name <span class="code">n.msg</span>,
where <span class="code">n</span> is the message number.
Alternatively, the <span class="code">server</span> field can be the name of a file which contains a single message.
The current implementation is quite basic, and is mainly intended for debugging purposes.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Test_Action">Test Action<a class="sectionlink" href="#Test_Action" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/test_action.png"><img src="../images/screenshots/test_action.png" width="467" height="184" alt="Screenshot for Test Action"></a></div>
<div class="description">
The Test Action sampler is a sampler that is intended for use in a conditional controller.
Rather than generate a sample, the test element eithers pauses or stops the selected target.
<p>This sampler can also be useful in conjunction with the Transaction Controller, as it allows
pauses to be included without needing to generate a sample.
For variable delays, set the pause time to zero, and add a Timer as a child.</p>
<p>
The "Stop" action stops the thread or test after completing any samples that are in progress.
The "Stop Now" action stops the test without waiting for samples to complete; it will interrupt any active samples.
If some threads fail to stop within the 5 second time-limit, a message will be displayed in GUI mode.
You can try using the Stop command to see if this will stop the threads, but if not, you should exit JMeter.
In non-GUI mode, JMeter will exit if some threads fail to stop within the 5 second time limit.
[This can be changed using the JMeter property <span class="code">jmeterengine.threadstop.wait</span>]
</p>
</div>
<div class="properties"><h3 id="Test_Action_parms1">
Parameters
<a class="sectionlink" href="#Test_Action_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Target</div><div class="description req-true">Current Thread / All Threads (ignored for Pause)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Action</div><div class="description req-true">Pause / Stop / Stop Now / Go to next loop iteration</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Duration</div><div class="description req-true">How long to pause for (milliseconds)</div><div class="required req-true">Yes, if Pause is selected</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="SMTP_Sampler">SMTP Sampler<a class="sectionlink" href="#SMTP_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/smtp_sampler.png"><img src="../images/screenshots/smtp_sampler.png" width="825" height="728" alt="Screenshot for SMTP Sampler"></a></div>
<div class="description">
<p>
The SMTP Sampler can send mail messages using SMTP/SMTPS protocol.
It is possible to set security propocols for the connection (SSL and TLS), as well as user authentication.
If a security protocol is used a verification on the server certificate will occur. <br>
Two alternatives to handle this verification are available:<br>
<ul>
<li>Trust all certificates. This will ignore certificate chain verification</li>
<li>Use a local truststore. With this option the certificate chain will be validated against the local truststore file.</li>
</ul>
</p>
</div>
<div class="properties"><h3 id="SMTP_Sampler_parms1">
Parameters
<a class="sectionlink" href="#SMTP_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Server</div><div class="description req-true">Hostname or IP address of the server. See below for use with <span class="code">file</span> protocol.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port to be used to connect to the server.
Defaults are: SMTP=25, SSL=465, StartTLS=587
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connection timeout</div><div class="description req-false">Connection timeout value in milliseconds (socket level). Default is infinite timeout.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Read timeout</div><div class="description req-false">Read timeout value in milliseconds (socket level). Default is infinite timeout.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Address From</div><div class="description req-true">The from address that will appear in the e-mail</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Address To</div><div class="description req-true">The destination e-mail address (multiple values separated by ";")</div><div class="required req-true">Yes, unless CC or BCC is specified</div></div>
<div class="property"><div class="name req-false">Address To CC</div><div class="description req-false">Carbon copy destinations e-mail address (multiple values separated by ";")</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Address To BCC</div><div class="description req-false">Blind carbon copy destinations e-mail address (multiple values separated by ";")</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Address Reply-To</div><div class="description req-false">Alternate Reply-To address (multiple values separated by ";")</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Use Auth</div><div class="description req-true">Indicates if the SMTP server requires user authentication</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Username</div><div class="description req-true">User login name</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Password</div><div class="description req-true">User login password (N.B. this is stored unencrypted in the test plan)</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use no security features</div><div class="description req-true">Indicates that the connection to the SMTP server does not use any security protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use SSL</div><div class="description req-true">Indicates that the connection to the SMTP server must use the SSL protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use StartTLS</div><div class="description req-true">Indicates that the connection to the SMTP server should attempt to start the TLS protocol.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Enforce StartTLS</div><div class="description req-true">If the server does not start the TLS protocol the connection will be terminated.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Trust All Certificates</div><div class="description req-true">When selected it will accept all certificates independent of the CA.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Use local truststore</div><div class="description req-true">When selected it will only accept certificates that are locally trusted.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Local truststore</div><div class="description req-true">Path to file containing the trusted certificates.
Relative paths are resolved against the current directory.
<br>Failing that, against the directory containing the test script (JMX file).
</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Subject</div><div class="description req-true">The e-mail message subject.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Suppress Subject Header</div><div class="description req-true">If selected, the "Subject:" header is omitted from the mail that is sent.
This is different from sending an empty "Subject:" header, though some e-mail clients may display it identically.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Include timestamp in subject</div><div class="description req-true">Includes the System.currentTimemilis() in the subject line.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-false">Add Header</div><div class="description req-false">Additional headers can be defined using this button.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Message</div><div class="description req-true">The message body.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Send plain body (i.e. not multipart/mixed)</div><div class="description req-true">
If selected, then send the body as a plain message, i.e. not multipart/mixed, if possible.
If the message body is empty and there is a single file, then send the file contents as the message body.
Note: If the message body is not empty, and there is at least one attached file, then the body is sent as multipart/mixed.
</div><div class="required req-true">
No
</div></div>
<div class="property"><div class="name req-true">Attach files</div><div class="description req-true">Files to be attached to the message.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Send .eml</div><div class="description req-true">If set, the .eml file will be sent instead of the entries in the Subject, Message, and Attached files</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Calculate message size</div><div class="description req-true">Calculates the message size and stores it in the sample result.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Enable debug logging?</div><div class="description req-true">If set, then the "mail.debug" property is set to "true"</div><div class="required req-true"></div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="OS_Process_Sampler">OS Process Sampler<a class="sectionlink" href="#OS_Process_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/os_process_sampler.png"><img src="../images/screenshots/os_process_sampler.png" width="683" height="582" alt="Screenshot for OS Process Sampler"></a></div>
<div class="description">
<p>
The OS Process Sampler is a sampler that can be used to execute commands on the local machine.<br>
It should allow execution of any command that can be run from the command line.<br>
Validation of the return code can be enabled, and the expected return code can be specified.<br>
</p>
<p>
Note that OS shells generally provide command-line parsing.
This varies between OSes, but generally the shell will split parameters on white-space.
Some shells expand wild-card file names; some don't.
The quoting mechanism also varies between OSes.
The sampler deliberately does not do any parsing or quote handling.
The command and its parameters must be provided in the form expected by the executable.
This means that the sampler settings will not be portable between OSes.
</p>
<p>
Many OSes have some built-in commands which are not provided as separate executables.
For example the Windows DIR command is part of the command interpreter (CMD.EXE).
These built-ins cannot be run as independent programs, but have to be provided as arguments to the appropriate command interpreter.
</p>
<p>
For example, the Windows command-line: <b><span class="code">DIR C:\TEMP</span></b> needs to be specified as follows:
<pre>
command: CMD
Param 1: /C
Param 2: DIR
Param 3: C:\TEMP
</pre>
</p>
</div>
<div class="properties"><h3 id="OS_Process_Sampler_parms1">
Parameters
<a class="sectionlink" href="#OS_Process_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Command</div><div class="description req-true">The program name to execute.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Working directory</div><div class="description req-false">Directory from which command will be executed, defaults to folder referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Command Parameters</div><div class="description req-false">Parameters passed to the program name.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Environment Parameters</div><div class="description req-false">Key/Value pairs added to environment when running command.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Standard input (stdin)</div><div class="description req-false">Name of file from which input is to be taken (STDIN).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Standard output (stdout</div><div class="description req-false">Name of output file for standard output (STDOUT).
If omitted, output is captured and returned as the response data.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Standard error (stderr)</div><div class="description req-false">Name of output file for standard error (STDERR).
If omitted, output is captured and returned as the response data.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Check Return Code</div><div class="description req-false">If checked, sampler will compare return code with Expected Return Code.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Expected Return Code</div><div class="description req-false">Expected return code for System Call, required if "Check Return Code" is checked.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Timeout</div><div class="description req-false">Timeout for command in milliseconds, defaults to 0, which means NO timeout.
If the timeout expires before the command finishes, JMeter will attempt to kill the OS process.
</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="MongoDB_Script">MongoDB Script<a class="sectionlink" href="#MongoDB_Script" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/mongodb-script.png"><img src="../images/screenshots/mongodb-script.png" width="847" height="635" alt="Screenshot for MongoDB Script"></a></div>
<div class="description"><p>This sampler lets you send an Request to a MongoDB.</p>
<p>Before using this you need to set up a
<a href="../usermanual/component_reference.html#MongoDB_Source_Config">MongoDB Source Config</a> Configuration element
</p>
<div class="clear"></div><div class="note">This Element currently uses com.mongodb.DB#eval which takes a global write lock causing a performance impact on the database, see <a href="http://docs.mongodb.org/manual/reference/method/db.eval/">db.eval()</a>.
So it is better to avoid using this element for load testing and use JSR223+Groovy scripting using <a href="../api/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.html">MongoDBHolder</a> instead.
MongoDB Script is more suitable for functionnal testing or test setup (setup/teardown threads)</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="MongoDB_Script_parms1">
Parameters
<a class="sectionlink" href="#MongoDB_Script_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this sampler that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">MongoDB Source</div><div class="description req-true">
Name of the JMeter variable that the MongoDB connection is bound to.
This must agree with the 'MongoDB Source' field of a MongoDB Source Config.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Database Name</div><div class="description req-true">Database Name, will be used in your script
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">
Mongo script as it would be used in MongoDB shell
</div><div class="required req-true">Yes</div></div>
</div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="../usermanual/component_reference.html#MongoDB_Source_Config">MongoDB Source Config</a></li></ul></div>
<div class="clear"></div><div class="note">Ensure Variable Name is unique accross Test Plan.</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="logic_controllers">18.2 Logic Controllers<a class="sectionlink" href="#logic_controllers" title="Link to here">&para;</a></h1>
<div class="description">
<br>Logic Controllers determine the order in which Samplers are processed.
</div>
<div class="component"><h2 id="Simple_Controller">Simple Controller<a class="sectionlink" href="#Simple_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/simple-controller.png"><img src="../images/screenshots/logic-controller/simple-controller.png" width="330" height="77" alt="Screenshot for Simple Controller"></a></div>
<div class="description">
<p>The Simple Logic Controller lets you organize your Samplers and other
Logic Controllers. Unlike other Logic Controllers, this controller provides no functionality beyond that of a
storage device.</p>
</div>
<div class="properties"><h3 id="Simple_Controller_parms1">
Parameters
<a class="sectionlink" href="#Simple_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="example"><div class="title">Using the Simple Controller<a class="sectionlink" href="#simple_controller_example" title="Link to here">&para;</a></div>
<p><a href="../demos/SimpleTestPlan.jmx">Download</a> this example (see Figure 6).
In this example, we created a Test Plan that sends two Ant HTTP requests and two
Log4J HTTP requests. We grouped the Ant and Log4J requests by placing them inside
Simple Logic Controllers. Remember, the Simple Logic Controller has no effect on how JMeter
processes the controller(s) you add to it. So, in this example, JMeter sends the requests in the
following order: Ant Home Page, Ant News Page, Log4J Home Page, Log4J History Page.
Note, the File Reporter
is configured to store the results in a file named "simple-test.dat" in the current directory.</p>
<figure><a href="../images/screenshots/logic-controller/simple-example.png"><img src="../images/screenshots/logic-controller/simple-example.png" width="546" height="222" alt="Figure 6 Simple Controller Example"></a><figcaption>Figure 6 Simple Controller Example</figcaption></figure>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Loop_Controller">Loop Controller<a class="sectionlink" href="#Loop_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/loop-controller.png"><img src="../images/screenshots/logic-controller/loop-controller.png" width="326" height="114" alt="Screenshot for Loop Controller"></a></div>
<div class="description"><p>If you add Generative or Logic Controllers to a Loop Controller, JMeter will
loop through them a certain number of times, in addition to the loop value you
specified for the Thread Group. For example, if you add one HTTP Request to a
Loop Controller with a loop count of two, and configure the Thread Group loop
count to three, JMeter will send a total of 2 * 3 = 6 HTTP Requests.
</p></div>
<div class="properties"><h3 id="Loop_Controller_parms1">
Parameters
<a class="sectionlink" href="#Loop_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Loop Count</div><div class="description req-true">
The number of times the subelements of this controller will be iterated each time
through a test run.
<p><b>Special Case:</b> The Loop Controller embedded in the <a href="test_plan.html#thread_group">Thread Group</a>
element behaves slightly differently. Unless set to forever, it stops the test after
the given number of iterations have been done.</p>
<div class="clear"></div><div class="note">When using a function in this field, be aware it may be evaluated multiple times.
Example using __Random will evaluate it to a different value for each child samplers of Loop Controller and result into unwanted behaviour.</div><div class="clear"></div></div><div class="required req-true">Yes, unless "Forever" is checked</div></div>
</div>
<div class="example"><div class="title">Looping Example<a class="sectionlink" href="#loop_example" title="Link to here">&para;</a></div>
<p><a href="../demos/LoopTestPlan.jmx">Download</a> this example (see Figure 4).
In this example, we created a Test Plan that sends a particular HTTP Request
only once and sends another HTTP Request five times.</p>
<figure><a href="../images/screenshots/logic-controller/loop-example.png"><img src="../images/screenshots/logic-controller/loop-example.png" width="548" height="160" alt="Figure 4 - Loop Controller Example"></a><figcaption>Figure 4 - Loop Controller Example</figcaption></figure>
<p>We configured the Thread Group for a single thread and a loop count value of
one. Instead of letting the Thread Group control the looping, we used a Loop
Controller. You can see that we added one HTTP Request to the Thread Group and
another HTTP Request to a Loop Controller. We configured the Loop Controller
with a loop count value of five.</p>
<p>JMeter will send the requests in the following order: Home Page, News Page,
News Page, News Page, News Page, and News Page. Note, the File Reporter
is configured to store the results in a file named "loop-test.dat" in the current directory.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Once_Only_Controller">Once Only Controller<a class="sectionlink" href="#Once_Only_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/once-only-controller.png"><img src="../images/screenshots/logic-controller/once-only-controller.png" width="330" height="78" alt="Screenshot for Once Only Controller"></a></div>
<div class="description">
<p>The Once Only Logic Controller tells JMeter to process the controller(s) inside it only once per Thread, and pass over any requests under it
during further iterations through the test plan.</p>
<p>The Once Only Controller will now execute always during the first iteration of any looping parent controller.
Thus, if the Once Only Controller is placed under a Loop Controller specified to loop 5 times, then the Once Only Controller will execute only on the first iteration through the Loop Controller
(ie, every 5 times).
Note this means the Once Only Controller will still behave as previously expected if put under a Thread Group (runs only once per test per Thread),
but now the user has more flexibility in the use of the Once Only Controller.</p>
<p>For testing that requires a login, consider placing the login request in this controller since each thread only needs
to login once to establish a session.</p>
</div>
<div class="properties"><h3 id="Once_Only_Controller_parms1">
Parameters
<a class="sectionlink" href="#Once_Only_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="example"><div class="title">Once Only Example<a class="sectionlink" href="#once_only_example" title="Link to here">&para;</a></div>
<p><a href="../demos/OnceOnlyTestPlan.jmx">Download</a> this example (see Figure 5).
In this example, we created a Test Plan that has two threads that send HTTP request.
Each thread sends one request to the Home Page, followed by three requests to the Bug Page.
Although we configured the Thread Group to iterate three times, each JMeter thread only
sends one request to the Home Page because this request lives inside a Once Only Controller.</p>
<figure><a href="../images/screenshots/logic-controller/once-only-example.png"><img src="../images/screenshots/logic-controller/once-only-example.png" width="348" height="131" alt="Figure 5. Once Only Controller Example"></a><figcaption>Figure 5. Once Only Controller Example</figcaption></figure>
<p>Each JMeter thread will send the requests in the following order: Home Page, Bug Page,
Bug Page, Bug Page. Note, the File Reporter is configured to store the results in a file named "loop-test.dat" in the current directory.</p>
</div>
<div class="clear"></div><div class="note">The behaviour of the Once Only controller under anything other than the
Thread Group or a Loop Controller is not currently defined. Odd things may happen.</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Interleave_Controller">Interleave Controller<a class="sectionlink" href="#Interleave_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/interleave-controller.png"><img src="../images/screenshots/logic-controller/interleave-controller.png" width="329" height="104" alt="Screenshot for Interleave Controller"></a></div>
<div class="description"><p>If you add Generative or Logic Controllers to an Interleave Controller, JMeter will alternate among each of the
other controllers for each loop iteration. </p>
</div>
<div class="properties"><h3 id="Interleave_Controller_parms1">
Parameters
<a class="sectionlink" href="#Interleave_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">ignore sub-controller blocks</div><div class="description req-false">If checked, the interleave controller will treat sub-controllers like single request elements and only allow one request per controller at a time. </div><div class="required req-false">No</div></div>
</div>
<div class="example"><div class="title">Simple Interleave Example<a class="sectionlink" href="#simple_interleave_example" title="Link to here">&para;</a></div>
<p><a href="../demos/InterleaveTestPlan.jmx">Download</a> this example (see Figure 1). In this example,
we configured the Thread Group to have two threads and a loop count of five, for a total of ten
requests per thread. See the table below for the sequence JMeter sends the HTTP Requests.</p>
<figure><a href="../images/screenshots/logic-controller/interleave.png"><img src="../images/screenshots/logic-controller/interleave.png" width="336" height="153" alt="Figure 1 - Interleave Controller Example 1"></a><figcaption>Figure 1 - Interleave Controller Example 1</figcaption></figure>
<table>
<tr valign="top"><th>Loop Iteration</th><th>Each JMeter Thread Sends These HTTP Requests</th></tr>
<tr valign="top"><td>1</td><td>News Page</td></tr>
<tr valign="top"><td>1</td><td>Log Page</td></tr>
<tr valign="top"><td>2</td><td>FAQ Page</td></tr>
<tr valign="top"><td>2</td><td>Log Page</td></tr>
<tr valign="top"><td>3</td><td>Gump Page</td></tr>
<tr valign="top"><td>3</td><td>Log Page</td></tr>
<tr valign="top"><td>4</td><td>Because there are no more requests in the controller,<br> JMeter starts over and sends the first HTTP Request, which is the News Page.</td></tr>
<tr valign="top"><td>4</td><td>Log Page</td></tr>
<tr valign="top"><td>5</td><td>FAQ Page</td></tr>
<tr valign="top"><td>5</td><td>Log Page</td></tr>
</table>
</div>
<div class="example"><div class="title">Useful Interleave Example<a class="sectionlink" href="#useful_interleave_example" title="Link to here">&para;</a></div>
<p><a href="../demos/InterleaveTestPlan2.jmx">Download</a> another example (see Figure 2). In this
example, we configured the Thread Group
to have a single thread and a loop count of eight. Notice that the Test Plan has an outer Interleave Controller with
two Interleave Controllers inside of it.</p>
<figure><a href="../images/screenshots/logic-controller/interleave2.png"><img src="../images/screenshots/logic-controller/interleave2.png" width="207" height="249" alt="
Figure 2 - Interleave Controller Example 2
"></a><figcaption>
Figure 2 - Interleave Controller Example 2
</figcaption></figure>
<p>The outer Interleave Controller alternates between the
two inner ones. Then, each inner Interleave Controller alternates between each of the HTTP Requests. Each JMeter
thread will send the requests in the following order: Home Page, Interleaved, Bug Page, Interleaved, CVS Page, Interleaved, and FAQ Page, Interleaved.
Note, the File Reporter is configured to store the results in a file named "interleave-test2.dat" in the current directory.</p>
<figure><a href="../images/screenshots/logic-controller/interleave3.png"><img src="../images/screenshots/logic-controller/interleave3.png" width="204" height="247" alt="
Figure 3 - Interleave Controller Example 3
"></a><figcaption>
Figure 3 - Interleave Controller Example 3
</figcaption></figure>
<p>If the two interleave controllers under the main interleave controller were instead simple controllers, then the order would be: Home Page, CVS Page, Interleaved, Bug Page, FAQ Page, Interleaved. However, if "ignore sub-controller blocks" was checked on the main interleave controller, then the order would be: Home Page, Interleaved, Bug Page, Interleaved, CVS Page, Interleaved, and FAQ Page, Interleaved.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Random_Controller">Random Controller<a class="sectionlink" href="#Random_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/random-controller.png"><img src="../images/screenshots/logic-controller/random-controller.png" width="328" height="100" alt="Screenshot for Random Controller"></a></div>
<div class="description">
<p>The Random Logic Controller acts similarly to the Interleave Controller, except that
instead of going in order through its sub-controllers and samplers, it picks one
at random at each pass.</p>
<div class="clear"></div><div class="note">Interactions between multiple controllers can yield complex behavior.
This is particularly true of the Random Controller. Experiment before you assume
what results any given interaction will give</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="Random_Controller_parms1">
Parameters
<a class="sectionlink" href="#Random_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Random_Order_Controller">Random Order Controller<a class="sectionlink" href="#Random_Order_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/randomordercontroller.png"><img src="../images/screenshots/randomordercontroller.png" width="328" height="76" alt="Screenshot for Random Order Controller"></a></div>
<div class="description">
<p>The Random Order Controller is much like a Simple Controller in that it will execute each child
element at most once, but the order of execution of the nodes will be random.</p>
</div>
<div class="properties"><h3 id="Random_Order_Controller_parms1">
Parameters
<a class="sectionlink" href="#Random_Order_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Throughput_Controller">Throughput Controller<a class="sectionlink" href="#Throughput_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/throughput_controller.png"><img src="../images/screenshots/throughput_controller.png" width="329" height="167" alt="Screenshot for Throughput Controller"></a></div>
<div class="description">
<p>
<b>This controller is badly named, as it does not control throughput.</b>
Please refer to the <a href="../usermanual/component_reference.html#Constant_Throughput_Timer">Constant Throughput Timer</a> for an element that can be used to adjust the throughput.
</p>
<p>The Throughput Controller allows the user to control how often it is executed. There are two modes - percent execution and total executions. Percent executions causes the controller to execute a certain percentage of the iterations through the test plan. Total
executions causes the controller to stop executing after a certain number of executions have occurred. Like the Once Only Controller, this
setting is reset when a parent Loop Controller restarts.
</p>
</div>
<div class="clear"></div><div class="note">The Throughput Controller can yield very complex behavior when combined with other controllers - in particular with interleave or random controllers as parents (also very useful).</div><div class="clear"></div>
<div class="properties"><h3 id="Throughput_Controller_parms1">
Parameters
<a class="sectionlink" href="#Throughput_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Execution Style</div><div class="description req-true">Whether the controller will run in percent executions or total executions mode.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Throughput</div><div class="description req-true">A number. for percent execution mode, a number from 0-100 that indicates the percentage of times the controller will execute. "50" means the controller will execute during half the iterations throught the test plan. for total execution mode, the number indicates the total number of times the controller will execute.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Per User</div><div class="description req-false">If checked, per user will cause the controller to calculate whether it should execute on a per user (per thread) basis. if unchecked, then the calculation will be global for all users. for example, if using total execution mode, and uncheck "per user", then the number given for throughput will be the total number of executions made. if "per user" is checked, then the total number of executions would be the number of users times the number given for throughput.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Runtime_Controller">Runtime Controller<a class="sectionlink" href="#Runtime_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/runtimecontroller.png"><img src="../images/screenshots/runtimecontroller.png" width="328" height="100" alt="Screenshot for Runtime Controller"></a></div>
<div class="description">
<p>The Runtime Controller controls how long its children are allowed to run.
</p>
</div>
<div class="properties"><h3 id="Runtime_Controller_parms1">
Parameters
<a class="sectionlink" href="#Runtime_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this controller that is shown in the tree, and used to name the transaction.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Runtime (seconds)</div><div class="description req-true">Desired runtime in seconds</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="If_Controller">If Controller<a class="sectionlink" href="#If_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ifcontroller.png"><img src="../images/screenshots/ifcontroller.png" width="497" height="131" alt="Screenshot for If Controller"></a></div>
<div class="description">
<p>The If Controller allows the user to control whether the test elements below it (its children) are run or not.</p>
<p>
Prior to JMeter 2.3RC3, the condition was evaluated for every runnable element contained in the controller.
This sometimes caused unexpected behaviour, so 2.3RC3 was changed to evaluate the condition only once on initial entry.
However, the original behaviour is also useful, so versions of JMeter after 2.3RC4 have an additional
option to select the original behaviour.
</p>
<p>
Versions of JMeter after 2.3.2 allow the script to be processed as a variable expression, rather than requiring Javascript.
It was always possible to use functions and variables in the Javascript condition, so long as they evaluated to "true" or "false";
now this can be done without the overhead of using Javascript as well. For example, previously one could use the condition:
<span class="code">${__jexl(${VAR} == 23)}</span> and this would be evaluated as true/false, the result would then be passed to Javascript
which would then return true/false. If the Variable Expression option is selected, then the expression is evaluated
and compared with "true", without needing to use Javascript.
Also, variable expressions can return any value, whereas the
Javascript condition must return "true"/"false" or an error is logged.
</p>
<div class="clear"></div><div class="note">
No variables are made available to the script when the condition is interpreted as Javascript.
If you need access to such variables, then select "Interpret Condition as Variable Expression?" and use
a __javaScript() function call. You can then use the objects "vars", "log", "ctx" etc. in the script.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
To test if a variable is undefined (or null) do the following, suppose var is named myVar, expression will be:
<br>
<span class="code">"${myVar}" == "\${myVar}"</span>
<br>
Or use:
<br>
<span class="code">"${myVar}" != "\${myVar}"</span>
<br>
to test if a variable is defined and is not null.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="If_Controller_parms1">
Parameters
<a class="sectionlink" href="#If_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Condition (default Javascript)</div><div class="description req-true">By default the condition is interpreted as <b>Javascript</b> code that returns "true" or "false",
but this can be overriden (see below)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Interpret Condition as Variable Expression?</div><div class="description req-true">If this is selected, then the condition must be an expression that evaluates to "true" (case is ignored).
For example, <span class="code">${FOUND}</span> or <span class="code">${__jexl(${VAR} &gt; 100)}</span>.
Unlike the Javascript case, the condition is only checked to see if it matches "true" (case is ignored).
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Evaluate for all children</div><div class="description req-true">
Should condition be evaluated for all children?
If not checked, then the condition is only evaluated on entry.
</div><div class="required req-true">Yes</div></div>
</div>
<p><b>Examples (Javascript):</b>
<ul>
<li>${COUNT} &lt; 10</li>
<li>"${VAR}" == "abcd"</li>
<li>${JMeterThread.last_sample_ok} (check if last sample succeeded)</li>
</ul>
If there is an error interpreting the code, the condition is assumed to be false, and a message is logged in jmeter.log.
</p>
<p><b>Examples (Variable Expression):</b>
<ul>
<li>${__jexl(${COUNT} &lt; 10)}</li>
<li>${RESULT}</li>
</ul>
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="While_Controller">While Controller<a class="sectionlink" href="#While_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/whilecontroller.png"><img src="../images/screenshots/whilecontroller.png" width="362" height="102" alt="Screenshot for While Controller"></a></div>
<div class="description">
<p>
The While Controller runs its children until the condition is "false".
</p>
<p>Possible condition values:</p>
<ul>
<li>blank - exit loop when last sample in loop fails</li>
<li>LAST - exit loop when last sample in loop fails.
If the last sample just before the loop failed, don't enter loop.</li>
<li>Otherwise - exit (or don't enter) the loop when the condition is equal to the string "false"</li>
</ul>
<div class="clear"></div><div class="note">
The condition can be any variable or function that eventually evaluates to the string "false".
This allows the use of JavaScript, BeanShell, properties or variables as needed.
</div><div class="clear"></div>
<br>
<div class="clear"></div><div class="note">
Note that the is evaluated twice, once before starting sampling children and once at end of children sampling, so putting
non idempotent functions in Condition (like __counter) can introduce issues.
</div><div class="clear"></div>
<br>
For example:
<ul>
<li>${VAR} - where VAR is set to false by some other test element</li>
<li>${__javaScript(${C}==10)}</li>
<li>${__javaScript("${VAR2}"=="abcd")}</li>
<li>${_P(property)} - where property is set to "false" somewhere else</li>
</ul>
</div>
<div class="properties"><h3 id="While_Controller_parms1">
Parameters
<a class="sectionlink" href="#While_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this controller that is shown in the tree, and used to name the transaction.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Condition</div><div class="description req-true">blank, LAST, or variable/function</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Switch_Controller">Switch Controller<a class="sectionlink" href="#Switch_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/switchcontroller.png"><img src="../images/screenshots/switchcontroller.png" width="361" height="106" alt="Screenshot for Switch Controller"></a></div>
<div class="description">
<p>
The Switch Controller acts like the <a href="../usermanual/component_reference.html#Interleave_Controller">Interleave Controller</a>
in that it runs one of the subordinate elements on each iteration, but rather than
run them in sequence, the controller runs the element defined by the switch value.
</p>
<p>
Note: In versions of JMeter after 2.3.1, the switch value can also be a name.
</p>
<p>If the switch value is out of range, it will run the zeroth element,
which therefore acts as the default for the numeric case.
It also runs the zeroth element if the value is the empty string.</p>
<p>
If the value is non-numeric (and non-empty), then the Switch Controller looks for the
element with the same name (case is significant).
If none of the names match, then the element named "default" (case not significant) is selected.
If there is no default, then no element is selected, and the controller will not run anything.
</p>
</div>
<div class="properties"><h3 id="Switch_Controller_parms1">
Parameters
<a class="sectionlink" href="#Switch_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this controller that is shown in the tree, and used to name the transaction.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Switch Value</div><div class="description req-true">The number (or name) of the subordinate element to be invoked. Elements are numbered from 0.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="ForEach_Controller">ForEach Controller<a class="sectionlink" href="#ForEach_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/foreach-controller.png"><img src="../images/screenshots/logic-controller/foreach-controller.png" width="342" height="193" alt="Screenshot for ForEach Controller"></a></div>
<div class="description"><p>A ForEach controller loops through the values of a set of related variables.
When you add samplers (or controllers) to a ForEach controller, every sample sample (or controller)
is executed one or more times, where during every loop the variable has a new value.
The input should consist of several variables, each extended with an underscore and a number.
Each such variable must have a value.
So for example when the input variable has the name inputVar, the following variables should have been defined:
<ul>
<li>inputVar_1 = wendy</li>
<li>inputVar_2 = charles</li>
<li>inputVar_3 = peter</li>
<li>inputVar_4 = john</li>
</ul>
<p>Note: the "_" separator is now optional.</p>
When the return variable is given as "returnVar", the collection of samplers and controllers under the ForEach controller will be executed 4 consecutive times,
with the return variable having the respective above values, which can then be used in the samplers.
</p>
<p>
It is especially suited for running with the regular expression post-processor.
This can "create" the necessary input variables out of the result data of a previous request.
By omitting the "_" separator, the ForEach Controller can be used to loop through the groups by using
the input variable refName_g, and can also loop through all the groups in all the matches
by using an input variable of the form refName_${C}_g, where C is a counter variable.
</p>
<div class="clear"></div><div class="note">The ForEach Controller does not run any samples if inputVar_1 is null.
This would be the case if the Regular Expression returned no matches.</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="ForEach_Controller_parms1">
Parameters
<a class="sectionlink" href="#ForEach_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Input variable prefix</div><div class="description req-true">Prefix for the variable names to be used as input.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Start index for loop</div><div class="description req-false">Start index (exclusive) for loop over variables (first element is at start index + 1)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">End index for loop</div><div class="description req-false">End index (inclusive) for loop over variables</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Output variable</div><div class="description req-true">
The name of the variable which can be used in the loop for replacement in the samplers</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use Separator</div><div class="description req-true">If not checked, the "_" separator is omitted.</div><div class="required req-true">Yes</div></div>
</div>
<div class="example"><div class="title">ForEach Example<a class="sectionlink" href="#foreach_example" title="Link to here">&para;</a></div>
<p><a href="../demos/forEachTestPlan.jmx">Download</a> this example (see Figure 7).
In this example, we created a Test Plan that sends a particular HTTP Request
only once and sends another HTTP Request to every link that can be found on the page.</p>
<figure><a href="../images/screenshots/logic-controller/foreach-example.png"><img src="../images/screenshots/logic-controller/foreach-example.png" width="246" height="154" alt="Figure 7 - ForEach Controller Example"></a><figcaption>Figure 7 - ForEach Controller Example</figcaption></figure>
<p>We configured the Thread Group for a single thread and a loop count value of
one. You can see that we added one HTTP Request to the Thread Group and
another HTTP Request to the ForEach Controller.</p>
<p>After the first HTTP request, a regular expression extractor is added, which extracts all the html links
out of the return page and puts them in the inputVar variable</p>
<p>In the ForEach loop, a HTTP sampler is added which requests all the links that were extracted from the first returned HTML page.
</p></div>
<div class="example"><div class="title">ForEach Example<a class="sectionlink" href="#foreach_example2" title="Link to here">&para;</a></div>
<p>Here is <a href="../demos/ForEachTest2.jmx">another example</a> you can download.
This has two Regular Expressions and ForEach Controllers.
The first RE matches, but the second does not match,
so no samples are run by the second ForEach Controller</p>
<figure><a href="../images/screenshots/logic-controller/foreach-example2.png"><img src="../images/screenshots/logic-controller/foreach-example2.png" width="198" height="253" alt="Figure 8 - ForEach Controller Example 2"></a><figcaption>Figure 8 - ForEach Controller Example 2</figcaption></figure>
<p>The Thread Group has a single thread and a loop count of two.
</p><p>
Sample 1 uses the JavaTest Sampler to return the string "a b c d".
</p><p>The Regex Extractor uses the expression <b>(\w)\s</b> which matches a letter followed by a space,
and returns the letter (not the space). Any matches are prefixed with the string "inputVar".
</p><p>The ForEach Controller extracts all variables with the prefix "inputVar_", and executes its
sample, passing the value in the variable "returnVar". In this case it will set the variable to the values "a" "b" and "c" in turn.
</p><p>The For 1 Sampler is another Java Sampler which uses the return variable "returnVar" as part of the sample Label
and as the sampler Data.
</p><p>Sample 2, Regex 2 and For 2 are almost identical, except that the Regex has been changed to "(\w)\sx",
which clearly won't match. Thus the For 2 Sampler will not be run.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Module_Controller">Module Controller<a class="sectionlink" href="#Module_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/module_controller.png"><img src="../images/screenshots/module_controller.png" width="504" height="217" alt="Screenshot for Module Controller"></a></div>
<div class="description">
<p>
The Module Controller provides a mechanism for substituting test plan fragments into the current test plan at run-time.
</p>
<p>
A test plan fragment consists of a Controller and all the test elements (samplers etc) contained in it.
The fragment can be located in any Thread Group, or on the <a href="../usermanual/component_reference.html#WorkBench">WorkBench</a>.
If the fragment is located in a Thread Group, then its Controller can be disabled to prevent the fragment being run
except by the Module Controller.
Or you can store the fragments in a dummy Thread Group, and disable the entire Thread Group.
</p>
<p>
There can be multiple fragments, each with a different series of
samplers under them. The module controller can then be used to easily switch between these multiple test cases simply by choosing
the appropriate controller in its drop down box. This provides convenience for running many alternate test plans quickly and easily.
</p>
<p>
A fragment name is made up of the Controller name and all its parent names.
For example:
<pre>
Test Plan / Protocol: JDBC / Control / Interleave Controller (Module1)
</pre>
Any <b>fragments used by the Module Controller must have a unique name</b>,
as the name is used to find the target controller when a test plan is reloaded.
For this reason it is best to ensure that the Controller name is changed from the default
- as shown in the example above -
otherwise a duplicate may be accidentally created when new elements are added to the test plan.
</p>
</div>
<div class="clear"></div><div class="note">The Module Controller should not be used with remote testing or non-gui testing in conjunction with Workbench components since the Workbench test elements are not part of test plan .jmx files. Any such test will fail.</div><div class="clear"></div>
<div class="properties"><h3 id="Module_Controller_parms1">
Parameters
<a class="sectionlink" href="#Module_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Module to Run</div><div class="description req-true">The module controller provides a list of all controllers loaded into the gui. Select
the one you want to substitute in at runtime.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Include_Controller">Include Controller<a class="sectionlink" href="#Include_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/includecontroller.png"><img src="../images/screenshots/includecontroller.png" width="417" height="130" alt="Screenshot for Include Controller"></a></div>
<div class="description">
<p>
The include controller is designed to use an external jmx file. To use it, create a Test Fragment
underneath the Test Plan and add any desired samplers, controllers etc. below it.
Then save the Test Plan. The file is now ready to be included as part of other Test Plans.
</p>
<p>
For convenience, a Thread Group can also be added in the external JMX file for debugging purposes.
A Module Controller can be used to reference the Test Fragment. The Thread Group will be ignored during the
include process.
</p>
<p>
If the test uses a Cookie Manager or User Defined Variables, these should be placed in the top-level
test plan, not the included file, otherwise they are not guaranteed to work.
</p>
<div class="clear"></div><div class="note">
This element does not support variables/functions in the filename field.<br>
However, if the property <b>includecontroller.prefix</b> is defined,
the contents are used to prefix the pathname.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
When using IncludeController and including the same JMX file, ensure you name the IncludeController differently to avoid facing known issue <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=50898">
Bug
50898</a>.
</div><div class="clear"></div>
<p>
If the file cannot be found at the location given by prefix+filename, then the controller
attempts to open the fileName relative to the JMX launch directory (versions of JMeter after 2.3.4).
</p>
</div>
<div class="properties"><h3 id="Include_Controller_parms1">
Parameters
<a class="sectionlink" href="#Include_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Filename</div><div class="description req-true">The file to include.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Transaction_Controller">Transaction Controller<a class="sectionlink" href="#Transaction_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/transactioncontroller.png"><img src="../images/screenshots/transactioncontroller.png" width="622" height="140" alt="Screenshot for Transaction Controller"></a></div>
<div class="description">
<p>
The Transaction Controller generates an additional
sample which measures the overall time taken to perform the nested test elements.
</p>
<div class="clear"></div><div class="note">
Note: when the check box "Include duration of timer and pre-post processors in generated sample" is checked,
the time includes all processing within the controller scope, not just the samples.
</div><div class="clear"></div>
<p>
For JMeter versions after 2.3, there are two modes of operation
<ul>
<li>additional sample is added after the nested samples</li>
<li>additional sample is added as a parent of the nested samples</li>
</ul>
</p>
<p>
The generated sample time includes all the times for the nested samplers, <b>and any timers etc.</b>
Depending on the clock resolution, it may be slightly longer than the sum of the individual samplers plus timers.
The clock might tick after the controller recorded the start time but before the first sample starts.
Similarly at the end.
</p>
<p>The generated sample is only regarded as successful if all its sub-samples are successful.</p>
<p>
In parent mode, the individual samples can still be seen in the Tree View Listener,
but no longer appear as separate entries in other Listeners.
Also, the sub-samples do not appear in CSV log files, but they can be saved to XML files.
</p>
<div class="clear"></div><div class="note">
In parent mode, Assertions (etc) can be added to the Transaction Controller.
However by default they will be applied to both the individual samples and the overall transaction sample.
To limit the scope of the Assertions, use a Simple Controller to contain the samples, and add the Assertions
to the Simple Controller.
Parent mode controllers do not currently properly support nested transaction controllers of either type.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="Transaction_Controller_parms1">
Parameters
<a class="sectionlink" href="#Transaction_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this controller that is shown in the tree, and used to name the transaction.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Generate Parent Sample</div><div class="description req-true">
If checked, then the sample is generated as a parent of the other samples,
otherwise the sample is generated as an independent sample.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Include duration of timer and pre-post processors in generated sample</div><div class="description req-true">
Whether to include timer, pre- and post-processing delays in the generated sample.
Default is false (since JMeter 2.11, in previous versions the default value is true).
</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Recording_Controller">Recording Controller<a class="sectionlink" href="#Recording_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/recording-controller.png"><img src="../images/screenshots/logic-controller/recording-controller.png" width="420" height="79" alt="Screenshot for Recording Controller"></a></div>
<div class="description">
<p>The Recording Controller is a place holder indicating where the proxy server should
record samples to. During test run, it has no effect, similar to the Simple Controller. But during
recording using the <a href="../usermanual/component_reference.html#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder</a>, all recorded samples will by default
be saved under the Recording Controller.</p>
</div>
<div class="properties"><h3 id="Recording_Controller_parms1">
Parameters
<a class="sectionlink" href="#Recording_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this controller that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Critical_Section_Controller">Critical Section Controller<a class="sectionlink" href="#Critical_Section_Controller" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/logic-controller/critical-section-controller.png"><img src="../images/screenshots/logic-controller/critical-section-controller.png" width="469" height="129" alt="Screenshot for Critical Section Controller"></a></div>
<div class="description">
<p>The Critical Section Controller ensures that its children elements (samplers/controllers, etc) will be executed
by only one thread as a named lock will be taken before executing children of controller.</p>
</div>
<p>
The figure below shows an example of using Critical Section Controller, in the figure below 2 Critical Section Controllers ensure
that:
<ul>
<li>DS2-${__threadNum} is executed only by one thread at a time</li>
<li>DS4-${__threadNum} is executed only by one thread at a time</li>
</ul>
<figure><a href="../images/screenshots/logic-controller/critical-section-controller-tp.png"><img src="../images/screenshots/logic-controller/critical-section-controller-tp.png" width="248" height="241" alt="Test Plan using Critical Section Controller"></a><figcaption>Test Plan using Critical Section Controller</figcaption></figure>
</p>
<div class="properties"><h3 id="Critical_Section_Controller_parms1">
Parameters
<a class="sectionlink" href="#Critical_Section_Controller_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Lock Name</div><div class="description req-true">Lock that will be taken by controller, ensure you use different lock names for unrelated sections</div><div class="required req-true">Yes</div></div>
</div>
<div class="clear"></div><div class="note">
Critical Section Controller takes locks only within one JVM, so if using Distributed testing ensure your use case does not rely on all threads of all JVMs blocking.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="listeners">18.3 Listeners<a class="sectionlink" href="#listeners" title="Link to here">&para;</a></h1>
<div class="description">
<br>
Most of the listeners perform several roles in addition to "listening"
to the test results.
They also provide means to view, save, and read saved test results.
<p>Note that Listeners are processed at the end of the scope in which they are found.</p>
<p>
The saving and reading of test results is generic. The various
listeners have a panel whereby one can specify the file to
which the results will be written (or read from).
By default, the results are stored as XML
files, typically with a ".jtl" extension.
Storing as CSV is the most efficient option, but is less detailed than XML (the other available option).
</p>
<p>
<b>Listeners do <i>not</i> process sample data in non-GUI mode, but the raw data will be saved if an output
file has been configured.</b>
In order to analyse the data generated by a non-GUI test run, you need to load the file into the appropriate
Listener.
</p>
<div class="clear"></div><div class="note">
To read existing results and display them, use the file panel Browse button to open the file.
</div><div class="clear"></div>
<p>
Versions of JMeter up to 2.3.2 <b>used to clear any current data</b> before loading the new file.<br>
This is no longer done, thus <b>allowing files to be merged</b>.
If the previous behaviour is required,
use the menu item Run/Clear (Ctrl+Shift+E) or Run/Clear All (Ctrl+E) before loading the file.
</p>
<p>Results can be read from XML or CSV format files.
When reading from CSV results files, the header (if present) is used to determine which fields are present.
<b>In order to interpret a header-less CSV file correctly, the appropriate properties must be set in jmeter.properties.</b>
</p>
<div class="clear"></div><div class="note">
The file name can contain function and/or variable references.
However variable references do not work in client-server mode (functions work OK).
</div><div class="clear"></div>
<p><b>Listeners can use a lot of memory if there are a lot of samples.</b>
Most of the listeners currently keep a copy of every sample in their scope, apart from:
</p>
<ul>
<li>Simple Data Writer</li>
<li>BeanShell/BSF Listener</li>
<li>Mailer Visualizer</li>
<li>Monitor Results</li>
<li>Summary Report</li>
</ul>
<p>
The following Listeners no longer need to keep copies of every single sample.
Instead, samples with the same elapsed time are aggregated.
Less memory is now needed, especially if most samples only take a second or two at most.
</p>
<ul>
<li>Aggregate Report</li>
<li>Aggregate Graph</li>
<li>Distribution Graph</li>
</ul>
<p>To minimise the amount of memory needed, use the Simple Data Writer, and use the CSV format.</p>
<p>
<div class="clear"></div><div class="note">
Versions of JMeter after 2.3.1 allow JMeter variables to be saved to the output files.
This can only be specified using a property.
See the <a href="listeners.html#sample_variables">Listener Sample Variables</a> for details
</div><div class="clear"></div>
For full details on setting up the default items to be saved
see the <a href="listeners.html#defaults">Listener Default Configuration</a> documentation.
For details of the contents of the output files,
see the <a href="listeners.html#csvlogformat">CSV log</a> format or
the <a href="listeners.html#xmlformat2.1">XML log</a> format.
</p>
<div class="clear"></div><div class="note">The entries in jmeter.properties are used to define the defaults;
these can be overriden for individual listeners by using the Configure button,
as shown below.
The settings in jmeter.properties also apply to the listener that is added
by using the -l command-line flag.
</div><div class="clear"></div>
<p>
The figure below shows an example of the result file configuration panel
<figure><a href="../images/screenshots/simpledatawriter.png"><img src="../images/screenshots/simpledatawriter.png" width="741" height="141" alt="Result file configuration panel"></a><figcaption>Result file configuration panel</figcaption></figure>
</p>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Filename</div><div class="description req-false">Name of the file containing sample results.
The file name can be specified using either a relative or an absolute path name.
Relative paths are resolved relative to the current working directory (which defaults to the bin/ directory).
Versions of JMeter after 2.4 also support paths relative to the directory containing the current test plan (JMX file).
If the path name begins with "~/" (or whatever is in the jmeter.save.saveservice.base_prefix JMeter property),
then the path is assumed to be relative to the JMX file location.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Browse...</div><div class="description req-false">File Browse Button</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Errors</div><div class="description req-false">Select this to write/read only results with errors</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Successes</div><div class="description req-false">Select this to write/read only results without errors.
If neither Errors nor Successes is selected, then all results are processed.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Configure</div><div class="description req-false">Configure Button, see below</div><div class="required req-false">No</div></div>
</div>
</div>
<div class="component"><h2 id="Sample_Result_Save_Configuration">Sample Result Save Configuration<a class="sectionlink" href="#Sample_Result_Save_Configuration" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/sample_result_config.png"><img src="../images/screenshots/sample_result_config.png" width="629" height="300" alt="Screenshot for Sample Result Save Configuration"></a></div>
<div class="description">
<p>
Listeners can be configured to save different items to the result log files (JTL) by using the Config popup as shown below.
The defaults are defined as described in the <a href="listeners.html#defaults">Listener Default Configuration</a> documentation.
Items with (CSV) after the name only apply to the CSV format; items with (XML) only apply to XML format.
CSV format cannot currently be used to save any items that include line-breaks.
</p>
<p>
Note that cookies, method and the query string are saved as part of the "Sampler Data" option.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Graph_Results">Graph Results<a class="sectionlink" href="#Graph_Results" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/graph_results.png"><img src="../images/screenshots/graph_results.png" width="915" height="686" alt="Screenshot for Graph Results"></a></div>
<div class="description">
<div class="clear"></div><div class="note">
Graph Results MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
<p>The Graph Results listener generates a simple graph that plots all sample times. Along
the bottom of the graph, the current sample (black), the current average of all samples(blue), the
current standard deviation (red), and the current throughput rate (green) are displayed in milliseconds.</p>
<p>The throughput number represents the actual number of requests/minute the server handled. This calculation
includes any delays you added to your test and JMeter's own internal processing time. The advantage
of doing the calculation like this is that this number represents something
real - your server in fact handled that many requests per minute, and you can increase the number of threads
and/or decrease the delays to discover your server's maximum throughput. Whereas if you made calculations
that factored out delays and JMeter's processing, it would be unclear what you could conclude from that
number.</p></div>
<p>The following table briefly describes the items on the graph.
Further details on the precise meaning of the statistical terms can be found on the web
- e.g. Wikipedia - or by consulting a book on statistics.
</p>
<ul>
<li>Data - plot the actual data values</li>
<li>Average - plot the Average</li>
<li>Median - plot the <a href="glossary.html#Median">Median</a> (midway value)</li>
<li>Deviation - plot the <a href="glossary.html#StandardDeviation">Standard Deviation</a> (a measure of the variation)</li>
<li>Throughput - plot the number of samples per unit of time</li>
</ul>
<p>The individual figures at the bottom of the display are the current values.
"Latest Sample" is the current elapsed sample time, shown on the graph as "Data".</p>
<p>The value displayed on the top left of graph is the max of 90th percentile of response time.</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Spline_Visualizer">Spline Visualizer<a class="sectionlink" href="#Spline_Visualizer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/spline_visualizer.png"><img src="../images/screenshots/spline_visualizer.png" width="737" height="489" alt="Screenshot for Spline Visualizer"></a></div>
<div class="clear"></div><div class="note">
Spline Visualizer MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
<div class="description">
<p>
The Spline Visualizer provides a view of all sample times from the start
of the test till the end, regardless of how many samples have been taken. The spline
has 10 points, each representing 10% of the samples, and connected using spline
logic to show a single continuous line.
</p>
<p>
The graph is automatically scaled to fit within the window.
This needs to be borne in mind when comparing graphs.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Assertion_Results">Assertion Results<a class="sectionlink" href="#Assertion_Results" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion_results.png"><img src="../images/screenshots/assertion_results.png" width="954" height="365" alt="Screenshot for Assertion Results"></a></div>
<div class="description">
<div class="clear"></div><div class="note">
Assertion Results MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
<p>The Assertion Results visualizer shows the Label of each sample taken.
It also reports failures of any <a href="test_plan.html#assertions">Assertions</a> that
are part of the test plan.</p></div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="../usermanual/component_reference.html#Response_Assertion">Response Assertion</a></li></ul></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="View_Results_Tree">View Results Tree<a class="sectionlink" href="#View_Results_Tree" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/view_results_tree.png"><img src="../images/screenshots/view_results_tree.png" width="901" height="646" alt="Screenshot for View Results Tree"></a></div>
<div class="description">
<div class="clear"></div><div class="note">
View Results Tree MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
The View Results Tree shows a tree of all sample responses, allowing you to view the
response for any sample. In addition to showing the response, you can see the time it took to get
this response, and some response codes.
Note that the Request panel only shows the headers added by JMeter.
It does not show any headers (such as Host) that may be added by the HTTP protocol implementation.
<p>
There are several ways to view the response, selectable by a drop-down box at the bottom of the left hand panel.</p>
<table>
<tr><th><b>Renderer</b></th><th><b>Description</b></th></tr>
<tr><td><b>CSS/JQuery Tester</b></td>
<td>The <i>CSS/JQuery Tester</i> only works for text responses. It shows the plain text in the upper panel.
The "Test" button allows the user to apply the CSS/JQuery to the upper panel and the results
will be displayed in the lower panel.<br>
The engine of CSS/JQuery expression can be JSoup or Jodd, syntax of these 2 implementation differs slightly.<br>
For example, the Selector <b>a[class=sectionlink]</b> with attribute <b>href</b> applied to the current JMeter functions page gives the following output:
<br>
<pre>
Match count: 74
Match[1]=#functions
Match[2]=#what_can_do
Match[3]=#where
Match[4]=#how
Match[5]=#function_helper
Match[6]=#functions
Match[7]=#__regexFunction
Match[8]=#__regexFunction_parms
Match[9]=#__counter
... and so on ...
</pre>
<br></td></tr>
<tr><td><b>Document</b></td>
<td>The <i>Document view</i> will show the extract text from various type of documents like Microsoft Office
(Word, Excel, PowerPoint 97-2003, 2007-2010 (openxml), Apache OpenOffice (writer, calc, impress), HTML,
gzip, jar/zip files (list of content), and some meta-data on "multimedia" files like mp3, mp4, flv, etc. The complete list of
support format is available on <a href="http://tika.apache.org/1.2/formats.html">Apache Tika format page.</a>
<br><br>
<b>Note:</b> A requirement to the <i>Document view</i> is to download the <a href="http://tika.apache.org/download.html">
Apache Tika binary package</a> (tika-app-x.x.jar) and put this in JMETER_HOME/lib directory.
<br><br>
If the document is larger than 10 MB, then it won't be displayed.
To change this limit, set the JMeter property <b>document.max_size</b> (unit is byte) or set to 0 to remove the limit.
<br></td></tr>
<tr><td><b>HTML</b></td>
<td>The <i>HTML view</i> attempts to render the response as
HTML. The rendered HTML is likely to compare poorly to the view one
would get in any web browser; however, it does provide a quick
approximation that is helpful for initial result evaluation.<br>
Images, style-sheets, etc. aren't downloaded.
<br></td></tr>
<tr><td><b>HTML (download resources)</b></td>
<td>If the <i>HTML (download resources) view</i> option is selected, the renderer
may download images, style-sheets, etc. referenced by the HTML code.
<br></td></tr>
<tr><td><b>JSON</b></td>
<td>The <i>JSON view</i> will show the response in tree style (also handles JSON embedded in JavaScript).
<br></td></tr>
<tr><td><b>Regexp Tester</b></td>
<td>The <i>Regexp Tester view</i> only works for text responses. It shows the plain text in the upper panel.
The "Test" button allows the user to apply the Regular Expression to the upper panel and the results
will be displayed in the lower panel.<br>
The engine of regular expression is the same that the Regular Expression Extractor.<br>
For example, the RE <b>(JMeter\w*).*</b> applied to the current JMeter home page gives the following output:
<br>
<pre>
Match count: 26
Match[1][0]=JMeter - Apache JMeter&lt;/title&gt;
Match[1][1]=JMeter
Match[2][0]=JMeter" title="JMeter" border="0"/&gt;&lt;/a&gt;
Match[2][1]=JMeter
Match[3][0]=JMeterCommitters"&gt;Contributors&lt;/a&gt;
Match[3][1]=JMeterCommitters
... and so on ...
</pre>
<br>
The first number in [] is the match number; the second number is the group.
Group [0] is whatever matched the whole RE.
Group [1] is whatever matched the 1st group, i.e. (JMeter\w*) in this case.
See Figure 9b (below).
<br></td></tr>
<tr><td><b>Text</b></td>
<td>
The default <i>Text view</i> shows all of the text contained in the response.
Note that this will only work if the response content-type is considered to be text.
If the content-type begins with any of the following, it is considered as binary,
otherwise it is considered to be text.
<pre>
image/
audio/
video/
</pre>
<br></td></tr>
<tr><td><b>XML</b></td>
<td>The <i>XML view</i> will show response in tree style.
Any DTD nodes or Prolog nodes will not show up in tree; however, response may contain those nodes.
<br></td></tr>
<tr><td><b>XPath Tester</b></td>
<td>The <i>XPath Tester</i> only works for text responses. It shows the plain text in the upper panel.
The "Test" button allows the user to apply the XPath query to the upper panel and the results
will be displayed in the lower panel.<br>
</td></tr>
</table>
<p><i>Scroll automatically?</i> option permit to have last node display in tree selection</p>
<p>
With <i>Search</i> option, most of the views also allow the displayed data to be searched; the result of the search will be high-lighted
in the display above. For example the Control panel screenshot below shows one result of searching for "Java".
Note that the search operates on the visible text, so you may get different results when searching
the Text and HTML views.
<br>Note: The regular expression uses the Java engine (not ORO engine like the Regular Expression Extractor or Regexp Tester view).
</p>
<p>
If there is no content-type provided, then the content
will not be displayed in the any of the Response Data panels.
You can use <a href="../usermanual/component_reference.html#Save_Responses_to_a_file">Save Responses to a file</a> to save the data in this case.
Note that the response data will still be available in the sample result,
so can still be accessed using Post-Processors.
</p>
<p>If the response data is larger than 200K, then it won't be displayed.
To change this limit, set the JMeter property <b>view.results.tree.max_size</b>.
You can also use save the entire response to a file using
<a href="../usermanual/component_reference.html#Save_Responses_to_a_file">Save Responses to a file</a>.
</p>
<p>
Additional renderers can be created.
The class must implement the interface <span class="code">org.apache.jmeter.visualizers.ResultRenderer</span>
and/or extend the abstract class <span class="code">org.apache.jmeter.visualizers.SamplerResultTab</span>, and the
compiled code must be available to JMeter (e.g. by adding it to the lib/ext directory).
</p>
</div>
<p>
The Control Panel (above) shows an example of an HTML display.<br>
Figure 9 (below) shows an example of an XML display.<br>
Figure 9a (below) shows an example of an Regexp tester display.<br>
Figure 9b (below) shows an example of an Document display.<br>
<div align="center">
<figure><a href="../images/screenshots/view_results_tree_xml.png"><img src="../images/screenshots/view_results_tree_xml.png" width="873" height="653" alt="Figure 9 Sample XML display"></a><figcaption>Figure 9 Sample XML display</figcaption></figure>
<figure><a href="../images/screenshots/view_results_tree_regex.png"><img src="../images/screenshots/view_results_tree_regex.png" width="858" height="643" alt="Figure 9a Sample Regexp Test display"></a><figcaption>Figure 9a Sample Regexp Test display</figcaption></figure>
<figure><a href="../images/screenshots/view_results_tree_document.png"><img src="../images/screenshots/view_results_tree_document.png" width="961" height="623" alt="Figure 9b Sample Document (here PDF) display"></a><figcaption>Figure 9b Sample Document (here PDF) display</figcaption></figure>
</div>
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Aggregate_Report">Aggregate Report<a class="sectionlink" href="#Aggregate_Report" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/aggregate_report.png"><img src="../images/screenshots/aggregate_report.png" width="1140" height="266" alt="Screenshot for Aggregate Report"></a></div>
<div class="description">The aggregate report creates a table row for each differently named request in your
test. For each request, it totals the response information and provides request count, min, max,
average, error rate, approximate throughput (request/second) and Kilobytes per second throughput.
Once the test is done, the throughput is the actual through for the duration of the entire test.
<p>
The thoughput is calculated from the point of view of the sampler target
(e.g. the remote server in the case of HTTP samples).
JMeter takes into account the total time over which the requests have been generated.
If other samplers and timers are in the same thread, these will increase the total time,
and therefore reduce the throughput value.
So two identical samplers with different names will have half the throughput of two samplers with the same name.
It is important to choose the sampler names correctly to get the best results from
the Aggregate Report.
</p>
<p>
Calculation of the <a href="glossary.html#Median">Median</a> and 90% Line (90<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>) values requires additional memory.
JMeter now combines samples with the same elapsed time, so far less memory is used.
However, for samples that take more than a few seconds, the probability is that fewer samples will have identical times,
in which case more memory will be needed.
Note you can use this listener afterwards to reload a CSV or XML results file which is the recommended way to avoid performance impacts.
See the <a href="../usermanual/component_reference.html#Summary_Report">Summary Report</a> for a similar Listener that does not store individual samples and so needs constant memory.
</p>
<div class="clear"></div><div class="note">
Starting with JMeter 2.12, you can configure the 3 percentile values you want to compute, this can be done by setting properties:
<ul>
<li>aggregate_rpt_pct1: defaults to 90<sup>th</sup> <a href="glossary.html#Percentile">percentile</a></li>
<li>aggregate_rpt_pct2: defaults to 95<sup>th</sup> <a href="glossary.html#Percentile">percentile</a></li>
<li>aggregate_rpt_pct3: defaults to 99<sup>th</sup> <a href="glossary.html#Percentile">percentile</a></li>
</ul>
</div><div class="clear"></div>
<ul>
<li>Label - The label of the sample.
If "Include group name in label?" is selected, then the name of the thread group is added as a prefix.
This allows identical labels from different thread groups to be collated separately if required.
</li>
<li># Samples - The number of samples with the same label</li>
<li>Average - The average time of a set of results</li>
<li>Median - The <a href="glossary.html#Median">median</a> is the time in the middle of a set of results.
50% of the samples took no more than this time; the remainder took at least as long.</li>
<li>90% Line - 90% of the samples took no more than this time.
The remaining samples took at least as long as this. (90<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>)</li>
<li>95% Line - 95% of the samples took no more than this time.
The remaining samples took at least as long as this. (95<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>)</li>
<li>99% Line - 99% of the samples took no more than this time.
The remaining samples took at least as long as this. (99<sup>th</sup> <a href="glossary.html#Percentile">percentile</a>)</li>
<li>Min - The shortest time for the samples with the same label</li>
<li>Max - The longest time for the samples with the same label</li>
<li>Error % - Percent of requests with errors</li>
<li>Throughput - the <a href="glossary.html#Throughput">Throughput</a> is measured in requests per second/minute/hour.
The time unit is chosen so that the displayed rate is at least 1.0.
When the throughput is saved to a CSV file, it is expressed in requests/second,
i.e. 30.0 requests/minute is saved as 0.5.
</li>
<li>Kb/sec - The throughput measured in Kilobytes per second</li>
</ul>
<p>Times are in milliseconds.</p>
</div>
<div align="center">
<p>
The figure below shows an example of selecting the "Include group name" checkbox.
<figure><a href="../images/screenshots/aggregate_report_grouped.png"><img src="../images/screenshots/aggregate_report_grouped.png" width="1140" height="276" alt="Sample &quot;Include group name&quot; display"></a><figcaption>Sample "Include group name" display</figcaption></figure>
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="View_Results_in_Table">View Results in Table<a class="sectionlink" href="#View_Results_in_Table" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/table_results.png"><img src="../images/screenshots/table_results.png" width="966" height="683" alt="Screenshot for View Results in Table"></a></div>
<div class="description">This visualizer creates a row for every sample result.
Like the <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a>, this visualizer uses a lot of memory.
<p>
By default, it only displays the main (parent) samples; it does not display the sub-samples (child samples).
Versions of JMeter after 2.5.1 have a "Child Samples?" check-box.
If this is selected, then the sub-samples are displayed instead of the main samples.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Simple_Data_Writer">Simple Data Writer<a class="sectionlink" href="#Simple_Data_Writer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/simpledatawriter.png"><img src="../images/screenshots/simpledatawriter.png" width="741" height="141" alt="Screenshot for Simple Data Writer"></a></div>
<div class="description">This listener can record results to a file
but not to the UI. It is meant to provide an efficient means of
recording data by eliminating GUI overhead.
When running in non-GUI mode, the -l flag can be used to create a data file.
The fields to save are defined by JMeter properties.
See the jmeter.properties file for details.
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Monitor_Results">Monitor Results<a class="sectionlink" href="#Monitor_Results" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/monitor_screencap.png"><img src="../images/screenshots/monitor_screencap.png" width="762" height="757" alt="Screenshot for Monitor Results"></a></div>
<div class="description">
<p>Monitor Results is a new Visualizer for displaying server
status. It is designed for Tomcat 5, but any servlet container
can port the status servlet and use this monitor. There are two primary
tabs for the monitor. The first is the "Health" tab, which will show the
status of one or more servers. The second tab labled "Performance" shows
the performance for one server for the last 1000 samples. The equations
used for the load calculation is included in the Visualizer.</p>
<p>Currently, the primary limitation of the monitor is system memory. A
quick benchmark of memory usage indicates a buffer of 1000 data points for
100 servers would take roughly 10Mb of RAM. On a 1.4Ghz centrino
laptop with 1Gb of ram, the monitor should be able to handle several
hundred servers.</p>
<p>As a general rule, monitoring production systems should take care to
set an appropriate interval. Intervals shorter than 5 seconds are too
aggressive and have a potential of impacting the server. With a buffer of
1000 data points at 5 second intervals, the monitor would check the server
status 12 times a minute or 720 times a hour. This means the buffer shows
the performance history of each machine for the last hour.</p>
<div class="clear"></div><div class="note">
The monitor requires Tomcat 5 or above.
Use a browser to check that you can access the Tomcat status servlet OK.
</div><div class="clear"></div>
<p>
For a detailed description of how to use the monitor, please refer to
<a href="build-monitor-test-plan.html">Building a Monitor Test Plan</a>
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Distribution_Graph_(alpha)">Distribution Graph (alpha)<a class="sectionlink" href="#Distribution_Graph_(alpha)" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/distribution_graph.png"><img src="../images/screenshots/distribution_graph.png" width="819" height="626" alt="Screenshot for Distribution Graph (alpha)"></a></div>
<div class="description">
<div class="clear"></div><div class="note">
Distribution Graph MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
<p>The distribution graph will display a bar for every unique response time. Since the
granularity of System.currentTimeMillis() is 10 milliseconds, the 90% threshold should be
within the width of the graph. The graph will draw two threshold lines: 50% and 90%.
What this means is 50% of the response times finished between 0 and the line. The same
is true of 90% line. Several tests with Tomcat were performed using 30 threads for 600K
requests. The graph was able to display the distribution without any problems and both
the 50% and 90% line were within the width of the graph. A performant application will
generally produce results that clump together. A poorly written application that has
memory leaks may result in wild fluctuations. In those situations, the threshold lines
may be beyond the width of the graph. The recommended solution to this specific problem
is fix the webapp so it performs well. If your test plan produces distribution graphs
with no apparent clumping or pattern, it may indicate a memory leak. The only way to
know for sure is to use a profiling tool.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Aggregate_Graph">Aggregate Graph<a class="sectionlink" href="#Aggregate_Graph" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/aggregate_graph.png"><img src="../images/screenshots/aggregate_graph.png" width="1132" height="872" alt="Screenshot for Aggregate Graph"></a></div>
<div class="description">The aggregate graph is similar to the aggregate report. The primary
difference is the aggregate graph provides an easy way to generate bar graphs and save
the graph as a PNG file.</div>
<div align="center">
<p>
The figure below shows an example of settings to draw this graph.
<figure><a href="../images/screenshots/aggregate_graph_settings.png"><img src="../images/screenshots/aggregate_graph_settings.png" width="1147" height="420" alt="Aggregate graph settings"></a><figcaption>Aggregate graph settings</figcaption></figure>
</p>
</div>
<p><i>Please note: All this parameters <b>aren't</b> saved in JMeter jmx script.</i></p>
<div class="properties"><h3 id="Aggregate_Graph_parms1">
Parameters
<a class="sectionlink" href="#Aggregate_Graph_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Column settings</div><div class="description req-true"><ul>
<li><u>Columns to display:</u> Choose the column(s) to display in graph.</li>
<li><u>Rectangles color:</u> Clic on right color rectangle open a popup dialog to choose a custom color for column.</li>
<li><u>Foreground color</u> Allow to change the value text color.</li>
<li><u>Value font:</u> Allow to define font settings for the text.</li>
<li><u>Draw outlines bar?</u> To draw or not the border line on bar chart</li>
<li><u>Show number grouping?</u> Show or not the number grouping in Y Axis labels.</li>
<li><u>Value labels vertical?</u> Change orientation for value label. (Default is horizontal)</li>
<li><u>Column label selection:</u> Filter by result label. A regular expression can be used, example: <i>.*Transaction.*</i>
<br>Before display the graph, click on <b>Apply filter</b> button to refresh internal data.</li></ul></div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Title</div><div class="description req-false">Define the graph's title on the head of chart. Empty value is the default value : "Aggregate Graph".
The button <b>Synchronize with name</b> define the title with the label of the listener. And define font settings for graph title</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Graph size</div><div class="description req-false">Compute the graph size by the width and height depending of the current JMeter's window size.
Use Width and Height fields to define a custom size. The unit is pixel. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X Axis settings</div><div class="description req-false">Define the max length of X Axis label (in pixel).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Y Axis settings</div><div class="description req-false">Define a custom maximum value for Y Axis.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Legend</div><div class="description req-true">Define the placement and font settings for chart legend</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Response_Time_Graph">Response Time Graph<a class="sectionlink" href="#Response_Time_Graph" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/response_time_graph.png"><img src="../images/screenshots/response_time_graph.png" width="921" height="616" alt="Screenshot for Response Time Graph"></a></div>
<div class="description">
The Response Time Graph draws a line chart showing the evolution of response time during the test, for each labelled request.
If many samples exist for the same timestamp, the mean value is displayed.
</div>
<div align="center">
<p>
The figure below shows an example of settings to draw this graph.
<figure><a href="../images/screenshots/response_time_graph_settings.png"><img src="../images/screenshots/response_time_graph_settings.png" width="919" height="481" alt="Response time graph settings"></a><figcaption>Response time graph settings</figcaption></figure>
</p>
</div>
<p><i>Please note: All this parameters are saved in JMeter .jmx file.</i></p>
<div class="properties"><h3 id="Response_Time_Graph_parms1">
Parameters
<a class="sectionlink" href="#Response_Time_Graph_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Interval (ms)</div><div class="description req-true">The time in milli-seconds for X axis interval. Samples are grouped according to this value.
Before display the graph, click on <b>Apply interval</b> button to refresh internal data.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Sampler label selection</div><div class="description req-false">Filter by result label. A regular expression can be used, ex.<i>.*Transaction.*</i>.
Before display the graph, click on <b>Apply filter</b> button to refresh internal data.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Title</div><div class="description req-false">Define the graph's title on the head of chart. Empty value is the default value : "Response Time Graph".
The button <b>Synchronize with name</b> define the title with the label of the listener. And define font settings for graph title</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Line settings</div><div class="description req-true">Define the width of the line. Define the type of each value point. Choose <i>none</i> to have a line without mark</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Graph size</div><div class="description req-false">Compute the graph size by the width and height depending of the current JMeter's window size.
Use Width and Height fields to define a custom size. The unit is pixel. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X Axis settings</div><div class="description req-false">Customize the date format of X axis label.
The syntax is the Java <a href="http://docs.oracle.com/javase/6/docs/api/java/text/SimpleDateFormat.html">SimpleDateFormat API</a>.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Y Axis settings</div><div class="description req-false">Define a custom maximum value for Y Axis in milli-seconds. Define the increment for the scale (in ms) Show or not the number grouping in Y Axis labels.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Legend</div><div class="description req-true">Define the placement and font settings for chart legend</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Mailer_Visualizer">Mailer Visualizer<a class="sectionlink" href="#Mailer_Visualizer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/mailervisualizer.png"><img src="../images/screenshots/mailervisualizer.png" width="860" height="403" alt="Screenshot for Mailer Visualizer"></a></div>
<div class="description"><p>The mailer visualizer can be set up to send email if a test run receives too many
failed responses from the server.</p></div>
<div class="properties"><h3 id="Mailer_Visualizer_parms1">
Parameters
<a class="sectionlink" href="#Mailer_Visualizer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">From</div><div class="description req-true">Email address to send messages from.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Addressee(s)</div><div class="description req-true">Email address to send messages to, comma-separated.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Success Subject</div><div class="description req-false">Email subject line for success messages.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Success Limit</div><div class="description req-true">Once this number of successful responses is exceeded
<strong>after previously reaching the failure limit</strong>, a success email
is sent. The mailer will thus only send out messages in a sequence of failed-succeeded-failed-succeeded, etc.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Failure Subject</div><div class="description req-false">Email subject line for fail messages.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Failure Limit</div><div class="description req-true">Once this number of failed responses is exceeded, a failure
email is sent - i.e. set the count to 0 to send an e-mail on the first failure.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Host</div><div class="description req-false">IP address or host name of SMTP server (email redirector)
server.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port of SMTP server (defaults to 25).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Login</div><div class="description req-false">Login used to authenticate.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password used to authenticate.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connection security</div><div class="description req-false">Type of encryption for SMTP authentication (SSL, TLS or none).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Test Mail</div><div class="description req-false">Press this button to send a test mail</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Failures</div><div class="description req-false">A field that keeps a running total of number
of failures so far received.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_Listener">BeanShell Listener<a class="sectionlink" href="#BeanShell_Listener" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/beanshell_listener.png"><img src="../images/screenshots/beanshell_listener.png" width="844" height="633" alt="Screenshot for BeanShell Listener"></a></div>
<div class="description">
<p>
The BeanShell Listener allows the use of BeanShell for processing samples for saving etc.
</p>
<p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p>
<p>
The test element supports the ThreadListener and TestListener methods.
These should be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
</div>
<div class="properties"><h3 id="BeanShell_Listener_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_Listener_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the BeanShell script to run.
The file name is stored in the script variable FileName</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The BeanShell script to run. The return value is ignored.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>Before invoking the script, some variables are set up in the BeanShell interpreter:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampleResult, prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a></li>
<li>sampleEvent (<a href="../api/org/apache/jmeter/samplers/SampleEvent.html">SampleEvent</a>) gives access to the current sample event</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<p>If the property <b>beanshell.listener.init</b> is defined, this is used to load an initialisation file, which can be used to define methods etc for use in the BeanShell script.</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Summary_Report">Summary Report<a class="sectionlink" href="#Summary_Report" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/summary_report.png"><img src="../images/screenshots/summary_report.png" width="926" height="324" alt="Screenshot for Summary Report"></a></div>
<div class="description">The summary report creates a table row for each differently named request in your
test. This is similar to the <a href="../usermanual/component_reference.html#Aggregate_Report">Aggregate Report</a> , except that it uses less memory.
<p>
The thoughput is calculated from the point of view of the sampler target
(e.g. the remote server in the case of HTTP samples).
JMeter takes into account the total time over which the requests have been generated.
If other samplers and timers are in the same thread, these will increase the total time,
and therefore reduce the throughput value.
So two identical samplers with different names will have half the throughput of two samplers with the same name.
It is important to choose the sampler labels correctly to get the best results from
the Report.
</p>
<ul>
<li>Label - The label of the sample.
If "Include group name in label?" is selected, then the name of the thread group is added as a prefix.
This allows identical labels from different thread groups to be collated separately if required.
</li>
<li># Samples - The number of samples with the same label</li>
<li>Average - The average elapsed time of a set of results</li>
<li>Min - The lowest elapsed time for the samples with the same label</li>
<li>Max - The longest elapsed time for the samples with the same label</li>
<li>Std. Dev. - the <a href="glossary.html#StandardDeviation">Standard Deviation</a> of the sample elapsed time</li>
<li>Error % - Percent of requests with errors</li>
<li>Throughput - the <a href="glossary.html#Throughput">Throughput</a> is measured in requests per second/minute/hour.
The time unit is chosen so that the displayed rate is at least 1.0.
When the throughput is saved to a CSV file, it is expressed in requests/second,
i.e. 30.0 requests/minute is saved as 0.5.
</li>
<li>Kb/sec - The throughput measured in Kilobytes per second</li>
<li>Avg. Bytes - average size of the sample response in bytes. (in JMeter 2.2 it wrongly showed the value in kB)</li>
</ul>
<p>Times are in milliseconds.</p>
</div>
<div align="center">
<p>
The figure below shows an example of selecting the "Include group name" checkbox.
<figure><a href="../images/screenshots/summary_report_grouped.png"><img src="../images/screenshots/summary_report_grouped.png" width="923" height="325" alt="Sample &quot;Include group name&quot; display"></a><figcaption>Sample "Include group name" display</figcaption></figure>
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Save_Responses_to_a_file">Save Responses to a file<a class="sectionlink" href="#Save_Responses_to_a_file" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/savetofile.png"><img src="../images/screenshots/savetofile.png" width="358" height="225" alt="Screenshot for Save Responses to a file"></a></div>
<div class="description">
<p>
This test element can be placed anywhere in the test plan.
For each sample in its scope, it will create a file of the response Data.
The primary use for this is in creating functional tests, but it can also
be useful where the response is too large to be displayed in the
<a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Listener.
The file name is created from the specified prefix, plus a number (unless this is disabled, see below).
The file extension is created from the document type, if known.
If not known, the file extension is set to 'unknown'.
If numbering is disabled, and adding a suffix is disabled, then the file prefix is
taken as the entire file name. This allows a fixed file name to be generated if required.
The generated file name is stored in the sample response, and can be saved
in the test log output file if required.
</p>
<p>
The current sample is saved first, followed by any sub-samples (child samples).
If a variable name is provided, then the names of the files are saved in the order
that the sub-samples appear. See below.
</p>
</div>
<div class="properties"><h3 id="Save_Responses_to_a_file_parms1">
Parameters
<a class="sectionlink" href="#Save_Responses_to_a_file_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Filename Prefix</div><div class="description req-true">Prefix for the generated file names; this can include a directory name.
Relative paths are resolved relative to the current working directory (which defaults to the bin/ directory).
Versions of JMeter after 2.4 also support paths relative to the directory containing the current test plan (JMX file).
If the path name begins with "~/" (or whatever is in the jmeter.save.saveservice.base_prefix JMeter property),
then the path is assumed to be relative to the JMX file location.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Variable Name</div><div class="description req-false">
Name of a variable in which to save the generated file name (so it can be used later in the test plan).
If there are sub-samples then a numeric suffix is added to the variable name.
E.g. if the variable name is FILENAME, then the parent sample file name is saved in the variable FILENAME,
and the filenames for the child samplers are saved in FILENAME1, FILENAME2 etc.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Save Failed Responses only</div><div class="description req-true">If selected, then only failed responses are saved</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Save Successful Responses only</div><div class="description req-true">If selected, then only successful responses are saved</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Don't add number to prefix</div><div class="description req-true">If selected, then no number is added to the prefix. If you select this option, make sure that the prefix is unique or the file may be overwritten.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Don't add suffix</div><div class="description req-true">If selected, then no suffix is added. If you select this option, make sure that the prefix is unique or the file may be overwritten.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_Listener">BSF Listener<a class="sectionlink" href="#BSF_Listener" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/bsf_listener.png"><img src="../images/screenshots/bsf_listener.png" width="847" height="634" alt="Screenshot for BSF Listener"></a></div>
<div class="description">
<p>
The BSF Listener allows BSF script code to be applied to sample results.
</p>
</div>
<div class="properties"><h3 id="BSF_Listener_parms1">
Parameters
<a class="sectionlink" href="#BSF_Listener_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Language</div><div class="description req-true">The BSF language to be used</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The script to run.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
The script (or file) is processed using the BSFEngine.exec() method, which does not return a value.
</p>
<p>
Before invoking the script, some variables are set up.
Note that these are BSF variables - i.e. they can be used directly in the script.
</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>Label - the String Label</li>
<li>Filename - the script file name (if any)</li>
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampleResult, prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the SampleResult</li>
<li>sampleEvent - (<a href="../api/org/apache/jmeter/samplers/SampleEvent.html">SampleEvent</a>) - gives access to the SampleEvent</li>
<li>sampler - (Sampler)- gives access to the last sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_Listener">JSR223 Listener<a class="sectionlink" href="#JSR223_Listener" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JSR223 Listener allows JSR223 script code to be applied to sample results.
For details, see <a href="../usermanual/component_reference.html#BSF_Listener">BSF Listener</a>.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Generate_Summary_Results">Generate Summary Results<a class="sectionlink" href="#Generate_Summary_Results" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/summary.png"><img src="../images/screenshots/summary.png" width="358" height="131" alt="Screenshot for Generate Summary Results"></a></div>
<div class="description">This test element can be placed anywhere in the test plan.
Generates a summary of the test run so far to the log file and/or
standard output. Both running and differential totals are shown.
Output is generated every n seconds (default 30 seconds) on the appropriate
time boundary, so that multiple test runs on the same time will be synchronised.
See jmeter.properties file for the summariser configuration items:
<pre>
# Define the following property to automatically start a summariser with that name
# (applies to non-GUI mode only)
#summariser.name=summary
#
# interval between summaries (in seconds) default 3 minutes
#summariser.interval=30
#
# Write messages to log file
#summariser.log=true
#
# Write messages to System.out
#summariser.out=true
</pre>
This element is mainly intended for batch (non-GUI) runs.
The output looks like the following:
<pre>
label + 171 in 20.3s = 8.4/s Avg: 1129 Min: 1000 Max: 1250 Err: 0 (0.00%)
label + 263 in 31.3s = 8.4/s Avg: 1138 Min: 1000 Max: 1250 Err: 0 (0.00%)
label = 434 in 50.4s = 8.6/s Avg: 1135 Min: 1000 Max: 1250 Err: 0 (0.00%)
label + 263 in 31.0s = 8.5/s Avg: 1138 Min: 1000 Max: 1250 Err: 0 (0.00%)
label = 697 in 80.3s = 8.7/s Avg: 1136 Min: 1000 Max: 1250 Err: 0 (0.00%)
label + 109 in 12.4s = 8.8/s Avg: 1092 Min: 47 Max: 1250 Err: 0 (0.00%)
label = 806 in 91.6s = 8.8/s Avg: 1130 Min: 47 Max: 1250 Err: 0 (0.00%)
</pre>
The "label" is the the name of the element.
The "+" means that the line is a delta line, i.e. shows the changes since the last output.<br>
The "=" means that the line is a totals line, i.e. it shows the running total.<br>
Entries in the jmeter log file also include time-stamps.
The example "806 in 91.6s = 8.8/s" means that there were 806 samples recorded in 91.6 seconds,
and that works out at 8.8 samples per second.<br>
The Avg (Average), Min(imum) and Max(imum) times are in milliseconds.<br>
"Err" means number of errors (also shown as percentage).<br>
The last two lines will appear at the end of a test.
They will not be synchronised to the appropriate time boundary.
Note that the initial and final deltas may be for less than the interval (in the example above this is 30 seconds).
The first delta will generally be lower, as JMeter synchronizes to the interval boundary.
The last delta will be lower, as the test will generally not finish on an exact interval boundary.
<p>
The label is used to group sample results together.
So if you have multiple Thread Groups and want to summarize across them all, then use the same label
- or add the summariser to the Test Plan (so all thread groups are in scope).
Different summary groupings can be implemented
by using suitable labels and adding the summarisers to appropriate parts of the test plan.
</p>
<div class="clear"></div><div class="note">
In Non-GUI mode by default a Generate Summary Results listener named "summariser" is configured, if you have already added one to your Test Plan, ensure you name it differently
otherwise results will be accumulated under this label (summary) leading to wrong results (sum of total samples + samples located under the Parent of Generate Summary Results listener).
This is not a bug but a design choice allowing to summarize across thread groups.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="Generate_Summary_Results_parms1">
Parameters
<a class="sectionlink" href="#Generate_Summary_Results_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.
It appears as the "label" in the output. Details for all elements with the same label will be added together.
</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Comparison_Assertion_Visualizer">Comparison Assertion Visualizer<a class="sectionlink" href="#Comparison_Assertion_Visualizer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/comparison_assertion_visualizer.png"><img src="../images/screenshots/comparison_assertion_visualizer.png" width="777" height="266" alt="Screenshot for Comparison Assertion Visualizer"></a></div>
<div class="description">
The Comparison Assertion Visualizer shows the results of any <a href="../usermanual/component_reference.html#Compare_Assertion">Compare Assertion</a> elements.
</div>
<div class="properties"><h3 id="Comparison_Assertion_Visualizer_parms1">
Parameters
<a class="sectionlink" href="#Comparison_Assertion_Visualizer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.
</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Backend_Listener">Backend Listener<a class="sectionlink" href="#Backend_Listener" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/backend_listener.png"><img src="../images/screenshots/backend_listener.png" width="902" height="341" alt="Screenshot for Backend Listener"></a></div>
<div class="description">
The backend listener is an Asynchronous listener that enables you to plug custom implementations of <a href="../api/org/apache/jmeter/visualizers/backend/BackendListenerClient.html">BackendListenerClient</a>.
By default, a Graphite implementation is provided.
</div>
<div class="properties"><h3 id="Backend_Listener_parms1">
Parameters
<a class="sectionlink" href="#Backend_Listener_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Backend Listener implementation</div><div class="description req-true">Class of the BackendListenerClient implementation.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Async Queue size</div><div class="description req-true">Size of the queue that holds the SampleResults while they are processed asynchronously.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameters</div><div class="description req-true">Parameters of the BackendListenerClient implementation.</div><div class="required req-true">Yes</div></div>
</div>
<p>The following parameters apply to the <b>GraphiteBackendListenerClient</b> implementation:</p>
<div class="properties"><h3 id="Backend_Listener_parms2">
Parameters
<a class="sectionlink" href="#Backend_Listener_parms2" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">graphiteMetricsSender</div><div class="description req-true">org.apache.jmeter.visualizers.backend.graphite.TextGraphiteMetricsSender or org.apache.jmeter.visualizers.backend.graphite.PickleGraphiteMetricsSender</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">graphiteHost</div><div class="description req-true">Graphite or InfluxDB (with Graphite plugin enabled) server host</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">graphitePort</div><div class="description req-true">Graphite or InfluxDB (with Graphite plugin enabled) server port, defaults to 2003. Note PickleGraphiteMetricsSender (port 2004) can only talk to Graphite server.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">rootMetricsPrefix</div><div class="description req-true">Prefix of metrics sent to backend. Defaults to "jmeter."</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">summaryOnly</div><div class="description req-true">Only send a summary with no detail. Defaults to true.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">samplersList</div><div class="description req-true">Semicolon separated list of samplers for which you want to report metrics to backend.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">percentiles</div><div class="description req-true">The percentiles you want to send to backend. List must be semicolon separated.</div><div class="required req-true">Yes</div></div>
</div>
<p>Read <a href="realtime-results.html">this</a> for more details.</p>
<figure><a href="../images/screenshots/grafana_dashboard.png"><img src="../images/screenshots/grafana_dashboard.png" width="1265" height="581" alt="Grafana dashboard"></a><figcaption>Grafana dashboard</figcaption></figure>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="config_elements">18.4 Configuration Elements<a class="sectionlink" href="#config_elements" title="Link to here">&para;</a></h1>
<div class="description">
<br>
Configuration elements can be used to set up defaults and variables for later use by samplers.
Note that these elements are processed at the start of the scope in which they are found,
i.e. before any samplers in the same scope.
<br>
</div>
<div class="component"><h2 id="CSV_Data_Set_Config">CSV Data Set Config<a class="sectionlink" href="#CSV_Data_Set_Config" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/csvdatasetconfig.png"><img src="../images/screenshots/csvdatasetconfig.png" width="433" height="281" alt="Screenshot for CSV Data Set Config"></a></div>
<div class="description">
<p>
CSV Data Set Config is used to read lines from a file, and split them into variables.
It is easier to use than the __CSVRead() and _StringFromFile() functions.
It is well suited to handling large numbers of variables, and is also useful for tesing with
"random" and unique values.
Generating unique random values at run-time is expensive in terms of CPU and memory, so just create the data
in advance of the test. If necessary, the "random" data from the file can be used in conjunction with
a run-time parameter to create different sets of values from each run - e.g. using concatenation - which is
much cheaper than generating everything at run-time.
</p>
<p>
Versions of JMeter after 2.3.1 allow values to be quoted; this allows the value to contain a delimiter.
Previously it was necessary to choose a delimiter that was not used in any values.
If "allow quoted data" is enabled, a value may be enclosed in double-quotes.
These are removed. To include double-quotes within a quoted field, use two double-quotes.
For example:<pre>
1,"2,3","4""5" =&gt;
1
2,3
4"5
</pre>
</p>
<p>
Versions of JMeter after 2.3.4 support CSV files which have a header line defining the column names.
To enable this, leave the "Variable Names" field empty. The correct delimiter must be provided.
</p>
<p>
Versions of JMeter after 2.7 support CSV files with quoted data that includes new-lines.
</p>
<p>
By default, the file is only opened once, and each thread will use a different line from the file.
However the order in which lines are passed to threads depends on the order in which they execute,
which may vary between iterations.
Lines are read at the start of each test iteration.
The file name and mode are resolved in the first iteration.
</p>
<p>
See the description of the Share mode below for additional options (JMeter 2.3.2+).
If you want each thread to have its own set of values, then you will need to create a set of files,
one for each thread. For example test1.csv, test2.csv,... testn.csv. Use the filename
<span class="code">test${__threadNum}.csv</span> and set the "Sharing mode" to "Current thread".
</p>
<div class="clear"></div><div class="note">CSV Dataset variables are defined at the start of each test iteration.
As this is after configuration processing is completed,
they cannot be used for some configuration items - such as JDBC Config -
that process their contents at configuration time (see <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=40394">
Bug
40394</a>)
However the variables do work in the HTTP Auth Manager, as the username etc are processed at run-time.
</div><div class="clear"></div>
<p>
As a special case, the string "\t" (without quotes) in the delimiter field is treated as a Tab.
</p>
<p>
When the end of file (EOF) is reached, and the recycle option is true, reading starts again with the first line of the file.
</p>
<p>
If the recycle option is false, and stopThread is false, then all the variables are set to <b>&lt;EOF&gt;</b> when the end of file is reached.
This value can be changed by setting the JMeter property <b>csvdataset.eofstring</b>.
</p>
<p>
If the Recycle option is false, and Stop Thread is true, then reaching EOF will cause the thread to be stopped.
</p>
</div>
<div class="properties"><h3 id="CSV_Data_Set_Config_parms1">
Parameters
<a class="sectionlink" href="#CSV_Data_Set_Config_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Filename</div><div class="description req-true">Name of the file to be read.
<b>Relative file names are resolved with respect to the path of the active test plan.</b>
<b>For distributed testing, the CSV file must be stored on the server host system in the correct relative directory to where the jmeter server is started.</b>
Absolute file names are also supported, but note that they are unlikely to work in remote mode,
unless the remote server has the same directory structure.
If the same physical file is referenced in two different ways - e.g. csvdata.txt and ./csvdata.txt -
then these are treated as different files.
If the OS does not distinguish between upper and lower case, csvData.TXT would also be opened separately.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">File Encoding</div><div class="description req-false">The encoding to be used to read the file, if not the platform default.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Variable Names</div><div class="description req-true">List of variable names (comma-delimited).
Versions of JMeter after 2.3.4 support CSV header lines:
if the variable name field empty, then the first line of the file is read and interpreted as the list of column names.
The names must be separated by the delimiter character. They can be quoted using double-quotes.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Delimiter</div><div class="description req-true">Delimiter to be used to split the records in the file.
If there are fewer values on the line than there are variables the remaining variables are not updated -
so they will retain their previous value (if any).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Allow quoted data?</div><div class="description req-true">Should the CSV file allow values to be quoted?
If enabled, then values can be enclosed in <span class="code">"</span> - double-quote - allowing values to contain a delimeter.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Recycle on EOF?</div><div class="description req-true">Should the file be re-read from the beginning on reaching EOF? (default is true)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Stop thread on EOF?</div><div class="description req-true">Should the thread be stopped on EOF, if Recycle is false? (default is false)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Sharing mode</div><div class="description req-true">
<ul>
<li>All threads - (the default) the file is shared between all the threads.</li>
<li>Current thread group - each file is opened once for each thread group in which the element appears</li>
<li>Current thread - each file is opened separately for each thread</li>
<li>Identifier - all threads sharing the same identifier share the same file.
So for example if you have 4 thread groups, you could use a common id for two or more of the groups
to share the file between them.
Or you could use the thread number to share the file between the same thread numbers in different thread groups.
</li>
</ul>
</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="FTP_Request_Defaults">FTP Request Defaults<a class="sectionlink" href="#FTP_Request_Defaults" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ftp-config/ftp-request-defaults.png"><img src="../images/screenshots/ftp-config/ftp-request-defaults.png" width="520" height="202" alt="Screenshot for FTP Request Defaults"></a></div>
<div class="description"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="DNS_Cache_Manager">DNS Cache Manager<a class="sectionlink" href="#DNS_Cache_Manager" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/dns-cache-manager.png"><img src="../images/screenshots/dns-cache-manager.png" width="712" height="387" alt="Screenshot for DNS Cache Manager"></a></div>
<div class="clear"></div><div class="note">DNS Cache Manager is designed for using in the root of Thread Group or Test Plan. Do not place it as child element of particular HTTP Sampler
</div><div class="clear"></div>
<div class="clear"></div><div class="note">DNS Cache Manager working only with the HTTP request using HTTPClient4 implementation.</div><div class="clear"></div>
<div class="description"><p>The DNS Cache Manager element allows to test applications, which have several servers behind load balancers (CDN, etc),
when user receives content from different IP's. By default JMeter uses JVM DNS cache. That's why
only one server from the cluster receives load. DNS Cache Manager resolves name for each thread separately each iteration and
saves results of resolving to its internal DNS Cache, which independent from both JVM and OS DNS caches.
</p>
</div>
<div class="properties"><h3 id="DNS_Cache_Manager_parms1">
Parameters
<a class="sectionlink" href="#DNS_Cache_Manager_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Clear cache each Iteration</div><div class="description req-false">If selected, DNS cache of every Thread is cleared each time new iteration is started.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use system DNS resolver</div><div class="description req-false">System DNS resolver will be used. For correct work edit
$JAVA_HOME/jre/lib/security/java.security and add <pre>networkaddress.cache.ttl=0</pre>
</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Use custom DNS resolver</div><div class="description req-false">Custom DNS resolver(from dnsjava library) will be used.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Hostname or IP address</div><div class="description req-false">List of DNS servers to use. If empty, network configuration DNS will used.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Add Button</div><div class="description req-false">Add an entry to the DNS servers table.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Delete Button</div><div class="description req-false">Delete the currently selected table entry.</div><div class="required req-false">N/A</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Authorization_Manager">HTTP Authorization Manager<a class="sectionlink" href="#HTTP_Authorization_Manager" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-config/http-auth-manager.png"><img src="../images/screenshots/http-config/http-auth-manager.png" width="538" height="340" alt="Screenshot for HTTP Authorization Manager"></a></div>
<div class="clear"></div><div class="note">If there is more than one Authorization Manager in the scope of a Sampler,
there is currently no way to specify which one is to be used.</div><div class="clear"></div>
<div class="description">
<p>The Authorization Manager lets you specify one or more user logins for web pages that are
restricted using server authentication. You see this type of authentication when you use
your browser to access a restricted page, and your browser displays a login dialog box. JMeter
transmits the login information when it encounters this type of page.</p>
<p>
The Authorisation headers may not be shown in the Tree View Listener "Request" tab.
The Java implementation does pre-emptive authentication, but it does not
return the Authorization header when JMeter fetches the headers.
The Commons HttpClient (3.1) implementation defaults to pre-emptive and the header will be shown.
The HttpComponents implementation does not do pre-emptive auth
(it is supported by the library but JMeter does not enable it)
</p>
<p>
In versions of JMeter after 2.2, the HttpClient sampler defaults to pre-emptive authentication
if the setting has not been defined. To disable this, set the values as below, in which case
authentication will only be performed in response to a challenge.
<pre>
jmeter.properties:
httpclient.parameters.file=httpclient.parameters
httpclient.parameters:
http.authentication.preemptive$Boolean=false
</pre>
Note: the above settings only apply to the HttpClient sampler (and the SOAP samplers, which use Httpclient).
</p>
<div class="clear"></div><div class="note">
When looking for a match against a URL, JMeter checks each entry in turn, and stops when it finds the first match.
Thus the most specific URLs should appear first in the list, followed by less specific ones.
Duplicate URLs will be ignored.
If you want to use different usernames/passwords for different threads, you can use variables.
These can be set up using a <a href="../usermanual/component_reference.html#CSV_Data_Set_Config">CSV Data Set Config</a> Element (for example).
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="HTTP_Authorization_Manager_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Authorization_Manager_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Clear auth on each iteration ?</div><div class="description req-true">Used by Kerberos authentication. If checked, authentication will be done on each iteration of Main Thread Group loop even if it has already been done in a previous one.
This is usually useful if each main thread group iteration represents behaviour of one Virtual User.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Base URL</div><div class="description req-true">A partial or complete URL that matches one or more HTTP Request URLs. As an example,
say you specify a Base URL of "http://jmeter.apache.org/restricted/" with a username of "jmeter" and
a password of "jmeter". If you send an HTTP request to the URL
"http://jmeter.apache.org/restricted/ant/myPage.html", the Authorization Manager sends the login
information for the user named, "jmeter".</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Username</div><div class="description req-true">The username to authorize.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Password</div><div class="description req-true">The password for the user. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Domain</div><div class="description req-false">The domain to use for NTLM.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Realm</div><div class="description req-false">The realm to use for NTLM.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Mechanism</div><div class="description req-false">Type of authentication to perform. JMeter can perform different types of authentications based on used Http Samplers:
<table>
<tr><th>Sampler</th><th>Authentications</th></tr>
<tr><td>Java</td><td>BASIC</td></tr>
<tr><td>HttpClient 3.1</td><td>BASIC, DIGEST</td></tr>
<tr><td>HttpClient 4</td><td>BASIC, DIGEST and Kerberos</td></tr>
</table>
</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
The Realm only applies to the HttpClient sampler.
In JMeter 2.2, the domain and realm did not have separate columns, and were encoded as part of
the user name in the form: [domain\]username[@realm].
This was an experimental feature and has been removed.
</div><div class="clear"></div>
<br>
<b>Kerberos Configuration:</b>
<p>To configure Kerberos you need to setup at least two JVM system properties:
<ul>
<li><span class="code">-Djava.security.krb5.conf=krb5.conf</span></li>
<li><span class="code">-Djava.security.auth.login.config=jaas.conf</span></li>
</ul>
You can also configure those two properties in the file <em>bin/system.properties</em>.
Look at the two sample configuration files (<em>krb5.conf</em> and <em>jaas.conf</em>) located in the jmeter <em>bin</em> folder
for references to more documentation, and tweak them to match your Kerberos configuration.
</p>
<p>
When generating a SPN for Kerberos SPNEGO authentication IE and Firefox will omit the port number
from the url. Chrome has an option (<span class="code">--enable-auth-negotiate-port</span>) to include the port
number if it differs from the standard ones (<span class="code">80</span> and <span class="code">443</span>). That behavior
can be emulated by setting the following jmeter property as below.
</p>
<p>
In <em>jmeter.properties</em> or <em>user.properties</em>, set:
<ul>
<li><span class="code">kerberos.spnego.strip_port=false</span></li>
</ul>
</p>
<br>
<b>Controls:</b>
<ul>
<li>Add Button - Add an entry to the authorization table.</li>
<li>Delete Button - Delete the currently selected table entry.</li>
<li>Load Button - Load a previously saved authorization table and add the entries to the existing
authorization table entries.</li>
<li>Save As Button - Save the current authorization table to a file.</li>
</ul>
<div class="clear"></div><div class="note">When you save the Test Plan, JMeter automatically saves all of the authorization
table entries - including any passwords, which are not encrypted.</div><div class="clear"></div>
<div class="example"><div class="title">Authorization Example<a class="sectionlink" href="#authorization_example" title="Link to here">&para;</a></div>
<p><a href="../demos/AuthManagerTestPlan.jmx">Download</a> this example. In this example, we created a Test Plan on a local server that sends three HTTP requests, two requiring a login and the
other is open to everyone. See figure 10 to see the makeup of our Test Plan. On our server, we have a restricted
directory named, "secret", which contains two files, "index.html" and "index2.html". We created a login id named, "kevin",
which has a password of "spot". So, in our Authorization Manager, we created an entry for the restricted directory and
a username and password (see figure 11). The two HTTP requests named "SecretPage1" and "SecretPage2" make requests
to "/secret/index.html" and "/secret/index2.html". The other HTTP request, named "NoSecretPage" makes a request to
"/index.html".</p>
<figure><a href="../images/screenshots/http-config/auth-manager-example1a.gif"><img src="../images/screenshots/http-config/auth-manager-example1a.gif" width="289" height="201" alt="Figure 10 - Test Plan"></a><figcaption>Figure 10 - Test Plan</figcaption></figure>
<figure><a href="../images/screenshots/http-config/auth-manager-example1b.png"><img src="../images/screenshots/http-config/auth-manager-example1b.png" width="641" height="329" alt="Figure 11 - Authorization Manager Control Panel"></a><figcaption>Figure 11 - Authorization Manager Control Panel</figcaption></figure>
<p>When we run the Test Plan, JMeter looks in the Authorization table for the URL it is requesting. If the Base URL matches
the URL, then JMeter passes this information along with the request.</p>
<div class="clear"></div><div class="note">You can download the Test Plan, but since it is built as a test for our local server, you will not
be able to run it. However, you can use it as a reference in constructing your own Test Plan.</div><div class="clear"></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Cache_Manager">HTTP Cache Manager<a class="sectionlink" href="#HTTP_Cache_Manager" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-config/http-cache-manager.png"><img src="../images/screenshots/http-config/http-cache-manager.png" width="511" height="196" alt="Screenshot for HTTP Cache Manager"></a></div>
<div class="description">
<p>
The HTTP Cache Manager is used to add caching functionality to HTTP requests within its scope to simulate browser cache feature.
Each Virtual User thread has its own Cache. By default, Cache Manager will store up to 5000 items in cache per Virtual User thread, using LRU algorithm.
Use property "maxSize" to modify this value. Note that the more you increase this value the more HTTP Cache Manager will consume memory, so be sure to adapt -Xmx option accordingly.
</p>
<p>
If a sample is successful (i.e. has response code 2xx) then the Last-Modified and Etag (and Expired if relevant) values are saved for the URL.
Before executing the next sample, the sampler checks to see if there is an entry in the cache,
and if so, the If-Last-Modified and If-None-Match conditional headers are set for the request.
</p>
<p>
Additionally, if the "Use Cache-Control/Expires header" option is selected, then the Cache-Control/Expires value is checked against the current time.
If the request is a GET request, and the timestamp is in the future, then the sampler returns immediately,
without requesting the URL from the remote server. This is intended to emulate browser behaviour.
Note that if Cache-Control header is "no-cache", the response will be stored in cache as pre-expired,
so will generate a conditional GET request.
If Cache-Control has any other value,
the "max-age" expiry option is processed to compute entry lifetime, if missing then expire header will be used, if also missing entry will be cached
as specified in <a href="http://www.ietf.org/rfc/rfc2616.txt">RFC 2616</a> section 13.2.4. using Last-Modified time and response Date.
</p>
<p>
If the requested document has not changed since it was cached, then the response body will be empty.
Likewise if the Expires date is in the future.
This may cause problems for Assertions.
</p>
</div>
<div class="properties"><h3 id="HTTP_Cache_Manager_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Cache_Manager_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Clear cache each iteration</div><div class="description req-true">
If selected, then the cache is cleared at the start of the thread.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use Cache Control/Expires header when processing GET requests</div><div class="description req-true">See description above.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Max Number of elements in cache</div><div class="description req-true">See description above.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Cookie_Manager">HTTP Cookie Manager<a class="sectionlink" href="#HTTP_Cookie_Manager" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-config/http-cookie-manager.png"><img src="../images/screenshots/http-config/http-cookie-manager.png" width="513" height="383" alt="Screenshot for HTTP Cookie Manager"></a></div>
<div class="clear"></div><div class="note">If there is more than one Cookie Manager in the scope of a Sampler,
there is currently no way to specify which one is to be used.
Also, a cookie stored in one cookie manager is not available to any other manager,
so use multiple Cookie Managers with care.</div><div class="clear"></div>
<div class="description"><p>The Cookie Manager element has two functions:<br>
First, it stores and sends cookies just like a web browser. If you have an HTTP Request and
the response contains a cookie, the Cookie Manager automatically stores that cookie and will
use it for all future requests to that particular web site. Each JMeter thread has its own
"cookie storage area". So, if you are testing a web site that uses a cookie for storing
session information, each JMeter thread will have its own session.
Note that such cookies do not appear on the Cookie Manager display, but they can be seen using
the <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Listener.
</p>
<p>
JMeter version 2.3.2 and earlier did not check that received cookies were valid for the URL.
This meant that cross-domain cookies were stored, and might be used later.
This has been fixed in later versions.
To revert to the earlier behaviour, define the JMeter property "CookieManager.check.cookies=false".
</p>
<p>
Received Cookies can be stored as JMeter thread variables
(versions of JMeter after 2.3.2 no longer do this by default).
To save cookies as variables, define the property "CookieManager.save.cookies=true".
Also, cookies names are prefixed with "COOKIE_" before they are stored (this avoids accidental corruption of local variables)
To revert to the original behaviour, define the property "CookieManager.name.prefix= " (one or more spaces).
If enabled, the value of a cookie with the name TEST can be referred to as ${COOKIE_TEST}.
</p>
<p>Second, you can manually add a cookie to the Cookie Manager. However, if you do this,
the cookie will be shared by all JMeter threads.</p>
<p>Note that such Cookies are created with an Expiration time far in the future</p>
<p>
Since version 2.0.3, cookies with null values are ignored by default.
This can be changed by setting the JMeter property: CookieManager.delete_null_cookies=false.
Note that this also applies to manually defined cookies - any such cookies will be removed from the display when it is updated.
Note also that the cookie name must be unique - if a second cookie is defined with the same name, it will replace the first.
</p>
</div>
<div class="properties"><h3 id="HTTP_Cookie_Manager_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Cookie_Manager_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Clear Cookies each Iteration</div><div class="description req-true">If selected, all server-defined cookies are cleared each time the main Thread Group loop is executed.
In JMeter versions after 2.3, any cookies defined in the GUI are not cleared.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Cookie Policy</div><div class="description req-true">The cookie policy that will be used to manage the cookies.
"compatibility" is the default, and should work in most cases.
See http://hc.apache.org/httpclient-3.x/cookies.html and
http://hc.apache.org/httpclient-3.x/apidocs/org/apache/commons/httpclient/cookie/CookiePolicy.html
[Note: "ignoreCookies" is equivalent to omitting the CookieManager.]
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Implementation</div><div class="description req-true">HC3CookieHandler (HttpClient 3.1 API) or HC4CookieHandler (HttpClient 4 API).
Default is HC3CookieHandler.
<br>
<i>[Note: If you have a website to test with IPv6 address, choose HC4CookieHandler (IPv6 compliant)]</i></div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">User-Defined Cookies</div><div class="description req-false">This
gives you the opportunity to use hardcoded cookies that will be used by all threads during the test execution.
<br>
The "domain" is the hostname of the server (without http://); the port is currently ignored.
</div><div class="required req-false">No (discouraged, unless you know what you're doing)</div></div>
<div class="property"><div class="name req-false">Add Button</div><div class="description req-false">Add an entry to the cookie table.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Delete Button</div><div class="description req-false">Delete the currently selected table entry.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Load Button</div><div class="description req-false">Load a previously saved cookie table and add the entries to the existing
cookie table entries.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Save As Button</div><div class="description req-false">
Save the current cookie table to a file (does not save any cookies extracted from HTTP Responses).
</div><div class="required req-false">N/A</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Request_Defaults">HTTP Request Defaults<a class="sectionlink" href="#HTTP_Request_Defaults" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-config/http-request-defaults.png"><img src="../images/screenshots/http-config/http-request-defaults.png" width="853" height="463" alt="Screenshot for HTTP Request Defaults"></a></div>
<div class="description"><p>This element lets you set default values that your HTTP Request controllers use. For example, if you are
creating a Test Plan with 25 HTTP Request controllers and all of the requests are being sent to the same server,
you could add a single HTTP Request Defaults element with the "Server Name or IP" field filled in. Then, when
you add the 25 HTTP Request controllers, leave the "Server Name or IP" field empty. The controllers will inherit
this field value from the HTTP Request Defaults element.</p>
<div class="clear"></div><div class="note">
In JMeter 2.2 and earlier, port 80 was treated specially - it was ignored if the sampler used the https protocol.
JMeter 2.3 and later treat all port values equally; a sampler that does not specify a port will use the HTTP Request Defaults port, if one is provided.
</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="HTTP_Request_Defaults_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Request_Defaults_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Server</div><div class="description req-false">Domain name or IP address of the web server. e.g. www.example.com. [Do not include the http:// prefix.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port the web server is listening to.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connect Timeout</div><div class="description req-false">Connection Timeout. Number of milliseconds to wait for a connection to open.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Response Timeout</div><div class="description req-false">Response Timeout. Number of milliseconds to wait for a response.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Implementation</div><div class="description req-false">Java, HttpClient3.1, HttpClient4.
If not specified the default depends on the value of the JMeter property
<span class="code">jmeter.httpsampler</span>, failing that, the Java implementation is used.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Protocol</div><div class="description req-false">HTTP or HTTPS.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Method</div><div class="description req-false">HTTP GET or HTTP POST.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Path</div><div class="description req-false">The path to resource (for example, /servlets/myServlet). If the
resource requires query string parameters, add them below in the "Send Parameters With the Request" section.
Note that the path is the default for the full path, not a prefix to be applied to paths
specified on the HTTP Request screens.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Send Parameters With the Request</div><div class="description req-false">The query string will
be generated from the list of parameters you provide. Each parameter has a <i>name</i> and
<i>value</i>. The query string will be generated in the correct fashion, depending on
the choice of "Method" you made (ie if you chose GET, the query string will be
appended to the URL, if POST, then it will be sent separately). Also, if you are
sending a file using a multipart form, the query string will be created using the
multipart form specifications.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Server (proxy)</div><div class="description req-false">Hostname or IP address of a proxy server to perform request. [Do not include the http:// prefix.]</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Port</div><div class="description req-false">Port the proxy server is listening to.</div><div class="required req-false">No, unless proxy hostname is specified</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">(Optional) username for proxy server.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">(Optional) password for proxy server. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Retrieve All Embedded Resources from HTML Files</div><div class="description req-false">Tell JMeter to parse the HTML file
and send HTTP/HTTPS requests for all images, Java applets, JavaScript files, CSSs, etc. referenced in the file.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Use concurrent pool</div><div class="description req-false">Use a pool of concurrent connections to get embedded resources.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Size</div><div class="description req-false">Pool size for concurrent connections used to get embedded resources.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Embedded URLs must match:</div><div class="description req-false">
If present, this must be a regular expression that is used to match against any embedded URLs found.
So if you only want to download embedded resources from http://example.com/, use the expression:
http://example\.com/.*
</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
Note: radio buttons only have two states - on or off.
This makes it impossible to override settings consistently
- does off mean off, or does it mean use the current default?
JMeter uses the latter (otherwise defaults would not work at all).
So if the button is off, then a later element can set it on,
but if the button is on, a later element cannot set it off.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Header_Manager">HTTP Header Manager<a class="sectionlink" href="#HTTP_Header_Manager" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/http-config/http-header-manager.png"><img src="../images/screenshots/http-config/http-header-manager.png" width="767" height="239" alt="Screenshot for HTTP Header Manager"></a></div>
<div class="description">
<p>The Header Manager lets you add or override HTTP request headers.</p>
<p>
Versions of JMeter up to 2.3.2 supported only one Header Manager per sampler;
if there were more in scope, then only the last one would be used.
</p>
<p>
<b>JMeter now supports multiple Header Managers</b>. The header entries are merged to form the list for the sampler.
If an entry to be merged matches an existing header name, it replaces the previous entry,
unless the entry value is empty, in which case any existing entry is removed.
This allows one to set up a default set of headers, and apply adjustments to particular samplers.
</p>
</div>
<div class="properties"><h3 id="HTTP_Header_Manager_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Header_Manager_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Name (Header)</div><div class="description req-false">Name of the request header.
Two common request headers you may want to experiment with
are "User-Agent" and "Referer".</div><div class="required req-false">No (You should have at least one, however)</div></div>
<div class="property"><div class="name req-false">Value</div><div class="description req-false">Request header value.</div><div class="required req-false">No (You should have at least one, however)</div></div>
<div class="property"><div class="name req-false">Add Button</div><div class="description req-false">Add an entry to the header table.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Delete Button</div><div class="description req-false">Delete the currently selected table entry.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Load Button</div><div class="description req-false">Load a previously saved header table and add the entries to the existing
header table entries.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Save As Button</div><div class="description req-false">Save the current header table to a file.</div><div class="required req-false">N/A</div></div>
</div>
<div class="example"><div class="title">Header Manager example<a class="sectionlink" href="#header_manager_example" title="Link to here">&para;</a></div>
<p><a href="../demos/HeaderManagerTestPlan.jmx">Download</a> this example. In this example, we created a Test Plan
that tells JMeter to override the default "User-Agent" request header and use a particular Internet Explorer agent string
instead. (see figures 12 and 13).</p>
<figure><a href="../images/screenshots/http-config/header-manager-example1a.gif"><img src="../images/screenshots/http-config/header-manager-example1a.gif" width="203" height="141" alt="Figure 12 - Test Plan"></a><figcaption>Figure 12 - Test Plan</figcaption></figure>
<figure><a href="../images/screenshots/http-config/header-manager-example1b.png"><img src="../images/screenshots/http-config/header-manager-example1b.png" width="" height="" alt="Figure 13 - Header Manager Control Panel"></a><figcaption>Figure 13 - Header Manager Control Panel</figcaption></figure>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Java_Request_Defaults">Java Request Defaults<a class="sectionlink" href="#Java_Request_Defaults" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/java_defaults.png"><img src="../images/screenshots/java_defaults.png" width="454" height="283" alt="Screenshot for Java Request Defaults"></a></div>
<div class="description"><p>The Java Request Defaults component lets you set default values for Java testing. See the <a href="../usermanual/component_reference.html#Java_Request">Java Request</a>.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JDBC_Connection_Configuration">JDBC Connection Configuration<a class="sectionlink" href="#JDBC_Connection_Configuration" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/jdbc-config/jdbc-conn-config.png"><img src="../images/screenshots/jdbc-config/jdbc-conn-config.png" width="474" height="458" alt="Screenshot for JDBC Connection Configuration"></a></div>
<div class="description">Creates a database connection (used by <a href="../usermanual/component_reference.html#JDBC_Request">JDBC Request</a>Sampler)
from the supplied JDBC Connection settings. The connection may be optionally pooled between threads.
Otherwise each thread gets its own connection.
The connection configuration name is used by the JDBC Sampler to select the appropriate
connection.
</div>
<div class="properties"><h3 id="JDBC_Connection_Configuration_parms1">
Parameters
<a class="sectionlink" href="#JDBC_Connection_Configuration_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for the connection configuration that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Variable Name</div><div class="description req-true">The name of the variable the connection is tied to.
Multiple connections can be used, each tied to a different variable, allowing JDBC Samplers
to select the appropriate connection.
<b>Each name must be different. If there are two configuration elements using the same name,
only one will be saved. JMeter versions after 2.3 log a message if a duplicate name is detected.</b>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Max Number of Connections</div><div class="description req-true">
Maximum number of connections allowed in the pool.
In most cases, <b>set this to zero (0)</b>.
This means that each thread will get its own pool with a single connection in it, i.e.
the connections are not shared betweeen threads.
<br>
If you really want to use shared pooling (why?), then set the max count to the same as the number of threads
to ensure threads don't wait on each other.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Pool timeout</div><div class="description req-true">Pool throws an error if the timeout period is exceeded in the
process of trying to retrieve a connection</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Idle Cleanup Interval (ms)</div><div class="description req-true">This is used to specify how long idle connections will be maintained in the pool before being closed. For a complete explanation on how this works, see <a href="http://excalibur.apache.org/apidocs/org/apache/avalon/excalibur/pool/ResourceLimitingPool.html#trim%28%29">ResourceLimitingPool.trim()</a> (Defaults to "60000", 1 minute)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Auto Commit</div><div class="description req-true">Turn auto commit on or off for the connections.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Keep-alive</div><div class="description req-true">The keep-alive is used enable a mechanism to monitor the health of connections. If a connection has not been used for Max Connection Age (ms) then before returning the connection from a call to getConnection(), the connection is first used to ping the database to make sure that it is still alive.
Setting the age allows the 5 second age to be overridden. Validation Query will be used to test it.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Max Connection Age (ms)</div><div class="description req-true">Controls the age mentionned in "Keep-Alive" property. It means connections not used for more than Max Connection Age will be tested</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Validation Query</div><div class="description req-true">A simple query used to determine if the database is still
responding.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Database URL</div><div class="description req-true">JDBC Connection string for the database.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">JDBC Driver class</div><div class="description req-true">Fully qualified name of driver class. (Must be in
JMeter's classpath - easiest to copy .jar file into JMeter's /lib directory).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">Name of user to connect as.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">Password to connect with. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
</div>
<p>Different databases and JDBC drivers require different JDBC settings.
The Database URL and JDBC Driver class are defined by the provider of the JDBC implementation.</p>
<p>Some possible settings are shown below. Please check the exact details in the JDBC driver documentation.</p>
<p>
If JMeter reports <b>No suitable driver</b>, then this could mean either:
<ul>
<li>The driver class was not found. In this case, there will be a log message such as <tt>DataSourceElement: Could not load driver: {classname} java.lang.ClassNotFoundException: {classname}</tt></li>
<li>The driver class was found, but the class does not support the connection string. This could be because of a syntax error in the connection string, or because the the wrong classname was used.</li>
</ul>
If the database server is not running or is not accessible, then JMeter will report a <b>java.net.ConnectException</b>.
</p>
<table>
<tr><th>Database</th><th>Driver class</th><th>Database URL</th></tr>
<tr><td>MySQL</td><td>com.mysql.jdbc.Driver</td><td>jdbc:mysql://host[:port]/dbname</td></tr>
<tr><td>PostgreSQL</td><td>org.postgresql.Driver</td><td>jdbc:postgresql:{dbname}</td></tr>
<tr><td>Oracle</td><td>oracle.jdbc.OracleDriver</td><td>jdbc:oracle:thin:@//host:port/service
OR<br>jdbc:oracle:thin:@(description=(address=(host={mc-name})(protocol=tcp)(port={port-no}))(connect_data=(sid={sid})))</td></tr>
<tr><td>Ingres (2006)</td><td>ingres.jdbc.IngresDriver</td><td>jdbc:ingres://host:port/db[;attr=value]</td></tr>
<tr><td>SQL Server (MS JDBC driver)</td><td>com.microsoft.sqlserver.jdbc.SQLServerDriver</td><td>jdbc:sqlserver://host:port;DatabaseName=dbname</td></tr>
<tr><td>Apache Derby</td><td>org.apache.derby.jdbc.ClientDriver</td><td>jdbc:derby://server[:port]/databaseName[;URLAttributes=value[;...]]</td></tr>
</table>
<div class="clear"></div><div class="note">The above may not be correct - please check the relevant JDBC driver documentation.</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Keystore_Configuration">Keystore Configuration<a class="sectionlink" href="#Keystore_Configuration" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/keystore_config.png"><img src="../images/screenshots/keystore_config.png" width="441" height="189" alt="Screenshot for Keystore Configuration"></a></div>
<div class="description"><p>The Keystore Config Element lets you configure how Keystore will be loaded and which keys it will use.
This component is typically used in HTTPS scenarios where you don't want to take into account keystore initialization into account in response time.</p>
<p>To use this element, you need to setup first a Java Key Store with the client certificates you want to test, to do that:
<ol>
<li>Create your certificates either with Java keytool utility or through your PKI</li>
<li>If created by PKI, import your keys in Java Key Store by converting them to a format acceptable by JKS</li>
<li>Then reference the keystore file through the 2 JVM properties (or add them in system.properties):
<ul>
<li>-Djavax.net.ssl.keyStore=path_to_keystore</li>
<li>-Djavax.net.ssl.keyStorePassword=password_of_keystore</li>
</ul>
</li>
</ol>
</p>
</div>
preload.shortDescription=Preload Keystore before test. Setting is to true is usually the best option.
startIndex.displayName=Alias Start index (0-based)
startIndex.shortDescription=First index of Alias in Keystore
endIndex.displayName=Alias End index (0-based)
endIndex.shortDescription=Last index of Alias in Keystore. When using Variable name ensure it is large enough so that all keys are loaded at startup.
clientCertAliasVarName.displayName=Variable name holding certificate alias
clientCertAliasVarName.shortDescription=Variable name that will contain the alias to use for Cert authentication. Var content can come from CSV Data Set.
<div class="properties"><h3 id="Keystore_Configuration_parms1">
Parameters
<a class="sectionlink" href="#Keystore_Configuration_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Preload</div><div class="description req-true">Wether or not to preload Keystore. Setting is to true is usually the best option.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Variable name holding certificate alias</div><div class="description req-false">Variable name that will contain the alias to use for authentication by client certificate. Variable value will be filled from CSV Data Set for example. In the screenshot, "certificat_ssl" will also be a variable in CSV Data Set.</div><div class="required req-false">False</div></div>
<div class="property"><div class="name req-true">Alias Start Index</div><div class="description req-true">The index of the first key to use in Keystore, 0-based.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Alias End Index</div><div class="description req-true">The index of the last key to use in Keystore, 0-based. When using "Variable name holding certificate alias" ensure it is large enough so that all keys are loaded at startup.</div><div class="required req-true">Yes</div></div>
</div>
<div class="clear"></div><div class="note">
To make JMeter use more than one certificate you need to ensure that:
<ul>
<li>https.use.cached.ssl.context=false is set in jmeter.properties or user.properties</li>
<li>You use either HTTPClient 3.1 or 4 implementations for HTTP Request</li>
</ul>
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Login_Config_Element">Login Config Element<a class="sectionlink" href="#Login_Config_Element" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/login-config.png"><img src="../images/screenshots/login-config.png" width="352" height="112" alt="Screenshot for Login Config Element"></a></div>
<div class="description"><p>The Login Config Element lets you add or override username and password settings in samplers that use username and password as part of their setup.</p>
</div>
<div class="properties"><h3 id="Login_Config_Element_parms1">
Parameters
<a class="sectionlink" href="#Login_Config_Element_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Username</div><div class="description req-false">The default username to use.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Password</div><div class="description req-false">The default password to use. (N.B. this is stored unencrypted in the test plan)</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="LDAP_Request_Defaults">LDAP Request Defaults<a class="sectionlink" href="#LDAP_Request_Defaults" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ldap_defaults.png"><img src="../images/screenshots/ldap_defaults.png" width="689" height="232" alt="Screenshot for LDAP Request Defaults"></a></div>
<div class="description"><p>The LDAP Request Defaults component lets you set default values for LDAP testing. See the <a href="../usermanual/component_reference.html#LDAP_Request">LDAP Request</a>.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="LDAP_Extended_Request_Defaults">LDAP Extended Request Defaults<a class="sectionlink" href="#LDAP_Extended_Request_Defaults" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/ldapext_defaults.png"><img src="../images/screenshots/ldapext_defaults.png" width="686" height="184" alt="Screenshot for LDAP Extended Request Defaults"></a></div>
<div class="description"><p>The LDAP Extended Request Defaults component lets you set default values for extended LDAP testing. See the <a href="../usermanual/component_reference.html#LDAP_Extended_Request">LDAP Extended Request</a>.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="TCP_Sampler_Config">TCP Sampler Config<a class="sectionlink" href="#TCP_Sampler_Config" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/tcpsamplerconfig.png"><img src="../images/screenshots/tcpsamplerconfig.png" width="826" height="450" alt="Screenshot for TCP Sampler Config"></a></div>
<div class="description">
<p>
The TCP Sampler Config provides default data for the TCP Sampler
</p>
</div>
<div class="properties"><h3 id="TCP_Sampler_Config_parms1">
Parameters
<a class="sectionlink" href="#TCP_Sampler_Config_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-false">TCPClient classname</div><div class="description req-false">Name of the TCPClient class. Defaults to the property tcp.handler, failing that TCPClientImpl.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">ServerName or IP</div><div class="description req-true">Name or IP of TCP server</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Port Number</div><div class="description req-true">Port to be used</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Re-use connection</div><div class="description req-true">If selected, the connection is kept open. Otherwise it is closed when the data has been read.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Close connection</div><div class="description req-true">If selected, the connection will be closed after running the sampler.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">SO_LINGER</div><div class="description req-false">Enable/disable SO_LINGER with the specified linger time in seconds when a socket is created. If you set "SO_LINGER" value as 0, you may prevent large numbers of sockets sitting around with a TIME_WAIT status.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">End of line(EOL) byte value</div><div class="description req-false">Byte value for end of line, set this to a value outside the range -128 to +127 to skip eol checking. You may set this in jmeter.properties file as well with eolByte property. If you set this in TCP Sampler Config and in jmeter.properties file at the same time, the setting value in the TCP Sampler Config will be used.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connect Timeout</div><div class="description req-false">Connect Timeout (milliseconds, 0 disables).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Response Timeout</div><div class="description req-false">Response Timeout (milliseconds, 0 disables).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Set Nodelay</div><div class="description req-true">Should the nodelay property be set?</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Text to Send</div><div class="description req-true">Text to be sent</div><div class="required req-true"></div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="User_Defined_Variables">User Defined Variables<a class="sectionlink" href="#User_Defined_Variables" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/user_defined_variables.png"><img src="../images/screenshots/user_defined_variables.png" width="741" height="266" alt="Screenshot for User Defined Variables"></a></div>
<div class="description"><p>The User Defined Variables element lets you define an <b>initial set of variables</b>, just as in the <a href="../usermanual/component_reference.html#Test_Plan">Test Plan</a>.
<b>
Note that all the UDV elements in a test plan - no matter where they are - are processed at the start.
</b>
So you cannot reference variables which are defined as part of a test run, e.g. in a Post-Processor.
</p>
<p>
<b>
UDVs should not be used with functions that generate different results each time they are called.
Only the result of the first function call will be saved in the variable.
</b>
However, UDVs can be used with functions such as __P(), for example:
<pre>
HOST ${__P(host,localhost)}
</pre>
which would define the variable "HOST" to have the value of the JMeter property "host", defaulting to "localhost" if not defined.
</p>
<p>
For defining variables during a test run, see <a href="../usermanual/component_reference.html#User_Parameters">User Parameters</a>.
UDVs are processed in the order they appear in the Plan, from top to bottom.
</p>
<p>
For simplicity, it is suggested that UDVs are placed only at the start of a Thread Group
(or perhaps under the Test Plan itself).
</p>
<p>
Once the Test Plan and all UDVs have been processed, the resulting set of variables is
copied to each thread to provide the initial set of variables.
</p>
<p>
If a runtime element such as a User Parameters Pre-Processor or Regular Expression Extractor defines a variable
with the same name as one of the UDV variables, then this will replace the initial value, and all other test
elements in the thread will see the updated value.
</p>
</div>
<div class="clear"></div><div class="note">
If you have more than one Thread Group, make sure you use different names for different values, as UDVs are shared between Thread Groups.
Also, the variables are not available for use until after the element has been processed,
so you cannot reference variables that are defined in the same element.
You can reference variables defined in earlier UDVs or on the Test Plan.
</div><div class="clear"></div>
<div class="properties"><h3 id="User_Defined_Variables_parms1">
Parameters
<a class="sectionlink" href="#User_Defined_Variables_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">User Defined Variables</div><div class="description req-true">Variable name/value pairs. The string under the "Name"
column is what you'll need to place inside the brackets in ${...} constructs to use the variables later on. The
whole ${...} will then be replaced by the string in the "Value" column.</div><div class="required req-true"></div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Random_Variable">Random Variable<a class="sectionlink" href="#Random_Variable" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/random_variable.png"><img src="../images/screenshots/random_variable.png" width="495" height="286" alt="Screenshot for Random Variable"></a></div>
<div class="description">
<p>
The Random Variable Config Element is used to generate random numeric strings and store them in variable for use later.
It's simpler than using <a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> together with the __Random() function.
</p>
<p>
The output variable is constructed by using the random number generator,
and then the resulting number is formatted using the format string.
The number is calculated using the formula <span class="code">minimum+Random.nextInt(maximum-minimum+1)</span>.
Random.nextInt() requires a positive integer.
This means that maximum-minimum - i.e. the range - must be less than 2147483647,
however the minimum and maximum values can be any long values so long as the range is OK.
</p>
</div>
<div class="properties"><h3 id="Random_Variable_parms1">
Parameters
<a class="sectionlink" href="#Random_Variable_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Variable Name</div><div class="description req-true">The name of the variable in which to store the random string.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Format String</div><div class="description req-false">The java.text.DecimalFormat format string to be used.
For example "000" which will generate numbers with at least 3 digits,
or "USER_000" which will generate output of the form USER_nnn.
If not specified, the default is to generate the number using Long.toString()</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Minimum Value</div><div class="description req-true">The minimum value (long) of the generated random number.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Maximum Value</div><div class="description req-true">The maximum value (long) of the generated random number.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Random Seed</div><div class="description req-false">The seed for the random number generator. Default is the current time in milliseconds.
If you use the same seed value with Per Thread set to true, you will get the same value for earch Thread as per
<a href="http://docs.oracle.com/javase/6/docs/api/java/util/Random.html">Random</a> class.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Per Thread(User)?</div><div class="description req-true">If False, the generator is shared between all threads in the thread group.
If True, then each thread has its own random generator.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Counter">Counter<a class="sectionlink" href="#Counter" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/counter.png"><img src="../images/screenshots/counter.png" width="404" height="262" alt="Screenshot for Counter"></a></div>
<div class="description"><p>Allows the user to create a counter that can be referenced anywhere
in the Thread Group. The counter config lets the user configure a starting point, a maximum,
and the increment. The counter will loop from the start to the max, and then start over
with the start, continuing on like that until the test is ended. </p>
<p>From version 2.1.2, the counter now uses a long to store the value, so the range is from -2^63 to 2^63-1.</p>
</div>
<div class="properties"><h3 id="Counter_parms1">
Parameters
<a class="sectionlink" href="#Counter_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Start</div><div class="description req-true">The starting number for the counter. The counter will equal this
number during the first iteration.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Increment</div><div class="description req-true">How much to increment the counter by after each
iteration.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Maximum</div><div class="description req-false">If the counter exceeds the maximum, then it is reset to the Start value.
For versions after 2.2 the default is Long.MAX_VALUE (previously it was 0).
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Format</div><div class="description req-false">Optional format, e.g. 000 will format as 001, 002 etc.
This is passed to DecimalFormat, so any valid formats can be used.
If there is a problem interpreting the format, then it is ignored.
[The default format is generated using Long.toString()]
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Reference Name</div><div class="description req-true">This controls how you refer to this value in other elements. Syntax is
as in <a href="functions.html">user-defined values</a>: <span class="code">$(reference_name}</span>.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Track Counter Independently for each User</div><div class="description req-false">In other words, is this a global counter, or does each user get their
own counter? If unchecked, the counter is global (ie, user #1 will get value "1", and user #2 will get value "2" on
the first iteration). If checked, each user has an independent counter.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Reset counter on each Thread Group Iteration</div><div class="description req-false">This option is only available when counter is tracked per User, if checked,
counter will be reset to Start value on each Thread Group iteration. This can be useful when Counter is inside a Loop Controller.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Simple_Config_Element">Simple Config Element<a class="sectionlink" href="#Simple_Config_Element" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/simple_config_element.png"><img src="../images/screenshots/simple_config_element.png" width="393" height="245" alt="Screenshot for Simple Config Element"></a></div>
<div class="description"><p>The Simple Config Element lets you add or override arbitrary values in samplers. You can choose the name of the value
and the value itself. Although some adventurous users might find a use for this element, it's here primarily for developers as a basic
GUI that they can use while developing new JMeter components.</p>
</div>
<div class="properties"><h3 id="Simple_Config_Element_parms1">
Parameters
<a class="sectionlink" href="#Simple_Config_Element_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree. </div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameter Name</div><div class="description req-true">The name of each parameter. These values are internal to JMeter's workings and
are not generally documented. Only those familiar with the code will know these values.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameter Value</div><div class="description req-true">The value to apply to that parameter.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="MongoDB_Source_Config">MongoDB Source Config<a class="sectionlink" href="#MongoDB_Source_Config" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/mongodb-source-config.png"><img src="../images/screenshots/mongodb-source-config.png" width="1233" height="618" alt="Screenshot for MongoDB Source Config"></a></div>
<div class="description">Creates a MongoDB connection (used by <a href="../usermanual/component_reference.html#MongoDB_Script">MongoDB Script</a>Sampler)
from the supplied Connection settings. Each thread gets its own connection.
The connection configuration name is used by the JDBC Sampler to select the appropriate
connection.
You can then access com.mongodb.DB object in Beanshell or JSR223 Test Elements through the element <a href="../api/org/apache/jmeter/protocol/mongodb/config/MongoDBHolder.html">MongoDBHolder</a>
using this code<br>
<pre class="source">
import com.mongodb.DB;
import org.apache.jmeter.protocol.mongodb.config.MongoDBHolder;
DB db = MongoDBHolder.getDBFromSource("value of property MongoDB Source",
"value of property Database Name");
...
</pre>
</div>
<div class="properties"><h3 id="MongoDB_Source_Config_parms1">
Parameters
<a class="sectionlink" href="#MongoDB_Source_Config_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for the connection configuration that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Server Address List</div><div class="description req-true">Mongo DB Servers</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">MongoDB Source</div><div class="description req-true">The name of the variable the connection is tied to.
<div class="clear"></div><div class="note">Each name must be different. If there are two configuration elements using the same name, only one will be saved.</div><div class="clear"></div>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Keep Trying</div><div class="description req-false">
If true, the driver will keep trying to connect to the same server in case that the socket cannot be established.<br>
There is maximum amount of time to keep retrying, which is 15s by default.<br>This can be useful to avoid some exceptions being thrown when a server is down temporarily by blocking the operations.
<br>It also can be useful to smooth the transition to a new master (so that a new master is elected within the retry time).<br>
Note that when using this flag\:
<br>- for a replica set, the driver will trying to connect to the old master for that time, instead of failing over to the new one right away
<br>- this does not prevent exception from being thrown in read/write operations on the socket, which must be handled by application.<br>
Even if this flag is false, the driver already has mechanisms to automatically recreate broken connections and retry the read operations. <br>
Default is false.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Maximum connections per host</div><div class="description req-false"></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Connection timeout</div><div class="description req-false">
The connection timeout in milliseconds.<br>It is used solely when establishing a new connection Socket.connect(java.net.SocketAddress, int)<br>Default is 0 and means no timeout.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Maximum retry time</div><div class="description req-false">
The maximum amount of time in MS to spend retrying to open connection to the same server.<br>Default is 0, which means to use the default 15s if autoConnectRetry is on.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Maximum wait time</div><div class="description req-false">
The maximum wait time in ms that a thread may wait for a connection to become available.<br>Default is 120,000.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Socket timeout</div><div class="description req-false">
The socket timeout in milliseconds It is used for I/O socket read and write operations Socket.setSoTimeout(int)<br>Default is 0 and means no timeout.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Socket keep alive</div><div class="description req-false">
This flag controls the socket keep alive feature that keeps a connection alive through firewalls Socket.setKeepAlive(boolean)<br>
Default is false.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">ThreadsAllowedToBlockForConnectionMultiplier</div><div class="description req-false">
This multiplier, multiplied with the connectionsPerHost setting, gives the maximum number of threads that may be waiting for a connection to become available from the pool.<br>
All further threads will get an exception right away.<br>
For example if connectionsPerHost is 10 and threadsAllowedToBlockForConnectionMultiplier is 5, then up to 50 threads can wait for a connection.<br>
Default is 5.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Safe</div><div class="description req-false">
If true the driver will use a WriteConcern of WriteConcern.SAFE for all operations.<br>
If w, wtimeout, fsync or j are specified, this setting is ignored.<br>
Default is false.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Fsync</div><div class="description req-false">
The fsync value of the global WriteConcern.<br>
Default is false.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Wait for Journal</div><div class="description req-false">
The j value of the global WriteConcern.<br>
Default is false.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Wait for servers</div><div class="description req-false">
The w value of the global WriteConcern.<br>Default is 0.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Wait timeout</div><div class="description req-false">
The wtimeout value of the global WriteConcern.<br>Default is 0.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Write Concern : Continue on error</div><div class="description req-false">
If batch inserts should continue after the first error
</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="assertions">18.5 Assertions<a class="sectionlink" href="#assertions" title="Link to here">&para;</a></h1>
<div class="description">
<p>
Assertions are used to perform additional checks on samplers, and are processed after <b>every sampler</b>
in the same scope.
To ensure that an Assertion is applied only to a particular sampler, add it as a child of the sampler.
</p>
<p>
Note: Unless documented otherwise, Assertions are not applied to sub-samples (child samples) -
only to the parent sample.
In the case of BSF and BeanShell Assertions, the script can retrieve sub-samples using the method
<span class="code">prev.getSubResults()</span> which returns an array of SampleResults.
The array will be empty if there are none.
</p>
<p>
Versions of JMeter after 2.3.2 include the option to apply certain assertions
to either the main sample, the sub-samples or both.
The default is to apply the assertion to the main sample only.
If the Assertion supports this option, then there will be an entry on the GUI which looks like the following:
<figure><a href="../images/screenshots/assertion/assertionscope.png"><img src="../images/screenshots/assertion/assertionscope.png" width="658" height="54" alt="Assertion Scope"></a><figcaption>Assertion Scope</figcaption></figure>
or the following
<figure><a href="../images/screenshots/assertion/assertionscopevar.png"><img src="../images/screenshots/assertion/assertionscopevar.png" width="841" height="55" alt="Assertion Scope"></a><figcaption>Assertion Scope</figcaption></figure>
If a sub-sampler fails and the main sample is successful,
then the main sample will be set to failed status and an Assertion Result will be added.
If the JMeter variable option is used, it is assumed to relate to the main sample, and
any failure will be applied to the main sample only.
</p>
<div class="clear"></div><div class="note">
The variable <b>JMeterThread.last_sample_ok</b> is updated to
"true" or "false" after all assertions for a sampler have been run.
</div><div class="clear"></div>
</div>
<div class="component"><h2 id="Response_Assertion">Response Assertion<a class="sectionlink" href="#Response_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/assertion.png"><img src="../images/screenshots/assertion/assertion.png" width="921" height="423" alt="Screenshot for Response Assertion"></a></div>
<div class="description"><p>The response assertion control panel lets you add pattern strings to be compared against various
fields of the response.
The pattern strings are:
<ul>
<li>Contains, Matches: Perl5-style regular expressions</li>
<li>Equals, Substring: plain text, case-sensitive</li>
</ul>
</p>
<p>
A summary of the pattern matching characters can be found at <a href="http://jakarta.apache.org/oro/api/org/apache/oro/text/regex/package-summary.html">ORO Perl5 regular expressions.</a>
</p>
<p>You can also choose whether the strings will be expected
to <b>match</b> the entire response, or if the response is only expected to <b>contain</b> the
pattern. You can attach multiple assertions to any controller for additional flexibility.</p>
<p>Note that the pattern string should not include the enclosing delimiters,
i.e. use <b>Price: \d+</b> not <b>/Price: \d+/</b>.
</p>
<p>
By default, the pattern is in multi-line mode, which means that the "." meta-character does not match newline.
In multi-line mode, "^" and "$" match the start or end of any line anywhere within the string
- not just the start and end of the entire string. Note that \s does match new-line.
Case is also significant. To override these settings, one can use the <i>extended regular expression</i> syntax.
For example:
</p>
<dl>
<dt><span class="code">(?i)</span></dt><dd>ignore case</dd>
<dt><span class="code">(?s)</span></dt><dd>treat target as single line, i.e. "." matches new-line</dd>
<dt><span class="code">(?is)</span></dt><dd>both the above</dd>
</dl>
These can be used anywhere within the expression and remain in effect until overriden. e.g.
<dl>
<dt><span class="code">(?i)apple(?-i) Pie</span></dt><dd>matches "ApPLe Pie", but not "ApPLe pIe"</dd>
<dt><span class="code">(?s)Apple.+?Pie</span></dt><dd>matches Apple followed by Pie, which may be on a subsequent line.</dd>
<dt><span class="code">Apple(?s).+?Pie</span></dt><dd>same as above, but it's probably clearer to use the (?s) at the start.</dd>
</dl>
</div>
<div class="properties"><h3 id="Response_Assertion_parms1">
Parameters
<a class="sectionlink" href="#Response_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Apply to:</div><div class="description req-true">
This is for use with samplers that can generate sub-samples,
e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the Transaction Controller.
<ul>
<li>Main sample only - assertion only applies to the main sample</li>
<li>Sub-samples only - assertion only applies to the sub-samples</li>
<li>Main sample and sub-samples - assertion applies to both.</li>
<li>JMeter Variable - assertion is to be applied to the contents of the named variable</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Response Field to Test</div><div class="description req-true">Instructs JMeter which field of the Response to test.
<ul>
<li>Text Response - the response text from the server, i.e. the body, excluding any HTTP headers.</li>
<li>Document (text) - the extract text from various type of documents via Apache Tika (see <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Document view section).</li>
<li>URL sampled</li>
<li>Response Code - e.g. 200</li>
<li>Response Message - e.g. OK</li>
<li>Response Headers, including Set-Cookie headers (if any)</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Ignore status</div><div class="description req-true">Instructs JMeter to set the status to success initially.
<p>
The overall success of the sample is determined by combining the result of the
assertion with the existing Response status.
When the Ignore Status checkbox is selected, the Response status is forced
to successful before evaluating the Assertion.
</p>
HTTP Responses with statuses in the 4xx and 5xx ranges are normally
regarded as unsuccessful.
The "Ignore status" checkbox can be used to set the status successful before performing further checks.
Note that this will have the effect of clearing any previous assertion failures,
so make sure that this is only set on the first assertion.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Pattern Matching Rules</div><div class="description req-true">Indicates how the text being tested
is checked against the pattern.
<ul>
<li>Contains - true if the text contains the regular expression pattern</li>
<li>Matches - true if the whole text matches the regular expression pattern</li>
<li>Equals - true if the whole text equals the pattern string (case-sensitive)</li>
<li>Substring - true if the text contains the pattern string (case-sensitive)</li>
</ul>
Equals and Substring patterns are plain strings, not regular expressions.
NOT may also be selected to invert the result of the check.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Patterns to Test</div><div class="description req-true">A list of patterns to
be tested.
Each pattern is tested separately.
If a pattern fails, then further patterns are not checked.
There is no difference between setting up
one Assertion with multiple patterns and setting up multiple Assertions with one
pattern each (assuming the other options are the same).
<b>However, when the Ignore Status checkbox is selected, this has the effect of cancelling any
previous assertion failures - so make sure that the Ignore Status checkbox is only used on
the first Assertion.</b>
</div><div class="required req-true">Yes</div></div>
</div>
<p>
The pattern is a Perl5-style regular expression, but without the enclosing brackets.
</p>
<div class="example"><div class="title">Assertion Examples<a class="sectionlink" href="#assertion_examples" title="Link to here">&para;</a></div>
<center>
<figure><a href="../images/screenshots/assertion/example1a.png"><img src="../images/screenshots/assertion/example1a.png" width="242" height="123" alt="Figure 14 - Test Plan"></a><figcaption>Figure 14 - Test Plan</figcaption></figure>
<figure><a href="../images/screenshots/assertion/example1b.png"><img src="../images/screenshots/assertion/example1b.png" width="920" height="451" alt="Figure 15 - Assertion Control Panel with Pattern"></a><figcaption>Figure 15 - Assertion Control Panel with Pattern</figcaption></figure>
<figure><a href="../images/screenshots/assertion/example1c-pass.png"><img src="../images/screenshots/assertion/example1c-pass.png" width="801" height="230" alt="Figure 16 - Assertion Listener Results (Pass)"></a><figcaption>Figure 16 - Assertion Listener Results (Pass)</figcaption></figure>
<figure><a href="../images/screenshots/assertion/example1c-fail.png"><img src="../images/screenshots/assertion/example1c-fail.png" width="800" height="233" alt="Figure 17 - Assertion Listener Results (Fail)"></a><figcaption>Figure 17 - Assertion Listener Results (Fail)</figcaption></figure>
</center>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Duration_Assertion">Duration Assertion<a class="sectionlink" href="#Duration_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/duration_assertion.png"><img src="../images/screenshots/duration_assertion.png" width="606" height="187" alt="Screenshot for Duration Assertion"></a></div>
<div class="description"><p>The Duration Assertion tests that each response was received within a given amount
of time. Any response that takes longer than the given number of milliseconds (specified by the
user) is marked as a failed response.</p></div>
<div class="properties"><h3 id="Duration_Assertion_parms1">
Parameters
<a class="sectionlink" href="#Duration_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Duration in Milliseconds</div><div class="description req-true">The maximum number of milliseconds
each response is allowed before being marked as failed.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Size_Assertion">Size Assertion<a class="sectionlink" href="#Size_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/size_assertion.png"><img src="../images/screenshots/size_assertion.png" width="732" height="358" alt="Screenshot for Size Assertion"></a></div>
<div class="description"><p>The Size Assertion tests that each response contains the right number of bytes in it. You can specify that
the size be equal to, greater than, less than, or not equal to a given number of bytes.</p>
<div class="clear"></div><div class="note">Since JMeter 2.3RC3, an empty response is treated as being 0 bytes rather than reported as an error.</div><div class="clear"></div>
</div>
<div class="properties"><h3 id="Size_Assertion_parms1">
Parameters
<a class="sectionlink" href="#Size_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Apply to:</div><div class="description req-true">
This is for use with samplers that can generate sub-samples,
e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the Transaction Controller.
<ul>
<li>Main sample only - assertion only applies to the main sample</li>
<li>Sub-samples only - assertion only applies to the sub-samples</li>
<li>Main sample and sub-samples - assertion applies to both.</li>
<li>JMeter Variable - assertion is to be applied to the contents of the named variable</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Size in bytes</div><div class="description req-true">The number of bytes to use in testing the size of the response (or value of the JMeter variable).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Type of Comparison</div><div class="description req-true">Whether to test that the response is equal to, greater than, less than,
or not equal to, the number of bytes specified.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="XML_Assertion">XML Assertion<a class="sectionlink" href="#XML_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/xml_assertion.png"><img src="../images/screenshots/xml_assertion.png" width="470" height="85" alt="Screenshot for XML Assertion"></a></div>
<div class="description"><p>The XML Assertion tests that the response data consists of a formally correct XML document. It does not
validate the XML based on a DTD or schema or do any further validation.</p></div>
<div class="properties"><h3 id="XML_Assertion_parms1">
Parameters
<a class="sectionlink" href="#XML_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_Assertion">BeanShell Assertion<a class="sectionlink" href="#BeanShell_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/beanshell_assertion.png"><img src="../images/screenshots/beanshell_assertion.png" width="849" height="633" alt="Screenshot for BeanShell Assertion"></a></div>
<div class="description"><p>The BeanShell Assertion allows the user to perform assertion checking using a BeanShell script.
</p>
<p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p><p>
Note that a different Interpreter is used for each independent occurence of the assertion
in each thread in a test script, but the same Interpreter is used for subsequent invocations.
This means that variables persist across calls to the assertion.
</p>
<p>
All Assertions are called from the same thread as the sampler.
</p>
<p>
If the property "beanshell.assertion.init" is defined, it is passed to the Interpreter
as the name of a sourced file. This can be used to define common methods and variables.
There is a sample init file in the bin directory: BeanShellAssertion.bshrc
</p>
<p>
The test element supports the ThreadListener and TestListener methods.
These should be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
</div>
<div class="properties"><h3 id="BeanShell_Assertion_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the BeanShell script to run. This overrides the script.
The file name is stored in the script variable FileName</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The BeanShell script to run. The return value is ignored.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>There's a <a href="../demos/BeanShellAssertion.bsh">sample script</a> you can try.</p>
<p>
Before invoking the script, some variables are set up in the BeanShell interpreter.
These are strings unless otherwise noted:
<ul>
<li>log - the Logger Object. (e.g.) log.warn("Message"[,Throwable])</li>
<li>SampleResult - the <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a> Object; read-write</li>
<li>Response - the response Object; read-write</li>
<li>Failure - boolean; read-write; used to set the Assertion status</li>
<li>FailureMessage - String; read-write; used to set the Assertion message</li>
<li>ResponseData - the response body (byte [])</li>
<li>ResponseCode - e.g. 200</li>
<li>ResponseMessage - e.g. OK</li>
<li>ResponseHeaders - contains the HTTP headers</li>
<li>RequestHeaders - contains the HTTP headers sent to the server</li>
<li>SampleLabel</li>
<li>SamplerData - data that was sent to the server</li>
<li>ctx - <a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a></li>
<li>vars - <a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a> - e.g. vars.get("VAR1"); vars.put("VAR2","value"); vars.putObject("OBJ1",new Object());</li>
<li>props - JMeterProperties (class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
</ul>
</p>
<p>The following methods of the Response object may be useful:
<ul>
<li>setStopThread(boolean)</li>
<li>setStopTest(boolean)</li>
<li>String getSampleLabel()</li>
<li>setSampleLabel(String)</li>
</ul></p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="MD5Hex_Assertion">MD5Hex Assertion<a class="sectionlink" href="#MD5Hex_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/MD5HexAssertion.png"><img src="../images/screenshots/assertion/MD5HexAssertion.png" width="411" height="149" alt="Screenshot for MD5Hex Assertion"></a></div>
<div class="description"><p>The MD5Hex Assertion allows the user to check the MD5 hash of the response data.</p></div>
<div class="properties"><h3 id="MD5Hex_Assertion_parms1">
Parameters
<a class="sectionlink" href="#MD5Hex_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">MD5 sum</div><div class="description req-true">32 hex digits representing the MD5 hash (case not significant)</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTML_Assertion">HTML Assertion<a class="sectionlink" href="#HTML_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/HTMLAssertion.png"><img src="../images/screenshots/assertion/HTMLAssertion.png" width="464" height="384" alt="Screenshot for HTML Assertion"></a></div>
<div class="description"><p>The HTML Assertion allows the user to check the HTML syntax of the response data using JTidy.</p></div>
<div class="properties"><h3 id="HTML_Assertion_parms1">
Parameters
<a class="sectionlink" href="#HTML_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">doctype</div><div class="description req-true">omit/auto/strict/loose</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Format</div><div class="description req-true">HTML, XHTML or XML</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Errors only</div><div class="description req-true">Only take note of errors?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Error threshold</div><div class="description req-true">Number of errors allowed before classing the response as failed</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Warning threshold</div><div class="description req-true">Number of warnings allowed before classing the response as failed</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Filename</div><div class="description req-false">Name of file to which report is written</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="XPath_Assertion">XPath Assertion<a class="sectionlink" href="#XPath_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/xpath_assertion.png"><img src="../images/screenshots/xpath_assertion.png" width="800" height="317" alt="Screenshot for XPath Assertion"></a></div>
<div class="description"><p>The XPath Assertion tests a document for well formedness, has the option
of validating against a DTD, or putting the document through JTidy and testing for an
XPath. If that XPath exists, the Assertion is true. Using "/" will match any well-formed
document, and is the default XPath Expression.
The assertion also supports boolean expressions, such as "count(//*error)=2".
See <a href="http://www.w3.org/TR/xpath">http://www.w3.org/TR/xpath</a> for more information
on XPath.
</p>
Some sample expressions:
<ul>
<li>//title[text()='Text to match'] - matches &lt;text&gt;Text to match&lt;/text&gt; anywhere in the response</li>
<li>/title[text()='Text to match'] - matches &lt;text&gt;Text to match&lt;/text&gt; at root level in the response</li>
</ul>
</div>
<div class="properties"><h3 id="XPath_Assertion_parms1">
Parameters
<a class="sectionlink" href="#XPath_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Use Tidy (tolerant parser)</div><div class="description req-true">Use Tidy, i.e. be tolerant of XML/HTML errors</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Quiet</div><div class="description req-false">Sets the Tidy Quiet flag</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Report Errors</div><div class="description req-false">If a Tidy error occurs, then set the Assertion accordingly</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Show warnings</div><div class="description req-false">Sets the Tidy showWarnings option</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Use Namespaces</div><div class="description req-false">Should namespaces be honoured?</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Validate XML</div><div class="description req-false">Check the document against its schema.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Ignore Whitespace</div><div class="description req-false">Ignore Element Whitespace.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Fetch External DTDs</div><div class="description req-false">If selected, external DTDs are fetched.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-true">XPath Assertion</div><div class="description req-true">XPath to match in the document.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">True if nothing matches</div><div class="description req-false">True if a XPath expression is not matched</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
The non-tolerant parser can be quite slow, as it may need to download the DTD etc.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
As a work-round for namespace limitations of the Xalan XPath parser implementation on which JMeter is based,
you can provide a Properties file which contains mappings for the namespace prefixes:
<ul>
<li>prefix1=Full Namespace 1</li>
<li>prefix2=Full Namespace 2</li>
<li>...</li>
</ul>
You reference this file in jmeter.properties file using the property:
<ul>
<li>xpath.namespace.config</li>
</ul>
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="XML_Schema_Assertion">XML Schema Assertion<a class="sectionlink" href="#XML_Schema_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/XMLSchemaAssertion.png"><img src="../images/screenshots/assertion/XMLSchemaAssertion.png" width="472" height="132" alt="Screenshot for XML Schema Assertion"></a></div>
<div class="description"><p>The XML Schema Assertion allows the user to validate a response against an XML Schema.</p></div>
<div class="properties"><h3 id="XML_Schema_Assertion_parms1">
Parameters
<a class="sectionlink" href="#XML_Schema_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">File Name</div><div class="description req-true">Specify XML Schema File Name</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_Assertion">BSF Assertion<a class="sectionlink" href="#BSF_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/bsf_assertion.png"><img src="../images/screenshots/bsf_assertion.png" width="847" height="634" alt="Screenshot for BSF Assertion"></a></div>
<div class="description">
<p>
The BSF Assertion allows BSF script code to be used to check the status of the previous sample.
</p>
</div>
<div class="properties"><h3 id="BSF_Assertion_parms1">
Parameters
<a class="sectionlink" href="#BSF_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Language</div><div class="description req-true">The BSF language to be used</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The script to run.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
The script (or file) is processed using the BSFEngine.exec() method, which does not return a value.
</p>
<p>The following variables are set up for use by the script:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>Label - the String Label</li>
<li>Filename - the script file name (if any)</li>
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>SampleResult, prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous SampleResult (if any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
<li>AssertionResult - the assertion result</li>
</ul>
<p>
The script can check various aspects of the <a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>.
If an error is detected, the script should use AssertionResult.setFailureMessage("message") and AssertionResult.setFailure(true).
</p>
<p>For futher details of all the methods available on each of the above variables, please check the Javadoc</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_Assertion">JSR223 Assertion<a class="sectionlink" href="#JSR223_Assertion" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JSR223 Assertion allows JSR223 script code to be used to check the status of the previous sample.
For details, see <a href="../usermanual/component_reference.html#BSF_Assertion">BSF Assertion</a>.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Compare_Assertion">Compare Assertion<a class="sectionlink" href="#Compare_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/compare.png"><img src="../images/screenshots/assertion/compare.png" width="292" height="296" alt="Screenshot for Compare Assertion"></a></div>
<div class="description">
<div class="clear"></div><div class="note">
Compare Assertion MUST NOT BE USED during load test as it consumes a lot of resources (memory and CPU). Use it only for either functional testing or
during Test Plan debugging and Validation.
</div><div class="clear"></div>
The Compare Assertion can be used to compare sample results within its scope.
Either the contents or the elapsed time can be compared, and the contents can be filtered before comparison.
The assertion comparisons can be seen in the <a href="../usermanual/component_reference.html#Comparison_Assertion_Visualizer">Comparison Assertion Visualizer</a>.
</div>
<div class="properties"><h3 id="Compare_Assertion_parms1">
Parameters
<a class="sectionlink" href="#Compare_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Compare Content</div><div class="description req-true">Whether or not to compare the content (response data)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Compare Time</div><div class="description req-true">If the value is &gt;=0, then check if the response time difference is no greater than the value.
I.e. if the value is 0, then the response times must be exactly equal.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Comparison Filters</div><div class="description req-false">Filters can be used to remove strings from the content comparison.
For example, if the page has a time-stamp, it might be matched with: "Time: \d\d:\d\d:\d\d" and replaced with a dummy fixed time "Time: HH:MM:SS".
</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="SMIME_Assertion">SMIME Assertion<a class="sectionlink" href="#SMIME_Assertion" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/assertion/smime.png"><img src="../images/screenshots/assertion/smime.png" width="471" height="428" alt="Screenshot for SMIME Assertion"></a></div>
<div class="description">
The SMIME Assertion can be used to evaluate the sample results from the Mail Reader Sampler.
This assertion verifies if the body of a mime message is signed or not. The signature can also be verified against a specific signer certificate.
As this is a functionality that is not necessarily needed by most users, additional jars need to be downloaded and added to JMETER_HOME/lib :<br>
<ul>
<li>bcmail-xxx.jar (BouncyCastle SMIME/CMS)</li>
<li>bcprov-xxx.jar (BouncyCastle Provider)</li>
</ul>
These need to be <a href="http://www.bouncycastle.org/latest_releases.html">downloaded from BouncyCastle.</a>
<p>
If using the <a href="../usermanual/component_reference.html#Mail_Reader_Sampler">Mail Reader Sampler</a>,
please ensure that you select "Store the message using MIME (raw)" otherwise the Assertion won't be able to process the message correctly.
</p>
</div>
<div class="properties"><h3 id="SMIME_Assertion_parms1">
Parameters
<a class="sectionlink" href="#SMIME_Assertion_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Verify Signature</div><div class="description req-true">If selected, the asertion will verify if it is a valid signature according to the parameters defined in the Signer Certificate box.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Message not signed</div><div class="description req-true">Whether or not to expect a signature in the message</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Signer Cerificate</div><div class="description req-true">"No Check" means that it wil not perform signature verification. "Check values" is used to verify the signature against the inputs provided. And "Certificate file" will perform the verification against a specific certificate file.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Message Position</div><div class="description req-true">
The Mail sampler can retrieve multiple messages in a single sample.
Use this field to specify which message will be checked.
Messages are numbered from 0, so 0 means the first message.
Negative numbers count from the LAST message; -1 means LAST, -2 means penultimate etc.
</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="timers">18.6 Timers<a class="sectionlink" href="#timers" title="Link to here">&para;</a></h1>
<div class="description">
<br>
<p>
Note that timers are processed <b>before</b> each sampler in the scope in which they are found;
if there are several timers in the same scope, <b>all</b> the timers will be processed <b>before
each</b> sampler.
<br>
Timers are only processed in conjunction with a sampler.
A timer which is not in the same scope as a sampler will not be processed at all.
<br>
To apply a timer to a single sampler, add the timer as a child element of the sampler.
The timer will be applied before the sampler is executed.
To apply a timer after a sampler, either add it to the next sampler, or add it as the
child of a <a href="../usermanual/component_reference.html#Test_Action">Test Action</a> Sampler.
</p>
</div>
<div class="component"><h2 id="Constant_Timer">Constant Timer<a class="sectionlink" href="#Constant_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/constant_timer.png"><img src="../images/screenshots/timers/constant_timer.png" width="372" height="100" alt="Screenshot for Constant Timer"></a></div>
<div class="description">
<p>If you want to have each thread pause for the same amount of time between
requests, use this timer.</p></div>
<div class="properties"><h3 id="Constant_Timer_parms1">
Parameters
<a class="sectionlink" href="#Constant_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Thread Delay</div><div class="description req-true">Number of milliseconds to pause.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Gaussian_Random_Timer">Gaussian Random Timer<a class="sectionlink" href="#Gaussian_Random_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/gauss_random_timer.png"><img src="../images/screenshots/timers/gauss_random_timer.png" width="372" height="156" alt="Screenshot for Gaussian Random Timer"></a></div>
<div class="description"><p>This timer pauses each thread request for a random amount of time, with most
of the time intervals ocurring near a particular value.
The total delay is the sum of the Gaussian distributed value (with mean 0.0 and standard deviation 1.0) times
the deviation value you specify, and the offset value.
Another way to explain it, in Gaussian Random Timer, the variation around constant offset has a gaussian curve distribution.
</p></div>
<div class="properties"><h3 id="Gaussian_Random_Timer_parms1">
Parameters
<a class="sectionlink" href="#Gaussian_Random_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Deviation</div><div class="description req-true">Deviation in milliseconds.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Constant Delay Offset</div><div class="description req-true">Number of milliseconds to pause in addition
to the random delay.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Uniform_Random_Timer">Uniform Random Timer<a class="sectionlink" href="#Uniform_Random_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/uniform_random_timer.png"><img src="../images/screenshots/timers/uniform_random_timer.png" width="372" height="157" alt="Screenshot for Uniform Random Timer"></a></div>
<div class="description"><p>This timer pauses each thread request for a random amount of time, with
each time interval having the same probability of occurring. The total delay
is the sum of the random value and the offset value.</p></div>
<div class="properties"><h3 id="Uniform_Random_Timer_parms1">
Parameters
<a class="sectionlink" href="#Uniform_Random_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Random Delay Maximum</div><div class="description req-true">Maxium random number of milliseconds to
pause.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Constant Delay Offset</div><div class="description req-true">Number of milliseconds to pause in addition
to the random delay.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Constant_Throughput_Timer">Constant Throughput Timer<a class="sectionlink" href="#Constant_Throughput_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/constant_throughput_timer.png"><img src="../images/screenshots/timers/constant_throughput_timer.png" width="636" height="146" alt="Screenshot for Constant Throughput Timer"></a></div>
<div class="description"><p>This timer introduces variable pauses, calculated to keep the total throughput (in terms of samples per minute) as close as possible to a give figure. Of course the throughput will be lower if the server is not capable of handling it, or if other timers or time-consuming test elements prevent it.</p>
<p>
N.B. although the Timer is called the Constant Throughput timer, the throughput value does not need to be constant.
It can be defined in terms of a variable or function call, and the value can be changed during a test.
The value can be changed in various ways:
</p>
<ul>
<li>using a counter variable</li>
<li>using a JavaScript or BeanShell function to provide a changing value</li>
<li>using the remote BeanShell server to change a JMeter property</li>
</ul>
<p>See <a href="best-practices.html">Best Practices</a> for further details.
Note that the throughput value should not be changed too often during a test
- it will take a while for the new value to take effect.
</p>
</div>
<div class="properties"><h3 id="Constant_Throughput_Timer_parms1">
Parameters
<a class="sectionlink" href="#Constant_Throughput_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Target Throughput</div><div class="description req-true">Throughput we want the timer to try to generate.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Calculate Throughput based on</div><div class="description req-true">
<ul>
<li>this thread only - each thread will try to maintain the target throughput. The overall throughput will be proportional to the number of active threads.</li>
<li>all active threads in current thread group - the target throughput is divided amongst all the active threads in the group.
Each thread will delay as needed, based on when it last ran.</li>
<li>all active threads - the target throughput is divided amongst all the active threads in all Thread Groups.
Each thread will delay as needed, based on when it last ran.
In this case, each other Thread Group will need a Constant Throughput timer with the same settings.</li>
<li>all active threads in current thread group (shared) - as above, but each thread is delayed based on when any thread in the group last ran.</li>
<li>all active threads (shared) - as above; each thread is delayed based on when any thread last ran.</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<p>The shared and non-shared algorithms both aim to generate the desired thoughput, and will produce similar results.
The shared algorithm should generate a more accurate overall transaction rate.
The non-shared algortihm should generate a more even spread of transactions across threads.</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Synchronizing_Timer">Synchronizing Timer<a class="sectionlink" href="#Synchronizing_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/sync_timer.png"><img src="../images/screenshots/timers/sync_timer.png" width="415" height="125" alt="Screenshot for Synchronizing Timer"></a></div>
<div class="description">
<p>
The purpose of the SyncTimer is to block threads until X number of threads have been blocked, and
then they are all released at once. A SyncTimer can thus create large instant loads at various
points of the test plan.
</p>
</div>
<div class="properties"><h3 id="Synchronizing_Timer_parms1">
Parameters
<a class="sectionlink" href="#Synchronizing_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree. </div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Number of Simultaneous Users to Group by</div><div class="description req-true">Number of threads to release at once. Setting it to 0 is equivalent to setting it to Number of threads in Thread Group.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Timeout in milliseconds</div><div class="description req-false">If set to 0, Timer will wait for the number of threads to reach the value in "Number of Simultaneous Users to Group", if superior to 0, then timer will wait at max "Timeout in milliseconds" if number of Threads does not reach if ater the timeout interval the number of users waiting is not reached, timer will stop waiting. Defaults to 0</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
If timeout in milliseconds is set to 0 and number of threads never reaches "Number of Simultaneous Users to Group by" then Test will pause infinitely.
Only a forced stop will stop it. Setting Timeout in milliseconds is an option to consider in this case.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
Synchronizing timer blocks only within one JVM, so if using Distributed testing ensure you never set "Number of Simultaneous Users to Group by" to a value superior to the number of users
of its containing Thread group considering 1 injector only.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_Timer">BeanShell Timer<a class="sectionlink" href="#BeanShell_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/beanshell_timer.png"><img src="../images/screenshots/timers/beanshell_timer.png" width="846" height="636" alt="Screenshot for BeanShell Timer"></a></div>
<div class="description">
<p>
The BeanShell Timer can be used to generate a delay.
</p>
<p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p>
<p>
The test element supports the ThreadListener and TestListener methods.
These should be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
</div>
<div class="properties"><h3 id="BeanShell_Timer_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">
A file containing the BeanShell script to run.
The file name is stored in the script variable FileName
The return value is used as the number of milliseconds to wait.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">
The BeanShell script. The return value is used as the number of milliseconds to wait.
</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>Before invoking the script, some variables are set up in the BeanShell interpreter:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous SampleResult (if any)</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<p>If the property <b>beanshell.timer.init</b> is defined, this is used to load an initialisation file, which can be used to define methods etc for use in the BeanShell script.</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_Timer">BSF Timer<a class="sectionlink" href="#BSF_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/bsf_timer.png"><img src="../images/screenshots/timers/bsf_timer.png" width="844" height="636" alt="Screenshot for BSF Timer"></a></div>
<div class="description">
<p>
The BSF Timer can be used to generate a delay using a BSF scripting language.
</p>
</div>
<div class="properties"><h3 id="BSF_Timer_parms1">
Parameters
<a class="sectionlink" href="#BSF_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">ScriptLanguage</div><div class="description req-true">
The scripting language to be used.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>args - String array containing parameters, split on white-space</li>
</ul>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">
A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property
The return value is converted to a long integer and used as the number of milliseconds to wait.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">
The script. The return value is used as the number of milliseconds to wait.
</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>Before invoking the script, some variables are set up in the script interpreter:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampler - the current Sampler</li>
<li>Label - the name of the Timer</li>
<li>Filename - the file name (if any)</li>
<li>OUT - System.out</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_Timer">JSR223 Timer<a class="sectionlink" href="#JSR223_Timer" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JSR223 Timer can be used to generate a delay using a JSR223 scripting language,
For details, see <a href="../usermanual/component_reference.html#BSF_Timer">BSF Timer</a>.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Poisson_Random_Timer">Poisson Random Timer<a class="sectionlink" href="#Poisson_Random_Timer" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/timers/poisson_random_timer.png"><img src="../images/screenshots/timers/poisson_random_timer.png" width="341" height="182" alt="Screenshot for Poisson Random Timer"></a></div>
<div class="description"><p>This timer pauses each thread request for a random amount of time, with most
of the time intervals ocurring near a particular value. The total delay is the
sum of the Poisson distributed value, and the offset value.</p></div>
<div class="properties"><h3 id="Poisson_Random_Timer_parms1">
Parameters
<a class="sectionlink" href="#Poisson_Random_Timer_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this timer that is shown in the tree</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Lambda</div><div class="description req-true">Lambda value in milliseconds.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Constant Delay Offset</div><div class="description req-true">Number of milliseconds to pause in addition
to the random delay.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><div class="section"><h1 id="preprocessors">18.7 Pre Processors<a class="sectionlink" href="#preprocessors" title="Link to here">&para;</a></h1>
<div class="description">
<br>
Preprocessors are used to modify the Samplers in their scope.
<br>
</div>
<div class="component"><h2 id="HTML_Link_Parser">HTML Link Parser<a class="sectionlink" href="#HTML_Link_Parser" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/html_link_parser.png"><img src="../images/screenshots/html_link_parser.png" width="239" height="113" alt="Screenshot for HTML Link Parser"></a></div>
<div class="description">
<p>This modifier parses HTML response from the server and extracts
links and forms. A URL test sample that passes through this modifier will be examined to
see if it "matches" any of the links or forms extracted
from the immediately previous response. It would then replace the values in the URL
test sample with appropriate values from the matching link or form. Perl-type regular
expressions are used to find matches.</p>
</div>
<div class="clear"></div><div class="note">
Matches are performed using protocol, host, path and parameter names.
The target sampler cannot contain parameters that are not in the response links.
</div><div class="clear"></div>
<div class="clear"></div><div class="note">
If using distributed testing, ensure you switch mode (see jmeter.properties) so that it's not a stripping one, see <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=56376">
Bug
56376</a>
</div><div class="clear"></div>
<div class="example"><div class="title">Spidering Example<a class="sectionlink" href="#spider_example" title="Link to here">&para;</a></div>
<p>Consider a simple example: let's say you wanted JMeter to "spider" through your site,
hitting link after link parsed from the HTML returned from your server (this is not
actually the most useful thing to do, but it serves as a good example). You would create
a <a href="../usermanual/component_reference.html#Simple_Controller">Simple Controller</a>, and add the "HTML Link Parser" to it. Then, create an
HTTP Request, and set the domain to ".*", and the path likewise. This will
cause your test sample to match with any link found on the returned pages. If you wanted to
restrict the spidering to a particular domain, then change the domain value
to the one you want. Then, only links to that domain will be followed.
</p>
</div>
<div class="example"><div class="title">Poll Example<a class="sectionlink" href="#poll_example" title="Link to here">&para;</a></div>
<p>A more useful example: given a web polling application, you might have a page with
several poll options as radio buttons for the user to select. Let's say the values
of the poll options are very dynamic - maybe user generated. If you wanted JMeter to
test the poll, you could either create test samples with hardcoded values chosen, or you
could let the HTML Link Parser parse the form, and insert a random poll option into
your URL test sample. To do this, follow the above example, except, when configuring
your Web Test controller's URL options, be sure to choose "POST" as the
method. Put in hard-coded values for the domain, path, and any additional form parameters.
Then, for the actual radio button parameter, put in the name (let's say it's called "poll_choice"),
and then ".*" for the value of that parameter. When the modifier examines
this URL test sample, it will find that it "matches" the poll form (and
it shouldn't match any other form, given that you've specified all the other aspects of
the URL test sample), and it will replace your form parameters with the matching
parameters from the form. Since the regular expression ".*" will match with
anything, the modifier will probably have a list of radio buttons to choose from. It
will choose at random, and replace the value in your URL test sample. Each time through
the test, a new random value will be chosen.</p>
<figure><a href="../images/screenshots/modification.png"><img src="../images/screenshots/modification.png" width="755" height="325" alt="Figure 18 - Online Poll Example"></a><figcaption>Figure 18 - Online Poll Example</figcaption></figure>
<div class="clear"></div><div class="note">One important thing to remember is that you must create a test sample immediately
prior that will return an HTML page with the links and forms that are relevant to
your dynamic test sample.</div><div class="clear"></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_URL_Re-writing_Modifier">HTTP URL Re-writing Modifier<a class="sectionlink" href="#HTTP_URL_Re-writing_Modifier" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/url_rewriter.png"><img src="../images/screenshots/url_rewriter.png" width="579" height="239" alt="Screenshot for HTTP URL Re-writing Modifier"></a></div>
<div class="description"><p>This modifier works similarly to the HTML Link Parser, except it has a specific purpose for which
it is easier to use than the HTML Link Parser, and more efficient. For web applications that
use URL Re-writing to store session ids instead of cookies, this element can be attached at the
ThreadGroup level, much like the <a href="../usermanual/component_reference.html#HTTP_Cookie_Manager">HTTP Cookie Manager</a>. Simply give it the name
of the session id parameter, and it will find it on the page and add the argument to every
request of that ThreadGroup.</p>
<p>Alternatively, this modifier can be attached to select requests and it will modify only them.
Clever users will even determine that this modifier can be used to grab values that elude the
<a href="../usermanual/component_reference.html#HTML_Link_Parser">HTML Link Parser</a>.</p>
</div>
<div class="properties"><h3 id="HTTP_URL_Re-writing_Modifier_parms1">
Parameters
<a class="sectionlink" href="#HTTP_URL_Re-writing_Modifier_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name given to this element in the test tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Session Argument Name</div><div class="description req-true">The name of the parameter to grab from
previous response. This modifier will find the parameter anywhere it exists on the page, and
grab the value assigned to it, whether it's in an HREF or a form.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Path Extension</div><div class="description req-false">Some web apps rewrite URLs by appending
a semi-colon plus the session id parameter. Check this box if that is so.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Do not use equals in path extension</div><div class="description req-false">Some web apps rewrite URLs without using an "=" sign between the parameter name and value (such as Intershop Enfinity).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Do not use questionmark in path extension</div><div class="description req-false">Prevents the query string to end up in the path extension (such as Intershop Enfinity).</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Cache Session Id?</div><div class="description req-true">
Should the value of the session Id be saved for later use when the session Id is not present?
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">URL Encode</div><div class="description req-false">
URL Encode value when writing parameter
</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
If using distributed testing, ensure you switch mode (see jmeter.properties) so that it's not a stripping one, see <a href="http://bz.apache.org/bugzilla/show_bug.cgi?id=56376">
Bug
56376</a>.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTML_Parameter_Mask_(DEPRECATED)">HTML Parameter Mask (DEPRECATED)<a class="sectionlink" href="#HTML_Parameter_Mask_(DEPRECATED)" title="Link to here">&para;</a></h2><div class="deprecated">
*** This element is deprecated. Use
<a href="../usermanual/component_reference.html#Counter">Counter</a>
instead ***
</div><div class="screenshot"><a href="../images/screenshots/parameter_mask.png"><img src="../images/screenshots/parameter_mask.png" width="624" height="209" alt="Screenshot for HTML Parameter Mask (DEPRECATED)"></a></div>
<div class="description"><p>The HTML Parameter Mask is used to generate unique values for HTML arguments. By
specifying the name of the parameter, a value prefix and suffix, and counter parameters, this
modifier will generate values of the form "<span class="code">name=prefixcountersuffix</span>". Any HTTP
Request that it modifies, it will replace any parameter with the same name or add the appropriate
parameter to the requests list of arguments.</p>
<div class="clear"></div><div class="note">The value of the argument in your HTTP Request must be a '*' in order for the HTML Parameter Mask
Modifier to replace it.</div><div class="clear"></div>
<p>As an example, the username for a login script could be modified to send a series of values
such as:<br>
user_1<br>
user_2<br>
user_3<br>
user_4, etc.</p></div>
<div class="properties"><h3 id="HTML_Parameter_Mask_(DEPRECATED)_parms1">
Parameters
<a class="sectionlink" href="#HTML_Parameter_Mask_(DEPRECATED)_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name given to this element in the test tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Name (second appearing)</div><div class="description req-true">The name of the parameter to
modify or add to the HTTP Request.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">ID Prefix</div><div class="description req-false">A string value to prefix to every generated value.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Lower Bound</div><div class="description req-true">A number value to start the counter at.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Upper Bound</div><div class="description req-true">A number value to end the counter, at which point it restarts
with the Lower Bound value.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Increment</div><div class="description req-true">Value to increment the counter by each time through.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">ID Suffix</div><div class="description req-false">A string value to add as suffix to every generated vaue.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="User_Parameters">User Parameters<a class="sectionlink" href="#User_Parameters" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/user_params.png"><img src="../images/screenshots/user_params.png" width="703" height="303" alt="Screenshot for User Parameters"></a></div>
<div class="description"><p>Allows the user to specify values for User Variables specific to individual threads.</p>
<p>User Variables can also be specified in the Test Plan but not specific to individual threads. This panel allows
you to specify a series of values for any User Variable. For each thread, the variable will be assigned one of the values from the series
in sequence. If there are more threads than values, the values get re-used. For example, this can be used to assign a distinct
user id to be used by each thread. User variables can be referenced in any field of any jMeter Component.</p>
<p>The variable is specified by clicking the Add Variable button in the bottom of the panel and filling in the Variable name in the 'Name:' column.
To add a new value to the series, click the 'Add User' button and fill in the desired value in the newly added column.</p>
<p>Values can be accessed in any test component in the same thread group, using the <a href="functions.html">function syntax</a>: ${variable}.</p>
<p>See also the <a href="../usermanual/component_reference.html#CSV_Data_Set_Config">CSV Data Set Config</a> element, which is more suitable for large numbers of parameters</p>
</div>
<div class="properties"><h3 id="User_Parameters_parms1">
Parameters
<a class="sectionlink" href="#User_Parameters_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Update Once Per Iteration</div><div class="description req-true">A flag to indicate whether the User Paramters element
should update its variables only once per iteration. if you embed functions into the UP, then you may need greater
control over how often the values of the variables are updated. Keep this box checked to ensure the values are
updated each time through the UP's parent controller. Uncheck the box, and the UP will update the parameters for
every sample request made within its <a href="test_plan.html#scoping_rules">scope</a>.</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_PreProcessor">BeanShell PreProcessor<a class="sectionlink" href="#BeanShell_PreProcessor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/beanshell_preprocessor.png"><img src="../images/screenshots/beanshell_preprocessor.png" width="845" height="633" alt="Screenshot for BeanShell PreProcessor"></a></div>
<div class="description">
<p>
The BeanShell PreProcessor allows arbitrary code to be applied before taking a sample.
</p>
<p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p>
<p>
The test element supports the ThreadListener and TestListener methods.
These should be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
</div>
<div class="properties"><h3 id="BeanShell_PreProcessor_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_PreProcessor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the BeanShell script to run.
The file name is stored in the script variable FileName</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The BeanShell script. The return value is ignored.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>Before invoking the script, some variables are set up in the BeanShell interpreter:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous SampleResult (if any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<p>If the property <b>beanshell.preprocessor.init</b> is defined, this is used to load an initialisation file, which can be used to define methods etc for use in the BeanShell script.</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_PreProcessor">BSF PreProcessor<a class="sectionlink" href="#BSF_PreProcessor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/bsf_preprocessor.png"><img src="../images/screenshots/bsf_preprocessor.png" width="844" height="632" alt="Screenshot for BSF PreProcessor"></a></div>
<div class="description">
<p>
The BSF PreProcessor allows BSF script code to be applied before taking a sample.
</p>
</div>
<div class="properties"><h3 id="BSF_PreProcessor_parms1">
Parameters
<a class="sectionlink" href="#BSF_PreProcessor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Language</div><div class="description req-true">The BSF language to be used</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The script to run.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
The script (or file) is processed using the BSFEngine.exec() method, which does not return a value.
</p>
<p>The following BSF variables are set up for use by the script:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>Label - the String Label</li>
<li>Filename - the script file name (if any)</li>
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_PreProcessor">JSR223 PreProcessor<a class="sectionlink" href="#JSR223_PreProcessor" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JSR223 PreProcessor allows JSR223 script code to be applied before taking a sample.
For details, see <a href="../usermanual/component_reference.html#BSF_PreProcessor">BSF PreProcessor</a>.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JDBC_PreProcessor">JDBC PreProcessor<a class="sectionlink" href="#JDBC_PreProcessor" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JDBC PreProcessor enables you to run some SQL statement just before a sample runs.
This can be useful if your JDBC Sample requires some data to be in DataBase and you cannot compute this in a setup Thread group.
For details, see <a href="../usermanual/component_reference.html#JDBC_Request">JDBC Request</a>.
</p>
<p>
See the following Test plan:
</p>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="../demos/JDBC-Pre-Post-Processor.jmx">Test Plan using JDBC Pre/Post Processor</a></li></ul></div>
<p>
In the linked test plan,"Create Price Cut-Off" JDBC PreProcessor calls a stored procedure to create a Price Cut-Off in Database,
this one will be used by "Calculate Price cut off".
<figure><a href="../images/screenshots/jdbc-pre-processor.png"><img src="../images/screenshots/jdbc-pre-processor.png" width="818" height="394" alt="Create Price Cut-Off Preprocessor"></a><figcaption>Create Price Cut-Off Preprocessor</figcaption></figure>
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="RegEx_User_Parameters">RegEx User Parameters<a class="sectionlink" href="#RegEx_User_Parameters" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/regex_user_params.png"><img src="../images/screenshots/regex_user_params.png" width="727" height="138" alt="Screenshot for RegEx User Parameters"></a></div>
<div class="description"><p>Allows to specify dynamic values for HTTP parameters extracted from another HTTP Request using regular expressions.
RegEx User Parameters are specific to individual threads.</p>
<p>This component allows you to specify reference name of a regular expression that extracts names and values of HTTP request parameters.
Regular expression group numbers must be specified for parameter's name and also for parameter's value.
Replacement will only occur for parameters in the Sampler that uses this RegEx User Parameters which name matches </p>
</div>
<div class="properties"><h3 id="RegEx_User_Parameters_parms1">
Parameters
<a class="sectionlink" href="#RegEx_User_Parameters_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Regular Expression Reference Name</div><div class="description req-true">Name of a reference to a regular expression</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameter names regexp group number</div><div class="description req-true">Group number of regular expression used to extract parameter names</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Parameter values regex group number</div><div class="description req-true">Group number of regular expression used to extract parameter values</div><div class="required req-true">Yes</div></div>
</div>
<p>Example:</p>
<p>Suppose we have a request which returns a form with 3 input parameters and we want to extract the value of 2 of them to inject them in next request</p>
<p>1. - Create Post Processor Regular Expression for first HTTP Request</p>
<ul>
<li>refName - set name of a regular expression Ex. (listParams)</li>
<li>regular expression - expression that will extract input names and input values attributes
<br>
Ex: input name="([^"]+?)" value="([^"]+?)"</li>
<li>template would be empty</li>
<li>match nr - -1 (in order to iterate through all the possible matches)</li>
</ul>
<p>2. - Create Pre Processor RegEx User Parameters for second HTTP Request</p>
<ul>
<li>refName - set the same reference name of a regular expression, would be listParams in our example</li>
<li>parameter names group number - group number of regular expression for parameter names, would be 1 in our example</li>
<li>parameter values group number - group number of regular expression for parameter values, would be 2 in our example</li>
</ul>
<p>See also the <a href="../usermanual/component_reference.html#Regular_Expression_Extractor">Regular Expression Extractor</a> element, which is used to extract parametes names and values</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="../demos/RegEx-User-Parameters.jmx">Test Plan showing how to use RegEx User Parameters</a></li></ul></div>
<a href="#">^</a>
</div><div class="section"><h1 id="postprocessors">18.8 Post-Processors<a class="sectionlink" href="#postprocessors" title="Link to here">&para;</a></h1>
<div class="description">
<p>
As the name suggests, Post-Processors are applied after samplers. Note that they are
applied to <b>all</b> the samplers in the same scope, so to ensure that a post-processor
is applied only to a particular sampler, add it as a child of the sampler.
</p>
<p>
Note: Unless documented otherwise, Post-Processors are not applied to sub-samples (child samples) -
only to the parent sample.
In the case of BSF and BeanShell post-processors, the script can retrieve sub-samples using the method
<span class="code">prev.getSubResults()</span> which returns an array of SampleResults.
The array will be empty if there are none.
</p>
<p>
Post-Processors are run before Assertions, so they do not have access to any Assertion Results, nor will
the sample status reflect the results of any Assertions. If you require access to Assertion Results, try
using a Listener instead. Also note that the variable JMeterThread.last_sample_ok is set to "true" or "false"
after all Assertions have been run.
</p>
</div>
<div class="component"><h2 id="Regular_Expression_Extractor">Regular Expression Extractor<a class="sectionlink" href="#Regular_Expression_Extractor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/regex_extractor.png"><img src="../images/screenshots/regex_extractor.png" width="790" height="276" alt="Screenshot for Regular Expression Extractor"></a></div>
<div class="description"><p>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.</p></div>
<div class="properties"><h3 id="Regular_Expression_Extractor_parms1">
Parameters
<a class="sectionlink" href="#Regular_Expression_Extractor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Apply to:</div><div class="description req-true">
This is for use with samplers that can generate sub-samples,
e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the Transaction Controller.
<ul>
<li>Main sample only - only applies to the main sample</li>
<li>Sub-samples only - only applies to the sub-samples</li>
<li>Main sample and sub-samples - applies to both.</li>
<li>JMeter Variable - assertion is to be applied to the contents of the named variable</li>
</ul>
Matching is applied to all qualifying samples in turn.
For example if there is a main sample and 3 sub-samples, each of which contains a single match for the regex,
(i.e. 4 matches in total).
For match number = 3, Sub-samples only, the extractor will match the 3rd sub-sample.
For match number = 3, Main sample and sub-samples, the extractor will match the 2nd sub-sample (1st match is main sample).
For match number = 0 or negative, all qualifying samples will be processed.
For match number &gt; 0, matching will stop as soon as enough matches have been found.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Field to check</div><div class="description req-true">
The following fields can be checked:
<ul>
<li>Body - the body of the response, e.g. the content of a web-page (excluding headers)</li>
<li>Body (unescaped) - the body of the response, with all Html escape codes replaced.
Note that Html escapes are processed without regard to context, so some incorrect substitutions
may be made.
<div class="clear"></div><div class="note">Note that this option highly impacts performances, so use it only when absolutely necessary and be aware of its impacts</div><div class="clear"></div>
</li>
<li>Body as a Document - the extract text from various type of documents via Apache Tika (see <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Document view section).
<div class="clear"></div><div class="note">Note that the Body as a Document option can impact performances, so ensure it is Ok for your test</div><div class="clear"></div>
</li>
<li>Request Headers - may not be present for non-HTTP samples</li>
<li>Response Headers - may not be present for non-HTTP samples</li>
<li>URL</li>
<li>Response Code - e.g. 200</li>
<li>Response Message - e.g. OK</li>
</ul>
Headers can be useful for HTTP samples; it may not be present for other sample types.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Reference Name</div><div class="description req-true">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.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Regular Expression</div><div class="description req-true">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$.
Do not enclose the expression in / / - unless of course you want to match these characters as well.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Template</div><div class="description req-true">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.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Match No.</div><div class="description req-true">Indicates which match to use. The regular expression may match multiple times.
<ul>
<li>Use a value of zero to indicate JMeter should choose a match at random.</li>
<li>A positive number N means to select the nth match.</li>
<li> Negative numbers are used in conjunction with the ForEach controller - see below.</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Default Value</div><div class="description req-false">
If the regular expression does not match, then the reference variable will be set to the default value.
This is particularly useful for debugging tests. If no default is provided, then it is difficult to tell
whether the regular expression did not match, or the RE element was not processed or maybe the wrong variable
is being used.
<p>
However, if you have several test elements that set the same variable,
you may wish to leave the variable unchanged if the expression does not match.
In this case, remove the default value once debugging is complete.
</p>
</div><div class="required req-false">No, but recommended</div></div>
</div>
<p>
If the match number is set to a non-negative number, and a match occurs, the variables are set as follows:
<ul>
<li>refName - the value of the template</li>
<li>refName_gn, where n=0,1,2 - the groups for the match</li>
<li>refName_g - the number of groups in the Regex (excluding 0)</li>
</ul>
If no match occurs, then the refName variable is set to the default (unless this is absent).
Also, the following variables are removed:
<ul>
<li>refName_g0</li>
<li>refName_g1</li>
<li>refName_g</li>
</ul>
</p>
<p>
If the match number is set to a negative number, then all the possible matches in the sampler data are processed.
The variables are set as follows:
<ul>
<li>refName_matchNr - the number of matches found; could be 0</li>
<li>refName_n, where n = 1,2,3 etc - the strings as generated by the template</li>
<li>refName_n_gm, where m=0,1,2 - the groups for match n</li>
<li>refName - always set to the default value</li>
<li>refName_gn - not set</li>
</ul>
Note that the refName variable is always set to the default value in this case,
and the associated group variables are not set.
<p>See also <a href="../usermanual/component_reference.html#Response_Assertion">Response Assertion</a> for some examples of how to specify modifiers,
and <a href="regular_expressions.html"> for further information on JMeter regular expressions.</a></p>
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="CSS/JQuery_Extractor">CSS/JQuery Extractor<a class="sectionlink" href="#CSS/JQuery_Extractor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/css_extractor_attr.png"><img src="../images/screenshots/css_extractor_attr.png" width="826" height="276" alt="Screenshot for CSS/JQuery Extractor"></a></div>
<div class="description"><p>Allows the user to extract values from a server response using a CSS/JQuery selector like syntax. As a post-processor,
this element will execute after each Sample request in its scope, applying the CSS/JQuery expression, extracting the requested nodes,
extracting the node as text or attribute value and store the result into the given variable name.</p></div>
<div class="properties"><h3 id="CSS/JQuery_Extractor_parms1">
Parameters
<a class="sectionlink" href="#CSS/JQuery_Extractor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Apply to:</div><div class="description req-true">
This is for use with samplers that can generate sub-samples,
e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the Transaction Controller.
<ul>
<li>Main sample only - only applies to the main sample</li>
<li>Sub-samples only - only applies to the sub-samples</li>
<li>Main sample and sub-samples - applies to both.</li>
<li>JMeter Variable - assertion is to be applied to the contents of the named variable</li>
</ul>
Matching is applied to all qualifying samples in turn.
For example if there is a main sample and 3 sub-samples, each of which contains a single match for the regex,
(i.e. 4 matches in total).
For match number = 3, Sub-samples only, the extractor will match the 3rd sub-sample.
For match number = 3, Main sample and sub-samples, the extractor will match the 2nd sub-sample (1st match is main sample).
For match number = 0 or negative, all qualifying samples will be processed.
For match number &gt; 0, matching will stop as soon as enough matches have been found.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">CSS/JQuery extractor Implementation</div><div class="description req-false">
As of JMeter 2.9, 2 implementations for CSS/JQuery based syntax are supported:
<ul>
<li><a href="http://jsoup.org/">JSoup</a></li>
<li><a href="http://jodd.org/doc/lagarto/index.html">Jodd-Lagarto (CSSelly)</a></li>
</ul>
If selector is set to empty, default implementation(JSoup) will be used.
</div><div class="required req-false">False</div></div>
<div class="property"><div class="name req-true">Reference Name</div><div class="description req-true">The name of the JMeter variable in which to store the result.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">CSS/JQuery expression</div><div class="description req-true">The CSS/JQuery selector used to select nodes from the response data.
Selector, selectors combination and pseudo-selectors are supported, examples:
<ul>
<li>E[foo] an E element with a "foo" attribute</li>
<li>ancestor child:child elements that descend from ancestor, e.g. .body p finds p elements anywhere under a block with class "body"</li>
<li>:lt(n): find elements whose sibling index (i.e. its position in the DOM tree relative to its parent) is less than n; e.g. td:lt(3)</li>
<li>:contains(text): find elements that contain the given text. The search is case-insensitive; e.g. p:contains(jsoup)</li>
<li>...</li>
</ul>
For more details on syntax, see:
<ul>
<li><a href="http://jsoup.org/cookbook/extracting-data/selector-syntax">JSoup</a></li>
<li><a href="http://jodd.org/doc/csselly/">Jodd-Lagarto (CSSelly)</a></li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Attribute</div><div class="description req-false">
Name of attribute (as per HTML syntax) to extract from nodes that matched the selector. If empty, then the combined text of this element and all its children will be returned.<br>
This is the equivalent <a href="http://jsoup.org/apidocs/org/jsoup/nodes/Node.html#attr%28java.lang.String%29">Element#attr(name)</a> function for JSoup if an atttribute is set.<br>
<figure><a href="../images/screenshots/css_extractor_attr.png"><img src="../images/screenshots/css_extractor_attr.png" width="826" height="275" alt="CSS Extractor with attribute value set"></a><figcaption>CSS Extractor with attribute value set</figcaption></figure><br>
If empty this is the equivalent of <a href="http://jsoup.org/apidocs/org/jsoup/nodes/Element.html#text%28%29">Element#text()</a> function for JSoup if not value is set for attribute.
<figure><a href="../images/screenshots/css_extractor_noattr.png"><img src="../images/screenshots/css_extractor_noattr.png" width="825" height="275" alt="CSS Extractor with no attribute set"></a><figcaption>CSS Extractor with no attribute set</figcaption></figure>
</div><div class="required req-false">false</div></div>
<div class="property"><div class="name req-true">Match No.</div><div class="description req-true">Indicates which match to use. The CSS/JQuery selector may match multiple times.
<ul>
<li>Use a value of zero to indicate JMeter should choose a match at random.</li>
<li>A positive number N means to select the nth match.</li>
<li> Negative numbers are used in conjunction with the ForEach controller - see below.</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Default Value</div><div class="description req-false">
If the expression does not match, then the reference variable will be set to the default value.
This is particularly useful for debugging tests. If no default is provided, then it is difficult to tell
whether the expression did not match, or the CSS/JQuery element was not processed or maybe the wrong variable
is being used.
<p>
However, if you have several test elements that set the same variable,
you may wish to leave the variable unchanged if the expression does not match.
In this case, remove the default value once debugging is complete.
</p>
</div><div class="required req-false">No, but recommended</div></div>
</div>
<p>
If the match number is set to a non-negative number, and a match occurs, the variables are set as follows:
<ul>
<li>refName - the value of the template</li>
</ul>
If no match occurs, then the refName variable is set to the default (unless this is absent).
</p>
<p>
If the match number is set to a negative number, then all the possible matches in the sampler data are processed.
The variables are set as follows:
<ul>
<li>refName_matchNr - the number of matches found; could be 0</li>
<li>refName_n, where n = 1,2,3 etc - the strings as generated by the template</li>
<li>refName - always set to the default value</li>
</ul>
Note that the refName variable is always set to the default value in this case.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="XPath_Extractor">XPath Extractor<a class="sectionlink" href="#XPath_Extractor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/xpath_extractor.png"><img src="../images/screenshots/xpath_extractor.png" width="729" height="317" alt="Screenshot for XPath Extractor"></a></div>
<div class="description">This test element allows the user to extract value(s) from
structured response - XML or (X)HTML - using XPath
query language.
</div>
<div class="properties"><h3 id="XPath_Extractor_parms1">
Parameters
<a class="sectionlink" href="#XPath_Extractor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Apply to:</div><div class="description req-true">
This is for use with samplers that can generate sub-samples,
e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the Transaction Controller.
<ul>
<li>Main sample only - only applies to the main sample</li>
<li>Sub-samples only - only applies to the sub-samples</li>
<li>Main sample and sub-samples - applies to both.</li>
<li>JMeter Variable - assertion is to be applied to the contents of the named variable</li>
</ul>
XPath matching is applied to all qualifying samples in turn, and all the matching results will be returned.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use Tidy (tolerant parser)</div><div class="description req-true">If checked use Tidy to parse HTML response into XHTML.
<ul>
<li>"Use Tidy" should be checked on for HTML response. Such response is converted to valid XHTML (XML compatible HTML) using Tidy</li>
<li>"Use Tidy" should be unchecked for both XHTML or XML response (for example RSS)</li>
</ul>
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Quiet</div><div class="description req-false">Sets the Tidy Quiet flag</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Report Errors</div><div class="description req-false">If a Tidy error occurs, then set the Assertion accordingly</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Show warnings</div><div class="description req-false">Sets the Tidy showWarnings option</div><div class="required req-false">If Tidy is selected</div></div>
<div class="property"><div class="name req-false">Use Namespaces</div><div class="description req-false">
If checked, then the XML parser will use namespace resolution.
Note that currently only namespaces declared on the root element will be recognised.
A later version of JMeter may support user-definition of additional workspace names.
Meanwhile, a work-round is to replace:
<br>
//mynamespace:tagname
<br>
by
<br>
//*[local-name()='tagname' and namespace-uri()='uri-for-namespace']
<br>
where "uri-for-namespace" is the uri for the "mynamespace" namespace.
(not applicable if Tidy is selected)
</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Validate XML</div><div class="description req-false">Check the document against its schema.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Ignore Whitespace</div><div class="description req-false">Ignore Element Whitespace.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-false">Fetch External DTDs</div><div class="description req-false">If selected, external DTDs are fetched.</div><div class="required req-false">If Tidy is not selected</div></div>
<div class="property"><div class="name req-true">Return entire XPath fragment instead of text content?</div><div class="description req-true">
If selected, the fragment will be returned rather than the text content.<br>
For example //title would return "&lt;title&gt;Apache JMeter&lt;/title&gt;" rather than "Apache JMeter".<br>
In this case, //title/text() would return "Apache JMeter".
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Reference Name</div><div class="description req-true">The name of the JMeter variable in which to store the result.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">XPath Query</div><div class="description req-true">Element query in XPath language. Can return more than one match.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Default Value</div><div class="description req-true">Default value returned when no match found.
It is also returned if the node has no value and the fragment option is not selected.</div><div class="required req-true"></div></div>
</div>
<p>To allow for use in a ForEach Controller, the following variables are set on return:</p>
<ul>
<li>refName - set to first (or only) match; if no match, then set to default</li>
<li>refName_matchNr - set to number of matches (may be 0)</li>
<li>refName_n - n=1,2,3 etc. Set to the 1st, 2nd 3rd match etc.
</li>
</ul>
<p>Note: The next refName_n variable is set to null - e.g. if there are 2 matches, then refName_3 is set to null,
and if there are no matches, then refName_1 is set to null.
</p>
<p>XPath is query language targeted primarily for XSLT transformations. However it is usefull as generic query language for structured data too. See
<a href="http://www.topxml.com/xsl/xpathref.asp">XPath Reference</a> or <a href="http://www.w3.org/TR/xpath">XPath specification</a> for more information. Here are few examples:
</p>
<dl>
<dt>/html/head/title</dt>
<dd>extracts title element from HTML response</dd>
<dt>/book/page[2]</dt>
<dd>extracts 2nd page from a book</dd>
<dt>/book/page</dt>
<dd>extracts all pages from a book</dd>
<dt>//form[@name='countryForm']//select[@name='country']/option[text()='Czech Republic'])/@value</dt>
<dd>extracts value attribute of option element that match text 'Czech Republic'
inside of select element with name attribute 'country' inside of
form with name attribute 'countryForm'</dd>
</dl>
<div class="clear"></div><div class="note">When "Use Tidy" is checked on - resulting XML document may slightly differ from original HTML response:
<ul>
<li>All elements and attribute names are converted to lowercase</li>
<li>Tidy attempts to correct improperly nested elements. For example - original (incorrect) <span class="code">ul/font/li</span> becomes correct <span class="code">ul/li/font</span></li>
</ul>
See <a href="http://jtidy.sf.net">Tidy homepage</a> for more information.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Result_Status_Action_Handler">Result Status Action Handler<a class="sectionlink" href="#Result_Status_Action_Handler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/resultstatusactionhandler.png"><img src="../images/screenshots/resultstatusactionhandler.png" width="613" height="133" alt="Screenshot for Result Status Action Handler"></a></div>
<div class="description">This test element allows the user to stop the thread or the whole test if the relevant sampler failed.
</div>
<div class="properties"><h3 id="Result_Status_Action_Handler_parms1">
Parameters
<a class="sectionlink" href="#Result_Status_Action_Handler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Action to be taken after a Sampler error</div><div class="description req-true">
Determines what happens if a sampler error occurs, either because the sample itself failed or an assertion failed.
The possible choices are:
<ul>
<li>Continue - ignore the error and continue with the test</li>
<li>Start next thread loop - does not execute samplers following the sampler in error for the current iteration and restarts the loop on next iteration</li>
<li>Stop Thread - current thread exits</li>
<li>Stop Test - the entire test is stopped at the end of any current samples.</li>
<li>Stop Test Now - the entire test is stopped abruptly. Any current samplers are interrupted if possible.</li>
</ul>
</div><div class="required req-true">
No
</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BeanShell_PostProcessor">BeanShell PostProcessor<a class="sectionlink" href="#BeanShell_PostProcessor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/beanshell_postprocessor.png"><img src="../images/screenshots/beanshell_postprocessor.png" width="847" height="633" alt="Screenshot for BeanShell PostProcessor"></a></div>
<div class="description">
<p>
The BeanShell PreProcessor allows arbitrary code to be applied after taking a sample.
</p>
<p>For JMeter versions after 2.2 the BeanShell Post-Processor no longer ignores samples with zero-length result data</p>
<p>
<b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell website.</a></b>
</p>
<p>
The test element supports the ThreadListener and TestListener methods.
These should be defined in the initialisation file.
See the file BeanShellListeners.bshrc for example definitions.
</p>
</div>
<div class="properties"><h3 id="BeanShell_PostProcessor_parms1">
Parameters
<a class="sectionlink" href="#BeanShell_PostProcessor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.
The name is stored in the script variable Label</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Reset bsh.Interpreter before each call</div><div class="description req-true">
If this option is selected, then the interpreter will be recreated for each sample.
This may be necessary for some long running scripts.
For further information, see <a href="best-practices#bsh_scripting">Best Practices - BeanShell scripting</a>.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the BeanShell script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>bsh.args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the BeanShell script to run.
The file name is stored in the script variable FileName</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The BeanShell script. The return value is ignored.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>The following BeanShell variables are set up for use by the script:</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object());</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous SampleResult</li>
<li>data - (byte [])- gives access to the current sample data</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<p>If the property <b>beanshell.postprocessor.init</b> is defined, this is used to load an initialisation file, which can be used to define methods etc for use in the BeanShell script.</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="BSF_PostProcessor">BSF PostProcessor<a class="sectionlink" href="#BSF_PostProcessor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/bsf_postprocessor.png"><img src="../images/screenshots/bsf_postprocessor.png" width="844" height="633" alt="Screenshot for BSF PostProcessor"></a></div>
<div class="description">
<p>
The BSF PostProcessor allows BSF script code to be applied after taking a sample.
</p>
</div>
<div class="properties"><h3 id="BSF_PostProcessor_parms1">
Parameters
<a class="sectionlink" href="#BSF_PostProcessor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Language</div><div class="description req-true">The BSF language to be used</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Parameters</div><div class="description req-false">Parameters to pass to the script.
The parameters are stored in the following variables:
<ul>
<li>Parameters - string containing the parameters as a single variable</li>
<li>args - String array containing parameters, split on white-space</li>
</ul></div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Script file</div><div class="description req-false">A file containing the script to run, if a relative file path is used, then it will be relative to directory referenced by "user.dir" System property</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Script</div><div class="description req-true">The script to run.</div><div class="required req-true">Yes (unless script file is provided)</div></div>
</div>
<p>
The script (or file) is processed using the BSFEngine.exec() method, which does not return a value.
</p>
<p>
Before invoking the script, some variables are set up.
Note that these are BSF variables - i.e. they can be used directly in the script.
</p>
<ul>
<li>log - (Logger) - can be used to write to the log file</li>
<li>Label - the String Label</li>
<li>Filename - the script file name (if any)</li>
<li>Parameters - the parameters (as a String)</li>
<li>args[] - the parameters as a String array (split on whitespace)</li>
<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>) - gives access to the context</li>
<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>) - gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new Object()); vars.getObject("OBJ2");</li>
<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS"); props.put("PROP1","1234");</li>
<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>) - gives access to the previous SampleResult (if any)</li>
<li>sampler - (Sampler)- gives access to the current sampler</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>For details of all the methods available on each of the above variables, please check the Javadoc</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JSR223_PostProcessor">JSR223 PostProcessor<a class="sectionlink" href="#JSR223_PostProcessor" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JSR223 PostProcessor allows JSR223 script code to be applied after taking a sample.
For details, see the <a href="../usermanual/component_reference.html#BSF_PostProcessor">BSF PostProcessor</a>.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="JDBC_PostProcessor">JDBC PostProcessor<a class="sectionlink" href="#JDBC_PostProcessor" title="Link to here">&para;</a></h2>
<div class="description">
<p>
The JDBC PostProcessor enables you to run some SQL statement just after a sample has run.
This can be useful if your JDBC Sample changes some data and you want to reset state to what it was before the JDBC sample run.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="links"><div class="title">See also:</div><ul class="links"><li><a href="../demos/JDBC-Pre-Post-Processor.jmx">Test Plan using JDBC Pre/Post Processor</a></li></ul></div>
<p>
In the linked test plan,"JDBC PostProcessor" JDBC PostProcessor calls a stored procedure to delete from Database the Price Cut-Off that was created by PreProcessor.
<figure><a href="../images/screenshots/jdbc-post-processor.png"><img src="../images/screenshots/jdbc-post-processor.png" width="818" height="399" alt="JDBC PostProcessor"></a><figcaption>JDBC PostProcessor</figcaption></figure>
</p>
</div><div class="section"><h1 id="Miscellaneous_Features">18.9 Miscellaneous Features<a class="sectionlink" href="#Miscellaneous_Features" title="Link to here">&para;</a></h1>
<div class="description">
<br>
</div>
<div class="component"><h2 id="Test_Plan">Test Plan<a class="sectionlink" href="#Test_Plan" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/testplan.png"><img src="../images/screenshots/testplan.png" width="560" height="457" alt="Screenshot for Test Plan"></a></div>
<div class="description">
<p>
The Test Plan is where the overall settings for a test are specified.
</p>
<p>
Static variables can be defined for values that are repeated throughout a test, such as server names.
For example the variable SERVER could be defined as www.example.com, and the rest of the test plan
could refer to it as ${SERVER}. This simplifies changing the name later.
</p>
<p>
If the same variable name is reused on one of more
<a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> Configuration elements,
the value is set to the last definition in the test plan (reading from top to bottom).
Such variables should be used for items that may change between test runs,
but which remain the same during a test run.
</p>
<p>
<b>Note that the Test Plan cannot refer to variables it defines.</b>
If you need to construct other variables from the Test Plan variables,
use a <a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> test element.
</p>
<p>
Selecting Functional Testing instructs JMeter to save the additional sample information
- Response Data and Sampler Data - to all result files.
This increases the resources needed to run a test, and may adversely impact JMeter performance.
If more data is required for a particular sampler only, then add a Listener to it, and configure the fields as required.
[The option does not affect CSV result files, which cannot currently store such information.]
</p>
<p>Also, an option exists here to instruct JMeter to run the <a href="../usermanual/component_reference.html#Thread_Group">Thread Group</a> serially rather than in parallel.</p>
<p>Run tearDown Thread Groups after shutdown of main threads:
if selected, the tearDown groups (if any) will be run after graceful shutdown of the main threads.
The tearDown threads won't be run if the test is forcibly stopped.
</p>
<p>
Test plan now provides an easy way to add classpath setting to a specific test plan.
The feature is additive, meaning that you can add jar files or directories,
but removing an entry requires restarting JMeter.
Note that this cannot be used to add JMeter GUI plugins, because they are processed earlier.
However it can be useful for utility jars such as JDBC drivers. The jars are only added to
the search path for the JMeter loader, not for the system class loader.
</p>
<p>
JMeter properties also provides an entry for loading additional classpaths.
In jmeter.properties, edit "user.classpath" or "plugin_dependency_paths" to include additional libraries.
See <a href="get-started.html#classpath">JMeter's Classpath</a> and
<a href="get-started.html#configuring_jmeter">Configuring JMeter</a> for details.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Thread_Group">Thread Group<a class="sectionlink" href="#Thread_Group" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/threadgroup.png"><img src="../images/screenshots/threadgroup.png" width="583" height="447" alt="Screenshot for Thread Group"></a></div>
<div class="description">
<p>A Thread Group defines a pool of users that will execute a particular test case against your server. In the Thread Group GUI, you can control the number of users simulated (num of threads), the ramp up time (how long it takes to start all the threads), the number of times to perform the test, and optionally, a start and stop time for the test.</p>
<p>
See also <a href="../usermanual/component_reference.html#tearDown_Thread_Group">tearDown Thread Group</a> and <a href="../usermanual/component_reference.html#setUp_Thread_Group">setUp Thread Group</a>.
</p>
<p>
When using the scheduler, JMeter runs the thread group until either the number of loops is reached or the duration/end-time is reached - whichever occurs first.
Note that the condition is only checked between samples; when the end condition is reached, that thread will stop.
JMeter does not interrupt samplers which are waiting for a response, so the end time may be delayed arbitrarily.
</p>
</div>
<div class="properties"><h3 id="Thread_Group_parms1">
Parameters
<a class="sectionlink" href="#Thread_Group_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true"></div></div>
<div class="property"><div class="name req-true">Action to be taken after a Sampler error</div><div class="description req-true">
Determines what happens if a sampler error occurs, either because the sample itself failed or an assertion failed.
The possible choices are:
<ul>
<li>Continue - ignore the error and continue with the test</li>
<li>Start Next Loop - ignore the error, start next loop and continue with the test</li>
<li>Stop Thread - current thread exits</li>
<li>Stop Test - the entire test is stopped at the end of any current samples.</li>
<li>Stop Test Now - the entire test is stopped abruptly. Any current samplers are interrupted if possible.</li>
</ul>
</div><div class="required req-true">
No
</div></div>
<div class="property"><div class="name req-true">Number of Threads</div><div class="description req-true">Number of users to simulate.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Ramp-up Period</div><div class="description req-true">How long JMeter should take to get all the threads started. If there are 10 threads and a ramp-up time of 100 seconds, then each thread will begin 10 seconds after the previous thread started, for a total time of 100 seconds to get the test fully up to speed.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Loop Count</div><div class="description req-true">Number of times to perform the test case. Alternatively, "forever" can be selected causing the test to run until manually stopped.</div><div class="required req-true">Yes, unless forever is selected</div></div>
<div class="property"><div class="name req-true">Delay Thread creation until needed</div><div class="description req-true">
If selected, threads are created only when the appropriate proportion of the ramp-up time has elapsed.
This is most appropriate for tests with a ramp-up time that is significantly longer than the time to execute a single thread.
I.e. where earlier threads finish before later ones start.
<br>
If not selected, all threads are created when the test starts (they then pause for the appropriate proportion of the ramp-up time).
This is the original default, and is appropriate for tests where threads are active throughout most of the test.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Scheduler</div><div class="description req-true">If selected, enables the scheduler</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Start Time</div><div class="description req-false">If the scheduler checkbox is selected, one can choose an absolute start time. When you start your test, JMeter will wait until the specified start time to begin testing.
Note: the Startup Delay field over-rides this - see below.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">End Time</div><div class="description req-false">If the scheduler checkbox is selected, one can choose an absolute end time. When you start your test, JMeter will wait until the specified start time to begin testing, and it will stop at the specified end time.
Note: the Duration field over-rides this - see below.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Duration (seconds)</div><div class="description req-false">
If the scheduler checkbox is selected, one can choose a relative end time.
JMeter will use this to calculate the End Time, and ignore the End Time value.
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Startup delay (seconds)</div><div class="description req-false">
If the scheduler checkbox is selected, one can choose a relative startup delay.
JMeter will use this to calculate the Start Time, and ignore the Start Time value.
</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="WorkBench">WorkBench<a class="sectionlink" href="#WorkBench" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/workbench.png"><img src="../images/screenshots/workbench.png" width="384" height="103" alt="Screenshot for WorkBench"></a></div>
<div class="description">
<p>The WorkBench simply provides a place to temporarily store test elements while not in use, for copy/paste purposes, or any other purpose you desire.
When you save your test plan, WorkBench items are not saved with it by default unless you check "Save Workbench" option.
Your WorkBench can be saved independently, if you like (right-click on WorkBench and choose Save).</p>
<p>Certain test elements are only available on the WorkBench:</p>
<ul>
<li><a href="../usermanual/component_reference.html#HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder</a></li>
<li><a href="../usermanual/component_reference.html#HTTP_Mirror_Server">HTTP Mirror Server</a></li>
<li><a href="../usermanual/component_reference.html#Property_Display">Property Display</a></li>
</ul>
<div class="properties"><h3>
Parameters
</h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Save WorkBench</div><div class="description req-false">
Allow to save the WorkBench's elements into the JMX file.
</div><div class="required req-false">No</div></div>
</div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="SSL_Manager">SSL Manager<a class="sectionlink" href="#SSL_Manager" title="Link to here">&para;</a></h2>
<p>
The SSL Manager is a way to select a client certificate so that you can test
applications that use Public Key Infrastructure (PKI).
It is only needed if you have not set up the appropriate System properties.
</p>
<b>Choosing a Client Certificate</b>
<p>
You may either use a Java Key Store (JKS) format key store, or a Public Key
Certificate Standard #12 (PKCS12) file for your client certificates. There
is a feature of the JSSE libraries that require you to have at least a six character
password on your key (at least for the keytool utility that comes with your
JDK).
</p>
<p>
To select the client certificate, choose Options-&gt;SSL Manager from the menu bar.
You will be presented with a file finder that looks for PKCS12 files by default.
Your PKCS12 file must have the extension '.p12' for SSL Manager to recognize it
as a PKCS12 file. Any other file will be treated like an average JKS key store.
If JSSE is correctly installed, you will be prompted for the password. The text
box does not hide the characters you type at this point--so make sure no one is
looking over your shoulder. The current implementation assumes that the password
for the keystore is also the password for the private key of the client you want
to authenticate as.
</p>
<p>Or you can set the appropriate System properties - see the system.properties file.</p>
<p>
The next time you run your test, the SSL Manager will examine your key store to
see if it has at least one key available to it. If there is only one key, SSL
Manager will select it for you. If there is more than one key, it currently selects the first key.
There is currently no way to select other entries in the keystore, so the desired key must be the first.
</p>
<b>Things to Look Out For</b>
<p>
You must have your Certificate Authority (CA) certificate installed properly
if it is not signed by one of the five CA certificates that ships with your
JDK. One method to install it is to import your CA certificate into a JKS
file, and name the JKS file "jssecacerts". Place the file in your JRE's
lib/security folder. This file will be read before the "cacerts" file in
the same directory. Keep in mind that as long as the "jssecacerts" file
exists, the certificates installed in "cacerts" will not be used. This may
cause problems for you. If you don't mind importing your CA certificate into
the "cacerts" file, then you can authenticate against all of the CA certificates
installed.
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP(S)_Test_Script_Recorder">HTTP(S) Test Script Recorder<a name="HTTP_Proxy_Server">
(was:
HTTP Proxy Server
)
</a><a class="sectionlink" href="#HTTP(S)_Test_Script_Recorder" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/proxy_control.png"><img src="../images/screenshots/proxy_control.png" width="917" height="622" alt="Screenshot for HTTP(S) Test Script Recorder"></a></div>
<div class="description"><p>The HTTP(S) Test Script Recorder allows JMeter to intercept and record your actions while you browse your web application
with your normal browser. JMeter will create test sample objects and store them
directly into your test plan as you go (so you can view samples interactively while you make them).<br>
Ensure you read this <a href="https://wiki.apache.org/jmeter/TestRecording210">wiki page</a> to setup correctly JMeter.
</p>
<p>To use the recorder, <i>add</i> the HTTP(S) Test Script Recorder element to the workbench.
Select the WorkBench element in the tree, and right-click on this element to get the
Add menu (Add --&gt; Non-Test Elements --&gt; HTTP(S) Test Script Recorder).</p>
<p>
The recorder is implemented as an HTTP(S) proxy server.
You need to set up your browser use the proxy for all HTTP and HTTPS requests.
[Do not use JMeter as the proxy for any other request types - FTP, etc. - as JMeter cannot handle them.]
</p>
<p>
Ideally use private browsing mode when recording the session.
This should ensure that the browser starts with no stored cookies, and prevents certain changes from being saved.
For example, Firefox does not allow certificate overrides to be saved permanently.
</p>
<h4>HTTPS recording and certificates</h4>
<p>
HTTPS connections use certificates to authenticate the connection between the browser and the web server.
When connecting via HTTPS, the server presents the certificate to the browser.
To authenticate the certificate, the browser checks that the server certificate is signed
by a Certificate Authority (CA) that is linked to one of its in-built root CAs.
[Browsers also check that the certificate is for the correct host or domain, and that it is valid and not expired.]
If any of the browser checks fail, it will prompt the user who can then decided whether to allow the connection to proceed.
</p>
<p>
JMeter needs to use its own certificate to enable it to intercept the HTTPS connection from
the browser. Effectively JMeter has to pretend to be the target server.
</p>
<p>
For versions of JMeter from 2.10, JMeter will generate its own certificate(s).
These are generated with a validity period defined by the property <span class="code">proxy.cert.validity</span>, default 7 days, and random passwords.
If JMeter detects that it is running under Java 7 or later, it will generate certificates for each target server as necessary (dynamic mode)
unless the following property is defined: <span class="code">proxy.cert.dynamic_keys=false</span>.
When using dynamic mode, the certificate will be for the correct host name, and will be signed by a JMeter-generated CA certificate.
By default, this CA certificate won't be trusted by the browser, however it can be installed as a trusted certificate.
Once this is done, the generated server certificates will be accepted by the browser.
This has the advantage that even embedded HTTPS resources can be intercepted, and there is no need to override the browser checks for each new server.
(Browsers don't prompt for embedded resources. So with earlier versions, embedded resources would only be downloaded for servers that were already 'known' to the browser)
</p>
<p>Unless a keystore is provided (and you define the property <span class="code">proxy.cert.alias</span>),
JMeter needs to use the keytool application to create the keystore entries.
Versions of JMeter after 2.10 include code to check that keytool is available by looking in various standard places.
If JMeter is unable to find the keytool application, it will report an error.
If necessary, the systen property <span class="code">keytool.directory</span> can be used to tell JMeter where to find keytool.
This should be defined in the file <span class="code">system.properties</span>.
</p>
<p>
The JMeter certificates are generated (if necessary) when the Start button is pressed.
<b>Certificate generation can take some while, during which time the GUI will be unresponsive.</b>
The cursor is changed to an hour-glass whilst this is happening.
When certificate generation is complete, the GUI will display a pop-up dialogue containing the details of the certificate for the root CA.
This certificate needs to be installed by the browser in order for it to accept the host certificates generated by JMeter; see <a href="#install_cert">below</a> for details.
</p>
<p>
If necessary, you can force JMeter to regenerate the keystore (and the exported certificates - ApacheJMeterTemporaryRootCA[.usr|.crt]) by deleting the keystore file <span class="code">proxyserver.jks</span> from the JMeter directory.
</p>
<p>
With versions of JMeter up to 2.9, it used a single certificate for all target servers.
[Likewise if JMeter is not being run under Java 7 or later]
This certificate is not one of the certificates that browsers normally trust, and will not be for the
correct host.<br>
As a consequence:
<ul>
<li>The browser should display a dialogue asking if you want to accept the certificate or not. For example:
<pre class="source">
1) The server's name "www.example.com" does not match the certificate's name
"JMeter Proxy (DO NOT TRUST)". Somebody may be trying to eavesdrop on you.
2) The certificate for "JMeter Proxy (DO NOT TRUST)" is signed by the unknown Certificate Authority
"JMeter Proxy (DO NOT TRUST)". It is not possible to verify that this is a valid certificate.
</pre>
You will need to accept the certificate in order to allow the JMeter Proxy to intercept the SSL traffic in order to
record it.
However, do not accept this certificate permanently; it should only be accepted temporarily.
Browsers only prompt this dialogue for the certificate of the main url, not for the resources loaded in the page, such as images, css or javascript files hosted on a secured external CDN.
If you have such resources (gmail has for example), you'll have to first browse manually to these other domains in order to accept JMeter's certificate for them.
Check in jmeter.log for secure domains that you need to register certificate for.
</li>
<li>If the browser has already registered a validated certificate for this domain, the browser will detect JMeter as a security breach and will refuse to load the page. If so, you have to remove the trusted certificate from your browser's keystore.
</li>
</ul>
</p>
<p>
Versions of JMeter from 2.10 onwards still support this method, and will continue to do so if the you define the following property:
<span class="code">proxy.cert.alias</span>
The following properties can be used to change the certificate that is used:
<ul>
<li>proxy.cert.directory - the directory in which to find the certificate (default = JMeter bin/)</li>
<li>proxy.cert.file - name of the keystore file (default "proxyserver.jks")</li>
<li>proxy.cert.keystorepass - keystore password (default "password") [Ignored if using JMeter certificate]</li>
<li>proxy.cert.keypassword - certificate key password (default "password") [Ignored if using JMeter certificate]</li>
<li>proxy.cert.type - the certificate type (default "JKS") [Ignored if using JMeter certificate]</li>
<li>proxy.cert.factory - the factory (default "SunX509") [Ignored if using JMeter certificate]</li>
<li>proxy.cert.alias - the alias for the key to be used. If this is defined, JMeter does not attempt to generate its own certificate(s).</li>
<li>proxy.ssl.protocol - the protocol to be used (default "SSLv3")</li>
</ul>
</p>
<div class="clear"></div><div class="note">
If your browser currently uses a proxy (e.g. a company intranet may route all external requests via a proxy),
then you need to <a href="get-started.html#proxy_server">tell JMeter to use that proxy</a> before starting JMeter,
using the <a href="get-started.html#options">command-line options</a> -H and -P.
This setting will also be needed when running the generated test plan.
</div><div class="clear"></div>
<a name="install_cert"></a>
<h4>Installing the JMeter CA certificate for HTTPS recording</h4>
<p>
As mentioned above, when run under Java 7, JMeter can generate certificates for each server.
For this to work smoothly, the root CA signing certificate used by JMeter needs to be trusted by the browser.
The first time that the recorder is started, it will generate the certificates if necessary.
The root CA certificate is exported into a file with the name <span class="code">ApacheJMeterTemporaryRootCA</span> in the current launch directory.
When the certificates have been set up, JMeter will show a dialog with the current certificate details.
At this point, the certificate can be imported into the browser, as per the instructions below.
</p>
<p>
Note that once the root CA certificate has been installed as a trusted CA, the browser will trust any certificates signed by it.
Until such time as the certificate expires or the certificate is removed from the browser, it will not warn the user that the certificate is being relied upon.
So anyone that can get hold of the keystore and password can use the certificate to generate certificates which will be accepted
by any browsers that trust the JMeter root CA certificate.
For this reason, the password for the keystore and private keys are randomly generated and a short validity period used.
The passwords are stored in the local preferences area.
Please ensure that only trusted users have access to the host with the keystore.
</p>
<h5>Installing the certificate in Firefox</h5>
<p>
Choose the following options:
<ul>
<li>Tools / Options</li>
<li>Advanced / Certificates</li>
<li>View Certificates</li>
<li>Authorities</li>
<li>Import ...</li>
<li>Browse to the JMeter launch directory, and click on the file <span class="code">ApacheJMeterTemporaryRootCA.crt</span>, press Open</li>
<li>Click View and check that the certificate details agree with the ones displayed by the JMeter Test Script Recorder</li>
<li>If OK, select "Trust this CA to identify web sites", and press OK</li>
<li>Close dialogs by pressing OK as necessary</li>
</ul>
</p>
<h5>Installing the certificate in Chrome or Internet Explorer</h5>
<p>
Both Chrome and Internet Explorer use the same trust store for certificates.
<ul>
<li>Browse to the JMeter launch directory, and click on the file <span class="code">ApacheJMeterTemporaryRootCA.crt</span>, and open it</li>
<li>Click on the "Details" tab and check that the certificate details agree with the ones displayed by the JMeter Test Script Recorder</li>
<li>If OK, go back to the "General" tab, and click on "Install Certificate ..." and follow the Wizard prompts</li>
</ul>
</p>
<h5>Installing the certificate in Opera</h5>
<p>
<ul>
<li>Tools / Preferences / Advanced / Security</li>
<li>Manage Certificates...</li>
<li>Select "Intermediate" tab, click "Import..."</li>
<li>Browse to the JMeter launch directory, and click on the file <span class="code">ApacheJMeterTemporaryRootCA.usr</span>, and open it</li>
<li></li>
</ul>
</p>
</div>
<div class="properties"><h3 id="HTTP(S)_Test_Script_Recorder_parms1">
Parameters
<a class="sectionlink" href="#HTTP(S)_Test_Script_Recorder_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Port</div><div class="description req-true">The port that the HTTP(S) Test Script Recorder listens to. 8080 is the default, but you can change it.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">HTTPS Domains</div><div class="description req-false">List of domain (or host) names for HTTPS. Use this to pre-generate certificates for all servers you wish to record.
<br>
For example, *.apache.org,*.incubator.apache.org
<br>
Note that wildcard domains only apply to one level,
i.e. podling.incubator.apache.org matches *.incubator.apache.org but not *.apache.org
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">Target Controller</div><div class="description req-true">The controller where the proxy will store the generated samples. By default, it will look for a Recording Controller and store them there wherever it is.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Grouping</div><div class="description req-true">Whether to group samplers for requests from a single "click" (requests received without significant time separation), and how to represent that grouping in the recording:
<ul>
<li>Do not group samplers: store all recorded samplers sequentially, without any grouping.</li>
<li>Add separators between groups: add a controller named "--------------" to create a visual separation between the groups. Otherwise the samplers are all stored sequentially.</li>
<li>Put each group in a new controller: create a new <a href="../usermanual/component_reference.html#Simple_Controller">Simple Controller</a> for each group, and store all samplers for that group in it.</li>
<li>Store 1st sampler of each group only: only the first request in each group will be recorded. The "Follow Redirects" and "Retrieve All Embedded Resources..." flags will be turned on in those samplers.</li>
<li>Put each group in a new transaction controller: create a new <a href="../usermanual/component_reference.html#Transaction_Controller">Transaction Controller</a> for each group, and store all samplers for that group in it.</li>
</ul>
The property <b>proxy.pause</b> determines the minimum gap that JMeter needs between requests
to treat them as separate "clicks". The default is 1000 (milliseconds) i.e. 1 second.
If you are using grouping, please ensure that you leave the required gap between clicks.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Capture HTTP Headers</div><div class="description req-true">Should headers be added to the plan?
If specified, a Header Manager will be added to each HTTP Sampler.
The Proxy server always removes Cookie and Authorization headers from the generated Header Managers.
By default it also removes If-Modified-Since and If-None-Match headers.
These are used to determine if the browser cache items are up to date;
when recording one normally wants to download all the content.
To change which additional headers are removed, define the JMeter property <b>proxy.headers.remove</b>
as a comma-separated list of headers.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Add Assertions</div><div class="description req-true">Add a blank assertion to each sampler?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Regex Matching</div><div class="description req-true">Use Regex Matching when replacing variables? If checked replacement will use word boundaries, ie it will only replace word matching values of variable, not part of a word. A word boundary follows Perl5 definition and is equivalent to \b. More information below in the paragraph about "User Defined Variable replacement".</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Type</div><div class="description req-true">Which type of sampler to generate (the Java default or HTTPClient)</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Redirect Automatically</div><div class="description req-true">Set Redirect Automatically in the generated samplers?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Follow Redirects</div><div class="description req-true">Set Follow Redirects in the generated samplers?<br>
<b>Note:</b> see "Recording and redirects" section below for important information.
</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Use Keep-Alive</div><div class="description req-true">Set Use Keep-Alive in the generated samplers?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Retrieve all Embedded Resources</div><div class="description req-true">Set Retrieve all Embedded Resources in the generated samplers?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Content Type filter</div><div class="description req-false">
Filter the requests based on the content-type - e.g. "text/html [;charset=utf-8 ]".
The fields are regular expressions which are checked to see if they are contained in the content-type.
[Does not have to match the entire field].
The include filter is checked first, then the exclude filter.
Samples which are filtered out will not be stored.
<b>Note: this filtering is applied to the content type of the response</b>
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Patterns to Include</div><div class="description req-false">Regular expressions that are matched against the full URL that is sampled. Allows filtering of requests that are recorded. All requests pass through, but only
those that meet the requirements of the Include/Exclude fields are <i>recorded</i>. If both Include and Exclude are
left empty, then everything is recorded (which can result in dozens of samples recorded for each page, as images, stylesheets,
etc are recorded). <b>If there is at least one entry in the Include field, then only requests that match one or more Include patterns are
recorded</b>.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Patterns to Exclude</div><div class="description req-false">Regular expressions that are matched against the URL that is sampled.
<b>Any requests that match one or more Exclude pattern are <i>not</i> recorded</b>.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Notify Child Listeners of filtered samplers</div><div class="description req-false">Notify Child Listeners of filtered samplers
<b>Any response that match one or more Exclude pattern is <i>not</i> delivered to Child Listeners (View Results Tree)</b>.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Start Button</div><div class="description req-false">Start the proxy server. JMeter writes the following message to the console once the proxy server has started up and is ready to take requests: "Proxy up and running!".</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Stop Button</div><div class="description req-false">Stop the proxy server.</div><div class="required req-false">N/A</div></div>
<div class="property"><div class="name req-false">Restart Button</div><div class="description req-false">Stops and restarts the proxy server. This is
useful when you change/add/delete an include/exclude filter expression.</div><div class="required req-false">N/A</div></div>
</div>
<h4>Recording and redirects</h4>
<p>
During recording, the browser will follow a redirect response and generate an additional request.
The Proxy will record both the original request and the redirected request
(subject to whatever exclusions are configured).
The generated samples have "Follow Redirects" selected by default, because that is generally better.
[Redirects may depend on the original request, so repeating the originally recorded sample may not always work.]
</p>
<p>
Now if JMeter is set to follow the redirect during replay, it will issue the original request,
and then replay the redirect request that was recorded.
To avoid this duplicate replay, JMeter tries to detect when a sample is the result of a previous
redirect. If the current response is a redirect, JMeter will save the redirect URL.
When the next request is received, it is compared with the saved redirect URL and if there is a match,
JMeter will disable the generated sample. It also adds comments to the redirect chain.
This assumes that all the requests in a redirect chain will follow each other without any intervening requests.
To disable the redirect detection, set the property <span class="code">proxy.redirect.disabling=false</span>
</p>
<h4>Includes and Excludes</h4>
<p>The <b>include and exclude patterns</b> are treated as regular expressions (using Jakarta ORO).
They will be matched against the host name, port (actual or implied) path and query (if any) of each browser request.
If the URL you are browsing is <br>
<b>"http://jmeter.apache.org/jmeter/index.html?username=xxxx"</b>,<br>
then the regular expression will be tested against the string:<br>
<b>"jmeter.apache.org:80/jmeter/index.html?username=xxxx"</b>.<br>
Thus, if you want to include all .html files, your regular expression might look like: <br>
<b>".*\.html(\?.*)?"</b> - or <b>".*\.html"</b>
if you know that there is no query string or you only want html pages without query strings.
</p>
<p>
If there are any include patterns, then the URL <b>must match at least one</b> of the patterns
, otherwise it will not be recorded.
If there are any exclude patterns, then the URL <b>must not match any</b> of the patterns
, otherwise it will not be recorded.
Using a combination of includes and excludes,
you should be able to record what you are interested in and skip what you are not.
</p>
<p>
N.B. the string that is matched by the regular expression must be the same as the <b>whole</b> host+path string.<br>Thus <b>"\.html"</b> will <b>not</b> match <b>j.a.o/index.html</b>
</p>
<h4>Capturing binary POST data</h4>
<p>
Versions of JMeter from 2.3.2 are able to capture binary POST data.
To configure which content-types are treated as binary, update the JMeter property proxy.binary.types.
The default settings are as follows:
<pre>
# These content-types will be handled by saving the request in a file:
proxy.binary.types=application/x-amf,application/x-java-serialized-object
# The files will be saved in this directory:
proxy.binary.directory=user.dir
# The files will be created with this file filesuffix:
proxy.binary.filesuffix=.binary
</pre>
</p>
<h4>Adding timers</h4>
<p>It is also possible to have the proxy add timers to the recorded script. To
do this, create a timer directly within the HTTP(S) Test Script Recorder component.
The proxy will place a copy of this timer into each sample it records, or into
the first sample of each group if you're using grouping. This copy will then be
scanned for occurences of variable ${T} in its properties, and any such
occurences will be replaced by the time gap from the previous sampler
recorded (in milliseconds).</p>
<p>When you are ready to begin, hit "start".</p>
<div class="clear"></div><div class="note">You will need to edit the proxy settings of your browser to point at the
appropriate server and port, where the server is the machine JMeter is running on, and
the port # is from the Proxy Control Panel shown above.</div><div class="clear"></div>
<h4>Where Do Samples Get Recorded?</h4>
<p>JMeter places the recorded samples in the Target Controller you choose. If you choose the default option
"Use Recording Controller", they will be stored in the first Recording Controller found in the test object tree (so be
sure to add a Recording Controller before you start recording).</p>
<p>
If the Proxy does not seem to record any samples, this could be because the browser is not actually using the proxy.
To check if this is the case, try stopping the proxy.
If the browser still downloads pages, then it was not sending requests via the proxy.
Double-check the browser options.
If you are trying to record from a server running on the same host,
then check that the browser is not set to "Bypass proxy server for local addresses"
(this example is from IE7, but there will be similar options for other browsers).
If JMeter does not record browser URLs such as http://localhost/ or http://127.0.0.1/,
try using the non-loopback hostname or IP address, e.g. http://myhost/ or http://192.168.0.2/.
</p>
<h4>Handling of HTTP Request Defaults</h4>
<p>If the HTTP(S) Test Script Recorder finds enabled <a href="../usermanual/component_reference.html#HTTP_Request_Defaults">HTTP Request Defaults</a> directly within the
controller where samples are being stored, or directly within any of its parent controllers, the recorded samples
will have empty fields for the default values you specified. You may further control this behaviour by placing an
HTTP Request Defaults element directly within the HTTP(S) Test Script Recorder, whose non-blank values will override
those in the other HTTP Request Defaults. See <a href="best-practices.html#proxy_server"> Best
Practices with the HTTP(S) Test Script Recorder</a> for more info.</p>
<h4>User Defined Variable replacement</h4>
<p>Similarly, if the HTTP(S) Test Script Recorder finds <a href="../usermanual/component_reference.html#User_Defined_Variables">User Defined Variables</a> (UDV) directly within the
controller where samples are being stored, or directly within any of its parent controllers, the recorded samples
will have any occurences of the values of those variables replaced by the corresponding variable. Again, you can
place User Defined Variables directly within the HTTP(S) Test Script Recorder to override the values to be replaced. See
<a href="best-practices.html#proxy_server"> Best Practices with the Test Script Recorder</a> for more info.</p>
<div class="clear"></div><div class="note">Please note that matching is case-sensitive.</div><div class="clear"></div>
<p>Replacement by Variables: by default, the Proxy server looks for all occurences of UDV values.
If you define the variable <span class="code">WEB</span> with the value <span class="code">www</span>, for example,
the string <span class="code">www</span> will be replaced by <span class="code">${WEB}</span> wherever it is found.
To avoid this happening everywhere, set the "Regex Matching" check-box.
This tells the proxy server to treat values as Regexes (using the perl5 compatible regex matchers provided by ORO).</p>
<p>If "Regex Matching" is selected every variable will be compiled into a perl compatible regex enclosed in
<span class="code">\b(</span> and <span class="code">)\b</span>. That way each match will start and end at a word boundary.</p>
<div class="clear"></div><div class="note">Note that the boundary characters are not part of the matching group, e.g. <span class="code">n.*</span> to match <span class="code">name</span> out
of <span class="code">You can call me 'name'</span>.</div><div class="clear"></div>
<p>If you don't want your regex to be enclosed with those boundary matchers, you have to enclose your
regex within parens, e.g <span class="code">('.*?')</span> to match <span class="code">'name'</span> out of <span class="code">You can call me 'name'</span>.</p>
<div class="clear"></div><div class="note">
The variables will be checked in random order. So ensure, that the potential matches don't overlap.
Overlapping matchers would be <span class="code">.*</span> (which matches anything) and <span class="code">www</span> (which
matches <span class="code">www</span> only). Non-overlapping matchers would be <span class="code">a+</span> (matches a sequence
of <span class="code">a</span>'s) and <span class="code">b+</span> (matches a sequence of <span class="code">b</span>'s).
</div><div class="clear"></div>
<p>If you want to match a whole string only, enclose it in <span class="code">(^</span> and <span class="code">$)</span>, e.g. <span class="code">(^thus$)</span>.
The parens are neccessary, since the normally added boundary characters will prevent <span class="code">^</span> and
<span class="code">$</span> to match.</p>
<p>If you want to match <span class="code">/images</span> at the start of a string only, use the value <span class="code">(^/images)</span>.
Jakarta ORO also supports zero-width look-ahead, so one can match <span class="code">/images/...</span>
but retain the trailing <span class="code">/</span> in the output by using <span class="code">(^/images(?=/))</span>".</p>
<div class="clear"></div><div class="note">
Note that the current version of Jakara ORO does not support look-behind - i.e. <span class="code">(?&lt;=...)</span> or <span class="code">(?&lt;!...)</span>.
</div><div class="clear"></div>
<p>Look out for overlapping matchers. For example the value <span class="code">.*</span> as a regex in a variable named
<span class="code">regex</span> will partly match a previous replaced variable, which will result in something like
<span class="code">${{regex}</span>, which is most probably not the desired result.</p>
<p>If there are any problems interpreting any variables as patterns, these are reported in jmeter.log,
so be sure to check this if UDVs are not working as expected.</p>
<p>When you are done recording your test samples, stop the proxy server (hit the "stop" button). Remember to reset
your browser's proxy settings. Now, you may want to sort and re-order the test script, add timers, listeners, a
cookie manager, etc.</p>
<h4>How can I record the server's responses too?</h4>
<p>Just place a <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> listener as a child of the HTTP(S) Test Script Recorder and the responses will be displayed.
You can also add a <a href="../usermanual/component_reference.html#Save_Responses_to_a_file">Save Responses to a file</a> Post-Processor which will save the responses to files.
</p>
<h4>Associating requests with responses</h4>
<p>
If you define the property <span class="code">proxy.number.requests=true</span>
JMeter will add a number to each sampler and each response.
Note that there may be more responses than samplers if excludes or includes have been used.
Responses that have been excluded will have labels enclosed in [ and ], for example <span class="code">[23 /favicon.ico]</span>
</p>
<h4>Cookie Manager</h4>
<p>
If the server you are testing against uses cookies, remember to add an <a href="../usermanual/component_reference.html#HTTP_Cookie_Manager">HTTP Cookie Manager</a> to the test plan
when you have finished recording it.
During recording, the browser handles any cookies, but JMeter needs a Cookie Manager
to do the cookie handling during a test run.
The JMeter Proxy server passes on all cookies sent by the browser during recording, but does not save them to the test
plan because they are likely to change between runs.
</p>
<h4>Authorization Manager</h4>
<p>
The HTTP(S) Test Script Recorder grabs "Authentication" header, tries to compute the Auth Policy. If Authorization Manager was added to target
controller manually, HTTP(S) Test Script Recorder will find it and add authorization(matching ones will be removed). Otherwise
Authorization Manager will be added to target controller with authorization object.
You may have to fix automatically computed values after recording.
</p>
<h4>Uploading files</h4>
<p>
Some browsers (e.g. Firefox and Opera) don't include the full name of a file when uploading files.
This can cause the JMeter proxy server to fail.
One solution is to ensure that any files to be uploaded are in the JMeter working directory,
either by copying the files there or by starting JMeter in the directory containing the files.
</p>
<h4>Recording HTTP Based Non Textual Protocols not natively available in JMeter</h4>
<p>
You may have to record an HTTP protocol that is not handled by default by JMeter (Custom Binary Protocol, Adobe Flex, Microsoft Silverlight... ).
Although JMeter does not provide a native proxy implementation to record these protocols, you have the ability to
record these protocols by implementing a custom SamplerCreator. This Sampler Creator will translate the binary format into a HTTPSamplerBase subclass
that can be added to the JMeter Test Case.
For more details see "Extending JMeter".
</p>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="HTTP_Mirror_Server">HTTP Mirror Server<a class="sectionlink" href="#HTTP_Mirror_Server" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/mirrorserver.png"><img src="../images/screenshots/mirrorserver.png" width="671" height="174" alt="Screenshot for HTTP Mirror Server"></a></div>
<div class="description">
<p>
The HTTP Mirrror Server is a very simple HTTP server - it simply mirrors the data sent to it.
This is useful for checking the content of HTTP requests.
</p>
<p>
It uses default port 8081 since 2.6.
</p>
</div>
<div class="properties"><h3 id="HTTP_Mirror_Server_parms1">
Parameters
<a class="sectionlink" href="#HTTP_Mirror_Server_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Port</div><div class="description req-true">Port on which Mirror server listens, defaults to 8081.</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-false">Max Number of threads</div><div class="description req-false">If set to a value &gt; 0, number of threads serving requests will be limited to the configured number, if set to a value &lt;=0
a new thread will be created to serve each incoming request. Defaults to 0</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">Max Queue size</div><div class="description req-false">Size of queue used for holding tasks before they are executed by Thread Pool, when Thread pool is exceeded, incoming requests will
be held in this queue and discarded when this queue is full. This parameter is only used if Max Number of Threads is greater than 0. Defaults to 25</div><div class="required req-false">No</div></div>
</div>
<div class="clear"></div><div class="note">
Note that you can get more control over the responses by adding an HTTP Header Manager with the following name/value pairs:
</div><div class="clear"></div>
<div class="properties"><h3 id="HTTP_Mirror_Server_parms2">
Parameters
<a class="sectionlink" href="#HTTP_Mirror_Server_parms2" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">X-Sleep</div><div class="description req-false">Time to sleep in ms before sending response</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X-SetCookie</div><div class="description req-false">Cookies to be set on response</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X-ResponseStatus</div><div class="description req-false">Response status, see <a href="http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html">HTTP Status responses</a>, example 200 OK, 500 Internal Server Error ....</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X-ResponseLength</div><div class="description req-false">Size of response, this trims the response to the requested size if that is less than the total size</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">X-SetHeaders</div><div class="description req-false">Pipe separated list of headers, example:<br>
<span class="code">headerA=valueA|headerB=valueB</span> would set headerA to valueA and headerB to valueB.
</div><div class="required req-false">No</div></div>
</div>
<p>
You can also use the following query parameters:
</p>
<div class="properties"><h3 id="HTTP_Mirror_Server_parms3">
Parameters
<a class="sectionlink" href="#HTTP_Mirror_Server_parms3" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">redirect</div><div class="description req-false">Generates a 302 (Temporary Redirect) with the provided location.
e.g. ?redirect=/path
</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">status</div><div class="description req-false">Overrides the default status return. e.g. ?status=404 Not Found</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-false">v</div><div class="description req-false">Verbose flag, writes some details to standard output. e.g. first line and redirect location if specified</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Property_Display">Property Display<a class="sectionlink" href="#Property_Display" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/property_display.png"><img src="../images/screenshots/property_display.png" width="804" height="508" alt="Screenshot for Property Display"></a></div>
<div class="description">
<p>
The Property Display shows the values of System or JMeter properties.
Values can be changed by entering new text in the Value column.
It is available only on the WorkBench.
</p>
</div>
<div class="properties"><h3 id="Property_Display_parms1">
Parameters
<a class="sectionlink" href="#Property_Display_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Debug_Sampler">Debug Sampler<a class="sectionlink" href="#Debug_Sampler" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/debug_sampler.png"><img src="../images/screenshots/debug_sampler.png" width="431" height="172" alt="Screenshot for Debug Sampler"></a></div>
<div class="description">
<p>
The Debug Sampler generates a sample containing the values of all JMeter variables and/or properties.
</p>
<p>
The values can be seen in the <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Listener Response Data pane.
</p>
</div>
<div class="properties"><h3 id="Debug_Sampler_parms1">
Parameters
<a class="sectionlink" href="#Debug_Sampler_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">JMeter Properties</div><div class="description req-true">Include JMeter properties ?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">JMeter Variables</div><div class="description req-true">Include JMeter variables ?</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">System Properties</div><div class="description req-true">Include System properties ?</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Debug_PostProcessor">Debug PostProcessor<a class="sectionlink" href="#Debug_PostProcessor" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/debug_postprocessor.png"><img src="../images/screenshots/debug_postprocessor.png" width="344" height="193" alt="Screenshot for Debug PostProcessor"></a></div>
<div class="description">
<p>
The Debug PostProcessor creates a subSample with the details of the previous Sampler properties,
JMeter variables, properties and/or System Properties.
</p>
<p>
The values can be seen in the <a href="../usermanual/component_reference.html#View_Results_Tree">View Results Tree</a> Listener Response Data pane.
</p>
</div>
<div class="properties"><h3 id="Debug_PostProcessor_parms1">
Parameters
<a class="sectionlink" href="#Debug_PostProcessor_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-false">Name</div><div class="description req-false">Descriptive name for this element that is shown in the tree.</div><div class="required req-false">No</div></div>
<div class="property"><div class="name req-true">JMeter Properties</div><div class="description req-true">Whether to show JMeter properties (default false).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">JMeter Variables</div><div class="description req-true">Whether to show JMeter variables (default false).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">Sampler Properties</div><div class="description req-true">Whether to show Sampler properties (default true).</div><div class="required req-true">Yes</div></div>
<div class="property"><div class="name req-true">System Properties</div><div class="description req-true">Whether to show System properties (default false).</div><div class="required req-true">Yes</div></div>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="Test_Fragment">Test Fragment<a class="sectionlink" href="#Test_Fragment" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/test_fragment.png"><img src="../images/screenshots/test_fragment.png" width="236" height="94" alt="Screenshot for Test Fragment"></a></div>
<div class="description">
<p>
The Test Fragment is used in conjunction with the <a href="../usermanual/component_reference.html#Include_Controller">Include Controller</a> and <a href="../usermanual/component_reference.html#Module_Controller">Module Controller</a>.
</p>
</div>
<div class="properties"><h3 id="Test_Fragment_parms1">
Parameters
<a class="sectionlink" href="#Test_Fragment_parms1" title="Link to here">&para;</a></h3><div class="property title"><div class="name title">Attribute</div><div class="description title">Description</div><div class="required title">Required</div></div>
<div class="property"><div class="name req-true">Name</div><div class="description req-true">Descriptive name for this element that is shown in the tree.</div><div class="required req-true">Yes</div></div>
</div>
<div class="clear"></div><div class="note">
When using Test Fragment with <a href="../usermanual/component_reference.html#Module_Controller">Module Controller</a>, ensure you disable the Test Fragment to avoid the execution of Test Fragment itself.
This is done by default since JMeter 2.13.
</div><div class="clear"></div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="setUp_Thread_Group">setUp Thread Group<a class="sectionlink" href="#setUp_Thread_Group" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/setup_thread_group.png"><img src="../images/screenshots/setup_thread_group.png" width="537" height="289" alt="Screenshot for setUp Thread Group"></a></div>
<div class="description">
<p>
A special type of ThreadGroup that can be utilized to perform Pre-Test Actions. The behavior of these threads
is exactly like a normal <a href="../usermanual/component_reference.html#Thread_Group">Thread Group</a> element. The difference is that these type of threads
execute before the test proceeds to the executing of regular Thread Groups.
</p>
</div>
<div class="go-top"><a href="#">^</a></div></div>
<div class="component"><h2 id="tearDown_Thread_Group">tearDown Thread Group<a class="sectionlink" href="#tearDown_Thread_Group" title="Link to here">&para;</a></h2><div class="screenshot"><a href="../images/screenshots/teardown_thread_group.png"><img src="../images/screenshots/teardown_thread_group.png" width="537" height="289" alt="Screenshot for tearDown Thread Group"></a></div>
<div class="description">
<p>
A special type of ThreadGroup that can be utilized to perform Post-Test Actions. The behavior of these threads
is exactly like a normal <a href="../usermanual/component_reference.html#Thread_Group">Thread Group</a> element. The difference is that these type of threads
execute after the test has finished executing its regular Thread Groups.
</p>
</div>
<div class="clear"></div><div class="note">
Note that by default it won't run if Test is gracefully shutdown, if you want to make it run in this case,
ensure you check option "Run tearDown Thread Groups after shutdown of main threads" on Test Plan element.
If Test Plan is stopped, tearDown will not run even if option is checked.
</div><div class="clear"></div>
<figure><a href="../images/screenshots/tear_down_on_shutdown.png"><img src="../images/screenshots/tear_down_on_shutdown.png" width="1081" height="570" alt="Figure 1 - Run tearDown Thread Groups after shutdown of main threads"></a><figcaption>Figure 1 - Run tearDown Thread Groups after shutdown of main threads</figcaption></figure>
<div class="go-top"><a href="#">^</a></div></div>
<a href="#">^</a>
</div><ul class="pagelinks"><li><a href="boss.html">&lt; Prev</a></li><li><a href="../index.html">Index</a></li><li><a href="functions.html">Next &gt;</a></li></ul></div><div class="footer"><div class="copyright">
Copyright &copy;
1999 &ndash;
2015
, Apache Software Foundation
</div><div class="trademarks">Apache, Apache JMeter, JMeter, the Apache
feather, and the Apache JMeter logo are
trademarks of the
Apache Software Foundation.
</div></div></body></html>
Reference in New Issue View Git Blame Copy Permalink