QuickStart

Version 3 (Roman Mackovčák, 05/27/2009 09:10 pm)

1 3 Roman Mackovčák
h1. [[/|Eazflow]] - Documentation - Quick start
2 1
3 1
Step by step instructions for creating Eazflow-based Grails application
4 1
5 1
h3. Prerequisites 
6 1
7 1
* Grails (>=1.0.3) installed (http://grails.org/Installation)
8 1
** Grails 1.0.3 tested, working
9 1
** Grails 1.0.4 tested, working
10 1
** Grails 1.1-RC2 tested, working; put xstream(>=1.3.1).jar to lib as it is no more included with grails
11 2 Roman Mackovčák
* "grails-eazflow-0.1.zip":http://www.grails.cz/attachments/download/1/grails-eazflow-0.1.zip  downloaded
12 1
13 1
h3. Creating the ''eazdemo'' application
14 1
15 1
* Create new Grails-application named ''eazdemo'' (you may, of course, use another name for it)
16 1
17 1
<pre><code class="text">
18 1
grails create-app eazdemo
19 1
cd eazdemo
20 1
grails install-plugin modalbox 0.3                     # updating plugins list cache may take some time
21 1
grails install-plugin richui 0.6
22 1
grails install-plugin ../grails-eazflow-0.1.zip        # yes, that is our plugin downloaded above
23 1
</code></pre>
24 1
25 1
* Optionally: Put content of `grails-app/conf/EazflowConfig.groovy` into `grails-app/conf/Config.groovy`
26 1
* Optionally: Configure `grails-app/conf/DataSource.groovy` (defaults should be OK for demonstration purposes)
27 1
28 1
h3. Run the application
29 1
30 1
* Start grails application
31 1
32 1
<pre><code class="text">
33 1
grails run-app
34 1
</code></pre>
35 1
   (give it some time for initialization)
36 1
37 1
* Open the application page http://localhost:8080/eazdemo/worklist/
38 1
39 1
h3. Application description 
40 1
41 1
On the ''worklist'' page, you should see an (initially empty) ''List of processes''.
42 1
On the top of the page there are ''demo login'' links, allowing you to login to the system easily.
43 1
44 1
Eazflow manages long running ''processes'', consisting of ''activities''. In each ''activity'', a ''user'' may read or edit a set of ''variables'', and then choose a ''transition'' into another ''activity''.
45 1
46 1
There is a predefined ''Ticket'' sample process where:
47 1
* Logged-in users can create a ''ticket'' (Start new process: Ticket), fill in the form and ''Submit'' the ''ticket'' for further processing
48 1
* The manager (''mng'') processes submitted ''tickets'' and assigns a ''worker'' user to each one of them (clicking ''Assign'' for next step)
49 1
* Assigned ''workers'' process the ''tickets''...
50 1
* Note the different access rights (to displayed variables, activities, transitions) applied for different roles, some of which are dynamically assigned according to filled-in values (e.g. ''worker'')
51 1
52 1
The ''Ticket'' process presented is very minimalistic, meant for the demonstration of ''Eazflow'' plugin abilities only. It can be simply extended (adding variables, activities, transitions and access rules) by data-based process definitions. 
53 1
54 1
Inspect `grails-app/services/EazflowBootStrapService.groovy` for the data definitions used in this example.