LimeSurvey Manual - User contributions [en]

Panel integration/zh-cn

2018-05-06T03:34:54Z

Lnmuhuanghe: Created page with "为了访问您的调查面板集成，转到“调查菜单”，然后点击“面板集成”标签。"

<languages />

__TOC__

<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>

=Introduction=

您可以从这个选项卡设置哪些URL参数将被您的调查接受（这些参数将附加到普查开始URL）。如果你想把你的调查与专业调查小组提供你的参与者，这个选项是很重要的。后者通常交出每个调查参与者的唯一ID，您将需要保存/处理这些独特的ID以供进一步参考。

对于某些供应商，由于配额限制或完成调查而退出的参与者的唯一ID需要在调查结束URL或配额URL中发送回面板提供商。

为了访问您的调查面板集成，转到“调查菜单”，然后点击“面板集成”标签。

<center>[[File:Panel integration - tab.png]]</center>

=Survey panel integration=

Once accessed, an empty table will be displayed with the option that allows you ''to add an URL parameter''.

<center>[[File:Add URL parameter button.png]]</center>

Two fields will have to be filled out:

<center>[[File:Add URL parameter.png]]</center>

*'''Parameter:''' Type in this field the name of the new parameter. It will be included in the URL;
*'''Target question:''' Generally, the URL parameter is saved as a question. It will represent the place where the survey respondents will land on once they click on the link that also includes in its URL the parameter defined above.

