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

[do-not-reply at jboss.org]

Author: tom.baeyens at jboss.com
Date: 2009-02-12 09:29:17 -0500 (Thu, 12 Feb 2009)
New Revision: 3854

Added:
   jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch11-History.xml
Removed:
   jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/chxx-History.xml
Modified:
   jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml
Log:
first cut of history

Modified: jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml
===================================================================
--- jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml	2009-02-12 14:14:00 UTC (rev 3853)
+++ jbpm4/trunk/modules/devguide/src/main/docbook/en/master.xml	2009-02-12 14:29:17 UTC (rev 3854)
@@ -11,6 +11,7 @@
   <!ENTITY ch08-Timers                         SYSTEM "modules/ch08-Timers.xml">
   <!ENTITY ch09-AsynchronousContinuations      SYSTEM "modules/ch09-AsynchronousContinuations.xml">
   <!ENTITY ch10-SoftwareLogging                SYSTEM "modules/ch10-SoftwareLogging.xml">
+  <!ENTITY ch11-History                        SYSTEM "modules/ch11-History.xml">
 ]>
 
 <book lang="en">
@@ -31,5 +32,6 @@
   &ch08-Timers;
   &ch09-AsynchronousContinuations;
   &ch10-SoftwareLogging;
+  &ch11-History;
 
 </book>
\ No newline at end of file

Copied: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch11-History.xml (from rev 3816, jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/chxx-History.xml)
===================================================================
--- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch11-History.xml	                        (rev 0)
+++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch11-History.xml	2009-02-12 14:29:17 UTC (rev 3854)
@@ -0,0 +1,42 @@
+<chapter id="history">
+  <title>History</title>
+
+  <section id="overview">
+    <title>Overview</title>
+    
+    <para>HistoryEvents are fired during process execution.
+    </para>
+
+    <para>We maintain history information on 2 levels: process instance and activity instance.
+    </para>
+
+    <para>Process instance start and process instance end generate history events are fired directly 
+    from within the implementation.
+    </para>
+
+    <para>ActivityBehaviour implementations are responsible for calling the historyXxx methods that 
+    are exposed on the ActivityExecution
+    </para>
+
+    <para>All the HistoryEvents are delegated to a HistorySession.  The default HistorySessionImpl 
+    will invoke the process() method on the history events themselves.
+    </para>
+
+    <para>The HistoryEvents are temporary events.  In the process method, they build up the information 
+    in the history model.  There is a HistoryProcessInstance and there is a whole class hierarchy starting with HistoryActivityInstance.   
+    </para>
+
+    <para>In the HistoryEvent.process methods, the history events create model entities or merge 
+    information into the model entities.  For instance, a ProcessInstanceStart history event will 
+    create a HistoryProcessInstance entity/record.  And the ProcessInstanceEnd will set the endTime 
+    property in the existing HistoryProcessInstance entity/record.  
+    </para>
+
+    <para>Similar pattern for the activities.  But for automatic activities, there is an optimisation 
+    so that only 1 event is created and all the information is stored in one single insert (as all 
+    this happens inside 1 transaction).
+    </para>
+
+  </section>
+
+</chapter>
\ No newline at end of file


Property changes on: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/ch11-History.xml
___________________________________________________________________
Name: svn:mergeinfo
   + 

Deleted: jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/chxx-History.xml
===================================================================
--- jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/chxx-History.xml	2009-02-12 14:14:00 UTC (rev 3853)
+++ jbpm4/trunk/modules/devguide/src/main/docbook/en/modules/chxx-History.xml	2009-02-12 14:29:17 UTC (rev 3854)
@@ -1,15 +0,0 @@
-<chapter id="history">
-  <title>History</title>
-
-  <section id="processlogs">
-    <title>Process logs</title>
-  </section>
-
-  <section id="businessintelligence">
-    <title>Business Intelligence (BI)</title>
-  </section>
-
-  <section id="businessactivitymonitoring">
-    <title>Business Activity Monitoring (BAM)</title>
-  </section>
-</chapter>
\ No newline at end of file