LimeSurvey Manual - User contributions [en]

Setting conditions

2011-11-17T16:54:07Z

Bobc55:

__TOC__

=Overview of Conditions in LimeSurvey=

LimeSurvey has a very powerful logical branching feature. [[File:conditions_icon.png]]

In this chapter we will describe:
* what conditions are in LimeSurvey
* what you can and can't do with conditions
* what steps you need to learn to setup simple or more complex conditions

For step-by-step video instructions check out [http://video.aol.co.uk/video-detail/conditions-in-limesurvey/838332261 this tutorial] or download the condition sample survey: [[Media:Limesurvey_sample_survey_Conditions.lss|Limesurvey_sample_survey_Conditions.lss]].

==Hide/Show Branching Versus Jump Branching==

You can design logical branching with LimeSurvey, this means that you can decide that some questions will be displayed only if some conditions are met like "Show question X if question Y was answered 'Z'".

Our approach is to implement a '''Hide/Show Branching Logic''':
* you can define a condition or a set of conditions on each question of your survey: if the condition is met, the question will be displayed

Simply put:
* a question without a condition defined on it will always be displayed
* a question with a condition defined on it will not be displayed unless the condition is met

This approach is different from the '''Jump Branching Logic''' that is sometimes implemented by other software. In the '''Jump Branching Logic''', the resulting action of a met condition would be to jump to another question (that is to say hide all questions in between). '''Limesurvey doesn't implement this Jump Branching Logic''' method. Instead if you wish to jump a series of questions, you would simply set the same condition on all the questions you do not wish displayed. For example if the jump condition you want to set on Question2 is "Jump to Question5 if the answer to Question1 is 'Yes'", you can simply:
*set a condition on questions 2, 3 and 4 to only display "if the answer to Question1 was NOT 'Yes'"

[[File:simple-condition-on-yes-question.png]]
* LimeSurvey makes setting the same condition on multiple questions (and thus implementing '''Jump Branching Logic''') easy by allowing you to "copy" a condition from one question to a series of others. In the above example you would begin by setting the condition on Question2, then from the same screen you would copy that condition to Question3 and Question4.

==Supported Types of Conditions==

Basically, a condition can compare values and returns true or false.

Values that can be compared are:
* '''answers to previous questions'''
** for instance: "IF you answered 'Yes' to Question1"

[[File:simple-condition-on-F-question.png]]

It is important at this point to understand what is considered as an eligible question-entry for the condition editor:

A ''question-entry'' is either:
* a simple question (for all question types apart from Array questions)
** for instance: text questions, radio or dropdown lists, and even multiple choices questions
* or a row in Array questions (except for Array dual scale and Array Multiple Flexible questions),
** for instance: Array of 5 radio buttons, array with label questions
* or either the left part or the right part of an Array dual scale question
* or each cell of an Array Flexible question

As a matter of simplification, ''question-entries'' are just called "Question" in this document and the condition editor.
* '''constant values'''
** for instance: "IF you answered more than 3 days to Question2"

[[File:simple-condition-on-numerical-question.png]]
* '''Participant's profile data''' To use '''Token attributes''', "Anonymized responses" must be set to NO. This option can be found in General Settings -> Tokens tab.

[[File:simple-condition-on-token.png]]

Several comparison operators are supported from the simple "equals", to the advanced "Regular Expression":
* The basic ones are equality, and inequality
* The greater/less than operator family is also available, and is usually only useful when using numeric question-entries
** Please note that comparisons on numeric fields honor the numeric order: for instance 2 < 10
** If you're using a question entry whose type is text, then the condition could be evaluated as "2" > "10" (string order)!
** Numeric questions, as well as text questions (when they have the 'numbers_only' attribute set), will use the numeric order for comparisons
* An advanced comparison operator using regular expressions is also available.
* The "Regular Expression" operator (don't panic: If you don't know what this means, then you don't need it)
** the pattern is '''not''' to be enclosed in '/' characters
** for instance <div class="simplebox">[a-zA-Z]$

==How can I combine conditions==

[[File:simple-conditions-combination.png]]

You can '''build complex conditions''' by '''combining simple conditions''' with the '''AND '''and '''OR '''logical operators.

However, it is important to understand that '''LimeSurvey automatically determines which logical operator to apply''': this means that the use of the '''OR '''or '''AND '''operators is determined '''according to the context''' of the condition.

We'll talk about complex conditions later, but let's start by the simple ones first.

=Understanding Simple conditions: elementary conditions=

==Accessing the editor screen==

First you need to access the condition editor:
* open the condition menu by clicking on the ''conditions icon'' [[File:conditions.png]] in the question button bar, when viewing a question.
* then click on the ''Set Conditions icon'' [[File:conditions_add.png]] , the edit conditions screen will appear allowing you to create, edit or delete conditions for the current question.

The following screen will appear:

[[File:edit-conditions-EditorView.png]]

Note: for the moment '''don't modify the default scenario''' ([[File:default_scenario.png]]) that is automatically selected in the condition addition form: we'll discuss this later.

==Definition of elementary conditions==

An elementary condition is simply a single condition '''without any OR or AND''' logical operators.

It is composed by:
* a left operand: the ''tested value''
** you can choose the ''tested value'' type by selecting the appropriate tab in the condition editor

[[File:edit-conditions-testedvalueTab.png]]
* a ''comparison operator''
** Choose the ''comparison operator'' you want to apply in the dropdown list

[[File:conditions-operators.png]]
* a right operand: the ''comparison value''
** you can choose the ''comparison value'' type by selecting the appropriate tab in the condition editor

[[File:edit-conditions-comparisonvalueTab.png]]

==Example of elementary conditions and how to create them==
* Show question IF "the answer to Question1 was the predefined answer 'Male'"
** ''tested value'' = answer to Question1
** ''comparison operator'' = equals
** ''comparison value'' = answer code of the 'Male' answer

[[File:edit-simple-condition-predefanswer.png]]
* Show question IF "the answer to Question2 was greater than the numerical value '5'"
** ''tested value''= answer to Question2
** ''comparison operator''= greater than
** ''comparison value''= the constant value 5

[[File:edit-simple-condition-constant.png]]

</div>'''Caution''': When using a constant 'comparison value' for a date question, you must enter the value with the YYY-MM-DD format, whatever the date format is set for current survey.<div class="simplebox">
* Show question IF "the answer to Question3 was greater than the answer to Question2"
** ''tested value''= answer to Question3
** ''comparison operator''= greater than
** ''comparison value''= answer to Question2

[[File:edit-simple-condition-prevQuestion.png]]
* Show question IF "the 'Department' value from the participant's profile (Token Attribute from the invitation) equals the 'Accounting' string"
** ''tested value''= the 'Department' value taken from the token invitation
** ''comparison operator''= equals
** ''comparison value''= the constant value 'Accounting'

[[File:edit-simple-condition-leftToken.png]]

=Default condition combinations=

As said earlier, LimeSurvey automatically decides which logical operator (AND or OR) should be applied between conditions depending on the 'context'.

Note also that '''the order in which you define your elementary conditions is not relevant''' as LimeSurvey will automatically reorder them according to its own logic.

Let's study this in detail.

==First rule: conditions having the same ''tested value'' are ORed together==

When you have several conditions they are '''ORed''' together if they share the same '''tested value'''
* this is the case for instance for several possible answers of the same previous questions: "If answer to Question1 equals 'green' '''OR''' answer to Question1 equals 'red' '''OR''' answer to Question1 equals 'blue'"

[[File:edit-conditions-naturalOr-edit.png]][[File:edit-conditions-naturalOr-result.png]]

==Second rule: conditions having different ''tested value'' are ANDed together==

When you have several conditions, they are '''ANDed''' together if they don't share the same '''tested values'''
* this is the case for instance for several conditions based on different answers from previous questions: "If answer to Question1 equals '4' '''AND''' answer to Question2 equals 'green'"

[[File:edit-conditions-naturalAND-editA.png]] [[File:edit-conditions-naturalAND-editB.png]] [[File:edit-conditions-naturalAND-result.png]]

==Third rule: ORed elementary conditions take precedence over the other ANDed conditions==

Imagine you define the 3 following sets of conditions:
*IF answer to Question "Type !" was 'Green'
*IF answer to question "Type 5" was '4'
*IF answer to question "Type A" was '4' or '5'

[[File:edit-conditions-naturalAND-editA.png]][[File:edit-conditions-naturalAND-editB.png]][[File:edit-conditions-naturalANDandOR-editC.png]]
* Then the resulting conditions will be:

[[File:edit-conditions-naturalANDandOR-result.png]]
**Note the '''capital 'OR'''' and the '''lower case 'and'''': this means that ORed conditions are evaluated as if prioritized with parentheses
**Note also that the order of the elementary conditions creation is not preserved and has no importance here
** The resulting conditions is: IF (answer to question "Type A" was '4' '''OR '''answer to question "Type A" was '4') '''AND '''(IF answer to question "Type 5" was '4') '''AND '''(IF answer to Question "Type !" was 'Green')

==The multiple options questions==

Note: This paragraph applies to ''Multiple options'' and ''Multiple options with comments'' questions, and not to ''Array Multiple Flexible (number) with checkbox layout'' questions (for this later question type, each checkbox is a separate question-entry and is not really handled as other multiple options question-types).

[[File:edit-conditions-MultipleOptions1.png]]

For ''Multiple options'' and ''Multiple options with comments'' questions, in the ''tested value''part of the condition editor this question will appear in two flavors
* a ''Group of checkboxes'' flavor which let you set conditions on all possible answers of this question
* a set of ''Single checkbox'' entries which let you set conditions on each checkbox individually

And now let's test your knowledge of conditions by trying to answer this question:
* I've got a multiple options question:
** Issue A: How can I set ORed conditions between different answers of this question
** Issue B: How can I set ANDed conditions between different answers of this question

...

...

...

Now the answers...

For Issue A:
* Use the ''Group of checkboxes'' entry as your ''tested value'' and select as much answers you want

[[File:edit-conditions-MultipleOptionsOR.png]][[File:edit-conditions-MultipleOptionsOR-result.png]]

For Issue B:
* Use the ''Single checkbox'' entry that correspond to the first answer you need to set the condition on and set the condition to the ''checked'' ''comparison value''

[[File:edit-conditions-MultipleOptionsAND1.png]]
* Use the ''Single checkbox'' entry that correspond to the second answer you need to set the condition on and set the condition to the ''checked'' ''comparison value''

[[File:edit-conditions-MultipleOptionsAND2.png]]
* Enjoy the result:

[[File:edit-conditions-MultipleOptionsAND-result.png]]

=Using ORed conditions between different questions: the use of scenario=

Now, you may argue that sometimes you need to have '''ORed''' conditions even when they are set on different questions (that is to say on different '''tested values'''): this is where scenarios can be used.

[[File:multi_scenario.png]]

==Definition of a scenario==

A scenario is simply '''a manual grouping of conditions''' in which conditions are evaluated independently of conditions from other scenarios. The complex condition resulting in this association of several scenarios will be met if only one scenario is met: in other words scenarios are '''logical grouping of conditions''', respecting the above rules, and '''which are ORed together''' to build complex conditions.

All what we described above is true inside a scenario, and by default all new conditions are created inside the "Default Scenario".

However, when you create a new elementary condition, you decide to affect it to another scenario than the default one.

Scenarios are identified by a simple number, the "Default scenario" having number '1' as its identifier.

==Adding a question to another scenario==

When you create (or edit) a condition, you can modify the scenario in which the condition is stored:

[[File:edit-conditions-EditorView-Scenario.png]]

If you need to define a condition in another scenario than the default one, click the new scenario icon [[File:plus.png]], and type in the scenario number: [[File:default_scenario_edit.png]]

The number id of a scenario has no importance and different scenarios can have non-continuous ids.

[[File:edit-conditions-EditorView-Scenario2.png]]

=Using the editor=

==Editor overview==

First you access the condition editor:
* open the condition menu by clicking on the ''conditions icon'' [[File:conditions.png]] in the question button bar, when viewing a question.

The top part of the window always shows any conditions already set for this question:

[[File:existing_conditions.png]]

In the example above question B is set to only display if:
* The answer to the question-entry FBI of previous question A is "1"
* AND
** EITHER the answer to the question-entry CIA of previous question A is "5"
** OR the answer to the question-entry CIA of previous question A is "3"

In Add/Edit mode [[File:conditions_add.png]], some specific actions are possible on each line such as:
* edit condition [[File:conditions_edit.png]]
* delete all conditions [[File:conditions_deleteall.png]], delete this condition [[File:conditions_delete.png]], delete all conditions from this scenario [[File:scenario_delete.png]]
* edit scenario [[File:scenario_edit.png]]

[[File:edit-conditions-EditModeButtons.png]]

In Copy mode [[File:conditions_copy.png]], each line is prepended with a checkbox allowing you to select those conditions you want to copy to later questions:

[[File:copying_conditions.png]]

==Setting new conditions==

===First select the scenario===

'''If you don't need ORed conditions''' between different question-entries, '''just don't modify the default scenario''' ([[File:default_scenario.png]]) that is automatically selected in the condition edition form.

On the contrary, if you need to define a condition in another scenario than the default one, click the new scenario icon [[File:plus.png]], and type in the scenario number: [[File:default_scenario_edit.png]]

The number id of a scenario has no importance and different scenarios can have non-continuous ids.

===Select the ''tested value''===

Click on the tab corresponding to the type of the ''tested value'' you want: it is either a previous question or a value taken from the profile of the participant (token attribute).

Note that i'''n order to use the ''Token''''' your survey must:
* '''not use anonymous answers'''
* '''use a token table''' and closed access

Then select the entry you want as ''tested value''.

If you select a question-entry (from the 'Previous questions' tab) and if this question uses predefined answers then the corresponding predefined answers are displayed in the ''Predefined'' tab of the ''comparison value'' selection.

===Select the comparison operator===

[[File:comparison_operators_conditions.png]]

Several comparison operators can be used:
* The basic ones are equality, and inequality
* The greater/less than operator family is also available, and is usually only useful when using numeric question-entries
** Please note that comparisons on numeric fields honor the numeric order: for instance 2 < 10
** If you're using a question entry whose type is text, then the condition could be evaluated as "2" > "10" (string order).
** Numeric questions, as well as text questions having the 'numbers_only' attribute set, will use the numeric order for comparisons
* An advanced comparison operator using regular expressions is also available. When selected, the answer input box will automatically switch to the advanced mode.

===Selecting an ''comparison value''===

Select the tab that corresponds to the type of ''comparison value'' you need: it can be a predefined answers, a constant value, an answer from a previous question, a value from a token attribute, or a regular expression (reserved for the advanced regular expression operator).

Then select or type in the value you want to use.

Note that if you select a value in a tab, then change the tab and select another value in this other tab, the first option you selected is lost.

When using ''predefined answers'', you can then select one or more predefined answers:
* the possible answers for that question
** Choose the answer that you want to use
** You can choose multiple answers in one go by using the CTRL button and clicking on more than one answer in the right hand select list

After that click on the "Add Condition" button.

==Editing/Deleting conditions==

Apart from adding new conditions, the Add/Edit can be used to
* edit conditions
* delete conditions
* edit scenario

===Edit conditions===

By clicking on the edit icon [[File:conditions_edit.png]] on a condition line, the edit condition form at the bottom is automatically displayed with the current settings for this condition. Note that in this mode you can only select one predefined answer.

Click the update condition button to update this condition.

===Delete conditions===

You can:
* delete a single condition by clicking on this icon [[File:conditions_delete.png]]
* delete all conditions within a scenario by clicking on this icon [[File:scenario_delete.png]]
* delete all conditions from this question by clicking on this icon [[File:conditions_deleteall.png]]

===Edit Scenario===

You can change the number assigned to a scenario by clicking this Icon [[File:scenario_edit.png]] and fill-in the form that appears on the same line.

[[File:edit_scenario_conditions.png]]

Alternatively, you can renumber scenarios by clicking on this icon [[File:scenario_renumber.png]].

As said above, scenario numbers have no impact in the way conditions are evaluated. However, modifying the scenario numbers are needed in order to:
* decide in which order the scenario are displayed when using the printable version of a survey
* merge conditions from 2 scenarios (in order to merge scenario 10 to scenario 1, just renumber scenario 10 with scenario id 1).

==Copying conditions to later questions==

It is not uncommon for a group of questions to have the same condition. Luckily you can copy this condition to any subsequent question from the conditions designer once a first condition has been set.

Switch to the copy mode by clicking the on the Copy conditions icon [[File:conditions_copy.png]].

[[File:copy_conditions_example.png]]

The conditions applying to the current questions are displayed with a checkbox on their left. You can:
* select each condition individually by checking the checkbox on the left of the condition
* or select all conditions from a scenario at a time by checking the checkbox on the left of the scenario

Then select all subsequent questions in the survey on which you want to copy the selected conditions from the bottom Select box by highlighting them (using the CTRL key to select multiples). Then click on the "Copy Conditions" button to copy them across.

It is usually best to leave this until you have finished entering all your survey questions, and are satisfied with the question order.

=Things to watch out for=

==General considerations==

There are a few basic rules you should keep in mind before setting conditions on a question:
*Once a single condition has been set for a question, that question '''will not display''' unless that condition is met.
*Conditions can only be set based on questions that appear '''before''' the question on which the condition is set.
*If you change the order of questions in your survey after you create conditions LimeSurvey does not warn you if the changed order will break a condition. You should always leave the creation of conditions until you are satisifed with the order of questions and groups in your survey.
*You can modify conditions even after a survey has been activated. This should be done with caution, as there is no "consistency checking" applied here.

==Conditions using the 'no answer' predefined answer==

[[File:noanswer_conditions.png]]

Setting the following condition "Show question Q20 if answer to question Q1 is 'no answer'" really means "show question Q20 if question Q1 was displayed and received no answer". This is not equivalent to "show question Q20 if question Q1 was not displayed"

==Chained conditions==

If you set conditions on a question that, itself, has conditions, then there may arise occasions where the survey behaves in ways you might not have predicted. For example a typical side-effect is that if you hide all questions in a group with chained conditions that the group header will still be shown unless you correct these conditions as explained below.

[[File:chained_conditions1.png]]

[[File:chained_conditions2_bad.png]]

In the example above a question is displayed 'Do you like being male?' which has conditions set, and which will only display if the answer to ''What is your gender?'' is ''M''. If you were to add a condition to this question requiring a specific answer from the ''Do you like being male?'' question, then this question will never display, because the question ''Do you like being male'' will not be presented.

It is highly recommended that you copy the conditions from the earlier question to the one you're editting.

For instance, you want the following:
* Q1 is a Gender question
* Q2 is a Yes/No and is displayed if answer to Q1 is Male
* Q3 is a ranking question and is displayed if Q2 is Yes

What you really need to setup is the following set of conditions:
* on Q2: display question if answer to Q1 is Yes
* on Q3: display question if answer to Q1 is Male AND answer to Q2 is Yes

After correction, the correct set of conditions for Q3 should look like:

[[File:chained_conditions2_good.png]]

So if you are designing a complicated survey with large number of conditions, make sure you test the survey for as many different combinations of results as you can think of.

==Limitations and workarounds==

===Progress-bar===

If you create a survey where many questions get skipped because of conditions, the progress bar will jump a big step forward, or the survey ends at 50%.

To avoid such behavior, the questions that could be skipped, should be arranged between the shown questions, so that only one or two questions get skipped per answer.

For Example: based on question one (yes or no question) 15 questions will be asked question 1A to 15A when the answer of question one was yes, 1B to 15B when the answer to question one was no.

If you arrange the questions in one group and arrange them like: 2A, 2B, 3A, 3B, and so on you will get a nearly correct progress bar, while arranging the questions like 2A, 3A, 4A, [...], 2B, 3B, 4B, ... you will get a progress bar from 0 to 50% or from 50% to 100%, depending on the answer to the first question.

=== Setting a constant comparison value for a "Date" Question Type===

You have to use the internal representation of Date values, which is YYYY-MM-DD to define your constant comparison value.

=== Setting conditions for "Other" Options in the Multiple Options Question Type===

In the multiple options question type, you can use the "Other" provided in the question type as a valid choice but you cannot set conditions on it. For example: Question No 1 says "Which color do your prefer to use?" Answer checkbox choices are Blue, Black and Other. If the participant chooses Blue, you can set a condition. If the participant chooses Black, you can set a different condition. However, if the participant chooses "Other" and types in something in the text box, there is NO way a condition can be set. Limesurvey does not recognize if the participant chose the "Other" condition. This is NOT a bug but a limitation.

There is no real field recorded for the 'other' checkbox for this question type. Thus, the only way to know if the user has answered the 'other' part of the question or not would be to check if the value of the text written in the other input field is empty or not.

However, due to the specific way we handle Multiple choice questions, testing the 'other' text input field has never been implemented.

As a workaround, add an explicit answer option called 'Other' and do not use the built-in 'other' option of these question types. Then add an additional short text question which will be displayed if this 'Other' checkbox was clicked.

===How to use parenthesis for the boolean expressions?===

'''''You can't!'''''

If you want to design something like:

(condition1 OR condition2) AND (condition3 OR condition4)

you'll have to set up:

(condition1 AND condition3) OR

(condition1 AND condition4) OR

(condition2 AND condition3) OR

(condition2 AND condition4)

Survey settings

2011-02-21T00:01:08Z

Bobc55:

<div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div>

__TOC__

=Overview=

To create a new survey, click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear. You can edit most of these settings later again by click the 'Edit survey settings' icon [[File:edit.png]] in the survey toolbar.

=1st Step - Creation=

All survey settings are organized in tabs. The following is a description of each tab and field.

==General==
#'''Base language''': This sets the base language for the survey. Once saved, you cannot change it later. The language-set is the base language for possible translations of the survey. That way you can have multilingual surveys. When you create a survey, you cannot add additional languages. You could only do that if you edit the survey properties again.
#'''Title''': This is the brief descriptive name of the survey (ie: "Enterprise Bargaining Survey 2003", or "Views on Ice Cream"). This title will be displayed on every page of the public survey.
#'''Description''': This allows you to enter a description of the survey. (ie: "A survey to collect your ideas on the next round of enterprise bargaining" or "A survey to find out the popularity of chocolate ice cream"). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor. By default, description is used on invitation email.
#'''Welcome''': This allows you to enter a message that will display when a participant first logs into your survey. (ie: "Thank you for taking the time to participate in this survey..") You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''End Message''': This allows you to enter a message that will display when a participant completes your survey. (ie: "Thank you for completing our survey. We will publish results soon."). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''End URL''': This URL will be presented as a link at the end of the survey, and allows you to direct your participants back to your home page (or, in fact, anywhere). The End URL has to be entered with "http://" at the beginning, eg. http://www.limesurvey.org. <br/>You can use {SAVEDID}, {TOKEN}, {SID} and {LANG} (since 1.71+) in this URL.<br/>SAVEDID is the id assigned to this particular submission, TOKEN is the token used to participate in the survey, SID is the survey ID and LANG is the language code<br/>eg. http://www.limesurvey.org/test.php?var1={SAVEDID}&var2;={TOKEN}&var3;={SID}&lang;={LANG} <br/>From version 1.82+ you can use [[URL fields]] with this field. <br/>You can also use {INSERTANS:SGQA} in this URL (since 1.82+). This allows adding the response to a specific question in the survey to the final url. This can be useful for sending a response to an external script (ie an email address collected during the survey). eg: "http://www.limesurvey.org/test.php?email={INSERTANS:1234X56X7}" <br/>You can also use a 'pass-through' fieldname and data value in the end url (versions 1.82+). In some instances you may want to pass a value to the survey at initialisation, and then have that value passed through to an external script at the end (for example a marketing firms subsid). In this case you'd start the survey with the query url "index.php?sid=12345&passthru;=subsid&subsid;=9999". In your url you would use {PASSTHRULABEL} and {PASSTHRUVALUE} to reuse these values at the end of the survey. A URL of "http://www.limesurvey.org/test.php?{PASSTHRULABEL}={PASSTHRUVALUE}" would convert to "http://www.limesurvey.org/test.php?subsid=9999" in this case.
#'''URL description''': The description for the link using the End URL.
#'''Administrator''': This is the name of the contact person who administers the survey. It will be included in emails sent out inviting participants to respond.
#'''Admin email''': This is the email address of the administrator (as above) and is used as the 'reply to:' address on any emails sent. You can also enter several email addresses separated with a semicolon - that way survey administrator notifications are sent to more than one person. (Example: "firstaddress@test.com;secondaddress@test.com")
#'''Bounce email''': This is the email address where a delivery error notification email should be sent. By default, this is the same as the administrator's email address. If you want to use a custom script to parse delivery error emails, then use a special Bounce Email address here and automatically process emails reaching this address with your script. This script could then update the Email Status field of the token line corresponding to this email address (see tokens).
#'''Fax to''': This field is used to give a fax number on the "printable survey" - ie: when you want to send someone a hard copy because they cannot use the online survey.

<div class="simplebox">'''Caution''': 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 ressources, please do so after survey creation, by editing the newly created survey.</div>

==Presentation & navigation==
#'''Format''': Choose from "One at a time", "Group at a time" or "All in one".
**'''Question by Question''': Public survey will display one question per page.
**'''Group by Group''': Public survey will display all questions in a group per page. Group at a time surveys still have a separate "welcome" page and "submit" page, like "One at a time" surveys.
**'''All in one''': Public survey will display all questions in one single page. Activated All in one surveys do not have a "welcome" page or "submit" page - the welcome message and submit button all appear on the same page.
#'''Template''': Choose from the installed templates in your system. The default template is rather dull, but functional. More information on creating your own templates is available in the LimeSurvey [[Templates / The Template Editor]] Guide.
#'''Show welcome screen''': Yes/No. If Yes, then the welcome message defined in Text Elements section will be displayed. Default is Yes.
#'''Navigation delay''': Number of seconds before Previous and Next buttons are enabled. Default 0 seconds
#'''Show <nowiki>[</nowiki><< Prev] button''': This option defaults to yes, however if you set it to "No" then users will not have the option of moving to a previous page while completing the survey.
#'''Show question index / allow jumping''': Yes/No. Default No. When Yes, an index will be displayed on the right side. Users can jump to any section in the survey.
#'''Keyboard-less operation''':
#'''Show progress bar''': Yes/No. Default Yes. Allow the administrator to turn off the Progress bar
#'''Participants may print answers?''': This option defaults to no. When it is set to yes, a participant can print a summary of responses at submit time.
#'''Public statistics''': (''since 1.80'') Yes/No. Default No. If set to "Yes" users who have submitted the survey will be presented a link to statistics of the current survey. The admin can set which questions should be included at these statistics by [[Advanced question settings|#public_statistics|applying the according question attribute]].
#'''Show graphs in public statistics''': (''since 1.80'') Determines if public statistics for this survey include graphs or only show a tabular overview. Creating graphs for huge surveys with lots of answers takes some time and server resources so this is the switch to turn them on/off (default setting: ''off'').
#'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
#'''Automatically load URL when survey complete''': Yes/No. Default No. If yes, when the survey is submitted, it will automatically redirect to the End URL. Which is defined in the Text Elements Section.
#'''Show "There are X questions in this survey"''': Yes/No. Default Yes. If Yes, the message will be displayed on the Welcome Screen. This option will not affect the print version.
#'''Show group name and/or group description''': Will control the display of Group Names and Descriptions. This option will not affect the print version. Four Options:
**'''Show Both''' - Default
**'''Show Group Names Only'''
**'''Show group description Only'''
**'''Hide Both'''
#'''Show question number and/or code''':
**'''Show Both''' - Default
**'''Show Question Number Only'''
**'''Show Question Code Only'''
**'''Hide Both'''
#'''Show "No answer"''': Yes/No. Default Yes. When Yes, the No Answer will be displayed as an answer

==Publication & access control==
#'''Only users with tokens may enter the survey''': This is pretty self-explaining. If you activate this then tokens (to access the survey) are enforced. (''Note: ''This setting was removed in version 1.87. If you create a [http://docs.limesurvey.org/tiki-index.php?page=Tokens&structure;=English+Instructions+for+LimeSurvey#How_to_activate_tokens_ token table] access to the survey will automatically be limited to users with a valid token.)
#'''Set token length to''': (''since 1.87'') Usually you don't need to change this, the default setting of 15 digits (max. supported value: 99) is fine. If changing this setting please enter a number (X) which should be greater than 5 (if the number entered is <5 it will be converted to the default value of 15). When generating tokens all tokens will use a length of X digits.
#'''Allow public registration''': If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.
# '''Start date''': Set this to some date if you want your survey to start on a certain date. The survey will start on midnight of that day and only then will people be able to answer to it. To disable this just clear the date from the input field.
#'''Expiry date''': Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this just clear the date from the input field.
#'''Set cookie to prevent repeated participation?''': If you set this to 'Yes', and your survey does not use a tokens table to control participant access, then a cookie will be saved to the client computer of each survey participant once they have submitted a survey. This cookie will stop the same user on that computer from accessing the survey more than once. There are inherent limitations in the 'security' strength of such a system, but, in general, it allows you to retain some control over multiple entries on public surveys.
#'''Use CAPTCHA for''': With this option you can decide when you want a CAPTCHA to be used. Default is to enable CAPTCHA only for the public Registration page, but you can also enable it before accessing the survey, and before Load/Saving partial answers.
#'''Use HTML format for token emails?''': When set to yes, 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 this emails. Default is Yes at survey creation. Caution, when you switch on/off this feature, you'll have to double check that your email templates are still displayed as you want.

==Notification & data management==
#'''Admin Notification''': Options to allow the administrator to be emailed when each individual survey response is saved. You can choose from:
##No email notification - Self-explanatory.
##Basic email notification - An email is sent informing the administrator that a survey response has been saved.
##Send email notification with response codes - Sends the full answers to the survey after saving.
#'''Email Responses To:''' (''since 1.87+'') This allows you to send the survey responses to additional email addresses once the survey is submitted. Multiple entries or different methods can be used by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using multiple methods: "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". There are three different methods for entering an address:
##Enter a specific ''email address'' (ie: yourname@test.com)
##Enter a ''SGQA code'' and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_previous_answers Re-use information from previous answers]
##Enter a ''Token code'' (only possible if your survey is ''not'' anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_tokens_table Re-use Information from the Tokens Table]

+It should be noted that entering an email address here will override the "Basic email notification" setting so the recipient(s) listed here and the survey admin will receive full answers.
#'''Anonymous answers?''': This allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is yes. If you choose "No" for anonymous, you must also have a tokens table for your survey when you activate it. '''''Attention:''''' If your survey is set to ''anonymous'' there is really no way to connect answers and participants. Even the admin can't link answers' data and users' data. However you will always be able to specifically view all answers entered by a certain anonymous individual participant in the survey. Thus individual, but anonymous, statistics is still possible to do.
#'''Date stamp?''': This field allows you to determine whether the survey will datestamp all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the time and date that the response was made. (See configuration settings for $timeadjust setting.)
#'''Save IP address?''': This field allows you to determine whether the survey will save an IP-address for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the ip-address of the participant.
#'''Save referring URL?''': This field allows you to determine whether the survey will save the referrer URL for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response where this URL is saved. A referrer URL is the URL from which the user was led to your survey URL.
#'''Enable token-based response persistence''': If your survey uses tokens and is not anonymous, then you may want to enable this feature. If you turn this on, then an auto-save is performed each time a participant answers a question, meaning that even if he hasn't submitted the survey and his browser crashes, he will find his survey answers still in place when returns to the survey. This can be used for designing pre-filled surveys as well (see data entry and importVV facility when not finalizing answers).
#'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.

==Import survey==

Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).

==Uploaded resources management==

This tab let you manage files (pictures, media files) that were uploaded in the HTML Editor.

You can:
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files

Important hints:
* Authorized files extensions are defined in config-defaults.php.
* Files for the survey are in the upload/surveys/<sid> subdirectory.
* Uploaded files will only been seen while browsing resources on this survey (groups, questions, answers) not in other surveys or objects (labels).
* Do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who know the URL to the file.
* You can't import a ZIP file containing subdirectories.

=2nd Step - Additional languages=

To add more language to a survey you have to create and save it - then edit it again. Now you can add and remove additional languages to the survey. If you remove a language from a survey the complete contents of that language in that survey is deleted permanently so be careful what you are doing.

By clicking on the button 'Save and continue' on the first page in the survey settings you will be taken to the language-specific page which lets you change all texts for each language like ''Survey name'', ''Welcome Text'', etc. You can also edit the date format which should be used for a certain language.

Previous [[Creating surveys - Introduction]]

Next [[Importing a survey structure]]

Survey settings

2011-02-20T23:50:41Z

Bobc55:

<div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div>

__TOC__

=Overview=

To create a new survey, click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear. You can edit most of these settings later again by click the 'Edit survey settings' icon [[File:edit.png]] in the survey toolbar.

=1st Step - Creation=

All survey settings are organized in tabs. The following is a description of each tab and field.

==General==
#'''Base language''': This sets the base language for the survey. Once saved, you cannot change it later. The language-set is the base language for possible translations of the survey. That way you can have multilingual surveys. When you create a survey, you cannot add additional languages. You could only do that if you edit the survey properties again.
#'''Title''': This is the brief descriptive name of the survey (ie: "Enterprise Bargaining Survey 2003", or "Views on Ice Cream"). This title will be displayed on every page of the public survey.
#'''Description''': This allows you to enter a description of the survey. (ie: "A survey to collect your ideas on the next round of enterprise bargaining" or "A survey to find out the popularity of chocolate ice cream"). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor. By default, description is used on ivitation email.
#'''Welcome''': This allows you to enter a message that will display when a participant first logs into your survey. (ie: "Thank you for taking the time to participate in this survey..") You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''End Message''': This allows you to enter a message that will display when a participant completes your survey. (ie: "Thank you for completing our survey. We will publish results soon."). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''Administrator''': This is the name of the contact person who administers the survey. It will be included in emails sent out inviting participants to respond.
#'''Admin email''': This is the email address of the administrator (as above) and is used as the 'reply to:' address on any emails sent. You can also enter several email addresses separated with a semicolon - that way survey administrator notifications are sent to more than one person. (Example: "firstaddress@test.com;secondaddress@test.com")
#'''Bounce email''': This is the email address where a delivery error notification email should be sent. By default, this is the same as the administrator's email address. If you want to use a custom script to parse delivery error emails, then use a special Bounce Email address here and automatically process emails reaching this address with your script. This script could then update the Email Status field of the token line corresponding to this email address (see tokens).
#'''Fax to''': This field is used to give a fax number on the "printable survey" - ie: when you want to send someone a hard copy because they cannot use the online survey.

<div class="simplebox">'''Caution''': 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 ressources, please do so after survey creation, by editing the newly created survey.</div>

==Presentation & navigation==
#'''Format''': Choose from "One at a time", "Group at a time" or "All in one".
**'''Question by Question''': Public survey will display one question per page.
**'''Group by Group''': Public survey will display all questions in a group per page. Group at a time surveys still have a separate "welcome" page and "submit" page, like "One at a time" surveys.
**'''All in one''': Public survey will display all questions in one single page. Activated All in one surveys do not have a "welcome" page or "submit" page - the welcome message and submit button all appear on the same page.
#'''Template''': Choose from the installed templates in your system. The default template is rather dull, but functional. More information on creating your own templates is available in the LimeSurvey [[Templates / The Template Editor]] Guide.
#'''Show welcome screen''': Yes/No. If Yes, then the welcome message defined in Text Elements section will be displayed. Default is Yes.
#'''Navigation delay''': Number of seconds before Previous and Next buttons are enabled. Default 0 seconds
#'''Show <nowiki>[</nowiki><< Prev] button''': This option defaults to yes, however if you set it to "No" then users will not have the option of moving to a previous page while completing the survey.
#'''Show question index / allow jumping''': Yes/No. Default No. When Yes, an index will be displayed on the right side. Users can jump to any section in the survey.
#'''Keyboard-less operation''':
#'''Show progress bar''': Yes/No. Default Yes. Allow the administrator to turn off the Progress bar
#'''Participants may print answers?''': This option defaults to no. When it is set to yes, a participant can print a summary of responses at submit time.
#'''Public statistics''': (''since 1.80'') Yes/No. Default No. If set to "Yes" users who have submitted the survey will be presented a link to statistics of the current survey. The admin can set which questions should be included at these statistics by [[Advanced question settings|#public_statistics|applying the according question attribute]].
#'''Show graphs in public statistics''': (''since 1.80'') Determines if public statistics for this survey include graphs or only show a tabular overview. Creating graphs for huge surveys with lots of answers takes some time and server resources so this is the switch to turn them on/off (default setting: ''off'').
#'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
#'''Automatically load URL when survey complete''': Yes/No. Default No. If yes, when the survey is submitted, it will automatically redirect to the End URL. Which is defined in the Text Elements Section.
#'''Show "There are X questions in this survey"''': Yes/No. Default Yes. If Yes, the message will be displayed on the Welcome Screen. This option will not affect the print version.
#'''Show group name and/or group description''': Will control the display of Group Names and Descriptions. This option will not affect the print version. Four Options:
**'''Show Both''' - Default
**'''Show Group Names Only'''
**'''Show group description Only'''
**'''Hide Both'''
#'''Show question number and/or code''':
**'''Show Both''' - Default
**'''Show Question Number Only'''
**'''Show Question Code Only'''
**'''Hide Both'''
#'''Show "No answer"''': Yes/No. Default Yes. When Yes, the No Answer will be displayed as an answer

==Publication & access control==
#'''Only users with tokens may enter the survey''': This is pretty self-explaining. If you activate this then tokens (to access the survey) are enforced. (''Note: ''This setting was removed in version 1.87. If you create a [http://docs.limesurvey.org/tiki-index.php?page=Tokens&structure;=English+Instructions+for+LimeSurvey#How_to_activate_tokens_ token table] access to the survey will automatically be limited to users with a valid token.)
#'''Set token length to''': (''since 1.87'') Usually you don't need to change this, the default setting of 15 digits (max. supported value: 99) is fine. If changing this setting please enter a number (X) which should be greater than 5 (if the number entered is <5 it will be converted to the default value of 15). When generating tokens all tokens will use a length of X digits.
#'''Allow public registration''': If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.
# '''Start date''': Set this to some date if you want your survey to start on a certain date. The survey will start on midnight of that day and only then will people be able to answer to it. To disable this just clear the date from the input field.
#'''Expiry date''': Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this just clear the date from the input field.
#'''Set cookie to prevent repeated participation?''': If you set this to 'Yes', and your survey does not use a tokens table to control participant access, then a cookie will be saved to the client computer of each survey participant once they have submitted a survey. This cookie will stop the same user on that computer from accessing the survey more than once. There are inherent limitations in the 'security' strength of such a system, but, in general, it allows you to retain some control over multiple entries on public surveys.
#'''Use CAPTCHA for''': With this option you can decide when you want a CAPTCHA to be used. Default is to enable CAPTCHA only for the public Registration page, but you can also enable it before accessing the survey, and before Load/Saving partial answers.
#'''Use HTML format for token emails?''': When set to yes, 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 this emails. Default is Yes at survey creation. Caution, when you switch on/off this feature, you'll have to double check that your email templates are still displayed as you want.

==Notification & data management==
#'''Admin Notification''': Options to allow the administrator to be emailed when each individual survey response is saved. You can choose from:
##No email notification - Self-explanatory.
##Basic email notification - An email is sent informing the administrator that a survey response has been saved.
##Send email notification with response codes - Sends the full answers to the survey after saving.
#'''Email Responses To:''' (''since 1.87+'') This allows you to send the survey responses to additional email addresses once the survey is submitted. Multiple entries or different methods can be used by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using multiple methods: "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". There are three different methods for entering an address:
##Enter a specific ''email address'' (ie: yourname@test.com)
##Enter a ''SGQA code'' and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_previous_answers Re-use information from previous answers]
##Enter a ''Token code'' (only possible if your survey is ''not'' anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_tokens_table Re-use Information from the Tokens Table]

+It should be noted that entering an email address here will override the "Basic email notification" setting so the recipient(s) listed here and the survey admin will receive full answers.
#'''Anonymous answers?''': This allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is yes. If you choose "No" for anonymous, you must also have a tokens table for your survey when you activate it. '''''Attention:''''' If your survey is set to ''anonymous'' there is really no way to connect answers and participants. Even the admin can't link answers' data and users' data. However you will always be able to specifically view all answers entered by a certain anonymous individual participant in the survey. Thus individual, but anonymous, statistics is still possible to do.
#'''Date stamp?''': This field allows you to determine whether the survey will datestamp all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the time and date that the response was made. (See configuration settings for $timeadjust setting.)
#'''Save IP address?''': This field allows you to determine whether the survey will save an IP-address for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the ip-address of the participant.
#'''Save referring URL?''': This field allows you to determine whether the survey will save the referrer URL for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response where this URL is saved. A referrer URL is the URL from which the user was led to your survey URL.
#'''Enable token-based response persistence''': If your survey uses tokens and is not anonymous, then you may want to enable this feature. If you turn this on, then an auto-save is performed each time a participant answers a question, meaning that even if he hasn't submitted the survey and his browser crashes, he will find his survey answers still in place when returns to the survey. This can be used for designing pre-filled surveys as well (see data entry and importVV facility when not finalizing answers).
#'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.

==Import survey==

Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).

