Actions

Difference between revisions of "ExpressionScript - Presentation/nl"

From LimeSurvey Manual

(Created page with "Je kunt het beste beginnen met EM door: *De meeste recente versie te downloaden van https://www.limesurvey.org/en/download. *Importeer en bekijk enkele ExpressionScript sam...")
Line 74: Line 74:
  
  
The best way to get started with the EM is to:
+
Je kunt het beste beginnen met EM door:
*Install the latest stable version from https://www.limesurvey.org/en/download.  
+
*De meeste recente versie te downloaden van https://www.limesurvey.org/en/download.  
*Import and explore some [[ExpressionScript sample surveys|sample surveys]].
+
*Importeer en bekijk enkele [[ExpressionScript sample surveys/nl|voorbeelden van enquêtes]].
*Explore the [[ExpressionScript How-tos|use cases and how-tos]], and the [[ExpressionScript examples|step-by-step examples]].
+
*Neem door de [[ExpressionScript How-tos/nl|use cases en uitleg over het gebruik]] en de [[ExpressionScript examples|voorbeelden]].
 
*Explore the EM documentation (this page)
 
*Explore the EM documentation (this page)
 
**Unit Tests of Isolated Expressions (advanced)
 
**Unit Tests of Isolated Expressions (advanced)

Revision as of 21:57, 22 May 2020

Other languages:
English • ‎Nederlands • ‎日本語


Inleiding

In LimeSurvey wordt de nieuwe module ExpressionScript (EM) gebruikt, waarmee LimeSurvey meer complexe vertakkingen, beoordelingen, validatie en maatwerk kan ondersteunen.  Het vervangt hoe LimeSurvey de vervangingen, condities en beoordelingen op het beheerdeel beheert. Doordat er nu ook minder wordt gelezen in de database, betekent het ook een snellere werking. EM is ontworpen door Dr. Thomas White (TMSWhite).


Definities

  1. Expressie: Alles tussen accolades:
    • As er tenminste geen spatie na de opening-accolade of voor de sluit-accolade staat.
    • De inhoud van de expressie wordt verwerkt door EM, het kan mathematische functies, functies en complexe tekst en datum verwerking bevatten.
  2. Maatwerk: Ook wel "tailoring" of "piping". Het metcondities wijzigen van tekst:
    • Er is toegang tot alle te vervangen velden, deelnemersgegevens en in de enquête ingevoerde gegevens.
    • Ook toegang tot vragen, antwoorden en hun eigenschappen.
  3. Relevantievergelijking: Een vraagattribuut dat zorgt voor het wel of niet tonen van de vraag:
    • als er een relevantievergelijking is dan wordt de vraag getoond als de uitkomst ervan 'true' is.
    • Intern, alle array_filter en array_filter_exclude commando's worden relevantie op subvraag-niveau.
  4. SGQA (oude naamgeving variabelen):
    • Staat voor Survey-Group-Question-Answer
    • SGQA variabele is bijvoorbeeld 123X5X382X971, er kan een achtervoegsel van de subvraag zijn.
    • Omdat deze namen samengesteld uit de onderliggende codes van de enquête, groep,vraag en subvraag kunnen ze soms gewijzigd moeten worden
  5. Vergelijking Een vraagtype waarmee een resultaat van een berekening of een rapport opgeslagen kunnen worden in de database:
    • Het is een Boilerplate vraag, het wordt opgeslagen ook als de vraag het attribuut 'altijd verbergen' heeft.
  6. Vraagcode: De voorkeursnaamgeving:
    • Dit is een beschrijvende naam wat dus het doel van de vraag aangeeft en wat de leesbaarheid gemakkelijker maakt bij complexe constructies..
    • Een vraagcode mag niet beginnen met een nummer, dus als je je vragen wilt nummeren gebruik dan "v1", of "v1a" of "v1q2" in plaats van alleen een volgnummer.
    • Dit wordt als naam van de variabele gebruikt bij exporteren naar SPSS of R. Zorg ervoor dat je alleen unieke codes gebruikt anders heb je weinig aan die vragen als je er later een analyse van wilt maken.


Moet ik EM gebruiken?

Nee, je hoeft EM niet te gebruiken, maar als je enquête wat meer complex wordt, dan is het wel handiger.

De Conditie-editor ondersteunt bijvoorbeeld ook wat eenvoudige expressies die je bij je vragen kunt gebruiken. In EM wordt veel meer ondersteund.


Kan ik zowel condities als relevantievergelijkingen gebruiken?

Ja. Je kunt bij de ene vraag de Conditie-editor gebruiken en bij een andere een Relevantievergelijking.

Maar je kunt ze niet beide in dezelfde vraag gebruiken! Als je een conditie maakt dan gaat de expressie in de relevantievergelijking verloren. Bovendien kan het veld van de relevantievergelijking niet meer handmatig worden aangepast.

Met wat rommelen kan het je wel lukken, maar waarom zou je dat willen. Je moet dan de relevantievergelijking in een editor bewaren. Verwijder dan de nieuwe conditie in de Conditie-editor en wijzig de vraag door de expressie van de conditie gecombineerd met de bewaarde relevantievergelijking in te vullen.


Kiezen tussen conditie en relevantie

Een lijst van voordelen en nadelen van beide:

