Author: heiko.braun(a)jboss.com Date: 2010-11-02 07:28:42 -0400 (Tue, 02 Nov 2010) New Revision: 1077 Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_data.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_deployments.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_execution_path.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_history.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_instances.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_login.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_more_options.png trunk/docs/docbook/userguide/src/main/en-US/images/Console_version.png Modified: trunk/docs/docbook/userguide/src/main/en-US/module/admin.xml trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml trunk/docs/docbook/userguide/src/main/en-US/module/db.xml trunk/docs/docbook/userguide/src/main/en-US/module/deploy.xml trunk/docs/docbook/userguide/src/main/en-US/module/esb.xml Log: Added new console sections. Update image path. Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_data.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_data.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_deployments.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_deployments.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_execution_path.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_execution_path.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_history.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_history.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_instances.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_instances.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_login.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_login.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_more_options.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_more_options.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/en-US/images/Console_version.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/en-US/images/Console_version.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/docs/docbook/userguide/src/main/en-US/module/admin.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/admin.xml 2010-11-02 10:41:00 UTC (rev 1076) +++ trunk/docs/docbook/userguide/src/main/en-US/module/admin.xml 2010-11-02 11:28:42 UTC (rev 1077) @@ -30,6 +30,9 @@ <listitem> The process instances executing in the BPEL engine </listitem> + <listitem> + The execution history of a process + </listitem> </itemizedlist> </section> @@ -47,7 +50,7 @@ </para> <imageobject> - <imagedata fileref="images/BPELConsole-login.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/Console_login.png" align="center" width="6in" /> </imageobject> <para> @@ -81,13 +84,9 @@ <title>Deployed Process Definitions</title> <para> - Once logged in, the 'Process Overview' tab shows the currently deployed + Once logged in, the <emphasis>'Manage Instances'</emphasis> tab shows the currently deployed BPEL processes and their versions. - </para> - - <imageobject> - <imagedata fileref="images/BPELConsole-processes.png" align="center" width="6in" /> - </imageobject> + </para> </section> @@ -95,27 +94,176 @@ <title>Process Instances</title> <para> - When a process definition is selected, the list of active process instances for - that process definition (and version) will be displayed in the right hand + When a process definition is selected (<emphasis>Open</emphasis>), the list of active process instances for + that process definition (and version) will be displayed in the bottom panel. </para> <imageobject> - <imagedata fileref="images/BPELConsole-process-instances.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/Console_instances.png" align="center" width="6in" /> </imageobject> - - <para> - When a process instance is selected, its details will be displayed in the lower - <emphasis>Execution Details</emphasis> - window. The <emphasis>Instance Data</emphasis> button will also become enabled, allowing - further detail about the process to be displayed. - </para> - - <imageobject> - <imagedata fileref="images/BPELConsole-process-instance-data.png" align="center" width="6in" /> - </imageobject> - + </section> + + <section> + <title>Process Versions</title> + <para> + There is only one active version at a time. If you open a process definition the + active version will be chosen by default. Sometimes you need to manage instancs of a + retired version (i.e. to terminate running instances). + In that case the button <emphasis>More - Change Version</emphasis> + allows you to select a different version of that process. + </para> + + <imageobject> + <imagedata fileref="en-US/images/Console_more_options.png" align="center" width="6in" /> + </imageobject> + + </section> + + <section> + <title>Execution History</title> + <para> + The <emphasis>Execution History</emphasis> allows you to inspect the BPAF history data associated + with a process. You can specify a timespan and wether or not you'd like to see failed/terminated instances + included in the chart. + </para> + + <imageobject> + <imagedata fileref="en-US/images/Console_history.png" align="keft" width="6in" /> + </imageobject> + + <para> + The chart has various keyboard bindings to browse through the displayed + execution data: + + <table> + <thead> + <tr> + <th class="noteheader" colspan="4">Keyboard and Mouse Commands</th> + + </tr> + </thead> + <tbody> + <tr> + <th>Up Arrow</th> + <td>Zoom In</td> + <th>Down Arrow</th> + + <td>Zoom Out</td> + </tr> + <tr> + <th>Left Arrow</th> + <td>Half-Page Left</td> + <th>Right Arrow</th> + <td>Half-Page Right</td> + + </tr> + <tr> + <th>Page-Up</th> + <td>Page Left</td> + <th>Page-Down</th> + <td>Page Right</td> + </tr> + + <tr> + <th>TAB</th> + <td>Next Focus</td> + <th>Shift-TAB</th> + <td>Previous Focus</td> + </tr> + <tr> + + <th>HOME</th> + <td>Max Zoom Out</td> + <th>ENTER</th> + <td>Max Zoom In to Focus</td> + </tr> + <tr> + <th>Mouse Drag</th> + + <td>Scroll Chart</td> + <th>Shift Mouse Drag</th> + <td>Drag Select/Zoom</td> + </tr> + <tr> + <th>Mouse Wheel Up/Z</th> + <td>Zoom In</td> + + <th>Mouse Wheel Down/X</th> + <td>Zoom Out</td> + </tr> + <tr> + <th>Backspace/Back Button</th> + <td>Back</td> + <th>Right Mouse Button</th> + + <td>Context Menu</td> + </tr> + <tr> + <th>Left Click</th> + <td>Set Focus</td> + <th>Double Click</th> + <td>Max Zoom In to Focus</td> + + </tr> + + + </tbody> + </table> + </para> + + <section> + <title>Logging configuration options</title> + <para> + + You need to explicitly enable history logging for a particular process through the 'deploy.xml' file + and for the BPEL engine in general through the 'bpel.properties' file. In order to record history + data, set the 'process-events' option for a particular process and make sure the 'org.jboss.soa.bpel.console.bpaf.BPAFLogAdapter' + is enabled. + + </para> + + <para> + Process configuration example (deploy.xml): +<programlisting> +&lt;deploy xmlns="http://www.apache.org/ode/schemas/dd/2007/03" + xmlns:bpl="http://www.jboss.org/bpel/examples" + xmlns:intf="http://www.jboss.org/bpel/examples/wsdl"> + + &lt;process name="bpl:HelloGoodbye"> + &lt;active>true&lt;/active> + &lt;process-events generate="all"/> + &lt;provide partnerLink="helloGoodbyePartnerLink"> + &lt;service name="intf:HelloGoodbyeService" port="HelloGoodbyePort"/> + &lt;/provide> + &lt;/process> +&lt;/deploy> +</programlisting> + + + </para> + + </section> + + </section> + + <section> + <title>Instance Data and Execution Path</title> + <para> + When a process instance is selected, its details will be displayed in the + <emphasis>Execution Details</emphasis> + panel. The <emphasis>Instance Data</emphasis> button will also become enabled, allowing + further detail about the process to be displayed. + Likewise the <emphasis>Execution Path</emphasis> button opens the related instance execution graph. + </para> + + <imageobject> + <imagedata fileref="en-US/images/Console_execution_path.png" align="center" width="6in" /> + </imageobject> + + </section> + <section> <title>Retiring and Reactivating Process Definitions</title> @@ -151,7 +299,7 @@ </para> <imageobject> - <imagedata fileref="images/ActivateRetire.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/Console_deployments.png" align="center" width="6in" /> </imageobject> <para> @@ -216,6 +364,12 @@ setting this value to <emphasis>true</emphasis>, then the web service will remain available while the BPEL process is updated, however any changes in the WSDL will not be made available.</td> </tr> + <tr> + <td>bpel.event.listeners (org.jboss.soa.bpel.console.bpaf.BPAFLogAdapter)</td> + <td> + Enables the BPAF logging used by the console to display the process execution history. + </td> + </tr> </table> </section> Modified: trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml 2010-11-02 10:41:00 UTC (rev 1076) +++ trunk/docs/docbook/userguide/src/main/en-US/module/clustering.xml 2010-11-02 11:28:42 UTC (rev 1077) @@ -13,7 +13,7 @@ </para> <imageobject> - <imagedata fileref="images/riftsaw-cluster.jpg"/> + <imagedata fileref="en-US/images/riftsaw-cluster.jpg"/> </imageobject> </section> Modified: trunk/docs/docbook/userguide/src/main/en-US/module/db.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/db.xml 2010-11-02 10:41:00 UTC (rev 1076) +++ trunk/docs/docbook/userguide/src/main/en-US/module/db.xml 2010-11-02 11:28:42 UTC (rev 1077) @@ -25,7 +25,7 @@ </para> <imageobject> - <imagedata fileref="images/RiftSaw-dbschemas.png" align="center"/> + <imagedata fileref="en-US/images/RiftSaw-dbschemas.png" align="center"/> </imageobject> </section> Modified: trunk/docs/docbook/userguide/src/main/en-US/module/deploy.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/deploy.xml 2010-11-02 10:41:00 UTC (rev 1076) +++ trunk/docs/docbook/userguide/src/main/en-US/module/deploy.xml 2010-11-02 11:28:42 UTC (rev 1077) @@ -110,7 +110,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseImportExistingProjectsIntoWorkspace.png" align="center" width="4in" /> + <imagedata fileref="en-US/images/EclipseImportExistingProjectsIntoWorkspace.png" align="center" width="4in" /> </imageobject> <para> @@ -120,7 +120,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseImportHelloWorld.png" align="center" width="4in" /> + <imagedata fileref="en-US/images/EclipseImportHelloWorld.png" align="center" width="4in" /> </imageobject> <para> @@ -129,7 +129,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseHelloWorldProject.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/EclipseHelloWorldProject.png" align="center" width="6in" /> </imageobject> <para> @@ -146,7 +146,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseNewServer.png" align="center" width="4in" /> + <imagedata fileref="en-US/images/EclipseNewServer.png" align="center" width="4in" /> </imageobject> <para> @@ -166,7 +166,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseAddRemoveProject.png" align="center" width="4in" /> + <imagedata fileref="en-US/images/EclipseAddRemoveProject.png" align="center" width="4in" /> </imageobject> <para> @@ -176,7 +176,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseHelloWorldDeployed.png" align="center" width="3in" /> + <imagedata fileref="en-US/images/EclipseHelloWorldDeployed.png" align="center" width="3in" /> </imageobject> <para> @@ -194,7 +194,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseSendHello.png" align="center" width="5in" /> + <imagedata fileref="en-US/images/EclipseSendHello.png" align="center" width="5in" /> </imageobject> <para> @@ -205,7 +205,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseHelloWorldResponse.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/EclipseHelloWorldResponse.png" align="center" width="6in" /> </imageobject> <para> @@ -217,7 +217,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseHelloWorldUpdated.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/EclipseHelloWorldUpdated.png" align="center" width="6in" /> </imageobject> <para> @@ -234,7 +234,7 @@ </para> <imageobject> - <imagedata fileref="images/EclipseHelloWorldResponseUpdated.png" align="center" width="6in" /> + <imagedata fileref="en-US/images/EclipseHelloWorldResponseUpdated.png" align="center" width="6in" /> </imageobject> <para> Modified: trunk/docs/docbook/userguide/src/main/en-US/module/esb.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/en-US/module/esb.xml 2010-11-02 10:41:00 UTC (rev 1076) +++ trunk/docs/docbook/userguide/src/main/en-US/module/esb.xml 2010-11-02 11:28:42 UTC (rev 1077) @@ -187,7 +187,7 @@ </para> <imageobject> - <imagedata fileref="images/BPELInvokeRelationship.jpg" align="center" width="6in" /> + <imagedata fileref="en-US/images/BPELInvokeRelationship.jpg" align="center" width="6in" /> </imageobject> <section>