Expression Manager - Revision history

C schmitz: Marked this version for translation

2025-12-02T20:36:30Z

Marked this version for translation

← Older revision		Revision as of 22:36, 2 December 2025
Line 4:		Line 4:
	__TOC__		__TOC__

	<!--T:2-->		=Quick Start Tutorial= <!--T:2-->
	~~=Quick Start Tutorial=~~

	==Overview== <!--T:4-->		==Overview== <!--T:4-->

C schmitz: Removed INSERTANS references

2025-12-02T20:36:21Z

Removed INSERTANS references

← Older revision		Revision as of 22:36, 2 December 2025
Line 5:		Line 5:

	<!--T:2-->		<!--T:2-->
	~~<div class="simplebox"> Note: This feature is only available in LimeSurvey 1.92 or later. </div>~~		=Quick Start Tutorial=

	=Quick Start Tutorial= ~~<!--T:3-->~~

	==Overview== <!--T:4-->		==Overview== <!--T:4-->
Line 233:		Line 231:
	#*You can hide assessment scores without needing JavaScript or CSS		#*You can hide assessment scores without needing JavaScript or CSS
	#Replacement Fields		#Replacement Fields
	#*~~Instead of using {INSERTANS:SGQA}, you can just use~~ the Question Code - this makes it easier to read and validate.		#*Use the Question Code to insert values from answer to previous questions - this makes it easier to read and validate.
	~~#*This also avoids the common need to edit questions to change the SGQA code to make everything work~~.
	#Tailoring - you can conditionally display text based upon other values		#Tailoring - you can conditionally display text based upon other values
	#*Use the appropriate title for a subject, like (e.g. "Hello <nowiki>[</nowiki>Mr./Mrs.] Smith")		#*Use the appropriate title for a subject, like (e.g. "Hello <nowiki>[</nowiki>Mr./Mrs.] Smith")
Line 245:		Line 242:
	#*.value - the assessment value for the question if it is relevant (otherwise blank), or the text value if it is not a coded question -- available is assesments are enabled for the survey, otherwise always zero		#*.value - the assessment value for the question if it is relevant (otherwise blank), or the text value if it is not a coded question -- available is assesments are enabled for the survey, otherwise always zero
	#*.valueNAOK - same as .value, but can be part of calculations or lists even if irrelevant		#*.valueNAOK - same as .value, but can be part of calculations or lists even if irrelevant
	#*.shown - the answer as displayed to the user ~~(this is what {INSERTANS:xxx} does)~~		#*.shown - the answer as displayed to the user
	#*.qid - the question ID		#*.qid - the question ID
	#*.gid - the group ID		#*.gid - the group ID
Line 341:		Line 338:

	<!--T:83-->		<!--T:83-->
	Users could tailor some messages and questions based upon prior responses. For example, a question might be, ''{TOKEN:FIRSTNAME}, you said {~~INSERTANS:111X3X4~~} was your favorite sport''. However, it was not possible to do conditional tailoring (like say "Mr." or "Mrs." depending upon the person's gender), or conjugate verbs or decline nouns without fancy JavaScript. Authors could implement surveys that seemed to tailor questions, but it required separate questions for each permutation, and complex conditions to decide which questions to display.		Users could tailor some messages and questions based upon prior responses. For example, a question might be, ''{TOKEN:FIRSTNAME}, you said {SPORT.shown} was your favorite sport''. However, it was not possible to do conditional tailoring (like say "Mr." or "Mrs." depending upon the person's gender), or conjugate verbs or decline nouns without fancy JavaScript. Authors could implement surveys that seemed to tailor questions, but it required separate questions for each permutation, and complex conditions to decide which questions to display.

	==Validation== <!--T:84-->		==Validation== <!--T:84-->

	<!--T:85-->		<!--T:85-->
	Question could be validated with Regular expressions, or minimum/maximum values, or let an ~~SGQA~~ response serve as the minimum or maximum value. However, validations could not be based upon calculations of other variables without fancy JavaScript.		Question could be validated with Regular expressions, or minimum/maximum values, or let an response serve as the minimum or maximum value. However, validations could not be based upon calculations of other variables without fancy JavaScript.

	==Equations== <!--T:86-->		==Equations== <!--T:86-->
