dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1037
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2014-04-22 16:44:31 +0200
message:
  Updated event capture docs
removed:
  src/docbkx/en/resources/images/event_capture/create_program.png
  src/docbkx/en/resources/images/event_capture/edit_program_stage.png
modified:
  src/docbkx/en/dhis2_user_man_using_event_capture.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_using_event_capture.xml'
--- src/docbkx/en/dhis2_user_man_using_event_capture.xml	2014-04-09 13:50:50 +0000
+++ src/docbkx/en/dhis2_user_man_using_event_capture.xml	2014-04-22 14:44:31 +0000
@@ -4,88 +4,22 @@
   <title>Using Event Capture</title>
   <section>    
     <title>Overview</title>
-    <para>The event capture module allows users to register events that occurred at a particular
-      time and place. In DHIS2,time and place correspond, respectively, to period and organisation
-      units. However, since events are treated as random occurrences there is no such thing as
-      period for them, rather a date the event has occurred.
-    </para>
+    <para>The event capture app allows users to register events that occurred at a particular time
+      and place. An event can happen at any given point in time. This stands in contrast to routine
+      data, which can be captured for predefined, regular intervals. Events in DHIS 2 are linked to
+      program. Hence, the event capture app lets you select the organisation unit, program and point
+      in time when an event (also known as case or record) happened, before entering information for
+      that event.</para>
     </section>
   <section>
-    <title>Program definition</title>    
-    <para>In order to capture events, it is mandatory for users to first define the nature of the
-      event using the Program/Attribute module. Below is a guiding step for this:<orderedlist>
-        <listitem>
-          <para>Go to Programs/Attributes module</para>
-        </listitem>
-        <listitem>
-          <para>Select Program</para>
-        </listitem>
-        <listitem>
-          <para>Click Add new and fill in the necessary details. Under <emphasis role="bold">Program
-              details</emphasis> make sure <emphasis role="bold">Type</emphasis> is <emphasis
-              role="bold"><emphasis role="italic">"Single event without
-              registration"</emphasis></emphasis>. Below is a snapshot to depict this.</para>
-        </listitem>
-      </orderedlist>
-      <screenshot>
-        <screeninfo>Example single event program creation</screeninfo>
-        <mediaobject>
-          <imageobject>
-            <imagedata fileref="resources/images/event_capture/create_program.png" format="JPG"
-              width="70%"/>
-          </imageobject>
-        </mediaobject>
-      </screenshot>Once a single event program is created, the system automatically creates a single
-      program stage. The stage can be accessed from the context menu of the program created.
-      Clicking <emphasis role="bold">"Edit"</emphasis> from the context menu of the program stage
-      takes to the detail view of the program stage, similar to the one shown below. 
-      <screenshot>
-        <screeninfo>Example single event program stage creation</screeninfo>
-        <mediaobject>
-          <imageobject>
-            <imagedata fileref="resources/images/event_capture/edit_program_stage.png" format="JPG"
-              width="70%"/>
-          </imageobject>
-        </mediaobject>
-      </screenshot>As can be seen from the program stage screen shot above, users have the chance to
-      define what to collect during event capture. This is possible by selecting a list of data
-      elements from <emphasis role="bold">"Available data elements" </emphasis>to <emphasis
-        role="bold">"Selected data elements"</emphasis>. Under selected data elements, please pay
-      attention for the following check boxes:<itemizedlist>
-        <listitem>
-          <para><emphasis role="italic">Compulsory: </emphasis>whether it is mandatory or not to
-            collect the element during event capture</para>
-        </listitem>
-        <listitem>
-          <para><emphasis role="italic">Allow provided elsewhere: </emphasis>this is to define if
-            the data element can be collected by the selected organisation unit while it has
-            occurred elsewhere. For example, from the figure, it is possible for "mnch Blood
-            pressure" to be measured in another facility but reported in the selected facility where
-            these is no blood pressure measuring device.</para>
-        </listitem>
-        <listitem>
-          <para><emphasis role="italic">Display in reports:</emphasis> this decides if the data
-            element can appear in reports or not. If there are many data elements to be collected
-            during event capture, it makes more sense to prioritize which ones to show in report by
-            default.</para>
-        </listitem>
-        <listitem>
-          <para><emphasis role="italic">Date in future: </emphasis>this is only for those date type
-            data elements and to decide if it is possible to allow collect future dates or
-            not.</para>
-        </listitem>
-      </itemizedlist></para>
-    <para>In addition to defining program and program stage, another important step to complete
-      before event capturing is associating programs with organization units. This can be done
-      through <emphasis role="bold">"Assign program to organisation units"</emphasis> button from
-      the context menu of the selected program.</para>
-  </section>
-  <section>
-    <title>Operations</title>
-    <para>Event capturing is possible by selecting an organisation unit and a program. The moment a
-      program is selected the system displays existing events. Events are displayed in a tabular
-      fashion as shown in the figure below. From the figure, each row corresponds to an event and
-      the columns are event details (data elements).</para>
+    <title>Capturing events</title>
+    <para>To capture an event, the first step is to select an organisation unit from the left-side
+      organisation unit tree. After selecting an org unit, the list of programs will display the
+      programs which have been associated with the selected organisation unit and which have been
+      given access to the current user through user roles. Events are displayed in a tabular fashion
+      as shown in the figure below. As seen in the screenshot, each row corresponds to an event. The
+      columns display information about the events, more specifically they display data for data
+      elements which are part of the program.</para>
     <screenshot>
       <screeninfo>Example event list</screeninfo>
       <mediaobject>
