[jbpm-commits] JBoss JBPM SVN: r5836 - in jbpm4/trunk/modules/devguide/src/main/docbook/en: images and 1 other directories.

Author: jbarrez Date: 2009-10-28 12:33:15 -0400 (Wed, 28 Oct 2009) New Revision: 5836 Added: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.event.png jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.transition.png jbpm4/trunk/modules/devguide/src/main/docbook/en/images/signavio.screenshot.png jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch17-Signavio.xml Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch02-Incubation.xml jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch09-Configuration.xml jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch13-SoftwareLogging.xml Log: Revised documentation. Added chapter 17: Signavio. Added: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.event.png =================================================================== (Binary files differ) Property changes on: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.event.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.transition.png =================================================================== (Binary files differ) Property changes on: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/process.timer.transition.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Added: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/signavio.screenshot.png =================================================================== (Binary files differ) Property changes on: jbpm4/trunk/modules/devguide/src/main/docbook/en/images/signavio.screenshot.png ___________________________________________________________________ Name: svn:mime-type + application/octet-stream Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml =================================================================== --- jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml 2009-10-28 16:09:09 UTC (rev 5835) +++ jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml 2009-10-28 16:33:15 UTC (rev 5836) @@ -17,6 +17,7 @@ <!ENTITY ch14-History SYSTEM "modules/ch14-History.xml"> <!ENTITY ch15-JBossIntegration SYSTEM "modules/ch15-JBossIntegration.xml"> <!ENTITY ch16-SpringIntegration SYSTEM "modules/ch16-SpringIntegration.xml"> + <!ENTITY ch17-Signavio SYSTEM "modules/ch17-Signavio.xml"> ]> <book lang="en"> @@ -43,5 +44,6 @@ &ch14-History; &ch15-JBossIntegration; &ch16-SpringIntegration; + &ch17-Signavio </book> \ No newline at end of file Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch02-Incubation.xml =================================================================== --- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch02-Incubation.xml 2009-10-28 16:09:09 UTC (rev 5835) +++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch02-Incubation.xml 2009-10-28 16:33:15 UTC (rev 5836) @@ -85,9 +85,6 @@ <section id="businesscalendar"> <title>Business calendar</title> - <para>Known limitation. The business calendar is not yet configurable. - See also <ulink url="https://jira.jboss.org/jira/browse/JBPM-2334">JBPM-2334... - </para> <para>The default configuration will contain a reference to the file <literal>jbpm.business.calendar.xml</literal>. That contains a configuration of business hours in the following format: @@ -110,14 +107,49 @@ &lt;/process-engine-context&gt; &lt;/jbpm-configuration&gt;</programlisting> - <para>For an example of where the business calendar is used, see - <xref linkedn="timerbusinesstime" /> - </para> + <para> + If the default business calendar implementation is sufficient for you, + you can simply adjust the timings in the xml configuration as shown above. + </para> + <para> + If the default implementation doesn't cover your use cases, you can easily + write your own implementation by implementing the + <literal>org.jbpm.pvm.internal.cal.BusinessCalendar</literal> interface. + </para> + <para> + For example: + <programlisting> +public class CustomBusinessCalendar implements BusinessCalendar { + + public Date add(Date date, String duration) { + if (&quot;my next birthday&quot;.equals(duration)) { + GregorianCalendar gregorianCalendar = new GregorianCalendar(); + gregorianCalendar.set(Calendar.MONTH, Calendar.JULY); + gregorianCalendar.set(Calendar.DAY_OF_MONTH, 21); + return gregorianCalendar.getTime(); + } + return null; + } +} + </programlisting> + To configure the jBPM engine to use this custom business calendar, just add + the following line to your <literal>jbpm.cfg.xml</literal>: + <programlisting> +&lt;process-engine-context&gt; + &lt;object class=&quot;org.jbpm.test.custombusinesscalendarimpl.CustomBusinessCalendar&quot; /&gt; +&lt;/process-engine-context&gt; + </programlisting> + </para> + Take a look at the + <literal>org.jbpm.test.custombusinesscalendarimpl.CustomBusinessCalendarImplTest</literal> + for more information. + </para> </section> <section id="timertransition"> <title>Timer transition</title> - <para>Example TimerTransitionTest shows how to put a timer on a transition.</para> + <para>The example <literal>org.jbpm.examples.timer.transition.TimerTransitionTest</literal> + shows how to put a timer on a transition.</para> <figure id="process.timer.transition"> <title>The timer transition example process</title> <mediaobject><imageobject><imagedata align="center" fileref="images/process.timer.transition.png"/></imageobject></mediaobject> @@ -286,7 +318,7 @@ <section id="group"> <title><literal>group</literal></title> - <para>A group groups a set of activities in a process. Contained groups must + <para>A <literal>group</literal> groups a set of activities in a process. Contained groups must be hierarchically nested. A group corresponds to a BPMN expanded sub process. </para> @@ -586,7 +618,7 @@ </section> <section> - <title>Creating groups</title> + <title>Creating identity groups</title> <para>The identity service methods to create groups are based on component generated ID's. </para> @@ -803,7 +835,7 @@ <section> <title>Version Ranges</title> - <para>So far I have showed you how instances of the previously deployed version - and only that one - + <para>So we've showed you how instances of the previously deployed version - and only that one - could be either migrated or ended. But what to do when you want to perform these actions on process instances of other already deployed versions. This can be done by making use of the versions attribute of the migrate-instances tag. This attribute lets you specify a range of versions that need to be Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch09-Configuration.xml =================================================================== --- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch09-Configuration.xml 2009-10-28 16:09:09 UTC (rev 5835) +++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch09-Configuration.xml 2009-10-28 16:33:15 UTC (rev 5836) @@ -66,19 +66,21 @@ </para> <para>The jbpm.jar contains also following hibernate mapping configuration files:</para> - <programlisting>jbpm.execution.hbm.xml - jbpm.history.hbm.xml - jbpm.identity.hbm.xml - jbpm.repository.hbm.xml - jbpm.task.hbm.xml</programlisting> + <programlisting> +jbpm.execution.hbm.xml +jbpm.history.hbm.xml +jbpm.identity.hbm.xml +jbpm.repository.hbm.xml +jbpm.task.hbm.xml</programlisting> <para>These all map the java domain model objects to a relational database. </para> <para>Other various configuration files that are included in jbpm.jar:</para> - <programlisting>jbpm.task.lifecycle.xml - jbpm.variable.types.xml - jbpm.wire.bindings.xml - jbpm.jpdl.activities.xml - jbpm.jpdl.eventlisteners.xml</programlisting> + <programlisting> +jbpm.task.lifecycle.xml +jbpm.variable.types.xml +jbpm.wire.bindings.xml +jbpm.jpdl.activities.xml +jbpm.jpdl.eventlisteners.xml</programlisting> <para>Normally it is not necessary to dive into the parsing itself. It's most a matter of figuring out how to specify the configuration that you want :-) @@ -93,9 +95,6 @@ <section id="customizingthebusinesscalendar"> <title>Customizing the business calendar</title> - <para>For specifying a different configuration for the default - business calendar implementation, see the userguide. - </para> <para>To provide a custom implementation for the business calendar, specify a custom business calendar implementation like this in the jbpm.cfg.xml Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch13-SoftwareLogging.xml =================================================================== --- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch13-SoftwareLogging.xml 2009-10-28 16:09:09 UTC (rev 5835) +++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch13-SoftwareLogging.xml 2009-10-28 16:33:15 UTC (rev 5836) @@ -32,7 +32,7 @@ <section> <title>JDK logging</title> - <para>In JDK logging, <literal>debug</literal>maps to <literal>fine</literal> + <para>In JDK logging, <literal>debug</literal> maps to <literal>fine</literal> and <literal>trace</literal> maps to <literal>finest</literal>. Level <literal>finer</literal> is not used. </para> Added: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch17-Signavio.xml =================================================================== --- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch17-Signavio.xml (rev 0) +++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch17-Signavio.xml 2009-10-28 16:33:15 UTC (rev 5836) @@ -0,0 +1,94 @@ +<?xml version="1.0" encoding="UTF-8"?> +<chapter> + + <title>Signavio web modeler</title> + + <section id="signavioIntroduction"> + + <title>Introduction</title> + + <para>Since version 4.1, jBPM ships with a completely open-source web-based BPMN + modeling tool called 'Signavio'. This Signavio web modeler is the result + of a close collaboration between the JBoss jBPM team, + <ulink url="http://www.signavio.com/en.html">the company also named 'Signavio'</ulink> + and the Hasso Plattner Instut (HPI) in Germany. Signavio is based on the + web-based modeling tool <ulink url="http://bpt.hpi.uni-potsdam.de/Oryx"> + Oryx</ulink>, which is developed in open-source by HPI. Both HPI and + Signavio have comitted themselves to continue investing in Oryx and Signavio. + More information about the initiative can be found + <ulink url="http://code.google.com/p/signavio-oryx-initiative/">her... + + <para> + <mediaobject><imageobject><imagedata align="center" fileref="images/signavio.screenshot.png"/></imageobject></mediaobject> + </para> + + <para> + Using the Signavio web-based BPMN modeler, it is possible to let business + analyst model the business processes through their browser. The file format + which is used to store the BPMN processes is actually jPDL. This means that + they can directly be imported into the Eclipse GPD and vice-versa. The process + files will be stored on the hard disk, by default in + <literal>$jbpm_home/signavio-repository</literal> if you've used the default + installation scripts. + </para> + + <para> + NOTE: The web-based BPMN modeling tool which ships with jBPM is 100% open-source + (MIT-licence). The company <ulink url="http://www.signavio.com/en.html">Signavio</ulink> + also offers commercial versions of the same modeling tool, enhanced with additional + features. Do note that new features, beneficial for the jBPM project, always + will be comitted in the open-source repository of the modeling tool. + </para> + + </section> + + <section id="signavioInstallation"> + + <title>Installation</title> + + <para> + There are several ways of installing Signavio into your web container: + <itemizedlist> + <listitem> + Use the demo.setup.jboss/tomcat scripts in <literal>$jbpm_home/install</literal> + </listitem> + <listitem> + Use the install.signavio.into.jboss/tomcat scripts in <literal>$jbpm_home/install</literal> + </listitem> + <listitem> + Copy the <literal>$jbpm_home/install/src/signavio/jbpmeditor.war</literal> + to your web container + </listitem> + </itemizedlist> + </para> + + </section> + + <section id="signavioConfiguration"> + + <title>Configuration</title> + + <para> + Most of the Signavio configuration parameters can be changed in the + <literal>web.xml</literal> file, which you can find in <literal>jbpmeditor.war/WEB-INF/</literal>. + The only parameters which is of real importance is the <literal>fileSystemRootDirectory</literal> + parameter. The value of this parameter must point to an existing folder + on your hard disk: + <programlisting> +&lt;/context-param&gt; + &lt;context-param&gt; + &lt;description&gt;Filesystem directory that is used to store models&lt;/description&gt; + &lt;param-name&gt;fileSystemRootDirectory&lt;/param-name&gt;&lt;param-value&gt;/home/jbarrez/dev/temp/jbpm-4.2-SNAPSHOT/signavio-repository&lt;/param-value&gt; +&lt;/context-param&gt; + </programlisting> + </para> + + <para> + If you use the installation scripts provided in <literal>$jbpm_home/install</literal>, + this parameter is automatically set to <literal>$jbpm_home/signavio-repository</literal> + during installation. + </para> + + </section> + +</chapter>