[jbpm-commits] JBoss JBPM SVN: r2236 - in jbpm4/pvm/trunk/modules/manual/src/main/docbook/en: modules and 1 other directory.

Author: tom.baeyens(a)jboss.com Date: 2008-09-15 04:07:56 -0400 (Mon, 15 Sep 2008) New Revision: 2236 Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/loan.execution.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/loan.process.png jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch02-ExecutionModes.xml jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch03-Architecture.xml Log: docs updates Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/loan.execution.png =================================================================== (Binary files differ) Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/images/loan.process.png =================================================================== (Binary files differ) Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch02-ExecutionModes.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch02-ExecutionModes.xml 2008-09-15 07:37:55 UTC (rev 2235) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch02-ExecutionModes.xml 2008-09-15 08:07:56 UTC (rev 2236) @@ -1,30 +1,27 @@ -<chapter id="overview"> - <title>Overview</title> +<chapter id="executionmodes"> + <title>Execution modes</title> + + <para>There are basically three process execution modes: object, persistent + and embedded. For the persistent and embedded execution modes, the process + execution has to participate in a transaction. In that case, the process + execution has to take place inside of an Environment. The environment will be + used to bind process execution updates to a transaction in the application + transaction. The environment can be used to bind to e.g. a JDBC connection, + JTA, BMT, Spring transactions and so on. + </para> - <section id="executionmodes"> - <title>Execution modes</title> - - <para>There are basically three process execution modes: object, persistent - and embedded. For the persistent and embedded execution modes, the process - execution has to participate in a transaction. In that case, the process - execution has to take place inside of an Environment. The environment will be - used to bind process execution updates to a transaction in the application - transaction. The environment can be used to bind to e.g. a JDBC connection, - JTA, BMT, Spring transactions and so on. + <section id="objectexecutionmode"> + <title>Object execution mode</title> + <para>Object execution mode is the simplest form of working with the Process + Virtual Machine. This means working with the process definition and execution + objects directly through the client API. Let's show this by an example. We + start by creating a <literal>ClientProcessDefinition</literal> that looks like this: </para> - - <section id="objectexecutionmode"> - <title>Object execution mode</title> - <para>Object execution mode is the simplest form of working with the Process - Virtual Machine. This means working with the process definition and execution - objects directly through the client API. Let's show this by an example. We - start by creating a <literal>ClientProcessDefinition</literal> that looks like this: - </para> - <figure id="loan.process"> - <title>The loan process</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/loan.process.png"/></imageobject></mediaobject> - </figure> - <programlisting>ClientProcessDefinition <emphasis role="bold">processDefinition</emphasis> = ProcessFactory.build() + <figure id="loan.process"> + <title>The loan process</title> + <mediaobject><imageobject><imagedata align="center" fileref="images/loan.process.png"/></imageobject></mediaobject> + </figure> + <programlisting>ClientProcessDefinition <emphasis role="bold">processDefinition</emphasis> = ProcessFactory.build() .node("a").initial().behaviour(AutomaticActivity.class) .transition().to("b") .node("b").behaviour(AutomaticActivity.class) @@ -37,82 +34,28 @@ .transition().to("e") .node("f").behaviour(WaitState.class) .done();</programlisting> - <para>The <literal>ProcessFactory</literal> is a helper class that provides convenience - for building an object graph that represents a process definition. - <literal>AutomaticActivity</literal> just acts as a pass through activity without anything - happening and <literal>WaitState</literal> will wait until an external signal is given. Both - activity implementations will be covered in more depth later. - </para> - <para>A process - </para> - </section> - - <section id="persistentexecutionmode"> - <title>Persistent execution mode</title> - <para>Embedded execution mode means that process definitions, the runtime - executions and the history information all is stored in the PVM database - schema. - </para> - </section> + <para>The <literal>ProcessFactory</literal> is a helper class that provides convenience + for building an object graph that represents a process definition. + <literal>AutomaticActivity</literal> just acts as a pass through activity without anything + happening and <literal>WaitState</literal> will wait until an external signal is given. Both + activity implementations will be covered in more depth later. + </para> + <para>A process + </para> + </section> - <section id="embeddedexecutionmode"> - <title>Embedded execution mode</title> - <para>Embedded execution mode means that the state of a process is stored - as a string column inside a user domain object like e.g. an Order. - </para> - </section> + <section id="persistentexecutionmode"> + <title>Persistent execution mode</title> + <para>Embedded execution mode means that process definitions, the runtime + executions and the history information all is stored in the PVM database + schema. + </para> </section> - <section id="architecture"> - <title>Architecture</title> - - <section id="apis"> - <title>APIs</title> - <para>The Process Virtual Machine has 4 integrated API's that together - offer a complete coverage of working with processes. Each of the APIs has a - specific purpose - </para> - <figure id="apis"> - <title>The 4 API's of the Process Virtual Machine</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/apis.png"/></imageobject></mediaobject> - </figure> - <para>The services interfaces should be used from application code that wants to interact - with the Process Virtual Machine which runs in transactional persistent mode, backed by a - database. This is the most typical way how users interact with the PVM as a workflow engine. - </para> - <para>To execute processes without persistence, the client API can be used to work with process - and execution objects directly. The client API expose the methods of the core model objects. - </para> - <para>The activity API is used to implement the runtime behaviour of activities. So a activity - type is in fact a component with at the core an implementation of the <literal>Activity</literal> - interface. Activity implementations can control the flow of execution. - </para> - <para>The event listener API serves to write pieces of Java code that should be executed upon - process events. It's very similar to the activity API with that exception that event listeners - are not able to control the flow of execution. - </para> - </section> - - <section> - <title>Configuration</title> - <para> - </para> - </section> - <section> - <title>Environment</title> - <para> - </para> - </section> - <section> - <title>Commands</title> - <para> - </para> - </section> - <section> - <title>Services</title> - <para> - </para> - </section> + <section id="embeddedexecutionmode"> + <title>Embedded execution mode</title> + <para>Embedded execution mode means that the state of a process is stored + as a string column inside a user domain object like e.g. an Order. + </para> </section> - </chapter> \ No newline at end of file Modified: jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch03-Architecture.xml =================================================================== --- jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch03-Architecture.xml 2008-09-15 07:37:55 UTC (rev 2235) +++ jbpm4/pvm/trunk/modules/manual/src/main/docbook/en/modules/ch03-Architecture.xml 2008-09-15 08:07:56 UTC (rev 2236) @@ -1,118 +1,52 @@ -<chapter id="overview"> - <title>Overview</title> - - <section id="executionmodes"> - <title>Execution modes</title> - - <para>There are basically three process execution modes: object, persistent - and embedded. For the persistent and embedded execution modes, the process - execution has to participate in a transaction. In that case, the process - execution has to take place inside of an Environment. The environment will be - used to bind process execution updates to a transaction in the application - transaction. The environment can be used to bind to e.g. a JDBC connection, - JTA, BMT, Spring transactions and so on. +<chapter id="architecture"> + <title>Architecture</title> + + <section id="apis"> + <title>APIs</title> + <para>The Process Virtual Machine has 4 integrated API's that together + offer a complete coverage of working with processes. Each of the APIs has a + specific purpose </para> + <figure id="apis"> + <title>The 4 API's of the Process Virtual Machine</title> + <mediaobject><imageobject><imagedata align="center" fileref="images/apis.png"/></imageobject></mediaobject> + </figure> + <para>The services interfaces should be used from application code that wants to interact + with the Process Virtual Machine which runs in transactional persistent mode, backed by a + database. This is the most typical way how users interact with the PVM as a workflow engine. + </para> + <para>To execute processes without persistence, the client API can be used to work with process + and execution objects directly. The client API expose the methods of the core model objects. + </para> + <para>The activity API is used to implement the runtime behaviour of activities. So a activity + type is in fact a component with at the core an implementation of the <literal>Activity</literal> + interface. Activity implementations can control the flow of execution. + </para> + <para>The event listener API serves to write pieces of Java code that should be executed upon + process events. It's very similar to the activity API with that exception that event listeners + are not able to control the flow of execution. + </para> + </section> - <section id="objectexecutionmode"> - <title>Object execution mode</title> - <para>Object execution mode is the simplest form of working with the Process - Virtual Machine. This means working with the process definition and execution - objects directly through the client API. Let's show this by an example. We - start by creating a <literal>ClientProcessDefinition</literal> that looks like this: - </para> - <figure id="loan.process"> - <title>The loan process</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/loan.process.png"/></imageobject></mediaobject> - </figure> - <programlisting>ClientProcessDefinition <emphasis role="bold">processDefinition</emphasis> = ProcessFactory.build() - .node("a").initial().behaviour(AutomaticActivity.class) - .transition().to("b") - .node("b").behaviour(AutomaticActivity.class) - .transition().to("c") - .node("c").behaviour(WaitState.class) - .transition().to("d") - .node("d").behaviour(AutomaticActivity.class) - .transition().to("f") - .node("e").behaviour(AutomaticActivity.class) - .transition().to("e") - .node("f").behaviour(WaitState.class) -.done();</programlisting> - <para>The <literal>ProcessFactory</literal> is a helper class that provides convenience - for building an object graph that represents a process definition. - <literal>AutomaticActivity</literal> just acts as a pass through activity without anything - happening and <literal>WaitState</literal> will wait until an external signal is given. Both - activity implementations will be covered in more depth later. - </para> - <para>A process - </para> - </section> - - <section id="persistentexecutionmode"> - <title>Persistent execution mode</title> - <para>Embedded execution mode means that process definitions, the runtime - executions and the history information all is stored in the PVM database - schema. - </para> - </section> - - <section id="embeddedexecutionmode"> - <title>Embedded execution mode</title> - <para>Embedded execution mode means that the state of a process is stored - as a string column inside a user domain object like e.g. an Order. - </para> - </section> + <section> + <title>Configuration</title> + <para> + </para> </section> - - <section id="architecture"> - <title>Architecture</title> - - <section id="apis"> - <title>APIs</title> - <para>The Process Virtual Machine has 4 integrated API's that together - offer a complete coverage of working with processes. Each of the APIs has a - specific purpose - </para> - <figure id="apis"> - <title>The 4 API's of the Process Virtual Machine</title> - <mediaobject><imageobject><imagedata align="center" fileref="images/apis.png"/></imageobject></mediaobject> - </figure> - <para>The services interfaces should be used from application code that wants to interact - with the Process Virtual Machine which runs in transactional persistent mode, backed by a - database. This is the most typical way how users interact with the PVM as a workflow engine. - </para> - <para>To execute processes without persistence, the client API can be used to work with process - and execution objects directly. The client API expose the methods of the core model objects. - </para> - <para>The activity API is used to implement the runtime behaviour of activities. So a activity - type is in fact a component with at the core an implementation of the <literal>Activity</literal> - interface. Activity implementations can control the flow of execution. - </para> - <para>The event listener API serves to write pieces of Java code that should be executed upon - process events. It's very similar to the activity API with that exception that event listeners - are not able to control the flow of execution. - </para> - </section> - - <section> - <title>Configuration</title> - <para> - </para> - </section> - <section> - <title>Environment</title> - <para> - </para> - </section> - <section> - <title>Commands</title> - <para> - </para> - </section> - <section> - <title>Services</title> - <para> - </para> - </section> + <section> + <title>Environment</title> + <para> + </para> </section> + <section> + <title>Commands</title> + <para> + </para> + </section> + <section> + <title>Services</title> + <para> + </para> + </section> </chapter> \ No newline at end of file