Merge branch 'master' of wiscigt.powertheword.com:labkey/crf

README.md

@@ -52,23 +52,14 @@ All datasets should be registered by adding them to the inputLists list. The sam
 dataset should already be a part of the inputList.
 
 ### Forms
-CRF consists of a series of forms, contained in the Forms list.
-Each form is a logical assembly of datasets. Each form has a setup, which is a 
-list which specifies which datasets are part of the form, and a title. 
-The only programatical feature that a form has is that all its datasets 
-should be completed before the form is submitted for review. 
-Each form can be reviewed independently.
-
-Some fields are set to default values for historical reasons:
-
-- formUrl: visit0
-- reviewFormUrl: reviewVisit0
-- viewURL: visit0.view
-
-The last field, master query is to be set to the created dataset list. Each form 
-has a master query that contains
-a participantCode field, and that is the field that will be used as the participant 
-assignment field for all datasets in the form. The
+CRF consists of a series of forms, contained in the Forms list. The Forms list has a name, a title and a master query.
+
+Form corresponds to a logical assembly of datasets. The only architectural property of a form has is that all its datasets 
+should be completed before the form is submitted for review. Each form can be reviewed independently.
+
+The last field, master query is to be set to one of the datasets in the form. 
+The master query must contain a participantCode field, and that is the field that 
+will be used as the participant assignment field for all datasets in the form. The
 sample Forms list already has an entry for demographicsData dataset.
 
 ### Form setup
@@ -78,7 +69,8 @@ A form setup is a list of datasets in the form and contains the following fields
 ![setup list][setupList]
 
 For a new setup list entry, set Query Name to the dataset name with Title that can be any string. 
-Other fields are set to NONE by default.
+Other fields are set to NONE by default. The last field is the Form this dataset
+will be a part of.
 
 ![setup list example with NONE][setupListExample1]
 
@@ -98,16 +90,17 @@ worked, the Demographics form should appear in the CRF tab.
 Once you click on create new, a new form is added to the list and the form
 completion portal opens. If you reload the CRF tab, or go back, you should
 see a new yellowish square which corresponds to the form just created. You can edit 
-the form until you are ready to Submit it for further review
+the form until you are ready to Submit it for further review, or Exit if your form
+needs further data.
 
-## Submitting the form
+## Uploading the form to the database
 
 ### Prepare datasets
 When the form gets submitted, a dataset should be created that will get filled with
 data from the (temporary) dataset list. To do that, go to Manage Datasets in 
 Study management, and create a dataset. When asked for fields, click on Import fields and copy
 the output of Export fields, performed in the Design view of the List. For each list
-that gets filled, a mirror dataset is required. Then Submiting the list works.
+that gets filled, a mirror dataset is required. Then Uploading lists works.
 
 ### Setup the review portal
 Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Review Portal web part. This will show all forms that were submitted. If the setup
@@ -118,6 +111,19 @@ Reviewer has two options - to return form to editor or to submit it. If returned
 form will appear on editor portal and editor can change values. If submitted, the 
 data gets copied to datasets. 
 
+## Viewing approved forms and reusing them for minor changes
+
+### Setup approved portal
+Add a tab (Wheel->Page Admin Mode, click on a + tab). Add CRF Manager Portal web part. This will show all forms that were approved. If the setup
+worked, the approved Demographics form should appear in the CRF Manager Portal.
+
+### Reusing approved forms
+Resued forms can be reinserted for editor use by clicking on the Restore for further review button. The form
+is shifted back to the editor, which can change/update values. While not completely to
+standard, this way allows to correct minor errors that were missed in review. Documenting
+causes in review fields is suggested for clarity.
+
+
 
 
 [studyParameters]: img/studyParametersSnapshot.png