ExpressionScript-Beispiele

Struktur

Im ersten Teil des Artikels wird beschrieben, wofür Ausdrücke verwendet werden können und wo ein Ausdruck gefunden/hinzugefügt werden kann. Der zweite Teil enthält Beispiele für die Verwendung von Expression.

Kategorien von Ausdrücken

LimeSurvey verwendet Ausdrücke für die folgenden Zwecke:

• Relevance
• Validation
• Textausgabe! N!* Antworten speichern

Relevanz

'Zweck: Fragengruppen/Fragen ausblenden

Die Relevanz steuert, ob eine Fragengruppe oder Frage angezeigt oder ausgeblendet wird. Wenn das Ergebnis des Ausdrucks „wahr“ (also 1) ist, wird das Element angezeigt. Andernfalls (wenn das Ergebnis des Ausdrucks „falsch“ (also 0) ist) wird das Element ausgeblendet.

Typ	Zeigt/versteckt	Wo zu finden	Screenshot
Fragengruppe Relevanz	Fragengruppe	Fragengruppe erstellen/bearbeiten -> „Relevanzgleichung:“	30px
Fragenrelevanz	Frage	Frage erstellen/bearbeiten -> „Relevanzgleichung:“	30px
Unterfragerelevanz	Unterfrage	Unterfragen bearbeiten -> „Relevanzgleichung:“	30px

Validierung

Zweck: Eingaben/Aktionen zu Fragen/Unterfragen/Antworten validieren'

Die Validierung steuert, ob die Eingabe des Befragten in eine Frage oder Aktion gültig ist oder nicht. Wenn das Ergebnis des Ausdrucks „wahr“ (also 1) ist, wird die „gute“ Klasse auf das Element und die Validierungsnachricht angewendet. Andernfalls, wenn das Ergebnis des Ausdrucks „falsch“ (dh 0) ist, wird die Klasse „Fehler“ auf das Element und die Validierungsnachricht angewendet. Sie können einen Stil für diese Klassen in der 'template.css deklarieren.

Type	Validates	Wo zu finden	Screenshot
Fragenvalidierung	question	Frage erstellen/bearbeiten -> „Registerkarte „Logik““ - > „Fragenvalidierungsgleichung“	30px
Unterfragevalidierung	Unterfragen	Frage erstellen/bearbeiten -> „Registerkarte „Logik““ -> „ Unterfragevalidierungsgleichung"	File:Subquestion validation Screenshot.png ‎

Textausgabe

'Zwecke: (etwas tun) und einen Text aufschreiben

Mit einem Ausdruck kann man einen Text schreiben. Sie können beispielsweise etwas testen oder berechnen und die Ausgabe abhängig vom Ergebnis des Tests oder der Berechnung festlegen. Es kann auch verwendet werden, um den Fragetext, die Antworten, die Fragetypen usw. einer verwendeten Frage einzufügen, bevor der Ausdruck verwendet wird. Die Textausgabe kann überall dort eingesetzt werden, wo ein Text angezeigt wird, und kann beliebige Ergebnisse liefern.

Use Case	Description
Micro Tailoring	Passen Sie einen Text an, schreiben Sie z. B. „Herr“ oder „Frau“, abhängig von einer zuvor gestellten Geschlechtsfrage
Berechnung	Berechnen Sie einen Wert und schreiben Sie ihn aus, z. B. „Ihr Familieneinkommen beträgt xxx“
Referenz	Fügen Sie einen Text aus einem Element ein, z. B. „Dein Name ist xxx. Wie alt bist du?“

Antworten werden gespeichert

Zwecke: (etwas tun) (etwas Text schreiben) und etwas in der Datenbank speichern'

Der Fragetyp „Gleichung“ kann verwendet werden, um etwas in der Datenbank zu speichern. Sie können etwas mit einem Ausdruck machen, die Gleichungsfrage anzeigen (ähnlich einer Textanzeige) und das Ergebnis des Ausdrucks in der Datenbank speichern. Die Antwort wird in der Antworttabelle gespeichert. Anschließend kann das Ergebnis innerhalb der Statistikfunktion verwendet oder auch in eines der von der LimeSurvey-Exportfunktionalität bereitgestellten Formate importiert werden.

Beispiele für Ausdrücke

Fügen Sie eine Antwort aus einer vorherigen Frage ein