Style Voor Tegen
Condities 1. Mooie GUI voor aanmaken van eenvoudige condities.
2. GUI goede documentatie en ondersteuning
1. Alleen simpele vergelijkingen en matige "AND" of "OR" condities.
2. Nesten condities kan problemen geven
3. Langzaam, veel gebruik database bij grote enquêtes.
4. Er zijn soms problemen met herladen van condities.
5. GUI matig schalen bij dozijn, honderd of duizend vragen.
6. Langzamere conversie bij papieren enquêtes omdat er SGQA namen gebruikt moeten worden.
7. Bij complexe vertakkingen kan alleen een ervaren persoon het aanpassen.
Relevantie 1. Ondersteunt erg complexe logica met meer dan 80 ingebouwde functies en mathematische / tekst operatoren.
2. Perfecte ondersteuning in trapsgewijze logica.
3. Snel, geen extra aanroepen database, ondersteunt enquête met 1000+ vragen.
4. Herladen werkt prima omdat er geen SGQA-codes nodig zijn.
5. Syntax-highlighting schaalt tot een enquête mer meer dan 1000 vragen.
6. Gemakkelijk en eenvoudig voor groepen de papieren enquêtes willen verwerken.
7. Ondersteunt semi-gestructureerde interviews en epidemiologische enquête zonder dat je een programmeur nodig hebt.
1. Geen GUI voor eenvoudige condities - het maakt gebruikt van syntax-highlighting.


Help.png NB:


Beginnen

Je kunt het beste beginnen met EM door:

Terminologie

These words are commonly used to describe the capabilities of the EM:

  • Relevance-based Branching - if a question is relevant, then ask it, otherwise don't (e.g., make it invisible and mark it as NULL in the database). You may find the Relevance fields in the question editor panel as well as in the question group editor panel. The later is used to apply a set of conditions to an entire group without having to copy the same condition to each question, and/or combine group and question-level conditional logic).
  • Tailoring - Once you know which questions should be asked, tailoring (sometimes called piping) specifies how the question should be asked. This lets you support not only simple substitution (like {TOKEN:FIRSTNAME}), but also conjugation of verbs and declination of nouns based upon the gender or number of your subjects. It also lets you change the message you deliver to a survey respondent based upon whether they answered (or how they answered) other questions.
  • Equations - EM adds a new question type called Equation which stores the result of an Expression. The equation results are computed and written to the database, even if you hide them on the page. Thus, they are used for hidden scoring calculations, navigation based upon complex equations, assessments, and reports that will be generated and stored within the database.


Relevantie en trapsgewijze relevantie

Elk vraagtype heeft een optie relevantie die bepaald of de vraag moet worden gesteld. Ze worden verwerkt in de volgorde dat ze in de enquête staan. Als de expressie waar is (of ontbreekt, dit om oudere enquêtes te blijven ondersteunen) dan wordt de vraag gesteld. Als de vraag niet gesteld wordt dan wordt de waarde NULL opgeslagen. Als er geen enkele relevante vraag in de groep is, dan wordt de hele groep overgeslagen.

Als een van de variabelen in de expressie niet relevant is, dan is die vraag niet relevant. Dit is dus een trapsgewijze relevantie waardoor je niet hele lange relevantievergelijkingen voor elke vraag hoeft te schrijven.

Stel je hebt 5 vragen Q1-Q5, en je wilt alleen vraag Q2 stellen als vraag Q1 beantwoord is. Ook wil je vraag Q3 alleen stellen als vraag Q2 beantwoord is.  De relevantievergelijkingen kunnen dan zijn:

Vraag Code Relevantie Vraag
Q1 1 Wat is uw naam?
Q2 Q1 {Q1}, hoe oud bent u?
Q3 Q2 Dus u bent {Q2} jaar oud.  Bent u getrouwd?
Q4 Q3 == "Y" {Q1}, hoelang bent u getrouwd?
Q5 Q4 Hoeveel kinderen heeft u, {Q1}?


Relevantie op groepsniveau

ExpressionScript also supports group-level relevance. This makes it easier to implement looping. Say you want to collect information from up to 10 entities (such as products or people from a household), where you first determine how many entities need follow-up (such as by asking how many people live in a household or having people check which products they like from a long list). After knowing how many entities need follow-up, you can use Group-level relevance like {count >= 1}, {count >=2}, ... {count >= 10} for each of the 10 groups of follow-up questions. Within each group, you can have question-level conditional logic (e.g., gender or age-specific follow-up questions for each subject). The question and group-level relevance equations are ANDed together to determine which should be shown.

We hebben een voorbeeld, dat je kunt importeren.

In de onderstaande afbeelding kun je zien dat de groep Person 1 relevant is als de deelnemer samenleeft met minstens een ander persoon:


Group-level relevance example screen.png


Maatwerk

Alles tussen accolades wordt beschouwd als een expressie (met een uitzondering die hieronder wordt beschreven). Expressies kunnen beschikken over alle vervangingsvelden, alle variabelen (via verschillende aliassen), alle vergelijkingsoperatoren (rekenkundig, logisch en vergelijkend) en veel functies (die ook dynamisch op de server uitgevoerd kunnen worden).

Met deze vergelijkingen kun je dingen doen als:

  1. Conditioneel tonen van op maat gesneden berichten aan de respondenten die gebaseerd zijn op antwoorden op voorafgaande vragen.
  2. Beoordelingen maken en de resultaten daarvan conditioneel tonen (of conditioneel een vertakking maken), alles zonder de module beoordeling te gebruiken.
  3. De goede werkwoordsnormen en zelfstandige naamwoorden gebruiken in vragen, antwoorden en rapporten.
  4. Tonen van samenvattingen van antwoorden bij het einde van de enquête.


Vergelijkingen

Er is een vraagtype Vergelijking toegevoegd. Het lijkt op het Tekst scherm vraagtype, maar bij het nieuwe vraagtype wordt de waarde of wat er wordt getoond, opgeslagen in de database. Dus, als de tekst van een vergelijking vraag een berekening van een beoordeling bevat, dan wordt die waarde opgeslagen in een variabele die getoond kan worden bij statistieken.


Syntax

De uitzondering op dat alles tussen accolades een expressie is, is dat er geen spatie(s) na de begin-accolade en voor de sluit-accolade mogen staan. Dit is nodig om te voorkomen dat ExpressionScript probeert JavaScript te gaan verwerken.

NB: Expressies mogen meerdere regels bevatten, zolang er maar geen spaties staan na een openingshaakje of voor een sluithaakje. Een voorbeeld met een genest if( ) statement:

