=== modified file 'dhis-2/dhis-options/src/main/java/org/hisp/dhis/options/help/DefaultHelpManager.java' --- dhis-2/dhis-options/src/main/java/org/hisp/dhis/options/help/DefaultHelpManager.java 2010-02-23 17:10:02 +0000 +++ dhis-2/dhis-options/src/main/java/org/hisp/dhis/options/help/DefaultHelpManager.java 2010-02-23 19:44:51 +0000 @@ -48,11 +48,9 @@ { try { - TransformerFactory factory = TransformerFactory.newInstance(); - Source stylesheet = new StreamSource( new ClassPathResource( "help_stylesheet.xsl" ).getInputStream() ); - Transformer transformer = factory.newTransformer( stylesheet ); + Transformer transformer = TransformerFactory.newInstance().newTransformer( stylesheet ); transformer.setParameter( "sectionId", id ); === modified file 'dhis-2/dhis-options/src/main/resources/help_content.xml' --- dhis-2/dhis-options/src/main/resources/help_content.xml 2010-02-23 17:10:02 +0000 +++ dhis-2/dhis-options/src/main/resources/help_content.xml 2010-02-23 19:44:51 +0000 @@ -1,40 +1,276 @@ - - - Data Quality - The data quality module provides means to improve the quality of the data in the system. This can be done through validation rules and various statistical checks. -
- Learning Objectives - After reading this module you will be able to understand: - - - What is data quality and its importance for HMIS. - - - How to do data quality check at point of data entry. - - - How to create data validation rules. - - - How to carry out data triangulation. - - - How to analyze data status. - - - This stuff is in a paragraph -
-
- Overview of data quality check - Ensuring data quality is a key concern in building an effective HMIS. Data quality has different dimensions including: - - - Correctness: Data should be within the normal range for data collected at that facility. There should be no gross discrepancies when compared with data from related data elements. - - - Completeness: Data for all data elements for all health facilities/blocks/Taluka/districts should have been submitted. - - - This stuff is in a paragraph -
-
+ + + + + Data Administration in DHIS 2 + The data administration module provides a range of functions to ensure that the data stored in the DHIS2 database is integral and that the database performance is optimised. These functions should be executed on a regular basis by a data administrator to ensure that the quality of the data stored is optimal. +
+ Data browser + The data browser maintenance module allows the user to produce a summary of the data contained in the DHIS2 database. This summary provides the number of data element values that have been recorded for a given time interval and then grouped by the following options: + + + Data sets + + + Data element groups + + + Organisational unit groups + + + Organisational units + + + Each of these options can be accessed by selecting the desired option from "Browse by" drop-down menu. + In order to produce a summary of submitted data for a given period and grouped by data sets, the user should follow this procedure. Begin by selecting a given periodicity type (e.g. Weekly, monthly, yearly, etc) and then a time interval (e.g. January 2009 to March 2009). Select the type of summary to be produced (e.g. Dataset) from the "Browse by" drop-down menu. Click the "Browse" button to view the summary. + + + + + + + + A summary of the number of data element values that have been submitted over the user selected time period is shown below. + + + + + + + + By clicking on the name of the individual dataset, a more detailed summary of each data element can be obtained as shown below. A cross-tab table summarising each time period will be shown. + + + + + + + + The functionality of the grouping by Datasets, Data element groups, and Organisational groups is essentially the same. + The functionality of grouping by organisation units will be discussed below. Begin by selecting "Organisation units" from the "Browse by" drop-down menu. The organisational hierarchy present in the database will now be displayed. Organisational units can be expanded by clicking on the plus symbol in the organisational tree view. + + + + + + + + By clicking on an organisational unit, and the clicking the "Browse" button, a summary of submitted data elements present in the database is returned for all immediate children of the selected organisational as shown below + + + + + + + + By clicking on one of the organisational units, a detailed list of data elements is presented by each time period as shown below. + + + + + + + For each of the data browser summaries, a PDF export can be produced by specifying a filename in the "Filename" field, selecting a font size, a page layout (Landscape or Portrait) and pressing the "Export PDF" button. You will then be prompted to select a location to save the file to, which can then be viewed with any PDF reader (e.g. Adobe Acrobat Reader, xpdf, etc). +
+
+ Data integrity + DHIS2 can perform a wide range of data integrity checks on the data contained in the database. Identifying and correcting data integrity issues is extremely important for ensuring that the data used for analysis purposes is valid. Each of the data integrity checks that are performed by the system will be described, along with general procedures that can be performed to resolve these issues. +
+ Data elements without data set + Each data element must be assigned to a data set. Values for data elements will not be able to be entered into the system if a data element is not assigned to a data set. Choose Maintenance->Datasets->Edit from the main menu and then add the "orphaned" data element to the appropriate data set. +
+
+ Data elements without groups + Some Data Elements have been allocated to several Data Element Groups. This is currently not allowed, because it will result in duplication of linked data records in the PivotSource recordsets that `feed` the pivot tables. Go to Maintenance -> Data Element Groups to review each Data Element identified and remove the incorrect Group allocations. +
+
+ Data elements assigned to data sets with different period types + Data Elements should not be assigned to two separate data sets whose period types differ. The recommended approach would be to create two separate data elements (for instance a monthly and yearly data element) and assign these to respective datasets. +
+
+ Data sets not assigned to organisation units + All data sets should be assigned to at least one organisation unit. +
+
+ Indicators with identical formulas + Although this rule will not affect data quality, it generally does not make sense to have two indicators with the exact same definition. Review the identified indicators and their formulas and delete or modify any indicator that appears to be the duplicate. +
+
+ Indicators without groups + All Data Elements and Indicators must be assigned to at least one group, so these Indicators need to be allocated to their correct Data Element and Indicator Group. Go to Maintenance -> Indicator Groups, and allocate each of the `Orphaned` Indicators to its correct group. +
+
+ Invalid indicator numerators + Violations of this rule may be caused by an incorrect reference to a deleted or modified data element. Review the indicator and make corrections to the numerator definition. +
+
+ Invalid indicator denominators + Violations of this rule may be caused by an incorrect reference to a deleted or modified data element. Review the indicator and make corrections to the denominator definition. +
+
+ Organisation units with cyclic references + Organisation units cannot be both parent and children of each other, directly nor indirectly. +
+
+ Orphaned organisation units + All organisation units must exist within the organisation unit hierarchy. Go to Organisation->Hierarchy Operations and move the offending organisation unit into the proper position in the hierarchy. +
+
+ Organisation units without groups + All organisation units must be allocated to at least one group. The problem might either be that you have not defined any `compulsory` OrgUnit Group Set at all, or that there are violations of the `compulsory` rule for some OrgUnits . NOTE: If you have defined no `compulsory` OrgUnit Group Sets, then you must first define them by going to Maintenance -> Organisation units->Organisation unit group sets and define at least one `compulsory` Group Set (the group set `OrgUnitType` are nearly universally relevant). If you have the relevant group sets, go to Maintenance -> OrgUnit Groups to review each OrgUnit identified and add the relevant Group allocation. +
+
+ Organisation units violating compulsory group sets + These organisation units have not been assigned to the any organisation unit group within one of the compulsory organisation unit group sets. When a group set is defined as `compulsory`, it means that an organisation unit must be allocated to at least one organisation unit group within that group set. For instance, all organisation units must belong to one of the groups in the `organisation unitType` group set. It might belong to the `Hospital` or the `Clinic` or any other `type` group - but it must belong to exactly one of them. Go to Maintenance -> organisation unit->Organisation unit groups to review each organisation unit identified in the integrity check. Allocate all organisation units to exactly one group. +
+
+ Organisation units violating exclusive group sets + Some organisation units have been allocated to several organisation unit groups that are members of the same exclusive organisation unit group set. When a group set is defined as exclusive, it means that an organisation unit can only be allocated to one organisation unit group within that Group Set. For instance, one organisation unit cannot normally belong to the both the 'Hospital' and 'Clinic' groups , but rather to only to one of them. Go to Maintenance -> organisation unit->Organisation unit groups to review each organisation unit identified in the integrity check. Remove the organisation unit from all groups except the one that it should be allocated to. +
+
+ Organisation unit groups without group sets + The organisation unit groups listed here have not been allocated to a group set. Go to Maintenance->Organisation unit->Organisation unit group sets and allocate the Organisation unit group to the appropriate group set. +
+
+ Validation rules without groups + All validation rules must be assigned to a group. Go to Services->Data quality->Validation rule group and assign the offending validation rule to a group. +
+
+ Invalid validation rule left side expressions + An error exists in the left-side validation rule definition. Go to Services->Data quality->Validation rule and click the "Edit" icon on the offending rule. Press "Edit left side" and make the corrections that are required. +
+
+ Invalid validation rule right side expressions + An error exists in the left-side validation rule definition. Go to Services->Data quality->Validation rule and click the "Edit" icon on the offending rule. Press "Edit right side" and make the corrections that are required. +
+
+
+ Maintenance + The data maintenance module has five options, each described below. + + + Clear hierarchy history + DHIS 2 maintains an audit trail of changes to the organisation unit hierarchy for aggregation purposes. This function clears the hierarchy history. + + + Clear data mart (aggregated datavalues) + The data mart is where DHIS 2 stores aggregated data produced during the export to data mart process. This function clears the database table which contains aggregated data element values. + + + Clear data mart (aggregated indicatorvalues) + The data mart is where DHIS 2 stores aggregated data produced during the export to data mart process. This function clears the database table which contains aggregated indicator values. + + + Clear zero values + This function removes zero data values from the database. Values registered for data elements with aggregation operator average is not removed, as such values will be significant when aggregating the data, contrary to values registered for data elements with aggregation operator sum. Reducing the number of data values will improve system performance. + + + Clear dataset completeness + This function removes aggregated dataset completeness values. This data is produced and used by report tables. + + + Prune periods + This function removes all periods which have no registered data values. Reducing the number of periods will improve system performance. + + +
+
+ Resource tables + Resource tables are supporting tables that are used during analysis of data. One would typically join the contents of these tables with the data value table when doing queries from third-party applications like Microsoft Excel. Simply select the tables that should be regenerated and press "Generate tables". Regeneration of the resource tables should only be done once all data integrity issues are resolved. + + + Organisation unit structure (orgunitstructure) + This table should be regenerated any time there have been any changes made to the organisational unit hierarchy. This table provides information about the organisation unit hierarchy. It has one row for each organisation unit, one column for each organisation unit level and the organisation unit identifiers for all parents in the lineage as values. + + + Exclusive organisation unit groupset structure normalized (orgunitgroupsetstructure) + This table provides information about the which organisation units are member of which organisation unit group sets. + + + Data element group set structure (_dataelementgroupsetstructure) + This table provides information about which data elements are members of which data element group sets. The table has one row for each data element, one column for each data element group set and the names of the data element group as values. + + + Indicator group set structure (_indicatorgroupsetstructure) + This table provides information about which indicators are members of which indicator group sets. The table has one row for each indicator, one column for each indicator group set and the names of the indicator group as values. + + + Organisation unit group set structure (_organisationunitgroupsetstructure) + This table provides information about which organisation units are members of which organisation unit group sets. The table has one row for each organisation unit, one column for each organisation unit group set and the names of the organisation unit groups as values. + + + Category structure (_categorystructure) + This table provides information about which data elements are members of which categories. The table has one row for each data element, one column for each category and the names of the category options as values. + + + Data element category option combo name (categoryoptioncomboname) + This table should be regenerated any time there have been changes made to the category combination names. It contains readable names for the various combinations of categories. + + +
+
+ Organisation unit merge + This function is useful when two organisation units need to be merged, eg. it is decided that one facility will be shut down and its services will be provided by a nearby facility. + Start by selecting the organisation unit to eliminate from the tree and click confirm. Then select the organisation unit to keep and click confirm again. Finally, verify the selection and click merge. + In the sitation where data exist for the organisation unit to eliminate and not for the one to keep, the data will be moved to the one to keep. When data exists for both organisation units, the data will be summarized and moved to the one to keep. When data exists only for the one to keep, no action is taken. The organisation unit to eliminate will eventually be deleted. +
+
+ Duplicate data elimination + This function is useful when data has been entered mistakenly for two data elements which represents the same phenomena. + Start by selecting the data element to eliminate from the list and click confirm. Then select the data element to keep and click confirm again. Finally, verify the selection and click merge. + In the situation where data exists for the data element to eliminate and not for the one to keep, the data will be moved to the one to keep. When data exists for both data elements, the data which was updated last will be used. When data exists only for the one to keep, no action will be taken. The data element to eliminate will eventually be deleted, except when it is a multidimensional data element and has other data registered. +
+
+ Data statistics + The data statistics module provides an overview of the number of objects stored in the DHIS2 database. + + + + + + + + The total number of each type of object is presented in a table, as well as a graph. +
+
+ Data locking + This module gives users the privilege of locking certain datasets for chosen organisation units. This encourages timely data entry and prevents unwanted to changes to the data once it has been entered. When the ‘Data Administration’ option is chosen the data locking interface is displayed. The user has to select the periodicity of the report e.g. monthly, quarterly or + yearly for which the data is to be locked. The month, quarter or year for which the reports are to be locked is then specified. + + + + + + + + The unlocked data sets for the period are displayed and the user will then have to choose the data sets to be locked. + + + + + + + + + After choosing the datasets to be locked, double click on each one by one to display the organisation unit tree in the field below. Click on the organisation unit to lock the dataset. + + + + + + + + + The Apply Locks on All button locks the dataset for all the organisation units to which that dataset has been assigned. ‘Remove locks on All’ removes all locks put on the organisation units corresponding to the selected dataset. After the operations are completed the user must click ‘Save’ to apply the settings. The ‘Lock at level’ button locks datasets at a particular level that the user chooses. . ‘Unlock at Level’ removes locks that have been put on the organisation units corresponding to the selected dataset at the selected level. After the operations are completed, the user must click ‘Save’ to apply the settings. The ‘Save’ button will also lock those organisation unit datasets that have been specified by the user. + +
+
+ Zero value storage + The zero value storage function makes it possible to define for which data elements the system should store zero values. In most cases zeros are significant only for a subset of the data elements in the database. Zero values will be ignored during data entry for selected data elements. +
+
+ Cache Statistics + This option is for system administrators only to use. The cache statistics shows the status of the application level cache. The application level cache refers to the objects and query results that the application is caching in order to speed up performance. If the database has been modified directly the application cache needs to be cleared for it to take effect. +
+
+
\ No newline at end of file === modified file 'dhis-2/dhis-options/src/main/resources/help_stylesheet.xsl' --- dhis-2/dhis-options/src/main/resources/help_stylesheet.xsl 2010-02-23 17:10:02 +0000 +++ dhis-2/dhis-options/src/main/resources/help_stylesheet.xsl 2010-02-23 19:44:51 +0000 @@ -28,7 +28,7 @@ - + === modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css' --- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css 2010-02-23 18:58:09 +0000 +++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/dhis-web-commons/css/widgets.css 2010-02-23 19:44:51 +0000 @@ -18,6 +18,7 @@ padding-right: 15px; padding-top: 9px; padding-bottom: 9px; + overflow: auto; } #hideRightBar === modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/images/help.png' Binary files dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/images/help.png 2009-04-20 14:54:22 +0000 and dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/images/help.png 2010-02-23 19:44:51 +0000 differ === modified file 'dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/macros.vm' --- dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/macros.vm 2009-11-02 18:13:58 +0000 +++ dhis-2/dhis-web/dhis-web-commons-resources/src/main/webapp/macros.vm 2010-02-23 19:44:51 +0000 @@ -91,7 +91,7 @@ #end #macro( openHelp $id ) -$i18n.getString( 'help' ) +$i18n.getString( 'help' ) #end #macro( introListItem $action $objectKey ) === modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataBrowserForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataBrowserForm.vm 2009-10-28 12:38:33 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataBrowserForm.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "data_browser" )

+

$i18n.getString( "data_browser" ) #openHelp( "dataBrowser" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataIntegrityForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataIntegrityForm.vm 2010-02-01 15:30:27 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/dataIntegrityForm.vm 2010-02-23 19:44:51 +0000 @@ -6,7 +6,7 @@ #end -

$i18n.getString( "data_integrity_checks_performed" )

+

$i18n.getString( "data_integrity_checks_performed" ) #openHelp( "dataIntegrity" )

#parse( "dhis-web-commons/loader/loader.vm" ) === modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/duplicateDataEliminationForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/duplicateDataEliminationForm.vm 2010-02-04 12:29:22 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/duplicateDataEliminationForm.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "duplicate_data_elimination" )

+

$i18n.getString( "duplicate_data_elimination" ) #openHelp( "duplicateDataElimination" )


=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/lockingForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/lockingForm.vm 2009-12-29 07:14:28 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/lockingForm.vm 2010-02-23 19:44:51 +0000 @@ -1,4 +1,4 @@ -

$i18n.getString( "data_locking_form" )

+

$i18n.getString( "data_locking_form" ) #openHelp( "dataLocking" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/maintenanceForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/maintenanceForm.vm 2009-12-17 09:22:20 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/maintenanceForm.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "maintenance" )

+

$i18n.getString( "maintenance" ) #openHelp( "maintenance" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/organisationUnitMergeForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/organisationUnitMergeForm.vm 2010-01-25 11:54:22 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/organisationUnitMergeForm.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "organisation_unit_merge" )

+

$i18n.getString( "organisation_unit_merge" ) #openHelp( "organisationUnitMerge" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/resourceTableForm.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/resourceTableForm.vm 2010-01-15 11:32:18 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/resourceTableForm.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "resource_table" )

+

$i18n.getString( "resource_table" )#openHelp( "resourceTables" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/showcache.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/showcache.vm 2009-03-03 16:46:36 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/showcache.vm 2010-02-23 19:44:51 +0000 @@ -9,7 +9,7 @@ } -

$i18n.getString( "cache_statistics" )

+

$i18n.getString( "cache_statistics" ) #openHelp( "cacheStatistics" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/viewStatistics.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/viewStatistics.vm 2009-10-07 18:53:11 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/viewStatistics.vm 2010-02-23 19:44:51 +0000 @@ -1,5 +1,5 @@ -

$i18n.getString( "data_statistics" )

+

$i18n.getString( "data_statistics" ) #openHelp( "dataStatistics" )

=== modified file 'dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/zeroValueStorageManagement.vm' --- dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/zeroValueStorageManagement.vm 2010-01-28 09:50:27 +0000 +++ dhis-2/dhis-web/dhis-web-maintenance/dhis-web-maintenance-dataadmin/src/main/webapp/dhis-web-maintenance-dataadmin/zeroValueStorageManagement.vm 2010-02-23 19:44:51 +0000 @@ -1,4 +1,5 @@ -

$i18n.getString( "zero_storage_management" )

+ +

$i18n.getString( "zero_storage_management" ) #openHelp( "zeroValueStorage" )