Difference between revisions of "Tab Separated Value survey structure"
From LimeSurvey Manual
m (Cdorin moved page Tab Separated Value Survey Structure to Tab Separated Value survey structure without leaving a redirect)
Revision as of 14:57, 2 August 2017
Tab Separated Value Import and Export of Survey Structure
This feature is designed to make it easy to use a spreadsheet software like Excel, LibreOffice or Google Docs to author and edit surveys. It completely eliminates the dependence upon SGQA codes.
This feature supports import from ASCII or UTF-8 encoded Tab Separated Value (TSV) files which have an extension of .txt.
The easiest way is to take an existing instrument and export it in Tab Separated Value format. Use the normal export survey button, and instead of selecting .lss format, select "LimeSurvey Tab Separated Value survey file (*.txt)". It will save as an Tab Separated Value file in the proper format (tab delimited unicode file), with all the correct column headings.
Any spreadsheet software the supports tab separated values is fine (e.g. OpenOffice or LibreOffice). LimeSurvey ignores any formatting within the spreadsheet, but feel free to add some if it helps you.
There will be one row for each group, question, sub-question, and answer. There are also rows for global survey variables, and for language-specific survey variables. The primary language will be listed first, followed by any secondary languages. So, if there are multiple languages, the entire contents of the base language will appear first (e.g. all groups, questions, sub-questions, and answers). This will be followed by a translated copy for each secondary language (with exactly the same number and order or rows for the translated set).
Relationships are inferred by proximity. So, questions following a group are part of that group; sub-questions following a question are part of that question, and answers following a question are part of that question. Thus, you don't need to know the IDs (gid, qid, sqid) for any questions. Those will be computed automatically upon import. In fact, this format does not use gid, qid, or sqid (or SGQA codes) at all.
The goal of the Tab Separated Value import/export is to let you rapidly design your survey using a spreadsheet. We expect that you will frequently import the sheet, check its validity using the "Show Survey Logic" feature, and test it. Each time you import it, you will get a new survey. So, you might end up with many partially developed surveys, but that is fine. Just get in the habit of keeping track of which is the most recent, or delete the old one after you import the new ones. Since you never use SGQA codes in the Tab Separated Value, you never need to worry about what codes LimeSurvey assigns for the primary survey, group, question and answer keys. So, feel free to import and export as often as you like.
Here are some convenient things you can do with this approach to authoring instruments:
- Use same Answers for many questions. Just copy the 'A' rows and paste after each question that should have the same set.
- Use same sub-questions for many questions. Just copy the 'SQ' rows and paste them after each question that needs it.
- "Looping" - use same group many times. After the group is the way you want it, copy it as many times as needed. Use Excel filtering to view just the 'G' rows (for groups), and use the Excel column drag feature to update the relevance equations for each group (e.g. for a census, the first relevance might be "numPeople > 1", the next should be "numPeople > 2". The drag feature will auto-update the number). Filter by 'Q' rows and ensure that each question has a unique value (e.g. say you name your variables g1_q1, g1_q2, g1_qN, use find/replace to convert g1 to g2 the second group; g3 for the third, etc.).
- Re-ordering questions/groups. Simply re-order the rows of the spreadsheet file.
- Testing survey modules. For long surveys, you may want to break up the testing into modules. Simply create new spreadsheet files for each module, deleting any rows that you don't need. This avoids the need to enter lots of data to test later sections of the survey.
- Testing mandatory questions. A common complaint is the need to make many questions mandatory, but the need to turn off the mandatory feature for testing. Simply create the master spreadsheet with mandatory set the the final desired values. Then, to test it, just delete the "mandatory" column and save the test version of the spreadsheet. When you import that version, none of the questions will be mandatory. After you have finished your testing, import the master copy.
- Setting defaults. Rather than using the GUI, you can enter any desired defaults in the default column. This is especially helpful for cases where the GUI does not let you enter the desired value, like Expressions to set the default for list items (like populating a list from a token attribute).
- Translation. You can create copies of your spreadsheet - one per language. Include all the rows for the primary language, then copy and paste them below, and use drag to change the language field to the target language. These can be distributed to your translators, and re-integrated into a single spreadsheet file when they are done.
- Bulk setting of advanced question attributes. You may want all of your equations to start visible (so you can see their values as you collect data), but then hide them all before going to production. Simply filter the spreadsheet on class = 'Q' and question type = '*' (equation), and set always_hide to 1 for each of those questions. Similarly, say after you create the survey, you decide which questions should appear in public statistics. Rather than edit each question through the GUI, filter on class = 'Q', and set public_statistics = 1 for all of the questions that should be visible in statistics.
- Find and replace. Say you decide you need to change some phrasing across all of your questions, you can use Excel find and replace to make those changes. Similarly, say you decide to do a bulk-renaming of your variables, find and replace can come to the rescue. If you need regular-expression based find and replace, you can select the desired column, copy to a text editor, do your find and replace, and paste the column back into the spreadsheet.
- Gaining approvals. If you are doing research, you may have an Institutional Review board who insists upon seeing the text of the questions. This may be a convenient way to share it. Similarly for discussions with a client.
- Team consensus. If you are trying to get a group to agree upon the wording or appearance of a question or group, you can rapidly prototype / edit the spreadsheet, import it, and show the team (via question or group preview) exactly what the users will see. That way you can get approval from the team before they leave the room rather than having to document requirements, build them, and get approval at future meetings.
- Upgrading from other survey formats. If you have existing survey in XML, Word, or other format, you can create a translation process to map them to this format. Although you could also try mapping to the .lss format, the advantage of this format is that it doesn't require you to keep track of foreign key relationships between groups, questions, sub-questions, answers, and defaults.
- By design, this feature only works properly for surveys that use qcode (rather than SGQA) naming. This feature assumes that variable names (question identifiers) are unique throughout the survey. Sub-question names can be repeated, as long as they are unique within the scope of a particular question.
- Currently, it does not import or export Conditions (since it assumes you'll be using relevance equations instead), Assessments (since it assumes you'll be using tailoring), or Quotas. However, if there is enough demand, it would not be hard to add these.
- Currently, the Tab Separated Value export feature does not export defaults for list-type questions.
We use the same set of column headings for multiple purposes. The first 12 columns serve different purposes depending upon the type of entity (e.g. group, question, answer). The remaining columns are an alphabetical list of the database field names for the advanced question codes. Below is the syntax for each entity type
The first 12 columns are:
Survey Global Parameters
There is one row per parameter in the surveys table.
- class = 'S'
- name => database field name
- text => value
Survey Language-Specific Parameters
There is one row per field per language in the surveys_languagesettings table. All entries for a given language are collected before doing the insert into that table.
- class = 'SL'
- name => database field name
- text => value
- language => language
There is one row per group.
- class = 'G'
- name => group_name -- the unique identifier for the group
- relevance => grelevance -- the group-level relevance equation, without curly braces
- text => description -- the language-specific description of the group
- language => language -- the language for the group (e.g. 'en')
One row per question. Questions are assumed to belong to the group that precedes them.
- class = 'Q'
- type/scale => type -- the (usually one letter) question type (e.g. 'M' is Multiple Choice)
- name => title -- the unique question name (the root of the qcode naming system)
- relevance => relevance -- the relevance equation for the question
- text => question -- the language-specific text of the question
- help => help -- the language-specific help text
- language => language -- the language for the group (e.g. 'en')
- validation => preg -- the optional regular expression validation criteria for the question
- mandatory => mandatory -- 'Y' if mandatory
- other => other -- 'Y' if the "Other" option should be available (only for some question types)
- default => default -- if set, this value is inserted into the defaultvalues table for this question
- same_default => same_default -- 'Y' for true, in which case any defaultvalue set for primary language applies to other languages
One row per sub-question. Sub-questions are assumed to belong to the question that precedes them.
- class = 'SQ'
- type/scale => scale_id -- 0 or 1, depending upon question type (e.g. array text will have two scales)
- name => title -- the "name" of the sub-question, e.g. the one used for exclude_all_others
- relevance => relevance -- (Future) to support sub-question-level relevance
- text => question -- the language-specific text of the sub-question
- help => help -- (Future) to support sub-question-level help
- language => language -- the language for the sub-question
- validation => preg -- (Future) to support sub-question-level regular expression validation (e.g. for address parts)
- mandatory => mandatory -- (Future) to support sub-question-level mandatory (e.g. make only a few sub-questions mandatory)
- default => default -- if set, then this is the default value for the sub-question (inserted into defaultvalues table)
- same_default => same_default -- if set, then the default for the primary language is used for all other languages
One row per answer. Answers are assumed to belong to the question that precedes them, and be in the desired sort order.
- class = 'A'
- type/scale => scale_id -- 0 or 1 (e.g. for dual-scale)
- name => code -- the unique answer identifier
- relevance => assessment_value -- if using assessment option, this is the assessment value for the answer
- text => answer -- the language-specific text of the answer
- language => language -- the language for this answer (e.g. 'en')