Surveys

What exactly is a Survey?

If you’re someone who uses Ushahidi v2, Surveys (previously referred to as post types) in v3 are what we used to refer to as custom forms. A survey defines critical aspects of a post’s structure and permissions. For example, a post’s “survey” defines which fields are available for contributors to complete, and who can see it when it’s published.

This section will show you how to create and manage surveys on your deployment.

NB: If you’re a user on ushahidi.com, there are limits to the the number of surveys you can create, based on the Ushahidi plan you are subscribed to. You may review these from our plans page. For open source/self hosted deployments, you can create as many surveys as desired.

To access the Surveys configuration page,

  • On the left hand menu bar, click on Settings

  • Then, click on Surveys.

Survey_Settings.png

Adding Surveys

By default, each deployment has a Basic Post survey, which can be deleted or modified as needed. To create a new survey,

  • Click on the yellow icon as shown below

  • Fill in the required details. Screen Shot 2017-05-31 at 12.48.37 PM.png

    • Survey Name: Try being as specific as possible when creating your survey name so that users will understand what they are selecting when creating new posts

    • Description: Provide a brief description of what kind of data you’ll be collecting with this survey

    • Tasks: This section allows you to break out your survey into specific tasks with fields, as described in Section 3.3.1.1 below.

  • Click on Save when done.

Building, Configuring, and Sharing a Survey

Building your Survey

Each survey you create will have a title and description field by default. You can add as many custom fields to your survey as you see fit.

Adding Fields

To add a new field,

  • Click on Add Field

Click_on_add_field.jpg

  • A pop up box with a list of different field types will appear on your screen. Choose whichever one will work best for the type of data you are trying to capture.

Screen Shot 2017-05-31 at 12.35.46 PM.pngScreen Shot 2017-05-31 at 12.35.58 PM.pngScreen Shot 2017-05-31 at 12.36.08 PM.png

  • Add the following details

    • Name: This is what is displayed as a label for your newly created field.

    • Show field description: Turn this on if you’d like to add a short description or help text to the field.

    • Field Options: This appears in cases where you’re creating a checkbox, select or radio button field. You can add as many options as you would like.

    • Required: If set to yes by toggling the button, the post to which this field belongs will not be able to be submitted for review or published until this field has been filled out.

    • Make responses private: If set to yes by toggling the button, the information input into this field will only be visible by the user roles with permission to manage posts. The information will not be made visible to anyone else.

    • Default Value: You can set a default value displayed every time someone is creating a new post.

Screen Shot 2017-05-31 at 12.42.53 PM.png

  • Once you’re done, click on Add&Close.

Editing Fields

To edit an existing field,

  • Select the desired custom field by clicking on it

Edit_field.jpg

  • Edit the fields(as described in the section above on Adding fields) as desired.

  • Click on Update&close when done.

Edit_field_details.jpg

 

You can also change the position of existing fields by clicking on the scroll icons to the left of every field as shown below.

Deleting Fields

To delete an existing field

  • Click on the field you would like to delete(as you would when selecting a field to edit), then click on Delete Field

Delete_field.jpg

 

  • A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the field

    • Click on Delete to delete the field

    • If you’d like to cancel the field deletion process, click on Cancel

Configuring Surveys

After you build a Survey, you’ll need to Configure the survey’s settings.

  • Click on Configure on the top of the survey editor

  • Configure the settings to suit your needs

Screen Shot 2017-05-31 at 12.45.16 PM.png

  • Require posts be reviewed before they’re published: Toggle this option “on” if you’d like posts to remain as drafts until you or a member of your team review the post’s information and choose to publish them. If this is toggled “off”, posts submitted to this survey will be published to everyone immediately after submission.

  • Hide author information: Toggle this option “on” if you’d like to completely hide any author information publicly. Note: logged in users with the permission to manage posts will still be able to see author information.

  • Who can add to this survey: Choose whether everyone or only specific roles can add to this particular survey.

  • Color: Select a color or input a specific hex value to choose which color will be associated with this survey. Pins on the map will match whichever color you select.

3.3.1.2.4 Sharing Surveys

After you build and configure a Survey, you can choose to Share the survey.

Screen Shot 2017-05-31 at 12.57.13 PM.png

  • Web address: Copy and paste this link to direct people to your survey form

  • Facebook: Share the survey form on Facebook

  • Twitter: Share the survey form on Twitter

  • Embed: Copy and paste this HTML block of code to embed the survey form on any site across the web

Adding Tasks

You can organize your survey into “Tasks”, allowing a deployment to separate fields related to actions that need to be taken, like translation or verification. These groups of tasks are visible to specified users and can be marked as ‘complete.’ For example, if a particular survey requires verification upon submission, you can design a task to ensure your team knows the post needs to be verified before publishing. The task could include fields like whether the information was verified or not, who verified the information, how they verified it, and when they verified it. After verification, the task can be marked as complete and the post can either be moved to the next task if necessary, or published.

By default, each new survey has a “Post” task created on creation, which can be edited.

To add a new task,

  • Click on Add Task on your survey creation/edit page

  • A small pop up box will appear, prompting you to give your task a name
  • If you’d like to make this task required before post submission, toggle the Require this task be completed before a post can be visible to the public button. This means that, a post will not be published until this task is marked as complete
  • Click on Add & Close

Adding, editing, and deleting Task fields

Each task can have custom fields within it. To add a new field,

  • Click on the task to which you’d like to add fields to as shown below.

  • Click on Add Field
  • A pop up box with a list of different field types will appear on your screen. Choose whichever one will work best for the type of data you are trying to capture.
  • Add the following details
    • Name: This is what is displayed as a label for your newly created field
    • Key: This field determines how this field is labelled for collection of data within your database. As your field name is filled out, it gets automatically filled out. You can change the field key if you desire. It cannot include spaces, and must be unique from every other field key to ensure proper data storage and retrieval
    • Default Value: You can set a default value displayed every time someone is creating a new post
    • Field Options: This appears in cases where you’re creating a checkbox, select or radio button field. You can add as many options as you would like
    • Require this field be completed: If set to yes by toggling the button, the task in which this field belongs to will not be able to be marked as complete until this field has been filled out.

  • Once you’re done, click on Add&Close.

To edit an existing field,

  • Select the desired custom field by clicking on it

  • Edit the fields(as described in the section above on Adding fields) as desired.
  • Click on Add&close when done.

To delete an existing field

  • Click on the field you would like to delete(as you would when selecting a field to edit), then click on Delete Field

  • A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the field
    • Click on Delete to delete the field
    • If you’d like to cancel the field deletion process, click on Cancel


Editing Tasks

To edit an existing task,

  • Select the desired task

  • Make changes as desired, e.g changing the task name/making a task required or not
  • When done, click on Save on the top of the page

Deleting Tasks

To delete an existing task

  • Select the desired task

  • Click on Delete Task

  • A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the task
    • Click on OK to delete the task
    • If you’d like to cancel the task deletion process, click on Cancel


Editing Surveys

To edit a survey

  • Click on a survey from the list of surveys on your page

  • From here, change your survey details as desired then click on Save

Deleting Surveys

To delete a survey,

  • Select the desired survey from the surveys list page

  • Click on Delete Survey

  • A black pop up box will appear on the top of the page, prompting you to confirm whether you would like to delete the survey
    • Click on OK to delete the survey
    • If you’d like to cancel the survey deletion process, click on Dismiss