https://manual.limesurvey.org/api.php?action=feedcontributions&user=Markusd1984&feedformat=atomLimeSurvey Manual - User contributions [en]2024-03-29T09:50:08ZUser contributionsMediaWiki 1.35.10https://manual.limesurvey.org/index.php?title=Surveys_-_introduction&diff=137331Surveys - introduction2019-03-05T17:08:16Z<p>Markusd1984: add info re survey group purpose to list set of surveys and apply theme/template options</p>
<hr />
<div><languages /> <translate><br />
<!--T:1--><br />
__TOC__<br />
<br />
<br />
<br />
{{Alert|title=Attention|text=Please note that this tutorial uses explanations and screenshots that are applicable to LimeSurvey 3.xx. Small differences exist between LimeSurvey 3.xx and LimeSurvey 2.xx, especially when it comes to the graphical user interface (GUI). We recommend the usage of the last LimeSurvey version.}}<br />
=General= <!--T:49--><br />
<br />
<!--T:50--><br />
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{{NewIn|3.0}} was recently added.<br />
<br />
=Surveys= <!--T:51--><br />
<br />
<!--T:43--><br />
There are two ways through which you can reach the '''[[Surveys - introduction#Create a new survey|create a new survey]]''' page:<br />
<br />
<!--T:52--><br />
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 drop-down list will show up from where you can choose the '''Create a new survey''' option:<br />
<br />
<!--T:44--><br />
<center>[[File:createnewsurvey.png]]</center><br />
<br />
<!--T:53--><br />
2. The second one is to click on the '''Surveys''' button located on the main toolbar of your LimeSurvey installation home page:<br />
<br />
<!--T:54--><br />
<center>[[File:Surveys-alternative button.png]]</center><br />
<br />
<!--T:55--><br />
A survey list will be displayed. 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.<br />
<br />
<br />
<!--T:56--><br />
<center>[[File:Create a new survey alternative.png]]</center><br />
<br />
<br />
==Create a new survey== <!--T:57--><br />
<br />
<!--T:58--><br />
After you pressed '''Create a new survey''', the following page will load:<br />
<br />
<!--T:46--><br />
<center>[[File:newsurveyscreen.png]]</center><br />
<br />
<!--T:59--><br />
To optimize your survey, check the options available under each tab located on the '''Create a new survey''' toolbar:<br />
*[[Surveys - introduction#Text elements|Text elements]]<br />
*[[Surveys - introduction#General settings|General settings]]<br />
*[[Surveys - introduction#Presentation & navigation|Presentation & navigation]]<br />
*[[Surveys - introduction#Publication & access control|Publication & access control]]<br />
*[[Surveys - introduction#Notification & data management|Notification & data management]]<br />
*[[Surveys - introduction#Participant settings|Participant settings]]<br />
<br />
<!--T:47--><br />
{{Box|You can also reedit most of these settings by accessing the [[Survey settings|settings menu]] of the newly created survey and editing the desired options.}}<br />
{{Alert|title=Attention|text=The HTML WYSIWYG editor doesn't allow you to upload files during the survey creation process. Trying to do so will end up with an error message like: "This file uploader is disabled". If you need to upload pictures or any other resources, please do so after the survey creation by accessing the [[Resources|resources panel]] from the [[Survey settings|survey settings menu]].}}<br />
<br />
===Text elements=== <!--T:60--><br />
<br />
<!--T:61--><br />
The following options are located under this tab:<br />
<br />
<!--T:62--><br />
*'''Survey title:''' The title of the survey can be changed from this field;<br />
<br />
<!--T:63--><br />
*'''Create example question and question group?:'''{{NewIn|3.0}} If enabled, a question and question group will be added to your survey by default when you create a survey; <br />
{{Alert|title=Attention|text=Please note that a question has to be first added to a question group in order to be displayed in a survey! Otherwise, the question will not be displayed to the survey participant.}}<br />
<br />
<!--T:209--><br />
*'''Base language''': It represents the main language of the survey. If you wish to add other survey languages, create first a survey, then access the [[General_settings#General_settings_panel|general settings]] of the newly created survey and add ''additional languages''. <br />
<br />
<!--T:64--><br />
*'''Description:''' You can type in a survey description. If enabled from the [[Global settings|global settings]], use the [[Global_settings#General|HTML editor]] to better customize the description field;<br />
<br />
<!--T:65--><br />
*'''End URL:''' You have the possibility to redirect users to another page when they finish filling out the questionnaire. If you wish to redirect them, type in the URL and activate the '''automatically load URL''' option that is located under the [[Surveys - introduction#Presentation & navigation|Presentation & navigation tab]];<br />
<br />
<!--T:66--><br />
*'''URL description:''' A short end URL description can be added in the case in which the user is redirected to a non-related survey webpage. It may help the survey administrator to add notes vis-a-vis the usage of the respective URL;<br />
<br />
<!--T:67--><br />
*'''Date format:''' This option is important when you want to record [[Surveys - introduction#Notification & data management|timestamps]] 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 fits your 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 if your questionnaire focuses on the US market (mm-dd-yyyy) and not on the British market (dd-mm-yy);<br />
<br />
<!--T:68--><br />
*'''Decimal mark:''' Two options are available: dot (.) and comma (,). Choose the one that fits the place where you conduct your study (e.g. US vs Germany);<br />
<br />
<!--T:69--><br />
*'''Welcome message:''' Type in a message that will welcome the survey participants when they access your survey link;<br />
<br />
<!--T:70--><br />
*'''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 [[Surveys - introduction#Presentation & navigation|automatically loaded]], the end message is not displayed anymore.<br />
<br />
===General settings=== <!--T:71--><br />
<br />
<!--T:72--><br />
The following options can be found under this tab:<br />
<br />
<br />
<!--T:73--><br />
<center>[[File:Create a new survey - General settings.png]]</center><br />
<br />
<!--T:76--><br />
*'''Survey owner:''' Type in the real name of the survey owner;<br />
*'''Administrator:''' The name of the administrator;<br />
*'''Admin email:''' Type in the email of the survey administrator;<br />
<br />
<!--T:77--><br />
{{Note|'''Administrator''' and '''admin email''' are utilized in the LimeSurvey [[Email templates|email templates]] system.}}<br />
<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><br />
<br />
<!--T:78--><br />
*'''Bounce email:''' This is the email address where the delivery error notification emails (bounced emails) will be sent to.<br />
<div class="simplebox">[[File:help.png]] A bounce email is an electronic email which is returned to the sender from various reasons (e.g. invalid address, temporary unavailable mail server, full recipient's mailbox, etc).</div><br />
<br />
<!--T:79--><br />
*'''Fax to:''' This field is used to print 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;<br />
<br />
<!--T:80--><br />
*'''Group'''{{NewIn|3.0}}''':''' Select the [[Surveys - introduction#Survey groups|survey group]] the newly created survey should be added to; <br />
<br />
<!--T:81--><br />
*'''Format:''' It allows you to choose the way in which the questions will be displayed to the survey respondents. Three options are available: <br />
**''Question by Question'' : The questions will be displayed one by one (one question per page). If this option is picked up, a separate "welcome" page and "end" page will be displayed when taking the survey;<br />
**''Group by Group'' : Each survey page will display a question group. Also, a separate "welcome" page and "end" page will still be displayed when taking the survey, as in the "Question by Question" surveys;<br />
**''All in one'' : If chosen, all the pages will be displayed on a single page. If you select this option, no separate pages exist for the "welcome" and "end" pages - they will all appear on the same page, together with the questions.<br />
<br />
<!--T:82--><br />
*'''Template:''' The default template is rather simple, but functional. More information on creating your own templates is available [[Theme editor|here]].<br />
<br />
===Presentation & navigation=== <!--T:83--><br />
The following options can be found under this tab:<br />
<br />
<br />
<!--T:84--><br />
<center>[[File:Create a new survey - Presentation & navigation.png]]</center><br />
<br />
<br />
<!--T:85--><br />
*'''Navigation delay (seconds):''' It shows the number of seconds before the previous, next, and submit buttons are enabled. If none is specified, the option will use the default value, which is "0" (seconds);<br />
<br />
<!--T:86--><br />
*'''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:<br />
**''Disabled'' : If this option is picked up, no index is shown in the survey;<br />
**''Incremental'' : If this option is selected, the question groups will be shown incrementally in an index menu located on the survey page. You are allowed "to jump" only to the question groups that were previously visited/accessed;<br />
**''Full'' : Jumping from question group to question group is allowed via the index menu.<br />
<br />
<!--T:87--><br />
*'''Show "There are X questions in this survey''': It shows the total number of questions in your survey;<br />
<br />
<!--T:88--><br />
*'''Show group name and/or group description:''' Your survey will show to the survey participants question groups names and/or group descriptions;<br />
<br />
<!--T:89--><br />
*'''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. 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 survey question;<br />
<br />
<!--T:90--><br />
*'''Show "No answer":''' When a radio button or select type question that contains editable answers (e.g.: List & array questions) has the '''Show "No answer"''' enabled and it is also '''not mandatory''', an additional entry "No answer" is displayed for each question/subquestion. In this way, the respondents may choose not to answer the respective question/subquestion. As a survey administrator, the following two options are available:<br />
<br />
<!--T:91--><br />
**''On'' : If this option is picked up, the respondents can choose the "no answer" option when it comes to selecting an answer for a non-mandatory question;<br />
**''Off'' : If selected, the "no answer" option will not be displayed as a possible answer for any non-mandatory question;<br />
<br />
<!--T:92--><br />
{{Box|If it has been already chosen from the [[Global settings#Presentation|global settings]] by the superadministrator to have the "no answer" option displayed, then the '''Show "No answer"''' of the local survey field becomes non-selectable because the global settings trump the survey settings (idem for the ''Off'' case). To offer freedom to your survey administrators, the superadministrator has to choose ''Selectable'' for the '''Show "No answer"''' option from the global settings of your LimeSurvey installation.}}<br />
<br />
<!--T:93--><br />
*'''Show welcome screen:''' If turned off, the welcome text message will not be displayed anymore at the beginning of the questionnaire;<br />
<br />
<!--T:94--><br />
*'''Allow backward navigation:''' If enabled, it will allow the users to navigate backwards and change his or her previous answers; <br />
<br />
<!--T:95--><br />
*'''Show on-screen keyboard:''' If turned on, an on-screen keyboard will show up when answering questions that require typing in information; <br />
<br />
<!--T:96--><br />
*'''Show progress bar:''' It shows to the survey participant a progress bar that emphasizes how much of the survey is filled out and how much is left to be completed;<br />
<br />
<!--T:97--><br />
*'''Participants may print answers:''' If turned on, the survey participants may choose at the end of the survey to print their answers; <br />
<br />
<!--T:98--><br />
*'''Public statistics:''' A link to a set of statistics will be shown at the end of the survey if this option is enabled;<br />
<br />
<!--T:99--><br />
*'''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 to allow the survey participants see the graphs in the public statistics;<br />
<br />
<!--T:100--><br />
*'''Automatically load URL when survey complete:''' The end URL becomes a redirect link once the survey is completed, if this option is turned on.<br />
<br />
===Publication & access control=== <!--T:101--><br />
<br />
<!--T:102--><br />
The following set of options is available under this tab:<br />
<br />
<br />
<!--T:103--><br />
<center>[[File:Publication & access control.png]]</center><br />
<br />
<br />
<!--T:104--><br />
*'''Start date/time:''' The date/time the survey starts;<br />
<br />
<!--T:105--><br />
*'''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 fill out the survey on the 1st of January). To disable this, just clear the date from the input field;<br />
<br />
<!--T:106--><br />
*'''List survey publicly:''' The default value is "No". When it is set to "Yes", your survey will be listed in the "available surveys" portal where it can be seen by all [[Manage users|LimeSurvey users]];<br />
<br />
<!--T:107--><br />
*'''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;<br />
<br />
<!--T:108--><br />
*'''Use CAPTCHA for survey access:''' In order to access the survey, a CAPTCHA code has be typed in by the survey participant;<br />
<br />
<!--T:109--><br />
*'''Use CAPTCHA for registration:''' In order to register for the survey, a CAPTCHA code has be typed in by the survey participant;<br />
<br />
<!--T:110--><br />
*'''Use CAPTCHA for save and load:''' Enable it if you wish a survey participant to type in a CAPTCHA code when he or she loads again the survey after only a part of it was completed.<br />
<br />
===Notification & data management=== <!--T:111--><br />
<br />
<!--T:112--><br />
The following options are available:<br />
<br />
<br />
<!--T:113--><br />
<center>[[File:Create a new survey - Notification & data management.png]]</center><br />
<br />
<br />
<!--T:114--><br />
*'''Date stamp:''' Turn it on if you would like to see the time when the answers were submitted; <br />
<br />
<!--T:115--><br />
*'''Save IP address:''' If turned yes, the IP address of the survey respondent will be stored together with his or her answers; <br />
<br />
<!--T:116--><br />
*'''Save referrer URL:''' If turned yes, the referrer URL will be stored together with the answers;<br />
<br />
<!--T:117--><br />
*'''Save timings:''' If enabled, the time spent on each page of the survey by each survey participant is recorded; <br />
<br />
<!--T:118--><br />
*'''Enable assessment mode:''' You can enable/disable assessments for this survey with this setting;<br />
<br />
<!--T:119--><br />
*'''Participant may save and resume later:''' This setting allows a participant to save his responses and resume to answer the survey questions at a later time. Please note that this makes most sense with open surveys or surveys with anonymized answer. If you are using [[Survey participants|tokens]] and the survey [[Participant settings|is not anonymous]], in most cases it is better to activate '''token-based response persistence''' from the [[Participant settings]] panel.<br />
<br />
<!--T:120--><br />
*'''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 (;) (e.g "yourname@test.com; myname@test.com;hisname@test.com" or (if using placeholders) "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}"). <br />
<br />
<!--T:121--><br />
{{Box|To send an email to the survey administrator, '''you must use {ADMINEMAIL}'''. <br />
<br />
<!--T:122--><br />
There are different ways for entering an address:<br />
#Enter a specific email address (ie: yourname@test.com);<br />
#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 reuse information from previous answers);<br />
#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 '''Survey participants''' table).}}<br />
<br />
<!--T:123--><br />
*'''Google Analytics settings:''' If you would like to get further details about the survey web traffic, use Google Analytics. Three options are available:<br />
**''None'' : Google Analytics will not be used;<br />
**''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:<br />
***Do not use Google Analytics - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string;<br />
***Default Google Analytics - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key;<br />
***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.<br />
**''Use global settings'' : If picked up, the survey will use the same Google Analytics Tracking ID as the one saved in the [[Global settings#General|global settings]] and then you choose the desired Google Analytics style. <br />
<br />
<!--T:124--><br />
{{Box|Google Analytics Tracking ID for a specific 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}.}}<br />
{{Note|For further details on how to use Google's API with LimeSurvey, check our [[Google API howto|Google API howto page]].}}<br />
<br />
===Participant settings=== <!--T:125--><br />
<br />
<!--T:126--><br />
The following options are available:<br />
<br />
<br />
<!--T:127--><br />
<center>[[File:Create a new survey - participant settings.png]]</center><br />
<br />
<br />
<!--T:128--><br />
*'''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''';<br />
<br />
<!--T:129--><br />
*'''Anonymized responses:''' It allows you to determine whether responses to your survey are matched up with information from the '''Survey participants''' table (utilized in the respective survey) or are 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 survey administrator 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 and anonymous analyses can still be done; <br />
<br />
<!--T:130--><br />
{{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, regardless of other settings. Invalidating the submission date ensures no match with the 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.}}<br />
<br />
<!--T:131--><br />
*'''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, when 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;<br />
<br />
<!--T:132--><br />
*'''Allow multiple responses or update responses with one token:''' If this option is activated, 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 enabled, the user will update the existing responses;<br />
<br />
<!--T:133--><br />
*'''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 code allocated in the [[Survey participants|Survey participants table]]. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow visitors to register his or her name and email address. The script will create a new entry in your '''Survey participants''' 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;<br />
<br />
<!--T:134--><br />
*'''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"; <br />
{{Alert|title=Attention|text=When you switch on or off this feature, you'll have to double check that your email templates are still displayed as you want.}}<br />
<br />
<!--T:135--><br />
*'''Send confirmation emails:''' If enabled, the participant will receive a confirmation email that the survey was submitted.<br />
<br />
==Import a survey== <!--T:136--><br />
<br />
<!--T:137--><br />
If you wish to import a survey, you can do that from the "Create, import, or copy survey" screen. <br />
To get there, click the '''Create, import, or copy a survey''' button and then on the '''Import''' tab. Next, click on '''browse''' to choose the file you wish to import, and then on the '''Import survey''' button. <br />
<br />
<br />
<!--T:138--><br />
<center>[[FIle:Import a survey.png]]</center><br />
<br />
<br />
<!--T:139--><br />
The import process reads the following formats:<br />
*.[[Exporting_a_survey_structure#Export_survey_structure_.28.lss.29|LSS files]] (XML-format created by LimeSurvey 1.90 or later);<br />
*.[[Exporting_a_survey_structure#Export_survey_archive_.28.lsa.29|LSA files]] (Survey archive which may include also token, responses and timings - available since LimeSurvey 2.0);<br />
*.[[Exporting_a_survey_structure#Export_tab-separated-values_format_.28.txt.29_.28New_in_2.0_.29|TXT files]] (Text-format created by Excel - available since LimeSurvey 2.0);<br />
*.CSV files (Created by early LimeSurvey versions from 1.50 to 1.90).<br />
<br />
<!--T:140--><br />
The import function "intelligently" re-numbers the survey, groups, questions, answers, and condition IDs so that they all match each other. No existing survey is going to be overwritten during the import process.<br />
<br />
<!--T:141--><br />
By default, the resource links and expression fields are also imported. Basically, the more advanced type of questions are going to be also imported along questions that include complex branching, assessments, validation, and tailoring. <br />
<br />
<!--T:142--><br />
{{Note|For further details on LimeSurvey expression manager, read [[Expression Manager|our wiki]].}}<br />
<br />
<!--T:143--><br />
Once the import process is completed, a survey structure import summary will be displayed, showing whether it was successful or not:<br />
<br />
<br />
<!--T:144--><br />
<center>[[File:Survey structure import summary.png]]</center><br />
<br />
<br />
<!--T:145--><br />
<div class="simplebox">[[File:help.png]] If you wish to use another method, read our wiki on [[Alternatives to the LimeSurvey import function|import alternatives]] for more information.</div><br />
<br />
==Copy a survey== <!--T:146--><br />
<br />
<!--T:147--><br />
The last tab contains the copy survey functionality and its options:<br />
<br />
<br />
<!--T:148--><br />
<center>[[FIle:Copy a survey.png]]</center><br />
<br />
<br />
<!--T:149--><br />
*'''Select survey to copy''': Select from the drop-down list the survey you want to copy;<br />
<br />
<!--T:150--><br />
*'''New survey title:''' Type in the title you wish the copied survey to have;<br />
<br />
<!--T:151--><br />
*'''New survey id:''' You can complete it or let the field empty as it gets automatically assigned a survey id during the process;<br />
<br />
<!--T:152--><br />
*'''Convert resource links and expression fields:''' If you disable it, the more [[Expression Manager|advanced question types that use the expression manager]] will not be copied;<br />
<br />
<!--T:153--><br />
*'''Exclude quotas''': The [[Survey quotas|quotas]] are going to be excluded if this option is disabled;<br />
<br />
<!--T:154--><br />
*'''Exclude survey permissions:''' If enabled, no survey permissions will be copied into the new survey.<br />
<br />
<!--T:155--><br />
*'''Exclude answers:''' Exclude the already-stored answers;<br />
<br />
<!--T:156--><br />
*'''Reset conditions/relevance:''' Reset the conditions set in the original survey;<br />
<br />
<!--T:157--><br />
*'''Reset start/end date/time?:''' Reset the set start/end date/time;<br />
<br />
<!--T:158--><br />
*'''Reset response start ID?:''' Each response has a corresponding ID. If enabled, the ID of the responses will be reset. However, bear in mind that it is better not to have an id with two matching responses because it might influence the output of your survey.<br />
<br />
<!--T:159--><br />
Once you are done with the options, click on the '''Copy survey''' button located on the bottom of the page. A survey copy summary will be displayed:<br />
<br />
<br />
<!--T:160--><br />
<center>[[File:Survey copy summary.png]]</center><br />
<br />
<br />
<!--T:161--><br />
To access the copied survey, click '''Go to survey''' to be redirected to the settings of the newly added survey.<br />
<br />
==List surveys== <!--T:162--><br />
<br />
<!--T:163--><br />
To get an overview of all your surveys, click on the '''Surveys''' button located on the toolbar of LimeSurvey home page:<br />
<br />
<br />
<!--T:164--><br />
<center>[[File:List a survey.png]]</center><br />
<br />
<br />
<!--T:165--><br />
*'''Survey ID:''' When created, the survey receives a unique id that is used to make the connection between different LimeSurvey tables;<br />
<br />
<!--T:166--><br />
*'''Status:''' It can be:<br />
**''active'' - If this option is selected, all but inactive surveys are displayed; <br />
**''active and running'' - [[File:Active survey symbol.png]];<br />
**''inactive'' - [[File:Inactive survey.png]];<br />
**''active but expired'' - [[File:Expired survey icon.png]];<br />
**''active but not yet started'' - [[File:active but not yet started icon.png]];<br />
<br />
<!--T:167--><br />
*'''Title:''' The title of the survey;<br />
*'''Group:''' The survey group to which the survey belongs to;<br />
*'''Created:''' The date when the survey was created;<br />
*'''Owner:''' The name of the user that owns the survey;<br />
*'''Anonymized responses:''' It shows whether the responses are anonymized when stored into the database or not;<br />
*'''Partial:''' The number of surveys that were partially completed;<br />
*'''Full:''' The number of surveys that were fully completed by the survey participants;<br />
*'''Total:''' The number of partially and fully completed surveys;<br />
*'''Closed group:''' It can be either "Yes" (if a '''Survey participants''' table is used) or "No";<br />
<br />
<!--T:168--><br />
*'''Actions:''' The last column presents the actions that are available for each survey:<br />
** [[File:Settings - small symbol.png]] - ''General settings & text :'' You will be redirected to the '''General settings & text''' tab;<br />
** [[File:Add new quesiton small symbol.png]] - ''Add a new question :'' Used when you want to quickly add a question to the survey;<br />
** [[File:Statistics small symbol.png]] - ''Statistics :'' The survey statistics ("simple" mode) will be shown if the button is clicked.<br />
<br />
<br />
<!--T:169--><br />
<center>[[File:Search survey list.png]]</center><br />
<br />
<br />
<!--T:170--><br />
If you want to look for a specific survey, use the search bar and filter the results via the survey status field ("active", "active and running inactive", "inactive", "active but expired", and "active but not yet started").<br />
<br />
==Delete a survey== <!--T:171--><br />
<br />
<!--T:172--><br />
In order to delete a survey, you have to first access the survey list page. Then, select the survey(s) you wish to delete and click on the '''Selected survey(s)...''' button located on the bottom-left side of the page:<br />
<br />
<br />
<!--T:173--><br />
<center>[[File:Delete survey.png]]</center><br />
<br />
<br />
<!--T:174--><br />
When you click '''Delete''', a confirmation window will pop up in order to confirm your action. <br />
<br />
==Export a survey== <!--T:175--><br />
<br />
<!--T:176--><br />
If you want to export a survey, you have to access the survey list table and select the survey(s) you wish to export:<br />
<br />
<br />
<!--T:177--><br />
<center>[[File:Export_survey_simple.png]]</center><br />
<br />
<br />
<!--T:178--><br />
The following options are available:<br />
*[[Exporting_a_survey_structure#Export_survey_archive_.28.lsa.29|Survey archive (*.lsa)]];<br />
*[[Exporting_a_survey_structure#Export_survey_structure_.28.lss.29|Survey structure (*.lss)]];<br />
*Printable survey (*.html): if you would like to export the survey in a printable format in order to be filled out "offline".<br />
<br />
<!--T:179--><br />
For more details, check our [[Exporting a survey structure|wiki section on how to export a survey structure]].<br />
<br />
=Survey groups= <!--T:180--><br />
<br />
<!--T:181--><br />
<div class="simplebox">The survey group functionality has been added once with the launch of LimeSurvey 3. More survey group features will be added in time. If you wish to help, join us on [irc://irc.freenode.net/limesurvey IRC] and give us a hand with [https://github.com/LimeSurvey/LimeSurvey the code] or else [https://www.limesurvey.org/component/nbill?action=orders&task=order&cid=2 donate] to help the core LimeSurvey development group.<br />
<br />
Currently survey groups can list a set of surveys and apply theme/template options.</div><br />
<br />
<!--T:182--><br />
In order to access the survey group functionalities, click on the '''Surveys''' button located on the main toolbar of the LimeSurvey home page. Then, access '''Survey groups''':<br />
<br />
<br />
<!--T:183--><br />
<center>[[File:Survey groups list.png]]</center><br />
<br />
<br />
<!--T:184--><br />
A survey groups list will be displayed.<br />
On this page you can:<br />
*[[Surveys - introduction#Create a survey group|Create a survey group]] - located above the survey groups table;<br />
*[[Surveys - introduction#Edit survey group|Edit a survey group]] - located on the last column (the green pencil icon);<br />
*[[Surveys - introduction#Delete a survey group|Delete a survey group]] - located on the last column (the red trash icon).<br />
<br />
==Create a survey group== <!--T:185--><br />
<br />
<!--T:186--><br />
To add a new survey group, click on the '''Create a new survey group''' button located above the survey groups list. The following columns have to be filled in:<br />
<br />
<!--T:187--><br />
*'''Name:''' Type in the name of the survey group;<br />
*'''Title:''' Type in the title of the survey group;<br />
*'''Description:''' Type in a short description of the survey group;<br />
*'''Order:''' Helps you organize the order of the survey groups within a parent group; <br />
*'''Parent:''' Choose the survey group that will be the parent survey group. The parent group option is used to ease the edit of template-related options of a high number of survey groups via a few clicks.<br />
<br />
<br />
To add surveys to the group you will need to visit the '''"General settings"''' tab inside a survey and under '''"Group"''' select the survey group.<br />
==Edit survey group== <!--T:188--><br />
<br />
<!--T:189--><br />
The following options of a survey group can be edited:<br />
<br />
<!--T:190--><br />
*[[Surveys - introduction#Surveys in this group|Surveys in this group]];<br />
*[[Surveys - introduction#Settings for this survey group|Settings for this survey group]];<br />
*[[Surveys - introduction#Template options for this survey group|Template options for this survey group]]{{NewIn|3.0}}.<br />
<br />
===Surveys in this group=== <!--T:191--><br />
<br />
<!--T:192--><br />
If you click on the first tab, all the surveys from the respective group will be displayed.<br />
<br />
<br />
<!--T:193--><br />
<center>[[File:List LimeSurvey groups.png]]</center><br />
<br />
<br />
<!--T:194--><br />
This works as a filtering function, filtering out all the surveys not listed in the chosen survey group. You can now select the desired survey and start editing it. To see which survey-editing functionalities are available, check the [[Surveys - introduction#List surveys|list surveys]] section.<br />
<br />
<br />
===Settings for this survey group=== <!--T:195--><br />
<br />
<br />
<!--T:196--><br />
The following fields can be edited from the '''Settings for this Surveygroup''' tab:<br />
<br />
<br />
<!--T:197--><br />
<center>[[File:Edit Survey Group.png]]</center><br />
<br />
<br />
<!--T:198--><br />
*'''Title:''' Type in the title of the survey group;<br />
*'''Description:''' Type in a short description of the survey group;<br />
*'''Order:''' Helps you organize the order of the survey groups within a parent group;<br />
*'''Parent:''' Choose 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 via a few clicks.<br />
<br />
===Template options for this survey group=== <!--T:199--><br />
<br />
<!--T:200--><br />
The template options functionalities are present in LimeSurvey 3.0+. It offers a set of various options that allows you to quickly and easily change the templates-related settings of the surveys that belong to the same survey group:<br />
<br />
<br />
<!--T:201--><br />
<center>[[File:Template options for survey groups.png]]</center><br />
<br />
<br />
<!--T:202--><br />
The '''Inherit everything''' functionality lets you decide whether you want the survey group to inherit everything or not from the parent survey group theme. <br />
If you do not want this to happen, select "No". The following options will show up which will allow you to choose what should be inherited from the parent survey group theme:<br />
<br />
<br />
<!--T:203--><br />
<center>[[File:Not inheriting everything survey group.png]]</center><br />
<br />
<br />
<!--T:204--><br />
Below, you will see that you can choose a bootswatch theme for your survey group. Bootswatch themes can be used to quickly edit your templates. Basically, bootswatch is a collection of themed swatches which can be [https://bootswatch.com/ 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.<br />
{{Box|Bootstrap is a free and open-source front-end web framework for designing websites and web applications. For more details, check [https://en.wikipedia.org/wiki/Bootstrap_(front-end_framework) the following wiki].}}<br />
{{Box|Bootswatch enables users to easily try new looks without investing too much time or energy. For more information on bootswatch themes, check [https://bootswatch.com/ the following link].}}<br />
<br />
<!--T:205--><br />
If you want to tweak more a survey group template options, click on the '''advanced option''' tab (recommended for advanced users):<br />
<br />
<br />
<!--T:206--><br />
<center>[[File:Advanced options survey group templates.png]]</center><br />
<br />
==Delete a survey group== <!--T:207--><br />
<br />
<!--T:208--><br />
To delete a survey group, select the survey group you wish to remove and click on the red trash button located in the last column. Then, confirm the deletion.<br />
<br />
<br />
</translate></div>Markusd1984https://manual.limesurvey.org/index.php?title=Surveys_-_introduction&diff=137330Surveys - introduction2019-03-05T16:34:16Z<p>Markusd1984: info added for survey groups to visit general settings tab</p>
<hr />
<div><languages /> <translate><br />
<!--T:1--><br />
__TOC__<br />
<br />
<br />
<br />
{{Alert|title=Attention|text=Please note that this tutorial uses explanations and screenshots that are applicable to LimeSurvey 3.xx. Small differences exist between LimeSurvey 3.xx and LimeSurvey 2.xx, especially when it comes to the graphical user interface (GUI). We recommend the usage of the last LimeSurvey version.}}<br />
=General= <!--T:49--><br />
<br />
<!--T:50--><br />
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{{NewIn|3.0}} was recently added.<br />
<br />
=Surveys= <!--T:51--><br />
<br />
<!--T:43--><br />
There are two ways through which you can reach the '''[[Surveys - introduction#Create a new survey|create a new survey]]''' page:<br />
<br />
<!--T:52--><br />
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 drop-down list will show up from where you can choose the '''Create a new survey''' option:<br />
<br />
<!--T:44--><br />
<center>[[File:createnewsurvey.png]]</center><br />
<br />
<!--T:53--><br />
2. The second one is to click on the '''Surveys''' button located on the main toolbar of your LimeSurvey installation home page:<br />
<br />
<!--T:54--><br />
<center>[[File:Surveys-alternative button.png]]</center><br />
<br />
<!--T:55--><br />
A survey list will be displayed. 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.<br />
<br />
<br />
<!--T:56--><br />
<center>[[File:Create a new survey alternative.png]]</center><br />
<br />
<br />
==Create a new survey== <!--T:57--><br />
<br />
<!--T:58--><br />
After you pressed '''Create a new survey''', the following page will load:<br />
<br />
<!--T:46--><br />
<center>[[File:newsurveyscreen.png]]</center><br />
<br />
<!--T:59--><br />
To optimize your survey, check the options available under each tab located on the '''Create a new survey''' toolbar:<br />
*[[Surveys - introduction#Text elements|Text elements]]<br />
*[[Surveys - introduction#General settings|General settings]]<br />
*[[Surveys - introduction#Presentation & navigation|Presentation & navigation]]<br />
*[[Surveys - introduction#Publication & access control|Publication & access control]]<br />
*[[Surveys - introduction#Notification & data management|Notification & data management]]<br />
*[[Surveys - introduction#Participant settings|Participant settings]]<br />
<br />
<!--T:47--><br />
{{Box|You can also reedit most of these settings by accessing the [[Survey settings|settings menu]] of the newly created survey and editing the desired options.}}<br />
{{Alert|title=Attention|text=The HTML WYSIWYG editor doesn't allow you to upload files during the survey creation process. Trying to do so will end up with an error message like: "This file uploader is disabled". If you need to upload pictures or any other resources, please do so after the survey creation by accessing the [[Resources|resources panel]] from the [[Survey settings|survey settings menu]].}}<br />
<br />
===Text elements=== <!--T:60--><br />
<br />
<!--T:61--><br />
The following options are located under this tab:<br />
<br />
<!--T:62--><br />
*'''Survey title:''' The title of the survey can be changed from this field;<br />
<br />
<!--T:63--><br />
*'''Create example question and question group?:'''{{NewIn|3.0}} If enabled, a question and question group will be added to your survey by default when you create a survey; <br />
{{Alert|title=Attention|text=Please note that a question has to be first added to a question group in order to be displayed in a survey! Otherwise, the question will not be displayed to the survey participant.}}<br />
<br />
<!--T:209--><br />
*'''Base language''': It represents the main language of the survey. If you wish to add other survey languages, create first a survey, then access the [[General_settings#General_settings_panel|general settings]] of the newly created survey and add ''additional languages''. <br />
<br />
<!--T:64--><br />
*'''Description:''' You can type in a survey description. If enabled from the [[Global settings|global settings]], use the [[Global_settings#General|HTML editor]] to better customize the description field;<br />
<br />
<!--T:65--><br />
*'''End URL:''' You have the possibility to redirect users to another page when they finish filling out the questionnaire. If you wish to redirect them, type in the URL and activate the '''automatically load URL''' option that is located under the [[Surveys - introduction#Presentation & navigation|Presentation & navigation tab]];<br />
<br />
<!--T:66--><br />
*'''URL description:''' A short end URL description can be added in the case in which the user is redirected to a non-related survey webpage. It may help the survey administrator to add notes vis-a-vis the usage of the respective URL;<br />
<br />
<!--T:67--><br />
*'''Date format:''' This option is important when you want to record [[Surveys - introduction#Notification & data management|timestamps]] 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 fits your 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 if your questionnaire focuses on the US market (mm-dd-yyyy) and not on the British market (dd-mm-yy);<br />
<br />
<!--T:68--><br />
*'''Decimal mark:''' Two options are available: dot (.) and comma (,). Choose the one that fits the place where you conduct your study (e.g. US vs Germany);<br />
<br />
<!--T:69--><br />
*'''Welcome message:''' Type in a message that will welcome the survey participants when they access your survey link;<br />
<br />
<!--T:70--><br />
*'''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 [[Surveys - introduction#Presentation & navigation|automatically loaded]], the end message is not displayed anymore.<br />
<br />
===General settings=== <!--T:71--><br />
<br />
<!--T:72--><br />
The following options can be found under this tab:<br />
<br />
<br />
<!--T:73--><br />
<center>[[File:Create a new survey - General settings.png]]</center><br />
<br />
<!--T:76--><br />
*'''Survey owner:''' Type in the real name of the survey owner;<br />
*'''Administrator:''' The name of the administrator;<br />
*'''Admin email:''' Type in the email of the survey administrator;<br />
<br />
<!--T:77--><br />
{{Note|'''Administrator''' and '''admin email''' are utilized in the LimeSurvey [[Email templates|email templates]] system.}}<br />
<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><br />
<br />
<!--T:78--><br />
*'''Bounce email:''' This is the email address where the delivery error notification emails (bounced emails) will be sent to.<br />
<div class="simplebox">[[File:help.png]] A bounce email is an electronic email which is returned to the sender from various reasons (e.g. invalid address, temporary unavailable mail server, full recipient's mailbox, etc).</div><br />
<br />
<!--T:79--><br />
*'''Fax to:''' This field is used to print 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;<br />
<br />
<!--T:80--><br />
*'''Group'''{{NewIn|3.0}}''':''' Select the [[Surveys - introduction#Survey groups|survey group]] the newly created survey should be added to; <br />
<br />
<!--T:81--><br />
*'''Format:''' It allows you to choose the way in which the questions will be displayed to the survey respondents. Three options are available: <br />
**''Question by Question'' : The questions will be displayed one by one (one question per page). If this option is picked up, a separate "welcome" page and "end" page will be displayed when taking the survey;<br />
**''Group by Group'' : Each survey page will display a question group. Also, a separate "welcome" page and "end" page will still be displayed when taking the survey, as in the "Question by Question" surveys;<br />
**''All in one'' : If chosen, all the pages will be displayed on a single page. If you select this option, no separate pages exist for the "welcome" and "end" pages - they will all appear on the same page, together with the questions.<br />
<br />
<!--T:82--><br />
*'''Template:''' The default template is rather simple, but functional. More information on creating your own templates is available [[Theme editor|here]].<br />
<br />
===Presentation & navigation=== <!--T:83--><br />
The following options can be found under this tab:<br />
<br />
<br />
<!--T:84--><br />
<center>[[File:Create a new survey - Presentation & navigation.png]]</center><br />
<br />
<br />
<!--T:85--><br />
*'''Navigation delay (seconds):''' It shows the number of seconds before the previous, next, and submit buttons are enabled. If none is specified, the option will use the default value, which is "0" (seconds);<br />
<br />
<!--T:86--><br />
*'''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:<br />
**''Disabled'' : If this option is picked up, no index is shown in the survey;<br />
**''Incremental'' : If this option is selected, the question groups will be shown incrementally in an index menu located on the survey page. You are allowed "to jump" only to the question groups that were previously visited/accessed;<br />
**''Full'' : Jumping from question group to question group is allowed via the index menu.<br />
<br />
<!--T:87--><br />
*'''Show "There are X questions in this survey''': It shows the total number of questions in your survey;<br />
<br />
<!--T:88--><br />
*'''Show group name and/or group description:''' Your survey will show to the survey participants question groups names and/or group descriptions;<br />
<br />
<!--T:89--><br />
*'''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. 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 survey question;<br />
<br />
<!--T:90--><br />
*'''Show "No answer":''' When a radio button or select type question that contains editable answers (e.g.: List & array questions) has the '''Show "No answer"''' enabled and it is also '''not mandatory''', an additional entry "No answer" is displayed for each question/subquestion. In this way, the respondents may choose not to answer the respective question/subquestion. As a survey administrator, the following two options are available:<br />
<br />
<!--T:91--><br />
**''On'' : If this option is picked up, the respondents can choose the "no answer" option when it comes to selecting an answer for a non-mandatory question;<br />
**''Off'' : If selected, the "no answer" option will not be displayed as a possible answer for any non-mandatory question;<br />
<br />
<!--T:92--><br />
{{Box|If it has been already chosen from the [[Global settings#Presentation|global settings]] by the superadministrator to have the "no answer" option displayed, then the '''Show "No answer"''' of the local survey field becomes non-selectable because the global settings trump the survey settings (idem for the ''Off'' case). To offer freedom to your survey administrators, the superadministrator has to choose ''Selectable'' for the '''Show "No answer"''' option from the global settings of your LimeSurvey installation.}}<br />
<br />
<!--T:93--><br />
*'''Show welcome screen:''' If turned off, the welcome text message will not be displayed anymore at the beginning of the questionnaire;<br />
<br />
<!--T:94--><br />
*'''Allow backward navigation:''' If enabled, it will allow the users to navigate backwards and change his or her previous answers; <br />
<br />
<!--T:95--><br />
*'''Show on-screen keyboard:''' If turned on, an on-screen keyboard will show up when answering questions that require typing in information; <br />
<br />
<!--T:96--><br />
*'''Show progress bar:''' It shows to the survey participant a progress bar that emphasizes how much of the survey is filled out and how much is left to be completed;<br />
<br />
<!--T:97--><br />
*'''Participants may print answers:''' If turned on, the survey participants may choose at the end of the survey to print their answers; <br />
<br />
<!--T:98--><br />
*'''Public statistics:''' A link to a set of statistics will be shown at the end of the survey if this option is enabled;<br />
<br />
<!--T:99--><br />
*'''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 to allow the survey participants see the graphs in the public statistics;<br />
<br />
<!--T:100--><br />
*'''Automatically load URL when survey complete:''' The end URL becomes a redirect link once the survey is completed, if this option is turned on.<br />
<br />
===Publication & access control=== <!--T:101--><br />
<br />
<!--T:102--><br />
The following set of options is available under this tab:<br />
<br />
<br />
<!--T:103--><br />
<center>[[File:Publication & access control.png]]</center><br />
<br />
<br />
<!--T:104--><br />
*'''Start date/time:''' The date/time the survey starts;<br />
<br />
<!--T:105--><br />
*'''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 fill out the survey on the 1st of January). To disable this, just clear the date from the input field;<br />
<br />
<!--T:106--><br />
*'''List survey publicly:''' The default value is "No". When it is set to "Yes", your survey will be listed in the "available surveys" portal where it can be seen by all [[Manage users|LimeSurvey users]];<br />
<br />
<!--T:107--><br />
*'''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;<br />
<br />
<!--T:108--><br />
*'''Use CAPTCHA for survey access:''' In order to access the survey, a CAPTCHA code has be typed in by the survey participant;<br />
<br />
<!--T:109--><br />
*'''Use CAPTCHA for registration:''' In order to register for the survey, a CAPTCHA code has be typed in by the survey participant;<br />
<br />
<!--T:110--><br />
*'''Use CAPTCHA for save and load:''' Enable it if you wish a survey participant to type in a CAPTCHA code when he or she loads again the survey after only a part of it was completed.<br />
<br />
===Notification & data management=== <!--T:111--><br />
<br />
<!--T:112--><br />
The following options are available:<br />
<br />
<br />
<!--T:113--><br />
<center>[[File:Create a new survey - Notification & data management.png]]</center><br />
<br />
<br />
<!--T:114--><br />
*'''Date stamp:''' Turn it on if you would like to see the time when the answers were submitted; <br />
<br />
<!--T:115--><br />
*'''Save IP address:''' If turned yes, the IP address of the survey respondent will be stored together with his or her answers; <br />
<br />
<!--T:116--><br />
*'''Save referrer URL:''' If turned yes, the referrer URL will be stored together with the answers;<br />
<br />
<!--T:117--><br />
*'''Save timings:''' If enabled, the time spent on each page of the survey by each survey participant is recorded; <br />
<br />
<!--T:118--><br />
*'''Enable assessment mode:''' You can enable/disable assessments for this survey with this setting;<br />
<br />
<!--T:119--><br />
*'''Participant may save and resume later:''' This setting allows a participant to save his responses and resume to answer the survey questions at a later time. Please note that this makes most sense with open surveys or surveys with anonymized answer. If you are using [[Survey participants|tokens]] and the survey [[Participant settings|is not anonymous]], in most cases it is better to activate '''token-based response persistence''' from the [[Participant settings]] panel.<br />
<br />
<!--T:120--><br />
*'''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 (;) (e.g "yourname@test.com; myname@test.com;hisname@test.com" or (if using placeholders) "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}"). <br />
<br />
<!--T:121--><br />
{{Box|To send an email to the survey administrator, '''you must use {ADMINEMAIL}'''. <br />
<br />
<!--T:122--><br />
There are different ways for entering an address:<br />
#Enter a specific email address (ie: yourname@test.com);<br />
#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 reuse information from previous answers);<br />
#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 '''Survey participants''' table).}}<br />
<br />
<!--T:123--><br />
*'''Google Analytics settings:''' If you would like to get further details about the survey web traffic, use Google Analytics. Three options are available:<br />
**''None'' : Google Analytics will not be used;<br />
**''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:<br />
***Do not use Google Analytics - so {GOOGLE_ANALYTICS_JAVASCRIPT} is an empty string;<br />
***Default Google Analytics - {GOOGLE_ANALYTICS_JAVASCRIPT} uses the standard Google Analytics code, inserting the proper Google Analytics Key;<br />
***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.<br />
**''Use global settings'' : If picked up, the survey will use the same Google Analytics Tracking ID as the one saved in the [[Global settings#General|global settings]] and then you choose the desired Google Analytics style. <br />
<br />
<!--T:124--><br />
{{Box|Google Analytics Tracking ID for a specific 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}.}}<br />
{{Note|For further details on how to use Google's API with LimeSurvey, check our [[Google API howto|Google API howto page]].}}<br />
<br />
===Participant settings=== <!--T:125--><br />
<br />
<!--T:126--><br />
The following options are available:<br />
<br />
<br />
<!--T:127--><br />
<center>[[File:Create a new survey - participant settings.png]]</center><br />
<br />
<br />
<!--T:128--><br />
*'''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''';<br />
<br />
<!--T:129--><br />
*'''Anonymized responses:''' It allows you to determine whether responses to your survey are matched up with information from the '''Survey participants''' table (utilized in the respective survey) or are 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 survey administrator 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 and anonymous analyses can still be done; <br />
<br />
<!--T:130--><br />
{{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, regardless of other settings. Invalidating the submission date ensures no match with the 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.}}<br />
<br />
<!--T:131--><br />
*'''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, when 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;<br />
<br />
<!--T:132--><br />
*'''Allow multiple responses or update responses with one token:''' If this option is activated, 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 enabled, the user will update the existing responses;<br />
<br />
<!--T:133--><br />
*'''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 code allocated in the [[Survey participants|Survey participants table]]. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow visitors to register his or her name and email address. The script will create a new entry in your '''Survey participants''' 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;<br />
<br />
<!--T:134--><br />
*'''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"; <br />
{{Alert|title=Attention|text=When you switch on or off this feature, you'll have to double check that your email templates are still displayed as you want.}}<br />
<br />
<!--T:135--><br />
*'''Send confirmation emails:''' If enabled, the participant will receive a confirmation email that the survey was submitted.<br />
<br />
==Import a survey== <!--T:136--><br />
<br />
<!--T:137--><br />
If you wish to import a survey, you can do that from the "Create, import, or copy survey" screen. <br />
To get there, click the '''Create, import, or copy a survey''' button and then on the '''Import''' tab. Next, click on '''browse''' to choose the file you wish to import, and then on the '''Import survey''' button. <br />
<br />
<br />
<!--T:138--><br />
<center>[[FIle:Import a survey.png]]</center><br />
<br />
<br />
<!--T:139--><br />
The import process reads the following formats:<br />
*.[[Exporting_a_survey_structure#Export_survey_structure_.28.lss.29|LSS files]] (XML-format created by LimeSurvey 1.90 or later);<br />
*.[[Exporting_a_survey_structure#Export_survey_archive_.28.lsa.29|LSA files]] (Survey archive which may include also token, responses and timings - available since LimeSurvey 2.0);<br />
*.[[Exporting_a_survey_structure#Export_tab-separated-values_format_.28.txt.29_.28New_in_2.0_.29|TXT files]] (Text-format created by Excel - available since LimeSurvey 2.0);<br />
*.CSV files (Created by early LimeSurvey versions from 1.50 to 1.90).<br />
<br />
<!--T:140--><br />
The import function "intelligently" re-numbers the survey, groups, questions, answers, and condition IDs so that they all match each other. No existing survey is going to be overwritten during the import process.<br />
<br />
<!--T:141--><br />
By default, the resource links and expression fields are also imported. Basically, the more advanced type of questions are going to be also imported along questions that include complex branching, assessments, validation, and tailoring. <br />
<br />
<!--T:142--><br />
{{Note|For further details on LimeSurvey expression manager, read [[Expression Manager|our wiki]].}}<br />
<br />
<!--T:143--><br />
Once the import process is completed, a survey structure import summary will be displayed, showing whether it was successful or not:<br />
<br />
<br />
<!--T:144--><br />
<center>[[File:Survey structure import summary.png]]</center><br />
<br />
<br />
<!--T:145--><br />
<div class="simplebox">[[File:help.png]] If you wish to use another method, read our wiki on [[Alternatives to the LimeSurvey import function|import alternatives]] for more information.</div><br />
<br />
==Copy a survey== <!--T:146--><br />
<br />
<!--T:147--><br />
The last tab contains the copy survey functionality and its options:<br />
<br />
<br />
<!--T:148--><br />
<center>[[FIle:Copy a survey.png]]</center><br />
<br />
<br />
<!--T:149--><br />
*'''Select survey to copy''': Select from the drop-down list the survey you want to copy;<br />
<br />
<!--T:150--><br />
*'''New survey title:''' Type in the title you wish the copied survey to have;<br />
<br />
<!--T:151--><br />
*'''New survey id:''' You can complete it or let the field empty as it gets automatically assigned a survey id during the process;<br />
<br />
<!--T:152--><br />
*'''Convert resource links and expression fields:''' If you disable it, the more [[Expression Manager|advanced question types that use the expression manager]] will not be copied;<br />
<br />
<!--T:153--><br />
*'''Exclude quotas''': The [[Survey quotas|quotas]] are going to be excluded if this option is disabled;<br />
<br />
<!--T:154--><br />
*'''Exclude survey permissions:''' If enabled, no survey permissions will be copied into the new survey.<br />
<br />
<!--T:155--><br />
*'''Exclude answers:''' Exclude the already-stored answers;<br />
<br />
<!--T:156--><br />
*'''Reset conditions/relevance:''' Reset the conditions set in the original survey;<br />
<br />
<!--T:157--><br />
*'''Reset start/end date/time?:''' Reset the set start/end date/time;<br />
<br />
<!--T:158--><br />
*'''Reset response start ID?:''' Each response has a corresponding ID. If enabled, the ID of the responses will be reset. However, bear in mind that it is better not to have an id with two matching responses because it might influence the output of your survey.<br />
<br />
<!--T:159--><br />
Once you are done with the options, click on the '''Copy survey''' button located on the bottom of the page. A survey copy summary will be displayed:<br />
<br />
<br />
<!--T:160--><br />
<center>[[File:Survey copy summary.png]]</center><br />
<br />
<br />
<!--T:161--><br />
To access the copied survey, click '''Go to survey''' to be redirected to the settings of the newly added survey.<br />
<br />
==List surveys== <!--T:162--><br />
<br />
<!--T:163--><br />
To get an overview of all your surveys, click on the '''Surveys''' button located on the toolbar of LimeSurvey home page:<br />
<br />
<br />
<!--T:164--><br />
<center>[[File:List a survey.png]]</center><br />
<br />
<br />
<!--T:165--><br />
*'''Survey ID:''' When created, the survey receives a unique id that is used to make the connection between different LimeSurvey tables;<br />
<br />
<!--T:166--><br />
*'''Status:''' It can be:<br />
**''active'' - If this option is selected, all but inactive surveys are displayed; <br />
**''active and running'' - [[File:Active survey symbol.png]];<br />
**''inactive'' - [[File:Inactive survey.png]];<br />
**''active but expired'' - [[File:Expired survey icon.png]];<br />
**''active but not yet started'' - [[File:active but not yet started icon.png]];<br />
<br />
<!--T:167--><br />
*'''Title:''' The title of the survey;<br />
*'''Group:''' The survey group to which the survey belongs to;<br />
*'''Created:''' The date when the survey was created;<br />
*'''Owner:''' The name of the user that owns the survey;<br />
*'''Anonymized responses:''' It shows whether the responses are anonymized when stored into the database or not;<br />
*'''Partial:''' The number of surveys that were partially completed;<br />
*'''Full:''' The number of surveys that were fully completed by the survey participants;<br />
*'''Total:''' The number of partially and fully completed surveys;<br />
*'''Closed group:''' It can be either "Yes" (if a '''Survey participants''' table is used) or "No";<br />
<br />
<!--T:168--><br />
*'''Actions:''' The last column presents the actions that are available for each survey:<br />
** [[File:Settings - small symbol.png]] - ''General settings & text :'' You will be redirected to the '''General settings & text''' tab;<br />
** [[File:Add new quesiton small symbol.png]] - ''Add a new question :'' Used when you want to quickly add a question to the survey;<br />
** [[File:Statistics small symbol.png]] - ''Statistics :'' The survey statistics ("simple" mode) will be shown if the button is clicked.<br />
<br />
<br />
<!--T:169--><br />
<center>[[File:Search survey list.png]]</center><br />
<br />
<br />
<!--T:170--><br />
If you want to look for a specific survey, use the search bar and filter the results via the survey status field ("active", "active and running inactive", "inactive", "active but expired", and "active but not yet started").<br />
<br />
==Delete a survey== <!--T:171--><br />
<br />
<!--T:172--><br />
In order to delete a survey, you have to first access the survey list page. Then, select the survey(s) you wish to delete and click on the '''Selected survey(s)...''' button located on the bottom-left side of the page:<br />
<br />
<br />
<!--T:173--><br />
<center>[[File:Delete survey.png]]</center><br />
<br />
<br />
<!--T:174--><br />
When you click '''Delete''', a confirmation window will pop up in order to confirm your action. <br />
<br />
==Export a survey== <!--T:175--><br />
<br />
<!--T:176--><br />
If you want to export a survey, you have to access the survey list table and select the survey(s) you wish to export:<br />
<br />
<br />
<!--T:177--><br />
<center>[[File:Export_survey_simple.png]]</center><br />
<br />
<br />
<!--T:178--><br />
The following options are available:<br />
*[[Exporting_a_survey_structure#Export_survey_archive_.28.lsa.29|Survey archive (*.lsa)]];<br />
*[[Exporting_a_survey_structure#Export_survey_structure_.28.lss.29|Survey structure (*.lss)]];<br />
*Printable survey (*.html): if you would like to export the survey in a printable format in order to be filled out "offline".<br />
<br />
<!--T:179--><br />
For more details, check our [[Exporting a survey structure|wiki section on how to export a survey structure]].<br />
<br />
=Survey groups= <!--T:180--><br />
<br />
<!--T:181--><br />
<div class="simplebox">The survey group functionality has been added once with the launch of LimeSurvey 3. More survey group features will be added in time. If you wish to help, join us on [irc://irc.freenode.net/limesurvey IRC] and give us a hand with [https://github.com/LimeSurvey/LimeSurvey the code] or else [https://www.limesurvey.org/component/nbill?action=orders&task=order&cid=2 donate] to help the core LimeSurvey development group.</div><br />
<br />
<!--T:182--><br />
In order to access the survey group functionalities, click on the '''Surveys''' button located on the main toolbar of the LimeSurvey home page. Then, access '''Survey groups''':<br />
<br />
<br />
<!--T:183--><br />
<center>[[File:Survey groups list.png]]</center><br />
<br />
<br />
<!--T:184--><br />
A survey groups list will be displayed.<br />
On this page you can:<br />
*[[Surveys - introduction#Create a survey group|Create a survey group]] - located above the survey groups table;<br />
*[[Surveys - introduction#Edit survey group|Edit a survey group]] - located on the last column (the green pencil icon);<br />
*[[Surveys - introduction#Delete a survey group|Delete a survey group]] - located on the last column (the red trash icon).<br />
<br />
==Create a survey group== <!--T:185--><br />
<br />
<!--T:186--><br />
To add a new survey group, click on the '''Create a new survey group''' button located above the survey groups list. The following columns have to be filled in:<br />
<br />
<!--T:187--><br />
*'''Name:''' Type in the name of the survey group;<br />
*'''Title:''' Type in the title of the survey group;<br />
*'''Description:''' Type in a short description of the survey group;<br />
*'''Order:''' Helps you organize the order of the survey groups within a parent group; <br />
*'''Parent:''' Choose the survey group that will be the parent survey group. The parent group option is used to ease the edit of template-related options of a high number of survey groups via a few clicks.<br />
<br />
<br />
To add surveys to the group you will need to visit the '''"General settings"''' tab inside a survey and under '''"Group"''' select the survey group.<br />
==Edit survey group== <!--T:188--><br />
<br />
<!--T:189--><br />
The following options of a survey group can be edited:<br />
<br />
<!--T:190--><br />
*[[Surveys - introduction#Surveys in this group|Surveys in this group]];<br />
*[[Surveys - introduction#Settings for this survey group|Settings for this survey group]];<br />
*[[Surveys - introduction#Template options for this survey group|Template options for this survey group]]{{NewIn|3.0}}.<br />
<br />
===Surveys in this group=== <!--T:191--><br />
<br />
<!--T:192--><br />
If you click on the first tab, all the surveys from the respective group will be displayed.<br />
<br />
<br />
<!--T:193--><br />
<center>[[File:List LimeSurvey groups.png]]</center><br />
<br />
<br />
<!--T:194--><br />
This works as a filtering function, filtering out all the surveys not listed in the chosen survey group. You can now select the desired survey and start editing it. To see which survey-editing functionalities are available, check the [[Surveys - introduction#List surveys|list surveys]] section.<br />
<br />
<br />
===Settings for this survey group=== <!--T:195--><br />
<br />
<br />
<!--T:196--><br />
The following fields can be edited from the '''Settings for this Surveygroup''' tab:<br />
<br />
<br />
<!--T:197--><br />
<center>[[File:Edit Survey Group.png]]</center><br />
<br />
<br />
<!--T:198--><br />
*'''Title:''' Type in the title of the survey group;<br />
*'''Description:''' Type in a short description of the survey group;<br />
*'''Order:''' Helps you organize the order of the survey groups within a parent group;<br />
*'''Parent:''' Choose 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 via a few clicks.<br />
<br />
===Template options for this survey group=== <!--T:199--><br />
<br />
<!--T:200--><br />
The template options functionalities are present in LimeSurvey 3.0+. It offers a set of various options that allows you to quickly and easily change the templates-related settings of the surveys that belong to the same survey group:<br />
<br />
<br />
<!--T:201--><br />
<center>[[File:Template options for survey groups.png]]</center><br />
<br />
<br />
<!--T:202--><br />
The '''Inherit everything''' functionality lets you decide whether you want the survey group to inherit everything or not from the parent survey group theme. <br />
If you do not want this to happen, select "No". The following options will show up which will allow you to choose what should be inherited from the parent survey group theme:<br />
<br />
<br />
<!--T:203--><br />
<center>[[File:Not inheriting everything survey group.png]]</center><br />
<br />
<br />
<!--T:204--><br />
Below, you will see that you can choose a bootswatch theme for your survey group. Bootswatch themes can be used to quickly edit your templates. Basically, bootswatch is a collection of themed swatches which can be [https://bootswatch.com/ 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.<br />
{{Box|Bootstrap is a free and open-source front-end web framework for designing websites and web applications. For more details, check [https://en.wikipedia.org/wiki/Bootstrap_(front-end_framework) the following wiki].}}<br />
{{Box|Bootswatch enables users to easily try new looks without investing too much time or energy. For more information on bootswatch themes, check [https://bootswatch.com/ the following link].}}<br />
<br />
<!--T:205--><br />
If you want to tweak more a survey group template options, click on the '''advanced option''' tab (recommended for advanced users):<br />
<br />
<br />
<!--T:206--><br />
<center>[[File:Advanced options survey group templates.png]]</center><br />
<br />
==Delete a survey group== <!--T:207--><br />
<br />
<!--T:208--><br />
To delete a survey group, select the survey group you wish to remove and click on the red trash button located in the last column. Then, confirm the deletion.<br />
<br />
<br />
</translate></div>Markusd1984https://manual.limesurvey.org/index.php?title=Custom_Admin_Themes&diff=130588Custom Admin Themes2018-11-19T12:35:03Z<p>Markusd1984: added steps for 3.0 and highlight editing AdminTheme.php</p>
<hr />
<div>__TOC__<br />
<br />
=LimeSurvey Version 2.06=<br />
<br />
==Creating a new theme== <br />
*In '''''/yourLimeSurveyDirectory/styles/''''', copy and rename one of the core admin theme directories<br />
*In [[Global_settings#General|Global settings --> General]], activate the new theme<br />
==Insert a JavaScript file into a custom theme== <br />
See [[Workarounds:_Further_solutions_provided_by_LimeSurvey_users#Insert_a_JavaScript_file_into_a_custom_admin_theme_.28LimeSurvey_2.06.29|the workaround here]].<br />
<br />
=LimeSurvey Version 2.5=<br />
<br />
==Creating a new theme== <br />
*Copy one of the themes from '''''/yourLimeSurveyDirectory/styles''''' to '''''/yourLimeSurveyDirectory/upload/admintheme/''''' and rename it (let's say "''''yourTheme''''")<br />
*Modify '''''/yourLimeSurveyDirectory/upload/admintheme/yourTheme/config.xml''''' to change the name, description and any other items in the <span style="color: red; font-weight:bold;"><metadatas></span> tag you see fit<br />
*In [[Global_settings#General|Global settings --> General]], activate the new theme<br />
==Insert a JavaScript file into a custom theme== <br />
*Add a custom.js file to '''''/yourLimeSurveyDirectory/upload/admintheme/yourTheme/scripts/'''''<br />
*Modify the <span style="color: red; font-weight:bold;"><js></span> tag in '''''/upload/admintheme/yourTheme/config.xml''''' to include the new file so it would end up looking something like this:<br />
<syntaxhighlight lang="xml" enclose="div"><br />
<br />
<js><br />
<filename>notify.js</filename><br />
<filename>save.js</filename><br />
<filename>panelclickable.js</filename><br />
<filename>panelsanimation.js</filename><br />
<filename>sidemenu.js</filename><br />
<filename>bootstrap-switch.min.js</filename><br />
<filename>jquery.jcarousel.min.js</filename><br />
<filename>jcarousel.responsive.js</filename><br />
<filename>custom.js</filename><br />
</js></syntaxhighlight><br />
<br />
=LimeSurvey Version 3.0+=<br />
<br />
==Creating a new theme== <br />
*Same procedure as in 2.5 to copy a theme folder, rename and modify the config.xml<br />
*Add the new admin theme name in '''/application/models/AdminTheme.php'''<br />
*'''Clear the cache''' in the Global Settings > General tab /surveys/index.php/admin/globalsettings#general</div>Markusd1984https://manual.limesurvey.org/index.php?title=Manage_users&diff=129301Manage users2018-11-07T14:19:10Z<p>Markusd1984: </p>
<hr />
<div><languages /><br />
<translate><br />
<!--T:1--><br />
__TOC__<br />
<br />
= User management= <!--T:2--><br />
<br />
<!--T:76--><br />
The user management tool allows you to add additional administration users to LimeSurvey. We will just call them 'users' in this chapter. Do not confuse them with [[Survey participants|survey participants]] (respondents).<br />
<br />
<br />
==Create users== <!--T:3--><br />
<br />
<!--T:4--><br />
To create a new user, open the user management dialog by clicking on '''Configuration''' (located on the main LimeSurvey toolbar) -> '''Manage survey administrators''' as shown below.<br />
<br />
<br />
<!--T:61--><br />
<center>[[File:LimeSurveyBenuzerVerwaltung.jpg]]</center><br />
<br />
<br />
<!--T:77--><br />
Then, click on '''Add user''' located in the upper right area of '''User control''' table. A window will show up asking you to:<br />
<br />
<!--T:5--><br />
* Enter the desired username into the '''Username''' text field.<br />
* Enter the email address into the '''Email''' text field. Please note that:<br />
** LimeSurvey sends out a confirmation email to the address entered into the '''Email''' field. This email address will be used as the standard contact email address for surveys created by the respective user.<br />
** If you don't want the user to receive the confirmation email with a link to the LimeSurvey application, username, and password, you can use your own email address to send the confirmation email to you. After that, you can change the email address to the address of the user.<br />
* Enter user's full name into the '''Full name''' text field. Please note that the full name entered here will be used as the standard contact person name for surveys created by the respective user.<br />
* Click '''Save''' to create the new user.<br />
<br />
<br />
<!--T:78--><br />
<center>[[File:LimeSurveyAddUser.jpg]]</center><br />
<br />
<br />
<!--T:6--><br />
You have now created your first user. To find out more about [[Manage users#Set global permissions for a user|setting user permissions]], please read on.<br />
<br />
<br />
<!--T:79--><br />
<center>[[File:LimeSurveyBleistiftSymbol.jpg]]</center><br />
<br />
<br />
<!--T:80--><br />
As you can see below, there are four options under the '''Action''' column that allow you to:<br />
<br />
<br />
<!--T:93--><br />
<center>[[File:Edit users.png]]</center><br />
<br />
<br />
<!--T:81--><br />
*edit the general aspects of a user - by clicking the pen symbol.<br />
*delete the user from the survey administrators database - by clicking the wastebin button.<br />
*set global permissions for a user - by clicking the lock symbol.<br />
*set theme permissions for a user - by clicking the pen-and-lock symbol.<br />
<br />
==Edit user== <!--T:7--><br />
<br />
<!--T:8--><br />
You can use the pen symbol to edit a user. <br />
<br />
<!--T:9--><br />
You can set a new email address, full name, and even change his or her password. If you have finished what you want to do, click on the '''Save''' button (right upper part of the window).<br />
<br />
<br />
==Delete user== <!--T:82--> <br />
<br />
<!--T:11--><br />
To delete a user account, simply click on his or her corresponding wastebin button (located on the same line as the user account you want to delete) and click '''OK'''.<br />
<br />
==Set global permissions for a user== <!--T:14--><br />
<br />
<!--T:83--><br />
{{Alert|Global permissions apply to the whole LimeSurvey application. If you want to set permissions only for a specific survey, you can use the [[Manage users#Setting permissions for a single survey|survey permissions settings]].}}<br />
<br />
<!--T:15--><br />
To set global permissions for a user, click on the lock symbol.<br />
<br />
<br />
<!--T:16--><br />
<center>[[File:User_global_permission.png]]</center><br />
<br />
<br />
<!--T:65--><br />
The CRUD (create, read, update, and delete) system is employed (like in the [[Manage users#Setting permissions for a single survey|survey permission settings]]). To fine-tune user permissions, we strongly recommend to extend the matrix using the double-right arrowhead, which is located in its upper right corner. If you check the first box, all the CRUD permissions in that row are automatically checked. <br />
<br />
<!--T:63--><br />
<center>[[File:User_global_permission_complete.png]]</center><br />
<br />
<!--T:17--><br />
You can now add or remove the following permissions:<br />
<br />
<!--T:73--><br />
* '''Participant panel''': For more details, continue reading about the [[Central Participant Database|central participant database here]].<br />
<br />
<!--T:72--><br />
* '''Label sets''': Permission to create, view, update, delete, export, and import label sets. The label sets don't have specific permissions (unlike themes).<br />
<br />
<!--T:68--><br />
* '''Settings & Plugins''': With this permission a user can check data integrity, save the SQL database to an .sql file, manage global settings, view the PHP info in the global settings, and manage all plugins.<br />
<br />
<!--T:67--><br />
* '''Surveys''': Gives access to all surveys. To allow a user to only create and manage their own survey, give the user the 'create' permission. A creator of a survey is the owner of the survey and will always be able to manage it. Remember that each survey can grant different permissions . <br />
{{Note|'''The global permission is applied before the survey-specific permission!'''}}<br />
<br />
<!--T:71--><br />
* '''Themes''': It allows the user to use all the available design themes and edit all non-standard themes. A person with this right should have sufficient knowledge in terms of HTML, Javascript, and CSS. If a user is not familiar with these things and is supposed to use a specific design themes, it would be better to only give him 'read' permission. Each theme can have specific permissions.<br />
<br />
<!--T:70--><br />
* '''User groups''': This permission allows a user to create/view/update/delete user groups.<br />
<br />
<!--T:69--><br />
* '''Users''': A user can create, modify, and delete his own administration users with this permission. The newly created users cannot have higher permissions than the parent user. You will also not be able to edit users owned by other administration users. If this has to be done, then a Superadministrator permission has to be granted.<br />
<br />
<!--T:66--><br />
* '''Superadministrator''': This permissions can only be added by other Superadministrator with this setting as update and grants full permission to the whole LimeSurvey application.<br />
{{Alert|title=Warning|text=This permissions is very powerful and you should be very careful with granting it.}}<br />
<br />
<!--T:84--><br />
*'''Use internal database authentication''': This permission allows users to access LimeSurvey's panel via the authentication page (e.g. ''http://domain/admin/authentication/sa/login''). If it is unchecked and the respective user tries to connect to LimeSuvey's panel, he will get the following error: 'Internal database authentication method is not allowed for this user'.<br />
<br />
<!--T:95--><br />
{{Note|All the permissions mentioned above that belong to the [[Optional_settings#Security|forced super administrator]] cannot be removed via the GUI.}}<br />
<br />
<br />
==Set theme permissions for a user== <!--T:19--><br />
<br />
<!--T:20--><br />
With theme permissions, you can decide which design themes a user can select when creating or editing a survey. It might be a good idea to restrict the design themes a user can select in order to prevent unwanted use of design themes, which you might consider to not be suitable for a survey/questionnaire.<br />
<br />
<!--T:21--><br />
For example, if you have a specific design themes for a group of users or customers, you might want to restrict their access to other themes to only make them use the themes created for their purpose.<br />
<br />
<!--T:22--><br />
To set or edit the themes permissions for a user, simply click the pen-and-lock symbol for design themes:<br />
<br />
<br />
<!--T:23--><br />
<center>[[File:LimeSurveySetDesignTemplatesLS.jpg]]</center><br />
<br />
<br />
<!--T:24--><br />
Select the design themes to which the respective user or user groups should have access. After you finished your selection or deselection, do not forget to hit the '''Save''' button: [[File:Save.png|0.75px]].<br />
<br />
<!--T:25--><br />
To get a proper understanding of this function, check [[Manage users#Examples|the examples provided below]].<br />
<br />
=Use one-time passwords= <!--T:51--><br />
<br />
<!--T:52--><br />
A user can call the LimeSurvey login at /limesurvey/admin and enter a username and a one-time password (which was previously written into the users table - ''column one_time_pw'' - by an external application).<br />
<br />
<!--T:53--><br />
To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>$use_one_time_passwords = false;</code>]] has to be set 'true' in config.php (it is 'false' by default) . <br />
<br />
<!--T:54--><br />
The URL has to contain the following variables:<br />
* '''user:''' The username normally used to login into LimeSurvey. This username has to exist in the 'users' table of the database.<br />
* '''onepass:''' The plain text password which is then compared to the password in the 'users' table<br />
<br />
<!--T:55--><br />
A valid URL to login using a one-time password will look like this:<br />
<br />
<!--T:59--><br />
<div class="simplebox">http://www.yourdomain.org/limesurvey/index.php/admin/authentication/login?user=myusername&onepass=secretpassword</div><br />
<br />
<!--T:94--><br />
<div class='simplebox'> [[File:help.png]] The 'secretpassword' field is plain text, not MD5 code.</div><br />
<br />
<!--T:60--><br />
'''Things to watch out for:'''<br />
* To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>$use_one_time_passwords = false;</code>]] has to be set <code>true</code> in config.php (it is 'false' by default).<br />
* The passed username has to exist in LimeSurvey's ''users table''.<br />
* The one-time password (which can be set via an external application) has to be stored as [https://secure.php.net/manual/en/function.md5.php MD5 hash] in column ''one_time_pw'' of table ''users''.<br />
* (This should be ignored except "Both passwords have to match") The passed plain text password will be hashed using the sha256 function and will then be compared to the stored hash in column ''one_time_pw'' of table ''users''. Both passwords have to match.<br />
* After the first login with the one-time password, it gets deleted from the database. The user won't be able to log in anymore with that respective password a second time.<br />
* My local LS system can't test the permissions with different accounts (my email password does not have a way to be connected).<br />
<br />
=Set permissions for a single survey= <!--T:26--><br />
<br />
<!--T:27--><br />
These permissions only apply for a single survey. If you want to set permissions for the whole system, you can use [[Manage users#Set global permissions for a user|global permissions]].<br />
These permissions can be offered either to a single user or to a user group.<br />
<br />
<!--T:28--><br />
{{Alert|title=Attention|text=An existing user account is required to set permissions for a single survey. If the account doesn't exist, you have to create it first and then change the survey permissions. The same applies to offering survey permissions to a user group. Besides the necessity to have one created, you also need to add at least one user to that group in order to be able to select it and grant it survey permissions.<br />
<br />
Note: For users to be selectable the global setting "'''Group member can only see own group:"''' needs to be disabled as otherwise groups need to be created containing the survey creator and the members to be added.}}<br />
<br />
<!--T:30--><br />
To change the survey permissions, you have to select the '''Settings''' sidebar of your survey. Then, click on '''Survey permissions''' and choose to whom would you like to offer permissions. The rights can be offered either separately to specific users or to a user group.<br />
<br />
<br />
<!--T:31--><br />
<center>[[File:LimeSurveySurveyPermissions.jpg]]</center><br />
<br />
<br />
<!--T:85--><br />
<center>[[File:LimeSurveySurveyPermissionsRights.png]]</center><br />
<br />
<br />
==Grant survey permissions to a user== <!--T:29--><br />
<br />
<!--T:32--><br />
In the next step, select the user that will receive survey rights and click '''Add user'''.<br />
<br />
<br />
<!--T:33--><br />
<center>[[File:LimeSurveyAddSurveyPermission.jpg]]</center><br />
<br />
<br />
<!--T:34--><br />
After you click '''Set survey permissions''', the user's survey permissions matrix will be shown.<br />
<br />
<!--T:35--><br />
<center>[[File:LimeSurveyUserPermissionMatrix.jpg]]</center><br />
<br />
<!--T:36--><br />
You can set in this matrix the user's survey permissions. Checking a box grants survey permissions to the respective user. If you click on a checkbox from the first column, all the rights of the corresponding line will be selected/removed. <br />
<br />
<!--T:37--><br />
Click on the double-right arrowhead to access the extended version of the matrix to choose specifically the actions that can be performed by a user.<br />
After you finished editing the survey permissions, click on the '''Save''' button, which is located in the upper right corner of the screen.<br />
<br />
<!--T:39--><br />
Some examples are provided [[Manage_users#Examples|below]] in order to help you get a better understanding of Limesurvey's survey permissions system.<br />
<br />
==Grant survey permissions to a user group== <!--T:86--><br />
<br />
<!--T:87--><br />
Click on add a user group and select the user group to which you would like to add the permission rights.<br />
<br />
<!--T:88--><br />
<center>[[File:LimeSurveyPermissionRightsUserGroup.png]]</center><br />
<br />
<!--T:89--><br />
In the next step, select the permissions that you will allocate to the members of that user group. Do not forget to click on the double right arrowhead to get an extended view of the permissions matrix.<br />
<br />
<br />
<!--T:90--><br />
<center>[[File:UserGroupSurveyPermissions.png]]</center><br />
<br />
<br />
<!--T:38--><br />
After you finished editing the survey permissions, click on the '''Save''' button, which is located in the upper right part of the screen.<br />
<br />
<!--T:91--><br />
Some examples are provided [[Manage_users#Examples|below]] in order to help you get a better understanding of the Limesurvey's survey permissions system.<br />
<br />
<!--T:92--><br />
{{Note|[[Manage user groups|The user group function]] is still experimental. Use our [https://bugs.limesurvey.org/ bugs tracker] to describe any kind of inconsistencies.}}<br />
<br />
=Examples= <!--T:40--><br />
<br />
<!--T:41--><br />
Different scenarios are presented below. They provide some advice about which rights are necessary for some specific tasks and how they can be granted to the users.<br />
<br />
<br />
==I want to add a new person in charge for administrating LimeSurvey== <!--T:42--><br />
* Log in as '''admin'''.<br />
* Create a new user account.<br />
* Grant that user the '''Superadministrator''' permission.<br />
* ''Not necessary'' : Setting the theme permissions ('''Superadministrator''' has all permissions for all themes).<br />
* ''Not necessary'' : Setting the survey permissions ('''Superadministrator''' has all permissions for all surveys).<br />
<br />
<br />
==A new user wants to create his/her own surveys== <!--T:43--><br />
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).<br />
* Create a new user account.<br />
* Set global permissions for that user to '''Create survey'''.<br />
* ''Optional'' : Set theme permissions - select which theme(s) should be used by the user/user group.<br />
<br />
==The creator of a survey needs another person to edit his/her survey== <!--T:44--><br />
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).<br />
* Create a new user account.<br />
* Set '''no global permissions''' for user.<br />
* Set '''no theme permissions''' for user.<br />
* Set the survey permissions the way you want. If he/she should receive all the survey permissions, you can check the first box from each row. Otherwise, click on the double-right arrowhead to see the expanded matrix (upper right corner) and select only those rights you believe the respective user should have.<br />
<br />
<br />
==A person responsible for the survey wants to see the results of the survey and export them== <!--T:45--><br />
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).<br />
* Create a new user account.<br />
* Set '''no global permissions''' for user.<br />
* Set '''no theme permissions''' for user.<br />
* Set survey permissions to: '''Responses''' -> '''View/read''' and '''export''', and '''Statistics''': '''View/read'''.<br />
<br />
<br />
<!--T:46--><br />
<center>[[File:LimeSurveyCusomerOwnStatistics.jpg]]</center><br />
<br />
==I need help from two interns that can help me with the translation of my survey== <!--T:47--><br />
* Log in as ''admin'' (or as a user that has the ''Superadministrator'' permission).<br />
* Create ''n'' user accounts (where n is the number of translators).<br />
* Create a user group called ''Translators'' and add the ''n'' accounts to this group.<br />
* Go to the '''Survey permissions''' and click on '''Add a user group'''.<br />
* If they only do translations, then offer them the '''Quick translation''' permission.<br />
<br />
<!--T:49--><br />
{{Note|Check our [[LimeSurvey Users|wiki section on users]] and their classification as it can be found in the code and documentation.}}<br />
</translate></div>Markusd1984