dhis2-devs team mailing list archive
-
dhis2-devs team
-
Mailing list archive
-
Message #23101
[Branch ~dhis2-documenters/dhis2/dhis2-docbook-docs] Rev 766: SMS Command guide
------------------------------------------------------------
revno: 766
committer: Lai <lai.hispvietnam@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Wed 2013-06-19 09:36:46 +0700
message:
SMS Command guide
added:
src/docbkx/en/dhis2_user_man_mobile_sms_command.xml
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-alert.png
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-reportingdata.png
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-add-sms-command.PNG
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-dataset.png
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-types.png
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-user-group.png
src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-startup-link-sms-command.png
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 2013-06-01 12:33:28 +0000
+++ src/docbkx/en/dhis2_user_man_mobile.xml 2013-06-19 02:36:46 +0000
@@ -47,4 +47,5 @@
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile_web_based.xml" xpointer="mobile_web_based" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile_J2ME_GPRS_3G.xml" xpointer="mobile_j2me_gprs_3g" encoding="UTF-8"/>
<xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile_J2ME_sms_transport.xml" xpointer="mobile_j2me_sms_transport" encoding="UTF-8"/>
+ <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"; href="dhis2_user_man_mobile_sms_command.xml" xpointer="mobile_sms_command" encoding="UTF-8"/>
</chapter>
=== added file 'src/docbkx/en/dhis2_user_man_mobile_sms_command.xml'
--- src/docbkx/en/dhis2_user_man_mobile_sms_command.xml 1970-01-01 00:00:00 +0000
+++ src/docbkx/en/dhis2_user_man_mobile_sms_command.xml 2013-06-19 02:36:46 +0000
@@ -0,0 +1,108 @@
+<?xml version='1.0' encoding='UTF-8'?>
+<!-- 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 id="mobile_sms_command">
+ <title>SMS Command</title>
+ <para>SMS command feature helps DHIS system receiving SMS from users, patients, or even anonymous. A SMS command is an object containing the configurations for each SMS
+form: reporting data from phones or j2me apps, alerting users, registering patient or user, etc. </para>
+ <section>
+ <title>Set up SMS command</title>
+ <para>This is where you can create a new SMS command</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-startup-link.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-startup-link-sms-command.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-conf-add-sms-command.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>Usually each SMS command has it own property, then the setting up process may be different from each other. Currently, we have 4 types of SMS command:</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-types.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>With KEY_VALUE_PARSER and J2ME_PARSER, the SMS command will have dataset because those are used for reporting data</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-dataset.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>With ALERT_PARSER and UNREGISTERED_PARSER, the SMS command will have user group because those are used for sending message such as SMS, DHIS conversation, email.</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-user-group.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ </section>
+ <section>
+ <title>SMS Command Type</title>
+ <para>The SMS command is basically defined by its parser type. In other word, each SMS command has one unique parser to parse the plain text SMS, then the result will be used for the purpose of that SMS command.</para>
+ <section>
+ <title>SMS Command for Reporting Data</title>
+ <para>In order to report data for example data set (aggregation), we use SMS commands which have KEY_VALUE_PARSER (for phone's plain text), or J2ME_PARSER (for j2me apps)</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-reportingdata.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>If the command has name "report", and a list of data element with code like above. The format should be: [command's name] [code][value] [code][value] [code][value]....,the [value] of course might be changed depends on real data, so you have to preapre a SMS text like this example: <emphasis role="bold">report vo2 vn5 a2 b6 z3 x1</emphasis></para>
+ <para>In case the command has a separator for instance ".", the SMS text should be:</para>
+ <para> <emphasis role="bold">report vo.2.vn.5.a.2.b.6.z.3.x.1</emphasis></para>
+ <para>or <emphasis role="bold">
+ <emphasis role="bold">report vo.2|vn.5|a.2|b.6|z.3|x.1</emphasis>
+ </emphasis></para>
+ <para>With the J2ME_PARSER, you don't need to prepare those SMS text, because the J2ME will do this job</para>
+ </section>
+ <section>
+ <title>SMS Command for Alerting, Registering</title>
+ <para>In order to alert users or register patients, users, we use SMS commands which have ALERT_PARSER (for phone's plain text), or UNREGISTERED_PARSER (for j2me apps)</para>
+ <para>
+ <screenshot>
+ <mediaobject>
+ <imageobject>
+ <imagedata width="40%" align="center" fileref="resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-alert.png"/>
+ </imageobject>
+ </mediaobject>
+ </screenshot>
+ </para>
+ <para>The format of those command will be: [command's name] [text], for example: </para>
+ <para><emphasis role="bold">alert one emergency case in A town</emphasis></para>
+ <para>Commands which has ALERT_PARSER will be received from users only</para>
+ </section>
+ </section>
+</section>
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-alert.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-alert.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-alert.png 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-reportingdata.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-reportingdata.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-cofig-sms-command-format-reportingdata.png 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-add-sms-command.PNG'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-add-sms-command.PNG 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-add-sms-command.PNG 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-dataset.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-dataset.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-dataset.png 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-types.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-types.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-types.png 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-user-group.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-user-group.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-conf-sms-command-user-group.png 2013-06-19 02:36:46 +0000 differ
=== added file 'src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-startup-link-sms-command.png'
Binary files src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-startup-link-sms-command.png 1970-01-01 00:00:00 +0000 and src/docbkx/en/resources/images/dhis2_mobile_sms/mobile-sms-startup-link-sms-command.png 2013-06-19 02:36:46 +0000 differ
