Panel integration - Revision history

C schmitz: Removed nonsense

2023-06-11T19:30:38Z

Removed nonsense

← Older revision		Revision as of 21:30, 11 June 2023
Line 60:		Line 60:
	<!--T:56-->		<!--T:56-->
	1) First, create a '''short/long free text question''' and name it what ever you want (we will use "LS" for the '''Question code''' field). Then, enable the '''always hide this question''' option, located under the '''Display''' tab within the menu of the question.		1) First, create a '''short/long free text question''' and name it what ever you want (we will use "LS" for the '''Question code''' field). Then, enable the '''always hide this question''' option, located under the '''Display''' tab within the menu of the question.

	~~<!--T:57-->~~
	{{Alert\|title=Attention\|text=Make sure you disable the welcome page! Let them land on the page with the short/long free text question. The parameter cannot work in the welcome screen because the parameter has to be loaded into the question first!}}


	<!--T:58-->		<!--T:58-->

C schmitz: Corrected nonsense about user landing in the target question when using session params.

2023-06-11T19:29:01Z

Corrected nonsense about user landing in the target question when using session params.

← Older revision		Revision as of 21:29, 11 June 2023
Line 45:		Line 45:

	<!--T:53-->		<!--T:53-->
	*'''Parameter:''' Type in this field the name of the new parameter. ~~It will be included in the URL;~~		*'''Parameter:''' Type in this field the name of the new parameter.
	*'''Target question:''' ~~Generally,~~ the ~~URL~~ parameter is saved as a question. ~~It is where survey participants will land once they click the link that also includes in its URL the parameter defined above~~.		*'''Target question:'''. The value of the parameter is always saved in the survey session, even if you don't set a target question here. Here, you can select a question of type 'Sort text' or 'Multiple texts'.

	<!--T:20-->		<!--T:20-->
	<div class="simplebox">[[File:help.png]] ~~You could also save the URL parameter as a response to a short text question or multiple short text question type. (You will be able to select any short text question to save it to). However, even if~~ you do not save the value of the URL parameter, you will still be able to use this parameter in the end URL. For further documentation, continue reading the [[URL_fields#Passthrough_fields\|End-URL]] wiki section.</div>		<div class="simplebox">[[File:help.png]] If you do not save the value of the URL parameter, you will still be able to use this parameter in the end URL. For further documentation, continue reading the [[URL_fields#Passthrough_fields\|End-URL]] wiki section.</div>


	==How to use the panel integration function== <!--T:54-->		==How to use the panel integration function== <!--T:54-->

Vharris at 10:47, 2 July 2021

2021-07-02T10:47:40Z

← Older revision		Revision as of 12:47, 2 July 2021
Line 182:		Line 182:
	<div class="simplebox">[[File:help.png]] '''Note:''' Read the following wiki section to find out more about the [[Survey quotas\|LimeSurvey quota system and its usage.]]</div>		<div class="simplebox">[[File:help.png]] '''Note:''' Read the following wiki section to find out more about the [[Survey quotas\|LimeSurvey quota system and its usage.]]</div>

	==The ~~Quotafull Link~~== <!--T:87-->		==The quotafull link== <!--T:87-->

Vharris at 10:47, 2 July 2021

2021-07-02T10:47:15Z

← Older revision		Revision as of 12:47, 2 July 2021
Line 165:		Line 165:
	</code>		</code>

	==The ~~Screenout Link~~== <!--T:82-->		==The screenout link== <!--T:82-->


Line 181:		Line 181:
	<!--T:86-->		<!--T:86-->
	<div class="simplebox">[[File:help.png]] '''Note:''' Read the following wiki section to find out more about the [[Survey quotas\|LimeSurvey quota system and its usage.]]</div>		<div class="simplebox">[[File:help.png]] '''Note:''' Read the following wiki section to find out more about the [[Survey quotas\|LimeSurvey quota system and its usage.]]</div>


	==The Quotafull Link== <!--T:87-->		==The Quotafull Link== <!--T:87-->

Vharris at 10:46, 2 July 2021

2021-07-02T10:46:59Z

← Older revision		Revision as of 12:46, 2 July 2021
Line 151:		Line 151:


	==The ~~Complete Link~~== <!--T:78-->		==The complete link== <!--T:78-->


Line 164:		Line 164:
	<nowiki>https://panelproviderwebsite.com/?return=complete&parametername={PASSTHRU:parametername}</nowiki>		<nowiki>https://panelproviderwebsite.com/?return=complete&parametername={PASSTHRU:parametername}</nowiki>
	</code>		</code>


	==The Screenout Link== <!--T:82-->		==The Screenout Link== <!--T:82-->

Vharris at 10:46, 2 July 2021

2021-07-02T10:46:34Z

← Older revision		Revision as of 12:46, 2 July 2021
Line 27:		Line 27:
	<center>[[File:Panel integration - tab.png]]</center>		<center>[[File:Panel integration - tab.png]]</center>

	=Survey ~~Panel Integration~~= <!--T:48-->		=Survey panel integration= <!--T:48-->


Line 52:		Line 52:


	==How to ~~Use~~ the ~~Panel Integration Function~~== <!--T:54-->		==How to use the panel integration function== <!--T:54-->

Vharris at 08:34, 20 May 2021

2021-05-20T08:34:29Z

← Older revision		Revision as of 10:34, 20 May 2021
Line 7:		Line 7:

	<!--T:43-->		<!--T:43-->
	<div class="simplebox">[[File:help.png]] The ~~below~~ examples and explanations are based entirely on our users' contributions. Feel free to contribute if you ~~wish~~ to expand our open knowledge about panel integration.</div>		<div class="simplebox">[[File:help.png]] The following examples and explanations are based entirely on our users' contributions. Feel free to contribute if you want to help to expand our open knowledge about panel integration.</div>


Line 18:		Line 18:

	<!--T:45-->		<!--T:45-->
	{{Alert\|title=Attention\|text=With some providers, the unique ID of the participant that ~~is dropping out~~ due to a quota limitation or when finishing the survey, needs to be sent back to the panel provider in the survey end URL or quota URL.}}		{{Alert\|title=Attention\|text=With some providers, the unique ID of the participant that will be omitted due to a quota limitation or when finishing the survey, needs to be sent back to the panel provider in the survey end URL or quota URL.}}

Vharris at 08:29, 20 May 2021

2021-05-20T08:29:31Z

← Older revision		Revision as of 10:29, 20 May 2021
Line 27:		Line 27:
	<center>[[File:Panel integration - tab.png]]</center>		<center>[[File:Panel integration - tab.png]]</center>

	=Survey ~~panel integration~~= <!--T:48-->		=Survey Panel Integration= <!--T:48-->

Vharris at 08:14, 14 May 2021

2021-05-14T08:14:42Z

← Older revision		Revision as of 10:14, 14 May 2021
Line 136:		Line 136:

	<!--T:74-->		<!--T:74-->
	The following examples were created ~~in order~~ to help you ~~easily~~ add:		The following examples were created to help you add:

	<!--T:75-->		<!--T:75-->
Line 144:		Line 144:

	<!--T:76-->		<!--T:76-->
	<div class="simplebox">[[File:help.png]] '''Note:''' parametername={PASSTHRU:parametername}" provides the panel provider the id of the ~~respondent~~.</div>		<div class="simplebox">[[File:help.png]] '''Note:''' parametername={PASSTHRU:parametername}" provides the panel provider the id of the participant.</div>


	<!--T:77-->		<!--T:77-->
	{{Alert\|title=Attention\|text=The solutions provided below make use of the [[URL_fields#Passthrough_fields\|'''passthrough fields''']]. Please note that ~~aside~~ "'''parametername={PASSTHRU:parametername}'''", everything else has to be provided by your panel provider!}}		{{Alert\|title=Attention\|text=The solutions provided below make use of the [[URL_fields#Passthrough_fields\|'''passthrough fields''']]. Please note that besides "'''parametername={PASSTHRU:parametername}'''", everything else has to be provided by your panel provider!}}


	==The ~~complete link~~== <!--T:78-->		==The Complete Link== <!--T:78-->


	<!--T:79-->		<!--T:79-->
	The complete link ~~has to~~ be inserted into [[Text elements\|the end URL field]] that also has [[Presentation#Presentation_panel\|to be loaded automatically]] for everyone who successfully completes the whole survey.		The complete link must be inserted into [[Text elements\|the end URL field]] that also has [[Presentation#Presentation_panel\|to be loaded automatically]] for everyone who successfully completes the whole survey.

	<!--T:80-->		<!--T:80-->
Line 166:		Line 166:


	==The ~~screenout link~~== <!--T:82-->		==The Screenout Link== <!--T:82-->


	<!--T:83-->		<!--T:83-->
	A screenout ~~excludes~~ the participants from continuing the survey because he or she is not a member of your survey target group. For screenouts, you have to set the quota limit field to "0" (zero) and allow the quota URL to be automatically loaded once it was triggered.		A screenout prevents the participants from continuing the survey because he or she is not a member of your survey target group. For screenouts, you have to set the quota limit field to "0" (zero) and allow the quota URL to be automatically loaded once it was triggered.

	<!--T:84-->		<!--T:84-->
Line 184:		Line 184:


	==The ~~quotafull link~~== <!--T:87-->		==The Quotafull Link== <!--T:87-->

Vharris at 08:08, 14 May 2021

2021-05-14T08:08:46Z

← Older revision		Revision as of 10:08, 14 May 2021
Line 70:		Line 70:

	<!--T:59-->		<!--T:59-->
	Select the short/long text question you created in the first step. The ~~respondents~~ that come from the respective professional panel provider will land on the '''target question'''. It can be hidden so that the ~~respondents~~ can ~~directly~~ start completing the survey.		Select the short/long text question you created in the first step. The participants that come from the respective professional panel provider will land on the '''target question'''. It can be hidden so that the participants can start completing the survey.


Line 78:		Line 78:

	<!--T:61-->		<!--T:61-->
	The name you pick for the parameter will have to be included in the entry link that you will later supply to your panel provider. It will be named "LSid" in our example. Don't forget to click on the '''Save''' button located in the upper right part of the table!		The name you pick for the parameter will have to be included in the entry link that you will later supply to your panel provider. It will be named "LSid" in our example. Don't forget to click the '''Save''' button located in the upper right part of the table!


	<!--T:62-->		<!--T:62-->
	3) Now, you have to set up the entry link that you will send to the your panel provider. To get your survey URL link, click on the '''Preview survey''' buttons.		3) Now, you have to set up the entry link that you will send to the your panel provider. To get your survey URL link, click the '''Preview survey''' buttons.


Line 98:		Line 98:

	<!--T:92-->		<!--T:92-->
	<div class="simplebox">[[File:help.png]] '''Hint''': The "newtest" parameter is used ~~in order~~ to reset the session. This is useful when you wish to test locally the panel integration or when you know that your ~~respondents~~ are using the same device/browser to fill out the survey. Therefore, adding "newtest=Y" in the survey URL creates new answers in the responses table by forcing the creation of a new session regardless of the used device/browser..</div>		<div class="simplebox">[[File:help.png]] '''Hint''': The "newtest" parameter is used to reset the session. This is useful when you wish to test locally the panel integration or when you know that your participants are using the same device/browser to fill out the survey. Therefore, adding "newtest=Y" in the survey URL creates new answers in the responses table by forcing the creation of a new session regardless of the used device/browser..</div>


Line 114:		Line 114:

	<!--T:69-->		<!--T:69-->
	What ever you replace the "xxxxxx" with will be ~~grabbed and~~ stored in the short/long free text question when your respondent lands on that page. For example, I sent to a user the following link:		What ever you replace the "xxxxxx" with will be stored in the short/long free text question when your respondent lands on that page. For example, I sent to a user the following link:

	<!--T:70-->		<!--T:70-->