sebb 2004/01/13 17:24:36
Modified: xdocs/usermanual component_reference.xml
Log:
Basic documentation added for new test elements
Revision Changes Path
1.70 +84 -1 jakarta-jmeter/xdocs/usermanual/component_reference.xml
Index: component_reference.xml
===================================================================
RCS file: /home/cvs/jakarta-jmeter/xdocs/usermanual/component_reference.xml,v
retrieving revision 1.69
retrieving revision 1.70
diff -u -r1.69 -r1.70
--- component_reference.xml 13 Jan 2004 04:41:01 -0000 1.69
+++ component_reference.xml 14 Jan 2004 01:24:36 -0000 1.70
@@ -473,6 +473,35 @@
}
</pre>
</component>
+
+
+<component name="BSF Sampler (ALPHA CODE)" index="14.1.10" screenshot="">
+<center><h2>(ALPHA Code)</h2></center>
+ <description><p>This sampler allows you to write a sampler using a BSF
scripting language.<br></br>
+
+ <br></br>
+ Please note that the BSF jar file is not included with JMeter; it
needs to be separately downloaded.
+ For full details, please see the BSF web-site at
http://bsf.jakarta.apache.org/.
+
+ </p>
+ </description>
+<properties>
+ <property name="Name" required="no">Descriptive name for this controller that
is shown in the tree.</property>
+ <property name="Parameters" required="no">List of parameters to be passed to
the script file or the script.</property>
+ <property name="Script File" required="no">Name of a file to be used as a
BeanShell script</property>
+ <property name="Script" required="no">Script to be passed to
BeanShell</property>
+</properties>
+TBC
+</component>
+
+<component name="TCP Sampler (ALPHA CODE)" index="14.1.11" screenshot="">
+<description>TBA
+</description>
+<properties>
+ <property name="Name" required="">Descriptive name for this element that is shown
in the tree.</property>
+</properties>
+</component>
+
</section>
<section name="14.2 Logic Controllers" anchor="logic_controllers">
@@ -1207,6 +1236,14 @@
</properties>
</component>
+<component index="14.4.15" name="TCP Sampler Config (ALPHA CODE)" screenshot="">
+<description>TBA
+</description>
+<properties>
+ <property name="Name" required="">Descriptive name for this element that is shown
in the tree.</property>
+</properties>
+</component>
+
</section>
<section name="14.5 Assertions" anchor="assertions">
@@ -1277,6 +1314,15 @@
</properties>
</component>
+<component index="14.5.5" name="BeanShell Assertion" screenshot="bsh_assertion.png">
+<description><p>The BeanShell Assertion allows the user to perform assertion
checking using a BeanShell script.</p></description>
+
+<properties>
+<property name="Name" required="">Descriptive name for this element that is shown
in the tree.</property>
+
+</properties>
+</component>
+
</section>
<section name="14.6 Timers" anchor="timers">
@@ -1524,6 +1570,43 @@
<property name="Default Value" required="No">If no matches are found, the
default value is stored in the variable.</property>
</properties>
</component>
+
+<component index="14.8.2" name="Result Status Action Handler"
screenshot="resultstatusactionhandler.png">
+ <description>This test element allows the user to stop the thread or the whole
test if the relevant sampler failed.
+ </description>
+ <properties>
+ <property name="Name" required="">Descriptive name for this element that is
shown in the tree.</property>
+ </properties>
+</component>
+
+<component index="14.8.3" name="Save Responses to a file"
screenshot="savetofile.png">
+ <description>This test element can be placed anywhere in the test plan.
+ For each sample in its scope, it will create a file of the response
Data.
+ The primary use for this is in creating functional tests.
+ The file name is created from the specified prefix, plus a number.
+ The file extension is created from the document type, if know.
+ </description>
+ <properties>
+ <property name="Name" required="">Descriptive name for this element that is shown
in the tree.</property>
+ <property name="Filename Prefix" required="">Prefix for the generate file
name</property>
+ </properties>
+</component>
+
+<component index="14.8.4" name="Generate Summary Results" screenshot="summary.png">
+ <description>This test element can be placed anywhere in the test plan.
+Generates a summary of the test run so far to the log file and/or
+standard output. Both running and differential totals are shown.
+Output is generated every n seconds (default 3 minutes) on the appropriate
+time boundary, so that multiple test runs on the same time will be
+ synchronised.
+
+This is mainly intended for batch (non-GUI) runs.
+ </description>
+ <properties>
+ <property name="Name" required="">Descriptive name for this element that is shown
in the tree.</property>
+ </properties>
+</component>
+
</section>
<section name="14.9 Miscellaneous Features" anchor="Miscellaneous_Features">
---------------------------------------------------------------------
To unsubscribe, e-mail: [EMAIL PROTECTED]
For additional commands, e-mail: [EMAIL PROTECTED]
