Workflow Builder

From CaisisWiki

(Difference between revisions)
Jump to: navigation, search
m
Line 15: Line 15:
# Preview EForm button
# Preview EForm button
-
== The structure of a dynamic EForm can be summarized as follows: ==
+
== Sample EForm Workflow ==
 +
[[File:EFormBuilderDocumentation_Diagram3.png|Sample EForm Workflow]]
 +
 
 +
= The structure of a dynamic EForm can be summarized as follows: =
# Each '''EForm''' is made up of one or more '''sections'''.
# Each '''EForm''' is made up of one or more '''sections'''.
# Each section can hold one or more data entry '''fields'''.  Each of these fields corresponds to a column in the Caisis database.
# Each section can hold one or more data entry '''fields'''.  Each of these fields corresponds to a column in the Caisis database.
-
==EForm Building Basics==
+
=EForm Building Basics=
# '''Give the EForm a name''' in the box on the top left of the screen.
# '''Give the EForm a name''' in the box on the top left of the screen.
# Select the appropriate '''disease''' for the EForm
# Select the appropriate '''disease''' for the EForm
Line 28: Line 31:
# You may '''preview your EForm''' using the "Preview EForm" button at the top of the screen.
# You may '''preview your EForm''' using the "Preview EForm" button at the top of the screen.
# To '''activate the EForm''' as a Workflow in the Data Entry section, you must check off the "Active" box for the EForm in the Manage Workflows list in the Admin section of Caisis.
# To '''activate the EForm''' as a Workflow in the Data Entry section, you must check off the "Active" box for the EForm in the Manage Workflows list in the Admin section of Caisis.
 +
 +
= Using Dynamic EForms for Data Entry =
 +
A dynamic EForm is available for use by users as soon it is activated by an administrator in the Manage Workflows list.  Users will find active EForms in the Workflows menu in the Patient Data section of Caisis.
 +
 +
= Limitations of the Alpha Version =
 +
This alpha version of the EForm Builder is designed to provide administrators a way to build data entry interfaces as easily as possible.  As such, some functionality planned for the final version of the builder have been left out of this alpha.  Several import limitations for the alpha version are listed below.
 +
# The data entry input type for each field is determined by the metadata for that database field; these fields cannot be configured to be different from the Patient Data section of Caisis.  More configuration options will be available in a future version.
 +
# When recording multiple records for any Caisis database table in a single EForm, the fields for that table '''must''' be collected in a DataGrid layout.  In future versions of the EForm Builder, One and Two-Column Lists will be available for use in these cases.  (However, this will add a layer of complexity as the user will have to specify such values as RecordId and ParentRecordId.)
 +
# A List section may have fields from a unlimited number of tables, but a datagrid can only hold records from one table.  Future versions will allow fields from multiple tables in a single DataGrid.
 +
# For any child record, the fields for the parent table must be a One or Two-Column List.  The fields for the parent record cannot be in a DataGrid.
 +
# Currently, all sections for an EForm are displayed on one page.  In the future, the EForm designer will be able to group the sections into multiple pages.

Revision as of 02:56, 3 May 2010

Contents

EForm & Workflow Builder (Alpha)

The new dynamic EForm & Workflow Builder is designed to allow Caisis administrators and data managers to construct EForm type data entry screens without the assistance of a programmer or database administrator. This is accomplished using a simple drag and drop interface.

Basic Features of the EForm Builder

  1. EForm Title
  2. EForm Disease
  3. Available Fields
  4. EForm Sections
    • Section TItle
    • Section Layout selectors
    • Delete Section button
    • Move Section buttons - move section up or down in the section order
  5. Trash - Remove fields from your EForm by dragging them here
  6. Preview EForm button

Sample EForm Workflow

Sample EForm Workflow

The structure of a dynamic EForm can be summarized as follows:

  1. Each EForm is made up of one or more sections.
  2. Each section can hold one or more data entry fields. Each of these fields corresponds to a column in the Caisis database.

EForm Building Basics

  1. Give the EForm a name in the box on the top left of the screen.
  2. Select the appropriate disease for the EForm
  3. A new EForm will have one blank section by default. You may add more sections as needed using the "Add Section" buttons. Give each section a title; if you don't want a section title to display on the user interface, uncheck the "Display Section Title" checkbox for that section. Delete sections using the "X" button found on the top right of the section.
  4. To add a field to your EForm, simply drag it from the Available Fields panel into a section of the EForm. (Use the table select box to choose the database table that contains the field you want to use.) To delete a field from your EForm, drag it from a section into the Trash can on the bottom left of the screen. (Note: the data entry input type is currently determined by the metadata for that database field.)
  5. Adjust the layout of each section by selecting either One-Column List, Two-Column List, or DataGrid layout. You can change the order of sections using the Up and Down arrows next to the section title.
  6. Be sure to save the EForm design regularly using the Save buttons.
  7. You may preview your EForm using the "Preview EForm" button at the top of the screen.
  8. To activate the EForm as a Workflow in the Data Entry section, you must check off the "Active" box for the EForm in the Manage Workflows list in the Admin section of Caisis.

Using Dynamic EForms for Data Entry

A dynamic EForm is available for use by users as soon it is activated by an administrator in the Manage Workflows list. Users will find active EForms in the Workflows menu in the Patient Data section of Caisis.

Limitations of the Alpha Version

This alpha version of the EForm Builder is designed to provide administrators a way to build data entry interfaces as easily as possible. As such, some functionality planned for the final version of the builder have been left out of this alpha. Several import limitations for the alpha version are listed below.

  1. The data entry input type for each field is determined by the metadata for that database field; these fields cannot be configured to be different from the Patient Data section of Caisis. More configuration options will be available in a future version.
  2. When recording multiple records for any Caisis database table in a single EForm, the fields for that table must be collected in a DataGrid layout. In future versions of the EForm Builder, One and Two-Column Lists will be available for use in these cases. (However, this will add a layer of complexity as the user will have to specify such values as RecordId and ParentRecordId.)
  3. A List section may have fields from a unlimited number of tables, but a datagrid can only hold records from one table. Future versions will allow fields from multiple tables in a single DataGrid.
  4. For any child record, the fields for the parent table must be a One or Two-Column List. The fields for the parent record cannot be in a DataGrid.
  5. Currently, all sections for an EForm are displayed on one page. In the future, the EForm designer will be able to group the sections into multiple pages.
Personal tools