dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #09631
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 248: Mobile documentation (work in progress)
------------------------------------------------------------
revno: 248
committer: Jo Størset <storset@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Mon 2011-01-17 16:36:18 +0530
message:
Mobile documentation (work in progress)
added:
src/docbkx/en/dhis2_user_man_mobile_web_based.xml
modified:
src/docbkx/en/dhis2_user_man_mobile.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_mobile.xml'
--- src/docbkx/en/dhis2_user_man_mobile.xml 2011-01-12 10:29:17 +0000
+++ src/docbkx/en/dhis2_user_man_mobile.xml 2011-01-17 11:06:18 +0000
@@ -4,23 +4,36 @@
<title>DHIS Mobile</title>
<section>
<title>Introduction</title>
- <para>Collection of data in the field can be technically
- challenging and expensive. Mobile phone
- solutions has the potential to
- significantly reduce the complexity of deploying a distributed
- data collection system. Using a simple Java client installed on
- a mobile phone, field workers
+ <para>Collection of data in the field can be technically challenging and expensive. Mobile phone
+ solutions has the potential to significantly reduce the complexity of deploying a distributed
+ data collection system. Using a simple Java client installed on a mobile phone, field workers
can report directly to DHIS2 instance. </para>
- <para>There are currently two
- mobile solutions for DHIS2, an older SMS based solution and a new
- solution relying on the phone having a data connection to the web (e.g. GPRS).</para>
- </section>
- <section>
- <title>GPRS based solution</title>
- <para>This solution is currently being developed, documentation
- coming soon...
- </para>
- </section>
+ <para>While mobile phone solutions have a great potential, it is also an area that can be
+ difficult to "get right". Phones lack processing power and have a small display,
+ need to be
+ charged and often makes the most sense in areas where mobile network coverage is weak and
+ patchy.</para>
+ <para>There are currently two main mobile solutions for DHIS2, and we continue to evolve these
+ as well as look at other possible solutions:</para>
+ <itemizedlist>
+ <listitem>
+ <para>New "generic" solution</para>
+ <para>A solution that allows for forms to be updated on the phone and also supports
+ community module reporting, but is relying on the phone having a data connection to the
+ web.</para>
+ </listitem>
+ <listitem>
+ <para>SMS based solution</para>
+ <para>The SMS based solution is quite simple and has been used in a number of places. But it
+ requires a custom built mobile application
+ and installation of a GSM modem and some manual
+ configuration on the server side.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile_web_based.xml" encoding="UTF-8"/>
+
<section>
<title>SMS based solution</title>
@@ -31,8 +44,9 @@
database.</para>
<para>
By default, DHIS2 does not ship with the DHIS SMS Mobile web
- module. <!-- The DHIS2 downloads site ( <ulink url="http://dhis2.org/downloads";>http://dhis2.org/downloads</ulink>
- ) has a prebuilt version of the latest release with this module added. Otherwise y -->
+ module. <!-- The DHIS2 downloads site
+ ( <ulink url="http://dhis2.org/downloads";>http://dhis2.org/downloads</ulink> ) has a prebuilt version
+ of the latest release with this module added. Otherwise y -->
You will need to build in these modules
yourself. You also need to modify the client side
application with your own data elements.
@@ -72,7 +86,7 @@
<listitem>
<para>Modify
the dhis-web-portal\pom.xml file, adding a dependency to dhis-web-mobile:
- </para>
+ </para>
<para>
<screen>
<dependency>
@@ -152,7 +166,8 @@
Copy it to your
<code>DHIS2_HOME</code>
folder (the folder where hibernate.properties is located). The settings in this file
- can also be modified from the Settings page in the mobile module in DHIS 2.
+ can
+ also be modified from the Settings page in the mobile module in DHIS 2.
</para>
<para>
In this file the manufacturer and the model of the GSM modem are specified. Also,
@@ -161,16 +176,21 @@
<code>modem1.pin=0000</code>
in the SMSserver.conf, or use the Settings page in the mobile module in DHIS 2 to
set
- the pin to 0000.
+ the
+ pin to 0000.
</para>
<para>The port of the modem also needs to be specified in this file. After the drivers
- are successfully installed and the modem is installed in a usb port, you can find
+ are
+ successfully installed and the modem is installed in a usb port, you can find
the
- port of the modem by opening Device Manager, locate your modem and right click
+ port of
+ the modem by opening Device Manager, locate your modem and right click
on it,
- click on Properties and navigate to the Modem tab. There you'll see
+ click on
+ Properties and navigate to the Modem tab. There you'll see
which port is
- assigned to the modem.</para>
+ assigned to
+ the modem.</para>
<para>
<emphasis>Important: Note that if you install the modem into another usb port
another
@@ -178,9 +198,11 @@
you for some
reason need to take the modem out of your computer, make sure
you'll install it
- in the same usb port as last time, or else you'll have
+ in
+ the same usb port as last time, or else you'll have
to update the
- SMSserver.conf file.</emphasis>
+ SMSserver.conf
+ file.</emphasis>
</para>
</listitem>
<listitem>
@@ -196,9 +218,11 @@
each
different mobile application in use. The lines start with a mobile
application's
- id, then followed by comma separated data element ids and their
+ id,
+ then followed by comma separated data element ids and their
categoryoptioncombo
- ids. The lines will be on the form
+ ids. The
+ lines will be on the form
<screen>
1 = <data element id>.<categoryoptioncombo id>,
<data element id>.<categoryoptioncombo id>, ... ,
@@ -208,8 +232,10 @@
</para>
<para>
<emphasis>Note: If the same mobile application is installed on several phones, the
- id for each application is the same! The formIDLayout.csv file should thus only
- have one line, starting with 1 = .</emphasis>
+ id for
+ each application is the same! The formIDLayout.csv file should thus only
+ have one line,
+ starting with 1 = .</emphasis>
</para>
</listitem>
</itemizedlist>
@@ -224,17 +250,13 @@
phone number has to be
registered for a user, and the user can
<emphasis>only</emphasis>
- be
- associated with
- <emphasis>one organisation unit</emphasis>
- !
+ be associated with
+ <emphasis>one organisation unit</emphasis>!
</para>
<para>
The phone number must include the regular phone number as well as
the country code without
- <code>+</code>
- or
- <code>00</code>
+ <code>+</code> or <code>00</code>
. E.g. for a
Norwegian number, having the country code
<code>47</code>
=== added file 'src/docbkx/en/dhis2_user_man_mobile_web_based.xml'
--- src/docbkx/en/dhis2_user_man_mobile_web_based.xml 1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_user_man_mobile_web_based.xml 2011-01-17 11:06:18 +0000
@@ -0,0 +1,93 @@
+<?xml version="1.0" encoding="UTF-8"?>
+
+ <!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
+
+<section>
+ <title>Web based mobile solution</title>
+ <para>The web based solution consists of two parts: Facility reporting, for data entry and
+ reporting of regular
+ DHIS2 aggregate data, and Activity reporting, for supporting individual activity reporting with the
+ Community module.</para>
+
+ <para>The solution relies on the mobile phone having a data connection available (i.e.
+ GPRS,
+ Edge, 3G), over which it communicates with a DHIS2 instance being publicly
+ available on the
+ internet, as any other web client. The application downloads the forms to be reported from the
+ server,
+ and the forms can therefore be updated without installing a new application.
+ </para>
+ <section>
+ <title>Data connection availability</title>
+ <para>Data connection availability can be a problem in many of the contexts where DHIS2 mobile
+ reporting would otherwise be a good solution
+ for getting data directly into DHIS2. If that is
+ the case for you, you might want to consider
+ trying the SMS based solution for now.
+ But keep
+ in mind that even though a data connection is currently required for communication between
+ the server and the mobile phone,
+ it is only required when initializing or updating the mobile
+ application and when sending reports
+ to the server.
+ The phone stores all entered data locally,
+ so it it can work fine with only temporary access to a
+ data connection on a regular basis.
+ </para>
+ </section>
+ <section>
+ <title>Server side setup for facility reporting</title>
+ <para>The server side component of the web based solution is no different than any other
+ regular web application, and it is included in the regular build of DHIS2.</para>
+ <itemizedlist>
+ <title>To try out the facility reporting, perform these steps on the
+ server</title>
+ <listitem>
+ <para>For the data sets you want reported, set the "Available for mobile" flag
+ on the edit dataset page.</para>
+ </listitem>
+ <listitem>
+ <para>Make sure the user that you want to log in as is associated to one (and
+ only one) organizational unit has the "mobile" datasets assigned.</para>
+ </listitem>
+ <listitem>
+ <para>That was all, go see if you can get the mobile working.</para>
+ </listitem>
+ </itemizedlist>
+ </section>
+ <section>
+ <title>A little detail</title>
+ <para>Though the previous steps is all that should be needed for testing the solution,
+ there are of course some more things you want to know about the server setup.</para>
+ <section>
+ <title>The mapping of data sets to form layout on the phone</title>
+ <para>By default a data set is mapped to one large form on the phone.
+ If the data set is divided into sections, each section is a form page and
+ If a data element has
+ more than one category option combo it will be displayed as a heading with the combos
+ following.</para>
+ </section>
+ <section>
+ <title>Names of elements on the phone</title>
+ <para>The name of the form is the ... And so on...</para>
+ </section>
+ <section>
+ <title>Sorting of forms</title>
+ <para>....</para>
+ </section>
+ <section>
+ <title>Language support</title>
+ <para>Language support for the form contents is not fully supported yet, as of the current
+ version (?)</para>
+ </section>
+ </section>
+ <section>
+ <title>Mobile application setup</title>
+ <para></para>
+ <section>
+ <title>Installation and initialization</title>
+ <para>....
+ </para>
+ </section>
+ </section>
+</section>
