jmeter-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From fschumac...@apache.org
Subject svn commit: r1704072 - /jmeter/trunk/xdocs/usermanual/component_reference.xml
Date Sat, 19 Sep 2015 18:07:09 GMT
Author: fschumacher
Date: Sat Sep 19 18:07:09 2015
New Revision: 1704072

URL: http://svn.apache.org/viewvc?rev=1704072&view=rev
Log:
Mostly markup changes. Usage of code, source and example tags.

Corrected spelling of variable FileName which gets used by JSR- and BSFTestElements
and were often spelled Filename.

Modified:
    jmeter/trunk/xdocs/usermanual/component_reference.xml

Modified: jmeter/trunk/xdocs/usermanual/component_reference.xml
URL: http://svn.apache.org/viewvc/jmeter/trunk/xdocs/usermanual/component_reference.xml?rev=1704072&r1=1704071&r2=1704072&view=diff
==============================================================================
--- jmeter/trunk/xdocs/usermanual/component_reference.xml (original)
+++ jmeter/trunk/xdocs/usermanual/component_reference.xml Sat Sep 19 18:07:09 2015
@@ -5605,17 +5605,17 @@ this one will be used by "<code>Calculat
         applied to <b>all</b> the samplers in the same scope, so to ensure that
a post-processor
         is applied only to a particular sampler, add it as a child of the sampler.
     </p>
-    <p>
+    <note>
     Note: Unless documented otherwise, Post-Processors are not applied to sub-samples (child
samples) -
     only to the parent sample.
     In the case of BSF and BeanShell post-processors, the script can retrieve sub-samples
using the method
     <code>prev.getSubResults()</code> which returns an array of SampleResults.
     The array will be empty if there are none.
-    </p>
+    </note>
     <p>
     Post-Processors are run before Assertions, so they do not have access to any Assertion
Results, nor will
     the sample status reflect the results of any Assertions. If you require access to Assertion
Results, try
-    using a Listener instead. Also note that the variable JMeterThread.last_sample_ok is
set to "true" or "false"
+    using a Listener instead. Also note that the variable <code>JMeterThread.last_sample_ok</code>
is set to "<code>true</code>" or "<code>false</code>"
     after all Assertions have been run.
     </p>
     </description>
@@ -5629,52 +5629,52 @@ generate the template string, and store
         This is for use with samplers that can generate sub-samples, 
         e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the
Transaction Controller.
         <ul>
-        <li>Main sample only - only applies to the main sample</li>
-        <li>Sub-samples only - only applies to the sub-samples</li>
-        <li>Main sample and sub-samples - applies to both.</li>
-        <li>JMeter Variable - assertion is to be applied to the contents of the named
variable</li>
+        <li><code>Main sample only</code> - only applies to the main sample</li>
+        <li><code>Sub-samples only</code> - only applies to the sub-samples</li>
+        <li><code>Main sample and sub-samples</code> - applies to both.</li>
+        <li><code>JMeter Variable</code> - assertion is to be applied to
the contents of the named variable</li>
         </ul>
         Matching is applied to all qualifying samples in turn.
         For example if there is a main sample and 3 sub-samples, each of which contains a
single match for the regex,
         (i.e. 4 matches in total).
-        For match number = 3, Sub-samples only, the extractor will match the 3<sup>rd</sup>
sub-sample.
-        For match number = 3, Main sample and sub-samples, the extractor will match the 2<sup>nd</sup>
sub-sample (1<sup>st</sup> match is main sample).
-        For match number = 0 or negative, all qualifying samples will be processed.
-        For match number > 0, matching will stop as soon as enough matches have been found.
+        For match number = <code>3</code>, Sub-samples only, the extractor will
match the 3<sup>rd</sup> sub-sample.
+        For match number = <code>3</code>, Main sample and sub-samples, the extractor
will match the 2<sup>nd</sup> sub-sample (1<sup>st</sup> match is
main sample).
+        For match number = <code>0</code> or negative, all qualifying samples
will be processed.
+        For match number > <code>0</code>, matching will stop as soon as enough
matches have been found.
         </property>
         <property name="Field to check" required="Yes">
         The following fields can be checked:
         <ul>
