Actions

Difference between revisions of "Surveys - introduction"

From LimeSurvey Manual

Line 8: Line 8:
 
=General=
 
=General=
  
A survey is an indispensable part of our software. It includes via different interconnected databases: languages, question groups, questions, question attributes, answers, subquestions, default answers, assessments, quotas, quota members, and quota language settings. To facilitate the [[Surveys - introduction#Surveys|surveys management]], the [[Surveys - introduction#Survey groups|survey group]] functionality was recently added.{{NewIn|3.0}}
+
A survey includes via different interconnected databases: languages, question groups, questions, question attributes, answers, subquestions, default answers, assessments, quotas, quota members, and quota language settings. To facilitate the [[Surveys - introduction#Surveys|surveys management]], the [[Surveys - introduction#Survey groups|survey group]] functionality was recently added.{{NewIn|3.0}}
  
 
=Surveys=
 
=Surveys=
Line 53: Line 53:
 
{{Alert|title=Attention|text=Please note that a survey cannot be activated in the absence of a question group!}}
 
{{Alert|title=Attention|text=Please note that a survey cannot be activated in the absence of a question group!}}
 
*'''Description:''' Survey description;
 
*'''Description:''' Survey description;
*'''End URL:''' You have the possibility to redirect the user to another page when they finish filling in the questionnaire. If you wish to redirect them, type in the URL and activate the automatically load URL function that is located under the [[Surveys - introduction#Presentation & navigation|Presentation & navigation tab]].
+
*'''End URL:''' You have the possibility to redirect the user to another page when they finish filling in the questionnaire. If you wish to redirect them, type in the URL and activate the automatically load URL function that is located under the [[Surveys - introduction#Presentation & navigation|Presentation & navigation tab]];
*'''URL description:''' A short end URL description can be added in the case in which the user is redirected to a non-related survey webgapge.
+
*'''URL description:''' A short end URL description can be added in the case in which the user is redirected to a non-related survey webgapge;
 
*'''Date format:''' This option is important when you want to record [[Surveys - introduction#Notification & data management|timestamps]] too together with the survey participants' answers. If you click on it, a drop-down list will show up with a multitude of date formats. Choose the one that mostly fits the survey respondents. Do not forget that different date formats are used across the world. For example, it is recommended to use a different time format on the US market (mm-dd-yyyy) than on an Eastern European country (dd-mm-yy);
 
*'''Date format:''' This option is important when you want to record [[Surveys - introduction#Notification & data management|timestamps]] too together with the survey participants' answers. If you click on it, a drop-down list will show up with a multitude of date formats. Choose the one that mostly fits the survey respondents. Do not forget that different date formats are used across the world. For example, it is recommended to use a different time format on the US market (mm-dd-yyyy) than on an Eastern European country (dd-mm-yy);
 
*'''Decimal mark:''' Two options are available: dot (.) and comma (,). Choose the one that fits the place where you conduct the study (e.g. US vs Germany);
 
*'''Decimal mark:''' Two options are available: dot (.) and comma (,). Choose the one that fits the place where you conduct the study (e.g. US vs Germany);
Line 70: Line 70:
 
*'''Admin email:''' Type in the email of the survey administrator;
 
*'''Admin email:''' Type in the email of the survey administrator;
 
<div class="simplebox">[[File:help.png]]Many hosting providers' SMTP servers will only accept emails whose "From:" address is on a local domain. Any emails that do not conform to this rule are discarded silently, without any visible error message. If this happens to you, ensure that you are using a provider-based email address in the 'Admin email' field. You could also set up email forwarding on the provider's side, so that any messages sent there are relayed to your preferred address.</div>
 
<div class="simplebox">[[File:help.png]]Many hosting providers' SMTP servers will only accept emails whose "From:" address is on a local domain. Any emails that do not conform to this rule are discarded silently, without any visible error message. If this happens to you, ensure that you are using a provider-based email address in the 'Admin email' field. You could also set up email forwarding on the provider's side, so that any messages sent there are relayed to your preferred address.</div>
*'''Bounce email:''' This is the email address where a delivery error notification email should be sent. It represents the address to which bounced emails will be send to;
+
*'''Bounce email:''' This is the email address where a delivery error notification email should be sent. It represents the address to which bounced emails will be sent to;
 
<div class="simplebox">[[File:help.png]] A bounce e-mail is an electronic e-mail which is returned to the sender from various reasons (e.g. invalid address, temporary unavailable mail server, full recipient's mailbox, etc).</div>
 
<div class="simplebox">[[File:help.png]] A bounce e-mail is an electronic e-mail which is returned to the sender from various reasons (e.g. invalid address, temporary unavailable mail server, full recipient's mailbox, etc).</div>
*'''Fax to:''' This field is used to give a fax number on the "printable survey" - i.e.: when you want to send someone a hard copy because he or she cannot use the online survey.;
+
*'''Fax to:''' This field is used to give a fax number on the "printable survey" - i.e.: when you want to send someone a hard copy because he or she cannot use the online survey;
 
*'''Group:''' Select the survey group to which the newly created survey should be added to;{{NewIn|3.0}}  
 
*'''Group:''' Select the survey group to which the newly created survey should be added to;{{NewIn|3.0}}  
 
*'''Format:''' Three options are available:
 
*'''Format:''' Three options are available:
**''Question by Question'' : Public survey will display one question per page.
+
**''Question by Question'' : Public survey will display one question per page;
**''Group by Group'' : The survey will display all questions in a group per page. if this option is chosen, a separate "welcome" page and "submit" page will still be displayed when taking the survey, as in the "Question by Question" surveys.
+
**''Group by Group'' : The survey will display all questions in a group per page. if this option is chosen, a separate "welcome" page and "submit" page will still be displayed when taking the survey, as in the "Question by Question" surveys;
 
**''All in one'' : The survey will display all questions in one single page. If you activate this option, no separate pages exist for the "welcome" or "submit" pages - they will all appear on the same page.
 
**''All in one'' : The survey will display all questions in one single page. If you activate this option, no separate pages exist for the "welcome" or "submit" pages - they will all appear on the same page.
 
*'''Template:''' The default template is rather simple, but functional. More information on creating your own templates is available [[Template editor|here]].
 
*'''Template:''' The default template is rather simple, but functional. More information on creating your own templates is available [[Template editor|here]].
Line 84: Line 84:
 
<center>[[File:Create a new survey - Presentation & navigation.png]]</center>
 
<center>[[File:Create a new survey - Presentation & navigation.png]]</center>
 
*'''Navigation delay (seconds):''' Number of seconds before the previous/next/submit buttons are enabled.  If none is specified, the option will use the default value which is 0 seconds;
 
*'''Navigation delay (seconds):''' Number of seconds before the previous/next/submit buttons are enabled.  If none is specified, the option will use the default value which is 0 seconds;
*'''Show question index / allow jumping:''' A question index can be displayed in the survey if this function is enabled, allowing the user to jump from one question group to another. You can choose the following :
+
*'''Show question index / allow jumping:''' A question index can be displayed in the survey if this function is enabled, allowing the user to jump from one question group to another. You can choose the following:
 
**''Disabled'' : If this option is picked up, no index will be shown and jumping from page to page will not be allowed
 
**''Disabled'' : If this option is picked up, no index will be shown and jumping from page to page will not be allowed
 
**''Incremental'' : If this option is selected, the question groups will be shown incrementally in an index menu located on . As a result, you are allowed "to jump" only to the previous visited question groups
 
**''Incremental'' : If this option is selected, the question groups will be shown incrementally in an index menu located on . As a result, you are allowed "to jump" only to the previous visited question groups
 
**''Full'' : Jumping from question group to question group is allowed via the index menu;
 
**''Full'' : Jumping from question group to question group is allowed via the index menu;
 
*'''Show "There are X questions in this survey": It shows the number of questions and groups in your survey;
 
*'''Show "There are X questions in this survey": It shows the number of questions and groups in your survey;
*'''Show group name and/or group description:'''  Your survey will show to the survey participants question groups names and/or group descriptions.
+
*'''Show group name and/or group description:'''  Your survey will show to the survey participants question groups names and/or group descriptions;
*'''Show question number and/or code:''' What to be shown to the survey participants - the question number and/or the question code, both or none. There is also a fifth option in which this option can be selected by the survey admin. The number of the questions is shown in the moment in which someone wishes to start the survey, while the question code is shown next to each question from the survey.
+
*'''Show question number and/or code:''' What to be shown to the survey participants - the question number and/or the question code, both or none. There is also a fifth option in which this option can be selected by the survey admin. The number of the questions is shown in the moment in which someone wishes to start the survey, while the question code is shown next to each question from the survey;
*'''Show "No answer:''' When a question of a radio button/select type that contains editable answers (i.e.: List & array questions) is not mandatory and this is set to 'On' (default), an additional entry "No answer" is shown for each sub-question - so that participants may choose not to answer the question.
+
*'''Show "No answer:''' When a question of a radio button/select type that contains editable answers (i.e.: List & array questions) is not mandatory and this is set to "On" (default), an additional entry "No answer" is shown for each sub-question - so that participants may choose not to answer the question;
 
**''Selectable'' : The survey users have the possibility to choose whether the question is non-mandatory or not when they create create/edit a question;
 
**''Selectable'' : The survey users have the possibility to choose whether the question is non-mandatory or not when they create create/edit a question;
 
**''On'' : If this option is chosen, the users can create questions with the 'no answer' option for non-mandatory questions ;
 
**''On'' : If this option is chosen, the users can create questions with the 'no answer' option for non-mandatory questions ;
**''Off'' : If off, the users cannot create non-mandatory questions that have the 'non answer' option available for the survey participants.
+
**''Off'' : If off, the users cannot create non-mandatory questions that have the 'non answer' option available for the survey participants;
{{Box|If it has been already chosen to show the "no answer" option from the global settings, then you cannot anymore select another option because the global settings trump the survey settings. To offer freedom to the survey users, the '''Show "No answer"''' button has to be ''selectable'' from global settings.}}
+
{{Box|If it has been already chosen to show the "no answer" option from the global settings, then you cannot anymore select another option because the global settings trump the survey settings. To offer freedom to the survey users, the '''Show "No answer"''' button has to be ''selectable'' from global settings.}};
*'''Show welcome screen:''' If turned off, the welcome text message will not be displayed anymore at the beginning of the questionnaire.
+
*'''Show welcome screen:''' If turned off, the welcome text message will not be displayed anymore at the beginning of the questionnaire;
 
*'''Allow backward navigation:''' If enabled, it will allow the users to navigate backwards and change his or her previous answers;  
 
*'''Allow backward navigation:''' If enabled, it will allow the users to navigate backwards and change his or her previous answers;  
 
*'''Show on-screen keyboard:''' If turned on, an on-screen keyboard will show up when answering questions that require typing in information;  
 
*'''Show on-screen keyboard:''' If turned on, an on-screen keyboard will show up when answering questions that require typing in information;  
*'''Show progress bar:''' It shows to the user a progress bar that underlines how much of the survey was completed and how much is left to be completed.
+
*'''Show progress bar:''' It shows to the user a progress bar that underlines how much of the survey was completed and how much is left to be completed;
*'''Participants may print answers:''' If turned on, the survey participants may choose at the end of the survey to print they answers.
+
*'''Participants may print answers:''' If turned on, the survey participants may choose at the end of the survey to print they answers;
*'''Public statistics:''' A link to a set of statistics will be shown at the end of the survey if this option is enabled,
+
*'''Public statistics:''' A link to a set of statistics will be shown at the end of the survey if this option is enabled;
*'''Show graphs in public statistics:''' If enabled, graphs will also be shown in the public statistics from the end of the survey. Please note that the Public statistics option has to be turned on in order to also show the graphs.
+
*'''Show graphs in public statistics:''' If enabled, graphs will also be shown in the public statistics from the end of the survey. Please note that the "Public statistics option" has to be enabled in order to also show the graphs;
*'''Automatically load URL when survey complete:''' The end URL becames a redirect link once the survey is completed, if this option is turned on.
+
*'''Automatically load URL when survey complete:''' The end URL becomes a redirect link once the survey is completed, if this option is turned on.
  
 
===Publication & access control===
 
===Publication & access control===
  
 +
The following set of options is available under this tab
 
<center>[[File:Publication & access control.png]]</center>
 
<center>[[File:Publication & access control.png]]</center>
 
+
*'''Start date/time:''' The date the survey starts;
*'''Start date/time:''' The date the survey starts.
+
*'''Expiry date/time:''' Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this, just clear the date from the input field;
*'''Expiry date/time:''' Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this, just clear the date from the input field.
+
*'''List survey publicly:''' The default value is "No". When it is set to "Yes", your survey will be listed in the "available surveys" portal;
*'''List survey publicly:''' Yes/No.  The default value is "No". When it is set to yes, your survey will be listed in the 'available surveys' portal.
+
*'''Set cookie to prevent repeated participation:''' If this is turned on, a survey participant will be blocked from completing a survey for the second time;
*'''Set cookie to prevent repeated participation:''' If this is turned on, a survey participant will be blocked from completing a survey for the second time.
+
*'''Use CAPTCHA for survey access:''' In order to access the survey, a CAPTCHA code needs to be typed in;
*'''Use CAPTCHA for survey access:''' In order to access the survey, a CAPTCHA code needs to be typed in.
+
*'''Use CAPTCHA for registration:''' In order to register for the survey, a CAPTCHA code needs to be typed in;
*'''Use CAPTCHA for registration:''' In order to register for the survey, a CAPTCHA code needs to be typed in.
 
 
*'''Use CAPTCHA for save and load:''' Enable it if a survey participant loads again his survey after he completed only a part of it.
 
*'''Use CAPTCHA for save and load:''' Enable it if a survey participant loads again his survey after he completed only a part of it.
  
 
===Notifaction & data management===
 
===Notifaction & data management===
  
 +
The following options are available:
 
<center>[[File:Create a new survey - Notification & data management.png]]</center>
 
<center>[[File:Create a new survey - Notification & data management.png]]</center>
 
 
*'''Date stamp:''' Turn it on if you would like to see the time when the answers were submitted;  
 
*'''Date stamp:''' Turn it on if you would like to see the time when the answers were submitted;  
 
*'''Save IP address:''' If turned yes, the IP address of the survey respondent will be stored  together with his or her answers;  
 
*'''Save IP address:''' If turned yes, the IP address of the survey respondent will be stored  together with his or her answers;  
Line 132: Line 132:
 
#Enter a specific email address (ie: yourname@test.com);
 
#Enter a specific email address (ie: yourname@test.com);
 
#Enter a SGQA code and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would Re-use information from previous answers);
 
#Enter a SGQA code and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would Re-use information from previous answers);
#Enter a Token code (only possible if your survey is not anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would re-use Information from the Tokens Table).
+
#Enter a Token code (only possible if your survey is not anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would re-use Information from the Tokens Table).}}
 
*'''Google Analytics settings:''' If you would like to get further details about the survey web traffic, use Google Analytics. Three options are available:
 
*'''Google Analytics settings:''' If you would like to get further details about the survey web traffic, use Google Analytics. Three options are available:
 
**None: Google Analytics will not be used.
 
**None: Google Analytics will not be used.
 
**Use settings below: if chosen, the survey owner can type in his or her Google Analytics Tracking ID to be stored only with the respective survey. You also have the possibility to choose one of the three Google Analytics styles:
 
**Use settings below: if chosen, the survey owner can type in his or her Google Analytics Tracking ID to be stored only with the respective survey. You also have the possibility to choose one of the three Google Analytics styles:
***Do not use Google Analytics - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string
+
***Do not use Google Analytics - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string;
***Default Google Analytics - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key
+
***Default Google Analytics - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key;
 
***SurveyName-[SID]/GroupName - {GOOGLE_ANALYTICS_JAVASCRIPT} contains customized Google Analytics code to log the URL as {SURVEYNAME}-[{SID}]/{GROUPNAME}.  This can be  helpful if you want to analyze navigation paths through your survey, time spent per page, and drop-off rates per page.
 
***SurveyName-[SID]/GroupName - {GOOGLE_ANALYTICS_JAVASCRIPT} contains customized Google Analytics code to log the URL as {SURVEYNAME}-[{SID}]/{GROUPNAME}.  This can be  helpful if you want to analyze navigation paths through your survey, time spent per page, and drop-off rates per page.
 
**Use global settings: If picked up, the survey will use the same Google Analytics Tracking ID as the one mentioned in the global settings and it iwll allow you to choose the desired Google Analytics style.  
 
**Use global settings: If picked up, the survey will use the same Google Analytics Tracking ID as the one mentioned in the global settings and it iwll allow you to choose the desired Google Analytics style.  
{{Box|Google Analytics Tracking ID for this survey:  Allows for integration with Google Analytics. The tracking ID can be inserted into templates using {GOOGLE_ANALYTICS_API_KEY}. The full JavaScript that Google Analytics expects (including the key) can be included in templates via {GOOGLE_ANALYTICS_JAVASCRIPT}.}}
+
{{Box|Google Analytics Tracking ID for this survey:  Allows for integration with Google Analytics. The tracking ID can be inserted into templates using {GOOGLE_ANALYTICS_API_KEY}. The full JavaScript that Google Analytics expects (including the key) can be included in templates via {GOOGLE_ANALYTICS_JAVASCRIPT}.}}
{{Note|For further details on how to use Google's API with LimeSurvey, check our [[Google API howto|Google API howto page.}}
+
{{Note|For further details on how to use Google's API with LimeSurvey, check our [[Google API howto|Google API howto page]].}}
  
 
===Participant settings===
 
===Participant settings===
  
 +
The following options are available
 
<center>[[File:Create a new survey - participant settings.png]]</center>
 
<center>[[File:Create a new survey - participant settings.png]]</center>
 
+
*'''Set token length to:''' Usually, the default value of 15 (max. supported value: 35) digits does not need to be changed. However, if you wish to change this setting, please enter a number (X) which is greater than 5. If the number entered is smaller than 5, it will be converted to the default value of 15. '''When generating tokens, all tokens will use a length of X digits.'''
*'''Set token length to:''' Usually you don't need to change this, the default setting of 15 digits (max. supported value: 35) is fine. However, if you wish to change this setting, please enter a number (X) which is greater than 5 (if the number entered is smaller than 5, it will be converted to the default value of 15). '''When generating tokens, all tokens will use a length of X digits.'''
 
 
*'''Anonymized responses:''' This options allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is "No". If you choose "Yes", then your survey is set to anonymize responses - '''there will be no way to connect answers and participants'''. Even the admin will not be able to link response data and participant/token data. However, you will always be able to specifically view each response entered by your participants in the survey. Thus individual, but anonymous, statistics is still possible to do.  
 
*'''Anonymized responses:''' This options allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is "No". If you choose "Yes", then your survey is set to anonymize responses - '''there will be no way to connect answers and participants'''. Even the admin will not be able to link response data and participant/token data. However, you will always be able to specifically view each response entered by your participants in the survey. Thus individual, but anonymous, statistics is still possible to do.  
 
{{Alert|title=Attention|text=If this feature is activated, the response submission date and the token completed date are always set to 1980-01-01 00:00, no matter of other settings. Why? Invalidating the submission date ensures no match with webserver logs where the token key might show up when a survey is started. Invalidating the token completed date guarantees that you can't align the order of submitted responses to the order of the token date/time.}}
 
{{Alert|title=Attention|text=If this feature is activated, the response submission date and the token completed date are always set to 1980-01-01 00:00, no matter of other settings. Why? Invalidating the submission date ensures no match with webserver logs where the token key might show up when a survey is started. Invalidating the token completed date guarantees that you can't align the order of submitted responses to the order of the token date/time.}}
Line 160: Line 160:
  
 
If you wish to import a survey, you can do that from the "Create, import, or copy survey" screen.  
 
If you wish to import a survey, you can do that from the "Create, import, or copy survey" screen.  
To get there just click the 'Create, import, or copy a survey' icon and in the following screen click on the 'Import' tab.
+
To get there just click the '''Create, import, or copy a survey''' button and click in the following screen on the 'Import' tab.
Click on the browse button to choose the file, and then click on the ''Import survey' button.  
+
Click on browse to choose the file, and then on the ''Import survey' button.  
  
 
<center>[[FIle:Import a survey.png]]</center>
 
<center>[[FIle:Import a survey.png]]</center>
Line 195: Line 195:
 
*'''Reset response start ID?'''
 
*'''Reset response start ID?'''
  
Once you are done completing the fields and chosing the options you want to be copied into the new survey, click on the '''Copy survey''' button:
+
Once you are done completing the fields and choosing the options you want to be copied into the new survey, click on the '''Copy survey''' button:
  
 
<center>[[File:Survey copy summary.png]]</center>
 
<center>[[File:Survey copy summary.png]]</center>
Line 208: Line 208:
 
*'''Status:''' It can be:
 
*'''Status:''' It can be:
 
**''active'' - If this option is selected, all but inactive surveys are displayed;  
 
**''active'' - If this option is selected, all but inactive surveys are displayed;  
**''active and running'' - [[File:Active survey symbol.png]]
+
**''active and running'' - [[File:Active survey symbol.png]];
**''inactive'' - [[File:Inactive survey.png]]
+
**''inactive'' - [[File:Inactive survey.png]];
**''active but expired'' - [[File:Expired survey icon.png]]
+
**''active but expired'' - [[File:Expired survey icon.png]];
**''active but not yet started'' - [[File:active but not yet started icon.png]]
+
**''active but not yet started'' - [[File:active but not yet started icon.png]];
*'''Title:''' The title of the survey/questionnaire
+
*'''Title:''' The title of the survey/questionnaire;
*'''Group:''' The survey group to which the survey/questionnaire belongs to
+
*'''Group:''' The survey group to which the survey/questionnaire belongs to;
*'''Created:''' The date when the survey was created
+
*'''Created:''' The date when the survey was created;
*'''Owner:''' The name of the user that owns the survey
+
*'''Owner:''' The name of the user that owns the survey;
*'''Anonymized responses:''' It shows whether the responses are anonymized when stored into the database or not.
+
*'''Anonymized responses:''' It shows whether the responses are anonymized when stored into the database or not;
*'''Partial:''' The number of surveys that were partially completed.
+
*'''Partial:''' The number of surveys that were partially completed;
*'''Full:''' The number of surveys that were entirely completed by the survey participants
+
*'''Full:''' The number of surveys that were entirely completed by the survey participants;
*'''Total:''' The number of partially and fully completed surveys
+
*'''Total:''' The number of partially and fully completed surveys;
*'''Closed group:''' It can be either "Yes" - if a token table is used - or ''No''
+
*'''Closed group:''' It can be either "Yes" - if a token table is used - or ''No'';
 
*'''Actions:''' The last columns presents different actions available for each survey:
 
*'''Actions:''' The last columns presents different actions available for each survey:
** [[File:Settings - small symbol.png]] - ''General settings & text :'' You will be redirected to the ''General settings & text :'' tab
+
** [[File:Settings - small symbol.png]] - ''General settings & text :'' You will be redirected to the ''General settings & text :'' tab;
** [[File:Add new quesiton small symbol.png]] - ''Add a new question :'' Used when you want to quickly add a question to the survey.
+
** [[File:Add new quesiton small symbol.png]] - ''Add a new question :'' Used when you want to quickly add a question to the survey;
 
** [[File:Statistics small symbol.png]] - ''Statistics :'' The survey statistics will be shown if the button is clicked.
 
** [[File:Statistics small symbol.png]] - ''Statistics :'' The survey statistics will be shown if the button is clicked.
  

Revision as of 14:14, 15 September 2017

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎Nederlands • ‎português do Brasil • ‎русский • ‎slovenščina


Important.png
Attention : Please note that this tutorial uses explanations and screenshots that are applicable to LimeSurvey 3.xx. Therefore, small differences exist between LimeSurvey 3.xx and LimeSurvey 2.xx, especially in terms of design.

General

A survey includes via different interconnected databases: languages, question groups, questions, question attributes, answers, subquestions, default answers, assessments, quotas, quota members, and quota language settings. To facilitate the surveys management, the survey group functionality was recently added. (New in 3.0 )

Surveys

There are two ways through which you can reach the create a new survey page:

1. The first one is to click on the arrow besides the Surveys button that is located on the main toolbar of your LimeSurvey installation home page. A dialog will show up from where you can choose the Create a new survey option:

Createnewsurvey.png

2. The second one is to click on the Surveys button located on the main toolbar of your LimeSurvey installation home page:

Surveys-alternative button.png

A survey list is shown. To create a new survey, click on the Create a new survey button located on the top-left part of the window, above the survey list.

Create a new survey alternative.png

Create a new survey

After you clicked Create new survey, the following page will be displayed:

Newsurveyscreen.png

To optimize your survey, check the options available under each tab located on the the Create new survey toolbar:

You can also reedit most of these settings again by accessing the available options located in the settings menu of the newly created survey.


Survey texts

The following options can be changed from this tab:

  • Survey title: The title of the survey;
  • Create example question and question group?: (New in 3.0 ) If it is turned on, a question and question group will be added to your survey by default when you create new one;
Important.png
Attention : Please note that a survey cannot be activated in the absence of a question group!
  • Description: Survey description;
  • End URL: You have the possibility to redirect the user to another page when they finish filling in the questionnaire. If you wish to redirect them, type in the URL and activate the automatically load URL function that is located under the Presentation & navigation tab;
  • URL description: A short end URL description can be added in the case in which the user is redirected to a non-related survey webgapge;
  • Date format: This option is important when you want to record timestamps too together with the survey participants' answers. If you click on it, a drop-down list will show up with a multitude of date formats. Choose the one that mostly fits the survey respondents. Do not forget that different date formats are used across the world. For example, it is recommended to use a different time format on the US market (mm-dd-yyyy) than on an Eastern European country (dd-mm-yy);
  • Decimal mark: Two options are available: dot (.) and comma (,). Choose the one that fits the place where you conduct the study (e.g. US vs Germany);
  • Welcome message: Type in a message that will welcome the survey participants when they access your survey link;
  • End message: Type in a message that will be displayed to the survey participants once they finish the questionnaire. If the end URL field is automatically loaded, the end message will not be displayed anymore.

General settings

The following options can be found under this tab:

Create a new survey - General settings.png
  • Base language: The main language of the survey. The default value is the language selected from the global settings of your LimeSurvey installation;
  • Additional languages: More languages can be added to your survey. This option is important when you want to create multilingual surveys. For example, if you wish to use English, German, and Romanian for your survey, add Romanian and German as additional languages (if English is already the default/base language). The list of available languages could be smaller if the LimeSurvey administrator has decided to diminish the number of available languages from the LimeSurvey global settings;
  • Survey owner: Type in the real name of the survey owner;
  • Administrator: The name of the administrator;
  • Admin email: Type in the email of the survey administrator;
Help.pngMany hosting providers' SMTP servers will only accept emails whose "From:" address is on a local domain. Any emails that do not conform to this rule are discarded silently, without any visible error message. If this happens to you, ensure that you are using a provider-based email address in the 'Admin email' field. You could also set up email forwarding on the provider's side, so that any messages sent there are relayed to your preferred address.
  • Bounce email: This is the email address where a delivery error notification email should be sent. It represents the address to which bounced emails will be sent to;
Help.png A bounce e-mail is an electronic e-mail which is returned to the sender from various reasons (e.g. invalid address, temporary unavailable mail server, full recipient's mailbox, etc).
  • Fax to: This field is used to give a fax number on the "printable survey" - i.e.: when you want to send someone a hard copy because he or she cannot use the online survey;
  • Group: Select the survey group to which the newly created survey should be added to; (New in 3.0 )
  • Format: Three options are available:
    • Question by Question : Public survey will display one question per page;
    • Group by Group : The survey will display all questions in a group per page. if this option is chosen, a separate "welcome" page and "submit" page will still be displayed when taking the survey, as in the "Question by Question" surveys;
    • All in one : The survey will display all questions in one single page. If you activate this option, no separate pages exist for the "welcome" or "submit" pages - they will all appear on the same page.
  • Template: The default template is rather simple, but functional. More information on creating your own templates is available here.

Presentation & navigation

The following options can be found under this tab:

Create a new survey - Presentation & navigation.png
  • Navigation delay (seconds): Number of seconds before the previous/next/submit buttons are enabled. If none is specified, the option will use the default value which is 0 seconds;
  • Show question index / allow jumping: A question index can be displayed in the survey if this function is enabled, allowing the user to jump from one question group to another. You can choose the following:
    • Disabled : If this option is picked up, no index will be shown and jumping from page to page will not be allowed
    • Incremental : If this option is selected, the question groups will be shown incrementally in an index menu located on . As a result, you are allowed "to jump" only to the previous visited question groups
    • Full : Jumping from question group to question group is allowed via the index menu;
  • Show "There are X questions in this survey": It shows the number of questions and groups in your survey;
  • Show group name and/or group description: Your survey will show to the survey participants question groups names and/or group descriptions;
  • Show question number and/or code: What to be shown to the survey participants - the question number and/or the question code, both or none. There is also a fifth option in which this option can be selected by the survey admin. The number of the questions is shown in the moment in which someone wishes to start the survey, while the question code is shown next to each question from the survey;
  • Show "No answer: When a question of a radio button/select type that contains editable answers (i.e.: List & array questions) is not mandatory and this is set to "On" (default), an additional entry "No answer" is shown for each sub-question - so that participants may choose not to answer the question;
    • Selectable : The survey users have the possibility to choose whether the question is non-mandatory or not when they create create/edit a question;
    • On : If this option is chosen, the users can create questions with the 'no answer' option for non-mandatory questions ;
    • Off : If off, the users cannot create non-mandatory questions that have the 'non answer' option available for the survey participants;
If it has been already chosen to show the "no answer" option from the global settings, then you cannot anymore select another option because the global settings trump the survey settings. To offer freedom to the survey users, the Show "No answer" button has to be selectable from global settings.
  • Show welcome screen: If turned off, the welcome text message will not be displayed anymore at the beginning of the questionnaire;
  • Allow backward navigation: If enabled, it will allow the users to navigate backwards and change his or her previous answers;
  • Show on-screen keyboard: If turned on, an on-screen keyboard will show up when answering questions that require typing in information;
  • Show progress bar: It shows to the user a progress bar that underlines how much of the survey was completed and how much is left to be completed;
  • Participants may print answers: If turned on, the survey participants may choose at the end of the survey to print they answers;
  • Public statistics: A link to a set of statistics will be shown at the end of the survey if this option is enabled;
  • Show graphs in public statistics: If enabled, graphs will also be shown in the public statistics from the end of the survey. Please note that the "Public statistics option" has to be enabled in order to also show the graphs;
  • Automatically load URL when survey complete: The end URL becomes a redirect link once the survey is completed, if this option is turned on.

Publication & access control

The following set of options is available under this tab

Publication & access control.png
  • Start date/time: The date the survey starts;
  • Expiry date/time: Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this, just clear the date from the input field;
  • List survey publicly: The default value is "No". When it is set to "Yes", your survey will be listed in the "available surveys" portal;
  • Set cookie to prevent repeated participation: If this is turned on, a survey participant will be blocked from completing a survey for the second time;
  • Use CAPTCHA for survey access: In order to access the survey, a CAPTCHA code needs to be typed in;
  • Use CAPTCHA for registration: In order to register for the survey, a CAPTCHA code needs to be typed in;
  • Use CAPTCHA for save and load: Enable it if a survey participant loads again his survey after he completed only a part of it.

Notifaction & data management

The following options are available:

Create a new survey - Notification & data management.png
  • Date stamp: Turn it on if you would like to see the time when the answers were submitted;
  • Save IP address: If turned yes, the IP address of the survey respondent will be stored together with his or her answers;
  • Save referrer URL: If turned yes, the referrer URL will be stored together with the answers. It is useful if you would like to also analyse how your survey participants access your survey;
  • Save timings:
  • Enable assessment mode: You can enable/disable assessments for this survey with this setting;
  • Participant may save and resume later:This setting allows a participant to save his responses and resume to answer the survey at a later time. Please note that this makes most sense with open surveys or surveys with anonymized answer. If you are using tokens and the survey is not anonymous in most cases it is better to activate 'Token-based response persistence' in the token tab.
  • Send basic admin notification email to and Send detailed admin notification email to: These two fields allow you to send notifications or survey responses to any email addresses once the survey is submitted. You can edit the templates for these emails from the [[Survey settings#Email templates|Email templates menu. Multiple recipients can be set by separating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" or (if using placeholders) "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}".
To send an email to the administrator email of the survey : you must use {ADMINEMAIL}. There are different ways for entering an address:
  1. Enter a specific email address (ie: yourname@test.com);
  2. Enter a SGQA code and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would Re-use information from previous answers);
  3. Enter a Token code (only possible if your survey is not anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would re-use Information from the Tokens Table).
  • Google Analytics settings: If you would like to get further details about the survey web traffic, use Google Analytics. Three options are available:
    • None: Google Analytics will not be used.
    • Use settings below: if chosen, the survey owner can type in his or her Google Analytics Tracking ID to be stored only with the respective survey. You also have the possibility to choose one of the three Google Analytics styles:
      • Do not use Google Analytics - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string;
      • Default Google Analytics - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key;
      • SurveyName-[SID]/GroupName - {GOOGLE_ANALYTICS_JAVASCRIPT} contains customized Google Analytics code to log the URL as {SURVEYNAME}-[{SID}]/{GROUPNAME}. This can be helpful if you want to analyze navigation paths through your survey, time spent per page, and drop-off rates per page.
    • Use global settings: If picked up, the survey will use the same Google Analytics Tracking ID as the one mentioned in the global settings and it iwll allow you to choose the desired Google Analytics style.
Google Analytics Tracking ID for this survey: Allows for integration with Google Analytics. The tracking ID can be inserted into templates using {GOOGLE_ANALYTICS_API_KEY}. The full JavaScript that Google Analytics expects (including the key) can be included in templates via {GOOGLE_ANALYTICS_JAVASCRIPT}.
Help.pngFor further details on how to use Google's API with LimeSurvey, check our Google API howto page.

Participant settings

The following options are available

Create a new survey - participant settings.png
  • Set token length to: Usually, the default value of 15 (max. supported value: 35) digits does not need to be changed. However, if you wish to change this setting, please enter a number (X) which is greater than 5. If the number entered is smaller than 5, it will be converted to the default value of 15. When generating tokens, all tokens will use a length of X digits.
  • Anonymized responses: This options allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is "No". If you choose "Yes", then your survey is set to anonymize responses - there will be no way to connect answers and participants. Even the admin will not be able to link response data and participant/token data. However, you will always be able to specifically view each response entered by your participants in the survey. Thus individual, but anonymous, statistics is still possible to do.
Important.png
Attention : If this feature is activated, the response submission date and the token completed date are always set to 1980-01-01 00:00, no matter of other settings. Why? Invalidating the submission date ensures no match with webserver logs where the token key might show up when a survey is started. Invalidating the token completed date guarantees that you can't align the order of submitted responses to the order of the token date/time.
  • Enable token-based response persistence: If your survey uses tokens and your responses are not anonymized, you may want to enable this feature. If you turn this on, your participants will be able to leave the survey and resume later at any time without using the 'Resume later' function - for example, if they get distracted or their browser crashes. Upon clicking the invitation link again, they will find their survey answers still in place when they return to the survey, and will even find themselves on the same page where they were before leaving.
  • Allow multiple responses or update responses with one token: If this option is activate, participants will be able to return to their survey by clicking the invitation link, even if they have already submitted the survey. If the survey is anonymous or "Enable token-based response persistence" is set to "No", this will add a new response. If the survey is not anonymous and "Enable token-based response persistence" is Yes, the user will update the existing responses.
  • Allow public registration: If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.
  • Use HTML format for token emails: When enabled, all emails sent by the token management interface (invite, reminder, confirmation) will be formatted as HTML. You'll then be able to use rich formatting for these emails. The default value is "Yes".
Important.png
Attention : When you switch on or off this feature, you'll have to double check that your email templates are still displayed as you want.
  • Send confirmation emails: If enabled, the participant will receive a confirmation email that the survey has been

Import a survey

If you wish to import a survey, you can do that from the "Create, import, or copy survey" screen. To get there just click the Create, import, or copy a survey button and click in the following screen on the 'Import' tab. Click on browse to choose the file, and then on the Import survey' button.

Import a survey.png

The import process reads the following formats:

  • .LSS files (XML-format created by LimeSurvey 1.90 or later);
  • .LSA files (Survey archive which may include also token, responses and timings - available since LimeSurvey 2.0);
  • .TXT files (Text-format created by Excel - available since LimeSurvey 2.0);
  • .CSV files (Created by early LimeSurvey versions from 1.50 to 1.90).

The import function "intelligently" re-numbers the survey, groups, questions, answers, and condition IDs so that they all match each other. No existing surveys are going to be overwritten during the import process.

Help.png If you wish to use another method, read our wiki on the import functionality alternatives for more information.

Convert resource links and expression fields?

Survey structure import summary.

Survey structure import summary.png

Copy a survey

Copy a survey.png
  • Select survey to copy: Select from the drop-down list the survey you want to copy;
  • New survey title: Type in the title you wish the copied survey to have;
  • New survey id: - it s autmatically different
  • Convert resource links and expression fields
  • Exclude quotas
  • Exclude survey permissions: Exclude the survey users with survey permissions on the original survey to receive the same survey permissions in the copied version of the survey;
  • Exclude answers: Exclude the already-stored answers;
  • Reset conditions/relevance: Reset the conditions set in the original survey;
  • Reset start/end date/time?: Reset the set start/end date/time;
  • Reset response start ID?

Once you are done completing the fields and choosing the options you want to be copied into the new survey, click on the Copy survey button:

Survey copy summary.png

A survey copy summary is presented. To access the copied survey, click Go to survey to be redirected to the settings of the newly added survey.

List surveys

List a survey.png
  • Survey ID: When created, the survey receives a unique id that is used to make the connection between different LimeSurvey tables
  • Status: It can be:
    • active - If this option is selected, all but inactive surveys are displayed;
    • active and running - Active survey symbol.png;
    • inactive - Inactive survey.png;
    • active but expired - Expired survey icon.png;
    • active but not yet started - Active but not yet started icon.png;
  • Title: The title of the survey/questionnaire;
  • Group: The survey group to which the survey/questionnaire belongs to;
  • Created: The date when the survey was created;
  • Owner: The name of the user that owns the survey;
  • Anonymized responses: It shows whether the responses are anonymized when stored into the database or not;
  • Partial: The number of surveys that were partially completed;
  • Full: The number of surveys that were entirely completed by the survey participants;
  • Total: The number of partially and fully completed surveys;
  • Closed group: It can be either "Yes" - if a token table is used - or No;
  • Actions: The last columns presents different actions available for each survey:
    • Settings - small symbol.png - General settings & text : You will be redirected to the General settings & text : tab;
    • Add new quesiton small symbol.png - Add a new question : Used when you want to quickly add a question to the survey;
    • Statistics small symbol.png - Statistics : The survey statistics will be shown if the button is clicked.

To sort surveys, click on the column according to which you want to do that:

Search survey list.png

If you want to look for a specific survey, use the search bar and filter the results through the status of the survey (active, active and running inactive, inactive, active but expired, active but not yet started):

Delete a survey

In order to delete a survey, you have to first access the survey list table. Then, select the surveys you wish to delete and click on the Selected survey(s)... button located on the bottom left side of the page:

Delete survey.png

When you click Delete, a confirmation window will pop up in order to confirm your action.

Export a survey

If you want to export a survey, you have to access the survey list table and select the survey(s) you wish to export:

Delete survey.png

The following options are available:

  • Survey archive (*.lsa)
  • Survey structra (*.lss)
  • Printable survey (*.html)

For more options...

Survey groups

The question group has been added once with the launch of LimeSurvey 3. More survey group features are going to be added in time. If you wish to help, join us on IRC and give us a hand with the code or simply donate to us to fasten the development of LimeSurvey.


Survey groups list.png

Create a survey group

[[File:]]

The following columns are available:

  • Name:;
  • Title;
  • Description;
  • Order: Helps you organise the order of the survey groups within a parent group
  • Parent: Chose the survey group that will be the parent survey group. The parent group option is used to ease the edit of template-related options to a higher number of survey groups.


Edit survey group

The following options of a survey group can be edited:

Edit Survey Group.png

Surveys in this group

If you click on the first tab, all the surveys from the respective group will be displayed.

List LimeSurvey groups.png

This works as a filtering function, filtering out all the surveys not listed in the chosen survey group. Now, you can select the desired survey and start editing them. To see which funcionalities are available, check LIST SURVEYS.

Settings for this survey group

The following fields can be edited from the Settings for this Surveygroup tab

  • Title
  • Description
  • Order
  • Parent

Template options for this survey group

The last option from the toolbar offers you different options to quickly and easily change templates for more than one survey via a few clicks

Template options for survey groups.png

Bootswatch themes can be used to quickly edit your templates. Basically, bootswatch is a collection of themed swatches which can be freely downloaded and dropped into your Bootstrap site. Some of these themes are already included into your LimeSurvey installation and they can be selected from the Bootswatch theme drop-down list.

Bootstrap is a free and open-source front-end web framework for designing websites and web applications. For more details, check the following wiki.


Bootswatch enables users to easily try new looks without investing too much time or energy. For more information on bootswatch themes, check the following link.


Delete a survey group

Examples