{if(is_empty(PFTotals),
 '',
 if(PFTotals >= -5 && PFTotals <= -4,
   'Heel weinig',
   if(PFTotals >= -3 && PFTotals <= -2,
     'Weinig',
     if(PFTotals == -1,
       'Minder dan normaal',
       if(PFTotals == 0,
         'Normaal',
         if(PFTotals == 1,
           'Meer dan normaal',
           if(PFTotals >= 2 && PFTotals <= 3,
             'Veel',
             if(PFTotals >= 4 && PFTotals <= 5,
               'Heel veel',
               ''
             )
           )
         )
       )
     )
   )
 )
)}

The ExpressionScript supports the following syntax:

  • All standard mathematical operators (e.g. +,-,*,/,!);
  • All standard comparison operators (e.g. <,<=,==,!=,>,>=, plus their equivalents: lt, le, eq, ne, gt, ge);
  • Parentheses (so you can group sub-expressions);
  • Conditional operators (e.g. &&,| | and their equivalents: and, or);
  • Single and double-quoted strings (which can each embed strings with the other quote type);
  • Comma operator (so can have a list of expressions and just return the final result);
  • Assignment operator (=);
  • Pre-defined variables (to refer to questions, question attributes, and responses) - e.g., the SGQA codes;
  • Pre-defined functions (there are already 80+, and it is easy to add more).


Operatoren

De volgorde van verwerken van operatoren is normaal.

Niveau Operator(en) Beschrijving
1 () haakjes voor groepen en functies
2 ! - + een varibele: not, negation, unary-plus
3 * / vermenigvuldigen, delen
4 + - optellen,aftrekken
5 < <= > >= lt le gt ge relatieve vergelijkingen
6 == != eq ne gelijkheid vergelijkingen
7 and logische AND
8 or logische OR
9 = toekennen operator
10 , komma operator
Help.png Om JavaScript en PHP gelijk te laten werken, werkt de plus operator (+) als optellen als beide velden numeriek zijn en als samenvoegen als beide velden niet numeriek (strings) zijn. Je kunt beter de join( ) functie gebruiken voor het samenvoegen want dan is de bedoeling duidelijker en voorkomt onverwachte resultaten als de invoer afwijkt van wat je verwacht.

Waarschuwing met niet-overeenkomend nummer en string en alfabetische / numerieke vergelijking

Wanneer je waarden wilt vergelijken met relatieve of gelijkheid, let dan op mismatch. De door de gebruiker ingevoerde waarde of de geselecteerde antwoordcode kan als getal worden gebruikt als het duidelijk een getal is. Als je een van de waarden omringt met " : forceer je een vergelijking als tekst. Als je wilt vergelijken als getal, zet het getal dan niet tussen " .

Voorbeeld: Q0.NAOK > "50" is TRUE als Q0.NAOK een numerieke vraag is met 9 als waarde. Dit komt omdat de operator > ervan uitgaat dat het een alfabetische vergelijking is en dus geen numerieke vergelijking.

Om er zeker van te zijn dat de invoer als getallen worden vergeleken kun je het volgende doen intval(Q0.NAOK) > 50, bedenk dat als Q0.NAOK geen getal is (leeg of een string), dat dan intval(Q0.NAOK) === 0. Gebruik om als strings te vergelijken ("A" < "B") strcmp : strcmp(Q0.NAOK,"B") of strcmp(Q0.NAOK,"A5").

Uitkijken met gebruik operator (=)

You should avoid using the assignment operators unless absolutely necessary, since they may cause unexpected side-effects. For example, if you change the value of a previous response, the cascading relevance and validation logic between that question and the current question is not re-computed, so you could end up with internally inconsistent data (e.g., questions that stay answered but should have been NULLed, or questions that are skipped but should have been answered). In general, if you want to assign a value to a variable, you should create an Equation question type, and use an expression to set its value. However, there are some rare times that people really need this operator, so we made it available.

Om het gebruik van de operator toekennen wat duidelijker aan te geven, tonen we het in rode tekst in de syntaxvergelijking. (Verwar deze operator niet met de gelijkheidsvergelijking "==".)


Example assignment operator.png


Gebruik toekenningsoperator

De belangrijkste redenen om deze operator te gebruiken:

  • Je wilt een standaardwaarde zetten voor een vraag, waar dat niet met een expressie kan (een radiolijst, waar kun je een van de antwoorden selecteren maar geen vergelijking kan invoeren).  Wees voorzichtig, want LimeSurvey kan niet valideren dat je vergelijking een goed antwoord voor die vraag oplevert.
  • Je wilt het antwoord van een vorige vraag aanpassen op grond van een later gegeven antwoord.
  • enz.


Important.png
  Attentie : De toekenning wordt alleen in PHP gedaan. Dit betekent dat de waarde niet op dezelfde pagina wordt bijgewerkt, maar pas wanneer de gebruiker naar een andere pagina gaat. Let daarom op wanneer de operator op dezelfde pagina wordt gebruikt met andere expressies.


Je kunt voor dit doel ExpressionScript gebruiken, maar het is beter om het vraagtype vergelijking te gebruiken.

Voorbeeld:

  • Zet het antwoord op een korte tekstvraag in kleine letters : {QCODE=strtolower(QCODE.NAOK)}
  • Zet een standaardantwoord voor het vraagtype array bij het starten van de enquête : {Q1_SQ1=(is_empty(Q1_SQ1.NAOK),"A99",Q1_SQ1.NAOK)}
  • Zet een standaardantwoord voor het vraagtype array (tekst) bij het begin van de enquête : {Q1_SQY1_SQX1 = (is_empty(Q1_SQY1_SQX1.NAOK),"Inserted answer", Q1_SQY1_SQX1.NAOK)}
  • Zet een conditie op een antwoord: {QCODE=if(YesNo="Y","A1","")}

XSS beveiliging