==Uploaded resources management==

This tab let you manage files (pictures, media files) that were uploaded in the HTML Editor.

You can:
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files

Important hints:
* Authorized files extensions are defined in config-defaults.php.
* Files for the survey are in the upload/surveys/<sid> subdirectory.
* Uploaded files will only been seen while browsing resources on this survey (groups, questions, answers) not in other surveys or objects (labels).
* Do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who know the URL to the file.
* You can't import a ZIP file containing subdirectories.

=2nd Step - Additional languages=

To add more language to a survey you have to create and save it - then edit it again. Now you can add and remove additional languages to the survey. If you remove a language from a survey the complete contents of that language in that survey is deleted permanently so be careful what you are doing.

By clicking on the button 'Save and continue' on the first page in the survey settings you will be taken to the language-specific page which lets you change all texts for each language like ''Survey name'', ''Welcome Text'', etc. You can also edit the date format which should be used for a certain language.

Previous [[Creating surveys - Introduction]]

Next [[Importing a survey structure]]

Survey settings

2011-02-20T23:50:36Z

Bobc55:

<div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div>

__TOC__

=Overview=

To create a new survey, click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear. You can edit most of these settings later again by click the 'Edit survey settings' icon [[File:edit.png]] in the survey toolbar.

=1st Step - Creation=

