[Zope3-checkins] CVS: Packages3/workflow - README.txt:1.7

Ulrich Eck ueck@net-labs.de
Thu, 26 Jun 2003 16:11:56 -0400


Update of /cvs-repository/Packages3/workflow
In directory cvs.zope.org:/tmp/cvs-serv10254

Modified Files:
	README.txt 
Log Message:
updated README.txt for workflow package


=== Packages3/workflow/README.txt 1.6 => 1.7 ===
--- Packages3/workflow/README.txt:1.6	Wed Mar 26 12:43:36 2003
+++ Packages3/workflow/README.txt	Thu Jun 26 16:11:56 2003
@@ -1,48 +1,30 @@
-Zope3 Workflow Implementations:
+Zope3 Workflow Implementation:
 
-This package is currently developed outside of the Zope3 CVS-HEAD
-to be able to share work between the developers more easily.
+  Overview:
 
-to install this package you need to check it out 
-from the Zope-CVS-Repository:
+    This package provides a modular and extensible implementation
+    for a workflow based application development.
 
- - cvs -d:pserver:anonymous@cvs.zope.org:/cvs-repository login
-   cvs -d:pserver:anonymous@cvs.zope.org:/cvs-repository co Packages3/workflow
+    Any number of Placeful WorkflowService instances can be created
+    to manage Registries of ProcessDefinitions and ProcessInstances.
 
- - remove the workflow directory from src/zope/app from Zope3src
+    A ProcessDefinition can be configured and made active at a workflow
+    service under a certain Name (ProcessDefinitionName).
 
- - link/copy this package into src/zope/app/workflow
+    ProcessInstances are created by the workflow service by their name.
+    They can be stored in Annotations or ProcessInstanceContainers.
 
- - add this to the src/zope/app/configure.zcml (before zope.app.browser is included):
+    There is a standard way to enable ProcessInstance Storage for Content
+    classes by implementing IProcessInstanceContainerAdaptable.
 
-   <include package=".workflow" />
+    The framework is fairly flexible and can host several workflow-type 
+    implementation (e.g. Statefull, State-Based vs. WfMC, Activity-Based.)
 
- - add this to the src/zope/app/meta.zcml (after the onlinehelp entry):
-
-   <include package="zope.app.workflow" file="meta.zcml" />
-
- - link/copy the workflow/browser folder into
-   src/zope/app/browser/workflow 
-
- - add this to the src/zope/app/browser/configure.zcml:
-
-   <include package=".workflow" />
-
- - edit your site-zcml to grant workflow permissions to manager:
-
-   <grant permission="zope.workflow.ManageProcessDefinitions" role="Manager" />
-   <grant permission="zope.workflow.CreateProcessInstances"  role="Manager" />
-   <grant permission="zope.workflow.UseProcessInstances" role="Manager" />
-
- - add this to your site.zcml for every content-object that
-   should get an instance annotated (example for FileContent):
-
-   <content class="zope.app.content.file.File" >
-    <implements interface="zope.app.interfaces.workflow.IProcessInstanceContainerAdaptable" />
-   </content>
-
- - start your Z3 server
+  Implementation simple Statefull Workflow:
 
+    a fairly simple state-based workflow has been implemented and can be
+    used for simple content-management applications. it features manual/
+    automatic transitions w/conditions and security integration.
 
 
 Configure your System to use Workflow:
@@ -98,7 +80,8 @@
  - build views for managing processinstances that are
    annotated to content objects. (partly done)
 
- - improve capabilities of stateful workflow
+ - improve capabilities of stateful workflow:
+   (sending of events, permission-management, ttw-schema)
 
  - start implementing the wfmc-based workflow based on the 
    experiences with the "fairly simple" stateful workflow.