@@ -98,36 +32,45 @@
     <para>All event related operations are accessible from the screen shown above. The operations
       currently available are: <orderedlist>
         <listitem>
-          <para>Capturing - this available by clicking the "Register New Event" button.</para>
+          <para>Capturing data: this available by clicking the "Register New Event" button.</para>
         </listitem>
         <listitem>
-          <para>Column show/hide - this is to allow users decide which columns to show/hide. This
-            feature is especially important when we have a long list of data elements assigned to a
-            program stage.</para>
+          <para>Showing/hiding colums: this is to allow users decide which columns to show/hide in
+            the table of events. This feature is especially important when we have a long list of
+            data elements assigned to a program stage.</para>
         </listitem>
         <listitem>
           <para>Editing - the rows in the table are clickable. Clicking them shows three menus -
               <emphasis role="bold">Edit</emphasis>, <emphasis role="bold">Edit in grid</emphasis>
-            and <emphasis role="bold">Remove.</emphasis> The difference between edit and edit in
-            grid is that, Edit takes to a new page with an opportunity to edit all the data elements
-            of the selected event. However, edit in grid allows to edit the selected event within
-            the table but only those columns (data elements) visible in the grid. If more columns
-            are required, it is possible to add using the "Show/Hide columns" button.</para>
-        </listitem>
-        <listitem>
-          <para>Sorting - this is possible by clicking the text of each column header.</para>
-        </listitem>
-        <listitem>
-          <para>Filtering - this is possible by clicking the small search icon shown to the right of
-            each column header. Clicking them provides an input field to type a filtering criteria.
-            The moment a user types a filter, the system starts applying. During filtering it is
-            possible to define start and end dates for date type data elements and lower and upper
-            limits for number types. For the rest, it is just a text.</para>
-        </listitem>
-        <listitem>
-          <para>Paging - using the links at the bottom of the table, it is possible to have some
-            paging interactions.</para>
+            and <emphasis role="bold">Remove.</emphasis> The edit function takes you to a new page
+            where information for the selected event can be updated. The edit in grid function
+            allows you to edit the selected event within the table but only those columns (data
+            elements) visible in the grid. If more columns are required it is possible to add using
+            the "Show/Hide columns" button to speficy which columns should be displayed in the
+            list.</para>
+        </listitem>
+        <listitem>
+          <para>Sorting: this can be done by clicking the text of each column header.</para>
+        </listitem>
+        <listitem>
+          <para>Filtering: this is done by clicking the small search icon shown to the right of each
+            column header. Clicking them provides an input field to type a filtering criteria. The
+            system starts applying the filter the moment a user starts to type. During filtering it
+            is possible to define start and end dates for date type data elements and lower and
+            upper limits for number types.</para>
+        </listitem>
+        <listitem>
+          <para>Paging: The list of events can be paged by using the paging section at the bootom of
+            the list. Paging allows you to quickly move between pages of events and to change the
+            page size, i.e. the number of events per page.</para>
         </listitem>
       </orderedlist></para>
+    <para>The event capture module works offline, in the sense that if Internet connectivity drops
+      during your working session, you can continue to capture events which will be stored locally
+      in your web browser (client). When connectivity has returned the system will ask you to upload
+      your locally stored data, which sends the data to the Web server where it is stored. Note that
+      if you close your Web browser while being disconnected from the Internet, you cannot return to
+      your working session; however your data will still be saved locally and can be uploaded to the
+      Web server the next time your are online and log into the system.</para>
   </section>
 </chapter>

=== removed file 'src/docbkx/en/resources/images/event_capture/create_program.png'
Binary files src/docbkx/en/resources/images/event_capture/create_program.png	2014-04-09 13:50:50 +0000 and src/docbkx/en/resources/images/event_capture/create_program.png	1970-01-01 00:00:00 +0000 differ
=== removed file 'src/docbkx/en/resources/images/event_capture/edit_program_stage.png'
Binary files src/docbkx/en/resources/images/event_capture/edit_program_stage.png	2014-04-09 13:50:50 +0000 and src/docbkx/en/resources/images/event_capture/edit_program_stage.png	1970-01-01 00:00:00 +0000 differ