Actions

Difference between revisions of "Central Participant Database/ru"

From LimeSurvey Manual

m (FuzzyBot moved page Central participants database/ru to Central Participant Database/ru without leaving a redirect: Part of translatable page "Central participants database".)
(Updating to match new version of source page)
Line 2: Line 2:
 
__TOC__
 
__TOC__
  
<div class="simplebox">This feature is available since LimeSurvey version 2.0.</div>
+
=Introduction=
 +
 
 +
To access this option: '''Configuration''' -> '''Central Participant Database''':
  
=Introduction=
 
  
To access this option: '''Configuration'''->'''Central participants database''':
 
 
<center>[[File:Central participants database.png]]</center>  
 
<center>[[File:Central participants database.png]]</center>  
  
This feature allows the administrator to store the participant information to a central table that is independent of any token table. Its major advantages are:
+
 
 +
This feature allows the administrator to store the participant information into a central table that is independent of any survey participants table. Its major advantages are:
 
* The central table acts as a backup. In the case in which a user creates a new survey, he does not have to go through the trouble of exporting its participants to a CSV file and then importing them back into a new survey.
 
* The central table acts as a backup. In the case in which a user creates a new survey, he does not have to go through the trouble of exporting its participants to a CSV file and then importing 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 his 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 his participants with other users and also set access rights for the shared users.
  
