Central Participant Database - Revision history

Ollehar at 10:58, 24 November 2022

2022-11-24T10:58:24Z

← Older revision		Revision as of 12:58, 24 November 2022
Line 16:		Line 16:
	<!--T:4-->		<!--T:4-->
	This feature allows the administrator to store the participant information in a central table that is independent of any survey participants table. Its major advantages are:		This feature allows the administrator to store the participant information in a central table that is independent of any survey participants table. Its major advantages are:
	* The central table acts as a backup. If a user creates a new survey, they will not have to ~~exoirt~~ its participants to a CSV file and then import them back into a new survey.		* The central table acts as a backup. If a user creates a new survey, they will not have to export its participants to a CSV file and then import them back into a new survey.
	* Users need only to add the participants to the central table. Then, the same participants can be added to as many surveys as the user wants.		* Users need only to add the participants to the central table. Then, the same participants can be added to as many surveys as the user wants.
	* In case multiple users have access to a LimeSurvey installation, its owner(s) can choose to share their participants with other users and also set access rights for the shared users.		* In case multiple users have access to a LimeSurvey installation, its owner(s) can choose to share their participants with other users and also set access rights for the shared users.

Vharris at 10:14, 25 May 2021

2021-05-25T10:14:00Z

← Older revision		Revision as of 12:14, 25 May 2021
Line 95:		Line 95:
	To edit the basic and/or custom attributes of a participant, click the first button (from left to right) located in the '''Action''' column ([[File:Edit participant CPDB.png]]). A window with all the available attributes will be displayed.		To edit the basic and/or custom attributes of a participant, click the first button (from left to right) located in the '''Action''' column ([[File:Edit participant CPDB.png]]). A window with all the available attributes will be displayed.

	===Delete ~~Participant~~=== <!--T:47-->		===Delete participant=== <!--T:47-->

	<!--T:49-->		<!--T:49-->

Vharris at 10:13, 25 May 2021

2021-05-25T10:13:32Z

