jbosstools-commits March 2010

jbosstools-commits@lists.jboss.org

1 participants
632 discussions

JBoss Tools SVN: r20538 - in trunk/drools/docs/guvnor_ref: en-US and 3 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-02-28 23:44:09 -0500 (Sun, 28 Feb 2010) New Revision: 20538 Added: trunk/drools/docs/guvnor_ref/en-US/ trunk/drools/docs/guvnor_ref/en-US/Author_Group.xml trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.ent trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.xml trunk/drools/docs/guvnor_ref/en-US/Preface.xml trunk/drools/docs/guvnor_ref/en-US/Revision_History.xml trunk/drools/docs/guvnor_ref/en-US/conclusion.xml trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml trunk/drools/docs/guvnor_ref/en-US/images/ trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/ trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/add_toGuvnor_wizard.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/association_details.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version2.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version3.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/confirm_delete.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/delete_connection_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/do_into_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_back_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_home_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_defaultPackage.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_button.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_wizard.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_repository.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnorinfo.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/open_guvnor_perspectine.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/repository_files_properties.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor2.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor3.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view2.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view3.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/select_target_folder.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection1.png trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection2.png trunk/drools/docs/guvnor_ref/en-US/images/guvnor_preferences/ trunk/drools/docs/guvnor_ref/en-US/images/guvnor_preferences/guvnor_preferences.png trunk/drools/docs/guvnor_ref/en-US/images/jbosstools_logo.png trunk/drools/docs/guvnor_ref/en-US/introduction.xml trunk/drools/docs/guvnor_ref/en-US/master.xml trunk/drools/docs/guvnor_ref/en-US/master_output.xml trunk/drools/docs/guvnor_ref/publican.cfg Removed: trunk/drools/docs/guvnor_ref/en/ Modified: trunk/drools/docs/guvnor_ref/pom.xml Log: modified for publican and maven building Added: trunk/drools/docs/guvnor_ref/en-US/Author_Group.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Author_Group.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Author_Group.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,5 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author><firstname>John</firstname><surname>Graham</surname><email>jgraham(a)redhat.com</email></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> </authorgroup> Added: trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Book_Info.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>Eclipse Guvnor Tools Reference Guide</title><subtitle>Provides information relating to the Eclipse Guvnor Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The Eclipse Guvnor Tools Reference Guide explains how to use the Eclipse Guvnor Tools to gain access to resources controled by the Guvnor repository policies.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.ent =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.ent (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.ent 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "Eclipse_Guvnor_Tools_Reference_Guide"> +<!ENTITY YEAR "2010"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Eclipse_Guvnor_Tools_Reference_Guide.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,12 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="functionality_overview.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="guvnor_preferences.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="conclusion.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: trunk/drools/docs/guvnor_ref/en-US/Preface.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Preface.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Preface.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></xi:fallback></xi:include></preface> Added: trunk/drools/docs/guvnor_ref/en-US/Revision_History.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/Revision_History.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/Revision_History.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/drools/docs/guvnor_ref/en-US/conclusion.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/conclusion.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/conclusion.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,22 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="conclusion" xreflabel="conclusion"> + <?dbhtml filename="conclusion.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Conclusion</title> + + <para>As stated at the beginning of this document, the key goal of the <property>EGT</property> + is to provide a way of interacting with Guvnor repository resources in a local Eclipse + workspace. While clearly there is a lot more that could be done, and no doubt there will be + aspects of the current tooling that require revision going forward, we feel that the current + state of the <property>EGT</property> is sufficient for the major use cases.</para> + + <para>If you have some questions, comments or suggestions on the topic, please feel free to ask in the + <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201" + >Jboss Tools Forum</ulink>.</para> +</chapter> Added: trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/functionality_overview.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,727 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="functionality_overview" xreflabel="functionality_overview"> + <?dbhtml filename="functionality_overview.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Functionality Overview</title> + + <para>This chapter will introduce you to the <property>Guvnor Repository Exploring + perspective</property> and give an overview on all functionality the <property>Guvnor Tools</property> provides.</para> + + <section id="guvnor_perspective"> + <title>Guvnor Perspective</title> + + <para>The <property>Guvnor Repository Exploring perspective</property> contains two views + supplied by <property>EGT</property> – <property>Repository Explorer</property> and + <property>Version History</property>, that will be the center of most interaction + with Guvnor, and Eclipse standard views such as <property>Properties</property> and + <property>Resource Navigator</property> that are also useful.</para> + + <para>While each of these views can be opened and positioned independently within an Eclipse + workbench, the <property>Guvnor perspective</property> provides a convenient method of + getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> + <property>Window > Open Perspective > Other</property> + </emphasis> to get the perspective list:</para> + + <figure> + <title>Enabling the Guvnor Repository Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>And then choose <emphasis> + <property>Guvnor Repository Exploring</property>.</emphasis> This opens the + <property>Guvnor perspective</property>.</para> + </section> + + <section id="connection_wizard"> + <title>Guvnor Connection Wizard</title> + + <para>After opening the <property>Guvnor perspective</property>, the first task is to make a + connection to a Guvnor repository. This is handled by the <property>Guvnor Connection + wizard</property>. This wizard appears in a number of places within the + <property>EGT</property> (as detailed below), but in this section we will cover only + the two most basic entry points.</para> + + <para>The <property>Guvnor Connection wizard</property> can be started in the following + ways:</para> + + <itemizedlist> + <listitem> + <para>using the Eclipse menu <emphasis> + <property>File > New > Other > Guvnor > Guvnor + repository location</property> + </emphasis></para> + + <figure> + <title>New Guvnor Repository Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>in the <property>Guvnor Repositories view</property> using the drop-down menu</para> + + <figure> + <title>Adding New Guvnor Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"/> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>using the menu button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"/> + </imageobject> + </inlinemediaobject> ) + </para> + </listitem> + </itemizedlist> + + <para>Choosing either of these will start the <property>Guvnor Connection + wizard</property>.</para> + + <figure id="guvnor_connection_wizard"> + <title>Guvnor Connection Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Default values appear in the <emphasis> + <property>Location</property>,</emphasis> + <emphasis> + <property>Port</property>,</emphasis> and <emphasis> + <property>Repository</property> + </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> section below for details about how to + change these default values.) Of course, any of these fields can be edited by typing in + the corresponding text box. Drag-and-drop or paste into the <emphasis> + <property>Location</property> + </emphasis> field of a typical Guvnor repository URL such as:</para> + + <para> + <emphasis> + <property>http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> + </emphasis> + </para> + + <para>Results in the URL being parsed into the respective fields as well. The authentication + information (user name and password) can optionally be stored in the Eclipse + workbench's key-ring file based on the selection of <emphasis> + <property>Save user name and password</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the authentication information is not stored in the key-ring, then the + <property>EGT</property> uses a session authentication, what means that the + credentials supplied are used only for the lifetime of the Eclipse workbench + instance.</para> + </note> + + <para>If authentication information is not stored in the key-ring or the authentication + information (key-ring or session) is not valid, the <property>EGT</property> will prompt + for authentication information when it has to access the Guvnor repository.</para> + + <para>If authentication fails, the <property>EGT</property> will retry once and then issue + an authentication failure error.</para> + + <tip> + <title>Tip:</title> + <para>If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</para> + </tip> + + <para>Note that the <property>EGT</property> calls the Guvnor repository at various times, + such as when determining if resource updates are available. Thus if you use session + authentication, the authentication dialog will appear at different times during the + Eclipse workbench session, depending on what actions you take. For ease of use, we + recommend saving the authentication information in the Eclipse key-ring.</para> + + <note> + <title>Note:</title> + <para>The Eclipse key-ring file is distinct from key-ring files found in some platforms + such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor + repository outside the <property>EGT</property>, the key-ring files might become + unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. + This is nuisance, but your usual credentials should apply in this case.</para> + </note> + </section> + + <section id="guvnor_repositories_view"> + <title>Guvnor Repositories View</title> + + <para>The <property>Guvnor Repositories view</property> contains tree structures for Guvnor + repository contents.</para> + + <figure> + <title>Guvnor Repositories View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_repository.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>You can perform the following actions under the resources in the + <property>Guvnor Repositories view</property>:</para> + + <itemizedlist> + <listitem> + <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> + </listitem> + + <listitem> + <para>remove a Guvnor repository connection. Use the Delete button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/delete_connection_button.png"/> + </imageobject> + </inlinemediaobject> ) in the tool-bar or the <emphasis> + <property>Delete</property></emphasis> option in the context menu to remove a repository connection.</para> + </listitem> + + <listitem> + <para>refresh Guvnor repository resorces. Use the <emphasis> + <property>Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> + </listitem> + + <listitem> + <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property>Go Home</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ), <emphasis><property>Go Back</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_back_button.png"/> + </imageobject> + </inlinemediaobject> ) and <emphasis> + <property>Go Into</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_button.png"/> + </imageobject> + </inlinemediaobject> ).</para> + </listitem> + </itemizedlist> + + <para>Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <emphasis> + <property>"defaultPackage"</property></emphasis> node changes the tree view to:</para> + + <figure> + <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on the Go Home button ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"/> + </imageobject> + </inlinemediaobject> ) or selecting <emphasis> + <property>Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </para> + + <para>There are a number of operations that can be performed on Guvnor repository files. Selecting a file in +the Guvnor repository causes the Eclipse <property>Properties view</property> to update with details about that file: +</para> + + <figure> + <title>Guvnor Repository Files Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/repository_files_properties.png"/> + </imageobject> + </mediaobject> + </figure> + + <para></para> + </section> + + <section id="local_copies"> + <title>Local Copies of Guvnor Files</title> + + <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose + of the <property>EGT</property> is to allow development using resources held in a Guvnor + repository. There are two method of getting local copies of Guvnor repository + resources:</para> + + <orderedlist> + <listitem> + <para>Drag-and-drop from the <property>Guvnor Repositories view</property></para> + </listitem> + <listitem> + <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor + wizard</link>, as described further in this document</para> + </listitem> + </orderedlist> + + <para>When local copies of Guvnor repository files are created, the <property>EGT</property> + sets an association between the local copy and the master file in the repository. This + information is kept in the (normally) hidden <emphasis> + <property>.guvnorinfo</property> + </emphasis> folder in the local project and, like all metadata, should not be changed by + end users.</para> + + <figure> + <title>.guvnorinfo metadata</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnorinfo.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The association allows for operations such as update and commit in + synchronization with the master copy held in the Guvnor repository.</para> + + <para>The <property>EGT</property> decorates local resources associated with Guvnor + repository master copies. This decoration appears in Eclipse views conforming to the + Eclipse Common Navigator framework, such as the Eclipse <property>Resource + Navigator</property> and the Java <property>Package Explorer</property>. On the image + above you can see the <emphasis> + <property>Dummy rule.drl</property></emphasis> file with the decoration in the <property>Resource Navigator</property>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor + revision details are appended to the file name. (The presence/location of these can be + changed the <link linkend="resource_decoration_preferences">Guvnor + Preferences</link>.)</para> + + <para>Here we see that, <emphasis><property>Dummy role.drl</property></emphasis> is associated with a Guvnor repository + resource and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time + stamp. The file <emphasis><property>Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository + file. Further details about the association can be found in the standard Eclipse + properties page, accessed via the <emphasis><property>Properties</property></emphasis> option in the context menu:</para> + + <figure> + <title>Association Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/association_details.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>EGT</property> contributes a property page to the standard Eclipse + properties dialog, the contents of which are shown above. It displays the specific Guvnor + repository, the location within the repository, the version (date/time stamp) and + the revision number.</para> + </section> + + <section id="actions"> + <title>Actions for Local Guvnor Resources</title> + + <para>The <property>EGT</property> provides a number of actions (available through the + <emphasis><property>Guvnor</property></emphasis> context menu on files) for working with files, both those associated with + Guvnor repository master copies and those not associated. The actions are:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="update_action">Update</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="add_action">Add</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="commit_action">Commit</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="show_history_action">Show History</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="compare_with_version">Compare with Version</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="switch_to_version">Switch to Version</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="delete_action">Delete</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="disconnect_action">Disconnect</link> + </para> + </listitem> + </itemizedlist> + + <para>Each of these actions is described below.</para> + + <section id="update_action"> + <title>Update Action</title> + + <para>The <emphasis> + <property>Update</property> + </emphasis> action is available for one or more Guvnor resources that are not in + synchronization with the Guvnor repository master copies. These resources would not + be in synchronization because either/both</para> + + <orderedlist> + <listitem><para>There are local changes to these + resources</para></listitem> + <listitem><para>The master copies have been changed in the Guvnor repository</para></listitem> + </orderedlist> + + <para>Performing the <emphasis> + <property>Update</property> + </emphasis> action replaces the local file contents with the current contents from + the Guvnor repository master copies (equivalent to <emphasis> + <link linkend="switch_to_version">Switch to version</link> + </emphasis> for the latest version).</para> + </section> + + <section id="add_action"> + <title>Add Action</title> + + <para>The <emphasis> + <property>Add</property> + </emphasis> action is available for one or more local files that are not associated + with a Guvnor repository master copy. Choosing the <emphasis> + <property>Add</property> + </emphasis> action launches the <property>Add to Guvnor wizard</property>:</para> + + <figure> + <title>Add to Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The first page of the wizard asks for the selection of the target Guvnor + repository and gives the choice to create a new Guvnor repository connection (in + which case the second page is the same as the <link linkend="guvnor_connection_wizard" + >Guvnor Connection wizard</link>). Once the target Guvnor repository is chosen, + the wizard then asks for the folder location to add the selection files:</para> + + <figure> + <title>Selecting a Target Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/select_target_folder.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here the <emphasis> + <property>"defaultPackage"</property></emphasis> folder is selected as the destination + location.</para> + + <note> + <title>Note:</title> + <para>Note that the <emphasis> + <property>"snapshot"</property></emphasis> folder in the Guvnor repository is read-only for + <property>EGT</property>, and hence not visible as a candidate location in + this wizard. The Guvnor repository web administration tools must be used to add + snapshot content.</para> + </note> + + <para>Clicking on <emphasis> + <property>Finish</property> + </emphasis> adds the selected files to the Guvnor repository and creates an + association between the local and Guvnor repository files.</para> + + <note> + <title>Note:</title> + <para>Note that the wizard will not allow for overwrite of existing Guvnor + repository files. Another target location must be chosen.</para> + </note> + </section> + + <section id="commit_action"> + <title>Commit Action</title> + + <para>The <emphasis> + <property>Commit</property> + </emphasis> action is enabled for one or more Guvnor repository associated files + that have local changes. The <emphasis> + <property>Commit</property> + </emphasis> action will write the local changes back to the associated Guvnor + repository files and update the association for the new revision created.</para> + + <para>If a local change is based on an older revision of a file that is currently in the + Guvnor repository (for example, someone else changed the same file), then the <emphasis> + <property>Commit</property> + </emphasis> action will<figure> + <title>Add to Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> + </imageobject> + </mediaobject> + </figure> ask whether you wish to overwrite the current version in the + Guvnor repository with the local content. When such conflicts occur, however, you + should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to + determine the differences and merge content based on the current version in the + Guvnor repository.</para> + </section> + + <section id="show_history_action"> + <title>Show History Action</title> + + <para>The <emphasis> + <property>Show History</property> + </emphasis> action is enable for one Guvnor repository associated file and causes + the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be + populated with revision history for the selected file.</para> + </section> + + <section id="compare_with_version"> + <title>Compare with Version Action</title> + + <para>The <emphasis> + <property>Compare with Version</property> + </emphasis> action is enabled for one Guvnor repository associated file. This action + first opens a wizard asking for the version for comparison (with the local file + contents):</para> + + <figure> + <title>Compare with Version Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the revision is selected, the action opens the Eclipse <property>Compare + editor</property> (read-only):</para> + <figure> + <title>Eclipse Compare Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>This editor uses Eclipse-standard comparison techniques to show the differences in + the two versions. In cases where there are no differences, the editor will not open, + rather a dialog saying that there are no differences will appear.</para> + <figure> + <title>Alert Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version3.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="switch_to_version"> + <title>Switch to Version Action</title> + + <para>The <emphasis> + <property>Switch to Version</property> + </emphasis> action is enabled for one Guvnor repository associated file.</para> + <para>First the <emphasis> + <property>Switch to Version</property> + </emphasis> action prompts for selection of version:</para> + + <figure> + <title>Select Version Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the version is selected, the <emphasis> + <property>Switch to Version</property> + </emphasis> action replaces the local file contents with those from the revision + selected.</para> + </section> + + <section id="delete_action"> + <title>Delete Action</title> + + <para>The <emphasis> + <property>Delete</property> + </emphasis> action is enabled for one or more Guvnor repository associated files. + After confirmation via a dialog, the <emphasis> + <property>Delete</property> + </emphasis> action removes the files in the Guvnor repository and deletes local + metadata for the Guvnor repository association.</para> + + <figure> + <title>Comfirm Delete Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/confirm_delete.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="disconnect_action"> + <title>Disconnect Action</title> + + <para>The <emphasis> + <property>Disconnect</property> + </emphasis> action is enabled for one or more Guvnor repository associated files, + and removes local metadata for the Guvnor repository association.</para> + </section> + </section> + + <section id="guvnor_history_view"> + <title>Guvnor Resource History View</title> + + <para>The <property>Guvnor Resource History view</property> should details about revision + history for selected files, both local and those in Guvnor repositories. The initial + state of this view is shown on the figure below.</para> + + <figure> + <title>Initial State of the Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>Guvnor Resource History view</property> is populated by <emphasis> + <property>Show History</property> + </emphasis> actions in either the local <emphasis> + <property>Guvnor</property></emphasis> context menu or in the context menu for + a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor + Repositories view</link>. Once this action is performed, the <property>Guvnor + Resource History view</property> updates to show the revision history:</para> + + <figure> + <title>IGuvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Here we see that the file <emphasis> + <property>test.txt</property> + </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> + <property>Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor + with the revision contents.</para> + + <figure> + <title>Eclipse Read-only Editor with the Revision Contents</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view3.png"/> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>You can also use the <emphasis> + <property>Save As...</property> + </emphasis> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</para> + </note> + + </section> + + <section id="resources_from_guvnor"> + <title>Importing Guvnor Repository Resources</title> + + <para>In addition to the single file drag-and-drop from the <property>Guvnor Repositories + view</property>, the <property>EGT</property> also includes a wizard for copying one + or more files from a Guvnor repository to the local workspace (and setting the + association with the Guvnor repository). This wizard is available from the <emphasis> + <property>File > Import > Guvnor > Resource from + Guvnor</property> + </emphasis> and the <emphasis> + <property>File > New > Other > Guvnor > Resource from + Guvnor</property> + </emphasis> menu items.</para> + <note> + <title>Note:</title> + + <para>Note that the wizard is identical but appears in both locations to accommodate + users who tend to view this functionality as being in either category.</para> + </note> + + <para>The first page of the wizard asks for the selection of the source Guvnor repository + and gives the choice to create a new Guvnor repository connection (in which case the + second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> + + <figure> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Finally, the target location in the local workspace should be chosen:</para> + <figure> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. + If a file with the same name already exists in the destination, the wizard uses the Eclipse standard + "prompt for rename" dialog:</para> + + <figure> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"/> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> Added: trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/guvnor_preferences.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,90 @@ +<?xml version='1.0' encoding='UTF-8'?> +<chapter id="guvnor_preferences" xreflabel="guvnor_preferences"> + <?dbhtml filename="guvnor_preferences.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Guvnor Preferences</title> + + <para>The <property>EGT</property> provides a preference page in the <emphasis> + <property>Guvnor</property> + </emphasis> category:</para> + + <figure> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para>Local Guvnor + repository resource decorations.</para></listitem> + </itemizedlist> + + <section id="repo_connection_preferences"> + <title>Guvnor Repository Connection Preferences</title> + <para>There are two preferences that can be set for Guvnor repository connections, that are + used when creating new connections:</para> + + <itemizedlist> + <listitem> + <para>The first is a default Guvnor repository URL template, which can make it + easier to create multiple similar connections by simply changing part of the + field, such as the host name.</para> + </listitem> + <listitem> + <para>The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</para> + </listitem> + </itemizedlist> + + <para>As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</para> + </section> + + <section id="resource_decoration_preferences"> + <title>Local Guvnor Repository Resource Decoration Preferences</title> + + <para>The second category of preferences provided by the <property>EGT</property> deals with how the decoration of + local resources associated with Guvnor repository resources is presented. Since the + Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to + decorate local resources, it is useful to be able to control just how the <property>EGT</property> decorate + its local resources to avoid messy conflicts with SCM packages.</para> + + <para>In the <emphasis> + <property>File Decoration</property></emphasis> + section of the preference page, you can choose the location (Top right, Top left, Bottom right, + Bottom left) of the decoration icon, or you can choose not to display it. In + the <emphasis> + <property>Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file + names:</para> + <itemizedlist> + <listitem> + <para>Whether to show an indicator (>) when the local file has changes not committed back to the + Guvnor repository</para> + </listitem> + <listitem> + <para>Whether to show the revision number</para> + </listitem> + <listitem> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property>Apply</property></emphasis> and then <emphasis> + <property>Ok</property></emphasis> buttons.</para> + </section> +</chapter> Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/add_toGuvnor_wizard.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/add_toGuvnor_wizard.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/association_details.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/association_details.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/compare_with_version3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/confirm_delete.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/confirm_delete.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/delete_connection_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/delete_connection_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/do_into_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/do_into_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_back_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_back_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_home_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_home_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_defaultPackage.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/go_into_defaultPackage.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_button.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_button.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_wizard.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_connection_wizard.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_repository.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnor_repository.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnorinfo.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/guvnorinfo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/open_guvnor_perspectine.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/open_guvnor_perspectine.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/repository_files_properties.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/repository_files_properties.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_from_guvnor3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view3.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/resource_history_view3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/select_target_folder.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/select_target_folder.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection1.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection2.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/functionality_overview/start_guvnor_connection2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/guvnor_preferences/guvnor_preferences.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/guvnor_preferences/guvnor_preferences.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/drools/docs/guvnor_ref/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/drools/docs/guvnor_ref/en-US/introduction.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/introduction.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/introduction.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,177 @@ +<?xml version="1.0" encoding="UTF-8"?> + +<chapter id="introduction" xreflabel="introduction"> + <title>Introduction</title> + + <para>The purpose of this document is to describe briefly the functionality present in the + <property>Eclipse Guvnor Tools</property> (EGT) for Drools 5. While not intended as a + comprehensive reference, there should be enough detail included for early adopters using + these tools.</para> + + <para>The <property>Guvnor repository</property> is not intended as a Source Code Management + (SCM) solution, and the <property>EGT</property> are not intended to be Eclipse “team + provider” extensions or replacements. Rather, the Guvnor repository is a location where + certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by + policies defined by the deployment environment. The purpose of the <property>EGT</property> + is then to enable access to resources held by the Guvnor repository, so + they can be used in development. Thus, limited capabilities for reading, writing, adding, + and removing Guvnor repository resources are provided in the + <property>EGT</property>.</para> + + <section id="drools_key_features"> + <title>Guvnor Tools Key Features</title> + + <para>The following table lists all valuable features of the <property>Guvnor + Tools</property>.</para> + <table> + <title>Key Functionality of Guvnor Tools</title> + <tgroup cols="3"> + + <colspec colnum="1" align="left" colwidth="1*"/> + <colspec colnum="2" colwidth="5*"/> + <colspec colnum="3" align="left" colwidth="1*"/> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Guvnor Repositories View</para> + </entry> + <entry> + <para>The purpose of the view is to enable access to Guvnor repository + resources in a standard tree format</para> + </entry> + <entry> + <link linkend="guvnor_repositories_view">Guvnor Repositories View</link> + </entry> + </row> + + <row> + <entry> + <para>Guvnor Connection Wizard</para> + </entry> + <entry> + <para>The wizard helps to create a connection to a Guvnor + repository.</para> + </entry> + <entry> + <link linkend="connection_wizard">Guvnor Connection Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>Guvnor Resource History View</para> + </entry> + <entry> + <para>This view shows revisions of specific resources available in the + repository.</para> + </entry> + <entry> + <link linkend="guvnor_history_view">Guvnor Resource History View</link> + </entry> + </row> + + <row> + <entry> + <para>Resources from Guvnor Wizard</para> + </entry> + <entry> + <para>The wizard helps to get local copies of Guvnor repository + resources.</para> + </entry> + <entry> + <link linkend="resources_from_guvnor">Importing Guvnor Repository + Resources</link> + </entry> + </row> + + <row> + <entry> + <para>A number of actions for working with files</para> + </entry> + <entry> + <para>The Guvnor actions (available through the <emphasis> + <property>Guvnor</property> + </emphasis> context menu on files) are provided for working with + files, both those associated with Guvnor repository master copies + and those not associated.</para> + </entry> + <entry> + <link linkend="actions">Actions for Local Guvnor Resources</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section id="how_to_start"> + <title>How to start with Guvnor Tools</title> + + <para><property>Guvnor Tools</property> is a part of the <property>JBoss Tools</property> + project. Thus to get started with <property>Guvnor Tools</property>, you should have the following:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to + install JBoss Tools onto Eclipse you can find in the JBoss Tools Installation section.</para> + </listitem> + + <listitem> + <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should + download <ulink + url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools-5.0.0.CR1..." + >Guvnor CR1</ulink> and extract it to the deploy directory of the + server.</para> + </listitem> + </itemizedlist> + + <para>Now refer to the <link linkend="functionality_overview">"Functionality + Overview"</link> section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</para> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + </listitem> + + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS + release documentation</ulink></para> + </listitem> + </itemizedlist> + + </section> +</chapter> Added: trunk/drools/docs/guvnor_ref/en-US/master.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/master.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/master.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,66 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "introduction.xml"> +<!ENTITY functionality_overview SYSTEM "functionality_overview.xml"> +<!ENTITY guvnor_preferences SYSTEM "guvnor_preferences.xml"> +<!ENTITY conclusion SYSTEM "conclusion.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]> + +<book> + + <bookinfo> + <title>Eclipse Guvnor Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>John</firstname><surname>Graham</surname><email>jgraham(a)redhat.com</email></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/guvnor_tools_ref_gui...">PDF version</ulink> + </para> + </abstract> + + </bookinfo> + + + <toc/> + &introduction; + &functionality_overview; + &guvnor_preferences; + &conclusion; + +</book> Added: trunk/drools/docs/guvnor_ref/en-US/master_output.xml =================================================================== --- trunk/drools/docs/guvnor_ref/en-US/master_output.xml (rev 0) +++ trunk/drools/docs/guvnor_ref/en-US/master_output.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,1077 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + +[<!ENTITY introduction SYSTEM "modules/introduction.xml"> +<!ENTITY functionality_overview SYSTEM "modules/functionality_overview.xml"> +<!ENTITY guvnor_preferences SYSTEM "modules/guvnor_preferences.xml"> +<!ENTITY conclusion SYSTEM "modules/conclusion.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + +]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + + <bookinfo> + <title>Eclipse Guvnor Tools Reference Guide</title> + + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + <author><firstname>John</firstname><surname>Graham</surname><email>jgraham(a)redhat.com</email></author> + <author><firstname>Olga</firstname><surname>Chikvina</surname></author> + + <copyright> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> + Version: 5.1.0.trunk + </releaseinfo> +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/guvnor_tools_ref_gui...">PDF version</ulink> + </para> + </abstract> + + </bookinfo> + + + <toc></toc> + + +<chapter id="introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/introduction.xml" xreflabel="introduction"> + <title>Introduction</title> + + <para>The purpose of this document is to describe briefly the functionality present in the + <property moreinfo="none">Eclipse Guvnor Tools</property> (EGT) for Drools 5. While not intended as a + comprehensive reference, there should be enough detail included for early adopters using + these tools.</para> + + <para>The <property moreinfo="none">Guvnor repository</property> is not intended as a Source Code Management + (SCM) solution, and the <property moreinfo="none">EGT</property> are not intended to be Eclipse “team + provider” extensions or replacements. Rather, the Guvnor repository is a location where + certain artifacts (such as rules and SOA policy definitions) are controlled (“governed”) by + policies defined by the deployment environment. The purpose of the <property moreinfo="none">EGT</property> + is then to enable access to resources held by the Guvnor repository, so + they can be used in development. Thus, limited capabilities for reading, writing, adding, + and removing Guvnor repository resources are provided in the + <property moreinfo="none">EGT</property>.</para> + + <section id="drools_key_features"> + <title>Guvnor Tools Key Features</title> + + <para>The following table lists all valuable features of the <property moreinfo="none">Guvnor + Tools</property>.</para> + <table> + <title>Key Functionality of Guvnor Tools</title> + <tgroup cols="3"> + + <colspec align="left" colnum="1" colwidth="1*"></colspec> + <colspec colnum="2" colwidth="5*"></colspec> + <colspec align="left" colnum="3" colwidth="1*"></colspec> + + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + <entry>Chapter</entry> + </row> + </thead> + + <tbody> + + <row> + <entry> + <para>Guvnor Repositories View</para> + </entry> + <entry> + <para>The purpose of the view is to enable access to Guvnor repository + resources in a standard tree format</para> + </entry> + <entry> + <link linkend="guvnor_repositories_view">Guvnor Repositories View</link> + </entry> + </row> + + <row> + <entry> + <para>Guvnor Connection Wizard</para> + </entry> + <entry> + <para>The wizard helps to create a connection to a Guvnor + repository.</para> + </entry> + <entry> + <link linkend="connection_wizard">Guvnor Connection Wizard</link> + </entry> + </row> + + <row> + <entry> + <para>Guvnor Resource History View</para> + </entry> + <entry> + <para>This view shows revisions of specific resources available in the + repository.</para> + </entry> + <entry> + <link linkend="guvnor_history_view">Guvnor Resource History View</link> + </entry> + </row> + + <row> + <entry> + <para>Resources from Guvnor Wizard</para> + </entry> + <entry> + <para>The wizard helps to get local copies of Guvnor repository + resources.</para> + </entry> + <entry> + <link linkend="resources_from_guvnor">Importing Guvnor Repository + Resources</link> + </entry> + </row> + + <row> + <entry> + <para>A number of actions for working with files</para> + </entry> + <entry> + <para>The Guvnor actions (available through the <emphasis> + <property moreinfo="none">Guvnor</property> + </emphasis> context menu on files) are provided for working with + files, both those associated with Guvnor repository master copies + and those not associated.</para> + </entry> + <entry> + <link linkend="actions">Actions for Local Guvnor Resources</link> + </entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section id="how_to_start"> + <title>How to start with Guvnor Tools</title> + + <para><property moreinfo="none">Guvnor Tools</property> is a part of the <property moreinfo="none">JBoss Tools</property> + project. Thus to get started with <property moreinfo="none">Guvnor Tools</property>, you should have the following:</para> + + <itemizedlist> + <listitem> + <para>Eclipse 3.4.x with Jboss Tools bundle of Eclipse plugins installed. How to + install JBoss Tools onto Eclipse you can find in the <ulink url="../../GettingStartedGuide/html_single/index.html#JBossToolsInstall">"JBoss Tools + Installation"</ulink> section.</para> + </listitem> + + <listitem> + <para>JBoss Server 4.2 or higher with Guvnor repository deployed. Thus, you should + download <ulink url="http://download.jboss.org/drools/release/5.0.0.25561.CR1/drools-5.0.0.CR1...">Guvnor CR1</ulink> and extract it to the deploy directory of the + server.</para> + </listitem> + </itemizedlist> + + <para>Now refer to the <link linkend="functionality_overview">"Functionality + Overview"</link> section to find out what you can do with Guvnor and + Eclipse synchronisation tool.</para> + </section> + + <section> + <title>Other relevant resources on the topic</title> + + <itemizedlist> + <listitem> + <para>Guvnor <ulink url="http://www.jboss.org/community/wiki/Guvnor">wiki page</ulink></para> + </listitem> + + <listitem> + <para>Drools on <ulink url="http://www.jboss.org/drools/">JBoss.org</ulink></para> + </listitem> + + <listitem> + <para> + <ulink url="http://www.jboss.org/tools/">JBoss Tools Home Page</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">The latest + JBossTools/JBDS documentation builds</ulink> + </para> + </listitem> + + <listitem> + <para> + <ulink url="http://docs.jboss.org/tools/">JBossTools/JBDS + release documentation</ulink></para> + </listitem> + </itemizedlist> + + </section> +</chapter> + + +<chapter id="functionality_overview" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/functionality_overview.xml" xreflabel="functionality_overview"> + <?dbhtml filename="functionality_overview.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Functionality Overview</title> + + <para>This chapter will introduce you to the <property moreinfo="none">Guvnor Repository Exploring + perspective</property> and give an overview on all functionality the <property moreinfo="none">Guvnor Tools</property> provides.</para> + + <section id="guvnor_perspective"> + <title>Guvnor Perspective</title> + + <para>The <property moreinfo="none">Guvnor Repository Exploring perspective</property> contains two views + supplied by <property moreinfo="none">EGT</property> – <property moreinfo="none">Repository Explorer</property> and + <property moreinfo="none">Version History</property>, that will be the center of most interaction + with Guvnor, and Eclipse standard views such as <property moreinfo="none">Properties</property> and + <property moreinfo="none">Resource Navigator</property> that are also useful.</para> + + <para>While each of these views can be opened and positioned independently within an Eclipse + workbench, the <property moreinfo="none">Guvnor perspective</property> provides a convenient method of + getting a suggested layout. In the Eclipse workbench menu, choose <emphasis> + <property moreinfo="none">Window > Open Perspective > Other</property> + </emphasis> to get the perspective list:</para> + + <figure float="0"> + <title>Enabling the Guvnor Repository Perspective</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/open_guvnor_perspectine.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>And then choose <emphasis> + <property moreinfo="none">Guvnor Repository Exploring</property>.</emphasis> This opens the + <property moreinfo="none">Guvnor perspective</property>.</para> + </section> + + <section id="connection_wizard"> + <title>Guvnor Connection Wizard</title> + + <para>After opening the <property moreinfo="none">Guvnor perspective</property>, the first task is to make a + connection to a Guvnor repository. This is handled by the <property moreinfo="none">Guvnor Connection + wizard</property>. This wizard appears in a number of places within the + <property moreinfo="none">EGT</property> (as detailed below), but in this section we will cover only + the two most basic entry points.</para> + + <para>The <property moreinfo="none">Guvnor Connection wizard</property> can be started in the following + ways:</para> + + <itemizedlist> + <listitem> + <para>using the Eclipse menu <emphasis> + <property moreinfo="none">File > New > Other > Guvnor > Guvnor + repository location</property> + </emphasis></para> + + <figure float="0"> + <title>New Guvnor Repository Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>in the <property moreinfo="none">Guvnor Repositories view</property> using the drop-down menu</para> + + <figure float="0"> + <title>Adding New Guvnor Connection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/start_guvnor_connection2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </listitem> + + <listitem> + <para>using the menu button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ) + </para> + </listitem> + </itemizedlist> + + <para>Choosing either of these will start the <property moreinfo="none">Guvnor Connection + wizard</property>.</para> + + <figure float="0" id="guvnor_connection_wizard"> + <title>Guvnor Connection Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_connection_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Default values appear in the <emphasis> + <property moreinfo="none">Location</property>,</emphasis> + <emphasis> + <property moreinfo="none">Port</property>,</emphasis> and <emphasis> + <property moreinfo="none">Repository</property> + </emphasis> fields (See the <link linkend="guvnor_preferences">“Guvnor Preferences”</link> section below for details about how to + change these default values.) Of course, any of these fields can be edited by typing in + the corresponding text box. Drag-and-drop or paste into the <emphasis> + <property moreinfo="none">Location</property> + </emphasis> field of a typical Guvnor repository URL such as:</para> + + <para> + <emphasis> + <property moreinfo="none">http://localhost:8080/drools-guvnor/org.drools.guvnor.Guvnor/webdav</property> + </emphasis> + </para> + + <para>Results in the URL being parsed into the respective fields as well. The authentication + information (user name and password) can optionally be stored in the Eclipse + workbench's key-ring file based on the selection of <emphasis> + <property moreinfo="none">Save user name and password</property>.</emphasis></para> + + <note> + <title>Note:</title> + <para>If the authentication information is not stored in the key-ring, then the + <property moreinfo="none">EGT</property> uses a session authentication, what means that the + credentials supplied are used only for the lifetime of the Eclipse workbench + instance.</para> + </note> + + <para>If authentication information is not stored in the key-ring or the authentication + information (key-ring or session) is not valid, the <property moreinfo="none">EGT</property> will prompt + for authentication information when it has to access the Guvnor repository.</para> + + <para>If authentication fails, the <property moreinfo="none">EGT</property> will retry once and then issue + an authentication failure error.</para> + + <tip> + <title>Tip:</title> + <para>If an authentication failure error occurs, you can retry the same operation and + supply different authentication information.</para> + </tip> + + <para>Note that the <property moreinfo="none">EGT</property> calls the Guvnor repository at various times, + such as when determining if resource updates are available. Thus if you use session + authentication, the authentication dialog will appear at different times during the + Eclipse workbench session, depending on what actions you take. For ease of use, we + recommend saving the authentication information in the Eclipse key-ring.</para> + + <note> + <title>Note:</title> + <para>The Eclipse key-ring file is distinct from key-ring files found in some platforms + such as Mac OS X and many forms of Linux. Thus, sometimes if you access a Guvnor + repository outside the <property moreinfo="none">EGT</property>, the key-ring files might become + unsynchronized and you will be unexpectedly prompted for authentication in Eclipse. + This is nuisance, but your usual credentials should apply in this case.</para> + </note> + </section> + + <section id="guvnor_repositories_view"> + <title>Guvnor Repositories View</title> + + <para>The <property moreinfo="none">Guvnor Repositories view</property> contains tree structures for Guvnor + repository contents.</para> + + <figure float="0"> + <title>Guvnor Repositories View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnor_repository.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>You can perform the following actions under the resources in the + <property moreinfo="none">Guvnor Repositories view</property>:</para> + + <itemizedlist> + <listitem> + <para>create a new Guvnor repository connection. How to do this is describe above in the <link linkend="connection_wizard">"Guvnor Connection Wizard"</link> section.</para> + </listitem> + + <listitem> + <para>remove a Guvnor repository connection. Use the Delete button + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/delete_connection_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ) in the tool-bar or the <emphasis> + <property moreinfo="none">Delete</property></emphasis> option in the context menu to remove a repository connection.</para> + </listitem> + + <listitem> + <para>refresh Guvnor repository resorces. Use the <emphasis> + <property moreinfo="none">Refresh</property></emphasis> context menu item to reload a tree content for the selected node.</para> + </listitem> + + <listitem> + <para>make use of "drill-into" functionality. It's represented by a number of tool-bar/context menu items such as <emphasis><property moreinfo="none">Go Home</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ), <emphasis><property moreinfo="none">Go Back</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_back_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ) and <emphasis> + <property moreinfo="none">Go Into</property></emphasis> + ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ).</para> + </listitem> + </itemizedlist> + + <para>Drill-down is useful when working with deeply nested tree structures and when you wish to concentrate on only branch of the tree. For example, drilling into the <emphasis> + <property moreinfo="none">"defaultPackage"</property></emphasis> node changes the tree view to:</para> + + <figure float="0"> + <title>Going Into the <emphasis>"defaultPackage"</emphasis></title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_into_defaultPackage.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Clicking on the Go Home button ( <inlinemediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/go_home_button.png"></imagedata> + </imageobject> + </inlinemediaobject> ) or selecting <emphasis> + <property moreinfo="none">Go Home</property></emphasis> in the context menu returns the tree to the top-level structure shown in the previous picture above. + </para> + + <para>There are a number of operations that can be performed on Guvnor repository files. Selecting a file in +the Guvnor repository causes the Eclipse <property moreinfo="none">Properties view</property> to update with details about that file: +</para> + + <figure float="0"> + <title>Guvnor Repository Files Properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/repository_files_properties.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para></para> + </section> + + <section id="local_copies"> + <title>Local Copies of Guvnor Files</title> + + <para>As mentioned in the <link linkend="introduction">"Introduction"</link>, the main purpose + of the <property moreinfo="none">EGT</property> is to allow development using resources held in a Guvnor + repository. There are two method of getting local copies of Guvnor repository + resources:</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem> + <para>Drag-and-drop from the <property moreinfo="none">Guvnor Repositories view</property></para> + </listitem> + <listitem> + <para>Using the <link linkend="resources_from_guvnor">Import from Guvnor + wizard</link>, as described further in this document</para> + </listitem> + </orderedlist> + + <para>When local copies of Guvnor repository files are created, the <property moreinfo="none">EGT</property> + sets an association between the local copy and the master file in the repository. This + information is kept in the (normally) hidden <emphasis> + <property moreinfo="none">.guvnorinfo</property> + </emphasis> folder in the local project and, like all metadata, should not be changed by + end users.</para> + + <figure float="0"> + <title>.guvnorinfo metadata</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/guvnorinfo.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The association allows for operations such as update and commit in + synchronization with the master copy held in the Guvnor repository.</para> + + <para>The <property moreinfo="none">EGT</property> decorates local resources associated with Guvnor + repository master copies. This decoration appears in Eclipse views conforming to the + Eclipse Common Navigator framework, such as the Eclipse <property moreinfo="none">Resource + Navigator</property> and the Java <property moreinfo="none">Package Explorer</property>. On the image + above you can see the <emphasis> + <property moreinfo="none">Dummy rule.drl</property></emphasis> file with the decoration in the <property moreinfo="none">Resource Navigator</property>. The Guvnor icon decorator is on the top right of the file image, and the Guvnor + revision details are appended to the file name. (The presence/location of these can be + changed the <link linkend="resource_decoration_preferences">Guvnor + Preferences</link>.)</para> + + <para>Here we see that, <emphasis><property moreinfo="none">Dummy role.drl</property></emphasis> is associated with a Guvnor repository + resource and the local copy is based on revision 0, with a <code>02-10-2008, 4:21:53</code> date/time + stamp. The file <emphasis><property moreinfo="none">Sample.drl</property>,</emphasis> however, is not associated with a Guvnor repository + file. Further details about the association can be found in the standard Eclipse + properties page, accessed via the <emphasis><property moreinfo="none">Properties</property></emphasis> option in the context menu:</para> + + <figure float="0"> + <title>Association Details</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/association_details.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">EGT</property> contributes a property page to the standard Eclipse + properties dialog, the contents of which are shown above. It displays the specific Guvnor + repository, the location within the repository, the version (date/time stamp) and + the revision number.</para> + </section> + + <section id="actions"> + <title>Actions for Local Guvnor Resources</title> + + <para>The <property moreinfo="none">EGT</property> provides a number of actions (available through the + <emphasis><property moreinfo="none">Guvnor</property></emphasis> context menu on files) for working with files, both those associated with + Guvnor repository master copies and those not associated. The actions are:</para> + + <itemizedlist> + <listitem> + <para> + <link linkend="update_action">Update</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="add_action">Add</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="commit_action">Commit</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="show_history_action">Show History</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="compare_with_version">Compare with Version</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="switch_to_version">Switch to Version</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="delete_action">Delete</link> + </para> + </listitem> + <listitem> + <para> + <link linkend="disconnect_action">Disconnect</link> + </para> + </listitem> + </itemizedlist> + + <para>Each of these actions is described below.</para> + + <section id="update_action"> + <title>Update Action</title> + + <para>The <emphasis> + <property moreinfo="none">Update</property> + </emphasis> action is available for one or more Guvnor resources that are not in + synchronization with the Guvnor repository master copies. These resources would not + be in synchronization because either/both</para> + + <orderedlist continuation="restarts" inheritnum="ignore"> + <listitem><para>There are local changes to these + resources</para></listitem> + <listitem><para>The master copies have been changed in the Guvnor repository</para></listitem> + </orderedlist> + + <para>Performing the <emphasis> + <property moreinfo="none">Update</property> + </emphasis> action replaces the local file contents with the current contents from + the Guvnor repository master copies (equivalent to <emphasis> + <link linkend="switch_to_version">Switch to version</link> + </emphasis> for the latest version).</para> + </section> + + <section id="add_action"> + <title>Add Action</title> + + <para>The <emphasis> + <property moreinfo="none">Add</property> + </emphasis> action is available for one or more local files that are not associated + with a Guvnor repository master copy. Choosing the <emphasis> + <property moreinfo="none">Add</property> + </emphasis> action launches the <property moreinfo="none">Add to Guvnor wizard</property>:</para> + + <figure float="0"> + <title>Add to Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The first page of the wizard asks for the selection of the target Guvnor + repository and gives the choice to create a new Guvnor repository connection (in + which case the second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>). Once the target Guvnor repository is chosen, + the wizard then asks for the folder location to add the selection files:</para> + + <figure float="0"> + <title>Selecting a Target Folder</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/select_target_folder.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here the <emphasis> + <property moreinfo="none">"defaultPackage"</property></emphasis> folder is selected as the destination + location.</para> + + <note> + <title>Note:</title> + <para>Note that the <emphasis> + <property moreinfo="none">"snapshot"</property></emphasis> folder in the Guvnor repository is read-only for + <property moreinfo="none">EGT</property>, and hence not visible as a candidate location in + this wizard. The Guvnor repository web administration tools must be used to add + snapshot content.</para> + </note> + + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> adds the selected files to the Guvnor repository and creates an + association between the local and Guvnor repository files.</para> + + <note> + <title>Note:</title> + <para>Note that the wizard will not allow for overwrite of existing Guvnor + repository files. Another target location must be chosen.</para> + </note> + </section> + + <section id="commit_action"> + <title>Commit Action</title> + + <para>The <emphasis> + <property moreinfo="none">Commit</property> + </emphasis> action is enabled for one or more Guvnor repository associated files + that have local changes. The <emphasis> + <property moreinfo="none">Commit</property> + </emphasis> action will write the local changes back to the associated Guvnor + repository files and update the association for the new revision created.</para> + + <para>If a local change is based on an older revision of a file that is currently in the + Guvnor repository (for example, someone else changed the same file), then the <emphasis> + <property moreinfo="none">Commit</property> + </emphasis> action will<figure float="0"> + <title>Add to Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> ask whether you wish to overwrite the current version in the + Guvnor repository with the local content. When such conflicts occur, however, you + should use the Eclipse Guvnor version tools, along with Eclipse standard tools, to + determine the differences and merge content based on the current version in the + Guvnor repository.</para> + </section> + + <section id="show_history_action"> + <title>Show History Action</title> + + <para>The <emphasis> + <property moreinfo="none">Show History</property> + </emphasis> action is enable for one Guvnor repository associated file and causes + the <link linkend="guvnor_history_view">Guvnor Resource History view</link> to be + populated with revision history for the selected file.</para> + </section> + + <section id="compare_with_version"> + <title>Compare with Version Action</title> + + <para>The <emphasis> + <property moreinfo="none">Compare with Version</property> + </emphasis> action is enabled for one Guvnor repository associated file. This action + first opens a wizard asking for the version for comparison (with the local file + contents):</para> + + <figure float="0"> + <title>Compare with Version Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once the revision is selected, the action opens the Eclipse <property moreinfo="none">Compare + editor</property> (read-only):</para> + <figure float="0"> + <title>Eclipse Compare Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>This editor uses Eclipse-standard comparison techniques to show the differences in + the two versions. In cases where there are no differences, the editor will not open, + rather a dialog saying that there are no differences will appear.</para> + <figure float="0"> + <title>Alert Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="switch_to_version"> + <title>Switch to Version Action</title> + + <para>The <emphasis> + <property moreinfo="none">Switch to Version</property> + </emphasis> action is enabled for one Guvnor repository associated file.</para> + <para>First the <emphasis> + <property moreinfo="none">Switch to Version</property> + </emphasis> action prompts for selection of version:</para> + + <figure float="0"> + <title>Select Version Window</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/compare_with_version.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once the version is selected, the <emphasis> + <property moreinfo="none">Switch to Version</property> + </emphasis> action replaces the local file contents with those from the revision + selected.</para> + </section> + + <section id="delete_action"> + <title>Delete Action</title> + + <para>The <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> action is enabled for one or more Guvnor repository associated files. + After confirmation via a dialog, the <emphasis> + <property moreinfo="none">Delete</property> + </emphasis> action removes the files in the Guvnor repository and deletes local + metadata for the Guvnor repository association.</para> + + <figure float="0"> + <title>Comfirm Delete Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/confirm_delete.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="disconnect_action"> + <title>Disconnect Action</title> + + <para>The <emphasis> + <property moreinfo="none">Disconnect</property> + </emphasis> action is enabled for one or more Guvnor repository associated files, + and removes local metadata for the Guvnor repository association.</para> + </section> + </section> + + <section id="guvnor_history_view"> + <title>Guvnor Resource History View</title> + + <para>The <property moreinfo="none">Guvnor Resource History view</property> should details about revision + history for selected files, both local and those in Guvnor repositories. The initial + state of this view is shown on the figure below.</para> + + <figure float="0"> + <title>Initial State of the Guvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">Guvnor Resource History view</property> is populated by <emphasis> + <property moreinfo="none">Show History</property> + </emphasis> actions in either the local <emphasis> + <property moreinfo="none">Guvnor</property></emphasis> context menu or in the context menu for + a Guvnor repository file in the <link linkend="guvnor_repositories_view">Guvnor + Repositories view</link>. Once this action is performed, the <property moreinfo="none">Guvnor + Resource History view</property> updates to show the revision history:</para> + + <figure float="0"> + <title>IGuvnor Resource History View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Here we see that the file <emphasis> + <property moreinfo="none">test.txt</property> + </emphasis> has three revisions. Double clicking on a revision row (or the context menu <emphasis> + <property moreinfo="none">Open (Read only)</property>)</emphasis> opens an Eclipse read-only editor + with the revision contents.</para> + + <figure float="0"> + <title>Eclipse Read-only Editor with the Revision Contents</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_history_view3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <note> + <title>Note:</title> + <para>You can also use the <emphasis> + <property moreinfo="none">Save As...</property> + </emphasis> option when a file is open in a read-only editor to save a local + writable copy of the contents. Doing so, however, will not associate the file + created with its Guvnor source.</para> + </note> + + </section> + + <section id="resources_from_guvnor"> + <title>Importing Guvnor Repository Resources</title> + + <para>In addition to the single file drag-and-drop from the <property moreinfo="none">Guvnor Repositories + view</property>, the <property moreinfo="none">EGT</property> also includes a wizard for copying one + or more files from a Guvnor repository to the local workspace (and setting the + association with the Guvnor repository). This wizard is available from the <emphasis> + <property moreinfo="none">File > Import > Guvnor > Resource from + Guvnor</property> + </emphasis> and the <emphasis> + <property moreinfo="none">File > New > Other > Guvnor > Resource from + Guvnor</property> + </emphasis> menu items.</para> + <note> + <title>Note:</title> + + <para>Note that the wizard is identical but appears in both locations to accommodate + users who tend to view this functionality as being in either category.</para> + </note> + + <para>The first page of the wizard asks for the selection of the source Guvnor repository + and gives the choice to create a new Guvnor repository connection (in which case the + second page is the same as the <link linkend="guvnor_connection_wizard">Guvnor Connection wizard</link>).</para> + + <figure float="0"> + <title>Resource from Guvnor Wizard</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/add_toGuvnor_wizard.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Once the source Guvnor repository is chosen, the wizard prompts for resource selection:</para> + + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Finally, the target location in the local workspace should be chosen:</para> + <figure float="0"> + <title>Choosing the Target Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On completion the wizard copies the selected files from the Guvnor repository to the local workspace. + If a file with the same name already exists in the destination, the wizard uses the Eclipse standard + "prompt for rename" dialog:</para> + + <figure float="0"> + <title>Prompt for Rename Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/functionality_overview/resource_from_guvnor3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> +</chapter> + + +<chapter id="guvnor_preferences" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/guvnor_preferences.xml" xreflabel="guvnor_preferences"> + <?dbhtml filename="guvnor_preferences.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Guvnor Preferences</title> + + <para>The <property moreinfo="none">EGT</property> provides a preference page in the <emphasis> + <property moreinfo="none">Guvnor</property> + </emphasis> category:</para> + + <figure float="0"> + <title>Resource Selection</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guvnor_preferences/guvnor_preferences.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The preferences cover two categories:</para> + <itemizedlist> + <listitem><para>Guvnor repository connections</para></listitem> + + <listitem><para>Local Guvnor + repository resource decorations.</para></listitem> + </itemizedlist> + + <section id="repo_connection_preferences"> + <title>Guvnor Repository Connection Preferences</title> + <para>There are two preferences that can be set for Guvnor repository connections, that are + used when creating new connections:</para> + + <itemizedlist> + <listitem> + <para>The first is a default Guvnor repository URL template, which can make it + easier to create multiple similar connections by simply changing part of the + field, such as the host name.</para> + </listitem> + <listitem> + <para>The second is whether saving of authentication information in the Eclipse + platform key-ring should be enabled by default.</para> + </listitem> + </itemizedlist> + + <para>As with the Guvnor repository URL template, actually whether to save a specific + instance of authentication information in the Eclipse platform key-ring can be + determined when actually creating the connection. That is, both of these preferences are + simply convenience values set to reasonable defaults.</para> + </section> + + <section id="resource_decoration_preferences"> + <title>Local Guvnor Repository Resource Decoration Preferences</title> + + <para>The second category of preferences provided by the <property moreinfo="none">EGT</property> deals with how the decoration of + local resources associated with Guvnor repository resources is presented. Since the + Guvnor repository is not a substitute for a SCM, and since SCM tools in Eclipse tend to + decorate local resources, it is useful to be able to control just how the <property moreinfo="none">EGT</property> decorate + its local resources to avoid messy conflicts with SCM packages.</para> + + <para>In the <emphasis> + <property moreinfo="none">File Decoration</property></emphasis> + section of the preference page, you can choose the location (Top right, Top left, Bottom right, + Bottom left) of the decoration icon, or you can choose not to display it. In + the <emphasis> + <property moreinfo="none">Text</property></emphasis> section, you can format the Guvnor metadata that is appended to the file + names:</para> + <itemizedlist> + <listitem> + <para>Whether to show an indicator (>) when the local file has changes not committed back to the + Guvnor repository</para> + </listitem> + <listitem> + <para>Whether to show the revision number</para> + </listitem> + <listitem> + <para>Whether to show the date/time stamp</para> + </listitem> + </itemizedlist> + + <para>Any changes to these preferences take effect immediately upon clicking the <emphasis> + <property moreinfo="none">Apply</property></emphasis> and then <emphasis> + <property moreinfo="none">Ok</property></emphasis> buttons.</para> + </section> +</chapter> + + +<chapter id="conclusion" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/drools/docs/guvnor_ref/en/modules/conclusion.xml" xreflabel="conclusion"> + <?dbhtml filename="conclusion.html"?> + <chapterinfo> + <keywordset> + <keyword>JBoss Tools</keyword> + <keyword>Eclipse Guvnor Tools</keyword> + </keywordset> + </chapterinfo> + + <title>Conclusion</title> + + <para>As stated at the beginning of this document, the key goal of the <property moreinfo="none">EGT</property> + is to provide a way of interacting with Guvnor repository resources in a local Eclipse + workspace. While clearly there is a lot more that could be done, and no doubt there will be + aspects of the current tooling that require revision going forward, we feel that the current + state of the <property moreinfo="none">EGT</property> is sufficient for the major use cases.</para> + + <para>If you have some questions, comments or suggestions on the topic, please feel free to ask in the + <ulink url="http://www.jboss.org/index.html?module=bb&op=viewforum&f=201">Jboss Tools Forum</ulink>.</para> +</chapter> + + +</book> Modified: trunk/drools/docs/guvnor_ref/pom.xml =================================================================== --- trunk/drools/docs/guvnor_ref/pom.xml 2010-03-01 03:18:59 UTC (rev 20537) +++ trunk/drools/docs/guvnor_ref/pom.xml 2010-03-01 04:44:09 UTC (rev 20538) @@ -94,9 +94,9 @@ <configuration> <sourceDocumentName>master.xml</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: trunk/drools/docs/guvnor_ref/publican.cfg =================================================================== --- trunk/drools/docs/guvnor_ref/publican.cfg (rev 0) +++ trunk/drools/docs/guvnor_ref/publican.cfg 2010-03-01 04:44:09 UTC (rev 20538) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

