[jbosstools-commits] JBoss Tools SVN: r5296 - trunk/jbpm/docs/reference/en/modules.

Author: ochikvina Date: 2007-12-14 07:03:37 -0500 (Fri, 14 Dec 2007) New Revision: 5296 Modified: trunk/jbpm/docs/reference/en/modules/Introduction.xml trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml Log: http://jira.jboss.com/jira/browse/JBDS-143 - adding transition sentences Modified: trunk/jbpm/docs/reference/en/modules/Introduction.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Introduction.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/Introduction.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -33,8 +33,7 @@ - <para> JBoss jBPM is a workflow that enable creating and - automatization business processes. Look at the list of features below. + <para> JBoss jBPM is a workflow that enables creating and automatization business processes. Look at the list of features below. </para> <table> <title>Key Functionality for JBoss jBPM</title> @@ -48,48 +47,45 @@ <tbody> <row> - <entry>jBDL support</entry> - <entry>Enable managing workflow processes as well as human tasks and interactions between them. - jBDL combines the best both Java and declarative process techniques. Look <link linkend="minimal_process_definition">here.</link></entry> + <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>Support of Graphical Process Designer (GPD)</entry> - <entry>For simplifying declarative process development and visualizations of all actions. Look <link linkend="GuidedTourJBossjBPMGPD">here.</link></entry> + <entry><link linkend="GuidedTourJBossjBPMGPD">Support of Graphical Process Designer (GPD)</link></entry> + <entry>For simplifying declarative process development and visualizations of all actions.</entry> </row> <row> - <entry>Project Creation wizard</entry> - <entry>Allows to create a new jBPM template project that already includes all advanced artifacts and core jBPM libraries. - Look <link linkend="CreatingjBPMProject">here.</link></entry> + <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>Rich palette of pre-build process nodes</entry> - <entry>Provides process-building functionality and gives opportunity even non-programmers to develop processes. - Look <link linkend="minimal_process_definition">here.</link></entry> + <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>Support of XML code view</entry> - <entry>Corresponding XML is generated automatically in the Source view of the process definition editor - when developing the process. Look <link linkend="the_source_view">here.</link></entry> + <entry><link linkend="the_source_view">Support of XML code view</link></entry> + <entry>Corresponding XML is generated automatically in the Source view of the process definition editor when developing the process.</entry> </row> <row> - <entry>Properties view</entry> - <entry>Facilitates configuring and editing of all nodes properties. Look <link linkend="the_properties_view">here.</link></entry> + <entry><link linkend="the_properties_view">Properties view</link></entry> + <entry>Facilitates configuring and editing of all nodes properties.</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> + <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> + <entry>Allows to write applications with complex workflows and provides easier interactions between them.</entry> </row> </tbody> Modified: trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/Quick_Howto_Guide.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -12,6 +12,7 @@ </chapterinfo> <title>Quick Howto Guide</title> + <para>This chapter contains additional information related to the <property>JBoss jBPM</property>.</para> <section> <title>Change the Default Core jBPM Installation</title> Modified: trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/Test_Drive_Proc.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -11,11 +11,12 @@ </keywordset> </chapterinfo> <title>Test Driven Process Development</title> - + <para> One of the most important advantages of JBoss jBPM&apos;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. In this chapter we will show how developers, making use of the JBoss jBPM GPD + 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> Modified: trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/The_JBoss_jBPM_Int_Mech.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -16,12 +16,12 @@ jBPM</property>. The standard mechanism to realize this is to wrap the functionality you want to integrate in a class that implements the <emphasis> <property>ActionHandler</property> - </emphasis> interface. </para> + </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 process should integrate one or more hello actions, so this is what we + + <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> @@ -65,13 +65,17 @@ <section> <title>Integrating the Hello World Action</title> + + <para>The main purpose of this chapter is to provide you with the steps to associate + 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 + <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. Creating the process instance is code we already saw in the previous chapter. We assert that no variable called - greeting exist. Then we give the process a signal to move it to the first state. We want + <emphasis> + <property>greeting</property></emphasis> exist. Then we give the process a signal to move it to the first state. We want to associate the execution of the action with the event of going over the transition from the start state to the first state. So after the signal, the process should be in the first state as in the previous scenario. But moreover, the <emphasis> @@ -179,7 +183,7 @@ </mediaobject> </figure> - + <para>Tere we are. The above objective has been achieved.</para> </section> <section> Modified: trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/guided_tour_jboss_jbpmgpd.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -10,7 +10,7 @@ </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 editing your own + <para>In this chapter we suggest a step-by-step walk-through of creating and configuring your own simple process. Let’s start with organizing 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 @@ -174,7 +174,7 @@ <section id="adding_transitions"> <?dbhtml filename="adding_transitions.html"?> <title>Adding Transitions</title> - <para>Then we will connect the nodes with transitions. For that select the <emphasis> + <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> @@ -197,128 +197,8 @@ </figure> </section> </section> - <para>Now the simple process is already defined and we can examine it more carefully. For + <para>As the simple process is already defined, we can examine it more carefully. For that JBDS provides a number of multiple editors and viewes.</para> </section> - <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 JBDS Outline view. If it is not - visible select <emphasis> - <property>Window &gt; Show view &gt; Outline</property> - </emphasis>. It is presented as the classical tree view. Also you can use <emphasis> - <property>Overview</property> - </emphasis> that comes as a scrollable thumbnail.</para> - <figure> - <title>The Outline and Overview Views</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour9.png" - scale="75"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="the_properties_view"> - <?dbhtml filename="the_properties_view.html"?> - <title>The Properties View</title> - <para>If the JBDS Properties view is visible (if not select <emphasis> - <property>Window &gt; Show view &gt; Properties</property> - </emphasis>), the relevant properties of the selected item are shown. Some of these - properties may be directly editable in the properties view. An example of a directly - editable property is the name property of the process definition. As you can see in the - next figure, the name property of the process definition can be changed to <emphasis> - <property>jbay</property> - </emphasis>. You can also write a description for this property.</para> - <figure> - <title>The Properties of a Process Definition</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour10.png"/> - </imageobject> - </mediaobject> - </figure> - <para>Let&apos;s change the name of the first transition to <emphasis> - <property>to_auction</property> - </emphasis>. We repeat this name change for the second transition and name it <emphasis> - <property>to_end</property> - </emphasis>.</para> - <figure> - <title>Transitions Names</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour11.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - - - <section id="direct_editing"> - <?dbhtml filename="direct_editing.html"?> - <title>Direct Editing</title> - <para>Some properties can be directly edited in 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> - <figure> - <title>Directly Editing the Node Name</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour12.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="the_source_view"> - <?dbhtml filename="the_source_view.html"?> - <title>The Source View</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 process definition editor.</para> - <figure> - <title>The Source View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour13.png"/> - </imageobject> - </mediaobject> - </figure> - <para>This source tab is editable, so if you know your way around in jpdl, you can create or - tweak your process definitions directly in the xml source.</para> - </section> - <section id="the_design_view"> - <?dbhtml filename="the_design_view.html"?> - <title>The Design View</title> - <para>The file is also editable in <emphasis> - <property>Design</property> - </emphasis> view as you can see in the next picture:</para> - <figure> - <title>The Design View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour14.png"/> - </imageobject> - </mediaobject> - </figure> - </section> - <section id="the_deployment_view"> - <?dbhtml filename="the_deployment_view.html"?> - <title>The Deployment View</title> - <para>The deployment settings of the project you can configure in <emphasis> - <property>Deployment</property> - </emphasis> view.</para> - <figure> - <title>The Deployment View</title> - <mediaobject> - <imageobject> - <imagedata fileref="images/guided_tour_jboss_jbpmgpd/guided_tour15.png"/> - </imageobject> - </mediaobject> - </figure> - </section> + </chapter> Modified: trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml =================================================================== --- trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml 2007-12-14 12:03:17 UTC (rev 5295) +++ trunk/jbpm/docs/reference/en/modules/jboss_jbpm_runtime_installation.xml 2007-12-14 12:03:37 UTC (rev 5296) @@ -1,28 +1,39 @@ <?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> + <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 jBPM plugin (jBPM Designer) is already included in JBDS. To make it work, you should only download the jBPM runtime (jbpm-jpdl-3.2.2 currently) from <ulink url="http://labs.jboss.com/jbossjbpm/downloads/">here</ul... and specify the -directory where you extracted the runtime either when you create a jBPM project or by using the jBPM preference pages.</para> - <para>Navigate to <emphasis><property>Window &gt; Preferences &gt; JBoss jBPM &gt; Runtime Locations</property></emphasis>. Here you can add, edit and remove JBoss jBPM installation locations.</para> - <para>Click <emphasis><property>Add</property></emphasis> button. In the diallog 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> - + <para>The main purpose of this chapter is to let you know how to launch the <property>JBoss + jBPM</property>.</para> + <para>The jBPM plugin (jBPM Designer) is already included in JBDS. To make it work, you should only + download the jBPM runtime (jbpm-jpdl-3.2.2 currently) from <ulink + url="http://labs.jboss.com/jbossjbpm/downloads/">here</ul... and specify the directory where you + extracted the runtime either when you create a jBPM project or by using the jBPM preference pages.</para> + <para>Navigate to <emphasis> + <property>Window &gt; Preferences &gt; JBoss jBPM &gt; Runtime Locations</property> + </emphasis>. Here you can add, edit and remove JBoss jBPM installation locations. Click <emphasis> + <property>Add</property> + </emphasis> button. In the diallog 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_installation1.png"/> - </imageobject> -</mediaobject> -</figure> + <title>Adding jBPM Location</title> + <mediaobject> + <imageobject> + <imagedata fileref="images/runtime_installation/runtime_installation1.png"/> + </imageobject> + </mediaobject> + </figure> </chapter> -