Als XSS is ingeschakeld kunnen enkele delen van ExpressionScript niet worden gebruikt:

  • een HTML-tag in een expressie laten starten en in een andere afsluiten.
  • een URL in de expressie.


Help.png NB: standaard iS XSS ingeschakeld!


Voorbeeld en alternatief

  • {if( 1 ,"<strong>","")}information{if( 1, "</strong>","")} is gebroken met XSS-beveiliging, je kunt hier gebruiken {if(1,"<strong>information</strong>","information")}
  • <a href="/script.php?value={if(QCODE == "Y","yes","no")}">next</a>, hier kun je een vergelijkingsvraag gebruiken omdat een het gebruik van een volledige vraagcode is toegestaan : <a href="/script.php?value={EQUATION.NAOK}">next</a>


Toegang tot variabelen

ExpressionScript geeft alleen leesrecht op de beschikbare variabelen. Om voorgaande versies te blijven ondersteunen, is er toegang tot:

  • TOKEN:xxx - de waarde van een TOKEN (bijvoorbeeld TOKEN:FIRSTNAME (voornaam), TOKEN:ATTRIBUTE_5 (attribuut_5)) (Alleen voor NIET anonieme enquêtes.)
  • |INSERTANS:SGQA - de te tonen waarde van een antwoord, bijvoorbeeld "Ja". Gelijk aan het gebruik van {QCODE.shown}.
  • Alle {XXX} waarden gebruikt in sjablonen
  • In de vraagtekst, kun je {QID} gebruiken voor het ID van de vraag en {SGQ} voor de SGQA van de vraag.

In addition, ExpressionScript lets you refer to variables by the Question Code (the 'title' column in the questions table within the database). This is also the variable label used when you export your data to SPSS, R, or SAS. For example, if you have questions about name, age, and gender, you could call those variables name, age, and gender instead of 12345X13X22, 12345X13X23, and 12345X13X24. This makes equations easier for everyone to read and validate the logic, plus making it possible to shuffle questions around without having to keep track of group or question numbers.

Belangrijk: Het is veiliger om alleen variabelen te gebruiken die op voorgaande pagina's of vragen aangemaakt zijn.

Je kunt verder nog de eigenschappen van de vraag lezen:


Syntax Meaning Example Example Result
Qcode an alias for Qcode.code {implode(',',name,gender)} 'Tom','M'
Qcode.code the selected response code for the question if it is relevant (otherwise blank), or the text value if it is not a coded question {implode(',',name.code,gender.code)} 'Tom','M'
Qcode.NAOK same as Qcode - see discussion of NAOK {gender.NAOK} 'M'
Qcode.value the assessment value for the question if it is relevant (otherwise blank), or the text value if it is not a coded question {gender.value} '1'
Qcode.valueNAOK same as Qcode.value - see discussion about NAOK {gender.valueNAOK} '1'
Qcode.shown the display value for the question {implode(',',name.shown,gender.shown)} 'Tom','Male'
Qcode.question the text of the question {gender.question} 'What is your gender?'
Qcode.mandatory whether the question is mandatory (Y/N) {gender.mandatory} 'N'
Qcode.qid the internal question number (not the sequential number) {gender.qid} 337
Qcode.type the question type {gender.type} 'G'
Qcode.jsName the correct javascript name for the question, regardless whether declared on or off this page {gender.jsName} 'java1827X3X337'
Qcode.gid the internal group number (not the sequential number) {gender.gid} 3
Qcode.qseq the sequential number of the question, starting from 0 {gender.qseq} 5
Qcode.gseq the sequential number of the group, starting from 0 {gender.gseq} 1
Qcode.relevanceStatus whether the question is currently relevant (0 or 1) {gender.relevanceStatus} 1
Qcode.relevance the question-level relevance equation {gender.relevance} '!is_empty(name)'
Qcode.grelevance the  group-level relevance equation {gender.grelevance} 'num_children >= 5'
Qcode.sgqa the SGQA value for this question {gender.sgqa} '1827X3X337'


HTML-editor probleem

Als je de HTML-editor gebruikt worden sommige tekens vervangen door HTML.

  • & door &amp;
  • < door &lt;
  • > door &gt;

Als je de HTML-editor gebruikt, gebruik dan:

  • and voor &
  • lt voor <
  • le voor <=
  • gt voor >
  • ge voor >=


Wij raden aan dat je in je expressie geen HTML gebruikt. Als je de LimeSurvey HTML-editor gebruikt, klik dan op de knop "Source" (linksboven) en verwijder alle tekens die niet bij je expressie horen (bijv.:

,
, ...).

Naamgeving Qcode Variabele

Dit zijn de details per vraagtype die je nodig hebt om een Qcode te maken (en enkele eigenschappen te benaderen).  In het algemeen worden Qcodes samengesteld als volgt:

 VraagCode . '_' . SubvraagID . '_' . SchaalId

Voor commentaar en anders zijn de overeenkomende vraagcodes resp. VraagCode_comment en VraagCode_other.