Line 572:		Line 569:
	Expression Manager provides read-only access to whichever variables we might need. For backwards compatibility, it provides access to the following:		Expression Manager provides read-only access to whichever variables we might need. For backwards compatibility, it provides access to the following:
	*TOKEN:xxx - the value of a TOKEN (e.g. TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (Only for NOT anonymous survey).		*TOKEN:xxx - the value of a TOKEN (e.g. TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (Only for NOT anonymous survey).
	*[[Adding a question#Information_from_previous_answers\|~~INSERTANS:SGQA~~]] - the display value of an answer (e.g. "Yes")~~. For~~ Expression Manager ~~it's the same that using {QCODE.shown}~~.		*[[Adding a question#Information_from_previous_answers\|QCODE.shown]] - the display value of an answer (e.g. "Yes") using Expression Manager.
	*All [[The_template_editor#Keywords\|{XXX} values used by templates]].		*All [[The_template_editor#Keywords\|{XXX} values used by templates]].
	*In question text, you can use {QID} replaced by the question id and {SGQ} replaced by the SGQA of the question		*In question text, you can use {QID} replaced by the question id and {SGQ} replaced by the SGQA of the question
Line 1,228:		Line 1,225:
	\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|single and double-quoted strings are shown in grey text		\|grey text\|\|style='color:#808080; background-color:#eee8aa'\|Sample\|\|string\|\|none\|\|single and double-quoted strings are shown in grey text
	\|-		\|-
	\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page to the current question is shown in cyan text, showning it can be updated in javascript. 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.		\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on the same page to the current question is shown in cyan text, showning it can be updated in javascript. The tooltip shows its name, 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.
	\|-		\|-
	\|green text\|\|style='color:#008000; background-color:#eee8aa'\|Sample\|\|variable set on a prior page\|\|<nowiki>[</nowiki>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 show.		\|green text\|\|style='color:#008000; background-color:#eee8aa'\|Sample\|\|variable set on a prior page\|\|<nowiki>[</nowiki>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, 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 pink text\|\|style='color:#9370db; background-color:#eee8aa'\|Sample\|\|variable set on a later page <sup>in general : empty at survey start, but can be filled with index or move previous</sup>\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a next 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 pink text\|\|style='color:#9370db; background-color:#eee8aa'\|Sample\|\|variable set on a later page <sup>in general : empty at survey start, but can be filled with index or move previous</sup>\|\|<nowiki>[</nowiki>name or SGQA code]: question; value; answerList showing codes for each value\|\|Any variable that is set on a next page is shown in bold pink text. The tooltip shows its name, 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\|\|style='color:#a0522d; background-color:#eee8aa'\|Sample\|\|a lime replacement value\|\|the value\|\|Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text.		\|bold tan text\|\|style='color:#a0522d; background-color:#eee8aa'\|Sample\|\|a lime replacement value\|\|the value\|\|Lime Replacement Strings (like {TOKEN:xxx}, {PRIVACY_MESSAGE}) are shown in bold tan text.

Han: Marked this version for translation

2025-08-05T19:21:04Z

Marked this version for translation

← Older revision		Revision as of 21:21, 5 August 2025
Line 158:		Line 158:
	This wiki page is the definitive reference for Expression Manager syntax and functionality.		This wiki page is the definitive reference for Expression Manager syntax and functionality.

	~~==Key Definitions==~~ <!--T:55-->		<!--T:55-->
			==Key Definitions==
	#'''Expression''': Anything surrounded by curly braces		#'''Expression''': Anything surrounded by curly braces
	#*As long as there is no white space immediately after the opening brace or before the closing curly brace		#*As long as there is no white space immediately after the opening brace or before the closing curly brace
Line 530:		Line 531:
	To help caution you about this operator, it is shown in red font within the syntax equations (so that you don't confuse it with "==")		To help caution you about this operator, it is shown in red font within the syntax equations (so that you don't confuse it with "==")

	~~===Using Assignment Operator===~~ <!--T:145-->		<!--T:145-->
			===Using Assignment Operator===
	The main reasons you may want to use assignment are:		The main reasons you may want to use assignment are:
	* You need to set the default value for a question that does not accept defaults via equation (such as list radio, where the user interface lets you pick one of the answer options, but does not let you enter an equation). However, be careful, as LimeSurvey will not be able to validate that your equation generates one of the allowable answers for that question.		* You need to set the default value for a question that does not accept defaults via equation (such as list radio, where the user interface lets you pick one of the answer options, but does not let you enter an equation). However, be careful, as LimeSurvey will not be able to validate that your equation generates one of the allowable answers for that question.
Line 654:		Line 656:
	QuestionCode . '_' . SubQuestionCode . '_' . ScaleId		QuestionCode . '_' . SubQuestionCode . '_' . ScaleId

			<!--T:208-->
	SubQuestion Code & Scale ID need to be used or not, depending on the question type - see table below.		SubQuestion Code & Scale ID need to be used or not, depending on the question type - see table below.
	~~<!--T:208-->~~
	For '''comment''' and '''other''', question code are QuestionCode_comment and QuestionCode_other		For '''comment''' and '''other''', question code are QuestionCode_comment and QuestionCode_other

C schmitz at 09:21, 11 April 2024

2024-04-11T09:21:53Z

← Older revision		Revision as of 11:21, 11 April 2024
Line 652:		Line 652:

	<!--T:155-->		<!--T:155-->
	QuestionCode . '_' . ~~SubQuestionID~~ . '_' . ScaleId		QuestionCode . '_' . SubQuestionCode . '_' . ScaleId

			SubQuestion Code & Scale ID need to be used or not, depending on the question type - see table below.
	<!--T:208-->		<!--T:208-->
	For '''comment''' and '''other''', question code are QuestionCode_comment and QuestionCode_other		For '''comment''' and '''other''', question code are QuestionCode_comment and QuestionCode_other

Han: Marked this version for translation

2024-04-02T15:02:10Z

Marked this version for translation

← Older revision		Revision as of 17:02, 2 April 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[StatFunctions\|Expression Manager statistic functions]]==		==[[StatFunctions\|Expression Manager statistic functions]]== <!--T:233-->

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

Mazi: Adjusted link syntax

2024-02-26T09:57:51Z

Adjusted link syntax

← Older revision		Revision as of 11:57, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions~~\|StatFunctions~~]]==		==[[StatFunctions\|Expression Manager statistic functions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

Mazi: Link fix

2024-02-26T09:55:43Z

Link fix

← Older revision		Revision as of 11:55, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions\|~~https://manual.limesurvey.org/~~StatFunctions]]==		==[[Expression Manager statistic functions\|StatFunctions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

Mazi: Fixed link

2024-02-26T09:54:45Z

Fixed link

← Older revision		Revision as of 11:54, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]		==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

Mazi: Added link to stat functions

2024-02-26T09:53:46Z

Added link to stat functions

← Older revision		Revision as of 11:53, 26 February 2024
Line 1,247:		Line 1,247:

	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

			==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

	==[[Expression Manager roadmap\|RoadMap/Status/ToDo List]]== <!--T:207-->		==[[Expression Manager roadmap\|RoadMap/Status/ToDo List]]== <!--T:207-->


	</translate>		</translate>

Adamzammit: Fix typo of three = signs which isn't a valid ExpressionManager comparison operator

2023-09-08T00:41:44Z

Fix typo of three = signs which isn't a valid ExpressionManager comparison operator

← Older revision		Revision as of 02:41, 8 September 2023
Line 520:		Line 520:

	<!--T:232-->		<!--T:232-->
	To be sure to compare integer value, you can use <code>[[Expression_Manager#Implemented_Functions\|intval]](Q0.NAOK) > 50</code>, just remember if Q0.NAOK is not a number (empty or a string), then intval(Q0.NAOK) === 0. To compare string value ("A" < "B") use [[Expression_Manager#Implemented_Functions\|strcmp]] directly : <code>strcmp(Q0.NAOK,"B")</code> or <code>strcmp(Q0.NAOK,"A5")</code>.		To be sure to compare integer value, you can use <code>[[Expression_Manager#Implemented_Functions\|intval]](Q0.NAOK) > 50</code>, just remember if Q0.NAOK is not a number (empty or a string), then intval(Q0.NAOK) == 0. To compare string value ("A" < "B") use [[Expression_Manager#Implemented_Functions\|strcmp]] directly : <code>strcmp(Q0.NAOK,"B")</code> or <code>strcmp(Q0.NAOK,"A5")</code>.

	===Caution about using Assignment Operator (=)=== <!--T:142-->		===Caution about using Assignment Operator (=)=== <!--T:142-->

← Older revision		Revision as of 17:02, 2 April 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[StatFunctions\|Expression Manager statistic functions]]==		==[[StatFunctions\|Expression Manager statistic functions]]== <!--T:233-->

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

← Older revision		Revision as of 11:57, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions~~\|StatFunctions~~]]==		==[[StatFunctions\|Expression Manager statistic functions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

← Older revision		Revision as of 11:55, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions\|~~https://manual.limesurvey.org/~~StatFunctions]]==		==[[Expression Manager statistic functions\|StatFunctions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

← Older revision		Revision as of 11:54, 26 February 2024
Line 1,248:		Line 1,248:
	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

	==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]		==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]==

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

← Older revision		Revision as of 11:53, 26 February 2024
Line 1,247:		Line 1,247:

	==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->		==[[ExpressionScript examples\|Step-by-Step examples]]== <!--T:205-->

			==[[Expression Manager statistic functions\|https://manual.limesurvey.org/StatFunctions]]

	==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->		==[[Expression Manager for developers\|Reference for Developers]]== <!--T:206-->

	==[[Expression Manager roadmap\|RoadMap/Status/ToDo List]]== <!--T:207-->		==[[Expression Manager roadmap\|RoadMap/Status/ToDo List]]== <!--T:207-->


	</translate>		</translate>