-        <li>Body - the body of the response, e.g. the content of a web-page (excluding
headers)</li>
-        <li>Body (unescaped) - the body of the response, with all Html escape codes
replaced.
+        <li><code>Body</code> - the body of the response, e.g. the content
of a web-page (excluding headers)</li>
+        <li><code>Body (unescaped)</code> - the body of the response, with
all Html escape codes replaced.
         Note that Html escapes are processed without regard to context, so some incorrect
substitutions
         may be made.
         <note>Note that this option highly impacts performances, so use it only when
absolutely necessary and be aware of its impacts</note>
         </li>
-        <li>Body as a Document - the extract text from various type of documents via
Apache Tika (see <complink name="View Results Tree"/> Document view section).
+        <li><code>Body as a Document</code> - the extract text from various
type of documents via Apache Tika (see <complink name="View Results Tree"/> Document
view section).
         <note>Note that the Body as a Document option can impact performances, so ensure
it is OK for your test</note>
         </li>
-        <li>Request Headers - may not be present for non-HTTP samples</li>
-        <li>Response Headers - may not be present for non-HTTP samples</li>
-        <li>URL</li>
-        <li>Response Code - e.g. 200</li>
-        <li>Response Message - e.g. OK</li>
+        <li><code>Request Headers</code> - may not be present for non-HTTP
samples</li>
+        <li><code>Response Headers</code> - may not be present for non-HTTP
samples</li>
+        <li><code>URL</code></li>
+        <li><code>Response Code</code> - e.g. <code>200</code></li>
+        <li><code>Response Message</code> - e.g. <code>OK</code></li>
         </ul>
         Headers can be useful for HTTP samples; it may not be present for other sample types.
         </property>
-        <property name="Reference Name" required="Yes">The name of the JMeter variable
in which to store the result.  Also note that each group is stored as [refname]_g#, where
[refname] is the string you entered as the reference name, and # is the group number, where
group 0 is the entire match, group 1 is the match from the first set of parentheses, etc.</property>
+        <property name="Reference Name" required="Yes">The name of the JMeter variable
in which to store the result.  Also note that each group is stored as <code>[refname]_g#</code>,
where <code>[refname]</code> is the string you entered as the reference name,
and <code>#</code> is the group number, where group <code>0</code>
is the entire match, group <code>1</code> is the match from the first set of parentheses,
etc.</property>
         <property name="Regular Expression" required="Yes">The regular expression used
to parse the response data. 
-        This must contain at least one set of parentheses "()" to capture a portion of the
string, unless using the group $0$.
-        Do not enclose the expression in / / - unless of course you want to match these characters
as well.
+        This must contain at least one set of parentheses "<code>()</code>" to
capture a portion of the string, unless using the group <code>$0$</code>.
+        Do not enclose the expression in <code>/ /</code> - unless of course
you want to match these characters as well.
         </property>
         <property name="Template" required="Yes">The template used to create a string
from the matches found.  This is an arbitrary string
-        with special elements to refer to groups within the regular expression.  The syntax
to refer to a group is: '$1$' to refer to
-        group 1, '$2$' to refer to group 2, etc. $0$ refers to whatever the entire expression
matches.</property>
+        with special elements to refer to groups within the regular expression.  The syntax
to refer to a group is: '<code>$1$</code>' to refer to
+        group <code>1</code>, '<code>$2$</code>' to refer to group
<code>2</code>, etc. <code>$0$</code> refers to whatever the entire
expression matches.</property>
         <property name="Match No." required="Yes">Indicates which match to use.  The
regular expression may match multiple times.  
             <ul>
                 <li>Use a value of zero to indicate JMeter should choose a match at
random.</li>
                 <li>A positive number N means to select the n<sup>th</sup>
match.</li>
-                <li> Negative numbers are used in conjunction with the ForEach controller
- see below.</li>
+                <li> Negative numbers are used in conjunction with the <complink
name="ForEach Controller"/> - see below.</li>
             </ul>
         </property>
         <property name="Default Value" required="No, but recommended">
@@ -5693,32 +5693,32 @@ generate the template string, and store
     If the match number is set to a non-negative number, and a match occurs, the variables
are set as follows:
 </p>
     <ul>