<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 [[Text elements|end URL]]. For further documentation, continue reading the [[URL_fields#Passthrough_fields|End-URL]] wiki section.</div>

==How to use the panel integration function==

A [https://www.limesurvey.org/forum/design-issues/95878-how-to-use-the-panel-integration-fuction simple example] is presented below in which we try to explain how to use the panel integration function

1) First, create a short/long 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.

{{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!}}

2) Go to the panel integration tab, and click on the "Add URL parameter".

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.

<center>[[File:Example - add URL parameter.png]]</center>

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!

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.

<center>[[File:Find the URL - panel integration.png]]</center>

Copy the URL you accessed from the address bar:

<center>[[File:URL preview question - panel integration.png]]</center>

Add at the end the newly added parameter: &LSid="xxxxxx". The link should look like this:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid="xxxxxx"</nowiki>
</code>

<div class="simplebox">[[File:help.png]] '''Hint''': The GET parameters use "?" for the first parameter and "&" for the rest of them. If you already have "?" in your URL, you must use "&" to add other GET parameters. Read about [[URL_fields#Prefilling_a_survey_using_GET_parameters|the GET parameters and their usage here]].</div>

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:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid=ABCD5</nowiki>
</code>

The string after LSid was stored as an answer to the short/long text question.

<center>[[File:ABCD5 - panel integration.png]]</center>

{{Note|Read the [[URL fields]] wiki section for more information on URL customization.}}

=Examples=
The following examples were created in order to help you easily add:

*[[Panel integration#The complete link|Redirects if the respondents have finished filling out the survey]];
*[[Panel integration#The screenout link|Redirects if the respondents were screened out due to a quota]];
*[[Panel integration#The quota-full|Redirects link if the quota limit was reached]].

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

{{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!}}

==The complete link==

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 URL you have to send back to the panel provider should look like this:

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

==The screenout link==

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.

Then, add the following link into the quota URL field:

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

<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==

A quotafull excludes participants from continuing the survey, because a certain quota has been exceeded.
<code>
<nowiki>https://panelproviderwebsite.com/?return=quotafull&parametername={PASSTHRU:parametername}</nowiki>
</code>

<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>

{{Box|This is not the only solution you can use to implement quotafull, complete, screenout redirects to your panel provider! For example, the [[Expression Manager]], the [[SGQA_identifier|SQGA indentifiers]], and the [[URL fields]] offer you different workarounds to complete the same tasks (and even the more complex ones). For additional help, check also the [https://www.limesurvey.org/forum LimeSurvey forum].}}

Translations:Panel integration/46/zh-cn

2018-05-06T03:34:54Z

Lnmuhuanghe: Created page with "为了访问您的调查面板集成，转到“调查菜单”，然后点击“面板集成”标签。"

为了访问您的调查面板集成，转到“调查菜单”，然后点击“面板集成”标签。

Panel integration/zh-cn

2018-05-06T03:34:29Z

Lnmuhuanghe: Created page with "对于某些供应商，由于配额限制或完成调查而退出的参与者的唯一ID需要在调查结束URL或配额URL中发送回面板提供商。"

<languages />

__TOC__

<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>

=Introduction=

您可以从这个选项卡设置哪些URL参数将被您的调查接受（这些参数将附加到普查开始URL）。如果你想把你的调查与专业调查小组提供你的参与者，这个选项是很重要的。后者通常交出每个调查参与者的唯一ID，您将需要保存/处理这些独特的ID以供进一步参考。

对于某些供应商，由于配额限制或完成调查而退出的参与者的唯一ID需要在调查结束URL或配额URL中发送回面板提供商。

In order to access your survey's panel integration, go to the '''survey menu''' and click on the '''Panel integration''' tab.

<center>[[File:Panel integration - tab.png]]</center>

=Survey panel integration=

Once accessed, an empty table will be displayed with the option that allows you ''to add an URL parameter''.

<center>[[File:Add URL parameter button.png]]</center>

Two fields will have to be filled out:

<center>[[File:Add URL parameter.png]]</center>

*'''Parameter:''' Type in this field the name of the new parameter. It will be included in the URL;
*'''Target question:''' Generally, the URL parameter is saved as a question. It will represent the place where the survey respondents will land on once they click on the link that also includes in its URL the parameter defined above.

<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 [[Text elements|end URL]]. For further documentation, continue reading the [[URL_fields#Passthrough_fields|End-URL]] wiki section.</div>

==How to use the panel integration function==

A [https://www.limesurvey.org/forum/design-issues/95878-how-to-use-the-panel-integration-fuction simple example] is presented below in which we try to explain how to use the panel integration function

1) First, create a short/long 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.

{{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!}}

2) Go to the panel integration tab, and click on the "Add URL parameter".

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.

<center>[[File:Example - add URL parameter.png]]</center>

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!

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.

<center>[[File:Find the URL - panel integration.png]]</center>

Copy the URL you accessed from the address bar:

<center>[[File:URL preview question - panel integration.png]]</center>

Add at the end the newly added parameter: &LSid="xxxxxx". The link should look like this:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid="xxxxxx"</nowiki>
</code>

<div class="simplebox">[[File:help.png]] '''Hint''': The GET parameters use "?" for the first parameter and "&" for the rest of them. If you already have "?" in your URL, you must use "&" to add other GET parameters. Read about [[URL_fields#Prefilling_a_survey_using_GET_parameters|the GET parameters and their usage here]].</div>

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:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid=ABCD5</nowiki>
</code>

The string after LSid was stored as an answer to the short/long text question.

<center>[[File:ABCD5 - panel integration.png]]</center>

{{Note|Read the [[URL fields]] wiki section for more information on URL customization.}}

=Examples=
The following examples were created in order to help you easily add:

*[[Panel integration#The complete link|Redirects if the respondents have finished filling out the survey]];
*[[Panel integration#The screenout link|Redirects if the respondents were screened out due to a quota]];
*[[Panel integration#The quota-full|Redirects link if the quota limit was reached]].

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

{{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!}}

==The complete link==

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 URL you have to send back to the panel provider should look like this:

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

==The screenout link==

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.

Then, add the following link into the quota URL field:

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

<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==

A quotafull excludes participants from continuing the survey, because a certain quota has been exceeded.
<code>
<nowiki>https://panelproviderwebsite.com/?return=quotafull&parametername={PASSTHRU:parametername}</nowiki>
</code>

<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>

{{Box|This is not the only solution you can use to implement quotafull, complete, screenout redirects to your panel provider! For example, the [[Expression Manager]], the [[SGQA_identifier|SQGA indentifiers]], and the [[URL fields]] offer you different workarounds to complete the same tasks (and even the more complex ones). For additional help, check also the [https://www.limesurvey.org/forum LimeSurvey forum].}}

Translations:Panel integration/45/zh-cn

2018-05-06T03:34:29Z

Lnmuhuanghe: Created page with "对于某些供应商，由于配额限制或完成调查而退出的参与者的唯一ID需要在调查结束URL或配额URL中发送回面板提供商。"

对于某些供应商，由于配额限制或完成调查而退出的参与者的唯一ID需要在调查结束URL或配额URL中发送回面板提供商。

Panel integration/zh-cn

2018-05-06T03:33:38Z

Lnmuhuanghe: Created page with "您可以从这个选项卡设置哪些URL参数将被您的调查接受（这些参数将附加到普查开始URL）。如果你想把你的调查与专业调查小组提供..."

<languages />

__TOC__

<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>

=Introduction=

您可以从这个选项卡设置哪些URL参数将被您的调查接受（这些参数将附加到普查开始URL）。如果你想把你的调查与专业调查小组提供你的参与者，这个选项是很重要的。后者通常交出每个调查参与者的唯一ID，您将需要保存/处理这些独特的ID以供进一步参考。

{{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.}}

In order to access your survey's panel integration, go to the '''survey menu''' and click on the '''Panel integration''' tab.

<center>[[File:Panel integration - tab.png]]</center>

=Survey panel integration=

Once accessed, an empty table will be displayed with the option that allows you ''to add an URL parameter''.

<center>[[File:Add URL parameter button.png]]</center>

Two fields will have to be filled out:

<center>[[File:Add URL parameter.png]]</center>

*'''Parameter:''' Type in this field the name of the new parameter. It will be included in the URL;
*'''Target question:''' Generally, the URL parameter is saved as a question. It will represent the place where the survey respondents will land on once they click on the link that also includes in its URL the parameter defined above.

<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 [[Text elements|end URL]]. For further documentation, continue reading the [[URL_fields#Passthrough_fields|End-URL]] wiki section.</div>

==How to use the panel integration function==

A [https://www.limesurvey.org/forum/design-issues/95878-how-to-use-the-panel-integration-fuction simple example] is presented below in which we try to explain how to use the panel integration function

1) First, create a short/long 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.

{{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!}}

2) Go to the panel integration tab, and click on the "Add URL parameter".

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.

<center>[[File:Example - add URL parameter.png]]</center>

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!

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.

<center>[[File:Find the URL - panel integration.png]]</center>

Copy the URL you accessed from the address bar:

<center>[[File:URL preview question - panel integration.png]]</center>

Add at the end the newly added parameter: &LSid="xxxxxx". The link should look like this:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid="xxxxxx"</nowiki>
</code>

<div class="simplebox">[[File:help.png]] '''Hint''': The GET parameters use "?" for the first parameter and "&" for the rest of them. If you already have "?" in your URL, you must use "&" to add other GET parameters. Read about [[URL_fields#Prefilling_a_survey_using_GET_parameters|the GET parameters and their usage here]].</div>

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:

<code>
<nowiki>http://localhost/index.php/369498?newtest=Y&lang=en&LSid=ABCD5</nowiki>
</code>

The string after LSid was stored as an answer to the short/long text question.

<center>[[File:ABCD5 - panel integration.png]]</center>

{{Note|Read the [[URL fields]] wiki section for more information on URL customization.}}

=Examples=
The following examples were created in order to help you easily add:

*[[Panel integration#The complete link|Redirects if the respondents have finished filling out the survey]];
*[[Panel integration#The screenout link|Redirects if the respondents were screened out due to a quota]];
*[[Panel integration#The quota-full|Redirects link if the quota limit was reached]].

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

{{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!}}

==The complete link==

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 URL you have to send back to the panel provider should look like this:

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

==The screenout link==

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.

Then, add the following link into the quota URL field:

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

<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==

A quotafull excludes participants from continuing the survey, because a certain quota has been exceeded.
<code>
<nowiki>https://panelproviderwebsite.com/?return=quotafull&parametername={PASSTHRU:parametername}</nowiki>
</code>

<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>

{{Box|This is not the only solution you can use to implement quotafull, complete, screenout redirects to your panel provider! For example, the [[Expression Manager]], the [[SGQA_identifier|SQGA indentifiers]], and the [[URL fields]] offer you different workarounds to complete the same tasks (and even the more complex ones). For additional help, check also the [https://www.limesurvey.org/forum LimeSurvey forum].}}

Translations:Panel integration/41/zh-cn

2018-05-06T03:33:38Z

您可以从这个选项卡设置哪些URL参数将被您的调查接受（这些参数将附加到普查开始URL）。如果你想把你的调查与专业调查小组提供你的参与者，这个选项是很重要的。后者通常交出每个调查参与者的唯一ID，您将需要保存/处理这些独特的ID以供进一步参考。