Setting conditions

=Overview of Conditions in LimeSurvey=

LimeSurvey has a very powerful logical branching feature. It can be accessed by clicking on the Set conditions button - - located on each question bar.

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

For step-by-step video instructions check out this tutorial or download the condition sample survey: [[Media:LimeSurvey_Survey_Setting_Conditions.zip|LimeSurvey_Survey_Setting_Conditions.zip]].

Hide/Show Branching Versus Jump Branching
You can design logical branching with LimeSurvey, which means that you can decide that some questions will be displayed only if some conditions are met like "Show question X if the answer to question Y was 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 then 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 should simply set the same condition on all the questions you do not wish to be 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'"

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.

To find out more details on how you can copy conditions within LimeSurvey, please continue reading the following wiki section.

Supported Types of Conditions
Basically, a condition can compare values, returning either true or false.

The values that can be compared are answers to previous questions. For instance, if you answer 'Yes' to Question1, Question2 will then be showed to the survey respondent:





At this point, it is important to understand what is considered 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 with 5 radio buttons or 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


 * constant values
 * for instance: "If you answered more than 18 years to the question below"




 * Participants' profile data: To use data from the survey participants table, "Anonymized responses" must be set to NO.  This option can be found in survey participant settings panel.





Several comparison operators are supported - from the simple "equals" to the advanced "regular expression":
 * The basic ones refer to the "equal" and "not equal to" operations
 * The greater/less than operator family is also available, and is usually used when using numeric question-entries
 * Please note that comparisons on numeric fields make use of the numeric order. For instance, 2 < 10
 * If you're using a question entry whose type is text, 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 (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: [a-zA-Z]$

How can I combine conditions?
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. In the above example, there is only one scenario. This means that LimeSurvey makes use of Boolean algebra, which means that operator or is "computed" first.

We'll talk more about complex conditions later. Let's first focus together on the elementary ones.

=The conditions designer=

First, you need to access the conditions designer. To do that, click on the question you wish to apply the condition to:



Now, look for the Set conditions button located on the top question bar:



Once accessed, the following page will be displayed:



The conditions designer panel can be divided into three sections:
 * The conditions designer toolbar
 * The current existent question conditions
 * Add/edit condition menu