-        <li>refName - the value of the template</li>
-        <li>refName_gn, where n=0,1,2 - the groups for the match</li>
-        <li>refName_g - the number of groups in the Regex (excluding 0)</li>
+        <li><code>refName</code> - the value of the template</li>
+        <li><code>refName_g<em>n</em></code>, where <code>n</code>=<code>0</code>,<code>1</code>,<code>2</code>
- the groups for the match</li>
+        <li><code>refName_g</code> - the number of groups in the Regex
(excluding <code>0</code>)</li>
     </ul>
 <p>
-    If no match occurs, then the refName variable is set to the default (unless this is absent).

+    If no match occurs, then the <code>refName</code> variable is set to the
default (unless this is absent). 
     Also, the following variables are removed:
 </p>
     <ul>
-        <li>refName_g0</li>
-        <li>refName_g1</li>
-        <li>refName_g</li>
+        <li><code>refName_g0</code></li>
+        <li><code>refName_g1</code></li>
+        <li><code>refName_g</code></li>
     </ul>
 <p>
     If the match number is set to a negative number, then all the possible matches in the
sampler data are processed.
     The variables are set as follows:
 </p>
     <ul>
-        <li>refName_matchNr - the number of matches found; could be 0</li>
-        <li>refName_n, where n = 1,2,3 etc. - the strings as generated by the template</li>
-        <li>refName_n_gm, where m=0,1,2 - the groups for match n</li>
-        <li>refName - always set to the default value</li>
-        <li>refName_gn - not set</li>
+        <li><code>refName_matchNr</code> - the number of matches found;
could be <code>0</code></li>
+        <li><code>refName_<em>n</em></code>, where <code>n</code>
= <code>1</code>, <code>2</code>, <code>3</code> etc.
- the strings as generated by the template</li>
+        <li><code>refName_<em>n</em>_g<em>m</em></code>,
where <code>m</code>=<code>0</code>, <code>1</code>, <code>2</code>
- the groups for match <code>n</code></li>
+        <li><code>refName</code> - always set to the default value</li>
+        <li><code>refName_g<em>n</em></code> - not set</li>
     </ul>
 <p>
-    Note that the refName variable is always set to the default value in this case, 
+    Note that the <code>refName</code> variable is always set to the default
value in this case, 
     and the associated group variables are not set.
 </p>
     <p>See also <complink name="Response Assertion"/> for some examples of how
to specify modifiers,
@@ -5735,18 +5735,18 @@ extracting the node as text or attribute
         This is for use with samplers that can generate sub-samples, 
         e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the
Transaction Controller.
         <ul>
-        <li>Main sample only - only applies to the main sample</li>
-        <li>Sub-samples only - only applies to the sub-samples</li>
-        <li>Main sample and sub-samples - applies to both.</li>
-        <li>JMeter Variable - assertion is to be applied to the contents of the named
variable</li>
+        <li><code>Main sample only</code> - only applies to the main sample</li>
+        <li><code>Sub-samples only</code> - only applies to the sub-samples</li>
+        <li><code>Main sample and sub-samples</code> - applies to both.</li>
+        <li><code>JMeter Variable</code> - assertion is to be applied to
the contents of the named variable</li>
         </ul>
         Matching is applied to all qualifying samples in turn.
         For example if there is a main sample and 3 sub-samples, each of which contains a
single match for the regex,
         (i.e. 4 matches in total).
-        For match number = 3, Sub-samples only, the extractor will match the 3<sup>rd</sup>
sub-sample.
-        For match number = 3, Main sample and sub-samples, the extractor will match the 2<sup>nd</sup>
sub-sample (1<sup>st</sup> match is main sample).
-        For match number = 0 or negative, all qualifying samples will be processed.
-        For match number > 0, matching will stop as soon as enough matches have been found.
+        For match number = <code>3</code>, Sub-samples only, the extractor will
match the 3<sup>rd</sup> sub-sample.
+        For match number = <code>3</code>, Main sample and sub-samples, the extractor
will match the 2<sup>nd</sup> sub-sample (1<sup>st</sup> match is
main sample).
+        For match number = <code>0</code> or negative, all qualifying samples
will be processed.
+        For match number > <code>0</code>, matching will stop as soon as enough
matches have been found.
         </property>
         <property name="CSS/JQuery extractor Implementation" required="False">
         As of JMeter 2.9, 2 implementations for CSS/JQuery based syntax are supported:
