Sona Systems : Limesurvey Help Page

Limesurvey Help Page

External Study Credit Granting with LimeSurvey

While these instructions refer to "credit granting", they work for both credit and paid studies. For paid studies, participation will be marked (instead of credit granted) just like with any other paid study.

With LimeSurvey, the instructions below are for version 2.05+ (build 140226) and abovebut not version 2.50+. Instead, view our separate instructions for version 2.50. At a minimum, be sure you are using version 2.0 build 130526 or newer. Earlier versions contain some bugs that will prevent things from working properly.



Here are the basic steps, which are subject to change (since the product is controlled by LimeSurvey):

  1. On your Sona Systems site, change the Study URL so it includes ?id=%SURVEY_CODE% in the URL. So if the LimeSurvey URL is:
    http://limesurvey.yourschool.edu/index.php/651365/lang-en
    then change it to
    http://limesurvey.yourschool.edu/index.php/651365/lang-en?id=%SURVEY_CODE%

    Note: In versions of LimeSurvey prior to 2.05+, the LimeSurvey URL format was different. If you see a ? instead of a / after index.php in the URL, then add &id=%SURVEY_CODE% (so change the ? to a &) to the end of the URL when entering the Study URL.

  2. Having completed Step 1, the Study Information on your Sona Systems site now displays a URL labeled "LimeSurvey End URL". In LimeSurvey, configure the survey to accept the survey code number, as URL Parameter named "id". To do this, go to General Settings | Panel Integration and add the URL parameter there, with no target question. Remember to use lower-case as this is case-sensitive, and be sure to click Save for both the new parameter and panel settings.



    If you would like to track within the responses, the code from the participant, so you can match it up to their sign-up on your Sona Systems site, then you should specify a target question. Make sure the target question is set to Hidden, and the Question Type is set to Short Free Text. A question is made hidden in the Advanced Settings for a question, in Display | Always hide this question.

  3. In LimeSurvey, configure the End URL (in Edit Text Elements), and provide the LimeSurvey End URL from your Sona Systems site. The LimeSurvey URL should look something like this:
    https://yourschool.sona-systems.com/webstudy_credit.aspx?experiment_id=123&credit_token=4e48f9b638a&survey_code={PASSTHRU:id}



    If (and only if) you do not see a LimeSurvey End URL on your Sona Systems site, then proceed with the rest of this step. Otherwise, proceed to the next step. In LimeSurvey, configure the End URL (in Edit Text Elements), and provide the Client-Side Completion URL from your Sona Systems site. However, you need to change the XXXX at the end of the URL, and instead have LimeSurvey put in the survey_code number passed as a pass-through variable. So if the client-side completion URL was:
    https://yourschool.sona-systems.com/webstudy_credit.aspx?experiment_id=123&credit_token=4e48f9b638a&survey_code=XXXX
    then enter it in LimeSurvey as
    https://yourschool.sona-systems.com/webstudy_credit.aspx?experiment_id=123&credit_token=4e48f9b638a&survey_code={PASSTHRU:id}

  4. Note that if, after saving the End URL, you see an & in place of & in the End URL field, then you need to instead set this value while logged into LimeSurvey as an administrator. This is due to a bug in LimeSurvey (bug 7827) that was fixed in version 130526.

  5. In LimeSurvey, set "Automatically load URL when survey complete?" to Yes on General Settings | Presentation & Navigation. This is due to a bug in LimeSurvey (bug 7826), where the survey code will not be properly passed through if this setting is set to No.




These features are described on LimeSurvey's site at the following URL:

("URL Fields") https://manual.limesurvey.org/URL_fields