[riftsaw-commits] riftsaw SVN: r265 - in trunk/docs/docbook: gettingstartedguide/src/main/images and 3 other directories.

Author: objectiser Date: 2009-11-13 17:26:08 -0500 (Fri, 13 Nov 2009) New Revision: 265 Added: trunk/docs/docbook/userguide/src/main/images/BPELConsole-login.png trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instance-data.png trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instances.png trunk/docs/docbook/userguide/src/main/images/BPELConsole-processes.png trunk/docs/docbook/userguide/src/main/images/BPELEditor.png trunk/docs/docbook/userguide/src/main/images/BPELInvokeRelationship.jpg Removed: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-login.png trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-process-instance-data.png trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-process-instances.png trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-processes.png trunk/docs/docbook/gettingstartedguide/src/main/images/BPELEditor.png trunk/docs/docbook/gettingstartedguide/src/main/module/console.xml Modified: trunk/docs/docbook/gettingstartedguide/src/main/master.xml trunk/docs/docbook/userguide/src/main/module/admin.xml trunk/docs/docbook/userguide/src/main/module/esb.xml trunk/docs/docbook/userguide/src/main/module/introduction.xml Log: Move admin console documentation from Getting Started Guide to User Guide, and add more info on deployment. Also added Len's artifact relationship image from ESB->BPEL integration blog, into User Guide (ESB integration section). Deleted: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-login.png =================================================================== (Binary files differ) Deleted: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-process-instance-data.png =================================================================== (Binary files differ) Deleted: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-process-instances.png =================================================================== (Binary files differ) Deleted: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELConsole-processes.png =================================================================== (Binary files differ) Deleted: trunk/docs/docbook/gettingstartedguide/src/main/images/BPELEditor.png =================================================================== (Binary files differ) Modified: trunk/docs/docbook/gettingstartedguide/src/main/master.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2009-11-13 01:27:14 UTC (rev 264) +++ trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2009-11-13 22:26:08 UTC (rev 265) @@ -12,6 +12,5 @@ <toc/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/installation.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/console.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/examples.xml"/> </book> Deleted: trunk/docs/docbook/gettingstartedguide/src/main/module/console.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/module/console.xml 2009-11-13 01:27:14 UTC (rev 264) +++ trunk/docs/docbook/gettingstartedguide/src/main/module/console.xml 2009-11-13 22:26:08 UTC (rev 265) @@ -1,93 +0,0 @@ -<?xml version="1.0" encoding="UTF-8"?> -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ -]> -<chapter id="console"> - <title>BPEL Console</title> - - <section> - <title>Overview</title> - <para> - This chapter provides a getting started guide to the BPEL Console. - </para> - - <para> - The console provides the ability to view: - </para> - - <itemizedlist> - <listitem> - The process definitions deployed to the BPEL engine - </listitem> - <listitem> - The process instances executing in the BPEL engine - </listitem> - </itemizedlist> - - </section> - - <section> - <title>Logging in</title> - - <para> - The BPEL console can be located using the URL: - <ulink url="http://localhost:8080/bpel-console">http://localhost:8080/bpel-console</ulink>. - </para> - - <para> - The first screen that is presented is the login screen: - </para> - - <imageobject> - <imagedata fileref="images/BPELConsole-login.png" align="center" width="6in" /> - </imageobject> - - <para> - The default username is <emphasis>admin</emphasis> with password - <emphasis>password</emphasis>. - </para> - </section> - - <section> - <title>Deployed Process Definitions</title> - - <para> - Once logged in, the 'Process Definitions' tab shows the currently deployed - BPEL processes. - </para> - - <imageobject> - <imagedata fileref="images/BPELConsole-processes.png" align="center" width="6in" /> - </imageobject> - - <para> - When a process definition is selected, the details will be displayed in the - lower panel. - </para> - - </section> - - <section> - <title>Process Instances</title> - - <para> - The 'Process Instances' tab shows the currently executing BPEL process instances. - Before selecting this tab, you must choose a process definition. - </para> - - <imageobject> - <imagedata fileref="images/BPELConsole-process-instances.png" align="center" width="6in" /> - </imageobject> - - <para> - When a process instance has been selected, its details will be displayed in the lower properties - window. The <emphasis>Instance Data</emphasis> button will also become enable, 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> - -</chapter> Added: trunk/docs/docbook/userguide/src/main/images/BPELConsole-login.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELConsole-login.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instance-data.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instance-data.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instances.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELConsole-process-instances.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/BPELConsole-processes.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELConsole-processes.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/BPELEditor.png =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELEditor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/docs/docbook/userguide/src/main/images/BPELInvokeRelationship.jpg =================================================================== (Binary files differ) Property changes on: trunk/docs/docbook/userguide/src/main/images/BPELInvokeRelationship.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: trunk/docs/docbook/userguide/src/main/module/admin.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/admin.xml 2009-11-13 01:27:14 UTC (rev 264) +++ trunk/docs/docbook/userguide/src/main/module/admin.xml 2009-11-13 22:26:08 UTC (rev 265) @@ -8,6 +8,7 @@ <title>Overview</title> <para> + This section describes the administration capabilities associated with RiftSaw. </para> </section> @@ -15,17 +16,178 @@ <section> <title>BPM Console</title> - <para> - </para> - + <section> + <title>Overview</title> + <para> + This section provides an overview of the BPEL Console. + The console provides the ability to view: + </para> + + <itemizedlist> + <listitem> + The process definitions deployed to the BPEL engine + </listitem> + <listitem> + The process instances executing in the BPEL engine + </listitem> + </itemizedlist> + + </section> + + <section> + <title>Logging in</title> + + <para> + The BPEL console can be located using the URL: + <ulink url="http://localhost:8080/bpel-console">http://localhost:8080/bpel-console</ulink>. + </para> + + <para> + The first screen that is presented is the login screen: + </para> + + <imageobject> + <imagedata fileref="images/BPELConsole-login.png" align="center" width="6in" /> + </imageobject> + + <para> + The default username is <emphasis>admin</emphasis> with password + <emphasis>password</emphasis>. + </para> + </section> + + <section> + <title>Deployed Process Definitions</title> + + <para> + Once logged in, the 'Process Definitions' tab shows the currently deployed + BPEL processes. + </para> + + <imageobject> + <imagedata fileref="images/BPELConsole-processes.png" align="center" width="6in" /> + </imageobject> + + <para> + When a process definition is selected, the details will be displayed in the + lower panel. + </para> + + </section> + + <section> + <title>Process Instances</title> + + <para> + The 'Process Instances' tab shows the currently executing BPEL process instances. + Before selecting this tab, you must choose a process definition. + </para> + + <imageobject> + <imagedata fileref="images/BPELConsole-process-instances.png" align="center" width="6in" /> + </imageobject> + + <para> + When a process instance has been selected, its details will be displayed in the lower properties + window. The <emphasis>Instance Data</emphasis> button will also become enable, 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> <section> <title>BPEL Process Deployment</title> - <para> + <para> + BPEL processes can be deployed to RiftSaw in two ways: </para> + <itemizedlist> + <listitem> + Eclipse BPEL editor with JBoss AS deployment + </listitem> + <listitem> + ANT script based deployment + </listitem> + </itemizedlist> + + <para> + The first approach, using the WTP deployment framework within Eclipse, + is described in the JBoss Tools documentation related to the BPEL + editor support. Please refer to this documentation for further help + using this approach. + </para> + + <para> + The ANT script approach is demonstrated in the quickstart examples. + For example, + </para> + + <informalexample> + <programlisting role="XML" ><![CDATA[ + <!-- Import the base Ant build script... --> + <property file="../../../install/deployment.properties" /> + + <property name="version" value="1" /> + + <property name="server.dir" value="${org.jboss.as.home}/server/${org.jboss.as.config}"/> + <property name="conf.dir" value="${server.dir}/conf"/> + <property name="deploy.dir" value="${server.dir}/deploy"/> + <property name="server.lib.dir" value="${server.dir}/lib"/> + + <property name="sample.jar.name" value="${ant.project.name}-${version}.jar" /> + + <target name="deploy"> + <echo>Deploy ${ant.project.name}</echo> + <jar basedir="bpel" destfile="${deploy.dir}/${sample.jar.name}" /> + </target> + + <target name="undeploy"> + <echo>Undeploy ${ant.project.name}</echo> + <delete file="${deploy.dir}/${sample.jar.name}" /> + </target> + ]]></programlisting> + </informalexample> + + <para> + This excerpt from the ANT build file for the <emphasis>hello_world</emphasis> + quickstart example shows that deploying a RiftSaw BPEL process using ANT + is very straightforward. The main points of interest are: + </para> + + <itemizedlist> + <listitem> + It is necessary to identify the location of the JBoss AS server in which + the BPEL process will be deployed. This is achieved in this example by + referring to the <filename>deployment.properties</filename> file that + has been configured in the RiftSaw distribution (install folder). + </listitem> + <listitem> + If a versioned approach is being used, so that multiple versions of the + same BPEL process may be deployed at one time, then the name of the + archive (jar) containing the BPEL process (and associated artifacts) + has a version number suffix. This would need to be manually incremented + for each distinct version of the BPEL process being deployed. + </listitem> + <listitem> + The next step is to define the <emphasis>deploy</emphasis> target, which + will create the BPEL process archive, using the contents of the bpel + sub-folder in this case, and store it within the JBoss AS + server's <filename>deploy</filename> folder. + </listitem> + <listitem> + The final step is to define the <emphasis>undeploy</emphasis> target, + which simply removes the BPEL process archive from the JBoss AS + server's <filename>deploy</filename> folder. + </listitem> + </itemizedlist> + </section> </chapter> Modified: trunk/docs/docbook/userguide/src/main/module/esb.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/esb.xml 2009-11-13 01:27:14 UTC (rev 264) +++ trunk/docs/docbook/userguide/src/main/module/esb.xml 2009-11-13 22:26:08 UTC (rev 265) @@ -158,7 +158,16 @@ part is defined as a text node, with value "Hello World". However this could have been an element representing the root node of a more complex XML value. </para> + + <para> + The following diagram illustrates the inter-relationship of the JBossESB bpel_helloworld + quickstart and the RiftSaw BPEL process configuration files. + </para> + <imageobject> + <imagedata fileref="images/BPELInvokeRelationship.jpg" align="center" width="6in" /> + </imageobject> + <section> <title>Fault Handling</title> Modified: trunk/docs/docbook/userguide/src/main/module/introduction.xml =================================================================== --- trunk/docs/docbook/userguide/src/main/module/introduction.xml 2009-11-13 01:27:14 UTC (rev 264) +++ trunk/docs/docbook/userguide/src/main/module/introduction.xml 2009-11-13 22:26:08 UTC (rev 265) @@ -7,9 +7,22 @@ <section> <title>Overview</title> - <para> + <para> + This is the User Guide for the RiftSaw BPEL process engine. </para> + <para> + RiftSaw provides a JBoss AS integration for the Apache ODE BPEL engine. For detailed + information on executing BPEL processes within Apache ODE, we would refer the reader + to the <ulink url="http://ode.apache.org">Apache ODE</ulink> website and documentation. + </para> + + <para> + In addition to the ability to run the Apache ODE engine within JBoss AS, the RiftSaw + project also provides a GWT based administration console, replaces the Axis2 based transport + with JBossWS (which can be configured to use Apache CXF), and provides tighter integration + with JBossESB. + </para> </section> </chapter>