Adding section to the Getting Started documentation

rapidpro · Nov 16, 2015 · 6ec4ff6 · 6ec4ff6
1 parent 06ba6b9
commit 6ec4ff6
Show file tree

Hide file tree

Showing 5 changed files with 30 additions and 4 deletions.
diff --git a/docs/source/images/rapidpro_send_message.png b/docs/source/images/rapidpro_send_message.png
diff --git a/docs/source/images/rapidpro_split.png b/docs/source/images/rapidpro_split.png
diff --git a/docs/source/images/tracpro_calculated.png b/docs/source/images/tracpro_calculated.png
diff --git a/docs/source/images/tracpro_poll_flows.png b/docs/source/images/tracpro_poll_flows.png
diff --git a/docs/source/users/getting-started.rst b/docs/source/users/getting-started.rst
@@ -34,9 +34,6 @@ There won't be much to see until you tell TracPro about which flows and groups t
  * Navigate to **Administration** > **Reporter Groups** and click **Select** to select which contact groups in RapidPro will be used as reporter groups in TracPro
  * Navigate to **Administration** > **Regions** and click **Select** to select which contact groups in RapidPro will be used as regions in TracPro. This will trigger a fetch of all contacts from those groups.
 
-Management Tasks
-------------------
-
 Fetching old runs
 ------------------
 
@@ -55,4 +52,33 @@ If a new poll is added, TracPro will only track runs made after the poll has bee
     $ ./manage.py fetchruns 3 --days=2
 
 
-**One should use this command with caution as it could potentially try to download a very high number of runs**
+**One should use this command with caution as it could potentially try to download a very high number of runs**
+
+Displaying Calculated Values on Tracpro
+---------------------------------------
+You can display values that are calculated from user responses on Tracpro. We reference an example flow that uses a calculated variable from results of a `structured message form <http://knowledge.rapidpro.io/knowledgebase/articles/716520-split-by-message-form>`_.
+
+**In RapidPro**: After you have built your flow to collect variables that you wish to use for the calculation, add a “Split by Expression” step.
+
+Save the result as a particular variable name, for example `Calculated Variable`.
+Write the expression to calculate the variable, for example `@(flow.girl_leaders / flow.girl_participants * 100)`. You have access to basic math, `expressions <http://knowledge.rapidpro.io/knowledgebase/topics/88968-syntax-guide>`_, and `variables <http://knowledge.rapidpro.io/knowledgebase/articles/595248-variables-in-a-flow>`_.
+
+.. image:: ../images/rapidpro_split.png
+
+**In RapidPro**: You can use the calculated variable like any other variable, for example in a response to the user.
+
+.. image:: ../images/rapidpro_send_message.png
+
+**In TracPro**: To view on Tracpro, ensure that your poll has been added through the Poll Flows chooser.
+
+.. image:: ../images/tracpro_poll_flows.png
+
+**In TracPro**: Your calculated variable will be available as a Question on Tracpro. You can view and use it exactly as you would any other Question.
+
+- To view the numeric responses, including those for the calculated variable:
+- View the Poll.
+- Click on the “Dates” tab.
+- Select the date of the poll you wish to see.
+- Click on the “Responses” tab.
+
+.. image:: ../images/tracpro_calculated.png