dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #03930
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 77: First addition of maintainence module to user manual. Work in progress.
------------------------------------------------------------
revno: 77
committer: Jason Pickering <jason@jason-laptop>
branch nick: dhis2-docbook-docs
timestamp: Thu 2010-01-14 16:47:26 +0200
message:
First addition of maintainence module to user manual. Work in progress.
added:
src/docbkx/en/dhis2_user_man_maintainence.xml
src/docbkx/en/resources/images/maintainence/
src/docbkx/en/resources/images/maintainence/data_browser1.png
src/docbkx/en/resources/images/maintainence/data_browser_dataset_detail.png
src/docbkx/en/resources/images/maintainence/data_browser_org_unit1.png
src/docbkx/en/resources/images/maintainence/data_browser_orgunit2.png
src/docbkx/en/resources/images/maintainence/data_browser_orgunit2a.png
src/docbkx/en/resources/images/maintainence/data_browsing_data_sets.png
src/docbkx/en/resources/images/maintainence/data_locking_select.png
src/docbkx/en/resources/images/maintainence/data_locking_select1.png
src/docbkx/en/resources/images/maintainence/data_locking_select2.png
src/docbkx/en/resources/images/maintainence/data_locking_select3.png
modified:
pom.xml
src/docbkx/en/dhis2_user_man_mod1.xml
src/docbkx/en/dhis2_user_man_mod7.xml
src/docbkx/en/dhis2_user_manual_en.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 'pom.xml'
--- pom.xml 2009-12-11 18:57:46 +0000
+++ pom.xml 2010-01-14 14:47:26 +0000
@@ -16,7 +16,7 @@
<plugins>
<plugin>
<groupId>com.agilejava.docbkx</groupId>
- <!-- <version>2.0.10-SNAPSHOT</version> -->
+ <version>2.0.10-SNAPSHOT</version>
<artifactId>docbkx-maven-plugin</artifactId>
<configuration>
<includes>*.xml</includes>
@@ -34,7 +34,7 @@
<configuration>
<htmlStylesheet>resources/css/docbook_bsd.css</htmlStylesheet>
- <!-- <glossaryCollection>resources/glossary_en.xml</glossaryCollection> -->
+ <glossaryCollection>resources/glossary_en.xml</glossaryCollection>
<sectionAutolabel>1</sectionAutolabel>
<sectionLabelIncludesComponentLabel>1</sectionLabelIncludesComponentLabel>
=== added file 'src/docbkx/en/dhis2_user_man_maintainence.xml'
--- src/docbkx/en/dhis2_user_man_maintainence.xml 1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_user_man_maintainence.xml 2010-01-14 14:47:26 +0000
@@ -0,0 +1,137 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- This document was created with Syntext Serna Free. -->
+<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "docbookV4.5/docbookx.dtd" []>
+<chapter>
+ <title>Maintainence module</title>
+ <section>
+ <title>Introduction</title>
+ <para>When the cursor hovers on the ‘Maintenance’ module, a drop-down menu appears with the following options: </para>
+ <itemizedlist>
+ <listitem>
+ <para>Data administation </para>
+ </listitem>
+ <listitem>
+ <para>Data elements and indicators</para>
+ </listitem>
+ <listitem>
+ <para>Datasets</para>
+ </listitem>
+ <listitem>
+ <para>Configuration</para>
+ </listitem>
+ <listitem>
+ <para>Organisation units</para>
+ </listitem>
+ <listitem>
+ <para>Settings</para>
+ </listitem>
+ <listitem>
+ <para>Users</para>
+ </listitem>
+ </itemizedlist>
+ <para>Each of these options will be described in a dedicated section in the remainder of this document. </para>
+ </section>
+ <section>
+ <title>Data administration</title>
+ <section>
+ <title>Data locking</title>
+ <para>This module gives users the privilege of locking certain datasets for chosen organization units. This encourages timely data entry. 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. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" fileref="resources/images/maintainence/data_locking_select1.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The unlocked data sets for the period are displayed and the user will then have to choose the data sets to be locked.
+</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" fileref="resources/images/maintainence/data_locking_select2.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>After choosing the datasets to be locked, double click on each one by one to display the organization unit tree in the field below. Click on the organization unit to lock the dataset.
+</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" fileref="resources/images/maintainence/data_locking_select3.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The <guibutton>Apply Locks on All</guibutton> button locks the dataset for all the organization units to which that dataset has been assigned. <guibutton>‘Remove locks on All’</guibutton> removes all locks put on the organization units corresponding to the selected dataset. After the operations are completed the user must click <guibutton>‘Save’</guibutton> to apply the settings. The <guibutton>‘Lock at level’</guibutton> button locks datasets at a particular level that the user chooses. . <guibutton>‘Unlock at Level’</guibutton> removes locks that have been put on the organization units corresponding to the selected dataset at the selected level. After the operations are completed, the user must click <guibutton>‘Save’</guibutton> to apply the settings. The <guibutton>‘Save’</guibutton> button will also lock those organization unit datasets that have been specified by the user.
+</para>
+ </section>
+ <section>
+ <title>Data browser</title>
+ <para>The data browser maintainence 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 groupded by the following options:</para>
+ <itemizedlist>
+ <listitem>
+ <para>Data sets</para>
+ </listitem>
+ <listitem>
+ <para>Data element groups</para>
+ </listitem>
+ <listitem>
+ <para>Organisational unit groups</para>
+ </listitem>
+ <listitem>
+ <para>Organisational units</para>
+ </listitem>
+ </itemizedlist>
+ <para>Each of these options can be accessed by selecting the desired option from <guilabel>"Browse by" </guilabel>drop-down menu. </para>
+ <para>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. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/maintainence/data_browser1.png" format="PNG" width="70%" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>A summary of the number of data element values that have been submitted over the user selected time period is shown below. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/maintainence/data_browsing_data_sets.png" format="PNG" width="80%" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para> By clicking on the name of the individual dataset, a more detailed summary of each data element can be obtained as shown below. A crosstab table summarizing each time period will be shown. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="80%" fileref="resources/images/maintainence/data_browser_dataset_detail.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>The functionality of the grouping by Datasets, Data element groups, and Organisational groups is essentially the same. </para>
+ <para>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.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="60%" fileref="resources/images/maintainence/data_browser_org_unit1.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para> 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</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="60%" fileref="resources/images/maintainence/data_browser_orgunit2a.png" format="PNG" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>By clicking on one of the organisational units, a detailed list of data elements is presented by each time period as shown below. <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/maintainence/data_browser_orgunit2.png" format="PNG" width="60%" align="center"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot></para>
+ <para>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 <guibutton>"Export PDF"</guibutton> 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). </para>
+ </section>
+ </section>
+</chapter>
=== modified file 'src/docbkx/en/dhis2_user_man_mod1.xml'
--- src/docbkx/en/dhis2_user_man_mod1.xml 2009-12-09 07:07:19 +0000
+++ src/docbkx/en/dhis2_user_man_mod1.xml 2010-01-14 14:47:26 +0000
@@ -1,6 +1,5 @@
<?xml version='1.0' encoding='UTF-8'?>
-<!-- This document was created with Syntext Serna Free. -->
-<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+<!-- This document was created with Syntext Serna Free. --><!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
<chapter>
<chapterinfo>
<date>12/09/09</date>
@@ -58,14 +57,6 @@
records.</para>
</listitem>
<listitem>
- <para>Promotes streamlining and standardization of data
- records.</para>
- </listitem>
- <listitem>
- <para>Promotes streamlining and standardization of data
- records.</para>
- </listitem>
- <listitem>
<para>Allows creation of an integrated warehouse, which supports
combining data from different sources and conducting cross
analysis.</para>
=== modified file 'src/docbkx/en/dhis2_user_man_mod7.xml'
--- src/docbkx/en/dhis2_user_man_mod7.xml 2009-12-10 20:38:04 +0000
+++ src/docbkx/en/dhis2_user_man_mod7.xml 2010-01-14 14:47:26 +0000
@@ -161,4 +161,20 @@
</section>
</section>
</section>
+ <section>
+ <title>Importing data</title>
+ <section>
+ <title>DXF Import</title>
+ <para>The Data Exchange Format (DXF) is the default XML schema that is used to transport data between two disconnected DHIS2 systems. Importing data from another DHIS2 system is simple. Just select "Services->Import-Export-Import". Click the "Browse" button, and select the name of the file that you wish to import as shown below. </para>
+ <screenshot>
+ <screeninfo>Default import screen</screeninfo>
+ <mediaobject>
+ <imageobject>
+ <imagedata fileref="resources/images/import_export/import_default.png" align="center" width="40%"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para/>
+ </section>
+ </section>
</chapter>
=== modified file 'src/docbkx/en/dhis2_user_manual_en.xml'
--- src/docbkx/en/dhis2_user_manual_en.xml 2009-12-10 14:21:14 +0000
+++ src/docbkx/en/dhis2_user_manual_en.xml 2010-01-14 14:47:26 +0000
@@ -5,6 +5,7 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod1.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod2.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod3.xml" encoding="UTF-8"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_maintainence.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod7.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mod11.xml" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_gis_user_manual_en.xml" encoding="UTF-8"/>
@@ -40,13 +41,5 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_technical_architechture_guide.xml" xpointer="arch_7" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_technical_architechture_guide.xml" xpointer="arch_8" encoding="UTF-8"/>
</appendix>
- <!-- <glossary role="auto">
- <glossentry>
- <glossterm>Bogus</glossterm>
- <glossdef>
- <para>If you see this, the <parameter>glossary.collection</parameter> was not set. </para>
- </glossdef>
- </glossentry>
- </glossary> -->
- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="resources/glossary/glossary_en.xml" encoding="UTF-8"/>
+ <!-- <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="resources/glossary/glossary_en.xml" encoding="UTF-8"/> -->
</book>
=== added directory 'src/docbkx/en/resources/images/maintainence'
=== added file 'src/docbkx/en/resources/images/maintainence/data_browser1.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browser1.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browser1.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_browser_dataset_detail.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browser_dataset_detail.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browser_dataset_detail.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_browser_org_unit1.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browser_org_unit1.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browser_org_unit1.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_browser_orgunit2.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browser_orgunit2.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browser_orgunit2.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_browser_orgunit2a.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browser_orgunit2a.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browser_orgunit2a.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_browsing_data_sets.png'
Binary files src/docbkx/en/resources/images/maintainence/data_browsing_data_sets.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_browsing_data_sets.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_locking_select.png'
Binary files src/docbkx/en/resources/images/maintainence/data_locking_select.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_locking_select.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_locking_select1.png'
Binary files src/docbkx/en/resources/images/maintainence/data_locking_select1.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_locking_select1.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_locking_select2.png'
Binary files src/docbkx/en/resources/images/maintainence/data_locking_select2.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_locking_select2.png 2010-01-14 14:47:26 +0000 differ
=== added file 'src/docbkx/en/resources/images/maintainence/data_locking_select3.png'
Binary files src/docbkx/en/resources/images/maintainence/data_locking_select3.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/maintainence/data_locking_select3.png 2010-01-14 14:47:26 +0000 differ
