Inhaltsverzeichnis. Datenbankoperationen_bei_Fragebogenerstellung. Zur Studiply-Projekt Hauptseite. Autor: Marcel Minke

Transcription

1 Zur Studiply-Projekt Hauptseite Autor: Marcel Minke Da diese Dokumentation auch der Limesurvey Open Source Gemeinde zur Verfügung gestellt werden soll, wurde sie in englischer Sprache verfasst. Inhaltsverzeichnis 1 Anonymous 1.1 Login 1.2 Create new 1.3 Enter Settings 1.4 Add Groups 1.5 Add Questions 1.6 Activate 1.7 Activate Probands 1.8 Add new Proband 1.9 Generate Tokens 1.10 Send Invitation 1.11 Start 1.12 Fill out 1.13 Save unsubmitted 1.14 Deactivate 2 NON-anonymous 2.1 Login 2.2 Create new 2.3 Enter Settings 2.4 Add Groups 2.5 Add Questions 2.6 Activate Inhaltsverzeichnis 1

2 2.7 Activate Probands 2.8 Add new Proband 2.9 Generate Tokens 2.10 Send Invitation 2.11 Start 2.12 Fill out 2.13 Save unsubmitted 2.14 Deactivate 1 Anonymous An anonymous survey has the advantage that answers can't be connected to participants. Therefore the table structure of anonymous and non-anonymous surveys differ. 1.1 Login To create a new survey you have to login first. The standard login is Username: admin Password: password 1.2 Create new To create a new survey click the plus-icon in the upper right 1.3 Enter Settings You can import a survey from a.csv- file or create a new survey by filling out the needed form fields. The most important ones are: Title Description Administrator data (name, adress) Security Settings (cookies, anonymisation yes/no, open registration yes/no) Navigation settings (save unsubmitted surveys, show prev. button) 1 Anonymous 2

3 invitations (text, subject) whereas some elements can only be used if tokens were created Token attribute names: The probands table offers space to request two additional parameters from the users. In this test scenario the residation and the body height were requested. If open registration is used you can give this field meaningful names and use it for evaluation. Further survey settings like "expires", "expiry date", "end URL" In this case the following settings were chosen: anonymous = yes open registration = no use timestamps = yes save IP adress = yes use end URL = yes expiry date = none Further information on how to create a survey can bei found at online manual. Note: If - like in this case - the survey is anonymous but at the same time a probands table is created the token will not be provided with a timestamp to protect anonymity. When the survey was created the following changes are made to the database: lime_surveys: new entry for the survey (name, ID,...) lime_surveys_languagesettings: The texts typed in when creating the survey (title, description of the end URL,...) are stored together with the language and the survey-id (sid). lime_surveys_rights: new entry showing which user (uid) has which rights (value 0/1) for which survey (sid) 1.4 Add Groups Groups can be imported from a.csv- file or added by clicking the plus icon [Bild:add.png]. When a group was added the following changes are made to the database: lime_groups: new entry with group-id (gid), survey-id (sid), group name etc. 1.5 Add Questions Adding questions works accordingly. They can be imported from a.csv- file or added by clicking the plus icon. The most important parameters are: code: key to each question question: question text 1.3 Enter Settings 3

4 help text: further information/help type: according to the type javascript is used to dynamically adapt input fields mandatory: yes/no Alle the question types are described (German). When a question was added the following changes are made to the database: lime_questions: data for every new question with the values qid = primary key, gid = group-id (to which group a question is assigned to), title, question text etc. lime_question_attributes: special features for certain question types. There isn't an entry for every single question. Example: The question "What year were you born?" should be ansewered by entering a four digit number. Therefore an entry maximum chars with the value "4" is stored in this table (together with qaid as primary and qid as foreign key). 1.6 Activate After having activated the survey the following actions can't be done anymore: add/delete groups add/delete answers add/delete questions These actions are not affected: change question code/text/type edit group name edit pre-defined answers (besides the ones with a multiple choise) change survey name and description If there has been some feedback but you'll have to do important changes you'll have to deactivate the survey. By doing so the entered data is shift to an archiv table that is named lime_old_survey_id_datetime. Example: lime_old_survey_12345_ If the survey has been set as an open survey it can be converted to a closed survey - even after it has been activated - by creating a probands table. When the survey was activated the following changes are made to the database: lime_survey_12345: Table was created but is still empty. As in this case the survey is set anonymous there is no token table (which would be named lime_tokens_12345) lime_surveys: active is set to "Y". 1.5 Add Questions 4