All survey settings are organized in tabs. The following is a description of each tab and field.

==General==
#'''Base language''': This sets the base language for the survey. Once saved, you cannot change it later. The language-set is the base language for possible translations of the survey. That way you can have multilingual surveys. When you create a survey, you cannot add additional languages. You could only do that if you edit the survey properties again.
#'''Title''': This is the brief descriptive name of the survey (ie: "Enterprise Bargaining Survey 2003", or "Views on Ice Cream"). This title will be displayed on every page of the public survey.
#'''Description''': This allows you to enter a description of the survey. (ie: "A survey to collect your ideas on the next round of enterprise bargaining" or "A survey to find out the popularity of chocolate ice cream"). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor. By default, description is used on ivitation email.
#'''Welcome''': This allows you to enter a message that will display when a participant first logs into your survey. (ie: "Thank you for taking the time to participate in this survey..") You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''End Message''': This allows you to enter a message that will display when a participant completes your survey. (ie: "Thank you for completing our survey. We will publish results soon."). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''Administrator''': This is the name of the contact person who administers the survey. It will be included in emails sent out inviting participants to respond.
#'''Admin email''': This is the email address of the administrator (as above) and is used as the 'reply to:' address on any emails sent. You can also enter several email addresses separated with a semicolon - that way survey administrator notifications are sent to more than one person. (Example: "firstaddress@test.com;secondaddress@test.com")
#'''Bounce email''': This is the email address where a delivery error notification email should be sent. By default, this is the same as the administrator's email address. If you want to use a custom script to parse delivery error emails, then use a special Bounce Email address here and automatically process emails reaching this address with your script. This script could then update the Email Status field of the token line corresponding to this email address (see tokens).
#'''Fax to''': This field is used to give a fax number on the "printable survey" - ie: when you want to send someone a hard copy because they cannot use the online survey.

