8.40. Survey Tool

Note

EdX offers full support for this tool.

This section describes how to include surveys in your course.

8.40.1. Overview

You can include surveys in your course to collect learner responses to multiple questions.

For a survey, you configure multiple question and multiple possible answers. The set of answers is used for each question in the survey. If you need to ask only one question, use the Poll Tool.

The following example survey has three questions, each with the same three possible answers.

A survey asking multiple questions about the learner's view of the course.

After learners submit their answers to the survey, they see the survey results that have been gathered at this time, unless the survey has been configured to hide results.

The results of a survey asking multiple questions about the learner's view of the course.

8.40.2. Enable the Survey Tool

Before you can add a survey to your course, you must enable the Survey tool in Studio or OLX.

To enable the Survey tool in Studio, you add the "survey" key to the Advanced Module List on the Advanced Settings page. For more information, see Enable Additional Exercises and Tools.

Alternatively, you can use OLX to enable the poll tool.

8.40.2.1. Enable the Survey Tool in OLX

To enable enable the survey tool, you edit the XML file that defines the course structure.

Open the XML file for the course in the course directory. In the course element’s advanced-modules attribute, add the string survey.

For example, the following XML code enables the survey tool.

<course advanced_modules="[&quot;survey&quot;,
    &quot;poll&quot;]" display_name="Sample Course"
    start="2015-01-01T00:00:00Z">
    ...
</course>

8.40.3. Add a Survey in edX Studio

You must enable the survey tool before you add the component.

  1. On the Course Outline page, open the unit where you want to add the survey.

  2. Under Add New Component click Advanced, and then select Survey.

    The new component is added to the unit, with the default survey that contains three answer fields and three questions.

    The survey component in Studio.
  3. In the new component, select Edit.

  4. In the Display Name field, enter the name for the component.

  5. In the Feedback field, enter text that learners see after they submit responses.

  6. In the Private Results field, to hide survey results from learners, select True. If you leave the default value, False, learners see survey results after they submit responses.

  7. In the Maximum Submissions field, to allow learners to submit responses more than once, change the value. Enter 0 to allow unlimited responses.

    Note

    If you allow learners to submit responses more than once, you should set Private Results to True. Otherwise, learners will be able to change their responses after seeing others’ responses.

  8. Configure answers for the survey. Each answer is displayed to learners as a column, with a radio button they can select. Each answer is used for each survey question.

    1. In each Answer field, enter the text for the column heading that learners will see.
    2. To add answers, select Add answer at the bottom of the editor. New answers are added at the bottom of the list.
    3. The top answer in the list is displayed to learners as the left-most answer column in the survey, and the bottom answer is displayed in the right-most column. To change the order of answers, select the up and down buttons next to each answer.
    4. To remove an answer, select Delete next to the answer.
  9. Configure questions for the survey. Each question is displayed to learners in the left-most column.

    1. You must enter either text or an image path, or both, for each question. To enter an image, use the Studio URL for the image.
    2. The survey template contains three questions. To add questions, select Add question at the bottom of the editor. New questions are added at the bottom of the list.
    3. If you use an image, you must enter useful alternative text in the Image alternate text field for non-sighted users.
    4. Questions are displayed to learners as rows in the order you configure them. To change the order of questions, select the up and down buttons next to each question.
    5. To remove a question, select Delete next to the question.
  10. Select Save.

8.40.4. Add a Survey in OLX

To add a survey XBlock in OLX, you create the survey element. You can embed the survey element in the vertical element, or you can create the survey element as a stand-alone file that you reference in the vertical.

The following example shows the OLX definition for a survey with two questions.

<survey
  url_name="unique identfier for the survey"
  xblock-family="xblock.v1"
  questions="[
               [&quot;unique code for question 1&quot;,
                 {
                   &quot;img&quot;: &quot;Static URL to image&quot;,
                   &quot;img_alt&quot;: &quot;Alternative text for image&quot;,
                   &quot;label&quot;: &quot;Text of question 1&quot;
                 }
               ],
               [&quot;unique code for question 2&quot;,
                 {
                   &quot;img&quot;: &quot;Static URL to image&quot;,
                   &quot;img_alt&quot;: &quot;Alternative text for image&quot;,
                   &quot;label&quot;: &quot;Text of question 2&quot;
                  }
                ]
              ]"
  feedback="Feedback displayed to learner after submission"
  private_results="false"
  block_name="Display name for survey"
  max_submissions="1"
  answers="[
            [
              &quot;Unique identifier for answer 1&quot;,
              &quot;Answer text&quot;
            ],
            [
              &quot;Unique identifier for answer 2&quot;,
              &quot;Answer text&quot;
            ]
          ]"
/>

8.40.4.1. survey Element Attributes

The following table describes the attribute of the survey element.

Attribute Description
url_name The unique identifier of the survey.
xblock-family The XBlock version used. Must be xblock.v1.
questions

An array of questions in the survey. Each question has a unique identifier, and a dictionary that defines values for the following names.

  • img, the static URL of the question image.
  • img_alt, the alternative text for the image.
  • label, the question text.

Each question must have a value for img or label, or both.

answers

An array of answers in the survey. Each answer has a unique identifier, and a dictionary that defines values for the following names.

  • img, the static URL of the answer image.
  • img_alt, the alternative text for the image.
  • label, the answer text.

Each answer must have a value for img or label, or both.

feedback The text shown to learners after they submit a response.
private_results Whether the survey results are shown to learners (true) or not (false).
block_name The display name for the survey.
max_submissions The number of times a learner can submit survey answers. Use 0 to allow unlimited submissions. If you use a value other than 1, set private_results to true. Otherwise, learners will be able to change their responses after seeing others’ responses.

8.40.5. Editing Published Surveys

Do not publish a survey until you have completed and tested it. You should avoid changing a survey after learners have begun using it.

If you must edit a survey after learners have submitted answers, take into account the following implications.

  • If you edit the value of a question or answer, previous submissions are associated with the new question or answer value. This change can result in an inaccurate picture of the responses.
  • If you change the survey so that previous submissions are invalid, by removing a question or answer, those submissions are deleted when learners next view the unit. Learners with invalid submissions are permitted to submit new responses.

8.40.6. View Survey Results

When you view the survey as a course staff member, you can view results of the survey in the courseware.

Select View results in the survey.

A survey with the View Results button for course staff.

The results of the survey are then displayed.

The results of a survey asking multiple questions about the learner's view of the course.