5 1.7 Activate Probands A survey can be started directly or access can be restricted to a predefined group of users (probands) by creating a token table. In this case we create a token table and later use the "create token" function to let limesurvey create a token for each proband. Now you'll need the token to access the survey. When a token table was created the following changes are made to the database: lime_tokens_12345: Table was created but is still empty Having created the token table you'll have to add probands. This can be done in the activate/edit tokens section which offers the following functions (icon on top left): display tokens add new token entry import tokens from.csv file or LDAP export tokens to.csv file send invitations send reminder generate tokens drop tokens table 1.8 Add new Proband When adding a new proband the two additional fields residence (attribute1) and body height (attribute2) have to be filled out by the user. This data belongs to the survey description and therefore is stored in the table lime_surveys in the columns attribute1/attribute2. The user's answers are stored in lime_tokens_12345 When a Proband was added the following changes are made to the database: lime_tokens_12345: The table is filled with the proband's data which includes the values entered for residence and body height. The value of the token field is still empty. 1.9 Generate Tokens For every proband a unique identifier is created which can be send to the participants via mail and has to be used to gain access to the survey. When a token was created the following changes are made to the database: lime_tokens_12345: The value of the token field is filled with the created identifier. 1.7 Activate Probands 5

6 1.10 Send Invitation The subject and text of the invitation mail can be edited in a form. Placeholders like firstname, lastname can be used to personalize the s. After the mails were send a list of the invited probands is shown. When a invitation mail was sent the following changes are made to the database: lime_tokens_12345: The value of sent is filled with a timestamp 1.11 Start To start the survey the green icon in the admin panel has to be clicked: Because probands and tokens have been added before, each user who wants to participate in the survey has to enter a valid token to start the survey Fill out If the user has verified his account by entering a valid token he is allowed to fill aout the survey. When a has filled out the survey the following changes are made to the database: lime_tokens_12345: The completed value is set to "Y". (For a non anonymous survey this field would be filled with a timstamp) lime_survey_12345: A new entry containing the participants data like Date/Time, IP-Adress and his answers is created. For this anonymous survey the coulmn token does not exist. For each answer a column in the format IdXGoupIdXQuestionId is created Save unsubmitted If the option to save unsubmitted surveys is enabled the user is able to leave the survey and save the answers given so far. Therefore a username and password (and an adress) has to be entered. An is sent to the user with a link which directly leads him to the page he left the survey. Using username and password the user can login and continue to fill out the survey. When a unsubmitted survey was saved the following changes are made to the database: lime_survey_12345: The value of submitdate is set to zero (datestamp is filled with date/time of the first answer given). lime_saved_control: The following values are stored: survey ID (sid) ID of the non-completed question (srid) 1.10 Send Invitation 6

7 username password (encrypted) timestamp When a user resumes to fill out the unsubmitted survey the following changes are made to the database: lime_saved_control: The user's data is deleted lime_tokens_12345: completed is set to "Y" lime_survey_12345: submitdate and datestamp are filled with timestamps of the last interaction 1.14 Deactivate When a survey is deactivated the data tables are renamed. The probands table is renamed, too. The renamed tables use the following format: lime_old_surveyid_datetime. Data can only be accessed by using tools like phpmyadmin. Therefore it is always useful to export data first before deactivating a survey. 2 NON-anonymous 2.1 Login To create a new survey you have to login first. The standard login is Username: admin Password: password 2.2 Create new To create a new survey click the plus-icon in the upper right 2.3 Enter Settings You can import a survey from a.csv- file or create a new survey by filling out the needed form fields. The most important ones are: Title Description Administrator data (name, adress) Security Settings (cookies, anonymisation yes/no, open registration yes/no) Navigation settings (save unsubmitted surveys, show prev. button) 1.13 Save unsubmitted 7

8 invitations (text, subject) whereas some elements can only be used if tokens were created Token attribute names: The probands table offers space to request two additional parameters from the users. In this test scenario the residation and the body height were requested. If open registration is used you can give this field meaningful names and use it for evaluation. Further survey settings like "expires", "expiry date", "end URL" In this case the following settings were chosen: anonymous = no open registration = no use timestamps = yes save IP adress = yes use end URL = yes expiry date = none Further information on how to create a survey can bei found at online manual. When the survey was created the following changes are made to the database: lime_surveys: new entry for the survey (name, ID,...) lime_surveys_languagesettings: The texts typed in when creating the survey (title, description of the end URL,...) are stored together with the language and the survey-id (sid). lime_surveys_rights: new entry showing which user (uid) has which rights (value 0/1) for which survey (sid) 2.4 Add Groups Groups can be imported from a.csv- file or added by clicking the plus icon. When a group was added the following changes are made to the database: lime_groups: new entry with group-id (gid), survey-id (sid), group name etc. 2.5 Add Questions Adding questions works accordingly. They can be imported from a.csv- file or added by clicking the plus icon. The most important parameters are: code: key to each question question: question text help text: further information/help type: according to the type javascript is used to dynamically adapt input fields 2.3 Enter Settings 8

