[overlord-commits] Overlord SVN: r434 - in cdl/trunk/docs/docbook: gettingstartedguide/src/main/images and 2 other directories.

Author: objectiser Date: 2008-11-11 10:25:46 -0500 (Tue, 11 Nov 2008) New Revision: 434 Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg Removed: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml Log: Added more screenshots, also changed to import all projects in one step, as part of the installation procedure. Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg =================================================================== (Binary files differ) Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportDialog.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg =================================================================== (Binary files differ) Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportFileDialog.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg =================================================================== (Binary files differ) Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportMenu.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg =================================================================== (Binary files differ) Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportProjectsDialog.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg =================================================================== (Binary files differ) Property changes on: cdl/trunk/docs/docbook/gettingstartedguide/src/main/images/ImportedProjects.jpg ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/master.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -13,7 +13,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/soagwithcdl.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-validation-with-cdl.xml"/> - <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/conversation-aware-esb.xml"/> <xi:include xmlns:xi="http://www.w3.org/2001/XInclude" href="module/appendix.xml"/> </book> Deleted: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-aware-esb.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -1,8 +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="conversationawareesb"> - <title>Conversation Aware ESB</title> - -</chapter> - Deleted: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/conversation-validation-with-cdl.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -1,7 +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="conversationvalidationwithcdl"> - <title>Conversation Validation with CDL</title> - -</chapter> Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/installation.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -121,5 +121,57 @@ </orderedlist> </section> + + <section> + <title>Importing Samples into Eclipse</title> + + <para> + Once the Overlord CDL distribution has been correctly installed, if you wish to try out any of the examples then + the following steps should be followed to import the relevant projects into the previously configured Eclipse + environment. + </para> + + <orderedlist> + <listitem> + <para> +Select the 'Import...' menu item, associated with the popup menu on the background of the left panal (Navigator or Package depending on perspective being viewed). + </para> + <imageobject> + <imagedata fileref="images/ImportMenu.jpg" align="center" width="2in" /> + </imageobject> + </listitem> + <listitem> + <para> +When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button. + </para> + <imageobject> + <imagedata fileref="images/ImportDialog.jpg" align="center" width="4in" /> + </imageobject> + </listitem> + <listitem> + <para> +Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <filename>${OverlordCDL}/samples</filename> folder, then press 'Ok'. + </para> + <imageobject> + <imagedata fileref="images/ImportFileDialog.jpg" align="center" width="3in" /> + </imageobject> + </listitem> + <listitem> + <para> +All of the Eclipse projects contained within the <filename>samples</filename> directory structure will be listed. Press the 'Finish' button to import them all. + </para> + <imageobject> + <imagedata fileref="images/ImportProjectsDialog.jpg" align="center" width="4in" /> + </imageobject> + <para> + Once imported, the Eclipse navigator will list the sample projects: + </para> + <imageobject> + <imagedata fileref="images/ImportedProjects.jpg" align="center" width="2in" /> + </imageobject> + </listitem> + </orderedlist> + + </section> </chapter> Modified: cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml =================================================================== --- cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/gettingstartedguide/src/main/module/soagwithcdl.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -3,5 +3,21 @@ ]> <chapter id="soagwithcdl"> <title>SOA Governance with CDL </title> - + +I wasn't expecting Chapter 2 until much later. I thought that after installation we'd take people through a worked example (glossing over the concepts, but showing people what can be accomplished), but Chapter 2 dives into terms and concepts. I suppose what I was expecting was something like "make sure your Eclipse workspace is set to blah" and blah is a pre-configured workspace that we've set up with a number of different out-of-the-box examples. Then we'd go quickly through them in Chapter 2 before going into more detail about what's going on in subsequent chapters. That way we almost convince people in Chapter 2 that it's worth their while continuing on with the rest of the document. I know that Steve used to do something like this when demo-ing the original CDL tooling, so hopefully it's not too much effort to try to put this in? + + +Explain about testable architecture, managing the lifecycle - possibly a cut down version of best practice guide, showing where the conformance checking, generation and monitoring fit in. + + + <section> + <title>Conversation Validation</title> + + </section> + + <section> + <title>Conversation Aware ESB</title> + + </section> + </chapter> Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml =================================================================== --- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlconformance.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -5,10 +5,10 @@ <title>CDL Conformance</title> <para> -There are two examples to demonstrate the conversation aware ESB actions, and the conformance checking against a choreography. These are <filename>purchasing</filename>, a simple customer/supplier example, and <filename>brokerage</filename> which extends the purchasing example through the introduction of a broker that mediates between potentially multiple suppliers to find the best deal. +There are two examples to demonstrate the conversation aware ESB actions, and the conformance checking against a choreography. These are <filename>purchasing</filename>, a simple customer/supplier example with two associated Eclipse projects (<filename>purchasing-store</filename> and <filename>purchasing-models</filename>), and <filename>brokerage</filename> which extends the purchasing example through the introduction of a broker that mediates between potentially multiple suppliers to find the best deal, defined within three Eclipse projects (<filename>brokerage-broker</filename>, <filename>brokerage-supplier</filename> and <filename>brokerage-models</filename>). </para> <para> -The other relevant folders for these examples are, <filename>common</filename> which contains the service implementation of the 'Credit Agency' which is used by both examples, and <filename>client</filename> which contains client applications to test both examples. +These examples make use of a common <emphasis>Credit Agency</emphasis> service, defined within the <filename>common-creditAgency</filename> Eclipse project, and are executed through the use of client applications defined in the <filename>${OverlordCDL}/samples/client</filename> folder. </para> <section> @@ -33,28 +33,7 @@ </itemizedlist> <para> -To check conformance, we need to import the model and service implementation projects into the Eclipse environment. This is achieved by: - </para> - <orderedlist> - <listitem> -Select the <emphasis role="bold">'Import...'</emphasis> menu item, associated with the context menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis role="bold">General->ExistingProject</emphasis> from Workspace option and press the <emphasis role="bold">'Next'</emphasis> button. - </listitem> - <listitem> -Ensuring that the 'Select root directory' radio button is selected, press the <emphasis role="bold">'Browse'</emphasis> button and navigate to the <filename>samples/purchasing/models</filename> folder, press 'Ok' and then press 'Finish'. - </listitem> - <listitem> -Then repeat steps (1) and (2) for the following project folders: - <itemizedlist> - <listitem> - <filename>samples/purchasing/store</filename> - </listitem> - <listitem> - <filename>samples/common/creditAgency</filename> - </listitem> - </itemizedlist> - </listitem> - </orderedlist> - <para> +To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment. The <filename>purchasing-models</filename> project contains the CDL used to perform conformance checking on the <filename>src/main/resources/META-INF/jboss-esb.xml</filename> files within the other projects. A full explanation of the conversation aware ESB actions can be found in the <emphasis>Conversational Aware ESB</emphasis> section of the <emphasis>User Guide</emphasis> in the <filename>docs</filename> folder. </para> <para> @@ -155,31 +134,7 @@ </itemizedlist> <para> -To check conformance, we need to import the model and service implementation projects into the Eclipse environment. This is achieved by: - </para> - <orderedlist> - <listitem> -Select the 'Import...' menu item, associated with the context menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button. - </listitem> - <listitem> -Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <emphasis>samples/brokerage/models</emphasis> folder, press 'Ok' and then press 'Finish'. - </listitem> - <listitem> -Then repeat steps (1) and (2) for the following project folders: - <itemizedlist> - <listitem> - <filename>samples/brokerage/broker</filename> - </listitem> - <listitem> - <filename>samples/brokerage/supplier</filename> - </listitem> - <listitem> - <filename>samples/common/creditAgency</filename> (if not already imported for the previous example) - </listitem> - </itemizedlist> - </listitem> - </orderedlist> - <para> +To check conformance, we need to refer to the model and service implementation projects in the Eclipse environment. The <filename>brokerage-models</filename> project contains the CDL used to perform conformance checking on the <filename>src/main/resources/META-INF/jboss-esb.xml</filename> files within the other brokerage projects. A full explanation of the conversation aware ESB actions can be found in the <emphasis>Conversational Aware ESB</emphasis> section of the <emphasis>User Guide</emphasis> in the <filename>docs</filename> folder. </para> <para> Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml =================================================================== --- cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/samplesguide/src/main/module/cdlvalidator.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -11,24 +11,22 @@ This example can be found in the <filename>trailblazer</filename> folder, which contains an enhanced version of the trailblazer example found in the JBossESB distribution. See the TrailBlazer Guide in the JBossESB distribution (<filename>$JBossESB/docs/samples/TBGuide.pdf</filename>) for more information about the example. The main changes are the introduction of a File Based Bank, and modifications to the message structures to enable a consistent conversation id to be carried with the messages. </para> - <orderedlist> - <listitem> -Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment. - </listitem> - <listitem> -Select the 'Import...' menu item, associated with the popup menu on the background of the left panal (Navigator or Package depending on perspective being viewed). When the import dialog appears, select the <emphasis>General->ExistingProject from Workspace</emphasis> option and press the 'Next' button. - </listitem> - <listitem> -Ensuring that the 'Select root directory' radio button is selected, press the 'Browse' button and navigate to the <filename>samples/trailblazer/models</filename> folder, press 'Ok' and then press 'Finish'. - <note> <para> -Once the models project has been installed, you can open the choreography for the trailblazer (trailblazer.cdm) and also a scenario representing a valid transaction associated with the choreography (LoanRequest.scn). In the choreography description editor, view the "Choreography Flows" tab to see the structure of the process. +The choreography description for the Trailblazer example can be found in the <emphasis>trailblazer-models</emphasis> project in the Eclipse environment. If the project has not yet been imported, then please refer to the instructions in the <emphasis>Getting Started Guide</emphasis>. </para> <para> +You can open the choreography for the trailblazer (trailblazer.cdm) and also a scenario representing a valid transaction associated with the choreography (LoanRequest.scn). In the choreography description editor, view the "Choreography Flows" tab to see the structure of the process. + </para> + <para> To simulate the scenario against the choreography, to ensure that the choreography correctly caters for the valid business scenario, the user should press the green 'play' button in the toolbar, associated with the Scenario Editor. </para> </note> + + + <orderedlist> + <listitem> +Update the <filename>$JBossAS/server/default/deploy/jbossesb.sar/jbossesb-properties.xml</filename> file, in the section entitled "transports" and specify all of the SMTP mail server settings for your environment. </listitem> <listitem> Update the <filename>trailblazer/trailblazer.properties</filename> Modified: cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml =================================================================== --- cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/samplesguide/src/main/module/overview.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -23,7 +23,7 @@ <note> <para> - Before attempting to install and run these examples, you must follow the instructions in the <emphasis role="bold">"Getting Started" Chapter</emphasis> of the <emphasis role="bold">User Guide</emphasis> regarding installing Overlord CDL into a JBossAS environment. + Before attempting to install and run these examples, you must follow the instructions in the <emphasis role="bold">"Installation" Chapter</emphasis> of the <emphasis role="bold">Getting Started Guide</emphasis> regarding installing Overlord CDL into a JBossAS environment, and importing the samples into the Eclipse environment. </para> </note> Deleted: cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml =================================================================== --- cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml 2008-11-11 12:28:12 UTC (rev 433) +++ cdl/trunk/docs/docbook/samplesguide/src/main/module/template.xml 2008-11-11 15:25:46 UTC (rev 434) @@ -1,7 +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="chapter-id"> - <title>Chapter title</title> - <para>To be written...</para> -</chapter>