<div class="simplebox">'''Caution''': 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 ressources, please do so after survey creation, by editing the newly created survey.</div>

==Presentation & navigation==
#'''Format''': Choose from "One at a time", "Group at a time" or "All in one".
**'''Question by Question''': Public survey will display one question per page.
**'''Group by Group''': Public survey will display all questions in a group per page. Group at a time surveys still have a separate "welcome" page and "submit" page, like "One at a time" surveys.
**'''All in one''': Public survey will display all questions in one single page. Activated All in one surveys do not have a "welcome" page or "submit" page - the welcome message and submit button all appear on the same page.
#'''Template''': Choose from the installed templates in your system. The default template is rather dull, but functional. More information on creating your own templates is available in the LimeSurvey [[Templates / The Template Editor]] Guide.
#'''Show welcome screen''': Yes/No. If Yes, then the welcome message defined in Text Elements section will be displayed. Default is Yes.
#'''Navigation delay''': Number of seconds before Previous and Next buttons are enabled. Default 0 seconds
#'''Show <nowiki>[</nowiki><< Prev] button''': This option defaults to yes, however if you set it to "No" then users will not have the option of moving to a previous page while completing the survey.
#'''Show question index / allow jumping''': Yes/No. Default No. When Yes, an index will be displayed on the right side. Users can jump to any section in the survey.
#'''Keyboard-less operation''':
#'''Show progress bar''': Yes/No. Default Yes. Allow the administrator to turn off the Progress bar
#'''Participants may print answers?''': This option defaults to no. When it is set to yes, a participant can print a summary of responses at submit time.
#'''Public statistics''': (''since 1.80'') Yes/No. Default No. If set to "Yes" users who have submitted the survey will be presented a link to statistics of the current survey. The admin can set which questions should be included at these statistics by [[Advanced question settings|#public_statistics|applying the according question attribute]].
#'''Show graphs in public statistics''': (''since 1.80'') Determines if public statistics for this survey include graphs or only show a tabular overview. Creating graphs for huge surveys with lots of answers takes some time and server resources so this is the switch to turn them on/off (default setting: ''off'').
#'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
#'''Automatically load URL when survey complete''': Yes/No. Default No. If yes, when the survey is submitted, it will automatically redirect to the End URL. Which is defined in the Text Elements Section.
#'''Show "There are X questions in this survey"''': Yes/No. Default Yes. If Yes, the message will be displayed on the Welcome Screen. This option will not affect the print version.
#'''Show group name and/or group description''': Will control the display of Group Names and Descriptions. This option will not affect the print version. Four Options:
**'''Show Both''' - Default
**'''Show Group Names Only'''
**'''Show group description Only'''
**'''Hide Both'''
#'''Show question number and/or code''':
**'''Show Both''' - Default
**'''Show Question Number Only'''
**'''Show Question Code Only'''
**'''Hide Both'''
#'''Show "No answer"''': Yes/No. Default Yes. When Yes, the No Answer will be displayed as an answer

