dhis2-devs team mailing list archive

[noreply@xxxxxxxxxxxxx]

------------------------------------------------------------
revno: 1015
committer: Lars Helge Øverland <larshelge@xxxxxxxxx>
branch nick: dhis2-docbook-docs
timestamp: Tue 2014-04-08 11:24:10 +0200
message:
  TEI query
modified:
  src/docbkx/en/dhis2_user_man_import_export.xml
  src/docbkx/en/dhis2_user_man_web_api.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_import_export.xml'
--- src/docbkx/en/dhis2_user_man_import_export.xml	2014-02-24 12:42:40 +0000
+++ src/docbkx/en/dhis2_user_man_import_export.xml	2014-04-08 09:24:10 +0000
@@ -103,14 +103,34 @@
     </section>
     <section>
       <title>Importing CSV meta-data</title>
-      <para>DHIS 2 supports import of meta-data in the CSV format. Currently data elements are
-      supported. You can import data elements from <emphasis role="italic">CSV Meta-data Import</emphasis> in the import-export module. Columns which are not required can be omitted
-      in the CSV file, but the order will be affected. If you would like to specify columns which
-      appear late in the order but not specify columns which appear early in the order you can
-      include empty columns (&quot;&quot;) for them.</para>
-      <para>To import CV meta-data go to import-export module and select CSV Meta-Data Import form the
-      left side menu. You must select the object type which your CSV file contains. You can only
-      upload one type of objects at the time. Upload your file and click update.</para>
+      <para>DHIS 2 supports import of meta-data in the CSV format. Columns which are not required
+        can be omitted in the CSV file, but the order will be affected. If you would like to specify
+        columns which appear late in the order but not specify columns which appear early in the
+        order you can include empty columns (&quot;&quot;) for them.</para>
+      <para>To import CV meta-data go to import-export module and select CSV Meta-Data Import form
+        the left side menu. You must select the object type which your CSV file contains. You can
+        only upload one type of objects at the time. Upload your file and click update. The
+        following object types are supported:</para>
+      <itemizedlist>
+        <listitem>
+          <para>Data elements</para>
+        </listitem>
+        <listitem>
+          <para>Data element groups</para>
+        </listitem>
+        <listitem>
+          <para>Category options</para>
+        </listitem>
+        <listitem>
+          <para>Category option groups</para>
+        </listitem>
+        <listitem>
+          <para>Organisation units</para>
+        </listitem>
+        <listitem>
+          <para>Organisation unit groups</para>
+        </listitem>
+      </itemizedlist>
       <para>The formats for the currently supported object types for CSV import are listed
       below.</para>
       <table frame="all">
@@ -326,7 +346,8 @@
         </tgroup>
       </table>
       <table frame="all">
-        <title>Category Option and Category Option Group CSV Format</title>
+        <title>Data Element Group, Category Option, Category Option Group, Organisation Unit Group
+          CSV Format</title>
         <tgroup cols="4">
           <colspec colnum="1" colname="c1" colwidth="1.33*"/>
           <colspec colnum="2" colname="c2" colwidth="1*"/>

=== modified file 'src/docbkx/en/dhis2_user_man_web_api.xml'
--- src/docbkx/en/dhis2_user_man_web_api.xml	2014-04-04 22:26:21 +0000
+++ src/docbkx/en/dhis2_user_man_web_api.xml	2014-04-08 09:24:10 +0000
@@ -4230,8 +4230,10 @@
       without any constraints. Attributes will be included in the response, while filters will only
       be used as criteria. </para>
     <para>If specifying a query with no attributes or program, the attributes defined to be
-      displayed in lists with no program will be included in the response. The following rules apply
-      to the query parameters.</para>
+        displayed in lists with no program will be included in the response. You can specify queries
+        with words separated by space - in that situation the system will query for each word
+        independently and return records where each word is contained in any attribute. The query is
+        case insensitive. The following rules apply to the query parameters.</para>
     <itemizedlist>
       <listitem>
         <para>At least one organisation unit must be specified using the <emphasis role="italic"
@@ -4246,12 +4248,21 @@
           <para>If <emphasis role="italic">programStatus</emphasis> is specified then <emphasis
               role="italic">program</emphasis> must also be specified.</para>
         </listitem>
+        <listitem>
+          <para>Attributes and filters can only be specified once.</para>
+        </listitem>
+        <listitem>
+          <para>An item cannot be specified as attribute and filter.</para>
+        </listitem>
     </itemizedlist>
     <para>A query for all instances associated with a specific organisation unit can look like
       this:</para>
     <screen>api/trackedEntityInstances.json?ou=DiszpKrYNg8</screen>
     <para>A query on all attributes for a specific value and organisation unit:</para>
-    <screen>api/trackedEntityInstances.json?query=wakiki&amp;ou=DiszpKrYNg8</screen>
+    <screen>api/trackedEntityInstances.json?query=scott&amp;ou=DiszpKrYNg8</screen>
+      <para>You can query on multiple words separated by the the URL character for space which is
+        %20:</para>
+      <screen>api/trackedEntityInstances.json?query=isabel%20may&amp;ou=ImspTQPwCqd</screen>
     <para>A query where the attributes to include in th response are specified looks like
       this:</para>
     <screen>api/trackedEntityInstances.json?query=wakiki&amp;attribute=dv3nChNSIxy&amp;attribute=AMpUYgxuCaE&amp;ou=DiszpKrYNg8</screen>