Type Description Code SubQs Answer Options Scales Answer Code Answer Shown Relevance
5 5 Point Choice Radio-Buttons Q1 1-5 {Q1} {Q1.shown} {Q1==3}
B Array (10 Point Choice) Radio-Buttons Q2 L1-L6 1-10 {Q2_L2} {Q2_L2.shown} {Q2_L2==7}
A Array (5 Point Choice) Radio-Buttons Q3 1-5 1-5 {Q3_1} {Q3_1.shown} {Q3_1>=3}
1 Array (Flexible Labels) Dual Scale Q4 sq1-sq5 0:a1-a3 1:b1-b3 {Q4_sq1_0} {Q4_sq1_1.shown} {Q4_sq1_1=='b2'}
H Array (Flexible) - Column Format Q5 1-5 s,m,t {Q5_1} {Q5_1.shown} {Q5_1=='s'}
F Array (Flexible) - Row Format Q6 F1-F5 1-5 {Q6_F3} {Q6_F3.shown} {Q6_F3==4}
E Array (Increase/Same/Decrease) Radio-Buttons Q7 1-7 I,S,D {Q7_4} {Q7_4.shown} {Q7_4=='D'}
: Array (Multi Flexi) 1 To 10 Q8 ls1,todo,ls2 min,max,avg {Q8_ls1_max} {Q8_ls2_avg.shown} {Q8_ls2_min==7}
; Array (Multi Flexi) Text Q9 hp,st,sw 1st,2nd,3rd {Q9_hp_3rd} {Q9_hp_3rd.shown} {Q9_hp_3rd=='Peter'}
C Array (Yes/Uncertain/No) Radio-Buttons Q10 1-5 Y,N,U {Q10_1} {Q10_1.shown} {Q10_3=='Y'}
X Boilerplate Question Q11 {Q11.shown}
D Date Q12 {Q12} {Q12.shown}
* Equation Q13 {Q13} {Q13.shown} {Q13>5}
~124~ File Upload (records number of files uploaded) Q14 {Q14} {Q14>0}
G Gender Drop-Down List Q15 M,F {Q15} {Q15.shown} {Q15=='M'}
U Huge Free Text Q16 {Q16} {Q16.shown} {strlen(Q16)>100}
I Language Question Q17 {Q17} {Q17.shown} {Q17=='en'}
! List - Dropdown Q18 1-5 {Q18} {Q18.shown} {Q18==3}
L List Drop-Down/Radio-Button List Q19 A-Z {Q19} {Q19.shown} {Q19=='X'}
O List With Comment Drop-Down/Radio-Button List + Textarea Q20 A-F {Q20},{Q20comment} {Q20.shown} {Q20=='B'}
T Long Free Text Q21 {Q21} {Q21.shown} {strstr(Q21,'hello')>0}
M Multiple Choice Checkbox Q22 A-F, other {Q22_E}, {Q22_other} {Q22_E.shown}, {Q22_other.shown} {Q22_E=='Y'}
P Multiple Choice With Comments Checkbox + Text Q23 A-F {Q23_D}, {Q23_Dcomment} {Q23_D.shown} {!is_empty(Q23)}
K Multiple Numerical Question Q24 self,mom,dad {Q24_self} {Q24_self.shown} {Q24_self>30}
Q Multiple Short Text Q25 A-F {Q25_B} {Q25_B.shown} {substr(Q25_B,1,1)=='Q'}
N Numerical Question Type Q26 {Q26} {Q26.shown} {Q26 > 30}
R Ranking Style Q27 1-4 {Q27_1} {Q27_1.shown} {Q27_1==3}
S Short Free Text Q28 {Q28} {Q28.shown} {Q28=='mine'}
Y Yes/No Radio-Buttons Q29 {Q29} {Q29.shown} {Q29=='Y'}


Het gebruik van NAOK

NAOK --> "Not Applicable" (Niet van toepassing) is OK (goed)


Bij gebruik van NAOK zijn sommige variabelen niet meer van belang, ("Not Applicable OK").

Voorbeeld : count(Q1_SQ1,Q1_SQ2,Q1_SQ3,Q1_SQ4) geeft altijd een lege string als een subvraag van Q1 wordt gefilterd. Om het aantal gecontroleerde subvragen in dergelijke vraag te tellen: count(Q1_SQ1.NAOK,Q1_SQ2.NAOK,Q1_SQ3.NAOK,Q1_SQ4.NAOK). Indien de subvraag is verborgen heeft ExpressionScript een lege string terug.

Zonder NAOK : als een vraag of een subvraag is verborgen, geeft ExpressionScript een lege string terug, dat komt overeen met false.

Bij .shown wordt altijd het NAOK-systeem gebruikt (lege string als verborgen). Als u de antwoordcode wilt hebben, is het altijd goed om .NAOK toe te voegen aan de vraagcode.

Meer informatie over overriding trapsgewijze condities.


Gereserveerde variabelen ('this','self','that')

Je wilt vrij vaak alle delen van een vraag evalueren, zoals hoeveel subvragen zijn beantwoord of de totalen van de scores bepalen. Soms wil je alleen bepaalde rijen of kolommen verwerken van een vraag (bepalen van de som van een rij en kolom en dat getal opslaan in de database).  De gereserveerde variabelen vereenvoudigen dat.


"This" variabele

De "this" variabele wordt alleen gebruikt in de opties "hele vraag validatievergelijking" en "subvraag validatievergelijking" (de laatste kan niet via de GUI). Het wordt geëxpandeerd naar de variabele-namen voor elke cel binnen die vergelijkingen. Als je dus wilt controleren of elke invoer groter dan drie is, dan kun je de "Subvraag validatievergelijking" zetten op (this > 3).


"Self" variabele

De "self" en "that" variabele zijn krachtiger, ze zijn macro's die uitgevoerd worden voordat de vergelijkingen verwerkt worden.  De syntax is:

  • self
  • self.suffix
  • self.sub-selector
  • self.sub-selector.suffix
  1. suffix is een van de normale qcode achtervoegsels (NAOK, value, shown)
  1. sub-selector can be one of the following:
  • comments - only subquestions that are comments (e.g., multiple choice with comment and list with comment);
  • nocomments - only subquestions that are not comments;
  • sq_X - where X is a row or column identifier.  Only subquestions matching pattern X are selected. Note that search is done on complete code identifier, then sq_X match and include subquestions nX, X, Xn (e.g. if you use sq_1, subquestions a1, 1a, 1, 11 or 001 was included). Put attention at dual scale question type where subquestions code are QCODE_SQCODE_1 and QCODE_SQCODE_1 and to ranking question type where subquestions code are QCODE_1,QCODE_2 ....

Voorbeelden:

  • Is elk deel van de vraag beantwoord?  {count(self.NAOK)>0}
  • Wat is de beoordelingsscore voor deze vraag?  {sum(self.value)}