==Publication & access control==
#'''Only users with tokens may enter the survey''': This is pretty self-explaining. If you activate this then tokens (to access the survey) are enforced. (''Note: ''This setting was removed in version 1.87. If you create a [http://docs.limesurvey.org/tiki-index.php?page=Tokens&structure;=English+Instructions+for+LimeSurvey#How_to_activate_tokens_ token table] access to the survey will automatically be limited to users with a valid token.)
#'''Set token length to''': (''since 1.87'') Usually you don't need to change this, the default setting of 15 digits (max. supported value: 99) is fine. If changing this setting please enter a number (X) which should be greater than 5 (if the number entered is <5 it will be converted to the default value of 15). When generating tokens all tokens will use a length of X digits.
#'''Allow public registration''': If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.
# '''Start date''': Set this to some date if you want your survey to start on a certain date. The survey will start on midnight of that day and only then will people be able to answer to it. To disable this just clear the date from the input field.
#'''Expiry date''': Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this just clear the date from the input field.
#'''Set cookie to prevent repeated participation?''': If you set this to 'Yes', and your survey does not use a tokens table to control participant access, then a cookie will be saved to the client computer of each survey participant once they have submitted a survey. This cookie will stop the same user on that computer from accessing the survey more than once. There are inherent limitations in the 'security' strength of such a system, but, in general, it allows you to retain some control over multiple entries on public surveys.
#'''Use CAPTCHA for''': With this option you can decide when you want a CAPTCHA to be used. Default is to enable CAPTCHA only for the public Registration page, but you can also enable it before accessing the survey, and before Load/Saving partial answers.
#'''Use HTML format for token emails?''': When set to yes, 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 this emails. Default is Yes at survey creation. Caution, when you switch on/off this feature, you'll have to double check that your email templates are still displayed as you want.

