dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #14324
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 407: Reorganized the DHIS mobile chapters and sections a bit.
------------------------------------------------------------
revno: 407
committer: Jason P. Pickering <jason.p.pickering@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2011-10-05 08:36:49 +0200
message:
Reorganized the DHIS mobile chapters and sections a bit.
modified:
src/docbkx/en/dhis2_user_man_mobile.xml
src/docbkx/en/dhis2_user_man_mobile_web_based.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-21 09:10:50 +0000
+++ src/docbkx/en/dhis2_user_man_mobile.xml 2011-10-05 06:36:49 +0000
@@ -4,317 +4,42 @@
<title>DHIS Mobile</title>
<section>
<title>Introduction</title>
+ <para>DHIS2 provides a range of options to allow data entry from mobile devices, including a dedicated GPRS/3G J2ME client, a SMS based client, and a version of DHIS2 which has been optimized specifically for mobile browsers. Each of these solutions will be described in detail in the following sections.</para>
<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>
+ data collection system. Using a simple Java client installed on a mobile phone or a web browser which works on the mobile phone, field workers
+ can report directly to the DHIS2 database through their mobile device.</para>
<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
+ <para>There are currently three 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>
+ <para>An mobile browser optimized data entry module</para>
+ <para>This module allows for data entry directly with the browser of the mobile device. A wide range of devices and mobile browsers are supported including: Opera mini 3 & 4 (basic and advanced)
+ - Opera mini 4, Nokia S40 mobiles ,Windows Phone 7, Window Mobile 6
+ ,Palm Pre
+ ,Blackberry (v5 and v6)
+ , Firefox mobile, iOS devices (iPhone)
+ and Android devices. An active GPRS/3G connection is required. This solution is described in <xref linkend="mobile_broswer_based"/></para>
+ </listitem>
+ <listitem>
+ <para>A dedicated J2ME GPRS/3G client</para>
+ <para>This solution allows for forms to be updated on the phone and also supports
+ community module reporting. An active GPRS/3G connection is required in order to send data to the DHIS2 database, but data can be entered offline and transmitted when a connection is present. This client is intended primarily for low-end devices which support J2ME applications. This solution is described in <xref linkend="mobile_j2me_gprs_client"/></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
+ <para>The SMS based solution is
+ requires a custom built J2MER mobile application
and installation of a GSM modem and some manual
- configuration on the server side.</para>
+ configuration on the server side. It would be an appropriate solution where GPRS/3G is not available but GSM coverage is available. Updating of forms to the client is not supported at this point in time. This solution is described in <xref linkend="mobile_sms_based_data_entry"/></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>
- <para>With the SMS solution, the forms filled in on the phone is
- sent using SMS messages to a
- central server. The SMS message is
- decrypted and converted, and then imported into the DHIS2
- 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 -->
- You will need to build in these modules
- yourself. You also need to modify the client side
- application with your own data elements.
- </para>
- <section>
- <title>Build DHIS2 with the dhis-web-mobile module</title>
- <itemizedlist>
- <listitem>
- <para>
- Download the latest source code from
- launchpad, i.e. the DHIS2 trunk source
- code from
- <ulink url="https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk";> https://code.launchpad.net/~dhis2-devs-core/dhis2/trunk</ulink>
- </para>
- </listitem>
- <listitem>
- <para>
- Build
- DHIS2 as normal, by running
- <code>mvn clean install</code>
- (to skip tests, use
- <code>mvn clean install -Dtest=false -DfailIfNoTests=false</code>
- ) in the dhis-2 and
- dhis-2\dhis-web folders.
- </para>
- </listitem>
- <listitem>
- <para>
- Build the mobile modules by
- running
- <code>mvn clean install</code>
- in the dhis-mobile folder.
- </para>
- </listitem>
- <listitem>
- <para>Modify
- the dhis-web-portal\pom.xml file, adding a dependency to dhis-web-mobile:
- </para>
- <para>
- <screen>
- <dependency>
- <groupId>org.hisp.dhis</groupId>
- <artifactId>dhis-web-mobile</artifactId>
- <version>${version}</version>
- <type>war</type>
- </dependency> </screen>
- </para>
- </listitem>
- <listitem>
- <para>
- Build the portal (
- <code>mvn clean install</code>
- in the dhis-web-portal folder)
- </para>
- </listitem>
- <listitem>
- <para>Copy the dhis.war file from dhis-web-portal\target to the
- tomcat\webapps folder.
- Rename it if you
- want.</para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Install the GSM modem</title>
- <itemizedlist>
- <listitem>
- <para>Driver for the GSM modem</para>
- <para>Plug
- in your modem and install the drivers. You might have to use the
- manufacturer's
- provided drivers from a CD or their web page.
- <emphasis>You might need administrator privileges to do this. If you still can't do it, try starting Windows in Safe Mode.</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>comm.jar</para>
- <para>
- Copy it to your
- <code>java\jreX\lib\ext</code>
- folder. If you've got multiple
- installations of JRE, you can find the path to the
- installation used by
- DHIS 2 by right clicking the Monitor Tomcat icon in the system
- tray,
- then Configure -> Java.
- </para>
- </listitem>
- <listitem>
- <para>javax.comm.properties</para>
- <para>
- Copy it to your
- <code>java\jreX\lib</code>
- folder.
- </para>
- </listitem>
- <listitem>
- <para>win32com.dll</para>
- <para>
- Copy it to your
- <code>java\jreX\bin</code>
- folder.
- </para>
- <para>
- <emphasis>Note: You might need administrator privileges to do this. If you still can't do it, try starting Windows in Safe Mode.</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>SMSserver.conf</para>
- <para>
- 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.
- </para>
- <para>
- In this file the manufacturer and the model of the GSM modem are specified. Also,
- make
- sure the PIN code for the SIM card in the GSM modem is turned off, and set
- <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.
- </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
- the
- 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
- which port is
- assigned to
- the modem.</para>
- <para>
- <emphasis>Important: Note that if you install the modem into another usb port another time, the port will change, and you will have to update the settings. If 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 to update the SMSserver.conf file.</emphasis>
- </para>
- </listitem>
- <listitem>
- <para>formIDLayout.csv</para>
- <para>
- Copy it to your
- <code>DHIS2_HOME\mi</code>
- folder. If you have not yet deployed your latest build of DHIS2, you'll have to
- create the mi folder manually.
- </para>
- <para>This
- file specifies which data elements are to be imported. There's one line for
- 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
- categoryoptioncombo
- ids. The
- lines will be on the form
- <screen>
- 1 = <data element id>.<categoryoptioncombo id>,
- <data element id>.<categoryoptioncombo id>, ... ,
- <data element id>.<categoryoptioncombo id> </screen>
- E.g.
- <screen>1 = 652.207, 652,208, 20485.271, 20485.272, 683.14</screen>
- </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>
- </para>
- </listitem>
- </itemizedlist>
- </section>
- <section>
- <title>Register users</title>
- <para>
- The phone numbers of the cell phones used for reporting with the
- mobile application needs to
- be registered in DHIS 2 in order for the data
- to be imported and stored in the database. A
- phone number has to be
- registered for a user, and the user can
- <emphasis>only</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>
- . E.g. for a
- Norwegian number, having the country code
- <code>47</code>
- and phone number
- <code>98765432</code>
- , the phone number to store is
- <code>4798765432</code>
- .
- </para>
- </section>
- <section>
- <title>Install the mobile application on a phone</title>
- <para>If
- you've got a phone and a computer with Bluetooth, you will in the most cases be able
- to
- send the
- <code>.jar</code>
- file (the mobile application) via Bluetooth from the computer to the phone. When using a
- cable, and also in some cases for phones with Bluetooth, you might have to install some
- software to be able to communicate with the phone. E.g. Nokia PC Suite for Nokia phones.
- </para>
- <para>Once the mobile application is installed on the phone, open it and navigate to the
- last
- page in the application. Select settings, and enter the number of the SIM card in the GSM
- modem. This works both with and without country code.</para>
- <para>If there are several GSM modems installed on several computers running DHIS 2 and you
- want to report to all of these, you can enter the numbers of the SIM cards installed in
- these GSM modems as well in the remaining fields in your mobile application. When clicking
- send, the application will now send the registered data to all the registered numbers at
- the
- same time.</para>
- </section>
- <section>
- <title>Using the system</title>
- <para>Navigate to the Mobile module via Services -> Mobiles</para>
- <section>
- <title>Start the SMS Service</title>
- <para>To start the SMS Service, navigate to "Receive Data and Import" or
- "Send SMS" in the left menu, and then press the Start button next to where
- it
- says: "SMS Service: Not Started". If everything works well, it should
- now say:
- "SMS Service: Started".</para>
- </section>
- <section>
- <title>Receive Data and Import</title>
- <para>To receive and import data, the SMS Service needs to be started. </para>
- <section>
- <title>Automated import of messages</title>
- <para>When SMSs are sent from the phones while the SMS Service is running, the messages
- will be processed automatically, and the data will automatically be imported and
- stored
- in the database.</para>
- </section>
- <section>
- <title>Import pending messages</title>
- <para>
- If SMSs are sent from the phones to the SIM card in the GSM modem
- while the SMS Service
- is inactive, the messages will be stored as xml
- files in the folder
- <code>DHIS2_HOME\mi\pending</code>
- short time after
- the service is started. On the Receive Data and Import page it will say
- how many SMSs are pending. These can be imported by pressing the "Import
- All
- Pending" button.
- </para>
- </section>
- </section>
- <section>
- <title>Send SMS</title>
- <para>
- The mobile module can be used to send messages to one number at a
- time. To send an SMS, the
- SMS Service needs to be started. Use the local
- phone number here
- <emphasis>without</emphasis>
- the country code.
- </para>
- </section>
- </section>
- </section>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_mobile_sms_data_entry.xml" encoding="UTF-8"/>
</chapter>
=== modified file 'src/docbkx/en/dhis2_user_man_mobile_web_based.xml'
--- src/docbkx/en/dhis2_user_man_mobile_web_based.xml 2011-10-04 19:44:03 +0000
+++ src/docbkx/en/dhis2_user_man_mobile_web_based.xml 2011-10-05 06:36:49 +0000
@@ -1,9 +1,72 @@
<?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 section PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"; []>
<section>
<title>Mobile data entry with DHIS2</title>
- <para>DHIS2 provides a range of options to allow data entry from mobile devices, including a dedicated GPRS/3G J2ME client, a SMS based client, and a version of DHIS2 which has been optimized specfically for mobile browsers. Each of these solutions will be described in detail in the following sections.</para>
- <section>
+ <section id="mobile_broswer_based">
+ <title>Mobile browser based data entry</title>
+ <para>DHIS2 has been optimized for use browsers in mobile devices through a module known as DHIS2 Light. This module has been optimized to provide a small memory footprint and to be capable of working over relatively modest bandwidths. To access the module, you should go to <to do></para>
+ <section>
+ <title>Getting started with mobile browser data entry</title>
+ <para>Once you have entered in the URL of you DHIS2 instance, simply login with your username and password. Press the login button to continue, or the "Reset" button to clear all fields.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/mobile-browser-login.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Once you have logged in, Select the "Data entry" option. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/after-login.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Then select from a list of available organisation units which the user is allowed to enter data on behalf of. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/select-org-unit.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Next, select a dataset to enter data for. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/select-dataset.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Select from a list of available periods to enter data for from the next screen.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/select-period.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Next, enter data for each data element. The category options for each data element are indicated in parentheses at the end of the name of the data element.</para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/data-entry.PNG"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Once you have finished entering all the data, you will be given the option to mark the dataset as complete and save it. </para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis-web-light-data-entry/dataset-complete-save.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ <para>Once you have finished entering data, you can logout by pressing the "Logout" link. </para>
+ </section>
+ </section>
+ <section id="mobile_j2me_gprs_client">
<title>J2ME GPRS/3G Client</title>
<para>The DHIS2 GPRS/3G mobile module provides a mechanism for remote clients using mobile phones to enter data directly into the DHIS2 system. There are two functions of the client, namely:</para>
<para>The solution relies on the mobile phone having a data connection available (i.e.
@@ -26,7 +89,7 @@
<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 described in a seperate document.
+ the case for you, you might want to consider trying the SMS based solution described in a separate document.
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,
@@ -521,68 +584,4 @@
</section>
</section>
</section>
- <section>
- <title>Mobile browser based data entry</title>
- <para>DHIS2 has been optimized for use browsers in mobile devices through a module known as DHIS2 Light. This module has been optimized to provide a small memory footprint and to be capable of working over relatively modest bandwidths. To access the module, you should go to <to do></para>
- <section>
- <title>Getting started with mobile browser data entry</title>
- <para>Once you have entered in the URL of you DHIS2 instance, simply login with your username and password. Press the login button to continue, or the "Reset" button to clear all fields.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/mobile-browser-login.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have logged in, Select the "Data entry" option. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/after-login.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Then select from a list of available organisation units which the user is allowed to enter data on behalf of. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/select-org-unit.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Next, select a dataset to enter data for. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/select-dataset.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Select from a list of available periods to enter data for from the next screen.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/select-period.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Next, enter data for each data element. The category options for each data element are indicated in parentheses at the end of the name of the data element.</para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/data-entry.PNG" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have finished entering all the data, you will be given the option to mark the dataset as complete and save it. </para>
- <screenshot>
- <mediaobject>
- <imageobject>
- <imagedata fileref="resources/images/dhis-web-light-data-entry/dataset-complete-save.png" align="center" width="40%"/>
- </imageobject>
- </mediaobject>
- </screenshot>
- <para>Once you have finished entering data, you can logout by pressing the "Logout" link. </para>
- </section>
- </section>
</section>
