Actions

Central Participant Database

From LimeSurvey Manual

Revision as of 15:29, 22 August 2011 by Aniesshsethh (talk | contribs)

Introduction

This new feature allows the administrator to store the participants to a central table that is independent of any token. The major advantages of allowing this is  :

  • The participants are backed up, so if a user wants to backup the participants without having to go through the trouble of exporting his participants to a CSV file and then importing them back into a new survey.
  • The user need not have to import CSV to each specific survey , he/she just needs to add the survey to the central table and then can add to as many surveys as he wants.
  • In case of multiple users , one user can choose to share his participants with others and also set if he wants it to be editable with the shared user or not.

Along with this, there is a advance attribute control and several other features.

The participants panel management tools

1) Home Screen

2) Information Screen( Summary of CPDB )

3) Display Participant’s Grid

4) Import from CSV

5) Export to CSV

6) Blacklist Control

7) Global Participant’s Settings

8) Attribute Control

9) Share Panel

10) Panel Summary

Home Screen

Participant's Panel is a separate panel in the LimeSurvey administrator toolbar, so this icon takes back the user to the administrator panel

Information Screen

This screen shows the summary of the Central Database by giving the statistics of Central Database. This gives the summary of

1) Total Participants in central table

2) Participants Owned by you

3) Participants Shared with you

4) Participants you have shared

5) Blacklisted Participants

6) Total attributes in the central table

Display Participant’s Grid

This is the main asset of the Participant's Panel. This is where you can perform majority of central Panel's operations, such as adding, deleting , exporting, adding to survey etc.

Let me show you a screenshot of the same and explain each of the feature.

Explaination of the screenshot is given below

1)  jqGrid header

2)  Add Participant

3)  Delete Participant

4)  Reload Grid

5)  Export to CSV ( Advanced )

6)  Advance Search

7)  Navigation Bar

8)  Share Participant

9)  Add to Survey

10) Total Count

11) Hide/show grid

11) Subgrid

Now I will explain each of the features

Add Participant

You can easily add individual participant using the plus sign in the grid pager. For editing the added participant you can simply double click on the row on which you want to edit and after editing you can press enter and any changes you have done will be saved on the server.

Delete Participant

You can easily mark a single participant to delete or you can choose all the participants in the grid to be deleted. There are three possible conditions when deleting a participant.

The explanation of the three conditions is

1) Delete Participant(s) from central participants panel only

2) Delete Participant(s) from central panel and token tables

3) Delete Participant(s) from central panel,token tables and all associated responses

The first option deletes the participant from the central panel only, if the participant is in the token table, he/she will not be removed.

The second option deletes the participant from central as well as token table, but the responses are kept.

The third option deletes all traces of that participant from the system included responses.

In all the three options the links created for the purpose of maintaining history related to a particular participant are also deleted.

Reload Grid

It simply reloads the grid from the server.

Export to CSV

When exporting to CSV the user is presented with a dialog box asking him to mark the additional attributes which he wants to import. There is also a nice filter for filtering the attributes. It will display all the attributes (visible/non-visible).

The export to CSV will work under two conditions :

1) Export filtered

2) Export All

When you are done filtering it will export all the filtered results otherwise it will export all the participants visible to that user.

It will export with the file name as central_'the current time stamp'.

Advance Search

This is another major feature of Central Panel. It has a powerful search which not only filters through the participant but through additional attributes as well (visible and non-visible). This feature is also integrated with the grid.

There are two level of searches that an administrator can do.

1) Single Search

2) Combined Search

You can add a complex condition using a plus sign next to the previous condition and remove the condition using a minus sign .

This search not only filters attributes in the grid but also from the database, so it is an extensive search.

Navigation Bar

To decrease load time of the grid we have used pagination in the grid which allows the user to see the first X entries ( chosen by the user) and then load more if required by him. To control this we have a pagination control in the navigator bar

Using the drop down you can select the entries to be loaded and with navigation buttons you can navigate and also use the text box to go to a certain page. Please note that the number of pages will reduce as you increase the number of eateries visible per page. Also the search and sorting of grid are not dependent on the records visible in the grid at any particular time but are independent of them.

Share Participant

This is another most important feature of CPDB. You can share the participants among other users in the LimeSurvey installation. You just have to select the participants you want to share and click on share. A modal box will open up which will allow you to select the user with who you want to share. You can also set as to whether the participant that you are sharing can be edited by the user with whom you are sharing. If you set it to no, user with whom you have shared will get a access denied error.

Add to survey

Add to survey can be done at three levels :

1) all participants in current search

2) all participants

3) only the participant's that I have selected

As we know that the grid loads only the requested participants and rest of the participants are loaded when requested, thus ensuring minimum loading time for the user. So when you select a page on the grid (using multi-select or single select )that doesn't meant you have selected all the participants on the second and the third page as well.So when exporting you are presented with the above mentioned three options which will be visible/invisible to you as per the present scenario.

For example if you have not selected any row and haven't done any search it will not show you any option and will offer you to add all the participants in the grid and so on...

The title of the dialog box will show you the number of participants that you are going to export. 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.

After clicking next you will be taken to the attribute map page.

The attribute map page has three columns and uses advance 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 to. 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 in the central table to the token table.

After you have mapped all the attributes, you can click on continue and after processing the participants a summary page will show up that will tell you how many participants were successfully copied, after which if you have asked for redirection you will be redirected to the token table table or else you will be redirected to the central grid.

Total Count

The navigator in the right also displays the number of participants out of the total participants.

Hide/Show grid

Simply hide or show the grid.

Subgrid

For editing of attributes in the system we have implemented subgrid in the main grid that shows all the attributes in the system and also edit them. The main grid shows only the visible attributes, the rest of the attributes are available here and only fetched when required. The subgrid as the main grid allows inline editing of attributes and also sorting. The subgrid also shows the links to the surveys to which the participant is added to. In case the participant is not added to any survey this subgrid hides itself. When you expand the subgrid all the attributes in the system show up, but that doesn't mean that you have saved all the attribute values for that participant in the database. Only when you add some value that attribute is saved for that particular attribute.

Import from CSV

This feature is similar to as we have in tokens.This supports files with only *.csv extension. The rest of the settings are similar with what we have for import CSV under tokens.