Versions Compared

Key

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

...

When setting up a keyword, you need to specify the following:

Basic Information:

  • Keyword: This is the word that the user will message to initiate the interaction.  Keywords need to be unique within a project.
  • Description:

...

  •  A description for the keyword does.  


Respond to Sender

    • Send: This controls what is sent to the person sending the keyword (a simple message or an SMS survey)
    • Survey or Message: The survey or message to send

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: 

Restrict Keyword Initiation: Restrict the type of contact who can use this keyword. Use 'Case Only' if you want to escalate messages to the Case Owner. 

 

 

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

Keyword: SMS Survey

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. 

Notes: 

  • SMS Surveys can have conditional triggers, for example send a satisfaction survey after a clinic visit. 
  • By creating a keyword, you can simulate that condition, and test an SMS Survey in a reliable way. 

Keyword: Structured SMS with Custom Delimiter

If the you choose Structured Keyword, if you want to send in all of your SMS questions at once.

The 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. 

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 "||".  

This example below uses a period (.) as a custom delimiter.

  • Custom Delimiter: This is useful if you want to use something else to separate each answer.  For example, if any of your answers have spaces, the default separator of a space will not make space. 

Keyword: Structured SMS with Named Answers

Named Answers

Named Answers allow users to skip questions or answer questions in a different order. This works by allowing the user to provide an identifier for each answer. 

To use named answers, check the named answer option.  

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 map two properties

  • /data/name to "name"
  • /data/household_size to   "members"

By adding a joining character, the name and the value are paired together. The joining character in this example is a semi colon : .  

As you build your Named Answers set-up, look at the Example Structured Message to understand how the message should look. 

Both of these examples are valid options

  • visit name:123 members:456
  • visit members:456 name:123