dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #13925
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 394: Reworked datasets/data entry forms section.
------------------------------------------------------------
revno: 394
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2011-09-13 17:24:17 +0200
message:
Reworked datasets/data entry forms section.
added:
src/docbkx/en/resources/images/datasets/
src/docbkx/en/resources/images/datasets/custom_forms_data_elements.png
src/docbkx/en/resources/images/datasets/datasets_0.png
src/docbkx/en/resources/images/datasets/grey_field_management.png
modified:
src/docbkx/en/dhis2_user_man_datasets_forms.xml
--
lp:~dhis2-documenters/dhis2/dhis2-docbook-docs
https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs
Your team DHIS 2 developers is subscribed to branch lp:~dhis2-documenters/dhis2/dhis2-docbook-docs.
To unsubscribe from this branch go to https://code.launchpad.net/~dhis2-documenters/dhis2/dhis2-docbook-docs/+edit-subscription
=== modified file 'src/docbkx/en/dhis2_user_man_datasets_forms.xml'
--- src/docbkx/en/dhis2_user_man_datasets_forms.xml 2011-03-15 10:29:11 +0000
+++ src/docbkx/en/dhis2_user_man_datasets_forms.xml 2011-09-13 15:24:17 +0000
@@ -3,68 +3,131 @@
<chapter>
<title>Datasets and data entry forms</title>
<section id="datasets">
- <title>Data Entry Forms and Datasets in DHIS2</title>
- <para>All data entry in DHIS2 is organised through the use of Datasets. You can add and edit datasets in Maintenance->Datasets. A DataSet is a collection of data elements grouped together for data collection and data export between instances of DHIS2 (e.g. from a district office local installation to a national server). </para>
+ <title>Datasets</title>
+ <para>All data entry in DHIS2 is organised through the use of datasets. You can add and edit datasets in Maintenance->Datasets. A dataset is a collection of data elements grouped together for data collection and data export between instances of DHIS2 (e.g. from a district office local installation to a national server). .</para>
<para>A dataset also has a frequency which controls the data collection frequency, which can be daily, weekly, monthly, quarterly, six-monthly, or yearly. Both which data elements to include in the dataset and the frequency is set in the Add/Edit Dataset window, together with a name, short name, and code.
In order to use a dataset to collect data for a specific orgunit you must assign the orgunit to the dataset, and this mechanism controls which orgunits that can use which datasets. </para>
- <para>You can assign orgunits to a dataset in the Dataset Management (list of available datasets are shown) by clicking on the blue folder icon, the first icon under Operations, corresponding to the dataset you would like to modify. Alternatively you can manage orgunit assignments for all datasets together in the Dataset Assignment Editor (available in the right-side menu for Datasets). </para>
+ <para>Datasets also are assigned to specific organisation units which will be allowed to enter data for all data elements in a given dataset. You can assign orgunits to a dataset in the Dataset Management (list of available datasets are shown) by clicking on the blue folder icon, the first icon under Operations, corresponding to the dataset you would like to modify. Alternatively you can manage orgunit assignments for all datasets together in the Dataset Assignment Editor (available in the right-side menu for Datasets). </para>
<para>Your dataset will then be ready to be used in Services->Data Entry for the orgunits that you have assigned and for periods according to your selected frequency (period type).</para>
+ <section>
+ <title>Dataset management</title>
+ <para>The dataset management function allows you to create new datasets and manage existing ones. The dialog can be reached by choosing Maintenance->Datasets->Dataset. A sample dialog is displayed below.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="70%" align="center" fileref="resources/images/datasets/datasets_0.PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <itemizedlist>
+ <para>Each of the functions is described below.</para>
+ <listitem>
+ <para>Sort: This controls the custom sort order. Depending on the systems settings, users will see the datasets ordered in the specific order which you provide. </para>
+ </listitem>
+ <listitem>
+ <para>Add new: Adds a new dataset. When pressing this button, you can create a new dataset. You need to provide a name, shortname and frequency. The "Code" attribute is optional. Data elements can be added to the "Selected data element" list by selecting them individually. and pressing the <inlinegraphic fileref="resources/images/dhis2_images/move_right.png"/> button. Indicators can also be added to data sets and will be available to be placed in custom data entry forms when they need to be shown along with data elements on the same data entry form. Press "Save" to add the new dataset. </para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/assign.png"/> Assign organisation units to datasets: This function will allow you to assign individual organisational units to a dataset. Only organisational units which have been assigned to a dataset will be allowed to enter data into the dataset. </para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/edit.png"/> Edit dataset: This will allow you to edit existing datasets, for instance when you need to add or remove data elements and indicators to a given dataset.</para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/i18n.png"/> Translate: Allows you to translate the name of a dataset to a different language.</para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/edit_layout.png"/> Create or edit a custom data entry form. Refer to <xref linkend="customDataEntryForms"/> for detailed information of how to use this function. </para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/edit_compulsory_data_elements.png"/> Edit compulsory data elements: This dialog will allow you to add or remove data elements which will be marked as compulsory during data entry. </para>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/delete.png"/> Delete: Completely removes a dataset from the system. </para>
+ <warning>
+ <para>Any dataset which is deleted from the system, is irrevocably lost. All data entry forms, and sectrion forms which may have been developed will also be removed. Ensure that you have made a backup of your database before deleting any dataset in case you need to restore it at some point in time.</para>
+ </warning>
+ </listitem>
+ <listitem>
+ <para><inlinegraphic fileref="resources/images/dhis2_images/information.png"/> Information: Display some informative information about the dataset, including the number of data elements, the frequency, and which data entry form has been assigned to the dataset.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
</section>
<section>
<title>Data Entry Forms</title>
<para>Once you have assigned a dataset to an orgunit that dataset will be made available in Data Entry (under Services) for the orgunits you have assigned it to. A default data entry form will then be shown, which is simply a list of the data elements you belonging to the dataset together with a column for inputting the values. If your dataset contains data elements with a non-default categorycombination, such as age groups or gender then additional columns will be automatically generated in the default form based on the different options/dimensions. </para>
- <para>If you use more than one categorycombination you will get multiple columns in the data entry form with different column headings for the options.
+ <para>If you use more than one dataelement category combination you will get multiple columns in the data entry form with different column headings for the options.
In addition to the default list-based data entry form there are two more alternatives, the section-based form and the custom form.</para>
+ <section>
+ <title>Section forms</title>
+ <para>Section forms allow for a bit more flexibility when it comes to using tabular forms and are quick and simple to design. Often your data entry form will need multiple tables with subheadings, and sometimes you need to disable (grey out) a few fields in the table, both of these functions are supported in section forms. This function can be access by choosing Maintenance->Dataset Section. </para>
+ </section>
<section id="dataset_sections">
- <title>Section forms</title>
- <para>Section forms allow for a bit more flexibility when it comes to using tabular forms and are quick and simple to design. Often your data entry form will need multiple tables with subheadings, and sometimes you need to disable (grey out) a few fields in the table, both of these functions are supported in section forms. </para>
- <screenshot>
- <screeninfo>Section form example</screeninfo>
- <mediaobject>
- <imageobject>
- <imagedata width="100%" fileref="resources/images/dhis2UserManual/section_form.png" format="PNG"/>
- </imageobject>
- </mediaobject>
- </screenshot>
+ <title>Adding a new section form</title>
+ <para>Section forms are separated automatically by data element category combinations, which produce a spreadsheet like data entry form for each section. </para>
<para>When designing a section form the procedure is as follows:
</para>
- <para>1) Set up your dataset as described above
-</para>
- <para>2) Open the DataSet Section window (from right side menu under Datasets) and add your sections one by one
-</para>
- <para>3) For each section you have the option to disable certain fields by accessing the Section grey field management window under Operations (second icon).
-</para>
- <para>4) Finally, in Dataset Section management, select your Dataset, then leave [All] in Category Combo, and click on Sort section to sort the order of appearance of your sections in the data entry form.
-</para>
- <para>5) In Data Entry you can now start using the Section form (should appear automatically when sections are available for the selected dataset). You can switch between default and section forms in the top right corner of the data entry screen.</para>
- <section>
- <title>Adding/editing dataset sections</title>
- <para>Under Maintenance->Dataset select Dataset Section in the right-side menu. To add new section first select your Dataset (above the section list) and then the Category Combo, and click on the <Add new> button. </para>
- <para>NOTE that you can only use one categorycombo per section (this is because each categorycombo requires a new table). </para>
- <para>To Edit an existing Section simply click on the Edit icon under Operations next to the section you want to edit.
-</para>
- <para>In the Add/Edit Dataset Section window you must provide a Name and a Title for your section. The Title is used as a heading above the section's table in the data entry form. The Name is used in Dataset section management when listing available sections. </para>
- <para>Under Available data elements you will see all the data elements allocated to your dataset that have not yet been assigned to a section. You can change the order of appearance of the selected data elements by using the green arrows. This is then the order used in the data entry form. </para>
- <para>Fill in the Name, Title, select the data elements to use, and then Save the section.</para>
- </section>
- <section>
- <title>Grey field management</title>
- <para>In Dataset section management, locate the section you want to modify and click on the Section grey field management icon under Operations. You will then see the table corresponding to your section and for each field there is a <Disable> button. </para>
- <para>For the fields you want to disable you simply click on the <Disable> button and you will see that the field goes grey and that the button changes to <Enable>. To undo the disabling you then click on Enable. When you have finished the disabling then click on <Done>.</para>
- </section>
+ <orderedlist>
+ <listitem>
+ <para> Set up your dataset as described in <xref linkend="datasets"/></para>
+ </listitem>
+ <listitem>
+ <para>Open the DataSet Section window (from right side menu under Datasets) and add your sections one by one. To add a new section to a section form, first choose the dataset from the "Select dataset" combo box. Then choose the specific category combo and press "Add new". You can now add data elements from the "Available data element" list on the left to the "Selected data elements" list on the right. Data elements can be sorted within the section with the use of the "Move up" <inlinegraphic fileref="resources/images/dhis2_images/move_up.png"/> and "Move down" <inlinegraphic fileref="resources/images/dhis2_images/move_down.png"/> buttons. Be sure to press "Save" once you have finished.<note>
+ <para>You can only use one data element category combination per section. </para>
+ </note></para>
+ </listitem>
+ <listitem>
+ <para> You may need to control how the data element sections are displayed on the final form. In Dataset Section management, select the dataset from the "Dataset" drop-down box, then leave [All] in the "Select Category Combo" drop-down. Click on "Sort section" to sort the order of appearance of your sections in the data entry form.
+</para>
+ </listitem>
+ <listitem>
+ <para>In Data Entry you can now start using the Section form (should appear automatically when sections are available for the selected dataset). Datasets which have section forms will automatically display the section form.</para>
+ </listitem>
+ <listitem>
+ <para>Certain data elements may need to be disabled for data entry. Clicking on the <inlinegraphic fileref="resources/images/dhis2_images/edit_layout.png"/> "Section grey field management" icon will allow you to disable specific data element category options as seen below. Pressing the "Disable" button will prevent data from being entered into this specific data element/category option during data entry. Be sure to press "Done" to save your changes.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/datasets/grey_field_management.PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </listitem>
+ </orderedlist>
+ <para>A sample section form is displayed in the next figure. Notice how each data element category has been separated into a separate section, and a data entry table has been automatically generated by the system. Use of section forms in combination with data element categories can drastically reduce the amount of time which is required to create data entry forms for datasets.</para>
+ <screenshot>
+ <screeninfo>Section form example</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="100%" fileref="resources/images/dhis2UserManual/section_form.png" format="PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
</section>
<section>
- <title>Custom Forms</title>
- <para>When the form you want to design is to complicated for the default or section forms then your last option is to use a custom form. This takes more time, but gives you full flexibility in term of the design. We use a built in HTML editor (FcK Editor) for the form designer and you can either design the form in the UI or paste in your html directly (using the Source window in the editor. </para>
- <para>Once a custom form has been added to a dataset it will be available in data entry and used automatically. You can switch back to default and section (if exists) forms in the top right corner of the data entry screen.</para>
+ <title id="customDataEntryForms">Custom Forms</title>
+ <para>When the form you want to design is to complicated for the default or section forms then your last option is to use a custom form. This takes more time, but gives you full flexibility in term of the design. DHIS2 uses a built-in HTML editor (FcK Editor) for the form designer and you can either design the form in the UI or paste in your HTML directly (using the Source window in the editor). A complete reference for use of the editor can be found <ulink url="http://docs.cksource.com/CKEditor_3.x/Users_Guide";>here</ulink>.</para>
+ <para>One of the big advantages of custom forms, is that they can be created to mimic existing paper aggregation forms. This makes data entry much easier for users, and should reduce the number of data elements which are incorrectly entered, as they are more easily identifiable when entering data from a paper form. </para>
+ <para>Once a custom form has been added to a dataset it will be available in data entry and used automatically. </para>
+ <note>
+ <para>Custom forms are preferentially displayed over section forms. If a dataset has both a section form and a custom form, the custom form will be displayed during data entry. Users will not be able to select which method they wish to input data, so be sure that your custom form contains all data elements which may be required.</para>
+ </note>
<para>To add a custom form design to a dataset then first locate your dataset in the Dataset Management window and click on the Design data entry form icon under Operations (the fifth icon), see the mouse-over text to be sure.
</para>
- <para>First provide a Name for the form. There are a few important buttons in the Editor that you must pay special attention to. The blue monitor icon is the full screen mode on/off button, which can be very useful. The there is a Source button that shows the html code for your form. </para>
- <para>If you already have the html for your form then you should start by pasting it in here. Click on Source again to go back to preview/non-html mode. Then there is an icon in the top right corner with a + sign on it, this will open a list of available data elements to add to your form, the Data Element Selector window. </para>
- <para>All the input fields need to have a link to a data element in order to save the value to the correct data element. To add a data element click on the data element, then on the desired categoryoptioncombo, and then click on OK. This will add a data field to your form which shows the linked data element+catoptioncombo. </para>
- <para>You can to intermediary saving by clicking on the Save button, and this will not close the window. We recommend saving often not to loose your work. </para>
+ <para>First provide a Name for the form. There are a few important buttons in the Editor that you must pay special attention to. The blue monitor icon is the full screen mode on/off button, which can be very useful. The there is a Source button that shows the HTML code for your form. </para>
+ <para>If you already have the HTML for your form then you should start by pasting it in here. Click on Source again to go back to preview/non-html mode. Then there is an icon in the top right corner with a + sign on it, this will open a list of available data elements to add to your form, the Data Element Selector window. </para>
+ <para>All the input fields need to have a link to a data element or indicator. To add new data elements to the form, double-click them from the data element/indicator box as shown below. You can also select a data element/indicator and press the "+Insert" button. You can switch between either data elements or indicators by pressing the respective buttons.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/datasets/custom_forms_data_elements.png" width="50%" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>You can to intermediary saving by clicking on the Save button, and this will not close the window. It is recommended to save often to ensure you do not loose your work. </para>
<para>When you are done or want to test your form in data entry click on <Save and close>.
</para>
</section>
=== added directory 'src/docbkx/en/resources/images/datasets'
=== added file 'src/docbkx/en/resources/images/datasets/custom_forms_data_elements.png'
Binary files src/docbkx/en/resources/images/datasets/custom_forms_data_elements.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/datasets/custom_forms_data_elements.png 2011-09-13 15:24:17 +0000 differ
=== added file 'src/docbkx/en/resources/images/datasets/datasets_0.png'
Binary files src/docbkx/en/resources/images/datasets/datasets_0.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/datasets/datasets_0.png 2011-09-13 15:24:17 +0000 differ
=== added file 'src/docbkx/en/resources/images/datasets/grey_field_management.png'
Binary files src/docbkx/en/resources/images/datasets/grey_field_management.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/datasets/grey_field_management.png 2011-09-13 15:24:17 +0000 differ