You may also find in your LimeSurvey installation an advanced [[Central participants 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=
 
=The participants panel management tools=
Line 20: Line 21:
 
The following options are available:
 
The following options are available:
  
<center>[[File:The participants panel management tools.png]]</center>
 
  
*[[Central participants database#Display CPDB participants|Display CPDB (Central Participant Database) participants]]  
+
<center>[[File:LimeSurvey2.05_ParticipantPanel_ru.jpg]]</center>
*[[Central participants database#Info|Info]]
+
 
*[[Central participants database#Import|Import]]
+
 
*[[Central participants database#Export|Export]]
+
*[[Central Participant Database#Display CPDB participants|Display CPDB (Central Participant Database) participants]]  
*[[Central participants database#Settings|Settings]]
+
*[[Central Participant Database#Info|Info]]
*[[Central participants database#Attributes|Attributes]]
+
*[[Central Participant Database#Import|Import]]
*[[Central participants database#Share panel|Share panel]]
+
*[[Central Participant Database#Export participants|Export participants]]
 +
*[[Central Participant Database#Blacklist settings|Blacklist settings]]
 +
*[[Central Participant Database#Attributes|Attributes]]
 +
*[[Central Participant Database#Share panel|Share panel]]
 +
*[[Central_Participant_Database#Export_all_participants|Export all participants]]
  
 
== Display CPDB participants ==
 
== Display CPDB participants ==
  
This is the main asset of this panel. The great majority of options can be accessed from here, such as adding, deleting, exporting, adding participants to surveys, and so on.
+
This is the main component of this panel. The great majority of options can be accessed from here, such as adding, deleting, exporting, adding participants to surveys, and so on.
  
 
Five options are available in the '''Action''' column for every participant listed in the table:
 
Five options are available in the '''Action''' column for every participant listed in the table:
 +
  
 
<center>[[File:LimeSurvey2.05_displayParticipant_ru.jpg]]</center>
 
<center>[[File:LimeSurvey2.05_displayParticipant_ru.jpg]]</center>
  
*[[Central participants database#Edit this participant|Edit this participant]]
 
*[[Central participants database#Delete this participant|Delete this participant]]
 
*[[Central participants database#Share this participant|Share this participant]]
 
*[[Central participants database#List active surveys|List active surveys]]
 
*[[Central participants database#Add participant to survey|Add participant to survey]]
 
  
{{Box|Before getting access to the options mentioned above, you need to have users listed in your database. To create them, click on the '''[[Central participants database#Add participant|Add new participant]]''' button, located in the upper-right part of the window.}}
+
*[[Central Participant Database#Edit participant|Edit this participant]]
 +
*[[Central Participant Database#Delete participant|Delete this participant]]
 +
*[[Central Participant Database#Share participant|Share this participant]]
 +
*[[Central Participant Database#List active surveys|List active surveys]]
 +
*[[Central Participant Database#Add participant to survey|Add participant to survey]]
 +
 
 +
{{Box|Before getting access to the options mentioned above, you need to have users listed in your database. To create them, click on the '''[[Central Participant Database#Add participant|Add new participant]]''' button, located in the upper-right part of the window.}}
  
 
===Add participant===
 
===Add participant===
Line 51: Line 57:
  
 
A dialog box with the following basic attributes will then appear:  
 
A dialog box with the following basic attributes will then appear:  
 +
  
 
<center>[[File:addParticipant.png]]</center>
 
<center>[[File:addParticipant.png]]</center>
 +
  
 
*'''First name'''
 
*'''First name'''
Line 60: Line 68:
 
*'''Owner''': Any user of LimeSurvey defined in the [[Manage_users#User_management|user control management page]] can be an owner.
 
*'''Owner''': Any user of LimeSurvey defined in the [[Manage_users#User_management|user control management page]] can be an owner.
  
{{Box|'''Custom attributes''' can be added. For further details, see the [[Central participants database#Attributes|attributes]] and [[Central participants database#Examples|examples]] section.}}
+
{{Box|'''Custom attributes''' can be added. For further details, see the [[Central Participant Database#Attributes|attributes]] and [[Central Participant Database#Examples|examples]] sections.}}
  
===Edit this participant===
+
===Edit participant===
  
To edit the basic and/or custom attributes of a participant, click on 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 show up.
+
To edit the basic and/or custom attributes of a participant, click on 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===
+
<center>[[File:LimeSurvey2.05_addParticipant_ru.jpg]]</center>
  
You can easily mark a single or more participant to delete:
+
You can easily delete one or multiple participants:
* If you want to delete one participant, go to the row where the respective participant is located and click on the red trash button: [[File:Delete participant CPDB.png]].
+
* If you want to delete one participant, go to the row where the respective participant is located and click on the red bin button: [[File:Delete participant CPDB.png]].
* If you want to delete two or more participants, click on the '''Selected participant(s)...''' button (under the last row, below the '''Action''' column) after you marked the respective participants: [[File:Select participants CPDB.png]]. Then, click on the delete option.  
+
* If you want to delete two or more participants, click on the '''Selected participant(s)...''' button (under the last row, below the '''Action''' column) after you selected the corresponding entries: [[File:Select participants CPDB.png]]. Then, click on the delete option.  
  
 
When you delete the participant(s), three options are available to you:
 
When you delete the participant(s), three options are available to you:
 +
  
 
<center>[[File:LimeSurvey2.05_deleteParticipant_ru.jpg]]</center>
 
<center>[[File:LimeSurvey2.05_deleteParticipant_ru.jpg]]</center>
  
1) '''Delete only from the central panel''': The first option deletes the participant from the central panel only. If the participant is in any token table, he/she will not be removed.
+
 
 +
1) '''Delete only from the central panel''': The first option deletes the participant from the central participant database only. If the participant is in any token table, he/she will not be removed.
  
 
2) '''Delete from the central panel and associated surveys''': The second option deletes the participant from central panel and from the surveys where he has been added to, but his responses are not deleted.
 
2) '''Delete from the central panel and associated surveys''': The second option deletes the participant from central panel and from the surveys where he has been added to, but his responses are not deleted.
Line 82: Line 92:
 
3) '''Delete from central panel, associated surveys and all associated responses''': The third option deletes all traces of that participant from the system, including his responses.
 
3) '''Delete from central panel, associated surveys and all associated responses''': The third option deletes all traces of that participant from the system, including his responses.
  
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 this participant===
+
===Share participant===
 +
 
 +
This is another important feature of the '''Central Participant Database'''. You can share your participants with other users. You just have to select the participant(s) you want to share and click either on the green right-arrow icon ([[File:Share participate CPDB.png]]) or on the '''Selected participant(s)...''' button situated in the bottom left part of the participants table. A modal box will open up which will allow you to select the user with whom you want to share the respective participant(s). You can also set whether the user who shares your participant can edit those participants. If you set it to ''No'', they will get an access denied error when trying to edit the entries of the shared participant.
  
This is another important feature of the Central Participants Database. You can share your participants with other users. You just have to select the participant(s) you want to share and click either on the green right-arrow icon ([[File:Share participate CPDB.png]]) or on the '''Selected participant(s)...''' button situated in the bottom left part of the participants table. A modal box will open up which will allow you to select the user with whom you want to share the respective participant(s). You can also set whether the user who shares your participant can edit those participants. If you set it to ''No'', they will get an access denied error when trying to edit the entries of the shared participant.
 
  
 
<center>[[File:shareParticipant.png]]</center>
 
<center>[[File:shareParticipant.png]]</center>
 +
  
 
===List active surveys===
 
===List active surveys===
  
If you click on 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 on 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===
 
===Add participant to survey===
  
Adding a participant to a survey can be done by clicking on the last icon ([[File:Add participant to survey CPDB.png]]) from the '''Action''' column. If you wish to add more than one participant to a survey, mark them and select the '''Share''' option from the '''Selected participant(s)...''' dialog box (located in the bottom-left part of the participants table).
+
Adding a participant to a survey can be done by clicking on the last icon ([[File:Add participant to survey CPDB.png]]) from the '''Action''' column. If you wish to add more than one participant to a survey, mark them and select the '''Share''' option from the '''Selected participant(s)...''' dialog box (located in the bottom-left part of the central table).
 +
 
  
 
<center>[[File:addtoSurvey.png]]</center>
 
<center>[[File:addtoSurvey.png]]</center>
  
The title of the dialog box will show you the number of participants that are going to be added to the respective survey. Besides that, there is also a check box, that if checked, will take you to the token table of the survey to which you are adding the participants.
+
 
 +
<div class='simplebox'> [[File:help.png]] Please note that if you wish to add participants from the central database to a survey, the respective survey needs to contain a '''survey participants table'''! For further details, please continue reading the following [[Survey participants|wiki section]].</div>
 +
 
 +
The title of the dialog box will show you the number of participants that are going to be added to the respective survey. Besides that, there is also a checkbox, that if checked, it will take you to the survey participants/tokens table of the survey to which you are adding the participants to.
  
 
After clicking 'Next', you will be taken to the attribute map page.
 
After clicking 'Next', you will be taken to the attribute map page.
  
The attribute map page has three columns and uses an advanced drag-and-drop functionality. The first column shows all the attributes that are present in the central table. The second column gives space to the user to create new attributes. The third column shows the attributes in the token table to which the user is adding participants. The user is free to choose to either create a new attribute in the token table, to copy new values to or map the values from the attribute located in the central table to the token table.
+
The attribute map page contains four tables and uses an advanced drag-and-drop functionality:
 +
 
  
 
<center>[[File:attributemap.png]]</center>
 
<center>[[File:attributemap.png]]</center>
  
After you have mapped all the attributes, you can click on continue. After processing the participants, a summary page will show up, telling you how many participants were successfully copied. If you have asked for redirection, you will be redirected to the token table table or else you will be redirected to the CPDB main page.
+
 
 +
* The first table, ''Unmapped participant attributes'', shows all the attributes that are present in the central participant database. They are currently unmapped - not present in the survey participants table. These unmapped attributes can either be moved into the ''Token attributes to create'' table which creates new attributes in the survey participants table or they can be merged with the existing token attributes by dragging the unmapped attributes into the ''Existing token attributes'' table, besides the existing token attribute you wish to be merged with.
 +
 
 +
* The second table, ''Token attributes to create'', helps you copy unmapped participant attributes into the survey participants table, creating new columns. Drag the attribute(s) you wish to add to the survey participants table and drop them into the second table. In this way, new columns/attributes will be added to the survey participants table.
 +
 
 +
* The third table, ''Existing token attributes'', displays the current attributes existing in the survey participants table. Drop the unmapped attributes here if you wish to copy the data from the unmapped attributes into the one of the existing token attributes (see screenshot below)
 +
 
 +
* The fourth table, the ''Standard token fields'', displays the standard token fields that can be merged with unmapped participant attributes. The only standard token field from a survey participants table that can be edited is the '''Token''' one. This is important when you wish, for example, to easily copy token codes across different LimeSurvey installations.
 +
 
 +
 
 +
<center>[[File:Attributemaps test.png]]</center>
 +
 
 +
 
 +
<div class='simplebox'> [[File:help.png]] You can also overwrite the existing token attribute values from the survey participants table if a participant already exists. Use this option cautiously in order not to lose any important data on survey respondents.</div>
 +
 
 +
 
 +
After you have mapped all the attributes, you can click on the '''Continue''' button. After processing the participants, a summary page will show up, telling you how many participants were successfully copied. If you have previously asked for redirection, you will be redirected to the survey participants table, otherwise you will be redirected to the CPDB main page.
 +
 
  
 
<center>[[File:addtosurveysummary.png]]</center>
 
<center>[[File:addtosurveysummary.png]]</center>
Line 114: Line 148:
 
==Info==
 
==Info==
  
It displays some '''Central participants database''' stats:
+
It displays some '''CPDB''' stats:
 +
 
 +
 
 
<center>[[File:ParticipantPanel.png]]</center>
 
<center>[[File:ParticipantPanel.png]]</center>
  
1) ''Total participants in central table'' : The total number of participants located in the central participants database.
 
  
2) ''Participants owned by you'' : It shows the total number of participants that have you as a owner. By default, <u>the new participants</u> entered into the central participants database <u>have as owner the user that firstly added them to it</u>.  
+
1) ''Total participants in central table'' : The total number of participants located in the central participant database.
 +
 
 +
2) ''Participants owned by you'' : It shows the total number of participants that have you as a owner. By default, <u>the new participants</u> entered into the central participant database <u>have as owner the user that firstly added them to it</u>.  
  
 
3) ''Participants shared with you'' : The number of participants that were shared with you by other users.
 
3) ''Participants shared with you'' : The number of participants that were shared with you by other users.
Line 134: Line 171:
  
 
The following options are available:
 
The following options are available:
 +
  
 
[[File:Import CSV CPDB.png]]
 
[[File:Import CSV CPDB.png]]
 +
  
 
Please note the text from the box on '''CSV input format''':  
 
Please note the text from the box on '''CSV input format''':  
Line 144: Line 183:
 
===Steps to import===
 
===Steps to import===
  
1) Select a file to import and specify associated settings.
+
1) Select a file to import and specify the settings associated to it.
 +
 
 +
2) Map the attributes from the CSV file. Import the attribute data either into an existing attribute from the central participant database or into a new column by creating a new attribute. The newly created attribute will be of text box type - the format can be changed later.
  
2) Map the attributes in the CSV to those in the central table or create a new attribute. New attributes created will be of text box type but can be changed later.
 
  
 
<center>[[File:attributeMapCSV.png]]</center>
 
<center>[[File:attributeMapCSV.png]]</center>
  
In the screenshot from above, a new attribute called age. Attribute sex was mapped with the one from the central table.
 
  
3) Wait for it to process and show the summary.
+
In the screenshot from above, a new attribute called "New Age" will be created. The data from attribute "Sex" was mapped and copied into the existent "Sex" attribute from the central participant database.
  
<center>[[File:CSVsummary.png]]</center>
+
3) Click continue, and wait for the process to be done. At the end of it, a short summary will be displayed.
  
Clicking ok will redirect you to the display participants screen, which will show the newly imported participants.
 
  
==Export==
+
<center>[[File:CSVsummary.png]]</center>
  
The export function is located on the main toolbar of the '''Central participant database''': [[File:Export CPDB.png]]
 
  
When exporting to CSV, you are presented with a dialog box that asks you to mark the additional attributes you want to export. There is also an option for filtering the attributes. It will display all the attributes located in the central table (visible and non-visible).
+
Clicking ok will redirect you to the participants screen, showing you the newly imported participants.
  
The export option works under either of the two conditions :
+
==Blacklist settings==
  
1) Export filtered
+
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:
  
2) Export All
 
  
It will export all or selected participants depending on your filtering criteria.
+
<center>[[File:CPDB Blacklist settings panel.png]]</center>
  
<center>[[File:LimeSurvey2.05_exporttoCSV_ru.jpg]]</center>
 
 
It will export the file as ''central_'the current time stamp'.csv''.
 
 
==Settings==
 
 
The '''Settings''' button available on the main toolbar of the '''Central participant database''' page refers to ''blacklist settings'': [[File:Settings CPDB.png]].
 
  
 
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 participant 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 cannot be added anymore 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, he 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, he 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 himself/herself''': If ''Yes'', a participant can un-blacklist himself without the help of a LimeSurvey user.
  
 
==Attributes==
 
==Attributes==
  
 
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 on the '''Attributes''' button located on the main toolbar of CPDB main page: [[File:Attributes management icon.png]]
 +
  
 
<center>[[File:Add new attribute CPDB.png]]</center>
 
<center>[[File:Add new attribute CPDB.png]]</center>
 +
  
 
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 on the '''Add new attribute''' located in the upper-right part of the window:
 +
  
 
<center>[[File:addingattribute.png]]</center>
 
<center>[[File:addingattribute.png]]</center>
 +
  
 
When adding a new attribute, the following options are available:
 
When adding a new attribute, the following options are available:
Line 202: Line 235:
 
*'''Attribute type''': You can choose either of the attribute types and the associated user interface will be presented to you while editing.
 
*'''Attribute type''': You can choose either of the attribute types and the associated user interface will be presented to you while editing.
 
*'''Should this attribute be visible on the panel?''': It can be ''Yes'' or ''No''. This function determines whether the attribute is visible in the CPDB table or not. This can be later edited from the '''Visible''' column that is located in the main attributes table.  
 
*'''Should this attribute be visible on the panel?''': It can be ''Yes'' or ''No''. This function determines whether the attribute is visible in the CPDB table or not. This can be later edited from the '''Visible''' column that is located in the main attributes table.  
*'''Languages''': If you would like LimeSurvey not to use the defaultname as the name of the attribute, type here the desired name. Please note that the attribute management has multilingual support. Click on the plus sign after you have selected the language. A new field will appear below English/default language.  
+
*'''Languages''': If you would like LimeSurvey not to use the defaultname as the name of the attribute, type here the desired name. Please note that the attribute management has multilingual support. Click on the plus sign after you have selected the language. A new field will appear below the English/default language.  
  
 
Once the changes are done, click on the '''Save''' button.
 
Once the changes are done, click on the '''Save''' button.
 +
 +
<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>
  
 
In the attributes table, two actions are available (see the ''Action'' column):
 
In the attributes table, two actions are available (see the ''Action'' column):
Line 216: Line 251:
 
== Share panel==
 
== Share panel==
  
The share panel shows all the information related to the shared participant. Please note that this panel shows only the shared participants owned by that particular user.
+
The share panel shows all the information related to the shared participants. Please note that this panel shows only the shared participants owned by that particular user.
 +
 
  
 
<center>[[File:sharepanel.png]]</center>
 
<center>[[File:sharepanel.png]]</center>
 +
  
 
This panel shows values like:
 
This panel shows values like:
Line 236: Line 273:
 
7) ''Can edit?''
 
7) ''Can edit?''
  
All this information is for viewing/sorting purposes.  
+
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.
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.
+
 
 +
==Export participants==
 +
 
 +
The export function is located on the main toolbar of the '''Central participant database''' page: [[File:Export CPDB.png]]
 +
 
 +
When exporting to CSV, you are presented with a dialog box that asks you to mark the attributes you wish to export.
 +
 
 +
You can export:
 +
 
 +
*'' '''None''' of the additional attributes''
 +
 
 +
*'' '''All''' the additional attributes''
 +
 
 +
*'' '''Certain''' additional attributes''
  
==Advanced search==
 
  
{{Box|This function is not available in the last LimeSurvey releases (e.g. in 3.0). It will be reintroduced soon.}}
+
<center>[[File:LimeSurvey2.05_exporttoCSV_ru.jpg]]</center>
  
This is yet another major feature of the Central Panel. It is a powerful feature which not only filters through the participants, but also through additional attributes (visible and non-visible).
 
  
There are two levels of search that you can do:
+
The format of the exported file will be CSV.
  
1) Single search
+
===Export filtered participants===
  
2) Combined search
+
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.
  
<center>[[File:LimeSurvey2.05_advanceSearch_ru.jpg]]</center>
+
==Search filters==
  
You can add a complex condition by using a plus sign next to the previous condition and remove a condition by using a minus sign in front of it.
+
If you wish to filter the users from your database, use the search/dropdown boxes located below each column title:
  
<center>[[File:advancesearchmultiple.png]]</center>
 
  
This not only filters the participants in the grid but also those in the database that are not yet loaded, so it is an extensive search.
+
<center>[[File:CPDB Filtered search.png]]</center>
 +
 
 +
 
 +
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.
  
 
=Additional information=
 
=Additional information=
  
 
Additional (technical) information is available in the [[Central participants database (User panel) Development]] wiki.
 
Additional (technical) information is available in the [[Central participants database (User panel) Development]] wiki.
 
=Examples=
 

Revision as of 16:05, 14 May 2018

Other languages:
Deutsch • ‎English • ‎Nederlands • ‎français • ‎slovenščina • ‎русский • ‎中文(简体)‎ • ‎日本語

Introduction

To access this option: Configuration -> Central Participant Database:


Central participants database.png


This feature allows the administrator to store the participant information into a central table that is independent of any survey participants table. Its major advantages are:

  • The central table acts as a backup. In the case in which a user creates a new survey, he does not have to go through the trouble of exporting its participants to a CSV file and then importing 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.
  • In case multiple users have access to a LimeSurvey installation, its owner(s) can choose to share his participants with other users and also set access rights for the shared users.

You may also find in your LimeSurvey installation an advanced attribute control and several other features.

The participants panel management tools

The following options are available:


LimeSurvey2.05 ParticipantPanel ru.jpg


Display CPDB participants

This is the main component of this panel. The great majority of options can be accessed from here, such as adding, deleting, exporting, adding participants to surveys, and so on.

Five options are available in the Action column for every participant listed in the table:


LimeSurvey2.05 displayParticipant ru.jpg


Before getting access to the options mentioned above, you need to have users listed in your database. To create them, click on the Add new participant button, located in the upper-right part of the window.


Add participant

Click on the Add new participant button located in the upper-right part of the window: Add new participat CPDB.png.

A dialog box with the following basic attributes will then appear:


AddParticipant.png


Custom attributes can be added. For further details, see the attributes and examples sections.


Edit participant

To edit the basic and/or custom attributes of a participant, click on the first button (from left to right) located in the Action column (Edit participant CPDB.png). A window with all the available attributes will be displayed.

LimeSurvey2.05 addParticipant ru.jpg

You can easily delete one or multiple participants:

  • If you want to delete one participant, go to the row where the respective participant is located and click on the red bin button: Delete participant CPDB.png.
  • If you want to delete two or more participants, click on the Selected participant(s)... button (under the last row, below the Action column) after you selected the corresponding entries: Select participants CPDB.png. Then, click on the delete option.

When you delete the participant(s), three options are available to you:


LimeSurvey2.05 deleteParticipant ru.jpg


1) Delete only from the central panel: The first option deletes the participant from the central participant database only. If the participant is in any token table, he/she will not be removed.

2) Delete from the central panel and associated surveys: The second option deletes the participant from central panel and from the surveys where he has been added to, but his responses are not deleted.

3) Delete from central panel, associated surveys and all associated responses: The third option deletes all traces of that participant from the system, including his responses.

Important.png
  Attention : 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

This is another important feature of the Central Participant Database. You can share your participants with other users. You just have to select the participant(s) you want to share and click either on the green right-arrow icon (Share participate CPDB.png) or on the Selected participant(s)... button situated in the bottom left part of the participants table. A modal box will open up which will allow you to select the user with whom you want to share the respective participant(s). You can also set whether the user who shares your participant can edit those participants. If you set it to No, they will get an access denied error when trying to edit the entries of the shared participant.


ShareParticipant.png


List active surveys

If you click on the next icon (List active surveys CPDB.png), all the active surveys where the respective participant has been added to will be listed.

Add participant to survey

Adding a participant to a survey can be done by clicking on the last icon (Add participant to survey CPDB.png) from the Action column. If you wish to add more than one participant to a survey, mark them and select the Share option from the Selected participant(s)... dialog box (located in the bottom-left part of the central table).


AddtoSurvey.png


Help.png Please note that if you wish to add participants from the central database to a survey, the respective survey needs to contain a survey participants table! For further details, please continue reading the following wiki section.

The title of the dialog box will show you the number of participants that are going to be added to the respective survey. Besides that, there is also a checkbox, that if checked, it will take you to the survey participants/tokens table of the survey to which you are adding the participants to.

After clicking 'Next', you will be taken to the attribute map page.

The attribute map page contains four tables and uses an advanced drag-and-drop functionality:


Attributemap.png


  • The first table, Unmapped participant attributes, shows all the attributes that are present in the central participant database. They are currently unmapped - not present in the survey participants table. These unmapped attributes can either be moved into the Token attributes to create table which creates new attributes in the survey participants table or they can be merged with the existing token attributes by dragging the unmapped attributes into the Existing token attributes table, besides the existing token attribute you wish to be merged with.
  • The second table, Token attributes to create, helps you copy unmapped participant attributes into the survey participants table, creating new columns. Drag the attribute(s) you wish to add to the survey participants table and drop them into the second table. In this way, new columns/attributes will be added to the survey participants table.
  • The third table, Existing token attributes, displays the current attributes existing in the survey participants table. Drop the unmapped attributes here if you wish to copy the data from the unmapped attributes into the one of the existing token attributes (see screenshot below)
  • The fourth table, the Standard token fields, displays the standard token fields that can be merged with unmapped participant attributes. The only standard token field from a survey participants table that can be edited is the Token one. This is important when you wish, for example, to easily copy token codes across different LimeSurvey installations.


Attributemaps test.png


Help.png You can also overwrite the existing token attribute values from the survey participants table if a participant already exists. Use this option cautiously in order not to lose any important data on survey respondents.


After you have mapped all the attributes, you can click on the Continue button. After processing the participants, a summary page will show up, telling you how many participants were successfully copied. If you have previously asked for redirection, you will be redirected to the survey participants table, otherwise you will be redirected to the CPDB main page.


Addtosurveysummary.png

Info

It displays some CPDB stats:


ParticipantPanel.png


1) Total participants in central table : The total number of participants located in the central participant database.

2) Participants owned by you : It shows the total number of participants that have you as a owner. By default, the new participants entered into the central participant database have as owner the user that firstly added them to it.

3) Participants shared with you : The number of participants that were shared with you by other users.

4) Participants you have shared : The number of participants you shared with other users.

5) Blacklisted participants : The number of blacklisted participants.

6) Total attributes in the central table : The total number of attributes that can be found in the central table.

Import

If you wish to add participants via the import function, click on the Import button that is located on the main toolbar of the Central participant database page: ImportCSV.png

The following options are available:


Import CSV CPDB.png


Please note the text from the box on CSV input format:

The file should be a standard CSV (comma delimited) file with optional double quotes around values (default for OpenOffice and Excel). The first line must contain the field names. The fields can be in any order.

Mandatory field: email

Optional fields: firstname, lastname, blacklisted, language


Steps to import

1) Select a file to import and specify the settings associated to it.

2) Map the attributes from the CSV file. Import the attribute data either into an existing attribute from the central participant database or into a new column by creating a new attribute. The newly created attribute will be of text box type - the format can be changed later.


AttributeMapCSV.png


In the screenshot from above, a new attribute called "New Age" will be created. The data from attribute "Sex" was mapped and copied into the existent "Sex" attribute from the central participant database.

3) Click continue, and wait for the process to be done. At the end of it, a short summary will be displayed.


CSVsummary.png


Clicking ok will redirect you to the participants screen, showing you the newly imported participants.

Blacklist settings

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:


CPDB Blacklist settings panel.png


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 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.
  • Allow blacklisted participants to be added to a survey: Even if a participant is blacklisted, he 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.
  • 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.

Attributes

To access the Attributes management panel, click on the Attributes button located on the main toolbar of CPDB main page: Attributes management icon.png


Add new attribute CPDB.png


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:


Addingattribute.png


When adding a new attribute, the following options are available:

  • Defaultname: It will be used by LimeSurvey to name the attribute in case no other English name is provided.
  • Attribute type: You can choose either of the attribute types and the associated user interface will be presented to you while editing.
  • Should this attribute be visible on the panel?: It can be Yes or No. This function determines whether the attribute is visible in the CPDB table or not. This can be later edited from the Visible column that is located in the main attributes table.
  • Languages: If you would like LimeSurvey not to use the defaultname as the name of the attribute, type here the desired name. Please note that the attribute management has multilingual support. Click on the plus sign after you have selected the language. A new field will appear below the English/default language.

Once the changes are done, click on the Save button.

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.

In the attributes table, two actions are available (see the Action column):

Action table attribute management.png

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.

To delete an attribute from the table, click on the red trash button, located next to the edit button. Clicking the delete button will not only delete the attribute, but also the associated values from the CPDB.

Share panel

The share panel shows all the information related to the shared participants. Please note that this panel shows only the shared participants owned by that particular user.


Sharepanel.png


This panel shows values like:

1) Last name

2) First name

3) Email address

4) Shared by

5) Owner

6) Date added

7) Can edit?

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.

Export participants

The export function is located on the main toolbar of the Central participant database page: Export CPDB.png

When exporting to CSV, you are presented with a dialog box that asks you to mark the attributes you wish to export.

You can export:

  • None of the additional attributes
  • All the additional attributes
  • Certain additional attributes


LimeSurvey2.05 exporttoCSV ru.jpg


The format of the exported file will be CSV.

Export filtered participants

To export filtered participants, use first the 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.

Search filters

If you wish to filter the users from your database, use the search/dropdown boxes located below each column title:


CPDB Filtered search.png


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.

Additional information

Additional (technical) information is available in the Central participants database (User panel) Development wiki.