@@ -5760,10 +5760,10 @@ extracting the node as text or attribute
         <property name="CSS/JQuery expression" required="Yes">The CSS/JQuery selector
used to select nodes from the response data. 
         Selector, selectors combination and pseudo-selectors are supported, examples:
         <ul>
-            <li>E[foo] an E element with a "foo" attribute</li>
-            <li>ancestor child:child elements that descend from ancestor, e.g. .body
p finds p elements anywhere under a block with class "body"</li>
-            <li>:lt(n): find elements whose sibling index (i.e. its position in the
DOM tree relative to its parent) is less than n; e.g. td:lt(3)</li>
-            <li>:contains(text): find elements that contain the given text. The search
is case-insensitive; e.g. p:contains(jsoup)</li>
+            <li><code>E[foo]</code> - an <code>E</code> element
with a "<code>foo</code>" attribute</li>
+            <li><code>ancestor child</code> - child elements that descend
from ancestor, e.g. <code>.body p</code> finds <code>p</code> elements
anywhere under a block with class "<code>body</code>"</li>
+            <li><code>:lt(n)</code> - find elements whose sibling index
(i.e. its position in the DOM tree relative to its parent) is less than <code>n</code>;
e.g. <code>td:lt(3)</code></li>
+            <li><code>:contains(text)</code> - find elements that contain
the given <code>text</code>. The search is case-insensitive; e.g. <code>p:contains(jsoup)</code></li>
             <li>&hellip;</li>
         </ul>
         For more details on syntax, see:
@@ -5782,8 +5782,8 @@ extracting the node as text or attribute
         <property name="Match No." required="Yes">Indicates which match to use.  The
CSS/JQuery selector may match multiple times.  
             <ul>
                 <li>Use a value of zero to indicate JMeter should choose a match at
random.</li>
-                <li>A positive number N means to select the n<sup>th</sup>
match.</li>
-                <li> Negative numbers are used in conjunction with the ForEach controller
- see below.</li>
+                <li>A positive number <code>N</code> means to select the
n<sup>th</sup> match.</li>
+                <li> Negative numbers are used in conjunction with the <complink
name="ForEach Controller"/> - see below.</li>
             </ul>
         </property>
         <property name="Default Value" required="No, but recommended">
@@ -5802,19 +5802,19 @@ extracting the node as text or attribute
     If the match number is set to a non-negative number, and a match occurs, the variables
are set as follows:
 </p>
     <ul>
-        <li>refName - the value of the template</li>
+        <li><code>refName</code> - the value of the template</li>
     </ul>
 <p>
-    If no match occurs, then the refName variable is set to the default (unless this is absent).

+    If no match occurs, then the <code>refName</code> variable is set to the
default (unless this is absent). 
 </p>
 <p>
     If the match number is set to a negative number, then all the possible matches in the
sampler data are processed.
     The variables are set as follows:
 </p>
     <ul>
-        <li>refName_matchNr - the number of matches found; could be 0</li>
-        <li>refName_n, where n = 1,2,3 etc - the strings as generated by the template</li>
-        <li>refName - always set to the default value</li>
+        <li><code>refName_matchNr</code> - the number of matches found;
could be <code>0</code></li>
+        <li><code>refName_n</code>, where <code>n</code> =
<code>1</code>, <code>2</code>, <code>3</code>, etc. -
the strings as generated by the template</li>
+        <li><code>refName</code> - always set to the default value</li>
     </ul>
 <p>
     Note that the refName variable is always set to the default value in this case.
@@ -5832,17 +5832,17 @@ extracting the node as text or attribute
         This is for use with samplers that can generate sub-samples, 
         e.g. HTTP Sampler with embedded resources, Mail Reader or samples generated by the
Transaction Controller.
         <ul>