==Notification & data management==
#'''Admin Notification''': Options to allow the administrator to be emailed when each individual survey response is saved. You can choose from:
##No email notification - Self-explanatory.
##Basic email notification - An email is sent informing the administrator that a survey response has been saved.
##Send email notification with response codes - Sends the full answers to the survey after saving.
#'''Email Responses To:''' (''since 1.87+'') This allows you to send the survey responses to additional email addresses once the survey is submitted. Multiple entries or different methods can be used by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using multiple methods: "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". There are three different methods for entering an address:
##Enter a specific ''email address'' (ie: yourname@test.com)
##Enter a ''SGQA code'' and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_previous_answers Re-use information from previous answers]
##Enter a ''Token code'' (only possible if your survey is ''not'' anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_tokens_table Re-use Information from the Tokens Table]

+It should be noted that entering an email address here will override the "Basic email notification" setting so the recipient(s) listed here and the survey admin will receive full answers.
#'''Anonymous answers?''': This allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is yes. If you choose "No" for anonymous, you must also have a tokens table for your survey when you activate it. '''''Attention:''''' If your survey is set to ''anonymous'' there is really no way to connect answers and participants. Even the admin can't link answers' data and users' data. However you will always be able to specifically view all answers entered by a certain anonymous individual participant in the survey. Thus individual, but anonymous, statistics is still possible to do.
#'''Date stamp?''': This field allows you to determine whether the survey will datestamp all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the time and date that the response was made. (See configuration settings for $timeadjust setting.)
#'''Save IP address?''': This field allows you to determine whether the survey will save an IP-address for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the ip-address of the participant.
#'''Save referring URL?''': This field allows you to determine whether the survey will save the referrer URL for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response where this URL is saved. A referrer URL is the URL from which the user was led to your survey URL.
#'''Enable token-based response persistence''': If your survey uses tokens and is not anonymous, then you may want to enable this feature. If you turn this on, then an auto-save is performed each time a participant answers a question, meaning that even if he hasn't submitted the survey and his browser crashes, he will find his survey answers still in place when returns to the survey. This can be used for designing pre-filled surveys as well (see data entry and importVV facility when not finalizing answers).
#'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.

