[riftsaw-commits] riftsaw SVN: r273 - trunk/docs/docbook/gettingstartedguide/src/main/module.

Author: objectiser Date: 2009-11-17 07:39:05 -0500 (Tue, 17 Nov 2009) New Revision: 273 Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml Log: Updated installation instructions to cover upgrade of jbossws and selection/config of database. Added the bpel_helloworld ESB example to the examples section. Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml 2009-11-17 10:35:51 UTC (rev 272) +++ trunk/docs/docbook/gettingstartedguide/src/main/module/examples.xml 2009-11-17 12:39:05 UTC (rev 273) @@ -23,7 +23,7 @@ </section> <section> - <title>Quickstart Examples</title> + <title>Quickstart Examples - Hello World</title> <para> The BPEL example we are going to try out is the simple @@ -112,9 +112,65 @@ </section> <section> - <title>ESB Examples</title> + <title>ESB Examples - ESB Invocation of Hello World</title> <para> + This quickstart example demonstrates how an ESB service can directly invoke + a BPEL process running inside RiftSaw, as long as RiftSaw and the ESB are + co-located in the same JVM, and the invoked BPEL process is deployed to the + RiftSaw instance running co-located with the JBossESB. + </para> + + <para> + If the ESB examples were deployed during the RiftSaw installation procedure, + the example that we are going to try will be located in the + <filename>${JBossESB}/samples/quickstarts/bpel_helloworld</filename> + folder. + </para> + + <para> + Also note that the quickstart described in the preceding section, + located in the <filename>${RiftSaw}/samples/quickstarts/hello_world</filename> + must still be deployed. If this example is not deployed, then please follow + the instructions in the previous section to deploy the example. + </para> + + <para> + The next step is to deploy the ESB service that will invoke this "hello world" + BPEL process. This is achieved by performing the following command in the + <filename>${JBossESB}/samples/quickstarts/bpel_helloworld</filename> + folder. + </para> + + <code> + ant deploy + </code> + + <para> + Once the ESB service has been successfully deployed, then run the following command: + </para> + + <code> + ant sendesb + </code> + + <para> + This command will send the text "Hello World via ESB to BPEL" to the ESB service, + which will invoke the BPEL + process, which in turn will append "World" to the text and echo it back until it + is received by the client application. + </para> + + <para> + For more information on the ESB to RiftSaw integration, please see the User Guide. + </para> + + </section> + + <section> + <title>ESB Examples - Order Management</title> + + <para> The ESB/BPEL example we are going to try out is the 'order management' example. When the ESB examples have been deployed, as described in the Installation chapter, then @@ -124,6 +180,12 @@ </para> <para> + This example is different to the previous ESB example, in that + it uses the BPEL process running inside RiftSaw as a Web Service. + There is no direct invocation of the BPEL process. + </para> + + <para> The first step is to deploy the example to the running JBossAS server. This is achieved using the following command: </para> @@ -147,7 +209,7 @@ </para> <para> - An example message can be found in the <filename>ppel/sampleData</filename> + An example message can be found in the <filename>bpel/sampleData</filename> subfolder. </para> Modified: trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml =================================================================== --- trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2009-11-17 10:35:51 UTC (rev 272) +++ trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2009-11-17 12:39:05 UTC (rev 273) @@ -24,7 +24,9 @@ <listitem>JBossAS (version 5.1.GA or higher), available from <ulink url="http://www.jboss.org/jbossas">http://www.jboss.org/jbos... <listitem>JBossESB (version 4.6.GA or higher), should download the <emphasis role="bold">jbossesb-4.6.GA.zip</emphasis>, available from <ulink url="http://www.jboss.org/jbossesb">http://www.jboss.org/jbo...;. This is only required to run the ESB/BPEL example.</listitem> - <listitem>RiftSaw (version 2.0-M1 or higher), available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/rift... + <listitem>RiftSaw (version 2.0-M2 or higher), available from <ulink url="http://www.jboss.org/riftsaw">http://www.jboss.org/rift... + <listitem>If using JBossAS 5.1.GA, then it will also be necessary to upgrade JBossWS (version 3.2.1.GA or higher), + available from <ulink url="http://www.jboss.org/jbossws">http://www.jboss.org/jbos... <listitem> Ant, available from <ulink url="http://ant.apache.org/">http://ant.apache.org</ulink... </listitem> @@ -33,6 +35,15 @@ <section> <title>Installation Instructions</title> + + <note> + <para> + If you have previously installed RiftSaw-2.0-M1, then you will need to undeploy this version using the + <emphasis>ant undeploy</emphasis> command from the <filename>install</filename> folder of the M1 + distribution. This is due to database schema changes. + </para> + </note> + <orderedlist> <listitem> Install JBossAS @@ -53,6 +64,18 @@ </para> </listitem> + <listitem> + Upgrade JBossWS + <para> + This is only required if you are using JBossAS 5.1.GA. + </para> + <para> + Unpack the JBossWS installation into a location alongside the JBossAS installation. + Then follow the instructions in the JBossWS installation (docs/Install.txt), to upgrade + the JBossWS version in the JBossAS environment. + </para> + </listitem> + <listitem> Install the RiftSaw distribution <para> @@ -65,7 +88,9 @@ the JBossAS and JBossESB location settings. </listitem> <listitem> - From the install folder, run: <command>ant deploy</command> to deploy RiftSaw to JBossAS. + From the install folder, run: <command>ant deploy -Ddatabase=....</command> to deploy + RiftSaw to JBossAS. The list of available databases, and how they should be configured, + is explained in the following sub-section. </listitem> <listitem> If JBossESB has been installed, then run: <command>ant deploy-esb-examples</command> to @@ -74,8 +99,60 @@ </itemizedlist> </para> </listitem> - </orderedlist> + + <para> + To de-install the RiftSaw distribution, + </para> + <orderedlist> + <listitem> + Uninstall the RiftSaw distribution + <para> + <itemizedlist> + <listitem> + From the install folder, run: <command>ant undeploy -Ddatabase=....</command> to remove + RiftSaw from JBossAS. The database option should specify the same value used + during installation of RiftSaw. + </listitem> + <listitem> + If JBossESB has been installed, then run: <command>ant undeploy-esb-examples</command> to + remove the BPEL/ESB examples from the JBossESB samples/quickstart folder. + </listitem> + </itemizedlist> + </para> + </listitem> + </orderedlist> + + <section> + <title>Available databases and how to configure them</title> + + <para> + The following "in-memory" databases are available. If just evaluating the capabilities + of RiftSaw, it is recommended that one of these options is used to reduce the + time taken to get RiftSaw up and running. + </para> + + <orderedlist> + <listitem>derby</listitem> + <listitem>hsql</listitem> + </orderedlist> + + <para> + Other databases available, that require further configuration details, include: + </para> + + <orderedlist> + <listitem>mysql</listitem> + <listitem>postgres</listitem> + </orderedlist> + + <para> + The configuration properties for these database options can be found in the + <filename>${RiftSaw}/db/jdbc</filename> folder. These properties need to be + specified before executing the <command>ant deploy -Ddatabase=...</command> + command. + </para> + </section> </section> </chapter>