← Older revision		Revision as of 12:13, 25 May 2021
Line 23:		Line 23:
	You may also find in your LimeSurvey installation an advanced [[Central Participant Database#Attributes\|attribute control]] and several other features.		You may also find in your LimeSurvey installation an advanced [[Central Participant Database#Attributes\|attribute control]] and several other features.

	=The ~~Participants Panel Management Tools~~= <!--T:6-->		=The participants panel management tools= <!--T:6-->

	<!--T:164-->		<!--T:164-->
Line 43:		Line 43:
	*[[Central_Participant_Database#Export_participants\|Export all participants]]		*[[Central_Participant_Database#Export_participants\|Export all participants]]

	== Display CPDB ~~Participants~~ == <!--T:28-->		== Display CPDB participants == <!--T:28-->

	<!--T:29-->		<!--T:29-->
Line 67:		Line 67:
	{{Box\|Before accessing the options mentioned above, you must have users listed in your database. To create them, click the '''[[Central Participant Database#Add participant\|Add new participant]]''' button, located in the upper-right part of the window.}}		{{Box\|Before accessing the options mentioned above, you must have users listed in your database. To create them, click the '''[[Central Participant Database#Add participant\|Add new participant]]''' button, located in the upper-right part of the window.}}

	===Add ~~Participant~~=== <!--T:45-->		===Add participant=== <!--T:45-->

	<!--T:46-->		<!--T:46-->
Line 90:		Line 90:
	{{Box\|'''Custom attributes''' can be added. For further details, see the [[Central Participant Database#Attributes\|attributes]] and [[Central Participant Database#Examples\|examples]] sections.}}		{{Box\|'''Custom attributes''' can be added. For further details, see the [[Central Participant Database#Attributes\|attributes]] and [[Central Participant Database#Examples\|examples]] sections.}}

	===Edit ~~Participant~~=== <!--T:172-->		===Edit participant=== <!--T:172-->

	<!--T:173-->		<!--T:173-->
Line 123:		Line 123:
	{{Alert\|title=Attention\|text=Please note that in all the three scenarios, the links created for the purpose of maintaining a participant's history are also deleted.}}		{{Alert\|title=Attention\|text=Please note that in all the three scenarios, the links created for the purpose of maintaining a participant's history are also deleted.}}

	===Share ~~Participant~~=== <!--T:59-->		===Share participant=== <!--T:59-->

	<!--T:83-->		<!--T:83-->
Line 132:		Line 132:
	<center>[[File:shareParticipant.png]]</center>		<center>[[File:shareParticipant.png]]</center>

	===List ~~Active Surveys~~=== <!--T:60-->		===List active surveys=== <!--T:60-->

	<!--T:175-->		<!--T:175-->
	If you click the next icon ([[File:List active surveys CPDB.png]]), all the active surveys where the respective participant has been added to will be listed.		If you click the next icon ([[File:List active surveys CPDB.png]]), all the active surveys where the respective participant has been added to will be listed.

	===Add ~~Participant To Survey~~=== <!--T:61-->		===Add participant to survey=== <!--T:61-->

	<!--T:86-->		<!--T:86-->
Line 239:		Line 239:
	'''Optional fields''': firstname, lastname, blacklisted, language}}		'''Optional fields''': firstname, lastname, blacklisted, language}}

	===Steps ~~To Import~~=== <!--T:110-->		===Steps to import=== <!--T:110-->

	<!--T:111-->		<!--T:111-->
Line 266:		Line 266:
	Clicking ''OK'' will redirect you to the participants screen, showing you the newly imported participants.		Clicking ''OK'' will redirect you to the participants screen, showing you the newly imported participants.

	==Blacklist ~~Settings~~== <!--T:78-->		==Blacklist settings== <!--T:78-->

	<!--T:181-->		<!--T:181-->
Line 365:		Line 365:
	This information is for viewing/sorting purposes. Only the '''Can Edit''' field is editable for the user. The '''Can edit''' field allows you to determine whether to allow the respective participant to be editable by the user with whom that participant was shared with or not. Clicking on the check box will make an AJAX call and save the changes on the server.		This information is for viewing/sorting purposes. Only the '''Can Edit''' field is editable for the user. The '''Can edit''' field allows you to determine whether to allow the respective participant to be editable by the user with whom that participant was shared with or not. Clicking on the check box will make an AJAX call and save the changes on the server.

	==Export ~~Participants~~== <!--T:179-->		==Export participants== <!--T:179-->

	<!--T:62-->		<!--T:62-->
Line 398:		Line 398:
	To export filtered participants, use first the [[Central Participant Database#Search filters\|search filters]]. Then. click the checkbox located on the left side of the '''Action''' column (to select all the filtered participants). Then, click the '''Selected participant(s)...''' button located at the bottom-right side of the table and select the export function. In this way, only the '''filtered participants''' will be exported.		To export filtered participants, use first the [[Central Participant Database#Search filters\|search filters]]. Then. click the checkbox located on the left side of the '''Action''' column (to select all the filtered participants). Then, click the '''Selected participant(s)...''' button located at the bottom-right side of the table and select the export function. In this way, only the '''filtered participants''' will be exported.

	==Search ~~Filters~~== <!--T:69-->		==Search filters== <!--T:69-->

	<!--T:206-->		<!--T:206-->

Vharris at 13:09, 21 May 2021

2021-05-21T13:09:06Z

← Older revision		Revision as of 15:09, 21 May 2021
Line 409:		Line 409:

	<!--T:208-->		<!--T:208-->
	~~You may type a string of characters according to which you wish to filter our~~ the ~~participants~~ or select from the dropdown lists (when possible) the participants you ~~wish~~ to be listed after the filtering process.		Enter information in the search fields or select from the dropdown lists (when possible) the participants you want to be listed after the filtering process.

	=Additional information= <!--T:160-->		=Additional information= <!--T:160-->

Vharris at 12:58, 21 May 2021

2021-05-21T12:58:54Z

← Older revision		Revision as of 14:58, 21 May 2021
Line 396:		Line 396:

	<!--T:205-->		<!--T:205-->
	To export filtered participants, use first the [[Central Participant Database#Search filters\|search filters]]. Then. click on the checkbox located on the left side of the '''Action''' column (to select all the filtered participants). Then, click on the '''Selected participant(s)...''' button located at the bottom-right side of the table and select the export function. In this way, only the '''filtered participants''' will be exported.		To export filtered participants, use first the [[Central Participant Database#Search filters\|search filters]]. Then. click the checkbox located on the left side of the '''Action''' column (to select all the filtered participants). Then, click the '''Selected participant(s)...''' button located at the bottom-right side of the table and select the export function. In this way, only the '''filtered participants''' will be exported.

	==Search Filters== <!--T:69-->		==Search Filters== <!--T:69-->

Vharris at 12:58, 21 May 2021

2021-05-21T12:58:05Z

← Older revision		Revision as of 14:58, 21 May 2021
Line 363:		Line 363:

	<!--T:157-->		<!--T:157-->
	~~All this~~ information is for viewing/sorting purposes. Only the '''Can Edit''' field is editable for the user. The '''Can edit''' field ~~determines~~ whether to allow the respective participant to be editable by the user with whom that participant was shared with or not. ~~Just clicking~~ on the check box will make an AJAX call and save the changes on the server.		This information is for viewing/sorting purposes. Only the '''Can Edit''' field is editable for the user. The '''Can edit''' field allows you to determine whether to allow the respective participant to be editable by the user with whom that participant was shared with or not. Clicking on the check box will make an AJAX call and save the changes on the server.

	==Export Participants== <!--T:179-->		==Export Participants== <!--T:179-->

Vharris at 12:54, 21 May 2021

2021-05-21T12:54:21Z

← Older revision		Revision as of 14:54, 21 May 2021
Line 288:		Line 288:

	<!--T:183-->		<!--T:183-->
	To access the '''Attributes management''' panel, click on the '''Attributes''' button located on the main toolbar of CPDB main page: [[File:Attributes management icon.png]]		To access the '''Attributes management''' panel, click the '''Attributes''' button located on the main toolbar of CPDB main page: [[File:Attributes management icon.png]]


Line 296:		Line 296:

	<!--T:127-->		<!--T:127-->
	The attribute management facilitates the addition of three types of attributes: ''text box, date, and drop-down list''. To add a new attribute, click ~~on the~~ '''Add new attribute''' located in the upper-right part of the window:		The attribute management facilitates the addition of three types of attributes: ''text box, date, and drop-down list''. To add a new attribute, click t'''Add new attribute''' located in the upper-right part of the window:


Line 311:		Line 311:

	<!--T:185-->		<!--T:185-->
	Once the changes are done, click ~~on the~~ '''Save''' ~~button~~.		Once the changes are done, click '''Save'''.

	<!--T:200-->		<!--T:200-->
	<div class='simplebox'>[[File:help.png]] We recommend you to write the name of the attribute in the corresponding language box even if you use only one language (the base language). The reason for this is that when you map attributes and you wish to add them to different survey participants table, the '''defaultname''' of the attribute is not displayed in the respective panel - only the name you give in the corresponding language box is shown.</div>		<div class='simplebox'>[[File:help.png]] We recommend tha you write the name of the attribute in the corresponding language box even if you use only one language (the base language). The reason for this is that when you map attributes and you wish to add them to different survey participants table, the '''defaultname''' of the attribute is not displayed in the respective panel - only the name you give in the corresponding language box is shown.</div>

	<!--T:186-->		<!--T:186-->
Line 323:		Line 323:

	<!--T:188-->		<!--T:188-->
	If you click on the first icon, a dialog box will ~~show up~~. It includes the basic settings of the selected attribute that can be edited according to your needs.		If you click the first icon, a dialog box will be displayed. It includes the basic settings of the selected attribute that can be edited according to your needs.

	<!--T:137-->		<!--T:137-->

Vharris at 12:45, 21 May 2021

2021-05-21T12:45:32Z

← Older revision		Revision as of 14:45, 21 May 2021
Line 283:		Line 283:
	*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.		*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.
	*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.		*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.
	*'''Allow participant to un-blacklist ~~themself~~''': If ''Yes'', participants can un-blacklist themselves without the help of a LimeSurvey user.		*'''Allow participant to un-blacklist himself/herself''': If ''Yes'', participants can un-blacklist themselves without the help of a LimeSurvey user.

	==Attributes== <!--T:126-->		==Attributes== <!--T:126-->

Vharris at 12:44, 21 May 2021

2021-05-21T12:44:16Z

← Older revision		Revision as of 14:44, 21 May 2021
Line 283:		Line 283:
	*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.		*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.
	*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.		*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.
	*'''Allow participant to un-blacklist themself''': If ''Yes'', ~~a participant~~ can un-blacklist ~~themself~~ without the help of a LimeSurvey user.		*'''Allow participant to un-blacklist themself''': If ''Yes'', participants can un-blacklist themselves without the help of a LimeSurvey user.

	==Attributes== <!--T:126-->		==Attributes== <!--T:126-->

Vharris at 12:43, 21 May 2021

2021-05-21T12:43:08Z

← Older revision		Revision as of 14:43, 21 May 2021
Line 269:		Line 269:

	<!--T:181-->		<!--T:181-->
	The '''Blacklist settings''' button is available on the main toolbar of the '''Central participant database''' page. Once you click on it, the following page will be ~~loaded:~~		The '''Blacklist settings''' button is available on the main toolbar of the '''Central participant database''' page. Once you click it, the following page will be displayed.


Line 277:		Line 277:

	<!--T:182-->		<!--T:182-->
	The following Yes/No options are available:		The following ''Yes/No'' options are available:
	*'''Blacklist all current surveys for participant once the global field is set''': If set to ''Yes'', the blacklisted participant(s) cannot be added to any survey.		*'''Blacklist all current surveys for participant once the global field is set''': If set to ''Yes'', the blacklisted participant(s) cannot be added to any survey.
	*'''Blacklist participant for any new added survey once the global field is set''': If new surveys are created, the respective participant(s) cannot be added to them (if ''Yes'' is picked up). However, he can still be added to those surveys created earlier.		*'''Blacklist participant for any new added survey once the global field is set''': If new surveys are created, the respective participant(s) cannot be added to them (if ''Yes'' is picked up). However, they can still be added to those surveys created earlier.
	*'''Allow blacklisted participants to be added to a survey''': Even if a participant is blacklisted, he can still be added to a survey.		*'''Allow blacklisted participants to be added to a survey''': Even if a participant is blacklisted, they can still be added to a survey.
	*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.		*'''Hide blacklisted participants''': Useful function when you would like to hide participant for a specific amount of time and then make them available for the rest of users with whom those blacklisted participants have been shared with.
	*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.		*'''Delete globally blacklisted participants from the database''': If ''Yes'', the blacklisted participants will be deleted from the database.
	*'''Allow participant to un-blacklist ~~himself/herself~~''': If ''Yes'', a participant can un-blacklist ~~himself~~ without the help of a LimeSurvey user.		*'''Allow participant to un-blacklist themself''': If ''Yes'', a participant can un-blacklist themself without the help of a LimeSurvey user.

	==Attributes== <!--T:126-->		==Attributes== <!--T:126-->