JBoss Tools SVN: r20537 - in trunk/jbpm/docs/reference: en-US and 7 other directories.

by jbosstools-commits＠lists.jboss.org

Author: irooskov(a)redhat.com Date: 2010-02-28 22:18:59 -0500 (Sun, 28 Feb 2010) New Revision: 20537 Added: trunk/jbpm/docs/reference/en-US/ trunk/jbpm/docs/reference/en-US/Author_Group.xml trunk/jbpm/docs/reference/en-US/Book_Info.xml trunk/jbpm/docs/reference/en-US/Introduction.xml trunk/jbpm/docs/reference/en-US/Preface.xml trunk/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml trunk/jbpm/docs/reference/en-US/Revision_History.xml trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml trunk/jbpm/docs/reference/en-US/images/ trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/ trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/ trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/ trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png trunk/jbpm/docs/reference/en-US/images/favicon.ico trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/ trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png trunk/jbpm/docs/reference/en-US/images/jbosstools_logo.png trunk/jbpm/docs/reference/en-US/images/runtime_installation/ trunk/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png trunk/jbpm/docs/reference/en-US/images/the_views/ trunk/jbpm/docs/reference/en-US/images/the_views/the_views_0.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_1.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_10.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_2.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_3.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_4.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_5.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_6.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_7.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_8.png trunk/jbpm/docs/reference/en-US/images/the_views/the_views_9.png trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml trunk/jbpm/docs/reference/en-US/master.xml trunk/jbpm/docs/reference/en-US/master_output.xml trunk/jbpm/docs/reference/en-US/the_views.xml trunk/jbpm/docs/reference/publican.cfg Removed: trunk/jbpm/docs/reference/en/ Modified: trunk/jbpm/docs/reference/pom.xml Log: updated book to work with Maven and Publican for release staging Added: trunk/jbpm/docs/reference/en-US/Author_Group.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Author_Group.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Author_Group.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,26 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<authorgroup><author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author></authorgroup> Added: trunk/jbpm/docs/reference/en-US/Book_Info.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Book_Info.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Book_Info.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<bookinfo><title>jBPM Tools Reference Guide</title><subtitle>Provides information relating to the jBPM Tools set.</subtitle><productname>JBoss Developer Studio</productname><productnumber>3.0</productnumber><edition>1.0</edition><pubsnumber>0</pubsnumber><abstract><para>The jBPM Tools Reference Guide explains how to use the jBPM Tools to create process definitions and workflow processes.</para></abstract><corpauthor><inlinemediaobject><imageobject><imagedata fileref="Common_Content/images/title_logo.svg" format="SVG"></imagedata></imageobject></inlinemediaobject></corpauthor><xi:include href="Common_Content/Legal_Notice.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Author_Group.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></bookinfo> Added: trunk/jbpm/docs/reference/en-US/Introduction.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Introduction.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Introduction.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,154 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Introduction" xreflabel="Introduction"> + <?dbhtml filename="TargetAudience.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>Target</keyword> + <keyword>developers</keyword> + <keyword>Audience</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>All developers and process analysts who are beginning to use JBoss jBPM should read this + Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para> + <section id="Preface"> + <?dbhtml filename="Preface.html"?> + <title>Preface</title> + <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to + create workflow processes. It will help first time users with the following tasks :</para> + <itemizedlist> + <listitem> + <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download + area</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Using the creation wizard to create an empty process definition</para> + </listitem> + <listitem> + <para>Use the designer palette to draw the first processdefinition</para> + </listitem> + <listitem> + <para>Show how the xml processdefinition can be inspected as an xml file</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Write an example process test case</para> + </listitem> + </itemizedlist> + <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com" + >Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more + information.</para> + </section> + + <section id="feature_list"> + + <title>Feature list</title> + + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look + at the list of features below to understand its main functionality.</para> + <table> + <title>Key Functionality for JBoss jBPM</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <link linkend="minimal_process_definition">jBDL support</link> + </entry> + <entry>Enables managing workflow processes as well as human tasks and interactions between + them. jBDL combines the best both Java and declarative process techniques.</entry> + </row> + + <row> + <entry> + <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link> + </entry> + <entry>Is used for simplifying declarative process development and visualizations of all + actions.</entry> + </row> + + <row> + <entry> + <link linkend="CreatingjBPMProject">Project Creation wizard</link> + </entry> + <entry>Allows to create a new jBPM template project that already includes all advanced + artifacts and core jBPM libraries.</entry> + </row> + + <row> + <entry> + <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link> + </entry> + <entry>Provides process-building functionality and gives opportunity even non-programmers to + develop processes.</entry> + </row> + + <row> + <entry> + <link linkend="the_views">A large range of special views, including:</link> + </entry> + <entry></entry> + </row> + + <row> + <entry> + <link linkend="source_mode">Support of XML code view</link> + </entry> + <entry>Shows the corresponding XML that's generated automatically in the Source view + of the process definition editor when developing the process.</entry> + </row> + + <row> + <entry> + <link linkend="the_properties_view">Properties view</link> + </entry> + <entry>Facilitates configuring and editing of all nodes properties.</entry> + </row> + + <row> + <entry> + <link linkend="jbpm_gpd_editor">The jBPM Graphical Process Designer editor</link> + </entry> + <entry>The plugin is used for designing the workflow.</entry> + </row> + + + <row> + <entry>Interaction with all of the J2EE based integration technologies including Web Services, + Java Messaging, J2EE Connectors, JBDC, EJBs.</entry> + <entry>Enables implementation, provides better functionality and flexibility.</entry> + </row> + + <row> + <entry>Integration with jBoss Seam</entry> + <entry>Allows to write applications with complex workflows and provides easier interactions + between them.</entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss Wiki. </ulink></para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> + </section> + +</chapter> Added: trunk/jbpm/docs/reference/en-US/Preface.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Preface.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Preface.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<preface><title>Preface</title><xi:include href="Common_Content/Conventions.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include><xi:include href="Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"><xi:fallback xmlns:xi="http://www.w3.org/2001/XInclude"><xi:include href="Common_Content/Feedback.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include></xi:fallback></xi:include></preface> Added: trunk/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Quick_Howto_Guide.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,175 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Quick_Howto_Guide" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword/> + <keyword/> + <keyword/> + <keyword/> + </keywordset> + </chapterinfo> + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property>JBoss + jBPM</property>.</para> + + <section id="change_core_jbpm_inst"> + <title>Change the Default Core jBPM Installation</title> + + <para> You can change the default <property>jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property>Window > Preferences</property> + </emphasis> and select the <emphasis> + <property>JBoss jBPM > Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property>jBPM</property> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a <property>jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Configuring Task Nodes</title> + + <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para> + + <para> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + <property>Properties view</property> for selected Task node includes several tabs. </para> + + <figure> + <title>The Properties View of the selected Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</para> + + <figure> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property>Properties view</property> as well.</para> + + <figure> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The <property>General page</property> is a place where you can specify the name of a + Task and its description. For instance, let it be <emphasis> + <property>approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property>Details page</property>. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The <emphasis> + <property>Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property>Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>For our example, we specify the due date as 2 business days, choose the high priority + and also check the <emphasis> + <property>Signalling</property> + </emphasis> and <emphasis> + <property>Notify</property> + </emphasis> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the <property>Assignment page</property>.</para> + + <figure> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property>Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</para> + <para>In the next figure you can see our configuring generated into XML.</para> + <figure> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" + scale="80"/> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. Besides, for additional information you are welcome on <ulink + url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> +</chapter> Added: trunk/jbpm/docs/reference/en-US/Revision_History.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Revision_History.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Revision_History.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,4 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<appendix><title>Revision History</title><simpara><revhistory><revision><revnumber>0</revnumber><date>Fri Nov 20 2009</date><author><firstname>Isaac</firstname><surname>Rooskov</surname><email>irooskov(a)redhat.com</email></author><revdescription><simplelist><member>Initial creation of book by publican</member></simplelist></revdescription></revision></revhistory></simpara></appendix> Added: trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/Test_Drive_Proc.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,173 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="Test_Drive_Proc_Development" xreflabel="Test_Drive_Proc_Development"> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword/> + <keyword/> + <keyword/> + <keyword/> + </keywordset> + </chapterinfo> + <title>Test Driven Process Development</title> + + <para> One of the most important advantages of JBoss jBPM's lightweight approach to BPM + and workflow management is that developers can easily leverage their usual programming + skills and techniques. One of these well-known techniques is Unit Testing and Test Driven + Development. </para> + <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a + technique we have baptized <property>Test Driven Process Development</property> to create + process definitions and test their correctness. </para> + + <para> When creating the <emphasis> + <property>HellojBPM</property> + </emphasis> project the Project Creation wizard has already put in place all the library + requirements we need to start writing the jBPM unit tests. They are contained in the jBPM + Library container and the most important of them is the <emphasis> + <property>.jar</property> + </emphasis> file containing the core jBPM classes. While working on the project you could + find them all in the <property>Package Explorer</property>.</para> + + <figure> + <title>The jBPM Libraries</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>It must be noted that it is possible to change the location of the core jBPM installation + by changing the preference settings. More on this <link linkend="change_core_jbpm_inst">see + later</link> in this book.</para> + + <para> With that extra knowledge on the project settings, you can create your first test. To do + this, we create the <emphasis> + <property>com.jbay</property> + </emphasis> package in the <emphasis> + <property>test/java</property> + </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis> + <property>New > Other...</property> + </emphasis></para> + + <figure> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"/> + </imageobject> + </mediaobject> + </figure> + + <para> And then <emphasis> + <property>Java > JUnit > JUnit Test Case</property> + </emphasis> to call the specialized JUnite Test case creation wizard.</para> + <figure> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard looks as follows:</para> + + <figure> + <title>Create Test Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>By default JUnite 3 version of testing framework is selected. Of course, you can choose + new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit + Library to your build path. To add it automatically just click on the appropriate link. In + the <emphasis> + <property>Class under test</property> + </emphasis> section you can specify the class to test.</para> + + <figure> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Then, we call the test class <emphasis> + <property>HelloTest</property> + </emphasis> and press <emphasis> + <property>Finish</property> + </emphasis> button to complete.</para> + + <para> Next, we should write a simple test scenario as shown on the next figure. Let's + study the code of this test case. </para> + + <figure id="hello_test"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>In the first line of the method, a jBPM process archive object is created. We use a + constructor accepting the filename of the archive. In our case it is the <emphasis> + <property>hello</property> + </emphasis> file we created earlier and which lives in the <emphasis> + <property>src/main/jpdl</property> + </emphasis> folder of our project. After asserting that this object is really created, we + extract a process definition object from it. This object is fed to the constructor of a + process instance object. We have a process instance object, but this process is not yet + started, so we can safely assert that its root token still resides in the start node. After + signalling the token will move to the next state and the process will be in the <emphasis> + <property>auction</property> + </emphasis> state. Finally another signal will end the process. </para> + + + <para> After writing this test we can check whether it works as expected by running it .</para> + + <figure> + <title>Running the Process Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + <para>All went well as we have a green light:</para> + + <figure> + <title>Successful Test Run</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para> Of course, this simple scenario was not very interesting, but the purpose of it was to + show how you can reuse your development skills in a very straightforward way when doing + process development. To see how more interesting processes and process test + scenario's can be developed, we suggest you to read the <ulink + url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> and to + study the API reference. You can find it in the jBPM download folder. (To get started we + downloaded jbpm-jpdl-3.2.2 in <link linkend="jboss_jbpm_runtime_installation">the second + chapter</link>. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder. + Moreover, some more examples will be given later in this book.</para> + +</chapter> Added: trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/The_JBoss_jBPM_Int_Mech.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,241 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="The_JBoss_jBPM_Int_Mech" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword/> + <keyword/> + <keyword/> + <keyword/> + </keywordset> + </chapterinfo> + <title>Actions : The JBoss jBPM Integration Mechanism</title> + + <para> In this chapter we will show how to do software integration with <property>JBoss + jBPM</property>. The standard mechanism to implement this is to wrap the functionality you + want to integrate in a class that implements the <emphasis> + <property>ActionHandler</property> + </emphasis> interface. In order to demonstrate it let's specify Hello World action for our + process.</para> + + <section> + <title>Creating a Hello World Action</title> + + <para>Each Hello World process should integrate one or more Hello World actions, so this is + what we will be doing. We can integrate custom code at different points in the process + definition. To do this we have to specify an action handler, represented by an + implementation of the <emphasis> + <property>ActionHandler</property> + </emphasis> interface, and attach this piece of code to a particular event. These events + are amongst others, going over a transition, leaving or entering nodes, after and before + signalling. </para> + + <para> To make things a little bit more concrete, let's create a new class called <emphasis> + <property>HelloActionHandler</property>. + </emphasis> For that firstly we'll create a new package <emphasis> + <property>com.jbay.action</property> + </emphasis> in the <emphasis> + <property>src/java/main</property> + </emphasis> folder of our project. Then, we should call New Class Creation wizard as + usual by right-clicking and navigating <emphasis> + <property>New > Class</property>. + </emphasis> </para> + + <figure> + <title>Creating HelloActionHendler Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis> + <property>Package</property> + </emphasis> option <emphasis> + <property>Enclose type</property> + </emphasis> option can be selected where a type in which to enclose a new class should + be specified.</para> + + <para>In our case, we leave everything as it is, just type <emphasis> + <property>HelloActionHandler</property> + </emphasis> as a name of new class and add <emphasis> + <property>org.jbpm.graph.ActionHendler</property> + </emphasis> interface as it's shown in the picture above.</para> + + <para>Thus, our <emphasis> + <property>HelloActionHandler</property> + </emphasis> implements the <emphasis> + <property>ActionHandler</property> + </emphasis> interface including the <emphasis> + <property>execute</property> + </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis> + <property>greeting</property> + </emphasis> to the collection of process variables and put a message in it : + <emphasis>"Hello from ActionHandler"</emphasis>. </para> + + <figure> + <title>A Simple Hello Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>Now, as we have <emphasis> + <property>HelloActionHandler</property> + </emphasis> class defined, let's explore how we can handle it.</para> + </section> + + <section> + <title>Integrating the Hello World Action</title> + + <para>The main purpose of this chapter is to provide you with the steps associating our + Hello World action with a particular event and test the correctness of our actions as + well.</para> + + <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour + we want to achieve by adding the <emphasis> + <property>ActionHandler</property> + </emphasis> to the process. So we implement another test.</para> + + <para>At first, let's return to the + code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis> + <property>testActionHendler</property></emphasis> to it. </para> + + <figure> + <title>Create the Hello Action Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para>We assert + that no variable called <emphasis> + <property>greeting</property> + </emphasis> exist. Then we give the process a signal to move it to the auction state. We + want to associate the execution of the action with the event of going over the + transition from the start state to the auction state. So after the signal, the process + should be in the auction state as in the previous scenario. But moreover, the <emphasis> + <property>greeting</property> + </emphasis> variable should exist and contain the string <emphasis>"Hello from + ActionHandler"</emphasis>. That's what we assert in the last lines of the test + method.</para> + + + + <para> Running the tests now results in a failure. The point is that we did not associate + the action with any particular event in the process definition, so the process variable + did not get set. </para> + + <figure> + <title>Test Results Before Integration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" + scale="75"/> + </imageobject> + </mediaobject> + </figure> + + <para> Let's do something about it and add an action to the first transition of our + sample process. To do this you can use the Actions tab in the Properties Editor that is + under the graphical canvas. Bring up the popup menu of the action element container and + chose New Action as it's shown on the figure below. The other way to add an action + to the transition is simply to use the dropdown menu that is available under the action + icon in the right upper corner of the Properties View.</para> + + <figure> + <title>Adding an Action to a Transition</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>After adding the action a tabbed view with three pages will appear.</para> + + <figure> + <title>Configuration Dialog for an Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>The first of these three pages allows you to give the Action a name. The last page + contains some advanced attributes such as whether the Action is asynchronous. The + Details page is the most important. It allows to choose and configure the actual action + handler implementation. </para> + + <figure> + <title>The Details page of an Action Configuration Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + + <para>Clicking on the <emphasis> + <property>Search...</property> + </emphasis> button brings us to a Choose Class dialog.</para> + + + <figure> + <title>The Choose Action Handler Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"/> + </imageobject> + </mediaobject> + </figure> + + + <para> We choose our previously created 'HelloActionHandler' class and + push the <property>OK</property> button. After the selection of the action handler for + the action, we can run the test and observe it gives us a green light.</para> + + <figure> + <title>Test Results</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" + scale="70"/> + </imageobject> + </mediaobject> + </figure> + + <para>There we are. The above objective has been achieved.</para> + </section> + + <section> + <title> Integration Points</title> + + <para> The different integration points in a process definition are thoroughly documented in + the <ulink + url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action + elements. Each of these will appear in the Action element list of the Actions tab. But + each Action also has a properties view of itself. You can navigate to this view by + selecting the added Action in the outline view. </para> + + </section> + +</chapter> Added: trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/guided_tour_jboss_jbpmgpd.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,221 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="GuidedTourJBossjBPMGPD" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>JBoss</keyword> + <keyword>Process</keyword> + <keyword>Definition</keyword> + </keywordset> + </chapterinfo> + <title>A Guided Tour of JBoss jBPM GPD</title> + <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your + own simple process. Let's try to organize a new jBPM project.</para> + <para>A wizard for creating a jBPM project is included in the GPD plugin. We have opted to + create a project based on a template already containing a number of advanced artifacts that + we will ignore for this section. In the future we will elaborate this wizard and offer the + possibility to create an empty jBPM project as well as projects based on templates taken + from the jBPM tutorial.</para> + <section id="CreatingjBPMProject"> + <?dbhtml filename="CreatingjBPMProject.html"?> + <title>Creating a jBPM Project</title> + <para>This section will show you how to use the Creation wizard for creating a new jBPM + project with already included source folders.</para> + <para>At first you should select <emphasis> + <property>File >New Project...</property> + </emphasis> and then <emphasis> + <property>JBoss jBPM > Process Project</property> + </emphasis> in the New Project dialog:</para> + <figure> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis> + <property>Next</property> + </emphasis> brings us to the wizard page where it's necessary to specify the + name and location for the project. We choose, for example, <emphasis> + <property>HellojBPM</property> + </emphasis> as the name and accept the default location. </para> + <figure> + <title>Process Name and Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Thus, our project will be created in the workspace root directory by default. If you + want to change the directory for your future project, deselect <emphasis> + <property>Use default location</property> + </emphasis> and click <emphasis> + <property>Browse...</property> + </emphasis> button to set needed location or simply type it.</para> + <para>On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</para> + <figure> + <title>Core jBPM Location Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis> + <property>Finish</property> + </emphasis> results in the project being generated. The wizard creates four source + folders: one for the processes (<emphasis> + <property>src/main/jpdl</property> + </emphasis>), one for the java sources (<emphasis> + <property>src/main/java</property> + </emphasis>), one for the unit tests (<emphasis> + <property>src/test/java</property> + </emphasis>) and one for the resources such as the jbpm.properties and the + hibernate.properties files (<emphasis> + <property>src/main/config</property> + </emphasis>). In addition a classpath container with all the core jBPM libraries is + added to the project</para> + <figure> + <title>Layout of the Process Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Looking inside the different source folders will reveal a number of other artifacts + that were generated, but we will leave these untouched for the moment. Instead, we will + look at another wizard that enables us to create an empty process definition.</para> + </section> + <section id="creating_an_empty_process_definition"> + <?dbhtml filename="creating_an_empty_process_definition.html"?> + <title>Creating an Empty Process Definition</title> + <para>Now when the project is set up, we can use a Creation wizard to create an empty + process definition. Bring up the <emphasis> + <property>New</property> + </emphasis> wizard by clicking the <emphasis> + <property>File > New > Other...</property> + </emphasis> menu item. The wizard opens on the <emphasis> + <property>Select Wizard</property> + </emphasis> page.</para> + <figure> + <title>The Select Wizard Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the <emphasis> + <property>JBoss jBPM</property> + </emphasis> category, then the <emphasis> + <property>Process Definition</property> + </emphasis> item and clicking on the <emphasis> + <property>Next</property> + </emphasis> button brings us to the <emphasis> + <property>Create Process Definition</property> + </emphasis> page.</para> + <figure> + <title>The Create New Process Defining Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"/> + </imageobject> + </mediaobject> + </figure> + <para>We choose <emphasis> + <property>hello</property> + </emphasis> as the name of the process archive file. Click on the <emphasis> + <property>Finish</property> + </emphasis> button to end the wizard and open the process definition editor.</para> + <figure> + <title>The Process Definition Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + + + <para>You can see in the Package Explorer that creating a process definition involves + creating a folder with the name of the process definition and populating this folder + with two .xml files : <emphasis> + <property>gpd.xml</property> + </emphasis> and <emphasis> + <property>processdefinition.xml</property>. </emphasis></para> + <para>The <emphasis> + <property>gpd.xml</property> + </emphasis> contains the graphical information used by the process definition editor. + The <emphasis> + <property>processdefinition.xml</property> + </emphasis> file contains the actual process definition info without the graphical + rendering info. At present, the GPD assumes that these two files are siblings. More + sophisticated configuration will be supported later.</para> + + <section id="minimal_process_definition"> + <?dbhtml filename="minimal_process_definition.html"?> + <title>A Minimal Process Definition</title> + <para>Now we are ready to create a very simple process definition consisting of a begin + state, an intermediate state and an end state.</para> + <para>To make the configuration of actions much easier it's better to use the + jPDL perspective. It provides the tabbed Properties Editor which allows to configure + all the relevant properties of the current selected item. </para> + + <section id="adding_the_nodes"> + <?dbhtml filename="adding_the_nodes.html"?> + <title>Adding the Nodes</title> + <para>At first select respectively <emphasis> + <property>Start</property>, </emphasis> + <emphasis> + <property>State</property> + </emphasis> and <emphasis> + <property>End</property> + </emphasis> on the tools palette and click on the canvas to add these nodes to + the process definition. The result should look similar to this:</para> + <figure> + <title>A Simple Process With Three Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + <?dbhtml filename="adding_transitions.html"?> + <title>Adding Transitions</title> + <para>Then, we will connect the nodes with transitions. To do that select the <emphasis> + <property>Transition</property> + </emphasis> tool in the tools palette and click on the <emphasis> + <property>Start</property> + </emphasis> node, then move to the <emphasis> + <property>State</property> + </emphasis> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the <emphasis> + <property>State</property> + </emphasis> node to the <emphasis> + <property>End</property> + </emphasis> node. The result will look like:</para> + <figure> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" + scale="60"/> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</para> + </section> + </section> + </section> + +</chapter> Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Quick_Howto_Guide/quick_howto_guide_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/Test_Drive_Proc/test_driv_proc_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/favicon.ico =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/favicon.ico ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/guided_tour_jboss_jbpmgpd/guided_tour_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/jbosstools_logo.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/jbosstools_logo.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/runtime_installation/runtime_installation_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_0.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_0.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_1.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_1.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_10.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_10.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_2.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_2.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_3.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_3.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_4.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_4.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_5.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_5.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_6.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_6.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_7.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_7.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_8.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_8.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_9.png =================================================================== (Binary files differ) Property changes on: trunk/jbpm/docs/reference/en-US/images/the_views/the_views_9.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent =================================================================== --- trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent (rev 0) +++ trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.ent 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,4 @@ +<!ENTITY PRODUCT "JBoss"> +<!ENTITY BOOKID "jBPM_Tools_Reference_Guide"> +<!ENTITY YEAR "2009"> +<!ENTITY HOLDER "Red Hat"> Added: trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/jBPM_Tools_Reference_Guide.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,15 @@ +<?xml version='1.0' encoding='utf-8' ?> +<!DOCTYPE Book PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN" "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [ +]> +<book> +<xi:include href="Book_Info.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Preface.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Introduction.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="jboss_jbpm_runtime_installation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="guided_tour_jboss_jbpmgpd.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="the_views.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Test_Drive_Proc.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="The_JBoss_jBPM_Int_Mech.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Quick_Howto_Guide.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +<xi:include href="Revision_History.xml" xmlns:xi="http://www.w3.org/2001/XInclude"></xi:include> +</book> Added: trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/jboss_jbpm_runtime_installation.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,49 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="jboss_jbpm_runtime_installation" xreflabel="jboss_jbpm_runtime_installation"> + <?dbhtml filename="jboss_jbpm_runtime_installation.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>designer</keyword> + <keyword>process</keyword> + <keyword>JBoss Developer Studio</keyword> + <keyword>jBPM runtime</keyword> + </keywordset> + </chapterinfo> + <title>JBoss jBPM Runtime Installation</title> + <para>The main purpose of this chapter is to let you know how to launch the <property>JBoss + jBPM</property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included in the <property>JBoss Tools</property>. + To make it work, you should only download the jBPM runtime (<ulink + url="http://sourceforge.net/project/showfiles.php?group_id=70542&package_i..." + >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where you extracted the runtime + either when you create a jBPM project or by using the jBPM preference pages.</para> + + <note> + <title>Note:</title> + <para>Try to avoid using spaces in the names of installation folders. It can provoke problems in + some situations with Sun-based VMs.</para> + </note> + + <para>Navigate to <emphasis> + <property>Window > Preferences > JBoss jBPM > Runtime Locations</property>. + </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property>Add</property> + </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and + point to the correct location of this package on your harddrive. Click <emphasis> + <property>OK</property> + </emphasis> then click <emphasis> + <property>OK</property> + </emphasis> again.</para> + + <figure> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation_1.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</para> +</chapter> Added: trunk/jbpm/docs/reference/en-US/master.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/master.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/master.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,91 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY introduction SYSTEM "Introduction.xml"> +<!ENTITY jboss_jbpm_runtime_installation SYSTEM "jboss_jbpm_runtime_installation.xml"> +<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "guided_tour_jboss_jbpmgpd.xml"> +<!ENTITY the_views SYSTEM "the_views.xml"> +<!ENTITY Test_Drive_Proc SYSTEM "Test_Drive_Proc.xml"> +<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "The_JBoss_jBPM_Int_Mech.xml"> +<!ENTITY Quick_Howto_Guide SYSTEM "Quick_Howto_Guide.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + ]> +<book> + <bookinfo> + <title>jBPM Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata format="PNG" fileref="images/jbosstools_logo.png" /> + </imageobject> + <imageobject role="html"> + <imagedata/> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author> + + <copyright> + <year>2007</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo> Version: 4.0.0.trunk</releaseinfo> + +<abstract> + <title/> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc/> + &introduction; + &jboss_jbpm_runtime_installation; + &guided_tour_jboss_jbpmgpd; + &the_views; &Test_Drive_Proc; + &The_JBoss_jBPM_Int_Mech; + &Quick_Howto_Guide; + +  +</book> Added: trunk/jbpm/docs/reference/en-US/master_output.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/master_output.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/master_output.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,1317 @@ +<?xml version="1.0" encoding="UTF-8"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" +"http://www.docbook.org/xml/4.3/docbookx.dtd" + + +[<!ENTITY introduction SYSTEM "modules/Introduction.xml"> +<!ENTITY jboss_jbpm_runtime_installation SYSTEM "modules/jboss_jbpm_runtime_installation.xml"> +<!ENTITY guided_tour_jboss_jbpmgpd SYSTEM "modules/guided_tour_jboss_jbpmgpd.xml"> +<!ENTITY the_views SYSTEM "modules/the_views.xml"> +<!ENTITY Test_Drive_Proc SYSTEM "modules/Test_Drive_Proc.xml"> +<!ENTITY The_JBoss_jBPM_Int_Mech SYSTEM "modules/The_JBoss_jBPM_Int_Mech.xml"> +<!ENTITY Quick_Howto_Guide SYSTEM "modules/Quick_Howto_Guide.xml"> + +<!ENTITY seamlink "../../seam/html_single/index.html"> +<!ENTITY aslink "../../as/html_single/index.html"> +<!ENTITY esblink "../../esb_ref_guide/html_single/index.html"> +<!ENTITY gsglink "../../GettingStartedGuide/html_single/index.html"> +<!ENTITY hibernatelink "../../hibernatetools/html_single/index.html"> +<!ENTITY jbpmlink "../../jbpm/html_single/index.html"> +<!ENTITY jsflink "../../jsf/html_single/index.html"> +<!ENTITY jsfreflink "../../jsf_tools_ref_guide/html_single/index.html"> +<!ENTITY jsftutoriallink "../../jsf_tools_tutorial/html_single/index.html"> +<!ENTITY strutsreflink "../../struts_tools_ref_guide/html_single/index.html"> +<!ENTITY strutstutoriallink "../../struts_tools_tutorial/html_single/index.html"> + + ]><book xmlns:diffmk="http://diffmk.sf.net/ns/diff"> + <bookinfo> + <title>jBPM Tools Reference Guide</title> + <corpauthor> + <inlinemediaobject> + <imageobject role="fo"> + <imagedata fileref="images/jbosstools_logo.png" format="PNG"></imagedata> + </imageobject> + <imageobject role="html"> + <imagedata></imagedata> + </imageobject> + </inlinemediaobject> + </corpauthor> + + <author> + <firstname>Anatoly</firstname> + <surname>Fedosik</surname> + </author> + <author> + <firstname>Koen</firstname> + <surname>Aers</surname> + <email>koen.aers(a)jboss.com</email> + </author> + <author> + <firstname>Olga</firstname> + <surname>Chikvina</surname> + </author> + <author> + <firstname>Svetlana</firstname> + <surname>Mukhina</surname> + <email>smukhina(a)exadel.com</email> + </author> + <author> + <firstname>Tom</firstname> + <surname>Baeyens</surname> + <email>tom.baeyens(a)jboss.com</email> + </author> + + <copyright> + <year>2007</year> + <year>2009</year> + <year>2010</year> + <holder>JBoss by Red Hat</holder> + </copyright> + <releaseinfo><diffmk:wrapper diffmk:change="changed"> Version: 4.0.0.trunk</diffmk:wrapper></releaseinfo> + +<abstract> + <title></title> + <para> + <ulink url="http://download.jboss.org/jbosstools/nightly-docs/en/jbpm/pdf/JBPM_Refere...">PDF version</ulink> + </para> +</abstract> + + </bookinfo> + + <toc></toc> + +<chapter id="Introduction" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/Introduction.xml" xreflabel="Introduction"> + <?dbhtml filename="TargetAudience.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>Target</keyword> + <keyword>developers</keyword> + <keyword>Audience</keyword> + </keywordset> + </chapterinfo> + <title>Introduction</title> + <para>All developers and process analysts who are beginning to use JBoss jBPM should read this + Getting Started guide. It will give them a jumpstart showing how to create a process definition.</para> + <section id="Preface"> + <?dbhtml filename="Preface.html"?> + <title>Preface</title> + <para>This document introduces the use of the JBoss jBPM Graphical Process Designer (GPD) to + create workflow processes. It will help first time users with the following tasks :</para> + <itemizedlist> + <listitem> + <para>Install the JBoss jBPM GPD Eclipse plugin available from the JBoss jBPM download + area</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Using the creation wizard to create an empty process definition</para> + </listitem> + <listitem> + <para>Use the designer palette to draw the first processdefinition</para> + </listitem> + <listitem> + <para>Show how the xml processdefinition can be inspected as an xml file</para> + </listitem> + <listitem> + <para>Set up a Java project in Eclipse and prepare it to do test driven process + development</para> + </listitem> + <listitem> + <para>Write an example process test case</para> + </listitem> + </itemizedlist> + <para>If you have questions, please feel free to contact <ulink url="mailto:koen.aers@jboss.com">Koen Aers</ulink> or <ulink url="mailto:tom.baeyens@jboss.com">Tom Baeyens</ulink> for more + information.</para> + </section> + + <section id="feature_list"> + + <title>Feature list</title> + + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look + at the list of features below to understand its main functionality.</para> + <table> + <title>Key Functionality for JBoss jBPM</title> + <tgroup cols="2"> + <thead> + <row> + <entry>Feature</entry> + <entry>Benefit</entry> + </row> + </thead> + <tbody> + + <row> + <entry> + <link linkend="minimal_process_definition">jBDL support</link> + </entry> + <entry>Enables managing workflow processes as well as human tasks and interactions between + them. jBDL combines the best both Java and declarative process techniques.</entry> + </row> + + <row> + <entry> + <link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link> + </entry> + <entry>Is used for simplifying declarative process development and visualizations of all + actions.</entry> + </row> + + <row> + <entry> + <link linkend="CreatingjBPMProject">Project Creation wizard</link> + </entry> + <entry>Allows to create a new jBPM template project that already includes all advanced + artifacts and core jBPM libraries.</entry> + </row> + + <row> + <entry> + <link linkend="minimal_process_definition">Rich palette of pre-build process nodes</link> + </entry> + <entry>Provides process-building functionality and gives opportunity even non-programmers to + develop processes.</entry> + </row> + + <row> + <entry> + <link linkend="the_views">A large range of special views, including:</link> + </entry> + <entry></entry> + </row> + + <row> + <entry> + <link linkend="source_mode">Support of XML code view</link> + </entry> + <entry>Shows the corresponding XML that's generated automatically in the Source view + of the process definition editor when developing the process.</entry> + </row> + + <row> + <entry> + <link linkend="the_properties_view">Properties view</link> + </entry> + <entry>Facilitates configuring and editing of all nodes properties.</entry> + </row> + + <row> + <entry> + <link linkend="jbpm_gpd_editor">The jBPM Graphical Process Designer editor</link> + </entry> + <entry>The plugin is used for designing the workflow.</entry> + </row> + + + <row> + <entry>Interaction with all of the J2EE based integration technologies including Web Services, + Java Messaging, J2EE Connectors, JBDC, EJBs.</entry> + <entry>Enables implementation, provides better functionality and flexibility.</entry> + </row> + + <row> + <entry>Integration with jBoss Seam</entry> + <entry>Allows to write applications with complex workflows and provides easier interactions + between them.</entry> + </row> + + </tbody> + </tgroup> + </table> + </section> + + <section> + <title>Other relevant resources on the topic</title> + <para>All JBoss Developer Studio/JBoss Tools release documentation you can find at<ulink url="http://docs.jboss.org/tools/">http://docs.jboss.org/tools</ulink> in the corresponding release directory.</para> + <para>There is some extra information on <ulink url="http://www.jboss.org/community/wiki/JBPMWiki">JBoss Wiki. </ulink></para> + <para>The latest documentation builds are available at <ulink url="http://download.jboss.org/jbosstools/nightly-docs/">http://download.jboss.org/jbosstools/nightly-docs</ulink>.</para> + </section> + +</chapter> + + +<chapter id="jboss_jbpm_runtime_installation" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml" xreflabel="jboss_jbpm_runtime_installation"> + <?dbhtml filename="jboss_jbpm_runtime_installation.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>designer</keyword> + <keyword>process</keyword> + <keyword>JBoss Developer Studio</keyword> + <keyword>jBPM runtime</keyword> + </keywordset> + </chapterinfo> + <title>JBoss jBPM Runtime Installation</title> + <para>The main purpose of this chapter is to let you know how to launch the <property moreinfo="none">JBoss + jBPM</property> (business process management).</para> + <para>The jBPM plugin (jBPM Designer) is already included in the <property moreinfo="none">JBoss Tools</property>. + To make it work, you should only download the jBPM runtime (<ulink + url="http://sourceforge.net/project/showfiles.php?group_id=70542& + package_id=145174&release_id=607377" + >jbpm-jpdl-3.2.3</ulink> currently) and specify the directory where you extracted the runtime + either when you create a jBPM project or by using the jBPM preference pages.</para> + + <note> + <title>Note:</title> + <para>Try to avoid using spaces in the names of installation folders. It can provoke problems in + some situations with Sun-based VMs.</para> + </note> + + <para>Navigate to <emphasis> + <property moreinfo="none">Window > Preferences > JBoss jBPM > Runtime Locations</property>. + </emphasis> Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property moreinfo="none">Add</property> + </emphasis> button. In the dialog that appeared enter a name for a newly added jBPM runtime and + point to the correct location of this package on your harddrive. Click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> then click <emphasis> + <property moreinfo="none">OK</property> + </emphasis> again.</para> + + <figure float="0"> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you have a runtime installed, we are going to demonstrate some powerful features of + the jBPM.</para> +</chapter> + + +<chapter id="GuidedTourJBossjBPMGPD" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml" xreflabel="GuidedTourJBossjBPMGPD"> + <?dbhtml filename="GuidedTourJBossjBPMGPD.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword>JBoss</keyword> + <keyword>Process</keyword> + <keyword>Definition</keyword> + </keywordset> + </chapterinfo> + <title>A Guided Tour of JBoss jBPM GPD</title> + <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your + own simple process. Let's try to organize a new jBPM project.</para> + <para>A wizard for creating a jBPM project is included in the GPD plugin. We have opted to + create a project based on a template already containing a number of advanced artifacts that + we will ignore for this section. In the future we will elaborate this wizard and offer the + possibility to create an empty jBPM project as well as projects based on templates taken + from the jBPM tutorial.</para> + <section id="CreatingjBPMProject"> + <?dbhtml filename="CreatingjBPMProject.html"?> + <title>Creating a jBPM Project</title> + <para>This section will show you how to use the Creation wizard for creating a new jBPM + project with already included source folders.</para> + <para>At first you should select <emphasis> + <property moreinfo="none">File >New Project...</property> + </emphasis> and then <emphasis> + <property moreinfo="none">JBoss jBPM > Process Project</property> + </emphasis> in the New Project dialog:</para> + <figure float="0"> + <title>New Project Dialog</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para> Clicking <emphasis> + <property moreinfo="none">Next</property> + </emphasis> brings us to the wizard page where it's necessary to specify the + name and location for the project. We choose, for example, <emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> as the name and accept the default location. </para> + <figure float="0"> + <title>Process Name and Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Thus, our project will be created in the workspace root directory by default. If you + want to change the directory for your future project, deselect <emphasis> + <property moreinfo="none">Use default location</property> + </emphasis> and click <emphasis> + <property moreinfo="none">Browse...</property> + </emphasis> button to set needed location or simply type it.</para> + <para>On the next screen you'll be prompted to select the core jBPM location that + we have defined in the previous chapter.</para> + <figure float="0"> + <title>Core jBPM Location Specifying</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Clicking on <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> results in the project being generated. The wizard creates four source + folders: one for the processes (<emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis>), one for the java sources (<emphasis> + <property moreinfo="none">src/main/java</property> + </emphasis>), one for the unit tests (<emphasis> + <property moreinfo="none">src/test/java</property> + </emphasis>) and one for the resources such as the jbpm.properties and the + hibernate.properties files (<emphasis> + <property moreinfo="none">src/main/config</property> + </emphasis>). In addition a classpath container with all the core jBPM libraries is + added to the project</para> + <figure float="0"> + <title>Layout of the Process Project</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Looking inside the different source folders will reveal a number of other artifacts + that were generated, but we will leave these untouched for the moment. Instead, we will + look at another wizard that enables us to create an empty process definition.</para> + </section> + <section id="creating_an_empty_process_definition"> + <?dbhtml filename="creating_an_empty_process_definition.html"?> + <title>Creating an Empty Process Definition</title> + <para>Now when the project is set up, we can use a Creation wizard to create an empty + process definition. Bring up the <emphasis> + <property moreinfo="none">New</property> + </emphasis> wizard by clicking the <emphasis> + <property moreinfo="none">File > New > Other...</property> + </emphasis> menu item. The wizard opens on the <emphasis> + <property moreinfo="none">Select Wizard</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Select Wizard Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Selecting the <emphasis> + <property moreinfo="none">JBoss jBPM</property> + </emphasis> category, then the <emphasis> + <property moreinfo="none">Process Definition</property> + </emphasis> item and clicking on the <emphasis> + <property moreinfo="none">Next</property> + </emphasis> button brings us to the <emphasis> + <property moreinfo="none">Create Process Definition</property> + </emphasis> page.</para> + <figure float="0"> + <title>The Create New Process Defining Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We choose <emphasis> + <property moreinfo="none">hello</property> + </emphasis> as the name of the process archive file. Click on the <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to end the wizard and open the process definition editor.</para> + <figure float="0"> + <title>The Process Definition Editor</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_6.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>You can see in the Package Explorer that creating a process definition involves + creating a folder with the name of the process definition and populating this folder + with two .xml files : <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis> and <emphasis> + <property moreinfo="none">processdefinition.xml</property>. </emphasis></para> + <para>The <emphasis> + <property moreinfo="none">gpd.xml</property> + </emphasis> contains the graphical information used by the process definition editor. + The <emphasis> + <property moreinfo="none">processdefinition.xml</property> + </emphasis> file contains the actual process definition info without the graphical + rendering info. At present, the GPD assumes that these two files are siblings. More + sophisticated configuration will be supported later.</para> + + <section id="minimal_process_definition"> + <?dbhtml filename="minimal_process_definition.html"?> + <title>A Minimal Process Definition</title> + <para>Now we are ready to create a very simple process definition consisting of a begin + state, an intermediate state and an end state.</para> + <para>To make the configuration of actions much easier it's better to use the + jPDL perspective. It provides the tabbed Properties Editor which allows to configure + all the relevant properties of the current selected item. </para> + + <section id="adding_the_nodes"> + <?dbhtml filename="adding_the_nodes.html"?> + <title>Adding the Nodes</title> + <para>At first select respectively <emphasis> + <property moreinfo="none">Start</property>, </emphasis> + <emphasis> + <property moreinfo="none">State</property> + </emphasis> and <emphasis> + <property moreinfo="none">End</property> + </emphasis> on the tools palette and click on the canvas to add these nodes to + the process definition. The result should look similar to this:</para> + <figure float="0"> + <title>A Simple Process With Three Nodes</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_7.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + <section id="adding_transitions"> + <?dbhtml filename="adding_transitions.html"?> + <title>Adding Transitions</title> + <para>Then, we will connect the nodes with transitions. To do that select the <emphasis> + <property moreinfo="none">Transition</property> + </emphasis> tool in the tools palette and click on the <emphasis> + <property moreinfo="none">Start</property> + </emphasis> node, then move to the <emphasis> + <property moreinfo="none">State</property> + </emphasis> node and click again to see the transition being drawn. Perform the + same steps to create a transition from the <emphasis> + <property moreinfo="none">State</property> + </emphasis> node to the <emphasis> + <property moreinfo="none">End</property> + </emphasis> node. The result will look like:</para> + <figure float="0"> + <title>A Simple Process With Transitions</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour_8.png" scale="60"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Now, when you've got background knowledge of simple project creation, + let's move to more advanced tools.</para> + </section> + </section> + </section> + +</chapter> + + +<chapter id="the_views" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/the_views.xml" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + + <title>The views</title> + + <para>Here, it will be explained how to work with views and editors provided by JBDS.</para> + <para>The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + current active file are immediately displayed in them. Let’s get acquainted more closely + with those that the <property moreinfo="none">jPDL perspective</property> provides. </para> + + <figure float="0"> + <title>The jPDL Perspective Views and Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_0.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see in the picture above, the <property moreinfo="none">jPDL perspective</property> contains a + complete set of functionality that's necessary for working on the jBPM project.</para> + + <section id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Outline View</title> + <para>To have a way to quickly see an outline of the process use the <emphasis> + <property moreinfo="none">Outline view</property> + </emphasis> that is presented as the classical tree. If it is not visible select <emphasis> + <property moreinfo="none">Window > Show view > Outline</property>. </emphasis></para> + + <figure float="0"> + <title>The Overview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Overview</title> + <para>The main advantage of this view is that it gives visual representation of the whole + current developing process. Besides, the <emphasis> + <property moreinfo="none">Overview</property> + </emphasis> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</para> + + <figure float="0"> + <title>The Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para> Here, we dwell on the JBDS <property moreinfo="none">Properties view</property>.</para> + <para>Notice if it's not visible you can access it by navigating <emphasis> + <property moreinfo="none">Window > Show view > Properties</property>. </emphasis></para> + <para>The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</para> + + <figure float="0"> + <title>The Properties View of selected Transition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to <emphasis> + <property moreinfo="none">to_auction</property>. </emphasis> We've done it directly in + active General tab of the view. The same way let's change the name for the + second transition to <emphasis> + <property moreinfo="none">to_end</property>. </emphasis></para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + + <figure float="0"> + <title>The Properties View of Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In this case, it contains six tabs. The first one is the <emphasis> + <property moreinfo="none">General</property>.</emphasis> It allows to specify a process name and add + necessary description. To illustrate let's change the process definition name + to <emphasis> + <property moreinfo="none">jbay</property>. </emphasis></para> + </section> + + <section id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title>The jBPM Graphical Process Designer editor.</title> + <para>The <property moreinfo="none">jBPM GPD editor</property> includes four modes: Diagram, Deployment, + Design and Source, which are available as switchable tabs at the bottom of the editor. + Let's dwell on each of them.</para> + + <section id="the_diagram_mode"> + <title>The Diagram mode</title> + <para> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hand side of the jBPM GPD. </para> + + <figure float="0"> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the <property moreinfo="none">Diagram + mode</property> of the graphical editor. One example of this is the <emphasis> + <property moreinfo="none">name</property> + </emphasis> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to <emphasis> + <property moreinfo="none">auction</property>. </emphasis></para> + </section> + + <section id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source Mode</title> + <para>Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML click on the Source + tab of the graphical process designer editor.</para> + + <figure float="0"> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>The <property moreinfo="none">Source mode</property> enables to easily manipulate our XML. That is + manually inserting and editing necessary elements or attributes. In addition, here + you can take advantage of content assist.</para> + </section> + + <section id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design Mode</title> + <para>One more way to edit your file is to use <property moreinfo="none">Design mode</property>. You can + see it in the next picture:</para> + <figure float="0"> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_7.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</para> + <para>For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose <emphasis> + <property moreinfo="none">Add Before > Comment</property>. </emphasis></para> + + <figure float="0"> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>Then, we can put the text <emphasis>This transition leads to the end + state</emphasis> in the right column as its value.</para> + + <figure float="0"> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_9.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment Mode</title> + <para>Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the <property moreinfo="none">Deployment mode</property>. On the picture below + the <property moreinfo="none">Deployment mode</property> is performed with default settings. Here, + you can easily modify them or, if the settings won't match your needs, to + reset defaults. </para> + <figure float="0"> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_10.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The button <emphasis> + <property moreinfo="none">Test Connections</property> + </emphasis> is necessary to make sure whether all your settings are valid before + deploying the process.</para> + <para>Now that we've seen how to work with <property moreinfo="none">jPDL + perspective</property>, let's pass on to the project testing.</para> + </section> + </section> +</chapter> + +<chapter id="Test_Drive_Proc_Development" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml" xreflabel="Test_Drive_Proc_Development"> + <?dbhtml filename="Test_Drive_Proc_Development.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Test Driven Process Development</title> + + <para> One of the most important advantages of JBoss jBPM's lightweight approach to BPM + and workflow management is that developers can easily leverage their usual programming + skills and techniques. One of these well-known techniques is Unit Testing and Test Driven + Development. </para> + <para>In this chapter we will show how developers, making use of the JBoss jBPM GPD, can use a + technique we have baptized <property moreinfo="none">Test Driven Process Development</property> to create + process definitions and test their correctness. </para> + + <para> When creating the <emphasis> + <property moreinfo="none">HellojBPM</property> + </emphasis> project the Project Creation wizard has already put in place all the library + requirements we need to start writing the jBPM unit tests. They are contained in the jBPM + Library container and the most important of them is the <emphasis> + <property moreinfo="none">.jar</property> + </emphasis> file containing the core jBPM classes. While working on the project you could + find them all in the <property moreinfo="none">Package Explorer</property>.</para> + + <figure float="0"> + <title>The jBPM Libraries</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>It must be noted that it is possible to change the location of the core jBPM installation + by changing the preference settings. More on this <link linkend="change_core_jbpm_inst">see + later</link> in this book.</para> + + <para> With that extra knowledge on the project settings, you can create your first test. To do + this, we create the <emphasis> + <property moreinfo="none">com.jbay</property> + </emphasis> package in the <emphasis> + <property moreinfo="none">test/java</property> + </emphasis> source folder. Then we bring up the context menu on this package and select <emphasis> + <property moreinfo="none">New > Other...</property> + </emphasis></para> + + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_2.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> And then <emphasis> + <property moreinfo="none">Java > JUnit > JUnit Test Case</property> + </emphasis> to call the specialized JUnite Test case creation wizard.</para> + <figure float="0"> + <title>Call the JUnit Test Case Creation wizard</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_3.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The wizard looks as follows:</para> + + <figure float="0"> + <title>Create Test Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_4.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>By default JUnite 3 version of testing framework is selected. Of course, you can choose + new advanced JUnit 4 version. In this case you'll be prompted to add new JUnit + Library to your build path. To add it automatically just click on the appropriate link. In + the <emphasis> + <property moreinfo="none">Class under test</property> + </emphasis> section you can specify the class to test.</para> + + <figure float="0"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_5.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Then, we call the test class <emphasis> + <property moreinfo="none">HelloTest</property> + </emphasis> and press <emphasis> + <property moreinfo="none">Finish</property> + </emphasis> button to complete.</para> + + <para> Next, we should write a simple test scenario as shown on the next figure. Let's + study the code of this test case. </para> + + <figure float="0" id="hello_test"> + <title>A First Test Scenario</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_6.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In the first line of the method, a jBPM process archive object is created. We use a + constructor accepting the filename of the archive. In our case it is the <emphasis> + <property moreinfo="none">hello</property> + </emphasis> file we created earlier and which lives in the <emphasis> + <property moreinfo="none">src/main/jpdl</property> + </emphasis> folder of our project. After asserting that this object is really created, we + extract a process definition object from it. This object is fed to the constructor of a + process instance object. We have a process instance object, but this process is not yet + started, so we can safely assert that its root token still resides in the start node. After + signalling the token will move to the next state and the process will be in the <emphasis> + <property moreinfo="none">auction</property> + </emphasis> state. Finally another signal will end the process. </para> + + + <para> After writing this test we can check whether it works as expected by running it .</para> + + <figure float="0"> + <title>Running the Process Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_7.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>All went well as we have a green light:</para> + + <figure float="0"> + <title>Successful Test Run</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Test_Drive_Proc/test_driv_proc_8.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Of course, this simple scenario was not very interesting, but the purpose of it was to + show how you can reuse your development skills in a very straightforward way when doing + process development. To see how more interesting processes and process test + scenario's can be developed, we suggest you to read the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink> and to + study the API reference. You can find it in the jBPM download folder. (To get started we + downloaded jbpm-jpdl-3.2.2 in <link linkend="jboss_jbpm_runtime_installation">the second + chapter</link>. You should just remember where you extracted it.) All we've mentioned are in the 'javadoc- *' subfolders of the 'doc' folder. + Moreover, some more examples will be given later in this book.</para> + +</chapter> + + +<chapter id="The_JBoss_jBPM_Int_Mech" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml" xreflabel="The_JBoss_jBPM_Int_Mech"> + <?dbhtml filename="The_JBoss_jBPM_Int_Mech.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Actions : The JBoss jBPM Integration Mechanism</title> + + <para> In this chapter we will show how to do software integration with <property moreinfo="none">JBoss + jBPM</property>. The standard mechanism to implement this is to wrap the functionality you + want to integrate in a class that implements the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface. In order to demonstrate it let's specify Hello World action for our + process.</para> + + <section> + <title>Creating a Hello World Action</title> + + <para>Each Hello World process should integrate one or more Hello World actions, so this is + what we will be doing. We can integrate custom code at different points in the process + definition. To do this we have to specify an action handler, represented by an + implementation of the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface, and attach this piece of code to a particular event. These events + are amongst others, going over a transition, leaving or entering nodes, after and before + signalling. </para> + + <para> To make things a little bit more concrete, let's create a new class called <emphasis> + <property moreinfo="none">HelloActionHandler</property>. + </emphasis> For that firstly we'll create a new package <emphasis> + <property moreinfo="none">com.jbay.action</property> + </emphasis> in the <emphasis> + <property moreinfo="none">src/java/main</property> + </emphasis> folder of our project. Then, we should call New Class Creation wizard as + usual by right-clicking and navigating <emphasis> + <property moreinfo="none">New > Class</property>. + </emphasis> </para> + + <figure float="0"> + <title>Creating HelloActionHendler Class</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Notice that two first gaps have been filled automatically. Here, instead of <emphasis> + <property moreinfo="none">Package</property> + </emphasis> option <emphasis> + <property moreinfo="none">Enclose type</property> + </emphasis> option can be selected where a type in which to enclose a new class should + be specified.</para> + + <para>In our case, we leave everything as it is, just type <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> as a name of new class and add <emphasis> + <property moreinfo="none">org.jbpm.graph.ActionHendler</property> + </emphasis> interface as it's shown in the picture above.</para> + + <para>Thus, our <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> implements the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> interface including the <emphasis> + <property moreinfo="none">execute</property> + </emphasis> method as shown in the next figure. Here, we add a variable named <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> to the collection of process variables and put a message in it : + <emphasis>"Hello from ActionHandler"</emphasis>. </para> + + <figure float="0"> + <title>A Simple Hello Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, as we have <emphasis> + <property moreinfo="none">HelloActionHandler</property> + </emphasis> class defined, let's explore how we can handle it.</para> + </section> + + <section> + <title>Integrating the Hello World Action</title> + + <para>The main purpose of this chapter is to provide you with the steps associating our + Hello World action with a particular event and test the correctness of our actions as + well.</para> + + <para> As good Testcity citizens we will first create a Unit Test that proves the behaviour + we want to achieve by adding the <emphasis> + <property moreinfo="none">ActionHandler</property> + </emphasis> to the process. So we implement another test.</para> + + <para>At first, let's return to the + code we already saw <link linkend="hello_test">in the previous chapter</link> and add new test method <emphasis> + <property moreinfo="none">testActionHendler</property></emphasis> to it. </para> + + <figure float="0"> + <title>Create the Hello Action Test</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_3.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>We assert + that no variable called <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> exist. Then we give the process a signal to move it to the auction state. We + want to associate the execution of the action with the event of going over the + transition from the start state to the auction state. So after the signal, the process + should be in the auction state as in the previous scenario. But moreover, the <emphasis> + <property moreinfo="none">greeting</property> + </emphasis> variable should exist and contain the string <emphasis>"Hello from + ActionHandler"</emphasis>. That's what we assert in the last lines of the test + method.</para> + + + + <para> Running the tests now results in a failure. The point is that we did not associate + the action with any particular event in the process definition, so the process variable + did not get set. </para> + + <figure float="0"> + <title>Test Results Before Integration</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_4.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para> Let's do something about it and add an action to the first transition of our + sample process. To do this you can use the Actions tab in the Properties Editor that is + under the graphical canvas. Bring up the popup menu of the action element container and + chose New Action as it's shown on the figure below. The other way to add an action + to the transition is simply to use the dropdown menu that is available under the action + icon in the right upper corner of the Properties View.</para> + + <figure float="0"> + <title>Adding an Action to a Transition</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>After adding the action a tabbed view with three pages will appear.</para> + + <figure float="0"> + <title>Configuration Dialog for an Action</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The first of these three pages allows you to give the Action a name. The last page + contains some advanced attributes such as whether the Action is asynchronous. The + Details page is the most important. It allows to choose and configure the actual action + handler implementation. </para> + + <figure float="0"> + <title>The Details page of an Action Configuration Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para>Clicking on the <emphasis> + <property moreinfo="none">Search...</property> + </emphasis> button brings us to a Choose Class dialog.</para> + + + <figure float="0"> + <title>The Choose Action Handler Dialog</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_8.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + + + <para> We choose our previously created 'HelloActionHandler' class and + push the <property moreinfo="none">OK</property> button. After the selection of the action handler for + the action, we can run the test and observe it gives us a green light.</para> + + <figure float="0"> + <title>Test Results</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/The_JBoss_jBPM_Int_Mech/jboss_jbpm_int_mech_9.png" scale="70"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>There we are. The above objective has been achieved.</para> + </section> + + <section> + <title> Integration Points</title> + + <para> The different integration points in a process definition are thoroughly documented in + the <ulink url="http://docs.jboss.com/jbpm/v3/userguide/">JBoss jBPM User Guide</ulink>. Instance nodes can contain many action + elements. Each of these will appear in the Action element list of the Actions tab. But + each Action also has a properties view of itself. You can navigate to this view by + selecting the added Action in the outline view. </para> + + </section> + +</chapter> + + +<chapter id="Quick_Howto_Guide" xml:base="file:///home/vchukhutsina/repos/ochik_jboss/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml" xreflabel="Quick_Howto_Guide"> + <?dbhtml filename="Quick_Howto_Guide.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + <keyword></keyword> + </keywordset> + </chapterinfo> + <title>Quick Howto Guide</title> + + <para>This chapter contains additional information related to the <property moreinfo="none">JBoss + jBPM</property>.</para> + + <section id="change_core_jbpm_inst"> + <title>Change the Default Core jBPM Installation</title> + + <para> You can change the default <property moreinfo="none">jBPM</property> installation by means of the + Eclipse preference mechanism. Open the Preferences dialog by selecting <emphasis> + <property moreinfo="none">Window > Preferences</property> + </emphasis> and select the <emphasis> + <property moreinfo="none">JBoss jBPM > Runtime Location</property> + </emphasis> category. Using this page you can add multiple <property moreinfo="none">jBPM</property> + installation locations and change the default one. The default installation is used for + the classpath settings when creating a new Process Project. Changing the preferences has + no influence on already created projects. Getting rid of a <property moreinfo="none">jBPM</property> + installation that's being referenced by a project however will cause the + classpath to contain errors. </para> + + + <figure float="0"> + <title>The jBPM Preferences Page</title> + + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_1.png"></imagedata> + </imageobject> + </mediaobject> + </figure> + </section> + + <section> + <title>Configuring Task Nodes</title> + + <para>Here, we'll examine how you can configure the Task nodes in jBPM jPDL GPD.</para> + + <para> You can add Tasks to Task nodes and then configure them in a similar manner as the + Action configuration mechanism. Let's consider the process definition similar + to the previous one that contains three nodes: Start state, Task node and End state. The + <property moreinfo="none">Properties view</property> for selected Task node includes several tabs. </para> + + <figure float="0"> + <title>The Properties View of the selected Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_2.png" scale="75"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>We should choose the Task tab and then bring up the context menu or click the button + in the top right corner of the view to add a Task to our Task node.</para> + + <figure float="0"> + <title>Adding a Task to the Task Node</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_3.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Every added Task has its own configuration possibilities. You can access them through + the <property moreinfo="none">Properties view</property> as well.</para> + + <figure float="0"> + <title>The Task properties</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_4.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>The <property moreinfo="none">General page</property> is a place where you can specify the name of a + Task and its description. For instance, let it be <emphasis> + <property moreinfo="none">approve oder</property> + </emphasis> with appropriate description that you can see in the figure below.</para> + + <figure float="0"> + <title>The Task General Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_5.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>Now, look at <property moreinfo="none">Details page</property>. First, you should specify the due date + that is a mandatory property for the Task. The due date is the date on which the task + should be accomplished. Here you can also set a Task priority as well as signalling, + notifying or blocking. The <emphasis> + <property moreinfo="none">Blocking</property> + </emphasis> attribute indicates that the process will not be able to continue if this + task is still unaccomplished. The <emphasis> + <property moreinfo="none">Generate Form...</property> + </emphasis> button is for creating a simple task form that can be rendered by the jBPM + console.</para> + + <figure float="0"> + <title>The Task Details Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_6.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>For our example, we specify the due date as 2 business days, choose the high priority + and also check the <emphasis> + <property moreinfo="none">Signalling</property> + </emphasis> and <emphasis> + <property moreinfo="none">Notify</property> + </emphasis> attributes. It means that the Task should be accomplished in 2 business days + and the assignee will be notified by email when the task is assigned. To specify how the + Task should be assigned switch on to the <property moreinfo="none">Assignment page</property>.</para> + + <figure float="0"> + <title>The Task Assignment Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_7.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>On the <property moreinfo="none">Reminder page</property> you can specify whether the assignee will be reminded of the task + that awaits him.</para> + + <figure float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_8.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + + <para>In our case, the assignee will be reminded by email after two business hours and + continue to get reminding every business hour after that.</para> + <para>In the next figure you can see our configuring generated into XML.</para> + <figure float="0"> + <title>The Task Reminder Page</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/Quick_Howto_Guide/quick_howto_guide_9.png" scale="80"></imagedata> + </imageobject> + </mediaobject> + </figure> + <para>We hope, our guide will help you to get started with the jPDL process language and jBPM + workflow on the whole. Besides, for additional information you are welcome on + <ulink url="http://www.jboss.com/index.html?module=bb&op=viewforum&f=201">JBoss forum</ulink>.</para> + </section> +</chapter> + + +  +</book> Added: trunk/jbpm/docs/reference/en-US/the_views.xml =================================================================== --- trunk/jbpm/docs/reference/en-US/the_views.xml (rev 0) +++ trunk/jbpm/docs/reference/en-US/the_views.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,230 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter id="the_views" xreflabel="the_views"> + <?dbhtml filename="the_views.html"?> + <chapterinfo> + <keywordset> + <keyword>jBPM</keyword> + </keywordset> + </chapterinfo> + + <title>The views</title> + + <para>Here, it will be explained how to work with views and editors provided by JBDS.</para> + <para>The views are used for representation and navigation the resources you are working on at + the moment. One of the advantages of all the views is that all modifications made in the + current active file are immediately displayed in them. Let’s get acquainted more closely + with those that the <property>jPDL perspective</property> provides. </para> + + <figure> + <title>The jPDL Perspective Views and Editors</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_0.png" scale="80"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see in the picture above, the <property>jPDL perspective</property> contains a + complete set of functionality that's necessary for working on the jBPM project.</para> + + <section id="the_outline_view"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Outline View</title> + <para>To have a way to quickly see an outline of the process use the <emphasis> + <property>Outline view</property> + </emphasis> that is presented as the classical tree. If it is not visible select <emphasis> + <property>Window > Show view > Outline</property>. </emphasis></para> + + <figure> + <title>The Overview View</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_1.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_overview"> + <?dbhtml filename="the_outline_view.html"?> + <title>The Overview</title> + <para>The main advantage of this view is that it gives visual representation of the whole + current developing process. Besides, the <emphasis> + <property>Overview</property> + </emphasis> comes as a scrollable thumbnail which enables a better navigation of the + process structure if it's too large.</para> + + <figure> + <title>The Overview</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_2.png"/> + </imageobject> + </mediaobject> + </figure> + </section> + + <section id="the_properties_view"> + <?dbhtml filename="the_properties_view.html"?> + <title>The Properties View</title> + <para> Here, we dwell on the JBDS <property>Properties view</property>.</para> + <para>Notice if it's not visible you can access it by navigating <emphasis> + <property>Window > Show view > Properties</property>. </emphasis></para> + <para>The view shows the relevant properties of the selected item in the tabbed form. Every + item has its own set of properties, which can be directly editable in the Properties + view or by brining up the context menu.</para> + + <figure> + <title>The Properties View of selected Transition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_3.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>For example, on the picture above the Properties view displays all the properties for + a selected transition. Its name has been changed to <emphasis> + <property>to_auction</property>. </emphasis> We've done it directly in + active General tab of the view. The same way let's change the name for the + second transition to <emphasis> + <property>to_end</property>. </emphasis></para> + <para>If no one item is selected, the view represents the properties of the whole process + definition. </para> + + <figure> + <title>The Properties View of Process Definition</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_4.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>In this case, it contains six tabs. The first one is the <emphasis> + <property>General</property>.</emphasis> It allows to specify a process name and add + necessary description. To illustrate let's change the process definition name + to <emphasis> + <property>jbay</property>. </emphasis></para> + </section> + + <section id="jbpm_gpd_editor"> + <?dbhtml filename="direct_editing.html"?> + <title>The jBPM Graphical Process Designer editor.</title> + <para>The <property>jBPM GPD editor</property> includes four modes: Diagram, Deployment, + Design and Source, which are available as switchable tabs at the bottom of the editor. + Let's dwell on each of them.</para> + + <section id="the_diagram_mode"> + <title>The Diagram mode</title> + <para> In this mode we define the process in the form of a diagram by means of tools + provided on the left-hand side of the jBPM GPD. </para> + + <figure> + <title>The Diagram mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_5.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>Besides, some properties can be directly edited in the <property>Diagram + mode</property> of the graphical editor. One example of this is the <emphasis> + <property>name</property> + </emphasis> property of nodes. You can edit this directly by selecting the node of + which you want to change the name and then click once inside this node. This enables + an editor in the node. We change the name of the node to <emphasis> + <property>auction</property>. </emphasis></para> + </section> + + <section id="source_mode"> + <?dbhtml filename="the_source_view.html"?> + <title>The Source Mode</title> + <para>Now, that we have defined a simple process definition, we can have a look at the + XML that is being generated under the covers. To see this XML click on the Source + tab of the graphical process designer editor.</para> + + <figure> + <title>The Source Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_6.png"/> + </imageobject> + </mediaobject> + </figure> + <para>The <property>Source mode</property> enables to easily manipulate our XML. That is + manually inserting and editing necessary elements or attributes. In addition, here + you can take advantage of content assist.</para> + </section> + + <section id="design_mode"> + <?dbhtml filename="the_design_view.html"?> + <title>The Design Mode</title> + <para>One more way to edit your file is to use <property>Design mode</property>. You can + see it in the next picture:</para> + <figure> + <title>The Design Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_7.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>As you can see above, this mode looks like a table in the first column of which + the process structure is performed. Here, you can also insert, remove and edit + elements or attributes, moreover add comments and instructions. Their values can be + directly edited in the second column of the Design mode table.</para> + <para>For instance, let’s add a comment on the second transition. For that, you should + bring up the context menu for it and choose <emphasis> + <property>Add Before > Comment</property>. </emphasis></para> + + <figure> + <title>Adding a Comment</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_8.png"/> + </imageobject> + </mediaobject> + </figure> + <para>Then, we can put the text <emphasis>This transition leads to the end + state</emphasis> in the right column as its value.</para> + + <figure> + <title>Comment is added</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_9.png"/> + </imageobject> + </mediaobject> + </figure> + + </section> + + <section id="deployment_mode"> + <?dbhtml filename="the_deployment_view.html"?> + <title>The Deployment Mode</title> + <para>Finally, to adjust the deployment settings of the project you should switch on to + the tab that opens the <property>Deployment mode</property>. On the picture below + the <property>Deployment mode</property> is performed with default settings. Here, + you can easily modify them or, if the settings won't match your needs, to + reset defaults. </para> + <figure> + <title>The Deployment Mode</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/the_views/the_views_10.png"/> + </imageobject> + </mediaobject> + </figure> + + <para>The button <emphasis> + <property>Test Connections</property> + </emphasis> is necessary to make sure whether all your settings are valid before + deploying the process.</para> + <para>Now that we've seen how to work with <property>jPDL + perspective</property>, let's pass on to the project testing.</para> + </section> + </section> +</chapter> Modified: trunk/jbpm/docs/reference/pom.xml =================================================================== --- trunk/jbpm/docs/reference/pom.xml 2010-02-28 09:59:15 UTC (rev 20536) +++ trunk/jbpm/docs/reference/pom.xml 2010-03-01 03:18:59 UTC (rev 20537) @@ -85,9 +85,9 @@ </dependencies> <configuration> <sourceDocumentName>${master}</sourceDocumentName> - <sourceDirectory>${pom.basedir}/en</sourceDirectory> + <sourceDirectory>${pom.basedir}/en-US</sourceDirectory> <imageResource> - <directory>${pom.basedir}/en</directory> + <directory>${pom.basedir}/en-US</directory> <includes> <include>images/**/*</include> </includes> Added: trunk/jbpm/docs/reference/publican.cfg =================================================================== --- trunk/jbpm/docs/reference/publican.cfg (rev 0) +++ trunk/jbpm/docs/reference/publican.cfg 2010-03-01 03:18:59 UTC (rev 20537) @@ -0,0 +1,7 @@ +# Config::Simple 4.59 +# Fri Nov 20 13:19:45 2009 + +xml_lang: en-US +type: Book +brand: JBoss +

14 years, 10 months

1
0
0 / 0

← Newer
1
...
61
62
63
64
Older →

Jump to page:

2024

2023

2022

2021

2020

2019

2018

2017

2016

2015

2014

2013

2012

2011

2010

2009

2008

2007

jbosstools-commits March 2010