Changeset 3518 for trunk/doc/src/docbook/developerdoc/plugin_developer.xml

Timestamp:

Jun 20, 2007, 8:48:57 AM (15 years ago)

Author:

Nicklas Nordborg

Message:

Fixes #637

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -1621 +1621 @@
             Send the form to
             <filename>index.jsp</filename>
-            with the <varname>ID</varname> and <varname>cmd</varname> parameters
-            as shown below.
+            with the <varname>ID</varname>, 
+            <varname>cmd</varname> and <varname>requestId</varname> 
+            parameters as shown below.
           </simpara>
 <programlisting>&lt;form action="index.jsp" method="post"&gt;
 &lt;input type="hidden" name="ID" value="&lt;%=ID%&gt;"&gt;
+&lt;input type="hidden" name="requestId" value="&lt;%=request.getParameter("requestId")%&gt;"&gt;
 &lt;input type="hidden" name="cmd" value="SetParameters"&gt;
 ...
 &lt;/form&gt;</programlisting>
+          <simpara>
+            The <varname>ID</varname> is the session ID for the logged
+            in user and is required. The <varname>requestId</varname>
+            is the ID for this particular plug-in/job configuration
+            sequence. It is optional, but we recommend that you use it
+            since it protects your plug-in from getting mixed up with 
+            other plug-in configuration wizards. The <varname>cmd</varname>
+            tells BASE to send the parameters to the plug-in for validation
+            and saving.
+          </simpara>
 
           </listitem>
           </itemizedlist>
+          
+          <para>
+            If you want a &gbCancel; button to abort the configuration
+            you should reload the page with with the url:
+            <uri>index.jsp?ID=&lt;%=ID%&gt;&amp;cmd=CancelWizard</uri>. This
+            allows BASE to clean up resources that has been put in global
+            session variables.
+          </para>
+          
             <para>
               In your JSP page you will probably need to access some information like the