-        <li>Main sample only - only applies to the main sample</li>
-        <li>Sub-samples only - only applies to the sub-samples</li>
-        <li>Main sample and sub-samples - applies to both.</li>
-        <li>JMeter Variable - assertion is to be applied to the contents of the named
variable</li>
+        <li><code>Main sample only</code> - only applies to the main sample</li>
+        <li><code>Sub-samples only</code> - only applies to the sub-samples</li>
+        <li><code>Main sample and sub-samples</code> - applies to both.</li>
+        <li><code>JMeter Variable</code> - assertion is to be applied to
the contents of the named variable</li>
         </ul>
         XPath matching is applied to all qualifying samples in turn, and all the matching
results will be returned.
        </property>
        <property name="Use Tidy (tolerant parser)" required="Yes">If checked use Tidy
to parse HTML response into XHTML.
        <ul>
-           <li>"Use Tidy" should be checked on for HTML response. Such response is
converted to valid XHTML (XML compatible HTML) using Tidy</li>
-           <li>"Use Tidy" should be unchecked for both XHTML or XML response (for example
RSS)</li>
+           <li>"<code>Use Tidy</code>" should be checked on for HTML response.
Such response is converted to valid XHTML (XML compatible HTML) using Tidy</li>
+           <li>"<code>Use Tidy</code>" should be unchecked for both XHTML
or XML response (for example RSS)</li>
        </ul>
        </property>
 <property name="Quiet"  required="If Tidy is selected">Sets the Tidy Quiet flag</property>
@@ -5872,32 +5872,32 @@ extracting the node as text or attribute
     <property name="Default Value" required="">Default value returned when no match
found. 
     It is also returned if the node has no value and the fragment option is not selected.</property>
    </properties>
-   <p>To allow for use in a ForEach Controller, the following variables are set on
return:</p>
+   <p>To allow for use in a <complink name="ForEach Controller"/>, the following
variables are set on return:</p>
    <ul>
-   <li>refName - set to first (or only) match; if no match, then set to default</li>
-   <li>refName_matchNr - set to number of matches (may be 0)</li>
-   <li>refName_n - n=1,2,3 etc. Set to the 1<sup>st</sup>, 2<sup>nd</sup>
3<sup>rd</sup> match etc. 
+   <li><code>refName</code> - set to first (or only) match; if no match,
then set to default</li>
+   <li><code>refName_matchNr</code> - set to number of matches (may be
<code>0</code>)</li>
+   <li><code>refName_n</code> - <code>n</code>=<code>1</code>,
<code>2</code>, <code>3</code>, etc. Set to the 1<sup>st</sup>,
2<sup>nd</sup> 3<sup>rd</sup> match etc. 
    </li>
    </ul>
-   <p>Note: The next refName_n variable is set to null - e.g. if there are 2 matches,
then refName_3 is set to null,
-   and if there are no matches, then refName_1 is set to null.
-   </p>
+   <note>Note: The next <code>refName_n</code> variable is set to <code>null</code>
- e.g. if there are 2 matches, then <code>refName_3</code> is set to <code>null</code>,
+   and if there are no matches, then <code>refName_1</code> is set to <code>null</code>.
+   </note>
    <p>XPath is query language targeted primarily for XSLT transformations. However
it is useful as generic query language for structured data too. See 
        <a href="http://www.topxml.com/xsl/xpathref.asp">XPath Reference</a> or
<a href="http://www.w3.org/TR/xpath">XPath specification</a> for more information.
Here are few examples:
    </p>
   <dl> 
-   <dt>/html/head/title</dt>
+   <dt><code>/html/head/title</code></dt>
      <dd>extracts title element from HTML response</dd>
-   <dt>/book/page[2]</dt>
+   <dt><code>/book/page[2]</code></dt>
      <dd>extracts 2<sup>nd</sup> page from a book</dd>
-   <dt>/book/page</dt>
+   <dt><code>/book/page</code></dt>
      <dd>extracts all pages from a book</dd>
-     <dt>//form[@name='countryForm']//select[@name='country']/option[text()='Czech
Republic'])/@value</dt>
-    <dd>extracts value attribute of option element that match text 'Czech Republic'
-        inside of select element with name attribute  'country' inside of
-        form with name attribute 'countryForm'</dd>
+     <dt><code>//form[@name='countryForm']//select[@name='country']/option[text()='Czech
Republic'])/@value</code></dt>
+    <dd>extracts value attribute of option element that match text '<code>Czech
Republic</code>'
+        inside of select element with name attribute  '<code>country</code>'
inside of
+        form with name attribute '<code>countryForm</code>'</dd>
  </dl>
