[jmeter] 05/47: Document Module Controller restrictons

[vl...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

vladimirsitnikov pushed a commit to annotated tag v2_3
in repository https://gitbox.apache.org/repos/asf/jmeter.git

commit ffeb912b6c5d7c1513823445987908cd7f6ebc45
Author: Sebastian Bazley <se...@apache.org>
AuthorDate: Wed Sep 12 17:09:40 2007 +0000

    Document Module Controller restrictons
    
    git-svn-id: https://svn.apache.org/repos/asf/jakarta/jmeter/branches/rel-2-2@575014 13f79535-47bb-0310-9956-ffa450edef68
    
    Former-commit-id: 41b1ce32be7103bded3a7ac944cd65ce37f02a1a
---
 xdocs/usermanual/component_reference.xml | 23 +++++++++++++++++++++--
 1 file changed, 21 insertions(+), 2 deletions(-)

diff --git a/xdocs/usermanual/component_reference.xml b/xdocs/usermanual/component_reference.xml
index 6f3dafe..3377905 100644
--- a/xdocs/usermanual/component_reference.xml
+++ b/xdocs/usermanual/component_reference.xml
@@ -1489,11 +1489,30 @@ which clearly won't match. Thus the For 2 Sampler will not be run.
 
 <component name="Module Controller" index="&sect-num;.2.13"  width="409" height="255" screenshot="module_controller.png">
 <description>
-<p>The Module Controller provides a mechanism for substituting test plan fragments into the current test plan at run-time.  To use this
-module effectively, one might have a number of Controllers under the <complink name="WorkBench" />, each with a different series of
+<p>
+The Module Controller provides a mechanism for substituting test plan fragments into the current test plan at run-time.
+</p>
+<p>
+A test plan fragment consists of a Controller and all the test elements (samplers etc) contained in it. 
+The fragment can be located in any Thread Group, or on the <complink name="WorkBench" />.
+If the fragment is located in a Thread Group, then its Controller can be disabled to prevent the fragment being run
+except by the Module Controller. 
+Or you can store the fragments in a dummy Thread Group, and disable the entire Thread Group. 
+</p>
+<p>
+There can be multiple fragments, each with a different series of
 samplers under them.  The module controller can then be used to easily switch between these multiple test cases simply by choosing
 the appropriate controller in its drop down box.  This provides convenience for running many alternate test plans quickly and easily.
 </p>
+<p>
+A fragment name is made up of the Controller name and all its parent names.
+For example:
+<pre>
+Test Plan / Protocol: JDBC / Control / Interleave Controller
+</pre>
+Any fragments used by the Module Controller must have a unique name,
+as the name is used to find the target controller when a test plan is reloaded.
+</p>
 </description>
 <note>The Module Controller should not be used with remote testing or non-gui testing in conjunction with Workbench components since the Workbench test elements are not part of test plan .jmx files.  Any such test will fail.</note>
 <properties>