Je kunt dit ook gebruiken om rij- en kolomtotalen te bepalen.  Stel je hebt een array met rijen A-E en kolommen 1-5.

  • Wat is het totaal?  {sum(self.NAOK)}
  • Wat is het totaal van rij B?  {sum(self.sq_B.NAOK)}
  • Wat is het totaal van kolom 3? {sum(self.sq_3.NAOK)}


"That" variabele

De "that" variabele is als de "self" variabele, maar je kunt refereren aan andere vragen. De syntax is:

  • that.qname
  • that.qname.suffix
  • that.qname.sub-selector
  • that.qname.sub-selector.suffix

qname is de naam van de vraag zonder de extensie van een subvraag.  Dus als een je vraag 'q1' hebt, dan is dat de qname.

Voorbeelden:

  • Is elk deel van de vraag q1 beantwoord?  {count(that.q1.NAOK)>0}
  • Wat is de beoordelingsscore voor q2?  {sum(that.q2.NAOK)}
  • Wat is het totaal van q3? {sum(that.q3.NAOK)}
  • Wat is het totaal van rij C in q4?  {sum(that.q4.sq_C.NAOK)}
  • Wat is het totaal van kolom 2 in q4? {sum(that.q4.sq_2.NAOK)}

De self en that variabelen kunnen worden gebruikt in elke relevantie, validatie of maatwerk.

De valkuil is dat als je toon logica bestand gebruikt, je dan de geëxpandeerde waarde ziet van "self" en "that".  Je ziet dan dus de actuele vergelijking die gegenereerd wordt zodat je (en EM) kunt valideren of de variabelen bestaan. Omdat je dan hele lange vergelijkingen kunt zien, kan dat verwarrend zijn. Als je de vraag gaat wijzigen, zie je wel de originele vergelijking met de variabelen "self" en/of "that".

Help.png Je moet deze variabelen niet gebruiken als je
  • expliciet elke variabele in de vergelijking wilt benoemen, of
  • variabelen gebruikt zonder subvragen.
In die gevallen is het gebruik van 'that' wat nutteloos, en loop je het risico op onverwachte resultaten.

Toegang tot functies

ExpressionScript ondersteunt het gebruik van de onderstaande functies inclusief door de gebruiker gedefinieerde functies. Je kunt dus zelf functies toevoegen. Het heeft PHP en JavaScript tegenhangers voor de onderstaande functies, zodat ze op de server (PHP) en de cliënt (JavaScript) gelijk werken. Je kunt eenvoudig functies toevoegen.


Geïmplementeerde functies

De volgende functies zijn beschikbaar:

Function Meaning Syntax
abs Absolute value number abs(number)
acos Arc cosine number acos(number)
addslashes Quote string with slashes string addslashes(string)
asin Arc sine number asin(number)
atan Arc tangent number atan(number)
atan2 Arc tangent of two variables number atan2(number, number)
ceil Round fractions up number ceil(number)
checkdate Returns true(1) if it is a valid date in gregorian calendar bool checkdate(month,day,year)
convert_value Convert a numerical value using a inputTable and outputTable of numerical values number convert_value(fValue, iStrict, sTranslateFromList, sTranslateToList)
cos Cosine number cos(number)
count count the number of answered (non-blank) questions in the list number count(arg1, arg12, ..., argN)
countif Count the number of answered questions in the list equal to the first argument number countif(matches, arg1, arg2, ... argN)
countifop Count the number of answered questions in the list which pass the criteria (arg op value) number countifop(op, value, arg1, arg2, ... argN)
date Format a local date/time string date(format [, timestamp=time()])
exp Calculates the exponent of e number exp(number)
fixnum Display numbers with comma as radix separator, if needed string fixnum(number)
floor Round fractions down number floor(number)
gmdate Format a GMT date/time string gmdate(format [, timestamp=time()])
html_entity_decode Convert all HTML entities to their applicable characters (always uses ENT_QUOTES and UTF-8) string html_entity_decode(string)
htmlentities Convert all applicable characters to HTML entities (always uses ENT_QUOTES and UTF-8) string htmlentities(string)
expr_mgr_htmlspecialchars Convert special characters to HTML entities (always uses ENT_QUOTES and UTF-8) string htmlspecialchars(string)
expr_mgr_htmlspecialchars_decode Convert special HTML entities back to characters (always uses ENT_QUOTES and UTF-8) string htmlspecialchars_decode(string)
idate Format a local time/date as integer string idate(string [, timestamp=time()])
if Excel-style if(test,result_if_true,result_if_false) if(test,result_if_true,result_if_false)
implode Join array elements with a string string implode(glue,arg1,arg2,...,argN)
intval Get the integer value of a variable int intval(number [, base=10])
is_empty Determine whether a variable is considered to be empty bool is_empty(var)
is_float Finds whether the type of a variable is float bool is_float(var)
is_int Find whether the type of a variable is integer bool is_int(var)
is_nan Finds whether a value is not a number bool is_nan(var)
is_null Finds whether a variable is NULL bool is_null(var)
is_numeric Finds whether a variable is a number or a numeric string bool is_numeric(var)
is_string Find whether the type of a variable is string bool is_string(var)
join (New in 2.0 build 130129) Join elements as a new string join(arg1, arg2, ... argN)
list Return comma-separated list of non-blank values string list(arg1, arg2, ... argN)
listifop (New in 3.16.1 ) Return a 'glue'-separated list of the specified question property (retProp) from questions in the list which pass the criteria (cmpProp op value) string listifop(cmpProp, op, value, retProp, glue, sgqa1, sgqa2, ... sgqaN)
ltrim Strip whitespace (or other characters) from the beginning of a string string ltrim(string [, charlist])
max Find highest value number max(arg1, arg2, ... argN)
min Find lowest value number min(arg1, arg2, ... argN)
mktime Get UNIX timestamp for a date (each of the 6 arguments are optional) number mktime([hour [, minute [, second [, month [, day [, year ]]]]]])
modulo-function The modulo function is not supported yet. You can use the floor() function instead floor(x/y)==(x/y)
nl2br Inserts HTML line breaks before all newlines in a string string nl2br(string)
number_format Format a number with grouped thousands string number_format(number)
pi Get value of pi number pi()
pow Exponential expression number pow(base, exp)
quoted_printable_decode Convert a quoted-printable string to an 8 bit string string quoted_printable_decode(string)
quoted_printable_encode Convert a 8 bit string to a quoted-printable string string quoted_printable_encode(string)
quotemeta Quote meta characters string quotemeta(string)
rand Generate a random integer, see this example int rand() OR int rand(min, max)
regexMatch compare a string to a regular expression bool regexMatch(pattern,input)
round Rounds a number to an optional precision number round(val [, precision])
rtrim Strip whitespace (or other characters) from the end of a string string rtrim(string [, charlist])
sin Sine number sin(arg)
sprintf Return a formatted string string sprintf(format, arg1, arg2, ... argN)
sqrt Square root number sqrt(arg)
stddev Calculate the Sample Standard Deviation for the list of numbers number stddev(arg1, arg2, ... argN)
str_pad Pad a string to a certain length with another string string str_pad(input, pad_length [, pad_string])
str_repeat Repeat a string string str_repeat(input, multiplier)
str_replace Replace all occurrences of the search string with the replacement string string str_replace(search, replace, subject)
strcasecmp Binary safe case-insensitive string comparison int strcasecmp(str1, str2)
strcmp Binary safe string comparison int strcmp(str1, str2)
strip_tags Strip HTML and PHP tags from a string string strip_tags(str, allowable_tags)
stripos Find position of first occurrence of a case-insensitive unicode string (starting by 0, return false if not found) int stripos(haystack, needle [, offset=0])
stripslashes Un-quotes a quoted string string stripslashes(string)
stristr Case-insensitive strstr string stristr(haystack, needle [, before_needle=false])
strlen Get string length int strlen(string)
strpos Find position of first occurrence of an unicode string (starting by 0, return false if not found) int strpos(haystack, needle [ offset=0])
strrev Reverse a string string strrev(string)
strstr Find first occurrence of a string string strstr(haystack, needle[, before_needle=false])
strtolower Make a string lowercase string strtolower(string)
strtotime Parse about any English textual datetime description into a Unix timestamp int strtotime(string)
strtoupper Make a string uppercase string strtoupper(string)
substr Return part of an unicode string string substr(string, start [, length])
sum Calculate the sum of values in an array number sum(arg1, arg2, ... argN)
sumifop Sum the values of answered questions in the list which pass the criteria (arg op value) number sumifop(op, value, arg1, arg2, ... argN)
tan Tangent number tan(arg)
time Return current UNIX timestamp number time()
trim Strip whitespace (or other characters) from the beginning and end of a string string trim(string [, charlist])
ucwords Uppercase the first character of each word in a string string ucwords(string)
unique Returns true if all non-empty responses are unique boolean unique(arg1, ..., argN)
Help.png Klik hier voor een uitleg over functies die nog ontwikkeld worden (of worden overwogen).

