ExpressionScript - Presentation - Revision history

C schmitz at 20:43, 2 December 2025

2025-12-02T20:43:54Z

← Older revision		Revision as of 22:43, 2 December 2025
Line 330:		Line 330:
	ExpressionScript provides read-only access to whichever variables you might need. For backwards compatibility, it provides access to the following:		ExpressionScript provides read-only access to whichever variables you might need. For backwards compatibility, it provides access to the following:
	*[[Survey_participants\|TOKEN:xxx]] - the value of a TOKEN (e.g., TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (only for '''not''' [[Participant_settings\|anonymous survey]]).		*[[Survey_participants\|TOKEN:xxx]] - the value of a TOKEN (e.g., TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (only for '''not''' [[Participant_settings\|anonymous survey]]).
	*[[Questions_-_introduction#Information_from_previous_answers\|Question code]] - the display value of an answer (e.g., "Yes") - similar to using {QCODE.shown}.
	*All [[Theme_editor#Keywords\|{XXX} values used by templates]].		*All [[Theme_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.

C schmitz at 20:30, 2 December 2025

2025-12-02T20:30:40Z

← Older revision		Revision as of 22:30, 2 December 2025
Line 330:		Line 330:
	ExpressionScript provides read-only access to whichever variables you might need. For backwards compatibility, it provides access to the following:		ExpressionScript provides read-only access to whichever variables you might need. For backwards compatibility, it provides access to the following:
	*[[Survey_participants\|TOKEN:xxx]] - the value of a TOKEN (e.g., TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (only for '''not''' [[Participant_settings\|anonymous survey]]).		*[[Survey_participants\|TOKEN:xxx]] - the value of a TOKEN (e.g., TOKEN:FIRSTNAME, TOKEN:ATTRIBUTE_5) (only for '''not''' [[Participant_settings\|anonymous survey]]).
	*[[Questions_-_introduction#Information_from_previous_answers\|~~INSERTANS:SGQA~~]] - the display value of an answer (e.g., "Yes") - similar to using {QCODE.shown}.		*[[Questions_-_introduction#Information_from_previous_answers\|Question code]] - the display value of an answer (e.g., "Yes") - similar to using {QCODE.shown}.
	*All [[Theme_editor#Keywords\|{XXX} values used by templates]].		*All [[Theme_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 947:		Line 947:
	\|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 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.		\|cyan text\|\|style='color:#4169e1; background-color:#eee8aa'\|Sample\|\|variable set on the same page,\|\|<nowiki>[</nowiki>name]: 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, 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\|\|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 shown.		\|green text\|\|style='color:#008000; background-color:#eee8aa'\|Sample\|\|variable set on a prior page\|\|<nowiki>[</nowiki>name]: 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 shown.
	\|-		\|-
	\|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 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 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 prior 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.

Denischenu: Variables : *{SAVEDID} for the current response ID

2024-11-26T17:02:03Z

Variables : *{SAVEDID} for the current response ID

← Older revision		Revision as of 19:02, 26 November 2024
Line 333:		Line 333:
	*All [[Theme_editor#Keywords\|{XXX} values used by templates]].		*All [[Theme_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.
			*{SAVEDID} for the current response ID

	<!--T:64-->		<!--T:64-->
Line 408:		Line 409:
	<!--T:71-->		<!--T:71-->
	It is recommended to clear your expression of HTML that appears within your expression. If you use the LimeSurvey HTML editor, click on the "Source" button (located in the upper left part of the editor) and delete all the characters that are not related to your expression (e.g., <p>,</br>, and so on).		It is recommended to clear your expression of HTML that appears within your expression. If you use the LimeSurvey HTML editor, click on the "Source" button (located in the upper left part of the editor) and delete all the characters that are not related to your expression (e.g., <p>,</br>, and so on).


	=Qcode variable naming= <!--T:72-->		=Qcode variable naming= <!--T:72-->

Tammo at 20:15, 4 December 2023

2023-12-04T20:15:45Z

← Older revision		Revision as of 22:15, 4 December 2023
Line 10:		Line 10:

	<!--T:3-->		<!--T:3-->
	LimeSurvey uses ~~the new ExpressionScript (EM) module~~ which lets LimeSurvey support more complex branching, assessments, validation, and tailoring. It replaces how LimeSurvey manages Replacements, [[Setting conditions\|Conditions]], and [[Assessments]] on the back-end. It also speeds up processing considerably since it eliminates most run-time database reads. EM was developed by Dr. Thomas White (TMSWhite).		LimeSurvey uses Expression Script which lets LimeSurvey support more complex branching, assessments, validation, and tailoring. It replaces how LimeSurvey manages Replacements, [[Setting conditions\|Conditions]], and [[Assessments]] on the back-end. It also speeds up processing considerably since it eliminates most run-time database reads. Expression Script was developed by Dr. Thomas White (TMSWhite).


Line 38:		Line 38:


	==Do I have to use EM?== <!--T:6-->		==Do I have to use Expression Script?== <!--T:6-->


Line 45:		Line 45:

	<!--T:8-->		<!--T:8-->
	For example, the [[Setting conditions\|Conditions editor]] covers some basic expressions that can be applied to the questions of your survey. However, the Conditions editor is limited. That is why the EM is used - it expands the realm of [[Expression_Manager_to_be_updated#Quick_start_tutorial\|customization possibilities]].		For example, the [[Setting conditions\|Conditions editor]] covers some basic expressions that can be applied to the questions of your survey. However, the Conditions editor is limited. That is why the Expression Script is used - it expands the realm of [[Expression_Manager_to_be_updated#Quick_start_tutorial\|customization possibilities]].

Tammo at 07:58, 22 May 2022

2022-05-22T07:58:05Z

← Older revision		Revision as of 09:58, 22 May 2022
Line 772:		Line 772:

	<!--T:135-->		<!--T:135-->
	If you need new function that ~~didn~~'t exist in core, you can create with plugin. Such function is created using [[expressionManagerStart]] event.		If you need a new function that doesn't exist in core, you can create one with a plugin. Such a new function is created using the [[expressionManagerStart]] event.

	=ExpressionScript knows which variables are local= <!--T:107-->		=ExpressionScript knows which variables are local= <!--T:107-->

C schmitz: Text replacement - " enclose="div"" to ""

2022-02-16T13:08:09Z

Text replacement - " enclose="div"" to ""

← Older revision		Revision as of 15:08, 16 February 2022
Line 181:		Line 181:

	<!--T:39-->		<!--T:39-->
	<syntaxhighlight lang="java~~" enclose="div~~">{if(is_empty(PFTotals),		<syntaxhighlight lang="java">{if(is_empty(PFTotals),
	'',		'',
	if(PFTotals >= -5 && PFTotals <= -4,		if(PFTotals >= -5 && PFTotals <= -4,

Han at 19:52, 22 May 2020

2020-05-22T19:52:06Z

← Older revision		Revision as of 21:52, 22 May 2020
Line 73:		Line 73:
	\|Conditions\|\|1. Nice [[Setting conditions\|GUI]] for creating simple conditions. <br/>2. GUI well documented and understood by support team\|\|1. Only supports simple comparisons and does not "AND" and "OR" conditions well. <br/>2. Cascading conditions work erratically <br/>3. Slow - database intensive -it can slow down long surveys. <br/>4. Some reported problems with reloading conditions.<br/>5. GUI doesn't scale well when there are dozens, hundreds, or thousands of questions. <br/>6. It could be slow to convert paper-based surveys since it must use [[SGQA identifier\|SGQA]] names. <br/>7. Often need a programmer to custom-code logic needed for complex branching.		\|Conditions\|\|1. Nice [[Setting conditions\|GUI]] for creating simple conditions. <br/>2. GUI well documented and understood by support team\|\|1. Only supports simple comparisons and does not "AND" and "OR" conditions well. <br/>2. Cascading conditions work erratically <br/>3. Slow - database intensive -it can slow down long surveys. <br/>4. Some reported problems with reloading conditions.<br/>5. GUI doesn't scale well when there are dozens, hundreds, or thousands of questions. <br/>6. It could be slow to convert paper-based surveys since it must use [[SGQA identifier\|SGQA]] names. <br/>7. Often need a programmer to custom-code logic needed for complex branching.
	\|-		\|-
	\|Relevance\|\|1. Supports very complex logic, including 80+ functions and math/string operators. <br/>2. Perfect support for [[~~Expression_Manager_~~-~~_presentation~~#Cascading_Conditions\|cascading logic]]. <br/>3. Fast - no extra database calls, supporting 1000+ question surveys. <br/>4. No problems with reloading logic since it does not require [[SGQA identifier\|SGQA]] codes. <br/>5. Syntax-highlighting scales to 1000+ question surveys. <br/>6. Easy and fast to use for groups wanting to computerize existing paper-based surveys. <br/>7. It easily supports semi-structured interviews and epidemiological surveys without needing a programmer.\|\|1. No GUI for simple conditions - it makes use of [[Expression_Manager_to_be_updated#Syntax_Highlighting\|syntax-highlighting]] instead.		\|Relevance\|\|1. Supports very complex logic, including 80+ functions and math/string operators. <br/>2. Perfect support for [[ExpressionScript_-_Presentation#Cascading_Conditions\|cascading logic]]. <br/>3. Fast - no extra database calls, supporting 1000+ question surveys. <br/>4. No problems with reloading logic since it does not require [[SGQA identifier\|SGQA]] codes. <br/>5. Syntax-highlighting scales to 1000+ question surveys. <br/>6. Easy and fast to use for groups wanting to computerize existing paper-based surveys. <br/>7. It easily supports semi-structured interviews and epidemiological surveys without needing a programmer.\|\|1. No GUI for simple conditions - it makes use of [[Expression_Manager_to_be_updated#Syntax_Highlighting\|syntax-highlighting]] instead.
	\|}		\|}

Line 81:		Line 81:
	*We recommend you to use whatever fits better your needs.		*We recommend you to use whatever fits better your needs.
	*For a more detailed explanation of the EM features, click on the following [[EM and its features\|link]].}}		*For a more detailed explanation of the EM features, click on the following [[EM and its features\|link]].}}


	=Getting Started= <!--T:17-->		=Getting Started= <!--T:17-->

Han: Marked this version for translation

2020-05-19T14:46:09Z

Marked this version for translation

← Older revision		Revision as of 16:46, 19 May 2020
Line 770:		Line 770:
	{{Note\| Click [[Functions that are Planned or Being Considered\|here]] if you wish to find out more about planned (or being constrained) functions.}}		{{Note\| Click [[Functions that are Planned or Being Considered\|here]] if you wish to find out more about planned (or being constrained) functions.}}

	==Create new expression functions with plugin {{NewIn\|4.0.0}}==		==Create new expression functions with plugin {{NewIn\|4.0.0}}== <!--T:134-->

			<!--T:135-->
	If you need new function that didn't exist in core, you can create with plugin. Such function is created using [[expressionManagerStart]] event.		If you need new function that didn't exist in core, you can create with plugin. Such function is created using [[expressionManagerStart]] event.

DenisChenu: Create new expression functions with plugin

2020-04-22T07:39:43Z

Create new expression functions with plugin

← Older revision		Revision as of 09:39, 22 April 2020
Line 766:		Line 766:
	\|unique\|\|Returns true if all non-empty responses are unique\|\|boolean unique(arg1, ..., argN)		\|unique\|\|Returns true if all non-empty responses are unique\|\|boolean unique(arg1, ..., argN)
	\|}		\|}


	<!--T:106-->		<!--T:106-->
	{{Note\| Click [[Functions that are Planned or Being Considered\|here]] if you wish to find out more about planned (or being constrained) functions.}}		{{Note\| Click [[Functions that are Planned or Being Considered\|here]] if you wish to find out more about planned (or being constrained) functions.}}

			==Create new expression functions with plugin {{NewIn\|4.0.0}}==

			If you need new function that didn't exist in core, you can create with plugin. Such function is created using [[expressionManagerStart]] event.

	=ExpressionScript knows which variables are local= <!--T:107-->		=ExpressionScript knows which variables are local= <!--T:107-->

Cdorin at 15:39, 14 April 2020

2020-04-14T15:39:13Z

← Older revision		Revision as of 17:39, 14 April 2020
Line 970:		Line 970:


	==[[ExpressionScript ~~how~~-tos\|Use cases and how-tos]]== <!--T:130-->		==[[ExpressionScript How-tos\|Use cases and how-tos]]== <!--T:130-->


Line 979:		Line 979:


	==[[ExpressionScript roadmap\|RoadMap, status, ToDo List]]== <!--T:133-->		==[[ExpressionScript Engine roadmap\|RoadMap, status, ToDo List]]== <!--T:133-->
	</translate>		</translate>