- <note>When "Use Tidy" is checked on - resulting XML document may slightly differ from
original HTML response:
+ <note>When "<code>Use Tidy</code>" is checked on - resulting XML document
may slightly differ from original HTML response:
      <ul>
          <li>All elements and attribute names are converted to lowercase</li>
          <li>Tidy attempts to correct improperly nested elements. For example - original
(incorrect) <code>ul/font/li</code> becomes correct <code>ul/li/font</code></li>
@@ -5916,11 +5916,11 @@ extracting the node as text or attribute
    Determines what happens if a sampler error occurs, either because the sample itself failed
or an assertion failed.
    The possible choices are:
    <ul>
-   <li>Continue - ignore the error and continue with the test</li>
-   <li>Start next thread loop - does not execute samplers following the sampler in
error for the current iteration and restarts the loop on next iteration</li>
-   <li>Stop Thread - current thread exits</li>
-   <li>Stop Test - the entire test is stopped at the end of any current samples.</li>
-   <li>Stop Test Now - the entire test is stopped abruptly. Any current samplers are
interrupted if possible.</li>
+   <li><code>Continue</code> - ignore the error and continue with the test</li>
+   <li><code>Start next thread loop</code> - does not execute samplers
following the sampler in error for the current iteration and restarts the loop on next iteration</li>
+   <li><code>Stop Thread</code> - current thread exits</li>
+   <li><code>Stop Test</code> - the entire test is stopped at the end of
any current samples.</li>
+   <li><code>Stop Test Now</code> - the entire test is stopped abruptly.
Any current samplers are interrupted if possible.</li>
    </ul>
    </property>
    </properties>
@@ -5936,14 +5936,14 @@ The BeanShell PreProcessor allows arbitr
 <b>For full details on using BeanShell, please see the <a href="http://www.beanshell.org/">BeanShell
website.</a></b>
 </p>
 <p>
-The test element supports the ThreadListener and TestListener methods.
+The test element supports the <code>ThreadListener</code> and <code>TestListener</code>
methods.
 These should be defined in the initialisation file.
-See the file BeanShellListeners.bshrc for example definitions.
+See the file <code>BeanShellListeners.bshrc</code> for example definitions.
 </p>
 </description>
 <properties>
     <property name="Name" required="No">Descriptive name for this element that is shown
in the tree.
-    The name is stored in the script variable Label</property>
+    The name is stored in the script variable <code>Label</code></property>
     <property name="Reset bsh.Interpreter before each call" required="Yes">
     If this option is selected, then the interpreter will be recreated for each sample.
     This may be necessary for some long running scripts. 
@@ -5952,24 +5952,26 @@ See the file BeanShellListeners.bshrc fo
     <property name="Parameters" required="No">Parameters to pass to the BeanShell script.
     The parameters are stored in the following variables:
     <ul>
-        <li>Parameters - string containing the parameters as a single variable</li>
-        <li>bsh.args - String array containing parameters, split on white-space</li>
+        <li><code>Parameters</code> - string containing the parameters
as a single variable</li>
+        <li><code>bsh.args</code> - String array containing parameters,
split on white-space</li>
     </ul></property>
     <property name="Script file" required="No">A file containing the BeanShell script
to run.
-    The file name is stored in the script variable FileName</property>
+    The file name is stored in the script variable <code>FileName</code></property>
     <property name="Script" required="Yes (unless script file is provided)">The BeanShell
script. The return value is ignored.</property>
 </properties>
 <p>The following BeanShell variables are set up for use by the script:</p>
 <ul>
-<li>log - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
-<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
-<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new
Object());</li>
-<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
-<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult</li>
-<li>data - (byte [])- gives access to the current sample data</li>
+<li><code>log</code> - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
+<li><code>ctx</code> - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
+<li><code>vars</code> - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: <source>vars.get(key);
+vars.put(key,val);
+vars.putObject("OBJ1",new Object());</source></li>
+<li><code>props</code> - (JMeterProperties - class java.util.Properties)
- e.g. <code>props.get("START.HMS");</code> <code>props.put("PROP1","1234");</code></li>
+<li><code>prev</code> - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult</li>
+<li><code>data</code> - (byte [])- gives access to the current sample data</li>
 </ul>
 <p>For details of all the methods available on each of the above variables, please
