Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Keyword Setup

To setup the reminder, navigate to www.commcarehq.org/a/<yourprojectname>/reminders.  In keyword, choose the Messaging tab, then In the left side bar, select "Keywords", then click .  Click the "+Add Keyword" button.

...

  • Keyword: This is the word that the user will message to initiate the interaction.  Keywords need to be unique within a project.Form
  • Description: A description for the keyword does.  
  • Respond to Sender
    • Send: This controls what is
    the form that will run for the user.  If you select a form that depends on a case, it will only work for phone numbers associated that case type.
  • Answer Method: There are two options here:
    • One SMS Per Question: The user will be able to respond to one question at a time and will receive the next question after answering.  This is how SMS surveys work for reminders.
    • All Questions in One SMS: The user will be able to send a single SMS that answers all questions in the form.  This is useful if the user knows all the questions and can easily answer them in a single line.  See details below. 
Image Removed
    • sent to the person sending the keyword (a simple message or an SMS survey)
    • Survey or Message: The survey or message to send
  • Process Incoming Keyword as a Structured Messaged: Choose this option if the user will be able to include additional information when sending in the keyword.  This can be used for structured data collection. Details on this are below. 
  • Notify Another Person: This will let you notify another contact when someone sends  a message to the keyword.
    • Recipient: The person to send the message to, a mobile worker group or the case's owner if the message was sent by a case. 
    • Send: This controls whether to send the person an SMS message or a survey. 
    • Survey or Message: The survey or message to send. 
  • Advanced Options
    • Override Open Surveys: Sending in this word will override any existing surveys that the user is currently filling out and trigger this keyword. 
    • Restrict Keyword Initiation: Restrict the type of contact who can use this keyword. 

Image Added

Once you've specified the keyword and form, save the keyword. 

Set Up All Questions In One SMS (Structured SMS)

If the Answer Method is changed to All Questions In One SMSyou choose Process Incoming Message as Structured Message, users are able to send an SMS that looks like <keyword> <answer1> <answer2> <answer3> etc. The defaults assumes that the user provides answers to each question, separated by spaces.  This will work well for most situations.  However, there are additional options available:

  • Custom Delimiter: This is useful if you want to use something else to separate each answer.  For example, if you any of your answers have spaces, the default separator of a space will not make space. 
  • Named Answers: This allows users to skip questions or answer questions in a different order.  This works by allowing the user to provide an identifier for each answer. Ex, they would send a message that looks like <keyword> a:<questiona> b:<questionb>

A summary of what a sample SMS will look like is shown at the bottom of the page. 

Custom Delimiter

To setup a custom separation character, check the custom delimiter option and choose the characters you want to use to separate each answer. This could be a "," or "|" or even multiple characters like "||".  

Named Answers

To use named answers, check the named answer option.  You can then specify the name that the user enters, and the question (via xpath in the form) that it maps to.  For example, you may want to to map the name "a" to the question /data/age.  This is setup as shown.  It is also possible to add a character to join the name and the answer (ex. a ":").  This is also shown.