You are viewing a plain text version of this content. The canonical link for it is here.
Posted to jmeter-dev@jakarta.apache.org by se...@apache.org on 2008/05/27 20:06:01 UTC
svn commit: r660629 [12/18] - in /jakarta/jmeter/trunk/docs: ./ localising/
usermanual/
Modified: jakarta/jmeter/trunk/docs/usermanual/functions.html
URL: http://svn.apache.org/viewvc/jakarta/jmeter/trunk/docs/usermanual/functions.html?rev=660629&r1=660628&r2=660629&view=diff
==============================================================================
--- jakarta/jmeter/trunk/docs/usermanual/functions.html (original)
+++ jakarta/jmeter/trunk/docs/usermanual/functions.html Tue May 27 11:05:49 2008
@@ -1,696 +1,696 @@
-<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
-<!--
- Licensed to the Apache Software Foundation (ASF) under one or more
- contributor license agreements. See the NOTICE file distributed with
- this work for additional information regarding copyright ownership.
- The ASF licenses this file to You under the Apache License, Version 2.0
- (the "License"); you may not use this file except in compliance with
- the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
- Unless required by applicable law or agreed to in writing, software
- distributed under the License is distributed on an "AS IS" BASIS,
- WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
- See the License for the specific language governing permissions and
- limitations under the License.
--->
-
-<!-- Content Stylesheet for Site -->
-
-
-<!-- start the processing -->
- <!-- ====================================================================== -->
- <!-- Main Page Section -->
- <!-- ====================================================================== -->
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
-
-
-
- <title>JMeter - User's Manual: Functions and Variables</title>
- </head>
-
- <body bgcolor="#ffffff" text="#000000" link="#525D76">
- <table border="0" cellspacing="0">
- <!-- TOP IMAGE -->
- <tr>
- <td>
-<!-- Need to specify height otherwise iframe seems to grab extra -->
-<iframe src="http://www.apache.org/ads/halfbanner.html" height="102"
- style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe>
-</td>
-<td align="left">
-<a href="http://jakarta.apache.org"><img width="505" height="48" src="../images/jakarta-logo.gif" alt="Jakarta" title="Jakarta" border="0"/></a>
-</td>
-<td align="right">
-<a href="http://jakarta.apache.org/jmeter/"><img width="221" height="102" src="../images/logo.jpg" alt="JMeter" title="JMeter" border="0"/></a>
-</td>
- </tr>
- </table>
- <table border="0" width="100%" cellspacing="4">
- <tr><td colspan="2">
- <hr noshade size="1"/>
- </td></tr>
-
- <tr>
- <!-- LEFT SIDE NAVIGATION -->
- <td width="20%" valign="top" nowrap="true">
- <p><strong>About</strong></p>
- <ul>
- <li> <a href="../index.html">Overview</a>
-</li>
- <li> <a href="../changes.html">Changes</a>
-</li>
- <li> <a href="../known_bugs.html">Known Bugs</a>
-</li>
- <li> <a href="../license.html">License</a>
-</li>
- <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters">Contributors</a>
-</li>
- </ul>
- <p><strong>Download</strong></p>
- <ul>
- <li> <a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi">Download Releases</a>
-</li>
- <li> <a href="../nightly.html">Developer (Nightly) Builds</a>
-</li>
- </ul>
- <p><strong>Documentation</strong></p>
- <ul>
- <li> <a href="../usermanual/index.html">User Manual</a>
-</li>
- <li> <a href="../api/index.html">Javadocs</a>
-</li>
- <li> <a href="../localising/index.html">Localisation (Translator's Guide)</a>
-</li>
- <li> <a href="../building.html">Building JMeter and Add-Ons</a>
-</li>
- <li> <a href="http://wiki.apache.org/jakarta-jmeter">JMeter Wiki</a>
-</li>
- <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ">FAQ (Wiki)</a>
-</li>
- </ul>
- <p><strong>Tutorials (PDF format)</strong></p>
- <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>
- <p><strong>Community</strong></p>
- <ul>
- <li> <a href="http://jakarta.apache.org/site/getinvolved.html">Get Involved</a>
-</li>
- <li> <a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
-</li>
- <li> <a href="http://jakarta.apache.org/site/cvsindex.html">SVN Repositories</a>
-</li>
- </ul>
- </td>
- <td width="80%" align="left" valign="top">
- <table>
- <tr>
- <td bgcolor="#525D76">
- <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div>
- </td>
- <td bgcolor="#525D76">
- <div align="right"><a href="regular_expressions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div>
- </td>
- <td bgcolor="#525D76">
- <div align="right"><a href="component_reference.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div>
- </td>
- </tr>
- </table>
- <br>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#525D76">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="functions"><strong>19. Functions and Variables</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p >
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+
+<!-- Content Stylesheet for Site -->
+
+
+<!-- start the processing -->
+ <!-- ====================================================================== -->
+ <!-- Main Page Section -->
+ <!-- ====================================================================== -->
+ <html>
+ <head>
+ <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"/>
+
+
+
+ <title>JMeter - User's Manual: Functions and Variables</title>
+ </head>
+
+ <body bgcolor="#ffffff" text="#000000" link="#525D76">
+ <table border="0" cellspacing="0">
+ <!-- TOP IMAGE -->
+ <tr>
+ <td>
+<!-- Need to specify height otherwise iframe seems to grab extra -->
+<iframe src="http://www.apache.org/ads/halfbanner.html" height="102"
+ style="border-width:0; float: left" frameborder="0" scrolling="no"></iframe>
+</td>
+<td align="left">
+<a href="http://jakarta.apache.org"><img width="505" height="48" src="../images/jakarta-logo.gif" alt="Jakarta" title="Jakarta" border="0"/></a>
+</td>
+<td align="right">
+<a href="http://jakarta.apache.org/jmeter/"><img width="221" height="102" src="../images/logo.jpg" alt="JMeter" title="JMeter" border="0"/></a>
+</td>
+ </tr>
+ </table>
+ <table border="0" width="100%" cellspacing="4">
+ <tr><td colspan="2">
+ <hr noshade size="1"/>
+ </td></tr>
+
+ <tr>
+ <!-- LEFT SIDE NAVIGATION -->
+ <td width="20%" valign="top" nowrap="true">
+ <p><strong>About</strong></p>
+ <ul>
+ <li> <a href="../index.html">Overview</a>
+</li>
+ <li> <a href="../changes.html">Changes</a>
+</li>
+ <li> <a href="../known_bugs.html">Known Bugs</a>
+</li>
+ <li> <a href="../license.html">License</a>
+</li>
+ <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterCommitters">Contributors</a>
+</li>
+ </ul>
+ <p><strong>Download</strong></p>
+ <ul>
+ <li> <a href="http://jakarta.apache.org/site/downloads/downloads_jmeter.cgi">Download Releases</a>
+</li>
+ <li> <a href="../nightly.html">Developer (Nightly) Builds</a>
+</li>
+ </ul>
+ <p><strong>Documentation</strong></p>
+ <ul>
+ <li> <a href="../usermanual/index.html">User Manual</a>
+</li>
+ <li> <a href="../api/index.html">Javadocs</a>
+</li>
+ <li> <a href="../localising/index.html">Localisation (Translator's Guide)</a>
+</li>
+ <li> <a href="../building.html">Building JMeter and Add-Ons</a>
+</li>
+ <li> <a href="http://wiki.apache.org/jakarta-jmeter">JMeter Wiki</a>
+</li>
+ <li> <a href="http://wiki.apache.org/jakarta-jmeter/JMeterFAQ">FAQ (Wiki)</a>
+</li>
+ </ul>
+ <p><strong>Tutorials (PDF format)</strong></p>
+ <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>
+ <p><strong>Community</strong></p>
+ <ul>
+ <li> <a href="http://jakarta.apache.org/site/getinvolved.html">Get Involved</a>
+</li>
+ <li> <a href="http://jakarta.apache.org/site/mail.html">Mailing Lists</a>
+</li>
+ <li> <a href="http://jakarta.apache.org/site/cvsindex.html">SVN Repositories</a>
+</li>
+ </ul>
+ </td>
+ <td width="80%" align="left" valign="top">
+ <table>
+ <tr>
+ <td bgcolor="#525D76">
+ <div align="right"><a href="index.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Index</font></a></div>
+ </td>
+ <td bgcolor="#525D76">
+ <div align="right"><a href="regular_expressions.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Next</font></a></div>
+ </td>
+ <td bgcolor="#525D76">
+ <div align="right"><a href="component_reference.html"><font size=-1 color="#ffffff" face="arial,helvetica,sanserif">Prev</font></a></div>
+ </td>
+ </tr>
+ </table>
+ <br>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#525D76">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="functions"><strong>19. Functions and Variables</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p >
JMeter functions are special values that can populate fields of any Sampler or other
-element in a test tree. A function call looks like this:
- </p>
- <p >
- <code >
- ${__functionName(var1,var2,var3)}
- </code>
- </p>
- <p >
+element in a test tree. A function call looks like this:
+ </p>
+ <p >
+ <code >
+ ${__functionName(var1,var2,var3)}
+ </code>
+ </p>
+ <p >
Where "__functionName" matches the name of a function.
-
- <br >
- </br>
+
+ <br >
+ </br>
Parentheses surround the parameters sent to the function, for example ${__time(YMD)}
The actual parameters vary from function to function.
Functions that require no parameters can leave off the parentheses, for example ${__threadNum}.
-
- </p>
- <p >
+
+ </p>
+ <p >
If a function parameter contains a comma, then be sure to escape this with "\", otherwise JMeter will treat it as a parameter delimiter.
For example:
-
- <pre >
+
+ <pre >
${__time(EEE\, d MMM yyyy)}
-
- </pre>
+
+ </pre>
-
- </p>
- <p >
+
+ </p>
+ <p >
Variables are referenced as follows:
-
- <pre >
+
+ <pre >
${VARIABLE}
-
- </pre>
+
+ </pre>
-
- </p>
- <p >
+
+ </p>
+ <p >
-
- <b >
+
+ <b >
If an undefined function or variable is referenced, JMeter does not report/log an error - the reference is returned unchanged.
For example if UNDEF is not defined as a variable, then the value of ${UNDEF} is ${UNDEF}.
-
- </b>
+
+ </b>
Variables, functions (and properties) are all case-sensitive.
-
- <b >
+
+ <b >
Versions of JMeter after 2.3.1 trim spaces from variable names before use, so for example
${__Random(1,63, LOTTERY )} will use the variable 'LOTTERY' rather than ' LOTTERY '.
-
- </b>
+
+ </b>
-
- </p>
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+
+ </p>
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td>
Properties are not the same as variables.
Variables are local to a thread; properties are common to all threads,
and need to be referenced using the __P or __property function.
-
- </td></tr>
- </table></p>
- <p >
- List of functions, loosely grouped into types.
- </p>
- <table>
- <tr>
- <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Type of function
- </font>
-</td>
- <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Name
- </font>
-</td>
- <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Comment
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Information
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__threadNum">threadNum</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- get thread number
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Information
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__machineName">machineName</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- get the local machine name
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Information
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__time">time</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- return current time in various formats
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Information
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__log">log</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- log (or display) a message (and return the value)
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Information
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__logn">logn</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- log (or display) a message (empty return value)
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Input
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__StringFromFile">StringFromFile</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- read a line from a file
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Input
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__CSVRead">CSVRead</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- read from CSV delimited file
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Input
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__XPath">XPath</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Use an XPath expression to read from a file
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Calculation
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__counter">counter</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- generate an incrementing number
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Calculation
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__intSum">intSum</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- add int numbers
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Calculation
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__longSum">longSum</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- add long numbers
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Calculation
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__Random">Random</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- generate a random number
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Calculation
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__regexFunction">regexFunction</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- parse previous response using a regular expression
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Scripting
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__BeanShell">BeanShell</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- run a BeanShell script
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Scripting
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__javaScript">javaScript</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- process JavaScript (Mozilla Rhino)
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Scripting
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__jexl">jexl</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- evaluate a Commons Jexl expression
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Properties
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__property">property</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- read a property
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Properties
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__P">P</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- read a property (shorthand method)
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Properties
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__setProperty">setProperty</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- set a JMeter property
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Variables
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__split">split</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Split a string into variables
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Variables
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__V">V</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- evaluate a variable name
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Variables
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__eval">eval</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- evaluate a variable expression
- </font>
-</td>
- </tr>
- <tr>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- Variables
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- <a href="#__evalVar">evalVar</a>
- </font>
-</td>
- <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
- <font color="#000000" size="-1" face="arial,helvetica,sanserif">
- evaluate an expression stored in a variable
- </font>
-</td>
- </tr>
- </table>
- <p >
- </p>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#828DA6">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="what_can_do"><strong>19.1 What can functions do</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p >
- There are two kinds of functions: user-defined static values (or variables), and built-in functions.
- <br >
- </br>
+
+ </td></tr>
+ </table></p>
+ <p >
+ List of functions, loosely grouped into types.
+ </p>
+ <table>
+ <tr>
+ <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Type of function
+ </font>
+</td>
+ <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Name
+ </font>
+</td>
+ <td bgcolor="#039acc" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Comment
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Information
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__threadNum">threadNum</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ get thread number
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Information
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__machineName">machineName</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ get the local machine name
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Information
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__time">time</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ return current time in various formats
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Information
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__log">log</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ log (or display) a message (and return the value)
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Information
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__logn">logn</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ log (or display) a message (empty return value)
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Input
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__StringFromFile">StringFromFile</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ read a line from a file
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Input
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__CSVRead">CSVRead</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ read from CSV delimited file
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Input
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__XPath">XPath</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Use an XPath expression to read from a file
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Calculation
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__counter">counter</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ generate an incrementing number
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Calculation
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__intSum">intSum</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ add int numbers
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Calculation
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__longSum">longSum</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ add long numbers
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Calculation
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__Random">Random</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ generate a random number
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Calculation
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__regexFunction">regexFunction</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ parse previous response using a regular expression
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Scripting
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__BeanShell">BeanShell</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ run a BeanShell script
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Scripting
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__javaScript">javaScript</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ process JavaScript (Mozilla Rhino)
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Scripting
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__jexl">jexl</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ evaluate a Commons Jexl expression
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Properties
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__property">property</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ read a property
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Properties
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__P">P</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ read a property (shorthand method)
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Properties
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__setProperty">setProperty</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ set a JMeter property
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Variables
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__split">split</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Split a string into variables
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Variables
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__V">V</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ evaluate a variable name
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Variables
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__eval">eval</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ evaluate a variable expression
+ </font>
+</td>
+ </tr>
+ <tr>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ Variables
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ <a href="#__evalVar">evalVar</a>
+ </font>
+</td>
+ <td bgcolor="#a0ddf0" colspan="" rowspan="" valign="top" align="left">
+ <font color="#000000" size="-1" face="arial,helvetica,sanserif">
+ evaluate an expression stored in a variable
+ </font>
+</td>
+ </tr>
+ </table>
+ <p >
+ </p>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="what_can_do"><strong>19.1 What can functions do</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p >
+ There are two kinds of functions: user-defined static values (or variables), and built-in functions.
+ <br >
+ </br>
User-defined static values allow the user to define variables to be replaced with their static value when
a test tree is compiled and submitted to be run. This replacement happens once at the beginning of the test
run. This could be used to replace the DOMAIN field of all HTTP requests, for example - making it a simple
matter to change a test to target a different server with the same test.
-
- </p>
- <p >
+
+ </p>
+ <p >
Note that variables cannot currently be nested; i.e ${Var${N}} does not work.
The __V (variable) function (versions after 2.2) can be used to do this: ${__V(Var${N})}.
In earlier JMeter versions one can use ${__BeanShell(vars.get("Var${N}")}.
-
- </p>
- <p >
+
+ </p>
+ <p >
This type of replacement is possible without functions, but was less convenient and less intuitive.
It required users to create default config elements that would fill in blank values of Samplers.
-Variables allow one to replace only part of any given value, not just filling in blank values.
- </p>
- <p >
+Variables allow one to replace only part of any given value, not just filling in blank values.
+ </p>
+ <p >
With built-in functions users can compute new values at run-time based on previous response data, which
thread the function is in, the time, and many other sources. These values are generated fresh for every
-request throughout the course of the test.
- </p>
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+request throughout the course of the test.
+ </p>
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td> Functions are shared between threads.
-Each occurrence of a function call in a test plan is handled by a separate function instance.
- </td></tr>
- </table></p>
- </blockquote>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#828DA6">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="where"><strong>19.2 Where can functions and variables be used?</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p >
+Each occurrence of a function call in a test plan is handled by a separate function instance.
+ </td></tr>
+ </table></p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="where"><strong>19.2 Where can functions and variables be used?</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p >
Functions and variables can be written into any field of any test component (apart from the TestPlan - see below).
Some fields do not allow random strings
because they are expecting numbers, and thus will not accept a function. However, most fields will allow
functions.
-
- </p>
- <p >
+
+ </p>
+ <p >
Functions which are used on the Test Plan have some restrictions.
JMeter thread variables will have not been fully set up when the functions are processed,
@@ -698,644 +698,644 @@
so split() and regex() and the variable evaluation functions won't work.
The threadNum() function won't work (and does not make sense at test plan level).
The following functions should work OK on the test plan:
-
- <ul >
+
+ <ul >
-
- <li >
- intSum
- </li>
-
-
- <li >
- longSum
- </li>
-
-
- <li >
- machineName
- </li>
-
-
- <li >
- BeanShell
- </li>
-
-
- <li >
- javaScript
- </li>
-
-
- <li >
- jexl
- </li>
-
-
- <li >
- random
- </li>
-
-
- <li >
- time
- </li>
-
-
- <li >
- property functions
- </li>
-
-
- <li >
- log functions
- </li>
-
-
- </ul>
-
-
- </p>
- <p >
+
+ <li >
+ intSum
+ </li>
+
+
+ <li >
+ longSum
+ </li>
+
+
+ <li >
+ machineName
+ </li>
+
+
+ <li >
+ BeanShell
+ </li>
+
+
+ <li >
+ javaScript
+ </li>
+
+
+ <li >
+ jexl
+ </li>
+
+
+ <li >
+ random
+ </li>
+
+
+ <li >
+ time
+ </li>
+
+
+ <li >
+ property functions
+ </li>
+
+
+ <li >
+ log functions
+ </li>
+
+
+ </ul>
+
+
+ </p>
+ <p >
Configuration elements are processed by a separate thread.
Therefore functions such as __threadNum do not work properly in elements such as User Defined Variables.
Also note that variables defined in a UDV element are not available until the element has been processed.
-
- </p>
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+
+ </p>
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td> When using variable/function references in SQL code (etc),
remember to include any necessary quotes for text strings,
-i.e. use
- <br >
- </br>
+i.e. use
+ <br >
+ </br>
SELECT item from table where name='${VAR}'
-
- <br >
- </br>
- <b >
- not
- </b>
-
-
- <br >
- </br>
+
+ <br >
+ </br>
+ <b >
+ not
+ </b>
+
+
+ <br >
+ </br>
SELECT item from table where name=${VAR}
-
- <br >
- </br>
+
+ <br >
+ </br>
(unless VAR itself contains the quotes)
-
- </td></tr>
- </table></p>
- </blockquote>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#828DA6">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="how"><strong>19.3 How to reference variables and functions</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p >
- Referencing a variable in a test element is done by bracketing the variable name with '${' and '}'.
- </p>
- <p >
+
+ </td></tr>
+ </table></p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="how"><strong>19.3 How to reference variables and functions</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p >
+ Referencing a variable in a test element is done by bracketing the variable name with '${' and '}'.
+ </p>
+ <p >
Functions are referenced in the same manner, but by convention, the names of
-functions begin with "__" to avoid conflict with user value names
- <sup >
- *
- </sup>
+functions begin with "__" to avoid conflict with user value names
+ <sup >
+ *
+ </sup>
. Some functions take arguments to
configure them, and these go in parentheses, comma-delimited. If the function takes no arguments, the parentheses can
-be omitted.
- </p>
- <p >
+be omitted.
+ </p>
+ <p >
Argument values that themselves contain commas should be escaped as necessary.
If you need to include a comma in your parameter value, escape it like so: '\,'.
This applies for example to the scripting functions - Javascript, Beanshell, Jexl - where it is necessary to escape any commas
that may be needed in script method calls - e.g.
-
- </p>
- <pre >
+
+ </p>
+ <pre >
${__BeanShell(vars.put("name"\,"value"))}
-
- </pre>
- <p >
+
+ </pre>
+ <p >
Functions can reference variables and other functions, for example
-
- <code >
- ${__XPath(${__P(xpath.file),${XPATH})}
- </code>
+
+ <code >
+ ${__XPath(${__P(xpath.file),${XPATH})}
+ </code>
will use the property "xpath.file" as the file name
and the contents of the variable XPATH as the expression to search for.
-
- </p>
- <p >
+
+ </p>
+ <p >
JMeter provides a tool to help you construct
function calls for various built-in functions, which you can then copy-paste.
-It will not automatically escape values for you, since functions can be parameters to other functions, and you should only escape values you intend as literal.
- </p>
- <p >
-
-
- <b >
- The value of a variable or function can be reported
- </b>
- using the
- <a href="#__logn">
- __logn()
- </a>
+It will not automatically escape values for you, since functions can be parameters to other functions, and you should only escape values you intend as literal.
+ </p>
+ <p >
+
+
+ <b >
+ The value of a variable or function can be reported
+ </b>
+ using the
+ <a href="#__logn">
+ __logn()
+ </a>
function.
The __logn() function reference can be used anywhere in the test plan after the variable has been defined.
Alternatively, the Java Request sampler can be used to create a sample containing variable references;
the output will be shown in the appropriate Listener.
-For versions of JMeter later than 2.3, there is a
- <a href="../usermanual/component_reference.html#Debug_Sampler">Debug Sampler</a>
+For versions of JMeter later than 2.3, there is a
+ <a href="../usermanual/component_reference.html#Debug_Sampler">Debug Sampler</a>
that can be used to display the values of variables etc in the Tree View Listener.
-
- </p>
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
- <tr><td> <sup >
- *
- </sup>
+
+ </p>
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+ <tr><td> <sup >
+ *
+ </sup>
If you define a user-defined static variable with the same name as a built-in function, your static
-variable will override the built-in function.
- </td></tr>
- </table></p>
- </blockquote>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#828DA6">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="function_helper"><strong>19.4 The Function Helper Dialog</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <p >
- The Function Helper dialog is available from JMeter's Tools menu.
- </p>
- <p><table border="0" cellspacing="0" cellpadding="0"><tr><td><img src="../images/screenshots/function_helper_dialog.png"><br>
- <font size="-1"> Function Helper Dialog
- </font></td></tr></table></p>
- <p >
+variable will override the built-in function.
+ </td></tr>
+ </table></p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="function_helper"><strong>19.4 The Function Helper Dialog</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <p >
+ The Function Helper dialog is available from JMeter's Tools menu.
+ </p>
+ <p><table border="0" cellspacing="0" cellpadding="0"><tr><td><img src="../images/screenshots/function_helper_dialog.png"><br>
+ <font size="-1"> Function Helper Dialog
+ </font></td></tr></table></p>
+ <p >
Using the Function Helper, you can select a function from the pull down, and assign
values for its arguments. The left column in the table provides a brief description of the
argument, and the right column is where you write in the value for that argument. Different
-functions take different arguments.
- </p>
- <p >
+functions take different arguments.
+ </p>
+ <p >
Once you have done this, click the "generate" button, and the appropriate string is generated
-for you to copy-paste into your test plan wherever you like.
- </p>
- </blockquote>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <table border="0" cellspacing="0" cellpadding="2" width="100%">
- <tr><td bgcolor="#828DA6">
- <font color="#ffffff" face="arial,helvetica,sanserif">
- <a name="functions"><strong>19.5 Functions</strong></a>
- </font>
- </td></tr>
- <tr><td>
- <blockquote>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__regexFunction">19.5.1 __regexFunction</h3></a>
- </font>
- </td></tr>
- <tr><td>
- <p >
+for you to copy-paste into your test plan wherever you like.
+ </p>
+ </blockquote>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <table border="0" cellspacing="0" cellpadding="2" width="100%">
+ <tr><td bgcolor="#828DA6">
+ <font color="#ffffff" face="arial,helvetica,sanserif">
+ <a name="functions"><strong>19.5 Functions</strong></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <blockquote>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__regexFunction">19.5.1 __regexFunction</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <p >
The Regex Function is used to parse the previous response (or the value of a variable) using any regular
expression (provided by user). The function returns the template string with variable values filled
-in.
- </p>
+in.
+ </p>
-
- <p >
+
+ <p >
The __regexFunction can also store values for future use. In the sixth parameter, you can specify
a reference name. After this function executes, the same values can be retrieved at later times
using the syntax for user-defined values. For instance, if you enter "refName" as the sixth
parameter you will be able to use:
-
- <ul >
+
+ <ul >
-
- <li >
+
+ <li >
${refName} to refer to the computed result of the second parameter ("Template for the
-replacement string") parsed by this function
- </li>
+replacement string") parsed by this function
+ </li>
+
+
+ <li >
+ ${refName_g0} to refer to the entire match parsed by this function.
+ </li>
+
+
+ <li >
+ ${refName_g1} to refer to the first group parsed by this function.
+ </li>
+
+
+ <li >
+ ${refName_g#} to refer to the n
+ <sup >
+ th
+ </sup>
+ group parsed by this function.
+ </li>
+
+
+ <li >
+ ${refName_matchNr} to refer to the number of groups found by this function.
+ </li>
+
+
+ </ul>
+
+
+ </p>
-
- <li >
- ${refName_g0} to refer to the entire match parsed by this function.
- </li>
-
-
- <li >
- ${refName_g1} to refer to the first group parsed by this function.
- </li>
-
-
- <li >
- ${refName_g#} to refer to the n
- <sup >
- th
- </sup>
- group parsed by this function.
- </li>
-
-
- <li >
- ${refName_matchNr} to refer to the number of groups found by this function.
- </li>
-
-
- </ul>
-
-
- </p>
-
-
- <p>
- <b>Parameters</b>
- <table border="1" cellspacing="0" cellpadding="2">
- <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
- <tr>
- <td>First argument</td>
+
+ <p>
+ <b>Parameters</b>
+ <table border="1" cellspacing="0" cellpadding="2">
+ <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <td>First argument</td>
<td> The first argument is the regular expression
to be applied to the response data. It will grab all matches. Any parts of this expression
that you wish to use in your template string, be sure to surround in parentheses. Example:
<a href="(.*)">. This will grab the value of the link and store it as the first group (there is
only 1 group). Another example: <input type="hidden" name="(.*)" value="(.*)">. This will
grab the name as the first group, and the value as the second group. These values can be used
- in your template string
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Second argument</td>
+ in your template string
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Second argument</td>
<td> This is the template string that will replace
the function at run-time. To refer to a group captured in the regular expression, use the syntax:
- $[group_number]$. Ie: $1$, or $2$. Your template can be any string.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Third argument</td>
+ $[group_number]$. Ie: $1$, or $2$. Your template can be any string.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Third argument</td>
<td> The third argument tells JMeter which match
to use. Your regular expression might find numerous matches. You have four choices:
-
- <ul >
- <li >
+
+ <ul >
+ <li >
An integer - Tells JMeter to use that match. '1' for the first found match, '2' for the
- second, and so on
- </li>
+ second, and so on
+ </li>
-
- <li >
- RAND - Tells JMeter to choose a match at random.
- </li>
+
+ <li >
+ RAND - Tells JMeter to choose a match at random.
+ </li>
-
- <li >
+
+ <li >
ALL - Tells JMeter to use all matches, and create a template string for each one and then
- append them all together. This option is little used.
- </li>
+ append them all together. This option is little used.
+ </li>
-
- <li >
+
+ <li >
A float number between 0 and 1 - tells JMeter to find the Xth match using the formula:
- (number_of_matches_found * float_number) rounded to nearest integer.
- </li>
+ (number_of_matches_found * float_number) rounded to nearest integer.
+ </li>
-
- </ul>
- </td>
- <td>
- No, default=1
- </td>
- </tr>
- <tr>
- <td>Fourth argument</td>
+
+ </ul>
+ </td>
+ <td>
+ No, default=1
+ </td>
+ </tr>
+ <tr>
+ <td>Fourth argument</td>
<td> If 'ALL' was selected for the above argument
- value, then this argument will be inserted between each appended copy of the template value.
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>Fifth argument</td>
- <td> Default value returned if no match is found
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>Sixth argument</td>
- <td> A reference name for reusing the values parsed by this function.
- <br >
- </br>
+ value, then this argument will be inserted between each appended copy of the template value.
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>Fifth argument</td>
+ <td> Default value returned if no match is found
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>Sixth argument</td>
+ <td> A reference name for reusing the values parsed by this function.
+ <br >
+ </br>
Stored values are ${refName} (the replacement template string) and ${refName_g#} where "#" is the
- group number from the regular expression ("0" can be used to refer to the entire match).
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>Seventh argument</td>
+ group number from the regular expression ("0" can be used to refer to the entire match).
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>Seventh argument</td>
<td> Input variable name.
If specified, then the value of the variable is used as the input instead of using the previous sample result.
-
- </td>
- <td>
- No
- </td>
- </tr>
- </table>
- </p>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <hr>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__counter">19.5.2 __counter</h3></a>
- </font>
- </td></tr>
- <tr><td>
- <p >
+
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ </table>
+ </p>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <hr>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__counter">19.5.2 __counter</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <p >
The counter generates a new number each time it is called, starting with 1
and incrementing by +1 each time. The counter can be configured to keep each simulated user's values
separate, or to use the same counter for all users. If each user's values is incremented separately,
that is like counting the number of iterations through the test plan. A global counter is like
counting how many times that request was run.
-
- </p>
+
+ </p>
-
- <p >
- The counter uses an integer variable to hold the count, which therefore has a maximum of 2,147,483,647.
- </p>
+
+ <p >
+ The counter uses an integer variable to hold the count, which therefore has a maximum of 2,147,483,647.
+ </p>
-
- <p >
+
+ <p >
The counter function instances are now completely independent.
[JMeter 2.1.1 and earlier used a fixed thread variable to keep track of the per-user count,
so multiple counter functions operated on the same value.]
The global counter - "FALSE" - is separately maintained by each counter instance.
-
- </p>
+
+ </p>
-
- <p>
- <b>Parameters</b>
- <table border="1" cellspacing="0" cellpadding="2">
- <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
- <tr>
- <td>First argument</td>
+
+ <p>
+ <b>Parameters</b>
+ <table border="1" cellspacing="0" cellpadding="2">
+ <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <td>First argument</td>
<td> TRUE if you wish each simulated user's counter
- to be kept independent and separate from the other users. FALSE for a global counter.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Second argument</td>
- <td> A reference name for reusing the value created by this function.
- <br >
- </br>
+ to be kept independent and separate from the other users. FALSE for a global counter.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Second argument</td>
+ <td> A reference name for reusing the value created by this function.
+ <br >
+ </br>
Stored values are of the form ${refName}. This allows you to keep one counter and refer to its value in
- multiple places. [For JMeter 2.1.1 and earlier this parameter was required.]
- </td>
- <td>
- No
- </td>
- </tr>
- </table>
- </p>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <hr>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__threadNum">19.5.3 __threadNum</h3></a>
- </font>
- </td></tr>
- <tr><td>
- <p >
+ multiple places. [For JMeter 2.1.1 and earlier this parameter was required.]
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ </table>
+ </p>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <hr>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__threadNum">19.5.3 __threadNum</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <p >
The thread number function simply returns the number of the thread currently
being executed. These numbers are independent of ThreadGroup, meaning thread #1 in one threadgroup
-is indistinguishable from thread #1 in another threadgroup, from the point of view of this function.
- </p>
+is indistinguishable from thread #1 in another threadgroup, from the point of view of this function.
+ </p>
-
- <p >
- There are no arguments for this function.
- </p>
+
+ <p >
+ There are no arguments for this function.
+ </p>
-
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td>
This function does not work in any Configuration elements (e.g. User Defined Variables) as these are run from a separate thread.
Nor does it make sense to use it on the Test Plan.
-
- </td></tr>
- </table></p>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <hr>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__intSum">19.5.4a __intSum</h3></a>
- </font>
- </td></tr>
- <tr><td>
+
+ </td></tr>
+ </table></p>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <hr>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__intSum">19.5.4a __intSum</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
-
- <p >
+
+ <p >
The intSum function can be used to compute the sum of two or more integer values.
-
- </p>
+
+ </p>
-
- <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
+
+ <p><table border="1" bgcolor="#bbbb00" width="50%" cellspacing="0" cellpadding="2">
<tr><td>
JMeter Versions 2.3.1 and earlier required the reference name to be present.
The reference name is now optional, but it must not be a valid integer.
-
- </td></tr>
- </table></p>
-
-
- <p>
- <b>Parameters</b>
- <table border="1" cellspacing="0" cellpadding="2">
- <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
- <tr>
- <td>First argument</td>
- <td> The first int value.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Second argument</td>
- <td> The second int value.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>nth argument</td>
- <td> The nth int value.
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>last argument</td>
+
+ </td></tr>
+ </table></p>
+
+
+ <p>
+ <b>Parameters</b>
+ <table border="1" cellspacing="0" cellpadding="2">
+ <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <td>First argument</td>
+ <td> The first int value.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Second argument</td>
+ <td> The second int value.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>nth argument</td>
+ <td> The nth int value.
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>last argument</td>
<td> A reference name for reusing the value computed by this function.
If specified, the reference name must contain at least one non-numeric character otherwise it will
be treated as another int value to be added.
-
- </td>
- <td>
- No
- </td>
- </tr>
- </table>
- </p>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <hr>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__longSum">19.5.4b __longSum</h3></a>
- </font>
- </td></tr>
- <tr><td>
- <p >
+
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ </table>
+ </p>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <hr>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__longSum">19.5.4b __longSum</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
+ <p >
The longSum function can be used to compute the sum of two or more long values.
-
- </p>
- <p>
- <b>Parameters</b>
- <table border="1" cellspacing="0" cellpadding="2">
- <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
- <tr>
- <td>First argument</td>
- <td> The first long value.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Second argument</td>
- <td> The second long value.
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>nth argument</td>
- <td> The nth long value.
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>last argument</td>
+
+ </p>
+ <p>
+ <b>Parameters</b>
+ <table border="1" cellspacing="0" cellpadding="2">
+ <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <td>First argument</td>
+ <td> The first long value.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Second argument</td>
+ <td> The second long value.
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>nth argument</td>
+ <td> The nth long value.
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>last argument</td>
<td> A reference name for reusing the value computed by this function.
If specified, the reference name must contain at least one non-numeric character otherwise it will
be treated as another long value to be added.
-
- </td>
- <td>
- No
- </td>
- </tr>
- </table>
- </p>
- </td></tr>
- <tr><td><br></td></tr>
- </table>
- <hr>
- <a name="_StringFromFile">
- </a>
- <table border="0" cellspacing="0" cellpadding="2">
- <tr><td>
- <font face="arial,helvetica,sanserif">
- <h3><a name="__StringFromFile">19.5.5 __StringFromFile</h3></a>
- </font>
- </td></tr>
- <tr><td>
+
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ </table>
+ </p>
+ </td></tr>
+ <tr><td><br></td></tr>
+ </table>
+ <hr>
+ <a name="_StringFromFile">
+ </a>
+ <table border="0" cellspacing="0" cellpadding="2">
+ <tr><td>
+ <font face="arial,helvetica,sanserif">
+ <h3><a name="__StringFromFile">19.5.5 __StringFromFile</h3></a>
+ </font>
+ </td></tr>
+ <tr><td>
-
- <p >
+
+ <p >
The StringFromFile function can be used to read strings from a text file.
This is useful for running tests that require lots of variable data.
For example when testing a banking application, 100s or 1000s of different account numbers might be required.
-
- </p>
+
+ </p>
-
- <p >
+
+ <p >
See also the
-
- <a href="component_reference.html#CSV_Data_Set_Config">
- CSV Data Set Config test element
- </a>
+
+ <a href="component_reference.html#CSV_Data_Set_Config">
+ CSV Data Set Config test element
+ </a>
which may be easier to use. However, that does not currently support multiple input files.
-
- </p>
+
+ </p>
-
- <p >
+
+ <p >
Each time it is called it reads the next line from the file.
When the end of the file is reached, it will start reading again from the beginning,
@@ -1343,1037 +1343,1037 @@
If there are multiple references to the function in a test script, each will open the file independently,
even if the file names are the same.
[If the value is to be used again elsewhere, use different variable names for each function call.]
-
- </p>
+
+ </p>
+
+
+ <p >
+ If an error occurs opening or reading the file, then the function returns the string "**ERR**"
+ </p>
-
- <p >
- If an error occurs opening or reading the file, then the function returns the string "**ERR**"
- </p>
-
-
- <p>
- <b>Parameters</b>
- <table border="1" cellspacing="0" cellpadding="2">
- <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
- <tr>
- <td>File Name</td>
+
+ <p>
+ <b>Parameters</b>
+ <table border="1" cellspacing="0" cellpadding="2">
+ <tr><th>Attribute</th><th>Description</th><th>Required</th></tr>
+ <tr>
+ <td>File Name</td>
<td> Path to the file name.
(The path can be relative to the JMeter launch directory)
If using optional sequence numbers, the path name should be suitable for passing to DecimalFormat.
See below for examples.
-
- </td>
- <td>
- Yes
- </td>
- </tr>
- <tr>
- <td>Variable Name</td>
+
+ </td>
+ <td>
+ Yes
+ </td>
+ </tr>
+ <tr>
+ <td>Variable Name</td>
<td>
A reference name - refName - for reusing the value created by this function. Stored values are of the form ${refName}.
Defaults to "StringFromFile_".
-
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>Start sequence number</td>
- <td> Initial Sequence number (if omitted, the End sequence number is treated as a loop count)
- </td>
- <td>
- No
- </td>
- </tr>
- <tr>
- <td>End sequence number</td>
- <td> Final sequence number (if omitted, seqence numbers can increase without limit)
- </td>
- <td>
- No
- </td>
- </tr>
- </table>
- </p>
- <p >
- The file name parameter is resolved when the file is opened or re-opened.
- </p>
- <p >
- The reference name parameter (if supplied) is resolved every time the function is executed.
- </p>
- <p >
- <b >
- Using sequence numbers:
- </b>
- </p>
- <p >
+
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>Start sequence number</td>
+ <td> Initial Sequence number (if omitted, the End sequence number is treated as a loop count)
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ <tr>
+ <td>End sequence number</td>
+ <td> Final sequence number (if omitted, seqence numbers can increase without limit)
+ </td>
+ <td>
+ No
+ </td>
+ </tr>
+ </table>
+ </p>
+ <p >
+ The file name parameter is resolved when the file is opened or re-opened.
+ </p>
+ <p >
+ The reference name parameter (if supplied) is resolved every time the function is executed.
+ </p>
+ <p >
+ <b >
+ Using sequence numbers:
+ </b>
+ </p>
+ <p >
When using the optional sequence numbers, the path name is used as the format string for java.text.DecimalFormat.
The current sequence number is passed in as the only parameter.
If the optional start number is not specified, the path name is used as is.
Useful formatting sequences are:
-
- </p>
- <p >
-
-
- <code >
-
-# - insert the number, with no leading zeros or spaces
- <br >
- </br>
+
+ </p>
+ <p >
+
+
+ <code >
+
+# - insert the number, with no leading zeros or spaces
+ <br >
+ </br>
000 - insert the number packed out to 3 digits with leading zeros if necessary
-
- <p >
- </p>
-
-Examples:
- <br >
- </br>
-
- pin#'.'dat -> pin1.dat, ... pin9.dat, pin10.dat, ... pin9999.dat
- <br >
- </br>
-
- pin000'.'dat -> pin001.dat ... pin099.dat ... pin999.dat ... pin9999.dat
- <br >
- </br>
+
+ <p >
+ </p>
+
+Examples:
+ <br >
+ </br>
+
+ pin#'.'dat -> pin1.dat, ... pin9.dat, pin10.dat, ... pin9999.dat
+ <br >
+ </br>
+
+ pin000'.'dat -> pin001.dat ... pin099.dat ... pin999.dat ... pin9999.dat
+ <br >
+ </br>
pin'.'dat# -> pin.dat1, ... pin.dat9 ... pin.dat999
-
- </code>
- <p >
- </p>
+
+ </code>
+ <p >
+ </p>
If more digits are required than there are formatting characters, the number will be
- expanded as necessary.
- <br >
- </br>
+ expanded as necessary.
+ <br >
+ </br>
-
- <b >
+
+ <b >
To prevent a formatting character from being interpreted,
enclose it in single quotes. Note that "." is a formatting character,
- and must be enclosed in single quotes
- </b>
+ and must be enclosed in single quotes
+ </b>
(though #. and 000. work as expected in locales where the decimal point is also ".")
-
- <br >
- </br>
+
+ <br >
+ </br>
In other locales (e.g. fr), the decimal point is "," - which means that "#."
- becomes "nnn,".
- <br >
- </br>
-
- See the documentation for DecimalFormat for full details.
- <br >
- </br>
+ becomes "nnn,".
+ <br >
+ </br>
+
+ See the documentation for DecimalFormat for full details.
+ <br >
+ </br>
If the path name does not contain any special formatting characters,
the current sequence number will be appended to the name, otherwise
- the number will be inserted aaccording to the fomatting instructions.
- <br >
- </br>
+ the number will be inserted aaccording to the fomatting instructions.
+ <br >
+ </br>
If the start sequence number is omitted, and the end sequence number is specified,
the sequence number is interpreted as a loop count, and the file will be used at most "end" times.
In this case the filename is not formatted.
-
[... 3075 lines stripped ...]
---------------------------------------------------------------------
To unsubscribe, e-mail: jmeter-dev-unsubscribe@jakarta.apache.org
For additional commands, e-mail: jmeter-dev-help@jakarta.apache.org