[jbpm-commits] JBoss JBPM SVN: r3858 - in jbpm3/trunk/modules/userguide: src/main/docbook/en and 2 other directories.

Author: alex.guizar(a)jboss.com Date: 2009-02-12 17:54:24 -0500 (Thu, 12 Feb 2009) New Revision: 3858 Added: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/create_connection.png jbpm3/trunk/modules/userguide/src/main/docbook/en/images/execute_script.png jbpm3/trunk/modules/userguide/src/main/docbook/en/images/load_script.png Removed: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/create_connection.jpg jbpm3/trunk/modules/userguide/src/main/docbook/en/images/execute_script.jpg jbpm3/trunk/modules/userguide/src/main/docbook/en/images/install_driver.jpg jbpm3/trunk/modules/userguide/src/main/docbook/en/images/load_script.jpg Modified: jbpm3/trunk/modules/userguide/pom.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/master.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/async.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/context.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/database.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/introduction.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/mail.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/modelling.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/persistence.xml jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/tutorial.xml Log: JBPM-1808: remove references to dbvisualizer and replace related images with pgadmin screenshots fix many broken links Modified: jbpm3/trunk/modules/userguide/pom.xml =================================================================== --- jbpm3/trunk/modules/userguide/pom.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/pom.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -47,8 +47,9 @@ <imageResource> <directory>${basedir}/src/main/docbook/en</directory> <includes> - <include>**/*.gif</include> - <include>**/*.jpg</include> + <include>images/*.gif</include> + <include>images/*.jpg</include> + <include>images/*.png</include> </includes> </imageResource> <formats> Deleted: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/create_connection.jpg =================================================================== (Binary files differ) Added: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/create_connection.png =================================================================== (Binary files differ) Property changes on: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/create_connection.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/execute_script.jpg =================================================================== (Binary files differ) Added: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/execute_script.png =================================================================== (Binary files differ) Property changes on: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/execute_script.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Deleted: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/install_driver.jpg =================================================================== (Binary files differ) Deleted: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/load_script.jpg =================================================================== (Binary files differ) Added: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/load_script.png =================================================================== (Binary files differ) Property changes on: jbpm3/trunk/modules/userguide/src/main/docbook/en/images/load_script.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/master.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/master.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/master.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -21,7 +21,7 @@ <!ENTITY security SYSTEM "modules/security.xml"> <!ENTITY tdd SYSTEM "modules/tdd.xml"> <!ENTITY pluggable SYSTEM "modules/pluggable.xml"> -<!ENTITY version "3.2.3"> +<!ENTITY version "3.2.6.GA"> ]> <book lang="en"> <bookinfo> Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/async.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/async.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/async.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -1,14 +1,14 @@ <chapter id="ch_asynchronouscontinuations"> <title>Asynchronous continuations</title> - <section id="theconcept"> + <section id="asynchronouscontinuations"> <title>The concept</title> <para>jBPM is based on Graph Oriented Programming (GOP). Basically, GOP specifies a simple state machine that can handle concurrent paths of execution. But in the execution algorithm specified in GOP, all state transitions are done in a single operation in the - thread of the client. If you're not familiar with the execution algorithm defined in - <xref linkend="graphorientedprogramming" />, please read that first. By default, this + thread of the client. + By default, this performing state transitions in the thread of the client is a good approach cause it fits naturally with server side transactions. The process execution moves from one wait state to another wait state in one transaction. @@ -21,7 +21,7 @@ </para> </section> - <section id="anexample"> + <section id="asynchronousexample"> <title>An example</title> <para>Normally, a node is always executed after a token has entered the node. So the node is Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/context.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/context.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/context.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -90,7 +90,7 @@ <title>Variables scopes</title> <para>Each path of execution (read: token) has its own set of process variables. Requesting a variable is always done on a token. Process instances have a tree - of tokens (see <xref linkend="graphorientedprogramming"/>). + of tokens. When requesting a variable without specifying a token, the default token is the root token. </para> Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/database.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/database.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/database.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -57,29 +57,14 @@ </mediaobject> </figure> - <para>After the installation of the database, we can use a database - viewer tool like DBVisualizer to look at the contents of the database. - Before you can define a database connection with DBVisualizer, you might - have to add the PostgreSQL JDBC driver to the driver manager. Select - 'Tools-&gt;Driver Manager...' to open the driver manager window. Look at - the figure below for an example of how to add the PostgreSQL JDBC - driver.</para> + <para>After the installation of the database, we can use the pgAdmin III + Query tool to look at the contents of the database.</para> - <figure> - <title>Adding the JDBC driver to the driver manager</title> - - <mediaobject> - <imageobject> - <imagedata fileref="images/install_driver.jpg" /> - </imageobject> - </mediaobject> - </figure> - - <para>Now everything is set to define a database connection in - DBVisualizer to our newly created database. We will use this tool + <para>Before we do, we have to define a database connection in + pgAdmin to our newly created database. We will use this tool further in this document to make sure the creation scripts and process deployment are working as expected. For an example of creating the - connection in DBVisualizer we refer to the following figure. As you can + connection in pgAdmin we refer to the following figure. As you will see, there are no tables present yet in this database. We will create them in the following section.</para> @@ -88,7 +73,7 @@ <mediaobject> <imageobject> - <imagedata fileref="images/create_connection.jpg" /> + <imagedata fileref="images/create_connection.png" /> </imageobject> </mediaobject> </figure> @@ -120,7 +105,7 @@ </section> <section> - <title>Creating the JBoss jBPM Database with your new PostGreSQL or + <title>Creating the JBoss jBPM Database with your new PostgreSQL or MySQL</title> <para>In order to get the proper database scripts for your @@ -128,7 +113,7 @@ Using your database admin console, navigate to the database and then open and execute the create script we just referenced. Below are screen shots - doing this for PostGreSQL and MySQL under their respective admin + doing this for PostgreSQL and MySQL under their respective admin consoles</para> <section> @@ -138,9 +123,9 @@ lot of the supported databases in the DB subproject. The database scripts for PostgreSQL are found in the folder '${jbpm-jpdl-home}/db. The creation script is - called 'postgresql.create.sql'. Using DBVisualizer, you can load this - script by switching to the 'SQL Commander' tab and then selecting - 'File-&gt;Load...'. In the following dialog, navigate to the creation + called 'postgresql.create.sql'. Using pgAdmin, you can load this + script by selecting 'Tools-&gt;Query tool' and then + 'File-&gt;Open...'. In the following dialog, navigate to the creation script file. The result of doing so is shown in the figure below.</para> @@ -149,13 +134,13 @@ <mediaobject> <imageobject> - <imagedata fileref="images/load_script.jpg" /> + <imagedata fileref="images/load_script.png" /> </imageobject> </mediaobject> </figure> - <para>To execute this script with DBVisualizer, you select - 'Database-&gt;Execute'. After this step all JBoss jBPM tables are + <para>To execute this script with the pgAdmin Query tool, select + 'Query-&gt;Execute'. After this step all JBoss jBPM tables are created. The situation is illustrated in the figure below.</para> <figure> @@ -163,7 +148,7 @@ <mediaobject> <imageobject> - <imagedata fileref="images/execute_script.jpg" /> + <imagedata fileref="images/execute_script.png" /> </imageobject> </mediaobject> </figure> @@ -302,8 +287,7 @@ you just created a new DataSource for your JBoss jBPM server. Well, almost... To make things really work you will have to copy the correct JDBC driver to the <literal>${jboss.home}/server/default/lib</literal> folder. - We already used this JDBC driver above when we were installing it in - DBVisualizer to be able to browse our newly created database. The file + The file is named <literal>postgresql-8.1-*.jdbc3.jar</literal> and it can be found in the jdbc subdirectory of your PostgreSQL installation folder.</para> Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/introduction.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/introduction.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/introduction.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -22,7 +22,7 @@ database.</para> <figure id="overview.image"> <title>Overview of the jPDL components</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/overview.png"/></imageobject></mediaobject> + <mediaobject><imageobject><imagedata align="center" fileref="images/overview.gif"/></imageobject></mediaobject> </figure> </section> @@ -70,10 +70,9 @@ <para>The plugin is available as a local update site (plain zip file) for installation via the standard eclipse software updates mechanism. The jPDL graphical process designer plugin is also included in - <ulink url="http://www.jboss.org/tools/">JBossTools</ulink>;, + <ulink url="http://www.jboss.org/tools/">JBoss Tools</ulink>, <ulink url="http://www.redhat.com/developer_studio/">JBoss Developer Studio</ulink> and - <ulink url="">the SOA Platform</ulink>. - .</para> + the <ulink url="http://www.jboss.com/products/platforms/soa/">SOA Platform</ulink>.</para> </section> <section> Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/mail.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/mail.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/mail.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -254,7 +254,7 @@ <section id="mailserver"> <title>Mail server</title> - <para>If you need a mail server that is easy to install, checkout <ulink url="http://www.jboss.org/products/mailservices">JBossMail Server</ulink> + <para>If you need a mail server that is easy to install, check out <ulink url="http://buni.org/">Meldware</ulink> or <ulink url="http://james.apache.org/">Apache James</ulink> </para> </section> Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/modelling.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/modelling.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/modelling.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -96,10 +96,8 @@ <section id="nodes"> <title>Nodes</title> - <para>A process graph is made up of nodes and transitions. For more information about the - graph and its execution model, refer to <xref linkend="graphorientedprogramming" />. - </para> - <para>Each node has a specific type. The node type determines what will happen when + <para>A process graph is made up of nodes and transitions. + Each node has a specific type. The node type determines what will happen when an execution arrives in the node at runtime. jBPM has a set of node types that you can use. Alternatively, you can write custom code for implementing your own specific node behavior.</para> @@ -135,9 +133,9 @@ </itemizedlist> <para>jBPM contains --as any workflow and BPM engine-- a set of pre-implemented node types that have a specific documented configuration and behavior. But the unique thing about - jBPM and the Graph Oriented Programming foundation<footnote><para><xref linkend="graphorientedprogramming"/>.</para></footnote> + jBPM and the Graph Oriented Programming foundation is that we open up the model for developers. Developers can write their own node behavior - very easy and use it in a process. + very easily and use it in a process. </para> <para>That is where traditional workflow and BPM systems are much more closed. They usually supply a fixed set of node types (called the process language). @@ -667,8 +665,8 @@ <section id="transactiondemarcation"> <title>Transaction demarcation</title> - <para>As explained in <xref linkend="graphexecution" /> and - <xref linkend="graphorientedprogramming" />, jBPM runs the process in the thread of + <para>As explained in <xref linkend="graphexecution" />, + jBPM runs the process in the thread of the client and is by nature synchronous. Meaning that the <literal>token.signal()</literal> or <literal>taskInstance.end()</literal> will only return when the process has entered a new wait state. Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/persistence.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/persistence.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/persistence.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -422,19 +422,11 @@ <programlisting language="xml"> &lt;jbpm-context&gt; &lt;service name="persistence"&gt; - &lt;factory&gt; - &lt;bean class="org.jbpm.persistence.db.DbPersistenceServiceFactory"&gt; - &lt;field name="isTransactionEnabled"&gt;&lt;false /&gt;&lt;/field&gt; - &lt;field name="isCurrentSessionEnabled"&gt;&lt;true /&gt;&lt;/field&gt; - &lt;field name="sessionFactoryJndiName"&gt; - &lt;string value="java:/myHibSessFactJndiName" /&gt; - &lt;/field&gt; - &lt;/bean&gt; - &lt;/factory&gt; + &lt;factory class="org.jbpm.persistence.jta.JtaDbPersistenceServiceFactory"/&gt; &lt;/service&gt; &lt;/jbpm-context&gt;</programlisting> - <para>Then you should specify in your hibernate session factory to use a datasource and + <para>Afterwards, you should specify in your hibernate session factory to use a datasource and bind hibernate to the transaction manager. Make sure that you bind the datasource to an XA datasource in case you are using more than one resource. For more information about binding hibernate to your transaction manager, please, refer to @@ -464,6 +456,7 @@ <para>These configurations allow for the enterprise beans to use CMT and still allow the web console to use BMT. That is why the property 'jta.UserTransaction' is also specified. + Note that 'java:comp/UserTransaction' is the value used if 'jta.UserTransaction' is absent. </para> </section> @@ -548,7 +541,7 @@ </section> - <section> + <section id="customhibernateclasses"> <title>Combining your hibernate classes</title> <para>In your project, you might use hibernate for your persistence. Combining your @@ -576,7 +569,7 @@ </para> </section> - <section> + <section id="customizingmappings"> <title>Customizing the jBPM hibernate mapping files</title> <para>To customize any of the jBPM hibernate mapping files, you can proceed as follows: Modified: jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/tutorial.xml =================================================================== --- jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/tutorial.xml 2009-02-12 20:55:57 UTC (rev 3857) +++ jbpm3/trunk/modules/userguide/src/main/docbook/en/modules/tutorial.xml 2009-02-12 22:54:24 UTC (rev 3858) @@ -18,7 +18,7 @@ <para>jBPM includes a graphical designer tool for authoring the XML that is shown in the examples. You can find download instructions - for the graphical designer in <xref linkend="downloadablesoverview" />. + for the graphical designer in <xref linkend="downloadingandinstallingjbpm" />. You don't need the graphical designer tool to complete this tutorial. </para>