==Import survey==

Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).

==Uploaded resources management==

This tab let you manage files (pictures, media files) that were uploaded in the HTML Editor.

You can:
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files

Important hints:
* Authorized files extensions are defined in config-defaults.php.
* Files for the survey are in the upload/surveys/<sid> subdirectory.
* Uploaded files will only been seen while browsing resources on this survey (groups, questions, answers) not in other surveys or objects (labels).
* Do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who know the URL to the file.
* You can't import a ZIP file containing subdirectories.

=2nd Step - Additional languages=

To add more language to a survey you have to create and save it - then edit it again. Now you can add and remove additional languages to the survey. If you remove a language from a survey the complete contents of that language in that survey is deleted permanently so be careful what you are doing.

By clicking on the button 'Save and continue' on the first page in the survey settings you will be taken to the language-specific page which lets you change all texts for each language like ''Survey name'', ''Welcome Text'', etc. You can also edit the date format which should be used for a certain language.

Previous [[Creating surveys - Introduction]]

Next [[Importing a survey structure]]

Survey settings

2011-02-20T23:13:37Z

Bobc55:

<div style="float:right;"><div class="simplebox">Additional pages:{toc}</div></div>

__TOC__

=Overview=

To create a new survey, click on the Add button [[File:add.png]] on the right side of the administration button bar and a "Create New Survey" screen will appear. You can edit most of these settings later again by click the 'Edit survey settings' icon [[File:edit.png]] in the survey toolbar.

=1st Step - Creation=

All survey settings are organized in tabs. The following is a description of each tab and field.

==General==
#'''Base language''': This sets the base language for the survey. Once saved, you cannot change it later. The language-set is the base language for possible translations of the survey. That way you can have multilingual surveys. When you create a survey, you cannot add additional languages. You could only do that if you edit the survey properties again.
#'''Title''': This is the brief descriptive name of the survey (ie: "Enterprise Bargaining Survey 2003", or "Views on Ice Cream"). This title will be displayed on every page of the public survey.
#'''Description''': This allows you to enter a description of the survey. (ie: "A survey to collect your ideas on the next round of enterprise bargaining" or "A survey to find out the popularity of chocolate ice cream"). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor. By default, description is used on ivitation email.
#'''Welcome''': This allows you to enter a message that will display when a participant first logs into your survey. (ie: "Thank you for taking the time to participate in this survey..") You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''End Message''': This allows you to enter a message that will display when a participant completes your survey. (ie: "Thank you for completing our survey. We will publish results soon."). You can incorporate HTML elements such as images or videos in this section using the WYSIWYG editor.
#'''Administrator''': This is the name of the contact person who administers the survey. It will be included in emails sent out inviting participants to respond.
#'''Admin email''': This is the email address of the administrator (as above) and is used as the 'reply to:' address on any emails sent. You can also enter several email addresses separated with a semicolon - that way survey administrator notifications are sent to more than one person. (Example: "firstaddress@test.com;secondaddress@test.com")
#'''Bounce email''': This is the email address where a delivery error notification email should be sent. By default, this is the same as the administrator's email address. If you want to use a custom script to parse delivery error emails, then use a special Bounce Email address here and automatically process emails reaching this address with your script. This script could then update the Email Status field of the token line corresponding to this email address (see tokens).
#'''Fax to''': This field is used to give a fax number on the "printable survey" - ie: when you want to send someone a hard copy because they cannot use the online survey.

<div class="simplebox">'''Caution''': 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 ressources, please do so after survey creation, by editing the newly created survey.</div>

==Presentation & navigation==
#'''Format''': Choose from "One at a time", "Group at a time" or "All in one".
**'''Question by Question''': Public survey will display one question per page.
**'''Group by Group''': Public survey will display all questions in a group per page. Group at a time surveys still have a separate "welcome" page and "submit" page, like "One at a time" surveys.
**'''All in one''': Public survey will display all questions in one single page. Activated All in one surveys do not have a "welcome" page or "submit" page - the welcome message and submit button all appear on the same page.
#'''Template''': Choose from the installed templates in your system. The default template is rather dull, but functional. More information on creating your own templates is available in the LimeSurvey [[Templates / The Template Editor]] Guide.
#'''Show welcome screen''': Yes/No. If Yes, then the welcome message defined in Text Elements section will be displayed. Default is Yes.
#'''Navigation delay''': Number of seconds before Previous and Next buttons are enabled. Default 0 seconds
#'''Show <nowiki>[</nowiki><< Prev] button''': This option defaults to yes, however if you set it to "No" then users will not have the option of moving to a previous page while completing the survey.
#'''Show question index / allow jumping''': Yes/No. Default No. When Yes, an index will be displayed on the right side. Users can jump to any section in the survey.
#'''Keyboard-less operation''':
#'''Show progress bar''': Yes/No. Default Yes. Allow the administrator to turn off the Progress bar
#'''Participants may print answers?''': This option defaults to no. When it is set to yes, a participant can print a summary of responses at submit time.
#'''Public statistics''': (''since 1.80'') Yes/No. Default No. If set to "Yes" users who have submitted the survey will be presented a link to statistics of the current survey. The admin can set which questions should be included at these statistics by [[Advanced question settings|#public_statistics|applying the according question attribute]].
#'''Show graphs in public statistics''': (''since 1.80'') Determines if public statistics for this survey include graphs or only show a tabular overview. Creating graphs for huge surveys with lots of answers takes some time and server resources so this is the switch to turn them on/off (default setting: ''off'').
#'''List survey publicly''': Yes/No. Default No. When it is set to yes, your survey will be listed in the 'available surveys' portal
#'''Automatically load URL when survey complete''': Yes/No. Default No. If yes, when the survey is submitted, it will automatically redirect to the End URL. Which is defined in the Text Elements Section.
#'''Show "There are X questions in this survey"''': Yes/No. Default Yes. If Yes, the message will be displayed on the Welcome Screen. This option will not affect the print version.
#'''Show group name and/or group description''': Will control the display of Group Names and Descriptions. This option will not affect the print version. Four Options:
**'''Show Both''' - Default
**'''Show Group Names Only'''
**'''Show group description Only'''
**'''Hide Both'''
#'''Show question number and/or code''':