check the Javadoc</p>
-<p>If the property <b>beanshell.postprocessor.init</b> is defined, this
is used to load an initialisation file, which can be used to define methods etc. for use in
the BeanShell script.</p>
+<p>If the property <code>beanshell.postprocessor.init</code> is defined,
this is used to load an initialisation file, which can be used to define methods etc. for
use in the BeanShell script.</p>
 </component>
 
 <component name="BSF PostProcessor" index="&sect-num;.8.6"  width="844" height="633"
screenshot="bsf_postprocessor.png">
@@ -5984,31 +5986,34 @@ The BSF PostProcessor allows BSF script
     <property name="Parameters" required="No">Parameters to pass to the script.
     The parameters are stored in the following variables:
     <ul>
-        <li>Parameters - string containing the parameters as a single variable</li>
-        <li>args - String array containing parameters, split on white-space</li>
+        <li><code>Parameters</code> - string containing the parameters
as a single variable</li>
+        <li><code>args</code> - String array containing parameters, split
on white-space</li>
     </ul></property>
-    <property name="Script file" required="No">A file containing the script to run,
if a relative file path is used, then it will be relative to directory referenced by "user.dir"
System property</property>
+    <property name="Script file" required="No">A file containing the script to run,
if a relative file path is used, then it will be relative to directory referenced by "<code>user.dir</code>"
System property</property>
     <property name="Script" required="Yes (unless script file is provided)">The script
to run.</property>
 </properties>
 <p>
-The script (or file) is processed using the BSFEngine.exec() method, which does not return
a value.
+The script (or file) is processed using the <code>BSFEngine.exec()</code> method,
which does not return a value.
 </p>
 <p>
 Before invoking the script, some variables are set up.
 Note that these are BSF variables - i.e. they can be used directly in the script.
 </p>
 <ul>
-<li>log - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
-<li>Label - the String Label</li>
-<li>Filename - the script file name (if any)</li>
-<li>Parameters - the parameters (as a String)</li>
-<li>args - the parameters as a String array (split on whitespace)</li>
-<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
-<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new
Object()); vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
-<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult (if any)</li>
-<li>sampler - (<a href="../api/org/apache/jmeter/samplers/Sampler.html">Sampler</a>)-
gives access to the current sampler</li>
-<li>OUT - System.out - e.g. OUT.println("message")</li>
+<li><code>log</code> - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
+<li><code>Label</code> - the String Label</li>
+<li><code>FileName</code> - the script file name (if any)</li>
+<li><code>Parameters</code> - the parameters (as a String)</li>
+<li><code>args</code> - the parameters as a String array (split on whitespace)</li>
+<li><code>ctx</code> - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
+<li><code>vars</code> - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: <source>vars.get(key);
+vars.put(key,val);
+vars.putObject("OBJ1",new Object());
+vars.getObject("OBJ2");</source></li>
+<li><code>props</code> - (JMeterProperties - class java.util.Properties)
- e.g. <code>props.get("START.HMS");</code> <code>props.put("PROP1","1234");</code></li>
+<li><code>prev</code> - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult (if any)</li>
+<li><code>sampler</code> - (<a href="../api/org/apache/jmeter/samplers/Sampler.html">Sampler</a>)-
gives access to the current sampler</li>
+<li><code>OUT</code> - System.out - e.g. <code>OUT.println("message")</code></li>
 </ul>
 <p>For details of all the methods available on each of the above variables, please
check the Javadoc</p>
 </component>
@@ -6025,10 +6030,10 @@ The JSR223 PostProcessor allows JSR223 s
     <property name="Parameters" required="No">Parameters to pass to the script.
     The parameters are stored in the following variables:
     <ul>