Functie in expressie aanmaken met plugin (Nieuw in 4.0.0)

Als je een functie in een expressie nodig hebt die nog niet bestaat dan kun je deze zelf aanmaken met een plugin. Hiervoor is het event expressionManagerStart beschikbaar.

ExpressieScript weet wat de lokale variabelen zijn

Om de JavaScript op een pagina goed op te bouwen, moet EM weten welke variabelen op de pagina staan en wat hun JavaScript-id is (bijvoorbeeld voor document.getElementById(x)).  Het moet ook weten welke variabelen op andere pagina's worden gebruikt (zodat het zeker is dat de nodige <input type='hidden' value='x'> velden aanwezig en gevuld zijn).


Trapsgewijze condities

Als een van de variabelen niet relevant is, wordt de hele vergelijking niet relevant (false).  Bijvoorbeeld, in de onderstaande tabel betekent N/A dat een van de variabelen niet relevant was.


Operator Example a b Result
+ (unary) +a N/A false
! !a N/A false
== (or eq) a == b N/A 5 false
== (or eq) a == b N/A 0 false
== (or eq) a == b N/A N/A false
!= (or ne) a != b N/A 5 false
!= (or ne) a != b N/A N/A false
!= (or ne) a != b N/A 0 false
> (or gt) a > b N/A 5 false
>= (or ge) a >= b N/A 5 false
< (or lt) a < b N/A 5 false
<= (or le) a <= b N/A 5 false
and a and b N/A 5 false
and a and b N/A N/A false
or a or b N/A N/A false
or a or b N/A 5 false
+ a + b N/A 5 false
* a * b N/A 5 false
/ a / b 5 N/A false
() (a) N/A false
(exp) (a && b) N/A 5 false
(exp) op (exp) (b + b) > (a && b) N/A 5 false
function sum(a,b,b) N/A 5 false
function max(a,b) N/A 5 false
function min(a,b) N/A 5 false
function implode(', ',a,b,a,b) N/A 5 false
function if(a,a,b) N/A 5 false
function is_empty(a) N/A false
function is_empty(a) 0 (or blank) true
function !is_empty(a) N/A false


Overslaan trapsgewijze condities

Stel je wilt een lopend totaal tonen van alle relevante antwoorden.  Je kunt de vergelijking {sum(q1,q2,q3,...,qN)} proberen.  Echter dit wordt intern vertaald naar LEMif(LEManyNA('q1','q2','q3',...,'qN'),,sum(LEMval('q1'),LEMval('q2'),LEMval('q3'),...,LEMval('qN'))).  Dus als een van de waarden q1-qN niet relevant is, krijg je altijd als resultaat false.  De sum() is zolang niet alle vragen zijn beantwoord altijd 0.