==Publication & access control==
#'''Only users with tokens may enter the survey''': This is pretty self-explaining. If you activate this then tokens (to access the survey) are enforced. (''Note: ''This setting was removed in version 1.87. If you create a [http://docs.limesurvey.org/tiki-index.php?page=Tokens&structure;=English+Instructions+for+LimeSurvey#How_to_activate_tokens_ token table] access to the survey will automatically be limited to users with a valid token.)
#'''Set token length to''': (''since 1.87'') Usually you don't need to change this, the default setting of 15 digits (max. supported value: 99) is fine. If changing this setting please enter a number (X) which should be greater than 5 (if the number entered is <5 it will be converted to the default value of 15). When generating tokens all tokens will use a length of X digits.
#'''Allow public registration''': If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token from the token table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. The script will create a new entry in your tokens table for this person, then send them an invitation email. The script will ensure that only one person per email address can complete your survey.
# '''Start date''': Set this to some date if you want your survey to start on a certain date. The survey will start on midnight of that day and only then will people be able to answer to it. To disable this just clear the date from the input field.
#'''Expiry date''': Set this to some date if you want your survey to expire on a special date. This is the last date on which the public survey script will let people participate. (Example: If you set it for the 31st of December, then people will no longer be able to use the survey script on the 1st of January). To disable this just clear the date from the input field.
#'''Set cookie to prevent repeated participation?''': If you set this to 'Yes', and your survey does not use a tokens table to control participant access, then a cookie will be saved to the client computer of each survey participant once they have submitted a survey. This cookie will stop the same user on that computer from accessing the survey more than once. There are inherent limitations in the 'security' strength of such a system, but, in general, it allows you to retain some control over multiple entries on public surveys.
#'''Use CAPTCHA for''': With this option you can decide when you want a CAPTCHA to be used. Default is to enable CAPTCHA only for the public Registration page, but you can also enable it before accessing the survey, and before Load/Saving partial answers.
#'''Use HTML format for token emails?''': When set to yes, 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 this emails. Default is Yes at survey creation. Caution, when you switch on/off this feature, you'll have to double check that your email templates are still displayed as you want.

==Notification & data management==
#'''Admin Notification''': Options to allow the administrator to be emailed when each individual survey response is saved. You can choose from:
##No email notification - Self-explanatory.
##Basic email notification - An email is sent informing the administrator that a survey response has been saved.
##Send email notification with response codes - Sends the full answers to the survey after saving.
#'''Email Responses To:''' (''since 1.87+'') This allows you to send the survey responses to additional email addresses once the survey is submitted. Multiple entries or different methods can be used by seperating the entries with a semicolon (;) - eg "yourname@test.com; myname@test.com;hisname@test.com" OR when using multiple methods: "yourname@test.com;{INSERTANS:82733X12X73};{TOKEN:EMAIL}". There are three different methods for entering an address:
##Enter a specific ''email address'' (ie: yourname@test.com)
##Enter a ''SGQA code'' and the response will be sent to an email address entered as an answer to that particular question (use the format {INSERTANS:9999X88X12}, in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_previous_answers Re-use information from previous answers]
##Enter a ''Token code'' (only possible if your survey is ''not'' anonymous) and the response will be sent to an email address retrieved from a token field (use the format {TOKEN:EMAIL} or {TOKEN:ATTRIBUTE_1} in the same way you would [http://docs.limesurvey.org/tiki-index.php?page=Adding+a+question&structure;=English+Instructions+for+LimeSurvey#Information_from_tokens_table Re-use Information from the Tokens Table]

+It should be noted that entering an email address here will override the "Basic email notification" setting so the recipient(s) listed here and the survey admin will receive full answers.
#'''Anonymous answers?''': This allows you to determine whether responses to your survey are matched up with information from your surveys tokens table, or kept 'anonymous'. The default is yes. If you choose "No" for anonymous, you must also have a tokens table for your survey when you activate it. '''''Attention:''''' If your survey is set to ''anonymous'' there is really no way to connect answers and participants. Even the admin can't link answers' data and users' data. However you will always be able to specifically view all answers entered by a certain anonymous individual participant in the survey. Thus individual, but anonymous, statistics is still possible to do.
#'''Date stamp?''': This field allows you to determine whether the survey will datestamp all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the time and date that the response was made. (See configuration settings for $timeadjust setting.)
#'''Save IP address?''': This field allows you to determine whether the survey will save an IP-address for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response indicating the ip-address of the participant.
#'''Save referring URL?''': This field allows you to determine whether the survey will save the referrer URL for all responses. If you choose "Yes", then when a response is submitted, a field will be included in that response where this URL is saved. A referrer URL is the URL from which the user was led to your survey URL.
#'''Enable token-based response persistence''': If your survey uses tokens and is not anonymous, then you may want to enable this feature. If you turn this on, then an auto-save is performed each time a participant answers a question, meaning that even if he hasn't submitted the survey and his browser crashes, he will find his survey answers still in place when returns to the survey. This can be used for designing pre-filled surveys as well (see data entry and importVV facility when not finalizing answers).
#'''Enable assessment mode?''': With this setting you can enable/disable [[Assessments|assessments]] for this survey.

==Import survey==

Alternatively you can [[Importing a survey structure|import a survey structure]] from this tab. You have the option to let LimeSurvey automatically convert relative URLs to local images/media files and INSERTANS tags (recommended).

==Uploaded resources management==

This tab let you manage files (pictures, media files) that were uploaded in the HTML Editor.

You can:
* Browse available files
* Export files as a ZIP archive
* Import a ZIP archive of files

Important hints:
* Authorized files extensions are defined in config-defaults.php.
* Files for the survey are in the upload/surveys/<sid> subdirectory.
* Uploaded files will only been seen while browsing resources on this survey (groups, questions, answers) not in other surveys or objects (labels).
* Do not expect this limited visibility to ensure confidentiality of the resources as they are reachable with a simple browser to anyone who know the URL to the file.
* You can't import a ZIP file containing subdirectories.

=2nd Step - Additional languages=

To add more language to a survey you have to create and save it - then edit it again. Now you can add and remove additional languages to the survey. If you remove a language from a survey the complete contents of that language in that survey is deleted permanently so be careful what you are doing.

By clicking on the button 'Save and continue' on the first page in the survey settings you will be taken to the language-specific page which lets you change all texts for each language like ''Survey name'', ''Welcome Text'', etc. You can also edit the date format which should be used for a certain language.

Previous [[Creating surveys - Introduction]]

Next [[Importing a survey structure]]

Data entry

2008-11-20T18:21:44Z

Bobc55:

<br/>Open the Data Entry Screen by clicking on the [[File:dataentry.png]] "Data Entry" Icon. This function is not intended to be available to your participants. When LimeSurvey was first developed, it was intended as a data entry system for paper based surveys. The Data Entry screen is intended to be used when entering returned surveys on a mass basis and subsequently is designed to allow for keyboard based entry (using tabs, space bar, arrow keys, number pad and keystrokes).

'''Shortcut key:'''

Tabulator Key: next question

Shift Key + Tabulator Key: previous question

The "Finalize response submission" let the operator finalize the response record by:
* adding a submitdate entry to the record, which will make it available as a full response while browsing responses or computing statistics
* marking the token code as used (if the survey uses tokens)

If the "Finalize response submission" check-box is not checked, then the answer will be considered as 'not completely filled out', no submission date will be added to the record and the token will remain available to the participant.

Activating a survey

2008-11-20T17:13:15Z

Bobc55:

<br/>Once you are happy with the structure of your survey you can activate it by clicking on the [[File:activate.png]] "Activate survey" icon. Activating a survey does a number of things:
*It creates a separate database table to hold all survey responses, and creates for each possible answer to the survey a field in that table.
*It allows people to enter data into that table, and gives you access to other features for the survey, including browse and token facilities.
*It gives you access to the "tokens" feature. Once a survey is activated, the "tokens" button will be available (see section on [[Tokens]] ).
*If your survey is set to "not anonymous", a tokens table will be created automatically.

Before you activate a survey you should note the following points:
*When the survey is initialized you can change the text for questions, answers, the survey etc, but not the type of question or the type of answer.
*You cannot add new questions or delete questions. Nor can you add answers to any of the array or multiple choice questions - however you can add answers to the basic list type questions.

If the [[File:activate.png]] "Activate survey" icon is not shown, then your survey is not yet capable of being activated (for example if you have no questions created yet). Once clicking on this icon, LimeSurvey will run a quick consistency check to make sure that your survey will work properly.