-        <li>Parameters - string containing the parameters as a single variable</li>
-        <li>args - String array containing parameters, split on white-space</li>
+        <li><code>Parameters</code> - string containing the parameters
as a single variable</li>
+        <li><code>args</code> - String array containing parameters, split
on white-space</li>
     </ul></property>
-    <property name="Script file" required="No">A file containing the script to run,
if a relative file path is used, then it will be relative to directory referenced by "user.dir"
System property</property>
+    <property name="Script file" required="No">A file containing the script to run,
if a relative file path is used, then it will be relative to directory referenced by "<code>user.dir</code>"
System property</property>
     <property name="Script compilation caching" required="No">Unique String across
Test Plan that JMeter will use to cache result of Script compilation if language used supports
<code>Compilable</code> interface (Groovy is one of these, java, beanshell and
javascript are not)</property>
     <property name="Script" required="Yes (unless script file is provided)">The script
to run.</property>
 </properties>
@@ -6037,17 +6042,20 @@ Before invoking the script, some variabl
 Note that these are JSR223 variables - i.e. they can be used directly in the script.
 </p>
 <ul>
-<li>log - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
-<li>Label - the String Label</li>
-<li>Filename - the script file name (if any)</li>
-<li>Parameters - the parameters (as a String)</li>
-<li>args - the parameters as a String array (split on whitespace)</li>
-<li>ctx - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
-<li>vars - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: vars.get(key); vars.put(key,val); vars.putObject("OBJ1",new
Object()); vars.getObject("OBJ2");</li>
-<li>props - (JMeterProperties - class java.util.Properties) - e.g. props.get("START.HMS");
props.put("PROP1","1234");</li>
-<li>prev - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult (if any)</li>
-<li>sampler - (<a href="../api/org/apache/jmeter/samplers/Sampler.html">Sampler</a>)-
gives access to the current sampler</li>
-<li>OUT - System.out - e.g. OUT.println("message")</li>
+<li><code>log</code> - (<a href="http://excalibur.apache.org/apidocs/org/apache/log/Logger.html">Logger</a>)
- can be used to write to the log file</li>
+<li><code>Label</code> - the String Label</li>
+<li><code>FileName</code> - the script file name (if any)</li>
+<li><code>Parameters</code> - the parameters (as a String)</li>
+<li><code>args</code> - the parameters as a String array (split on whitespace)</li>
+<li><code>ctx</code> - (<a href="../api/org/apache/jmeter/threads/JMeterContext.html">JMeterContext</a>)
- gives access to the context</li>
+<li><code>vars</code> - (<a href="../api/org/apache/jmeter/threads/JMeterVariables.html">JMeterVariables</a>)
- gives read/write access to variables: <source>vars.get(key);
+vars.put(key,val);
+vars.putObject("OBJ1",new Object());
+vars.getObject("OBJ2");</source></li>
+<li><code>props</code> - (JMeterProperties - class java.util.Properties)
- e.g. <code>props.get("START.HMS");</code> <code>props.put("PROP1","1234");</code></li>
+<li><code>prev</code> - (<a href="../api/org/apache/jmeter/samplers/SampleResult.html">SampleResult</a>)
- gives access to the previous SampleResult (if any)</li>
+<li><code>sampler</code> - (<a href="../api/org/apache/jmeter/samplers/Sampler.html">Sampler</a>)-
gives access to the current sampler</li>
+<li><code>OUT</code> - System.out - e.g. <code>OUT.println("message")</code></li>
 </ul>
 <p>For details of all the methods available on each of the above variables, please
check the Javadoc</p>
 </component>
@@ -6064,7 +6072,7 @@ This can be useful if your JDBC Sample c
         <link href="../demos/JDBC-Pre-Post-Processor.jmx">Test Plan using JDBC Pre/Post
Processor</link>
 </links>
 <p>
-In the linked test plan,"JDBC PostProcessor" JDBC PostProcessor calls a stored procedure
to delete from Database the Price Cut-Off that was created by PreProcessor.
+In the linked test plan, "<code>JDBC PostProcessor</code>" JDBC PostProcessor
calls a stored procedure to delete from Database the Price Cut-Off that was created by PreProcessor.
 </p>
 <figure width="818" height="399" image="jdbc-post-processor.png">JDBC PostProcessor</figure>
 </section>




Mime
View raw message