=== modified file 'src/docbkx/en/dhis2_user_man_datasets_forms.xml' --- src/docbkx/en/dhis2_user_man_datasets_forms.xml 2010-10-21 09:53:34 +0000 +++ src/docbkx/en/dhis2_user_man_datasets_forms.xml 2010-12-09 10:45:15 +0000 @@ -1,41 +1,63 @@ - + Datasets and data entry forms -
+
Data Entry Forms and Datasets in DHIS2 - 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). 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. + 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). + 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. 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). Your dataset is now 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). +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. + 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). + 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).
Data Entry Forms - 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. If you use more than one categorycombination you will get multiple columns in the data entry form with different column headings for the options. + 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. + If you use more than one categorycombination 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. -
+
Section forms - 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. When designing a section form the procedure is as follows: -1) Set up your dataset as described above -2) Open the DataSet Section window (from right side menu under Datasets) and add your sections one by one -3) For each section you have the option to disable certain fields by accessing the Section grey field management window under Operations (second icon). -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. -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. + 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. + When designing a section form the procedure is as follows: + + 1) Set up your dataset as described above + + 2) Open the DataSet Section window (from right side menu under Datasets) and add your sections one by one + + 3) For each section you have the option to disable certain fields by accessing the Section grey field management window under Operations (second icon). + + 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. + + 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.
Adding/editing dataset sections - 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. NOTE that you can only use one categorycombo per section (this is because each categorycombo requires a new table). To Edit an existing Section simply click on the Edit icon under Operations next to the section you want to edit. -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. 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. Fill in the Name, Title, select the data elements to use, and then Save the section. + 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. + NOTE that you can only use one categorycombo per section (this is because each categorycombo requires a new table). + To Edit an existing Section simply click on the Edit icon under Operations next to the section you want to edit. + + 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. + 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. + Fill in the Name, Title, select the data elements to use, and then Save the section.
Grey field management - 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. 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>. + 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. + 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>.
Custom Forms - 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. 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. + 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. + 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. 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. -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. 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. 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. 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. When you are done or want to test your form in data entry click on <Save and close>. + + 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. + 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. + 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. + 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. + When you are done or want to test your form in data entry click on <Save and close>.
=== modified file 'src/docbkx/en/dhis2_user_man_getting_started.xml' --- src/docbkx/en/dhis2_user_man_getting_started.xml 2010-12-06 21:00:17 +0000 +++ src/docbkx/en/dhis2_user_man_getting_started.xml 2010-12-09 10:45:15 +0000 @@ -186,7 +186,7 @@
-
+
Creating new users and roles This section will describe how to add new users to the DHIS 2 application. @@ -217,7 +217,7 @@ entering the name in the ‘filter by user name’ field as shown above.
-
+
Define a new role As part of creating a user name you are required to define the user role. Do so by clicking on the ‘user role’ appearing on the left side of @@ -359,7 +359,7 @@
-
+
Quick intro to designing a DHIS 2 database The DHIS 2 application comes with a set of tools for data collection, validation, reporting and analysis, but the contents of the database, e.g. what to collect, who should collect it and on what format will depend on the context of use. This metadata need to be populated into the application before it can be used, and this can be done through the user interface and requires no programming or in-depth technical skills of the software. We call this initial process database design or customisation. This section will provide a very quick and brief introduction to DHIS 2 database design and mainly explain the various steps needed to prepare a new DHIS 2 system for use. How to do each step is explained in other chapters, and best practices on design choices will be explained in an implementers manual (expected during first half of 2011). Here are the steps to follow: === modified file 'src/docbkx/en/dhis2_user_man_orgunits.xml' --- src/docbkx/en/dhis2_user_man_orgunits.xml 2010-12-08 13:36:13 +0000 +++ src/docbkx/en/dhis2_user_man_orgunits.xml 2010-12-09 10:45:15 +0000 @@ -14,95 +14,101 @@ How to make changes to the orgunit hierarchy -
+
The organisational hierarchy - The organisational hierarchy defines the organisation using the DHIS 2, the health facilities, administrative areas and other geographical areas used in data collection and data analysis. This dimension to the data is defined as a hierarchy with one root unit (e.g. Ministry of Health) and any number of levels and nodes below. Each node in this hierarchy is called an organisational unit in DHIS 2. The design of this hierarchy will determine the geographical units of analysis available to the users as data is collected and aggregated in this structure. There can only be one organisational hierarchy at the same time so its structure needs careful consideration. Additional hierarchies (e.g. parallel administrative boundaries to the health care sector) can be modeled using organisational groups and group sets, but the organisational hierarchy is the main vehicle for data aggregation on the geographical dimension. Typically national organisational hierarchies in public health have 4-6 levels, but any number of levels is supported. The hierarchy is built up of parent-child relations, e.g. a Country or MoH unit (the root) might have e.g. 8 parent units (provinces), and each province again ( at level 2) might have 10-15 districts as their children. Normally the health facilities will be located at the lowest level, but they can also be located at higher levels, e.g. national or provincial hospitals, so skewed organisational trees are supported (e.g. a leaf node can be positioned at level 2 while most other leaf nodes are at level 5). Note that it is quite easy to make changes to the upper levels of the hierarchy at a later stage, the only problem is changing organisational units that collect data (the leaf nodes), e.g. splitting or merging health facilities. Aggregation up the hierarchy is done based on the current hierarchy at any time and will always reflect the most recent changes to the organisational structure. + The organisational hierarchy defines the organisation using the DHIS 2, the health facilities, administrative areas and other geographical areas used in data collection and data analysis. This dimension to the data is defined as a hierarchy with one root unit (e.g. Ministry of Health) and any number of levels and nodes below. Each node in this hierarchy is called an organisational unit in DHIS 2. + The design of this hierarchy will determine the geographical units of analysis available to the users as data is collected and aggregated in this structure. There can only be one organisational hierarchy at the same time so its structure needs careful consideration. + Additional hierarchies (e.g. parallel administrative boundaries to the health care sector) can be modeled using organisational groups and group sets, but the organisational hierarchy is the main vehicle for data aggregation on the geographical dimension. Typically national organisational hierarchies in public health have 4-6 levels, but any number of levels is supported. + The hierarchy is built up of parent-child relations, e.g. a Country or MoH unit (the root) might have e.g. 8 child units (provinces), and each province again ( at level 2) might have 10-15 districts as their children. Normally the health facilities will be located at the lowest level, but they can also be located at higher levels, e.g. national or provincial hospitals, so skewed organisational trees are supported (e.g. a leaf node can be positioned at level 2 while most other leaf nodes are at level 5). + Note that it is quite easy to make changes to the upper levels of the hierarchy at a later stage, the only problem is changing organisational units that collect data (the leaf nodes), e.g. splitting or merging health facilities. Aggregation up the hierarchy is done based on the current hierarchy at any time and will always reflect the most recent changes to the organisational structure.
Organisation unit maintenance -
+
Organisation units This is where you can create organisation units (from now on referred to as orgunits) and build up the orgunit hierarchy. Orgunits are added one by one as either root unit or a child of a selected unit. The left side menu represents the current organisational hierarchy and if you select a unit there you will see its children listed in the main list of orgunits in the middle of the screen. When an orgunit is selected in the left side menu you can also add new child units to it. To locate an orgunit in the hierarchy you can either navigate through the tree by expanding the branches (click on the + symbol), or search for it by opening the search field (click the green symbol above the root of the hierarchy). In search you can either search for the orgunit name or its code, both will only show exact matches (case-insensitive). To add a new orgunit first select its parent and then click on the Add new button in the top right corner of the list of orgunits. To add a new root orgunit make sure no orgunit is selected in the menu and click on "Add new". The details of adding a new orgunit are explained in the Editing organisational units section below. -
+
Editing organisation units To edit the properties of an existing orgunit first select its parent (if any) in the left side menu, then locate the orgunit in the listed orgunits, and finally click on the "Edit" button next to the name of the orgunit that you want to modify. The following properties can be defined in the Edit (or Create new) window: - - - Name: Define the precise name of the orgunit in this field. Each orgunit must have a unique name. - - - Short name: Typically, an abbreviation of the full name. This attribute is often used in reports to display the name of the orgunit, where there is limited space available. - - - Code: In many countries, orgunits are assigned a code. This code can be entered in this field. - - - Opening date: Used to control which orgunits that where existing at a point in time, e.g. when analysing historical data. Default is 1994-01-01 and can be used when the orgunit was already existing when the data collection process started. - - - Registers data: This property is used to identify which orgunits that can register data or not. Sometimes administrative orgunits at higher levels in the hierarchy are not supposed to register any data. This can help control the data entry process as only orgunits with this property set to Yes will be availabel for data entry. - - - Comment: Any additional information that you would like to add can be put here. - - - Coordinates: This field is used to create the maps in the GIS module. Paste in the coordinates of the orgunit in this field, either a polygon (for orgunits that represent an administrative boundary) or a point (for health facilities). Without this information the GIS module will not work. It might be more efficient to import these coordinates later as a batch job for all orgunits using the import module. See the GIS chapter for more details. - - - URL: You can use this field to insert a URL link to an external web site that has additional information about this specific orgunit. - - + + + Name: Define the precise name of the orgunit in this field. Each orgunit must have a unique name. + + + Short name: Typically, an abbreviation of the full name. This attribute is often used in reports to display the name of the orgunit, where there is limited space available. + + + Code: In many countries, orgunits are assigned a code. This code can be entered in this field. + + + Opening date: Used to control which orgunits that where existing at a point in time, e.g. when analysing historical data. Default is 1994-01-01 and can be used when the orgunit was already existing when the data collection process started. + + + Registers data: This property is used to identify which orgunits that can register data or not. Sometimes administrative orgunits at higher levels in the hierarchy are not supposed to register any data. This can help control the data entry process as only orgunits with this property set to Yes will be availabel for data entry. + + + Comment: Any additional information that you would like to add can be put here. + + + Coordinates: This field is used to create the maps in the GIS module. Paste in the coordinates of the orgunit in this field, either a polygon (for orgunits that represent an administrative boundary) or a point (for health facilities). Without this information the GIS module will not work. It might be more efficient to import these coordinates later as a batch job for all orgunits using the import module. See the GIS chapter for more details. + + + URL: You can use this field to insert a URL link to an external web site that has additional information about this specific orgunit. + +
-
+
Organisation unit group sets - Group sets can be understood as a flexible tool to add more categorisation to orgunits. Any number of group sets can be added, but as a default start all databases will have the two group sets "Type" and "Ownership". Using these group sets will simplify how reporting is done. While a group set like "Type" describes a measure dimension, the actual categories are represented by the groups, and the categorisation of an orgunit through the orgunit's group memberships. This can be understood as a parallel hierarchy of orgunits with the group set as the root ("Type"), the groups at level 2 (e..g "Clinic", "Hospital", "Dispensary"), and the actual orgunits at level 3. The group set can as such provide additional information and dimensionality to the data analysis as data is easily filtered, organised, or aggregated by groups within a group set. For this aggregation to work without any duplication in the data some rules are necessary. A group set is always exclusive, which means that an orgunit cannot be member of more than one group in a group set. If you try otherwise you will get notified by the application and the action not allowed. Furthermore it is possible to define whether a group set is compulsory or not, which will affect the completeness of the data when analysing data using group sets. Compulsory means that ALL orgunits must be member of a group in that group set. + Group sets can be understood as a flexible tool to add more categorisation to orgunits. Any number of group sets can be added, but as a default start all databases will have the two group sets "Type" and "Ownership". Using these group sets will simplify how reporting is done. + While a group set like "Type" describes a measure dimension, the actual categories are represented by the groups, and the categorisation of an orgunit through the orgunit's group memberships. This can be understood as a parallel hierarchy of orgunits with the group set as the root ("Type"), the groups at level 2 (e..g "Clinic", "Hospital", "Dispensary"), and the actual orgunits at level 3. The group set can as such provide additional information and dimensionality to the data analysis as data is easily filtered, organised, or aggregated by groups within a group set. + For this aggregation to work without any duplication in the data some rules are necessary. A group set is always exclusive, which means that an orgunit cannot be member of more than one group in a group set. If you try otherwise you will get notified by the application and the action not allowed. Furthermore it is possible to define whether a group set is compulsory or not, which will affect the completeness of the data when analysing data using group sets. Compulsory means that ALL orgunits must be member of a group in that group set. We recommend that you approach the orgunit grouping in the following sequence (and one group set at a time): 1. Add a new group set (or use one of the ones) 2. Add new groups (names only) and then when you are done go back to the group set and add the groups you just created (in edit group set mode). 3. Go back to each group, one by one, go to edit mode and assign the orgunits that should be member of the group. If you start with 3) above then you will easily end up with exclusive violations when later adding groups to a group set. Following the sequence above this will be checked at the time of assigning orgunits to a group (since the system know which group set that group belongs to). To add a new group set click on the "Add new" button. -
+
Editing organisation unit group sets Click on the "Edit" button next to the name of the orgunit group set that you want to modify. The following properties can be defined in the Edit (or Create new) window: - - - Name: Provide a precise name for the group set. - - - Description: Describe the phenomena the group set is measuring/capturing. - - - Compulsory: Indicate whether ALL orgunits need to be member of a group in this group set or not. - - - groups/Selected groups: Here you assign groups to your group set by using the arrow buttons to move highlighted groups between the two lists (/selected). If no groups appear in the list then you must go to orgunit groups and create new groups there first. Note that assigning groups that will violate the exclusive rule on group sets is not possible, e.g. adding a group that already has assigned an orgunit that again is already member of a group that has already been selected by this group set, will not be possible since one orgunit will end up with two group memberships in the same group set. To avoid such situations we recommend first adding groups to group sets, and then orgunits to groups. - - + + + Name: Provide a precise name for the group set. + + + Description: Describe the phenomena the group set is measuring/capturing. + + + Compulsory: Indicate whether ALL orgunits need to be member of a group in this group set or not. + + + groups/Selected groups: Here you assign groups to your group set by using the arrow buttons to move highlighted groups between the two lists (/selected). If no groups appear in the list then you must go to orgunit groups and create new groups there first. Note that assigning groups that will violate the exclusive rule on group sets is not possible, e.g. adding a group that already has assigned an orgunit that again is already member of a group that has already been selected by this group set, will not be possible since one orgunit will end up with two group memberships in the same group set. To avoid such situations we recommend first adding groups to group sets, and then orgunits to groups. + +
-
+
Organisation unit groups Here you can add new and manage existing organisation groups and their memberships. To add a new orgunit group click on the "Add new" button in the top right corner of the list of groups. -
+
Editing organisation unit groups Click on the "Edit" button next to the name of the orgunit group that you want to modify. The following properties can be defined in the Edit (or Create new) window: - - - Name: Provide a precise name for the orgunit group. - - - Organisation unit tree selection: This is where you assign orgunits to the group. The tree supports multiple selection so select all the orgunits that you want to add (the selected ones appear with orange color) and click on "Save". Click on "Cancel" to undo your changes and return to the list of orgunit groups. Use the "Select at level" button and dropdown if you want to select all orgunits at a specific level in the hierarchy (e.g. all districts). - - + + + Name: Provide a precise name for the orgunit group. + + + Organisation unit tree selection: This is where you assign orgunits to the group. The tree supports multiple selection so select all the orgunits that you want to add (the selected ones appear with orange color) and click on "Save". Click on "Cancel" to undo your changes and return to the list of orgunit groups. Use the "Select at level" button and dropdown if you want to select all orgunits at a specific level in the hierarchy (e.g. all districts). + +
-
+
Organisation unit level Here you specify a contextual name for each level in the hierarchy, e.g. "Country", "Province", "District", "Health Facility", and these names will be used all over the application where levels are referred to. This page will take some time to load if the orgunit hierarchy is very big.
-
+
Hierarchy operations Here you can move orgunits around in the hierarchy by changing the parent of a selected orgunit. This process is done in three steps: 1. Select the orgunit you want to move (in the hierarchy in the left side menu) and click "Confirm" under the "Select an organisation unit to move" label.