The conditions designer toolbar
You may find on the toolbar the following options:




 * Show conditions for this question: Click on this button to get a quick overview of the current existent conditions that are applied to your question.


 * Add and edit conditions: It represents the default page that opens automatically once you click the Set conditions button. It is divided in two parts: (1) a table displaying all the existent conditions and scenarios, and (2) the add/edit conditions menu.


 * Copy conditions: Sometimes, you wish to apply the same condition to X questions in order to get questionY displayed at the end. For this, click on Copy conditions. A new window will open displaying the current existent conditions added to your question (let's call it question3). To add them to question5, check the desired conditions you wish to be copied, select question5, and click on the Copy conditions button located on the bottom left part of the panel. For further information, please continue reading the following wiki section.


 * Save and close: Once you are done with the changes, click Save and close to get your conditions saved.


 * Move to question: In order not to leave the conditions designer panel while moving to another question, use the following option to select from the dropdown list the next question you wish to apply conditions to. Please note that the dropdown list displays the questions that are displayed in the survey before and after the current question.


 * Close: If you wish to exit the panel without performing any changes, you can either go straight to the settings/structure tab and select the desired option or click Close, which is located in the upper right of the screen.

Overview of the existent conditions
This section displays a table that contains all the existent scenarios and conditions of a question. Certain actions can be performed from here:




 * In the top right part, three actions are available:
 * Quick-add conditions - it fastens the process of adding conditions (read below to learn about all the options)
 * Renumber scenarios - if clicked, the scenarios will be renumbered with incremental numbers beginning from one. Please note that this option is displayed only if two or more scenarios are applied to your question.
 * Delete all conditions - you can delete via this action all the current existent conditions and scenarios applied to your question.




 * Besides the id number of each scenario there are three buttons that allow you to perform the following actions:
 * Delete scenario
 * Change scenario number
 * Add condition to this scenario - click on this button to add another condition to the desired scenario




 * Two actions can be performed on each condition:
 * Delete condition
 * Edit condition - if clicked, you will be able to edit the condition from the conditions menu



Add/Edit conditions
The bottom part of the screen is allocated to the Add/edit conditions menu:



You can also edit the condition from the same location if you pressed before on the green pencil that corresponds to the question you wish to be edited (see the conditions and scenarios table).

To understand how the conditions feature works in LimeSurvey, we will first present the elementary conditions.

Note: For the moment don't modify the default scenario that is automatically selected in the condition addition form. It will be covered later within this wiki section.

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. It can either be a previous question or a survey participant attribute.



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 under the Predefined tab of the comparison value selection.

Note that in order to use the Token your survey must:
 * not use anonymous answers
 * use a survey participants table and closed access.


 * a comparison operator. Choose the comparison operator you want to apply from the dropdown list (less than, less than or equal to, equals, not equal to, greater than or equal to, greater than, regular expression).


 * a right operand: the comparison value. You can choose the comparison value type by selecting the appropriate tab in the condition editor. When you create a condition, you can select as the comparison value a predefined value (answer), a constant, a question, a survey participant attribute, or a regular expression:



Example of elementary conditions and how to create them

 * Show Question 'AAMN' if "the answer to Question 'Gender' is the predefined answer 'Male'"
 * tested value = answer to Question 'Gender'
 * comparison operator = equals
 * comparison value = predefined answer code (the 'Male' answer in this case)




 * Show Question 'Alcohol' if "the answer to Question 'Age' is greater or equal than the numerical value '18'"
 * tested value = answer to Question 'Age'
 * comparison operator = greater than or equal to
 * comparison value = the constant value '18'




 * Show Question 'Alcohol' if "the answer to Question 'BirthDate' is greater than 2000-01-01'''"
 * tested value = answer to Question 'BirthDate'
 * comparison operator = Greater than or equal to
 * comparison value = '2000-01-01' (the format in the constant field: 2000-01-01)




 * Show Question 'Alcohol' if "the the 'DrinkingHistory' participant's attribute" matches the 'Yes' string.
 * tested value= the 'DrinkingHistory' value taken from the survey participants table
 * comparison operator = equals
 * comparison value = the constant value 'Yes'



=Conditions and scenarios in LimeSurvey=

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. Two rules should be always remembered:
 * First rule: conditions having the same tested value are ORed together
 * Second rule: conditions having different tested value are ANDed together

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 if the condition applies to several answers belonging to one single question. For example, a condition was applied below to three answers belonging to the same question - if answer to Question 'FavColour' equals 'green' OR  answer to Question 'FavColour' equals 'red'  OR  answer to Question 'FavColour' equals 'blue', then Question 'BirthDate' will be displayed to the survey respondent:





Note: To select multiple predefined answers, don't forget to hold the Shift or Ctrl key while selecting the tested values.

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. For example, you may see below the case for several conditions based on different previous questions - "If answer to Question 'Alcohol' equals 'Y' answer AND answer to Question 'Gender' equals 'F'", then Question 'Alcoholconsumption' will be displayed to the survey respondent:







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 (in case of the latter, each checkbox is a separate question-entry and is not really handled as other multiple options question-types).

The Multiple choice and Multiple choice with comments question types will be displayed in two flavors:
 * a Group of checkboxes flavor which let you set conditions on all possible answers of the respective question;
 * a set of Single checkbox entries which lets you set conditions on each checkbox individually.



The group of checkboxes flavour
Now, let's focus on an example to better understand the difference between the two flavours. Let's imagine that we wish to display the 'Pointchoice' Question only if the respondent checks at least one of the tested answers listed under the 'MultipleOrganizations' Question.

As mentioned above, the group of checkboxes flavor allows you to set conditions on all possible answers of the respective question. Therefore, only the options that refer to responsibilities are selected as comparison values below:



As we can observe, the conditions get ORed due to the Group of checkboxes flavour selected in the beginning.:



ANDing conditions in multiple choice questions
Now, let's focus on a similar example. However, we are looking this time only for the most active members to ask them further questions. To do this, we make use of the Single checkbox flavour which allows you to set conditions based on each checkbox individually.

In this example, question X will be displayed if A and B are checked:





Once done, you can observe that the two conditions are ANDed now.



This means that your question will not be displayed unless both tested values (the selected subquestions) are met.

The usage of scenarios - Using ORed conditions between different questions
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 why we got scenarios!

Definition of a scenario
A scenario is simply a manual grouping of conditions in which some conditions are evaluated independently of other conditions from other scenarios. The complex condition resulting in this association of several scenarios will be met only if 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.

Everything described above applies to the conditions located in every scenario. By default, all the new conditions are created inside the Default Scenario, which uses number '1' as its identifier. When you create new conditions, you can choose whether they are added to the default scenario or not. To change the scenario, just use another 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 by simply clicking on the add scenario button:



As you can observe, the default scenario uses as identifier '1'. To add conditions to different scenarios, change the identifier by typing a different number in the box.

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



You can change the number assigned to a scenario by clicking this Icon and assigning the new id to the scenario.



Note: 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 scenarios are displayed when using the printable version of a survey
 * merge conditions from two scenarios (in order to merge scenario 10 with scenario 1, just renumber scenario 10, so that it is scenario 1).

Example: creating three scenarios
To create three scenarios, you need at least three conditions and to add to each of them a different scenario id. Once done, the scenarios are going to be connected among themselves via the 'OR' operator. For example, it could look like this:



AND vs OR in the same scenario
You may end up in certain cases with AND and OR logical operators in the same scenario:



LimeSurvey will always apply first OR. For further details on this, you may check the following Wikipedia article on Boolean algebra.

However. the order of operations can also be observed in the Relevance equation field. For the above example, the relevance equation is highlighted below:



As it can be observed, a set of extra parentheses is added for the OR logical operations in order to let the software know that it must be "computed" first.

Help: For more information on relevance equations, check the ExpressionScript and relevance equation wiki sections.

=How to copy conditions=

The copy conditions functionality can be used when you wish to apply the same set of conditions you applied to Question5 to Question10. In this way, you will not have to manually recreate the conditions you applied to the previous question(s).

To start copying conditions, you first have to select the question the condition(s) is/are applied to (Question 'LowQ' in our case). Then, select the conditions you wish to be copied and select the question you wish to have the conditions added to (Question 'Alcohol' in our case).



Note: Conditions can only be set based on questions that appear before the question on which the condition is set.

Please pay attention to how the copy conditions functions work when you wish to copy and apply a set of conditions located under different scenarios to another question which uses the same or different scenario id numbers. To summarise the possible cases you might have, check the following example:


 * you wish to copy Scenario 1 - Condition A, Scenario 1- Condition B, Scenario 7 - Condition C, and Scenario 7 - Condition D from QuestionX into QuestionY
 * QuestionY already contains Scenario 1 - Condition A, Scenario - Condition C, Scenario 6 - Condition E, Scenario 8- Condition F.
 * Once copied, the following conditions will be applied to QuestionY:
 * Scenario 1: Condition A, Condition B, Condition C -> Condition A is not copied anymore as it already exists in QuestionY, only condition B being copied.
 * Scenario 6: Condition E -> not affected
 * Scenario 7: Condition C, Condition D -> a new scenario is created where the two conditions are added to it
 * Scenario 8: Condition F -> not affected

=Reset conditions=

To quickly reset all the survey conditions, click on one survey-related setting, look for Tools on the top toolbar, and click Reset conditions:



Next, confirm on the next page that you want to proceed and all the conditions will be deleted.

=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 be displayed 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 any of your conditions. You should always put aside the creation of conditions until you are satisfied 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


Setting the following condition "Show question 'FavColour' if the answer to the question 'Gender' is 'no answer'" really means "show question 'FavColour' if question 'Gender' was displayed to the survey participant who did not submit answer".

Chained conditions
If you set conditions on a question that, itself, has conditions, you could end up with your survey behaving 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, the group header will still be shown unless you correct these conditions as explained below.





In the above example, the 'Alcohol' question is displayed if the respondent has previously answered to the 'AAMN' question 'No (N)'. However, the 'AAMN' question might not be displayed at the end if the respondent did not select to the previous question ('Gender') answer 'Male (M)'. In this scenario, no 'Alcohol' question will be displayed if 'Male (M)' was chosen previously.

To have the 'Alcohol' question displayed, you have to copy the conditions from the earlier question(s) to the one you're editing. To have the 'Alcohol' question displayed, you need to set up the following set of conditions:
 * Show 'AAMN' if the answer to 'Gender' is 'Male (M)'
 * Show 'Alcohol' if answer to 'Gender' is 'Male (M)' and if answer to 'AAMN' is No (N)'.

After correction, the correct set of conditions for 'Alcohol' should look like this:



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

To find out more on how you can copy conditions in LimeSurvey, please scroll up or click here to continue reading the dedicates wiki section.

Progress-bar
If you create a survey where many questions get skipped because of conditions, the progress bar either jumps over a set of questions or the survey ends at 50%.

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

For example, based on Question1 (yes or no question), 14 questions (2A to 15A) will be displayed if the answer to Question1 is 'Yes', or 2B to 15B if the answer to Question1 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 you 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 Multiple choice questions are handled, 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)