ExpressieScript voorbeeld enquêtes
From LimeSurvey Manual
Inleiding
De beste manier om ExpressionScript te leren te gebruiken is door werkende voorbeelden uit te proberen en die aan te passen naar wat je nodig hebt.
De beste manier om EM te leren te gebruiken is door werkende voorbeelden uit te proberen en die aan te passen naar wat je nodig hebt.
Relevantie, maatwerk en vergelijkingen
Overzicht
De volgende functies worden gebruikt in dit voorbeeld:
Functies gedemonstreerd
- Relevance - support for powerful conditional logic;
- Piping / Tailoring - offers the ability to pipe or tailor answers and question metadata;
- Dynamic Tailoring - note that reports are changed on the page as you answer questions.
- Micro-Tailoring - conditional tailoring withing sentences and reports using if() statements
- Equations - a new question type that lets you do calculations and store the results in the database, even if the calculation is hidden
- Conditional Validation - validation criteria, such as the minimum allowable value, can be conditional - e.g., based upon equations.
Schermafdruk
In dit voorbeeld wordt de BMI bepaald (Body Mass Index), een berekening op grond van je gewicht en je lengte. Een norm om te bepalen of je bijvoorbeeld overgewicht hebt. Standaard zijn er 4 verplichte vragen.
Na het invullen van de informatie (waaronder het selecteren welke eenheden je gebruikt) zie je een maatwerk rapport met je invoergegevens en het resultaat:
Een ander voorbeeld met andere eenheden, de resultaten worden vanzelfsprekend met die eenheden weergegeven:
Er zijn verborgen vragen van het vraagtype Vergelijking waarmee intern de eventuele benodigde omzettingen vanwege de gekozen eenheden worden gedaan. Dit hoeft dus niet in JavaScript te worden gedaan.
In de volgende set voorbeelden zie je hoe je mathematische en andere functies kunt gebruiken bij maatwerk rapporten. Voor het invoeren van gegevens ziet de pagina er als volgt uit. Er is conditionele logica om blanco gegevens te tonen als er geen of een niet-numeriek gegeven is ingevoerd, dit voorkomt het tonen van "NaN" en "Divide by Zero".
Bij numerieke invoer wordt het rapport aangepast om de berekening te doen en het resultaat te tonen.
There are many other examples in this sample survey. For example, the below screenshot shows one of the dozens of ways you can fill out the Dynamic Relevance page. As the help text notes, try different ages, and especially illogical combinations of responses to see the amusing messages generated at the bottom. Also note that if you say that you have more than one child, the message will say "I hope you enjoy playing with your X children", rather than saying "I hope you enjoy playing with your child". This shows how you can easily micro-tailor sentences to make them match the gender and/or number of your subjects. You can even easily conjugate verbs and decline nouns based upon gender and number.
Download
Voorbeeld downloaden.
Voorbeeld telling
Overzicht
In dit voorbeeld vragen we hoeveel mensen er zijn in je huishouden.
We demonstreren hoe groepsrelevantie het gemakkelijk maakt om een aantal vragen een aantal keer te stellen (een loop, de vragen worden per lid van het huishouden gesteld). Na het aanmaken van de groep voor de eerste persoon wordt de groep door ons geëxporteerd. Als variabele-naam is p1_name gekozen in plaats van de SGQA-code. Je kunt natuurlijk de vraag dan simpel een aantal keer kopiëren in een tekstverwerker en dan importeren nadat je de variabele-namen uniek hebt gemaakt.
Je kunt hiervoor ook, al zal dat wel iets langer duren, de functie vraag kopiëren gebruiken.
We tonen ook hoe je het tonen van het afsluitbericht kunt voorkomen totdat alle verplichte groepen afgerond zijn.
Functies gedemonstreerd
- Groepsrelevantie: De groepen per personen in het huishouden (1 tm 5) worden getoond afhankelijk van het opgegeven aantal leden van het huishouden.
- Maatwerk: Het eindrapport bevat demografische gegevens voor elk lid van het huishouden.
- Progressief tonen van vragen: Of per groep of alles tegelijk, vervolgvragen worden pas getoond als de voorafgaande vraag is beantwoord.
Schermafdruk
De enquête maakt een rapport aan waarin met maatwerk de demografische gegevens van de leden van het huishouden worden getoond.
If you switch to question-at-a-time mode, you see that the index tailors the questions. Since the user said that the person is a woman, it asks "What is her name". And since we answered "Mary", the next question says "How old is Mary"?
Download
Voorbeeld downloaden.
Cascading arrayfilters
Overzicht
Deze enquête is gebaseerd op een enquête van Joy Lane Research, LLC.
Schermafdruk
Hierbij staat:
- Q02 voor de verzameling geselecteerde producten in vraag Q01 (gebruik van een array_filter).
- Q02 toont ook "Another product", de ingevulde tekst bij het veld "Other electronic" in Q01.
- Q04 voor de verzameling geselecteerde producten in Q02 (dus een herhaald filter).
- Q05 voor de verzameling niet in Q02 geselecteerde producten (gebruik van het array_filter_exclude).
Download
Voorbeeld downloaden.
Maatwerk met gebruik van vraagtypes en attributen
Overzicht
Je bent niet alleen als je de naamgeving van je variabelen moeilijk vindt (SGQA of Qcodes). In de documentatie beschrijven we hoe een Qcode-naam wordt opgebouwd, maar vermoedelijk is een werkend demo gemakkelijker te volgen. In deze enquête tonen we hoe je vraagattributen en reacties kunt benaderen met ExpressionScript.
Voor dit voorbeeld raden we aan de ingebouwde HTML-editor uit te schakelen (of de pop-upmodus te kiezen) bij het bewerken van deze enquête. Het kan een minuut of wat langer duren voordat de HTML-editor een groter HTML-rapport weergeeft in de bewerkingsmodus.
Inhoud
- Voorbeelden van elk vraagtype.
- Inclusief alle vraagtypes die "anders" kunnen gebruiken, zodat je kunt zien hoe dat van invloed is op de naamgeving van de variabelen.
- Standaardwaarden voor alle vraagtypen die standaardinstellingen accepteren.
- Maatwerk : On- en off-pagina rapporten met alle 16 beschikbare Expressiebeheer notatie-achtervoegsels.
- Deze rapporten tonen alle ingevoerde gegevens (je ziet hoe je eigen afdrukbare rapporten kunt genereren voor gebruikers in plaats van het afdruk- antwoordscherm)
- Goede Qcode en SGQA-naamgeving van alle variabelen.
Schermafdruk
Geen screenshot, want dit is een lange enquête. Probeer de download uit.
Download
Voorbeeld downloaden.
Traditionele validatie, opnieuw gebruiken
Overzicht
Hier zien we alle validatietypes die gebruikmaken van expressies en hoe deze van invloed zijn op elk van de vraagtypes die validatie ondersteunen. In veel gevallen zijn de validatietips eerst verborgen en verschijnen ze alleen als een antwoord niet voldoet aan de validatiecriteria (ze verdwijnen zodra het antwoord voldoet).
Validatie types gedemonstreerd
- min_num_value_n - minimum value for an answer
- max_num_value_n - max value for an answer
- min_answers - minimum number of answers required
- max_answers maximum number of answers allowed
- multiflexible_min - minimum value allowed for an answer (for multiflexi numbers question type)
- multiflexible_max - maximum value allowed for an answer (for multiflexi numbers question type)
- min_num_value - minimum allowed sum across all answers for the question
- max_num_value - maximum allowed sum across all answers for the question
- equals_num_value - the sum across all answers for the question must equal this value
- validation - this is the regular expression validation for the question - it can apply to individual cells
Schermafdruk
Met behulp van nieuwe CSS-styles verschijnt bij elk validatietype een afzonderlijke tip. Als ze worden getoond, kunnen ze worden verborgen via de optie hide_tip. De standaardoptie is om ze met een rood lettertype weer te geven als het antwoord niet aan de validatiecriteria voldoet en groen als het voldoet.
A user cannot submit a page with validation errors. He will be immediately warned if he entered wrong information:
Validation can be applied to individual cells within an array, such as in this example where regular expression validations ensure that each entry is a properly formatted US phone number including area code.
Download
To download the above example, click on the following link: LS3_Validation_tests.zip.
Validation Equations
Overview
Sometimes you need custom validation that cannot be achieved using the traditional min/max criteria. For this, you will need to use the em_validation_q and em_validation_sq options which let you construct complex validation equations at the question and subquestion level, respectively.
At the subquestion level, we also introduce the "this" variable to make it easy to validate each cell in an array without needing to know its variable name. For more details about it, click here.
EM Features Demonstrated
- em_validation_q - this is an equation that determines whether the whole question is valid
- em_validation_q_tip - this is the message to show if the question fails em_validation_q criteria
- em_validation_sq - this is the equation that determines whether each subquestion (array cell) is valid
- em_validation_sq_tip - this is the message to show if any of the subquestions is invalid.
In general, when em_validation_sq is used, if any cell is invalid, the background color for that cell turns red to indicate that there is an error.
Screenshots
This question ensures that you enter the ages of your children in descending order by applying this validation equation:
q1_sq1 >= q1_sq2 && q1_sq2 >= q1_sq3 && q1_sq3 >= q1_sq4
In the below example, the validation ensures that no more than 3 questions are answered on any given row by applying this validation equation:
(sum(Test_A_1, Test_A_2, Test_A_3, Test_A_4, Test_A_5) <= 3) && (sum(Test_B_1, Test_B_2, Test_B_3, Test_B_4, Test_B_5) <= 3) && (sum(Test_C_1, Test_C_2, Test_C_3, Test_C_4, Test_C_5) <= 3)
You can also write this as follows, LimeSurvey automatically converting it at run-time to the above-listed expression.
(sum(self.sq_A) <= 3) && (sum(self.sq_B) <= 3) && (sum(self.sq_C) <= 3)
Download
To download the survey sample used in the above examples, click on the following link: ls2_test_em_sq_validation.lss.
Subquestion relevance
Overview
This shows how array_filter and validation criteria can interact. For validations that apply to sums, only relevant (visible) values are considered.
EM Features Demonstrated
It also shows dynamic reporting of the numbers of questions answered in the core questions.
Screenshots
Changing the number of visible rows dynamically changes the sum. Marking a subquestion as being irrelevant doesn't clear its value. Rather, if it is irrelevant, its values don't contribute to any equation.
Note what happens when we check the "Fifth subquestion" for the first question "Which rows should appear below". Note that the sum for the second "Enter some numbers" question is now 5. Even though subquestion 5 for that question still has the value 14 (e.g., if you un-check the fifth subquestion, you will see the value of 14 again), that value does not contribute to the sum since it is currently irrelevant. All irrelevant data is cleared (NULLed in the database) on submit, but it stays available on the page in case users want or need to change their minds about answers.
Download
To download our example, click here: ls2_subquestion_relevance.lss.
Using Comma as Radix Separator (Decimal Point)
Overview
The ExpressionScript ensures that only valid numbers can be entered into numeric fields. If you enter an invalid number, you will be warned that something is wrong (e.g., in the case of the fruity theme, the whole question is "red-ed").
Note that the numeric values are always converted to using a period as the radix separator within the database. In this way, the statistical analyses will work appropriately.
To change the radix separator, access the Text elements options located under the Settings tab, and look for the decimal mark functionality.
For more information on what a radix separator is, click [https://en.wikipedia.org/wiki/Radix_point
Question Types Using Radix Separator
- Numerical input [N]
- Multiple numerical input [K]
- Array (Numbers) [:]
- Array (Texts) [;], when using the numbers_only attribute
- List (radio) [L], when using the other_numbers_only attribute
- Short free text [S], when using the numbers_only attribute
- Multiple short text [Q], when using the numbers_only attribute
- Multiple choice [M], when using the other_numbers_only attribute
- Multiple choice with comments [P], when using the other_numbers_only attribute
Screenshots
You may note in the below screenshots that comma can be used as a radix separator.
Download
To download the above example, click on the following link: ls2_comma_as_radix_separator.lss.
Randomization Groups
Overview
This survey demonstrates how to make use of the random_group attribute.
If this attribute is used, each time you start the survey, the question order is randomized. However, once the survey is started, the randomization order remains fixed, even if you change languages.
Screenshots
Let's check together the below example. The first random question on the page will either be Q1 , Q4, or Q7. The second randomized question on the page will either be Q2, Q5, or Q8.
Here is the randomization generated the first time I tested this survey.
A different randomization was generated the second time I tested the survey.
But, when I switched to French (without re-starting the survey), the randomization order remained intact.
Download
To download the above example, click on the following link: Randomization_Group_Test.lss
Randomly Ask One Question Per Group
Overview
This survey shows how you can configure a survey to randomly display one question per group. In it, there are 5 groups of 6 questions each. At the outset, in Group 0, five hidden Equation questions, called ask1-ask5, are populated. Each one has the value of {floor(rand(1,6.9999))} in the question text field, which means that the variables ask1-ask5 will each have a value between 1 and 6. Then, each question in the group has a relevance equation like "ask1==N" where N is the Nth question in the group (so the third question in group 1 has the relevance equation "ask1==3").
This survey works equally well in survey-at-a-time, group-by-group, and question-by-question modes. Since the randomization is set in the first group, and that group is effectively hidden (since all of the ask1-ask5 questions are hidden), the randomization stays the same for the subject; but each different subject will have a distinct randomization.
Features Demonstrated
- Equation question type
- Randomization functions
- Conditional (if) function
Screenshots
This is Group0, which uses the Equation question type to select random values from 1 to 6 for each group (except the last group, which has only 4 questions). Note that the "if()" function first checks whether ask1 has already been set, and if so, uses that value. If the value hasn't been set, then it uses a random value to set the value of ask1.
This Group shows how the variable (ask4) from Group0 is used to control which question is visible within the fourth group.
Download
To download the above survey example, click here: Random questions within a group survey example.
Randomly Ask A Specific Number Of Questions In A Group (a subset of the questions)
This applies only to all random questions from one group and only if the Group by group or All in one format is used.
Overview
This survey shows how to ask a random subset of questions in a group. For example, show 5 random questions out of 10 questions located within a group.
The survey has one group containing 10 questions. All questions are assigned the same randomization group name. As a result, they will be displayed in a random order on page load. Each question is given a relevance equation that the sum of the "relevanceStatus" of all other questions in the group is less than the number of questions you want to show. Since relevanceStatus is assigned as questions are rendered, this effectively totals the number of preceding questions.
So, in our 5 out of 10 example, the equation for Q1 would be:
sum(Q2.relevanceStatus, Q3.relevanceStatus, Q4.relevanceStatus, Q5.relevanceStatus, Q6.relevanceStatus, Q7.relevanceStatus, Q8.relevanceStatus, Q9.relevanceStatus, Q10.relevanceStatus) LT 5
For Q2, it would be:
sum(Q1.relevanceStatus, Q3.relevanceStatus, Q4.relevanceStatus, Q5.relevanceStatus, Q6.relevanceStatus, Q7.relevanceStatus, Q8.relevanceStatus, Q9.relevanceStatus, Q10.relevanceStatus) LT 5
And so on...
Features Demonstrated
Download
To download the above example, click on the following link: Random 5 out of 10 survey example.
Rating User-Entered List of Products
Overview
The below example shows how you can ask users to list a set of products that interest them, and then have them rate those products.
EM Features Demonstrated
- Tailoring answers - when rating products, the labels come from the comment field of the preceding multiple choice question
- Tailoring scales - many advanced questions options, like scale headings, can also be tailored.
Screenshots
This image shows that even though only products 1,3, and 5 were selected, only those 3 are displayed (using the array_filter attribute). Moreover, the row labels in the second question are either the product numbers (if nothing is entered into the comment field) or the contents of the comment fields.
This image shows how the tailored answers are specified:
Here is the Show Logic File for that question, which lets us verify that the conditional logic works as desired (e.g., to see whether there are any syntax errors):
The next image shows a group in which you specify a 5 point rating scale (Options 1-5), the title of the scale, and the products you want to rate. The final question shows that each of the parts of the array question can be tailored:
The next image shows the logic file view of the last question. As you can observe, the subquestions, answers, and scale headers can be tailored.
Download
To download the survey example from above, click on the following link: Rating user-entered list of products survey example.