Changes between Version 8 and Version 9 of BluePrint/MultiStepForms


Ignore:
Timestamp:
04/26/13 16:58:38 (9 years ago)
Author:
hardik juneja
Comment:

--

Legend:

Unmodified
Added
Removed
Modified
  • BluePrint/MultiStepForms

    v8 v9  
    55== Introduction ==
    66
    7 The Blueprint outlines the development of Workflow Support for Sahana Eden.
     7The Blueprint outlines the development of Workflow Support for Sahana Eden i.e to develop a generator that can generate robust wizards for user to guide them through the different processes of sahana. A wizard is a user interface that presents a user with a sequence of forms  that lead the user through a series of well-defined steps.Tasks that are complex, infrequently performed, or unfamiliar may be easier to perform using these wizards.
    88
    99=== Description ===
     
    1111Workflow Support includes developing two functionality for Sahana Eden -
    1212
    13 ==== Workflow Engine ====
     13==== Multi-Step Forms(Wizard) Generator ====
    1414
    15              It includes development of a Engine which can act on some given data and can generate robust wizard out of the given data.[[BR]]
     15             It includes development of a Multi-step forms(wizard) Generator which can act on some defined data and can generate robust multi-step forms or wizard out of the defined data.[[BR]]
    1616             The wizard thus generated can be used by users and can help them understanding Sahana Eden dexterously and expeditiously.[[BR]]
    1717             It will also help developers to make robust wizards for different modules of Sahana Eden.[[BR]]
    1818
    19 ==== Morphing workflow for mobile interface ====
     19==== Morphing wizards for mobile interface ====
    2020
    2121             It includes splitting bigger forms into smaller part.[[BR]]
    22              Ex. Morphing one wizard screen into three for  small mobile devices
     22             Ex. Morphing one form into three for  small mobile devices
    2323
    2424=== Target Problem ===
     
    4040* '''End Users''' - Users of Sahana Eden will be benefited the most with Workflow Support as it will help them understand Sahana Eden quickly and easily. [BR]
    4141
    42 * '''Developers''' - With the help of Workflow Engine, developers of sahana eden can easily create a wizard for new modules.
     42* '''Developers''' - With the help of Multi-step forms Generator, developers of sahana eden can easily create a wizard for new modules.
    4343
    4444* '''Sys Admin'''
     
    4646== User Stories ==
    4747
    48  * As an end user, I want a wizard to guide me and help me through different resources available in Sahana Eden.
    49  * As a developer, I want a workflow engine that can easily generate a robust workflow for me by accepting some simple data.
     48 * As an end user, I want a wizard to guide me and help me through different resources available in Sahana Eden.                   
     49                 * To take a Wizard for registering volunteer, User will click on the Wizard option from the homepage
     50                 * Then user will have to select a register volunteer option .
     51                 * Then the first step will be to enter basic details of a volunteer.
     52                 * As he fills the form he will taken to the next step i.e to enter contact details.
     53                 * The wizard will end when he complete all the steps.
     54 
     55 * As a developer, I want a Multi-step forms Generator that can easily generate a robust wizards for me by accepting some simple data.                 
     56                   * Developer will have define some data to the Generator.
     57                   * Which will be converted into wizards(Multi-step forms) by the Generator.
     58
    5059 * As a mobile user, I want a portable workflow i.e one that works on my mobile devices also.
    5160
     
    5463=== Functional ===
    5564
    56 * Workflow Engine should generate robust workflow wizards by processing the given data.
    57 * Workflow Engine should accept simple data, data can be as simple as resource name and list of field names.   
    58 * Workflow thus generated should have the ability to adapt changes as the data given to workflow engine changes.
    59 * Workflow should also adapt to structural changes if the structure of the given data changes.
    60 * Workflow should provide full access control to the user, they can go back, skip steps and quit at any point.
    61 * Workflow should track the audit trails i.e keeping the record of the running processes as they unfold, so that users can come back to the same point where they left off.
    62 * Workflow Wizard should have a simple and user-friendly user interface.
     65* Generator should accept simple data, data can be as simple as resource name and list of field names.   
     66* Multi-step forms or wizards thus generated should have the ability to adapt changes as the data given to workflow engine changes.
     67* Generator should also adapt structural changes if the structure of the given data changes.
     68* Generator should provide full access control to the user, they can go back, skip steps and quit at any point.
     69* Multi-step forms or wizard should track the audit trails i.e keeping the record of the running processes as they unfold, so that users can come back to the same point where they left off.
     70* Multi-step forms should have a simple and user-friendly user interface.
     71* These Multi-step forms or wizards should be easily available and accessible to the user after successful login.
    6372
    6473=== Non-functional ===
    65 
    66 * The most common operations streamlined to be performed quickly.
    67 * The wizard should be easily available and accessible to the user after successful login.
    6874=== Interoperability ===
    6975=== Standards ===
     
    7379
    7480[[Image(Workflow 1.png)]]
     81
    7582== Design ==
    76 
    7783=== Data Model ===
    7884=== Workflows ===
     
    8086==== As Developer ====
    8187
    82 * Developers will have to provide data to the workflow engine.
     88* Developers will have to define data to the Generator .
    8389* Data possibly will be a resource name along with fields list which makes up an activity.
    8490* These will be followed by control edges (Ex. whether node will be optional,required or not allowed).
    85 * Workflow engine will convert the given data into desired wizard template.
     91* Wizard generator will convert the given data into desired wizard template.
    8692
    8793==== As User ====
     
    103109=== (Prospective) ===
    104110
    105 * The workflow engine will reuse S3SQLCustomForm where possible.
    106 
    107 * The idea is to define a S3WorkflowForm which will be defined as S3SQLCustomForm.
     111* The Multi-step forms Generator will reuse S3SQLCustomForm where possible.
    108112
    109113* It will accept resource name and list of fields along with the description of corresponding edge i.e is the node optional or required.
     
    118122''' Future Implementation '''
    119123
    120 * Making a UI for the Workflow Engine , So that not only developer but sys admin can easily make wizards for different resources or new modules.
     124* Making a UI for Multi-step forms Generator , So that not only developer but sys admin can easily make wizards for different resources or new modules.
    121125
    122126