Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

Project28JMeter/ApacheJmeter/xdocs/usermanual/functions.xml

Go to file
 
 
Cannot retrieve contributors at this time
1226 lines (1134 sloc) 56.2 KB
Raw Blame
Open in GitHub Desktop
<?xml version="1.0"?>
<!--
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.
-->
<!DOCTYPE document
[
<!ENTITY sect-num '19'>
]>
<document prev="component_reference.html" next="regular_expressions.html" id="$Id: functions.xml 1340703 2012-05-20 12:56:55Z sebb $">
<properties>
<title>User's Manual: Functions and Variables</title>
</properties>
<body>
<!--
Because this is an XML document, all tags must be properly closed, including ones
which are passed unchanged into the HTML output, e.g. <br/>, not just <br>.
Unfortunately Java does not currently allow for this - it outputs the trailing > -
which messes up the Help display.
To avoid these artefacts, use the form <br></br>, which Java does seem to handle OK.
-->
<section name="&sect-num;. Functions and Variables" anchor="functions">
<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>
Where "__functionName" matches the name of a function.
<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>
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>
${__time(EEE\, d MMM yyyy)}
</pre>
</p>
<p>Variables are referenced as follows:
<pre>
${VARIABLE}
</pre>
</p>
<p>
<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>
Variables, functions (and properties) are all case-sensitive.
<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>
</p>
<note>
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.
</note>
<p>List of functions, loosely grouped into types.</p>
<table border="1">
<tr><th>Type of function</th><th>Name</th><th>Comment</th><th>Since</th></tr>
<!-- N.B. the leading space is needed to ensure the content is processed -->
<tr><td>Information</td><td> <a href="#__threadNum">threadNum</a></td><td>get thread number</td><td>1.X</td></tr>
<tr><td>Information</td><td> <a href="#__samplerName">samplerName</a></td><td>get the sampler name (label)</td><td>2.5</td></tr>
<tr><td>Information</td><td> <a href="#__machineIP">machineIP</a></td><td>get the local machine IP address</td><td>2.6</td></tr>
<tr><td>Information</td><td> <a href="#__machineName">machineName</a></td><td>get the local machine name</td><td>1.X</td></tr>
<tr><td>Information</td><td> <a href="#__time">time</a></td><td>return current time in various formats</td><td>2.2</td></tr>
<tr><td>Information</td><td> <a href="#__log">log</a></td><td>log (or display) a message (and return the value)</td><td>2.2</td></tr>
<tr><td>Information</td><td> <a href="#__logn">logn</a></td><td>log (or display) a message (empty return value)</td><td>2.2</td></tr>
<tr><td>Input</td><td> <a href="#__StringFromFile">StringFromFile</a></td><td>read a line from a file</td><td>1.9</td></tr>
<tr><td>Input</td><td> <a href="#__FileToString">FileToString</a></td><td>read an entire file</td><td>2.4</td></tr>
<tr><td>Input</td><td> <a href="#__CSVRead">CSVRead</a></td><td>read from CSV delimited file</td><td>1.9</td></tr>
<tr><td>Input</td><td> <a href="#__XPath">XPath</a></td><td>Use an XPath expression to read from a file</td><td>2.0.3</td></tr>
<tr><td>Calculation</td><td> <a href="#__counter">counter</a></td><td>generate an incrementing number</td><td>1.X</td></tr>
<tr><td>Calculation</td><td> <a href="#__intSum">intSum</a></td><td>add int numbers</td><td>1.8.1</td></tr>
<tr><td>Calculation</td><td> <a href="#__longSum">longSum</a></td><td>add long numbers</td><td>2.3.2</td></tr>
<tr><td>Calculation</td><td> <a href="#__Random">Random</a></td><td>generate a random number</td><td>1.9</td></tr>
<tr><td>Calculation</td><td> <a href="#__RandomString">RandomString</a></td><td>generate a random string</td><td>2.6</td></tr>
<tr><td>Scripting</td><td> <a href="#__BeanShell">BeanShell</a></td><td>run a BeanShell script</td><td>1.X</td></tr>
<tr><td>Scripting</td><td> <a href="#__javaScript">javaScript</a></td><td>process JavaScript (Mozilla Rhino)</td><td>1.9</td></tr>
<tr><td>Scripting</td><td> <a href="#__jexl">jexl, jexl2</a></td><td>evaluate a Commons Jexl expression</td><td>jexl(2.2), jexl2(2.6)</td></tr>
<tr><td>Properties</td><td> <a href="#__property">property</a> </td><td>read a property</td><td>2.0</td></tr>
<tr><td>Properties</td><td> <a href="#__P">P</a></td><td>read a property (shorthand method)</td><td>2.0</td></tr>
<tr><td>Properties</td><td> <a href="#__setProperty">setProperty</a></td><td>set a JMeter property</td><td>2.1</td></tr>
<tr><td>Variables</td><td> <a href="#__split">split</a></td><td>Split a string into variables</td><td>2.0.2</td></tr>
<tr><td>Variables</td><td> <a href="#__V">V</a></td><td>evaluate a variable name</td><td>2.3RC3</td></tr>
<tr><td>Variables</td><td> <a href="#__eval">eval</a></td><td>evaluate a variable expression</td><td>2.3.1</td></tr>
<tr><td>Variables</td><td> <a href="#__evalVar">evalVar</a></td><td>evaluate an expression stored in a variable</td><td>2.3.1</td></tr>
<tr><td>String</td><td> <a href="#__regexFunction">regexFunction</a></td><td>parse previous response using a regular expression</td><td>1.X</td></tr>
<tr><td>String</td><td> <a href="#__char">char</a></td><td>generate Unicode char values from a list of numbers</td><td>2.3.3</td></tr>
<tr><td>String</td><td> <a href="#__unescape">unescape</a></td><td>Process strings containing Java escapes (e.g. \n &amp; \t)</td><td>2.3.3</td></tr>
<tr><td>String</td><td> <a href="#__unescapeHtml">unescapeHtml</a></td><td>Decode HTML-encoded strings</td><td>2.3.3</td></tr>
<tr><td>String</td><td> <a href="#__escapeHtml">escapeHtml</a></td><td>Encode strings using HTML encoding</td><td>2.3.3</td></tr>
<tr><td>String</td><td> <a href="#__TestPlanName">TestPlanName</a></td><td>Return name of current test plan</td><td>2.6</td></tr>
</table>
<p></p>
<subsection name="&sect-num;.1 What can functions do" anchor="what_can_do">
<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>
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>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>
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>
<note>Functions are shared between threads.
Each occurrence of a function call in a test plan is handled by a separate function instance.</note>
</subsection>
<subsection name="&sect-num;.2 Where can functions and variables be used?" anchor="where">
<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>
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,
so variable names passed as parameters will not be set up, and variable references will not work,
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>
<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>
<note>When using variable/function references in SQL code (etc),
remember to include any necessary quotes for text strings,
i.e. use<br></br>
SELECT item from table where name='${VAR}'
<br></br><b>not</b>
<br></br>
SELECT item from table where name=${VAR}
<br></br>(unless VAR itself contains the quotes)
</note>
</subsection>
<subsection name="&sect-num;.3 How to reference variables and functions" anchor="how">
<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>. 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><b>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: '\,'.</b>
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>
${__BeanShell(vars.put("name"\,"value"))}
</pre>
<p>
Alternatively, you can define your script as a variable, e.g. on the Test Plan:
<pre>SCRIPT vars.put("name","value")</pre>
The script can then be referenced as follows:
<pre>${__BeanShell(${SCRIPT})}</pre>
There is no need to escape commas in the SCRIPT variable because the function call is parsed before the variable is replaced with its value.
This works well in conjunction with the BSF or BeanShell Samplers, as these can be used to test Javascript, Jexl and BeanShell scripts.
</p>
<p>
Functions can reference variables and other functions, for example
<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>
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>
<note>
If a string contains a backslash('\') and also contains a function or variable reference, the backslash will be removed if
it appears before '$' or ',' or '\'.
This behaviour is necessary to allow for nested functions that include commas or the string ${.
Backslashes before '$' or ',' or '\' are not removed if the string does not contain a function or variable reference.
</note>
<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 <complink name="Debug Sampler"/>
that can be used to display the values of variables etc in the Tree View Listener.
</p>
<note><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.</note>
</subsection>
<subsection name="&sect-num;.4 The Function Helper Dialog" anchor="function_helper">
<p>The Function Helper dialog is available from JMeter's Tools menu.</p>
<figure width="667" height="326" image="function_helper_dialog.png">Function Helper Dialog</figure>
<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>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>
</subsection>
<subsection name="&sect-num;.5 Functions" anchor="functions">
<component index="&sect-num;.5.1" name="__regexFunction">
<description><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>
<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>
<li>${refName} to refer to the computed result of the second parameter ("Template for the
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>
</description>
<properties>
<property name="First argument" required="Yes">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:
&amp;lt;a href="(.*)"&amp;gt;. This will grab the value of the link and store it as the first group (there is
only 1 group). Another example: &amp;lt;input type="hidden" name="(.*)" value="(.*)"&amp;gt;. 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</property>
<property name="Second argument" required="Yes">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.</property>
<property name="Third argument" required="No, default=1">The third argument tells JMeter which match
to use. Your regular expression might find numerous matches. You have four choices:
<ul><li>An integer - Tells JMeter to use that match. '1' for the first found match, '2' for the
second, and so on</li>
<li>RAND - Tells JMeter to choose a match at random.</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>
<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>
</ul></property>
<property name="Fourth argument" required="No">If 'ALL' was selected for the above argument
value, then this argument will be inserted between each appended copy of the template value.</property>
<property name="Fifth argument" required="No">Default value returned if no match is found</property>
<property name="Sixth argument" required="No">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).</property>
<property name="Seventh argument" required="No">Input variable name.
If specified, then the value of the variable is used as the input instead of using the previous sample result.
</property>
</properties>
</component>
<component index="&sect-num;.5.2" name="__counter">
<description><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>The counter uses an integer variable to hold the count, which therefore has a maximum of 2,147,483,647.</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>
<b>
Multiple __counter function calls in the same iteration won't increment the value further.
</b>
<br/>
If you want to have a count that increments for each sample, use the function in a Pre-Processor such as <complink name="User Parameters"/>.
</p>
</description>
<properties>
<property name="First argument" required="Yes">TRUE if you wish each simulated user's counter
to be kept independent and separate from the other users. FALSE for a global counter.</property>
<property name="Second argument" required="No">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.]</property>
</properties>
</component>
<component index="&sect-num;.5.3" name="__threadNum">
<description><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>
<p>There are no arguments for this function.</p>
</description>
<note>
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.
</note>
</component>
<component index="&sect-num;.5.4a" name="__intSum">
<description>
<p>
The intSum function can be used to compute the sum of two or more integer values.
</p>
<note>
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.
</note>
</description>
<properties>
<property name="First argument" required="Yes">The first int value.</property>
<property name="Second argument" required="Yes">The second int value.</property>
<property name="nth argument" required="No">The nth int value.</property>
<property name="last argument" required="No">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.
</property>
</properties>
</component>
<component index="&sect-num;.5.4b" name="__longSum">
<description><p>The longSum function can be used to compute the sum of two or more long values.
</p></description>
<properties>
<property name="First argument" required="Yes">The first long value.</property>
<property name="Second argument" required="Yes">The second long value.</property>
<property name="nth argument" required="No">The nth long value.</property>
<property name="last argument" required="No">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.
</property>
</properties>
</component>
<!-- Alternate spelling -->
<a name="_StringFromFile"/>
<component index="&sect-num;.5.5" name="__StringFromFile">
<description>
<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>
See also the
<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>
Each time it is called it reads the next line from the file.
All threads share the same instance, so different threads will get different lines.
When the end of the file is reached, it will start reading again from the beginning,
unless the maximum loop count has been reached.
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>
<note>
Function instances are shared between threads, and the file is (re-)opened by whatever thread
happens to need the next line of input, so using the threadNumber as part of the file name
will result in unpredictable behaviour.
</note>
<p>If an error occurs opening or reading the file, then the function returns the string "**ERR**"</p>
</description>
<properties>
<property name="File Name" required="Yes">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.
</property>
<property name="Variable Name" required="No">
A reference name - refName - for reusing the value created by this function. Stored values are of the form ${refName}.
Defaults to "StringFromFile_".
</property>
<property name="Start sequence number" required="No">Initial Sequence number (if omitted, the End sequence number is treated as a loop count)</property>
<property name="End sequence number" required="No">Final sequence number (if omitted, seqence numbers can increase without limit)</property>
</properties>
<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>
000 - insert the number packed out to 3 digits with leading zeros if necessary
<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/>
If more digits are required than there are formatting characters, the number will be
expanded as necessary.<br></br>
<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>
(though #. and 000. work as expected in locales where the decimal point is also ".")
<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>
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>
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.
<code>
<br></br>
${_StringFromFile(PIN#'.'DAT,,1,2)} - reads PIN1.DAT, PIN2.DAT<br></br>
${_StringFromFile(PIN.DAT,,,2)} - reads PIN.DAT twice<br></br>
</code>
Note that the "." in PIN.DAT above should <u>not</u> be quoted.
In this case the start number is omitted, so the file name is used exactly as is.
</p>
</component>
<component index="&sect-num;.5.6a" name="__machineName">
<description><p>The machineName function returns the local host name</p></description>
<properties>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
</component>
<component index="&sect-num;.5.6b" name="__machineIP">
<description><p>The machineIP function returns the local IP address</p></description>
<properties>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
</component>
<component index="&sect-num;.5.7" name="__javaScript">
<description>
<p>
The javaScript function executes a piece of JavaScript (not Java!) code and returns its value
</p>
<p>
The JMeter Javascript function calls a standalone JavaScript interpreter.
Javascript is used as a scripting language, so you can do calculations etc.</p>
<p>
For details of the language, please see <a href="http://www.mozilla.org/rhino/overview.html">Mozilla Rhino Overview</a>
</p>
<p>
The following variables are made available to the script:
</p>
<ul>
<li>log - the logger for the function</li>
<li>ctx - JMeterContext object</li>
<li>vars - JMeterVariables object</li>
<li>threadName - String containing the current thread name (in 2.3.2 it was misspelt as "theadName")</li>
<li>sampler - current Sampler object (if any)</li>
<li>sampleResult - previous SampleResult object (if any)</li>
<li>props - JMeter Properties object</li>
</ul>
<p>
Rhinoscript allows access to static methods via its Packages object.
See the <a href="http://www.mozilla.org/rhino/ScriptingJava.html">Scripting Java</a> documentation.
For example one can access the JMeterContextService static methods thus:
<code>Packages.org.apache.jmeter.threads.JMeterContextService.getTotalThreads()</code>
</p>
<note>
JMeter is not a browser, and does not interpret the JavaScript in downloaded pages.
</note>
</description>
<properties>
<property name="Expression" required="Yes">The JavaScript expression to be executed. For example:
<ul>
<li>new Date() - return the current date and time</li>
<li>Math.floor(Math.random()*(${maxRandom}+1))
- a random number between 0 and the variable maxRandom</li>
<li>${minRandom}+Math.floor(Math.random()*(${maxRandom}-${minRandom}+1))
- a random number between the variables minRandom and maxRandom</li>
<li>"${VAR}"=="abcd"</li>
</ul>
</property>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
<note>Remember to include any necessary quotes for text strings and JMeter variables. Also, if
the expression has commas, please make sure to escape them. For example in:
<br></br>
${__javaScript('${sp}'.slice(7\,99999))}
<br></br>
the comma after 7 is escaped.</note>
</component>
<component index="&sect-num;.5.8" name="__Random">
<description><p>The random function returns a random number that lies between the given min and max values.</p></description>
<properties>
<property name="Minimum value" required="Yes">A number</property>
<property name="Maximum value" required="Yes">A bigger number</property>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
</component>
<component index="&sect-num;.5.8" name="__RandomString">
<description><p>The RandomString function returns a random String of length using characters in chars to use.</p></description>
<properties>
<property name="Length" required="Yes">A number length of generated String</property>
<property name="Characters to use" required="No">Chars used to generate String</property>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
</component>
<component index="&sect-num;.5.8" name="__CSVRead">
<description><p>The CSVRead function returns a string from a CSV file (c.f. <a href="#_StringFromFile">StringFromFile</a>)</p>
<p>NOTE: versions up to 1.9.1 only supported a single file.
JMeter versions since 1.9.1 support multiple file names.
</p>
<p><b>In most cases, the newer
<a href="component_reference.html#CSV_Data_Set_Config">CSV Data Set Config element</a>
is easier to use.</b></p>
<p>
When a filename is first encountered, the file is opened and read into an internal
array. If a blank line is detected, this is treated as end of file - this allows
trailing comments to be used (N.B. this feature was introduced in versions after 1.9.1)
</p>
<p>All subsequent references to the same file name use the same internal array.
N.B. the filename case is significant to the function, even if the OS doesn't care,
so CSVRead(abc.txt,0) and CSVRead(aBc.txt,0) would refer to different internal arrays.
</p>
<p>
The *ALIAS feature allows the same file to be opened more than once,
and also allows for shorter file names.
</p>
<p>
Each thread has its own internal pointer to its current row in the file array.
When a thread first refers to the file it will be allocated the next free row in
the array, so each thread will access a different row from all other threads.
[Unless there are more threads than there are rows in the array.]
</p>
<p>
Note: the function splits the line at every comma by default.
If you want to enter columns containing commas, then you will need
to change the delimiter to a character that does not appear in any
column data, by setting the property: csvread.delimiter
</p>
</description>
<properties>
<property name="File Name" required="Yes">The file (or *ALIAS) to read from</property>
<property name="Column number" required="Yes">
The column number in the file.
0 = first column, 1 = second etc.
"next" - go to next line of file.
*ALIAS - open a file and assign it to the alias
</property>
</properties>
<p>For example, you could set up some variables as follows:
<ul>
<li>COL1a ${__CSVRead(random.txt,0)}</li>
<li>COL2a ${__CSVRead(random.txt,1)}${__CSVRead(random.txt,next)}</li>
<li>COL1b ${__CSVRead(random.txt,0)}</li>
<li>COL2b ${__CSVRead(random.txt,1)}${__CSVRead(random.txt,next)}</li>
</ul>
This would read two columns from one line, and two columns from the next available line.
If all the variables are defined on the same User Parameters Pre-Processor, then the lines
will be consecutive. Otherwise, a different thread may grab the next line.
</p>
<note>
The function is not suitable for use with large files, as the entire file is stored in memory.
For larger files, use <a href="component_reference.html#CSV_Data_Set_Config">CSV Data Set Config element</a>
or <a href="#__StringFromFile">StringFromFile</a>.
</note>
</component>
<component index="&sect-num;.5.9" name="__property">
<description><p>The property function returns the value of a JMeter property.
If the property value cannot be found, and no default has been supplied, it returns the property name.
When supplying a default value, there is no need to provide a function name - the parameter can be set to null, and it will be ignored.
</p>For example:<p>
<ul>
<li>${__property(user.dir)} - return value of user.dir</li>
<li>${__property(user.dir,UDIR)} - return value of user.dir and save in UDIR</li>
<li>${__property(abcd,ABCD,atod)} - return value of property abcd (or "atod" if not defined) and save in ABCD</li>
<li>${__property(abcd,,atod)} - return value of property abcd (or "atod" if not defined) but don't save it</li>
</ul>
</p>
</description>
<properties>
<property name="Property Name" required="Yes">The property name to be retrieved.</property>
<property name="Variable Name" required="No">A reference name for reusing the value
computed by this function.</property>
<property name="Default Value" required="No">The default value for the property.</property>
</properties>
</component>
<component index="&sect-num;.5.10" name="__P">
<description><p>This is a simplified property function which is
intended for use with properties defined on the command line.
Unlike the __property function, there is no option to save the value in a variable,
and if no default value is supplied, it is assumed to be 1.
The value of 1 was chosen because it is valid for common test variables such
as loops, thread count, ramp up etc.
</p>For example:<p>
<code>
Define the property value:
<br></br>
jmeter -Jgroup1.threads=7 -Jhostname1=www.realhost.edu
<br></br>
Fetch the values:
<br></br>
${__P(group1.threads)} - return the value of group1.threads
<br></br>
${__P(group1.loops)} - return the value of group1.loops
<br></br>
${__P(hostname,www.dummy.org)} - return value of property hostname or www.dummy.org if not defined
<br></br>
</code>
In the examples above, the first function call would return 7,
the second would return 1 and the last would return www.dummy.org
(unless those properties were defined elsewhere!)
</p>
</description>
<properties>
<property name="Property Name" required="Yes">The property name to be retrieved.</property>
<property name="Default Value" required="No">The default value for the property.
If omitted, the default is set to "1".</property>
</properties>
</component>
<component index="&sect-num;.5.11" name="__log">
<description>
<p>
The log function logs a message, and returns its input string
</p>
</description>
<properties>
<property name="String to be logged" required="Yes">A string</property>
<property name="Log Level" required="No">OUT, ERR, DEBUG, INFO (default), WARN or ERROR</property>
<property name="Throwable text" required="No">If non-empty, creates a Throwable to pass to the logger</property>
<property name="Comment" required="No">If present, it is displayed in the string.
Useful for identifying what is being logged.</property>
</properties>
<p>The OUT and ERR log level names are used to direct the output to System.out and System.err respectively.
In this case, the output is always printed - it does not depend on the current log setting.
</p>
<pre>
For example:
${__log(Message)} - written to the log file as "...thread Name : Message"
${__log(Message,OUT)} - written to console window
${__log(${VAR},,,VAR=)} - written to log file as "...thread Name VAR=value"
</pre>
</component>
<component index="&sect-num;.5.12" name="__logn">
<description>
<p>
The logn function logs a message, and returns the empty string
</p>
</description>
<properties>
<property name="String to be logged" required="Yes">A string</property>
<property name="Log Level" required="No">OUT, ERR, DEBUG, INFO (default), WARN or ERROR</property>
<property name="Throwable text" required="No">If non-empty, creates a Throwable to pass to the logger</property>
</properties>
<p>The OUT and ERR log level names are used to direct the output to System.out and System.err respectively.
In this case, the output is always printed - it does not depend on the current log setting.
</p>
<pre>
For example:
${__logn(VAR1=${VAR1},OUT)} - write the value of the variable to the console window
</pre>
</component>
<component index="&sect-num;.5.13" name="__BeanShell">
<description>
<p>
The BeanShell function evaluates the script passed to it, and returns the result.
</p>
<p>
<b>For full details on using BeanShell, please see the BeanShell web-site at <a href="http://www.beanshell.org/">http://www.beanshell.org/</a>
</b>
</p>
<p>
Note that a different Interpreter is used for each independent occurence of the function
in a test script, but the same Interpreter is used for subsequent invocations.
This means that variables persist across calls to the function.
</p>
<p>
A single instance of a function may be called from multiple threads.
However the function execute() method is synchronised.
</p>
<p>
If the property "beanshell.function.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: BeanShellFunction.bshrc.
</p>
<p>
The following variables are set before the script is executed:
<ul>
<li>log - the logger for the BeanShell function (*)</li>
<li>ctx - the current JMeter context variable</li>
<li>vars - the current JMeter variables</li>
<li>props - JMeter Properties object</li>
<li>threadName - the threadName (String)</li>
<li>Sampler the current Sampler, if any</li>
<li>SampleResult - the current SampleResult, if any</li>
</ul>
(*) means that this is set before the init file, if any, is processed.
Other variables vary from invocation to invocation.
</p>
</description>
<properties>
<property name="BeanShell script" required="Yes">A beanshell script (not a file name)</property>
<property name="Name of variable" required="No">A reference name for reusing the value
computed by this function.</property>
</properties>
<p>
Example:
<pre>
${__BeanShell(123*456)} - returns 56088
${__BeanShell(source("function.bsh"))} - processes the script in function.bsh
</pre>
</p>
<note>
Remember to include any necessary quotes for text strings and JMeter variables that represent text strings.
</note>
</component>
<component index="&sect-num;.5.14" name="__split">
<description>
<p>
The split function splits the string passed to it according to the delimiter,
and returns the original string. If any delimiters are adjacent, "?" is returned as the value.
The split strings are returned in the variables ${VAR_1}, ${VAR_2} etc.
The count of variables is returned in ${VAR_n}.
From JMeter 2.1.2 onwards, a trailing delimiter is treated as a missing variable, and "?" is returned.
Also, to allow it to work better with the ForEach controller,
__split now deletes the first unused variable in case it was set by a previous split.
</p>
<p/>
Example:
<code>
<br></br>
Define VAR="a||c|" in the test plan.
<br></br>
${__split(${VAR},VAR,|)}
<br></br>
This will return the contents of VAR, i.e. "a||c|" and set the following variables:
<br></br>
VAR_n=4 (3 in JMeter 2.1.1 and earlier)
<br></br>
VAR_1=a
<br></br>
VAR_2=?
<br></br>
VAR_3=c
<br></br>
VAR_4=? (null in JMeter 2.1.1 and earlier)
<br></br>
VAR_5=null (in JMeter 2.1.2 and later)
</code>
</description>
<properties>
<property name="String to split" required="Yes">A delimited string, e.g. "a|b|c"</property>
<property name="Name of variable" required="Yes">A reference name for reusing the value
computed by this function.</property>
<property name="Delimiter" required="No">The delimiter character, e.g. <b>|</b>.
If omitted, <b>,</b> is used. Note that <b>,</b> would need to be specified as <b>\,</b>.
</property>
</properties>
</component>
<component index="&sect-num;.5.15" name="__XPath">
<description>
<p>
The XPath function reads an XML file and matches the XPath.
Each time the function is called, the next match will be returned.
At end of file, it will wrap around to the start.
If no nodes matched, then the function will return the empty string,
and a warning message will be written to the JMeter log file.
<note>Note that the entire NodeList is held in memory.</note>
</p>
<p/>
Example:
<code>
<br></br>
<br></br>
${__XPath(/path/to/build.xml, //target/@name)}
<br></br>
This will match all targets in build.xml and return the contents of the next name attribute
</code>
</description>
<properties>
<property name="XML file to parse" required="Yes"> a XML file to parse</property>
<property name="XPath" required="Yes"> a XPath expression to match nodes in the XML file</property>
</properties>
</component>
<component index="&sect-num;.5.16" name="__setProperty">
<description>
<p>The setProperty function sets the value of a JMeter property.
The default return value from the function is the empty string,
so the function call can be used anywhere functions are valid.</p>
<p>The original value can be returned by setting the optional 3rd parameter to "true".</p>
<p>Properties are global to JMeter,
so can be used to communicate between threads and thread groups</p>
</description>
<properties>
<property name="Property Name" required="Yes">The property name to be set.</property>
<property name="Property Value" required="Yes">The value for the property.</property>
<property name="True/False" required="No">Should the original value be returned?</property>
</properties>
</component>
<component index="&sect-num;.5.17" name="__time">
<description>
<p>The time function returns the current time in various formats.</p>
</description>
<properties>
<property name="Format" required="No">
The format to be passed to SimpleDateFormat.
The function supports various shorthand aliases, see below.
</property>
<property name="Name of variable" required="No">The name of the variable to set.</property>
</properties>
<p>If the format string is omitted, then the function returns the current time in milliseconds.
Otherwise, the current time is passed to SimpleDateFormat.
The following shorthand aliases are provided:
</p>
<ul>
<li>YMD = yyyyMMdd</li>
<li>HMS = HHmmss</li>
<li>YMDHMS = yyyyMMdd-HHmmss</li>
<li>USER1 = whatever is in the Jmeter property time.USER1</li>
<li>USER2 = whatever is in the Jmeter property time.USER2</li>
</ul>
<p>The defaults can be changed by setting the appropriate JMeter property, e.g.
time.YMD=yyMMdd
</p>
</component>
<component index="&sect-num;.5.18" name="__jexl" tag="__jexl2">
<description>
<p>The jexl function returns the result of evaluating a
<a href="http://commons.apache.org/jexl">Commons JEXL expression</a>.
See links below for more information on JEXL expressions.
</p>
<p>The __jexl function uses Commons JEXL 1, and the __jexl2 function uses Commons JEXL 2</p>
<ul>
<li><a href="http://commons.apache.org/jexl/reference/syntax.html">JEXL syntax description</a></li>
<li><a href="http://commons.apache.org/jexl/reference/examples.html#Example_Expressions">JEXL examples</a></li>
</ul>
</description>
<properties>
<property name="Expression" required="Yes">
The expression to be evaluated. For example, 6*(5+2)
</property>
<property name="Name of variable" required="No">The name of the variable to set.</property>
</properties>
<p>
The following variables are made available to the script:
</p>
<ul>
<li>log - the logger for the function</li>
<li>ctx - JMeterContext object</li>
<li>vars - JMeterVariables object</li>
<li>props - JMeter Properties object</li>
<li>threadName - String containing the current thread name (in 2.3.2 it was misspelt as "theadName")</li>
<li>sampler - current Sampler object (if any)</li>
<li>sampleResult - previous SampleResult object (if any)</li>
<li>OUT - System.out - e.g. OUT.println("message")</li>
</ul>
<p>
Jexl can also create classes and call methods on them, for example:
</p>
<p>
<code>
Systemclass=log.class.forName("java.lang.System");<br></br>
now=Systemclass.currentTimeMillis();
</code>
Note that the Jexl documentation on the web-site wrongly suggests that "div" does integer division.
In fact "div" and "/" both perform normal division. One can get the same effect
as follows:
<code>
i= 5 / 2;
i.intValue(); // or use i.longValue()
</code>
</p>
<note>Versions of JMeter after 2.3.2 allow the expression to contain multiple statements.
JMeter 2.3.2 and earlier only processed the first statement (if there were multiple statements a warning was logged).
</note>
</component>
<component index="&sect-num;.5.19" name="__V">
<description>
<p>The V (variable) function returns the result of evaluating a variable name expression.
This can be used to evaluate nested variable references (which are not currently supported).
</p>
<p>For example, if one has variables A1,A2 and N=1:</p>
<ul>
<li>${A1} - works OK</li>
<li>${A${N}} - does not work (nested variable reference)</li>
<li>${__V(A${N})} - works OK. A${N} becomes A1, and the __V function returns the value of A1</li>
</ul>
</description>
<properties>
<property name="Variable name" required="Yes">
The variable to be evaluated.
</property>
</properties>
</component>
<component index="&sect-num;.5.20" name="__evalVar">
<description>
<p>The eval function returns the result of evaluating an expression stored in a variable.
</p>
<p>
This allows one to read a string from a file, and process any variable references in it.
For example, if the variable "query" contains "select ${column} from ${table}"
and "column" and "table" contain "name" and "customers", then ${__evalVar(query)}
will evaluate as "select name from customers".
</p>
</description>
<properties>
<property name="Variable name" required="Yes">
The variable to be evaluated.
</property>
</properties>
</component>
<component index="&sect-num;.5.21" name="__eval">
<description>
<p>The eval function returns the result of evaluating a string expression.
</p>
<p>
This allows one to interpolate variable and function references in a string
which is stored in a variable. For example, given the following variables:
<ul>
<li>name=Smith</li>
<li>column=age</li>
<li>table=birthdays</li>
<li>SQL=select ${column} from ${table} where name='${name}'</li>
</ul>
then ${__eval(${SQL})} will evaluate as "select age from birthdays where name='Smith'".
</p>
<p>
This can be used in conjunction with CSV Dataset, for example
where the both SQL statements and the values are defined in the data file.
</p>
</description>
<properties>
<property name="Variable name" required="Yes">
The variable to be evaluated.
</property>
</properties>
</component>
<component index="&sect-num;.5.22" name="__char">
<description>
<p>
The char function returns the result of evaluating a list of numbers as Unicode characters.
See also __unescape(), below.
</p>
<p>
This allows one to add arbitrary character values into fields.
</p>
</description>
<properties>
<property name="Unicode character number (decimal or 0xhex)" required="Yes">
The decimal number (or hex number, if prefixed by 0x, or octal, if prefixed by 0) to be converted to a Unicode character.
</property>
</properties>
<p>Examples:
<br/>
${__char(13,10)} = ${__char(0xD,0xA)} = ${__char(015,012)} = CRLF
<br/>
${__char(165)} = &amp;#165; (yen)
</p>
</component>
<component index="&sect-num;.5.23" name="__unescape">
<description>
<p>
The unescape function returns the result of evaluating a Java-escaped string. See also __char() above.
</p>
<p>
This allows one to add characters to fields which are otherwise tricky (or impossible) to define via the GUI.
</p>
</description>
<properties>
<property name="String to unescape" required="Yes">
The string to be unescaped.
</property>
</properties>
<p>Examples:
<br/>
${__unescape(\r\n)} = CRLF
<br/>
${__unescape(1\t2)} = 1[tab]2
</p>
</component>
<component index="&sect-num;.5.24" name="__unescapeHtml">
<description>
<p>
Function to unescape a string containing HTML entity escapes
to a string containing the actual Unicode characters corresponding to the escapes.
Supports HTML 4.0 entities.
</p>
<p>
For example, the string <code>"&amp;#38;lt;Fran&amp;#38;ccedil;ais&amp;#38;gt;"</code>
will become <code>"&amp;lt;Fran&amp;ccedil;ais&amp;gt;"</code>.
</p>
<p>
If an entity is unrecognized, it is left alone, and inserted verbatim into the result string.
e.g. <code>"&amp;gt;&amp;zzzz;x"</code> will become <code>">&amp;zzzz;x"</code>.
</p>
<p>
Uses StringEscapeUtils#unescapeHtml(String) from Commons Lang.
</p>
</description>
<properties>
<property name="String to unescape" required="Yes">
The string to be unescaped.
</property>
</properties>
</component>
<component index="&sect-num;.5.25" name="__escapeHtml">
<description>
<p>
Function which escapes the characters in a String using HTML entities.
Supports HTML 4.0 entities.
</p>
<p>
For example,<code>&amp;quot;bread&amp;quot; &amp;amp; &amp;quot;butter&amp;quot;</code>
becomes:
<code>&amp;#38;quot;bread&amp;#38;quot; &amp;#38;amp; &amp;#38;quot;butter&amp;#38;quot;</code>.
</p>
<p>
Uses StringEscapeUtils#escapeHtml(String) from Commons Lang.
</p>
</description>
<properties>
<property name="String to escape" required="Yes">
The string to be escaped.
</property>
</properties>
</component>
<component index="&sect-num;.5.26" name="__FileToString">
<description>
<p>
The FileToString function can be used to read an entire file.
Each time it is called it reads the entire file.
</p>
<p>If an error occurs opening or reading the file, then the function returns the string "**ERR**"</p>
</description>
<properties>
<property name="File Name" required="Yes">Path to the file name.
(The path can be relative to the JMeter launch directory)
</property>
<property name="File encoding if not the platform default" required="No">
The encoding to be used to read the file. If not specified, the platform default is used.
</property>
<property name="Variable Name" required="No">
A reference name - refName - for reusing the value created by this function. Stored values are of the form ${refName}.
</property>
</properties>
<p>The file name, encoding and reference name parameters are resolved every time the function is executed.</p>
</component>
<component index="&sect-num;.5.27" name="__samplerName">
<description>
<p>
The samplerName function returns the name (i.e. label) of the current sampler.
</p>
<p>
The function does not work in Test elements that don't have an associated sampler.
For example the Test Plan.
Configuration elements also don't have an associated sampler.
However some Configuration elements are referenced directly by samplers, such as the HTTP Header Manager
and Http Cookie Manager, and in this case the functions are resolved in the context of the Http Sampler.
Pre-Processors, Post-Processors and Assertions always have an associated Sampler.
</p>
</description>
<properties>
<property name="Variable Name" required="No">
A reference name - refName - for reusing the value created by this function. Stored values are of the form ${refName}.
</property>
</properties>
</component>
<component index="&sect-num;.5.28" name="__TestPlanName">
<description>
<p>
The TestPlanName function returns the name of the current test plan (can be used in Including Plans to know the name of the calling test plan).
</p>
</description>
</component>
</subsection>
<subsection name="&sect-num;.6 Pre-defined Variables" anchor="predefinedvars">
<p>
Most variables are set by calling functions or by test elements such as User Defined Variables;
in which case the user has full control over the variable name that is used.
However some variables are defined internally by JMeter. These are listed below.
</p>
<ul>
<li>COOKIE_cookiename - contains the cookie value (see <complink name="HTTP Cookie Manager" />)</li>
<li>JMeterThread.last_sample_ok - whether or not the last sample was OK - true/false.
Note: this is updated after PostProcessors and Assertions have been run.
</li>
<li>START variables (see next section)</li>
</ul>
</subsection>
<subsection name="&sect-num;.6 Pre-defined Properties" anchor="predefinedprops">
<p>
The set of JMeter properties is initialised from the system properties defined when JMeter starts;
additional JMeter properties are defined in jmeter.properties, user.properties or on the command line.
</p>
<p>
Some built-in properties are defined by JMeter. These are listed below.
For convenience, the START properties are also copied to variables with the same names.
</p>
<ul>
<li>START.MS - JMeter start time in milliseconds</li>
<li>START.YMD - JMeter start time as yyyyMMdd</li>
<li>START.HMS - JMeter start time as HHmmss</li>
<li>TESTSTART.MS - test start time in milliseconds</li>
</ul>
<p>
Please note that the START variables / properties represent JMeter startup time, not the test start time.
They are mainly intended for use in file names etc.
</p>
</subsection>
</section>
</body>
</document>