Zweck	Eine Antwort aus einer vorherigen Frage einfügen
Typ	Referenz
Beispiel	Frage eins (Fragecode „ Q00"): In welcher Stadt leben Sie? Frage zwei (Fragecode „Q01“) Wie lange leben Sie schon in der STADT? Zu tun: Die Antwort aus Frage eins sollte anstelle von „CITY“ aus der zweiten Frage verwendet werden.
Ausdruck	{QOO}
Beschreibung	Die in Q00 bereitgestellte Antwort ersetzt das Feld Q00 aus der zweiten Frage
Schritte	Frage zwei erstellen/bearbeiten Einfügen „Wie lange leben Sie schon in {QOO} (Jahren)?“ in das Fragetextfeld

Verwenden einer versteckten Gleichungsfrage zum automatischen Ausfüllen einer Antwort

'Problem: Stellen Sie sich vor, Sie haben zwei Fragen Q1 und Q2. Q1 fragt die Befragten nach ihrem Alter. Q2 teilt die Befragten in drei Gruppen ein: Alter ist unter 20 Jahre, Alter ist 20, Alter ist größer als 20. Also sollte Q2 die Werte „1“, „2“, „3“ verwenden, die entsprechen die oben genannten Bedingungen. Außerdem sollten wir nicht vergessen, Q2 unsichtbar zu machen (die Frage wird nicht in der Umfrage angezeigt, aber die Werte werden über den „Hintergrundprozess“ innerhalb der Antworttabelle angezeigt).

So füllen Sie die Datenbank mit dem Fragetyp Gleichung aus:

• Erstellen Sie zunächst eine Frage mit dem Code Q1 als numerische Eingabefrage.
• Erstellen Sie dann eine weitere Frage mit dem Code Q2 als Gleichungsfrage .
• Setzen Sie im Kapitel „Anzeigeeinstellungen“ von Q2:
  • das Feld „Diese Frage immer ausblenden“ auf „Ein“
  • und geben Sie im Feld „Gleichung“ den Ausdruck ein:

 {if(Q1.NAOK < 20, „1“, if(Q1.NAOK > 20, „3“, „2“))}

Erstellen Sie eine Zusammenfassungsseite mit Platzhaltern

Dieses Tutorial zeigt, wie Sie am Ende der Umfrage eine Übersicht erstellen und alle Fragen und Antworten über ExpressionScript-Platzhalter auflisten können. Es zeigt auch, wie das geht Beschränken Sie einen solchen Überblick nur auf beantwortete Fragen.

Unser Beispiel kann hier heruntergeladen werden: Umfragebeispiel für Umfrageplatzhalter.

Question types being used here:

1. Single choice questions / single text/numeric questions

• List (dropdown)
• List (radio) [L]
• Yes/No [Y]
• Long free text [T]
• Short free text [S]
• Numerical input [N]
• Equation [*]

2. Question with subquestions

• Multiple short text [Q]
• Multiple choice [M]
• Array [F]
• Array (Yes/No/Uncertain) [C]
• Array (10 point choice) [B]

3. Questions with 2 scales

• Array dual scale [1]

4. Questions with X and Y scales

• Array (Numbers) [:]

5. Mask questions

• Text display [X]

In this simple example, our overview will be a simple list with:

- Question text: User's answer

Single choice questions / single text/numeric questions

For all these question types, Limesurvey will store a single response:

• List (dropdown)
• List (radio)
• List with comment
• 5 point choice
• Yes/No
• Short free text
• Long free text
• Huge free text
• Numerical input
• Equation
• Date
• Gender

Assuming the question code of the question is q1, we can reference the question text and answer using:

- {q1.question}: {q1.shown}

Example:

- How old are you?: 25

If you want to check whether that question was answered you can put an IF statement around your output:

{if(!is_empty(q1),join("- ",q1.question,": ",q1.shown),"")}

This "translates" to: IF question with code q1 is not empty, output "- " AND the question text AND ": " AND the answer text (the join() function joins elements as a new string; ELSE: output nothing ("" means empty string).

Question with subquestions

For all these question types LimeSurvey uses subquestions:

• Multiple short text
• Multiple choice
• Multiple choice with comments
• Array
• Array (5 point choice)
• Array (10 point choice)
• Array (Yes/No/Uncertain)
• Array (Increase/Same/Decrease)
• Array by column

Assuming the question code of the question is q2 and the subquestions are numbered SQ001, SQ002, (auto-numbering done by LimeSurvey), we can reference the question text and answer using:

- {q2_SQ001.question}: {q2_SQ001.shown}

- {q2_SQ002.question}: {q2_SQ002.shown}

For multiple choice questions it makes sense to now show the text of the ticked subquestion but to show a Y for each selected option:

- {q2_SQ001.question}: {q2_SQ001}

- {q2_SQ002.question}: {q2_SQ002}

...

Note that currently it is not possible to output the question text of questions with subquestions, see this feature request.

Example 1 (assuming question type is multiple choice)

- Do you know these car brands?

-- Mercedes: Y

-- Audi: N

-- Volvo: Y

If you want to output checked items only you can put an IF statement around your output and check for the checkbox value:

{ if( q2_SQ001=="Y", join( "- ", q2_SQ001.question, ": ", q2_SQ001.shown ), "" ) }

Use the listifop function if you want to output a list of only the selected items, eg: Mercedes, Volvo

{ listifop( 'value', '==', 'Y', 'question', ', ', that.q2.sgqa ) }

Where  that.q2  expands to all of q2's subquestions. See self, this and that for more detail.

Example 2 (assuming question type is Array (10 point choice))

- Please rate the quality of the car brands below on a scale from 1=very bad to 10=very good?

-- Mercedes: 7

-- Audi: 9

-- Volvo: 9

If you want to output rated items only you can put an IF statement around your output and check if the current sub question was answered by using:

{ if( ! is_empty( q3_SQ001 ), join( "- ", q3_SQ001.question, ": ", q3_SQ001.shown ), "" ) }

Use the listifop function if for example you want to only output a list of the selected items greater than eight, eg: Audi / Volvo

{ listifop( 'value', '>', 8, 'question', ' / ', that.q3.sgqa ) }

Question with two scales

This applies to the dual scale question type only.

Let's assume that the following codes are being used:

• Question code: q4
• Subquestion codes: SQ001, SQ002, ...
• Answer codes scale 1: A1, A2, ...
• Answer codes scale 2: B1, B2, ...

To refer to the result of a certain subquestion on a certain scale, you need to use QuestionCode . '_' . SubQuestionCode . '_' . ScaleID. Note that "ScaleID" is 0 for the first scale and 1 for the other!
Example for referring to the answer of the third subquestion and second scale: q4_SQ003_1 - Question 4, subquestion 3, second scale.

Let's output the results for both scales and the first two subquestions:

- {q4_SQ001_0.question}: {q4_SQ001_0.shown} / {q4_SQ001_1.shown}

- {q4_SQ002_0.question}: {q4_SQ002_0.shown} / {q4_SQ002_1.shown}

To output the subquestion text, you need to add the scale ID to the placeholder (though the texts are the same for both scales). So instead of {q4_SQ001.question} we have to use {q4_SQ001_0.question} or {q4_SQ001_1.question}.

If you want to export/display the results of subquestions with at least one answer only, use this syntax for each subquestion:

{if(count(q4_SQ001_0,q4_SQ001_1)>0,join("- ",q4_SQ001_0.question,": ",q4_SQ001_0.shown," / ",q4_SQ001_1.shown),"")}

Question with X and Y scales

This applies to all matrix questions which allow an answer for every cell (not just every row as shown previously):

• Array Texts
• Array Numbers

Assumed codes used:

• Question code: q5
• Subquestion codes: SQ001, SQ002, ...
• Answer codes: A1, A2, ...

To refer to the result of a certain subquestion from a certain column, you need to use QuestionCode . '_' . SubQuestionCode . '_' . AnswerCode. Example for referring to the answer of the third subquestion and second column: q5_SQ003_A2.

Let's output the results for columns 1-3 of the first two subquestions:

- {q5_SQ001_A1.question}: {q5_SQ001_A1.shown} | {q5_SQ001_A2.shown} | {q5_SQ001_A3.shown}

- {q5_SQ002_A1.question}: {q5_SQ002_A1.shown} | {q5_SQ002_A2.shown} | {q5_SQ002_A3.shown}

Since for these question types each cell (combination of X axes and Y axes) equals one answer option, a test for existing data needs to be done for each cell. Example:

{if(!is_empty(q5_SQ001_A1),join("- ",q5_SQ001_A1.question,": ",q5_SQ001_A1.shown),"")}

To output the subquestion text you need to add the answer code to the placeholder (though the texts are the same for all answer options). So instead of {q5_SQ001.question} we have to use {q5_SQ001_A1.question} or {q5_SQ001_A2.question}.

Hide question if answer from previous question is empty

Purpose	Hide question if answer from previous question is empty
Type	Question Relevance
Example	Question one: question code "name", question text "What's your name?" Question two: question text "{name}, how old are you?" To do: Hide question two if the textfield of question one is empty
Expression	!is_empty(name)
Description	is_empty() determines whether a variable is considered to be empty. The "!" negates the result. So if the variable is not empty the Expression will be true and the question is shown
Steps	Create/edit question two Insert "!is_empty(name)" into "Relevance equation:"
Sample File	Hide_question_if_empty_question_group.zip

Hide question group if answer from previous question is Yes or No

Purpose	Hide question group if answer from previous question is Yes or No
Type	Question group Relevance
Example	Page one, Question Group one, Question one: question code "PET", question text "Do you have a pet?" -Yes -No Page two, Question Group two: Title "About your pet(s)" To do: Show/Hide question group two if answer from question one is Yes/No
Expression	PET == "Y"
Description	PET is the question code for the question you want to check the answer. If you don't use a suffix EM will use "Qcode.code". So you compare the answer code from the PET question to the value "Y". If the participant answers "Yes" the Expression is true and the question group "About your pet(s)" will be shown.
Steps	Create/edit question group two Insert "PET == "Y"" into "Relevance equation:"
Sample File	Hide_question group_if_answer_from_previous_question_is_Yes_or_No.zip

Display value of a multiple answer input question field

Purpose	Display value of a multiple answer input question field
Type	Reference
Example	Question one: question code "AskChildAge", question text "How old are your children?". Subquestions codes -Child1 -Child2 -Child3 - ChildXXX Question two: question code "ReportChildAge" question text "About your first child: - CHILD1 is AGE1."
Expression	{AskChildAge_Child1.question}, {AskChildAge_Child1.value}
Description	You want to use the value of a subquestion in a following question. You can access the subquestion value with this kind of expression: QcodeQuestion_QcodeSubquestion.value
Steps	Create/edit the second question Insert this text in the description: "About your first child: - {AskChildAge_Child1.question} is {AskChildAge_Child1.value}."
Sample File	Display_value_of_a_multiple_answer_input_question_field.zip

Validate number of boxes ticked per row for an "Array (Numbers) Checkbox" question

Purpose	Validate number of boxes ticked per row
Type	Validation
Example	Question of type "Array Numbers (Checkbox Layout)"
Expression	sum(...)
Description	(sum(Test_A_1, Test_A_2, Test_A_3, Test_A_4, Test_A_5) <= X) determines whether at least X checkboxes in row A are checked. If you want to check all three rows (A, B, C), you can connect the expression using "&&": (sum(Test_A_1, Test_A_2, Test_A_3, Test_A_4, Test_A_5) <= X) && (sum(Test_B_1, Test_B_2, Test_B_3, Test_B_4, Test_B_5) <= X) && (sum(Test_C_1, Test_C_2, Test_C_3, Test_C_4, Test_C_5) <= X)
Steps	Create/edit question of type "Array Numbers (Checkbox Layout)". Insert the above expression into "Question validation equation" at the advanced question settings (you might have to adjust variable namings!).
Sample File	Validate number of boxes ticker per row for an Array (Numbers) Checkbox.lss

Calculate difference between two dates

Purpose	Calculate difference between two dates
Type	Relevance / Equation question type / Validation
Example	Question one (date/time, code: DOB): What is your date of birth? Question two (date/time, code: datetoday): What is the date today? Question three (boilerplate): You are XXXX days old. To do: Calculate and display the number of days between the date given in question 1 and the question 2.
Expression	{(strtotime(datetoday)-strtotime(DOB))/60/60/24}
Description	strtotime calculates the number of seconds between the 1st of January 1970 and the given date. The above expression calculates the number of seconds between the two given dates. The term "/60/60/24" just calculates the number of days from the number of seconds. Instead of asking for the "datetoday", you can also use strtotime('now') or simply time(), which directly returns the number of seconds from January 1970 until now (i.e. the time the survey was taken). Thus you could quickly figure out the age of a person in years with the equation {(time() - strtotime(DOB)) / 60 / 60 / 24 / 365.25} In any of these cases, it is critical that the date is entered in a proper format, otherwise the strtotime() function will not work right.
Steps	Create two date questions (for the date of birth and for today's date) and a boilerplate question. In the question text of the boilerplate question insert: "On {datetoday} you were {(strtotime(today)-strtotime(dob))/60/60/24} days days old." Please note: The function strtotime can work with MANY but not all date formats. If you run into problems set your survey's date format to mm/dd/yyyy or yyyy-mm-dd or dd.mm.yyyy"
Sample File	Date_difference.zip

Using ExpressionScript for Assessments

Here comes another example on how to use the ExpressionScript with Array type questions and assessments:</ br>

Let's say you have 2 array questions and you want to save the results of the calculation data to your database. It is actually simple, you will need to create and test your arrays and submit a dummy response to see if it works and gives you the results in the completed page.

Implementation details:

• add a question of type equation
• add the following line assuming that Q1 is your array question code while Q2 is the second one:

  • {sum(Q1_SQ001.value,Q2_SQ001.value)}

Note that SQ001 is the default code for any subquestion. If you change the subquestion code, adjust the equation above accordingly.

Using em_validation_q in array

You can use the question validation equation to control an array with any condition.

Implementation details:

• for the first array : array of single choice
  • Question code is ARRAY
  • Sub question code are SQ01,SQ02,SQ03 and SQ04
  • update the Whole question validation equation and put

    !is_empty(ARRAY_SQ01) and !is_empty(ARRAY_SQ03) 

• for the second array : array of text
  • Question code is ARRAYTEXT
  • Sub question at Y axis code are SY01,SY02,SY03, and SY04
  • Update the Whole question validation equation and put

    count(self.sq_SY01 >= 1) and count(self.sq_SY03 >= 3)