9 mandatory: yes/no Alle the question types are described (German). When a question was added the following changes are made to the database: lime_questions: data for every new question with the values qid = primary key, gid = group-id (to which group a question is assigned to), title, question text etc. lime_question_attributes: special features for certain question types. There isn't an entry for every single question. Example: The question "What year were you born?" should be ansewered by entering a four digit number. Therefore an entry maximum chars with the value "4" is stored in this table (together with qaid as primary and qid as foreign key). 2.6 Activate After having activated the survey the following actions can't be done anymore: add/delete groups add/delete answers add/delete questions These actions are not affected: change question code/text/type edit group name edit pre-defined answers (besides the ones with a multiple choise) change survey name and description If there has been some feedback but you'll have to do important changes you'll have to deactivate the survey. By doing so the entered data is shift to an archiv table that is named lime_old_survey_id_datetime. Example: lime_old_survey_12345_ If the survey has been set as an open survey it can be converted to a closed survey - even after it has been activated - by creating a probands table. When the survey was activated the following changes are made to the database: lime_survey_12345: Table was created but is still empty. As in this case the survey is set anonymous there is no token table (which would be named lime_tokens_12345) lime_surveys: active is set to "Y". 2.5 Add Questions 9

10 2.7 Activate Probands A survey can be started directly or access can be restricted to a predefined group of users (probands) by creating a token table. In this case we create a token table and later use the "create token" function to let limesurvey create a token for each proband. Now you'll need the token to access the survey. When a token table was created the following changes are made to the database: lime_tokens_12345: Table was created but is still empty Having created the token table you'll have to add probands. This can be done in the activate/edit tokens section which offers the following functions (icon on top left): display tokens add new token entry import tokens from.csv file or LDAP export tokens to.csv file send invitations send reminder generate tokens drop tokens table 2.8 Add new Proband When adding a new proband the two additional fields residence (attribute1) and body height (attribute2) have to be filled out by the user. This data belongs to the survey description and therefore is stored in the table lime_surveys in the columns attribute1/attribute2. The user's answers are stored in lime_tokens_12345 When a Proband was added the following changes are made to the database: lime_tokens_12345: The table is filled with the proband's data which includes the values entered for residence and body height. The value of the token field is still empty. 2.9 Generate Tokens For every proband a unique identifier is created which can be send to the participants via mail and has to be used to gain access to the survey. When a token was created the following changes are made to the database: lime_tokens_12345: The value of the token field is filled with the created identifier. 2.7 Activate Probands 10

11 2.10 Send Invitation The subject and text of the invitation mail can be edited in a form. Placeholders like firstname, lastname can be used to personalize the s. After the mails were send a list of the invited probands is shown. When a invitation mail was sent the following changes are made to the database: lime_tokens_12345: The value of sent is filled with a timestamp 2.11 Start To start the survey the green icon in the admin panel has to be clicked: Because probands and tokens have been added before, each user who wants to participate in the survey has to enter a valid token to start the survey Fill out If the user has verified his account by entering a valid token he is allowed to fill aout the survey. When a has filled out the survey the following changes are made to the database: lime_tokens_12345: The completed value is filled with a timstamp. lime_survey_12345: A new entry containing the participants data like Date/Time, IP-Adress and his answers is created. For each answer a column in the format IdXGoupIdXQuestionId is created Save unsubmitted If the option to save unsubmitted surveys is enabled the user is able to leave the survey and save the answers given so far. Therefore a username and password (and an adress) has to be entered. An is sent to the user with a link which directly leads him to the page he left the survey. Using username and password the user can login and continue to fill out the survey. When a unsubmitted survey was saved the following changes are made to the database: lime_survey_12345: The value of submitdate is set to zero (datestamp is filled with date/time of the first answer given). lime_saved_control: The following values are stored: survey ID (sid) ID of the non-completed question (srid) username 2.10 Send Invitation 11

12 password (encrypted) timestamp When a user resumes to fill out the unsubmitted survey the following changes are made to the database: lime_saved_control: The user's data is deleted lime_tokens_12345: completed is set to "Y" lime_survey_12345: submitdate and datestamp are filled with timestamps of the last interaction 2.14 Deactivate When a survey is deactivated the data tables are renamed. The probands table is renamed, too. The renamed tables use the following format: lime_old_surveyid_datetime. Data can only be accessed by using tools like phpmyadmin. Therefore it is always useful to export data first before deactivating a survey Save unsubmitted 12