eduNEXT / xblock-limesurvey

LimeSurvey XBlock for Open edX
GNU Affero General Public License v3.0
1 stars 0 forks source link

feat: add student interaction with survey from the LMS #3

Closed BryanttV closed 1 year ago

BryanttV commented 1 year ago

Description

This PR adds the get survey handler for the LimeSurvey block. It displays the url of the survey according to the survey_id set by the instructor, and the access code of the student to access the survey

How to test

Configure the XBlock

  1. Install this branch in your environment.
  2. Add the XBlock to your course following the instructions in the README file.
  3. Edit the XBlock and configure it.
  4. Save.

Enable the LimeSurvey API

From the LimeSurvey administrator you must enable the use of the API:

  1. Login in the LimeSurvey admin → limesurvey.local.overhang.io/admin
  2. Navigate to Configuration → Settings → Global → Interfaces.
  3. Enable JSON-RPC in RPC interface enabled.
  4. Save changes.

Configure the Survey

  1. Login in the LimeSurvey admin.
  2. Create a survey with the basic information: Survey title, Base language, Survey group (default) and Administrator (default).
  3. Create a new attribute in the participants table of the survey (Surveys > survey_name > Survey participants > Manage attributes). The new attribute is to store the anonymous user id. You can set any name for this attribute, example auserid. image
  4. Activate the survey (Settings > overview > Activate survey) and select Switch to closed-access mode. image

Finally, from the LMS, click on the Get Survey URL button to obtain the survey URL and the user's access code. image

Pending

  1. Avoid duplicate user in the survey
BryanttV commented 1 year ago

Instructions have been updated