Om dit probleem te voorkomen, kan elke variabele een achtervoegsel ".NAOK" krijgen (dat betekent dat niet toepasbaar goed is Not Applicable is OK). Dat leidt dan tot het volgende gedrag.  Stel je hebt een variabele q1.NAOK

  1. q1 wordt niet toegevoegd aan de LEManyNA() clause
  2. LEMval('q1') blijft controleren of het antwoord relevant is en geeft "" terug als het niet relevant is (dus individuele niet relevante antwoorden worden overgeslagen, maar ze hebben geen invloed op de gehele expressie).

Dus de te gebruiken vergelijking voor het lopende totaal is: sum(q1.NAOK,q2.NAOK,q3.NAOK,...,qN.NAOK).

The use of the .NAOK suffix also lets authors design surveys that have several possible paths but then converge on common paths later. For example, say subjects answer a survey in a way that is outside the normal range of responses. The author could alert the subjects that they may not get valid results, and ask them whether they really want to continue with the survey. If they say "Yes", then the rest of the questions will be shown. The condition for the "rest of the questions" would check whether the initial responses were answered within the normal range OR whether the subject said "Yes" to the question that is only relevant if they answered outside the normal range.

Hoe wordt conditioneel micro-maatwerk ondersteund?

Dit is een voorbeeld van micro-maatwerk (waar Vraagtype == 'expr' betekent als het vraagtype vergelijking is):


Question Code Relevance Question Type Question
name 1 text What is your name?
age 1 text How old are you?
badage !is_empty(age) expr {(age<16) or (age>80)}
agestop badage message Sorry, {name}, you are too {if( (age<16),'young',if( (age>80),'old','middle-aged') ) } for this test.
kids !badage yesno Do you have children?
parents 1 expr {!badage && kids=='Y'}
numKids parents text How many children do you have?
kid1 parents && numKids >= 1 text How old is your first child?
kid2 parents && numKids >= 2 text How old is your second child?
kid3 parents && numKids >= 3 text How old is your third child?
kid4 parents && numKids >= 4 text How old is your fourth child?
kid5 parents && numKids >= 5 text How old is your fifth child?
sumage 1 expr {sum(kid1.NAOK,kid2.NAOK,kid3.NAOK,kid4.NAOK,kid5.NAOK)}
report parents text {name}, you said you are {age} and that you have {numKids}.  The sum of ages of your first {min(numKids,5)} kids is {sumage}


Bovenstaand voorbeeld in het Engels met aantal kinderen downloaden.

Al deze vragen kunnen op dezelfde pagina (dus in een groep), alleen de relevante vragen worden getoond. Bovendien wordt, als de leeftijden van de kinderen worden ingevoerd, de sum() expressie in de laatste vraag dynamisch op de pagina gewijzigd.

ExpressionScript zorgt voor deze functionaliteit door elke expressie in een <span> element met een bepaalde naam te zetten. Elke keer als een waarde wijzigt wordt de expressie in dat <span> element opnieuw bepaald.  Er is geen beperking in het aantal van dergelijke micro-maatwerk expressies op een pagina.


Syntax markeren

Als ondersteuning bij het invoeren en valideren van expressies wordt de syntax met kleur gemarkeerd volgens de regels:

Manieren van markeren en hun betekenis

Color Sample Meaning Tooltip Comments
tan background Sample the whole equation none Anything within curly braces that is recognized as an equation (e.g., there is no leading or trailing whitepace) will be color-coded with a tan background to help distinguish it from surrounding text
bold red text Sample An error Some explanation on error Can be an unknow variable or an error in function. Survey is broken and the questions that rely on the respective expression will not be shown to the respondents.
blue text Sample function name meaning and allowable syntax It refers to function names or things that should be functions since they are followed by an open parenthesis. They are displayed in bold blue text. Tooltips show the meaning and allowable syntax for the function.
grey text Sample string none Single and double-quoted strings are shown in grey text.
cyan text Sample variable set on the same page, [name or SGQA code]: question; value; answerList showing codes for each value Any variable that is set on the same page as the question you are currently editing is shown in cyan text (it can be updated in javascript). The tooltip shows its name (if you used INSERTANS:xxx) or its SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown.
green text Sample variable set on a prior page [name or SGQA code]: question; value; answerList showing codes for each value Any variable that is set on a prior page is shown in bold green text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is shown.
bold pink text Sample variable set on a later page in general : empty at survey start, but can be filled with index or move previous [name or SGQA code]: question; value; answerList showing codes for each value Any variable that is set on a prior page is shown in bold pink text. The tooltip shows its name (if you used INSERTANS:xxx) or SGQA code (if you used the new naming system), the actual question, and its current value (or blank if not set). If the question type expects responses from an enumerated value set, the mapping of the codes to display values is show.
bold tan text Sample a lime replacement value the value Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text.
red text Sample assignment operator (=) warning message If you use one of the assignment operator (=), that operator will be displayed in red text. This is meant to help prevent accidental re-assignment of values when you really meant to check whether a == b instead of setting the value of a = b.
normal black text Sample punctuation none All other punctuation signs within the expression are shown as normal black text.
red-boxed text a bold red line surrounds the error syntax error description of the error Any detected syntax errors are shown within red boxes. The tooltip shows the error. Examples include unmatched parentheses, use of undefined functions, passing the wrong number of arguments to functions, poorly structured expressions (e.g., missing operators between variables), trying to assign a new value to a read-only variable, trying to assign values to non-variables, or using unsupported syntax. Note that the syntax error dectection system may only report one error in an expression even if there are multiple errors; however, if any errors are detected, at least one error will be shown.


Help.png Met tooltips bedoelen we de tekst die in een pop-up getoond wordt als je met de muis over bepaalde functies en variabelen heen gaat.


Leesvoer

ExpressionScript voorbeeld enquêtes

Uitwerkingen en manier van aanpak

Voorbeelden

Referentie voor ontwikkelaars

Voortgang