Actions

Difference between revisions of "General FAQ"

From LimeSurvey Manual

m
m (Hiding "Exit and clear survey")
Line 253: Line 253:
  
  
<center>[[File:]]</center>
+
<center>[[File:Hide exit and clear survey.png]]</center>
  
  
Line 263: Line 263:
  
  
<center>[[File:]]</center>
+
<center>[[File:exit and clear survey pic.png]]</center>
  
  
Line 269: Line 269:
  
  
<center>[[File:]]</center>
+
<center>[[File:no exit clear survey.png]]</center>
  
  
<div class="simplebox">[[File:help.png]] '''Note:''' This customization can be used when you create long surveys and require from your respondents to save and resume later the survey. Sometimes, the users tend to click the "Exit and clear survey" button which deletes the entry from the partially completed responses table.
+
<div class="simplebox">[[File:help.png]] '''Note:''' This customization can be used when you create long surveys and require from your respondents to save and resume later the survey. Sometimes, the users tend to click the "Exit and clear survey" button which deletes the entry from the partially completed responses table.</div>
  
 
=Help, I accidentally...= <!--T:30-->
 
=Help, I accidentally...= <!--T:30-->

Revision as of 16:41, 20 June 2019

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎日本語 • ‎Nederlands • ‎русский • ‎slovenščina • ‎svenska


Help.pngThe following answers have been provided by the LimeSurvey user community. In case you do not understand something or you are unsure about what you have to do next, you can address your question(s) to the rest of community members: https://limesurvey.org/forums. For professional help, please check our list of authorized partners: https://limesurvey.com.


Getting started

If you don't want to read half the manual to get a feeling what can be done with LimeSurvey, we recommend you to watch some YouTube video tutorials:


Help.pngIf you know any good video out there, do not hesitate to share it with us.


I need a quick introduction for LimeSurvey

For a quick text introduction to LimeSurvey, check the following two links:


Important.png
We are working at the moment on introductory videos to LimeSurvey.


Survey design and layout

How can I remove index.php from the URL path to get a shorter URL

If you want to use fancy URLs (not have /index.php in every URL), please edit /application/config/config.php and change

'showScriptName' => true,

to

'showScriptName' => false,

For this to work properly, you must use an Apache webserver with a properly installed mod_rewrite module.

If you are using the Nginx http server (with php running via FastCGI) and want to use the 'urlFormat' => 'path' setting (see config.php), consider the following Nginx website configuration:

server {
    set $host_path "/PATH/TO/LIMESURVEY";
    server_name  YOUR.SERVER.FQDN;
    root /PATH/TO/LIMESURVEY;
    charset utf-8;
    try_files $uri $uri/ /index.php?r=$uri&$args;
    #Disallow reading inside php script directory, see issue with debug > 1 on note
    location ~ ^/(application|protected|framework|themes/\w+/views) {
        deny  all;
    }
    #Disallow direct read user upload files
    location ~ ^/upload/surveys/.*/fu_[a-z0-9]*$ {
        return 444;
    }
    #Disallow uploaded potential executable files in upload directory
    location ~* /upload/.*\.(pl|cgi|py|pyc|pyo|phtml|sh|lua|php|php3|php4|php5|php6|pcgi|pcgi3|pcgi4|pcgi5|pcgi6|icn)$ {
        return 444;
    }
    #avoid processing of calls to unexisting static files by yii
    location ~ \.(js|css|png|jpg|gif|swf|ico|pdf|mov|fla|zip|rar)$ {
        try_files $uri =404;
    }
    location ~ \.php$ {
        fastcgi_split_path_info  ^(.+\.php)(.*)$;
        try_files $uri index.php;
        fastcgi_pass   127.0.0.1:9000; # Change this to match your settings
        fastcgi_index index.php;
        include fastcgi_params;
        fastcgi_param  SCRIPT_FILENAME  $document_root$fastcgi_script_name;
        fastcgi_param  SCRIPT_NAME      $fastcgi_script_name;
    }
}
Help.pngThis disables access to files inside application. Some JavaScript and CSS files located within the application have to be readable with debug > 0. You can force the usage of the asset manager when the debug mode is enabled with 'use_asset_manager' => 1, in your config file (or remove application from the directory list).

The end result should look like this:


Remove index.php steps.png


How do I get rid of the * (red asterisk) of mandatory questions?

Instructions for LimeSurvey 2

In LimeSurvey 2.x, the red asterisk of mandatory questions is set within the template.css file ("asterisk" class). To hide it:

  • Open the template editor
  • Create a copy of the template you wish to modify
  • Select the "template.css" file and search for the asterix class
  • Add the following line at the end of the asterix class".asterisk {display: none;}".
  • Save template.css
  • Clear your browser cache so that the edited template.css is reloaded and not taken from cache.


Instructions for LimeSurvey 3

The instructions are similar to the ones presented above for LimeSurvey 2.

  • Access the desired theme. If it is a default theme, create a copy of it by clicking on the "extend" button.
  • Access the list of themes and click on the theme editor that corresponds to the newly created theme.
  • On the left side, you can visualise the corresponding CSS files of your theme.
  • Click on custom.css and add the following line:
.asterisk {display: none;}


  • Save the changes. The red asterisk that is usually displayed at the beginning of the question text is hidden.


How can I embed a flash file?

First, go to Global settings and deactivate the XSS-filter. Please also read up the implications deactivating that filter has on your instance. The following steps will not work if the filter is active.

  1. Navigate to the place in your survey where you want insert your Flash file. This can be anywhere where you can use the integrated HTML editor, for example in questions, subquestions, answers, survey welcome/end text and many more.
  2. Open the full-screen editor mode by clicking the 'LimeFitWin' button on the editor tool-bar.
  3. On the full-screen editor tool-bar you will find a little button with a Flash symbol. Click on it. A dialog box will open.
  4. In this box you can give either the path to an existing Flash file somewhere or you click the 'Browse server' button.
  5. If you clicked the 'Browse server' button you will be presented with a file browser and on the bottom an file upload field. Choose now an existing file or upload a file first.


That's it! If you find this description incomplete please update it accordingly.


Important.png
Attention : The steps to use it in LimeSurvey 3 are similar. However, we do not recommend our users to use flash files!


How do I create a survey which is open to everyone?

To create a survey that can be filled out by anyone, do not create a survey participants table! Share the survey link located on the overview panel.


Public registration - mandatory fields

If you use a survey participants table and you also allow public registration, then users will be prompted by the following message:


Non-mandatory public reg.png


As it can be observed above, only the email field is mandatory.

To have all three fields marked as being mandatory, please edit your survey theme accordingly. If you use Fruity, you have to go to the registration screen and see how the participants email field looks like:

        {# Participants email #}
        <div class='{{ aSurveyInfo.class.registerformcolrowc }} form-group row' {{ aSurveyInfo.attr.registerformcolrowc }}>
            <label {{ aSurveyInfo.attr.registerformcolrowclabel }} class='{{ aSurveyInfo.class.registerformcolrowclabel }}  control-label'> {{ gT("Email address:") }} {{ include('./subviews/registration/required.twig') }}</label>
            <div {{ aSurveyInfo.attr.registerformcolrowcdiv }}  >
                {{ C.Html.textField('register_email', aSurveyInfo.sEmail, ({'id' : 'register_email','class' : 'form-control input-sm','required' : true})) }}
            </div>
        </div>

After that, make sure to edit the first name and last name fields correspondingly by adding the label:

{{ include('./subviews/registration/required.twig') }}

and this line which makes the field mandatory to be filled out:

'required' : true

The edited file should look like this:

        {# Participants first name #}
        <div class='{{ aSurveyInfo.class.registerformcolrow }} form-group row' {{ aSurveyInfo.attr.registerformcolrow }}>
            <label for='register_firstname' class='{{ aSurveyInfo.class.registerformcolrowlabel }} control-label '>{{ gT("First name:") }} {{ include('./subviews/registration/required.twig') }}</label> {# extra label #}
            <div class="">
                {{ C.Html.textField('register_firstname', aSurveyInfo.sFirstName, ({'id' : 'register_firstname','class' : 'form-control', 'required' : true})) }} {# mandatory field #}
            </div>
        </div>

        {# Participants last name #}
        <div class='{{ aSurveyInfo.class.registerformcolrowb }} form-group row' {{ aSurveyInfo.attr.registerformcolrowb }}>
            <label {{ aSurveyInfo.attr.registerformcolrowblabel }}  class='{{ aSurveyInfo.class.registerformcolrowblabel }} control-label '>{{ gT("Last name:") }} {{ include('./subviews/registration/required.twig') }}</label> {# extra label #}
            <div {{ aSurveyInfo.attr.registerformcolrowbdiv }} >
                {{ C.Html.textField('register_lastname', aSurveyInfo.sLastName, ({'id' : 'register_lastname', 'class' : 'form-control', 'required' : true})) }} {# mandatory field #}
            </div>
        </div>


Now, the public registration page should look like this (all the fields being mandatory):


Mandatory public reg.png


Hiding the language switcher

The steps to hide both the language switchers (near the survey title and on the top-right side of the page) are described in our wiki section dedicated to multilingual surveys.


Hiding "Exit and clear survey"

In case you wish to hide the button "Exit and clear survey", you have to edit the nav_bar.twig file located inside your survey theme.


Hide exit and clear survey.png


The line that needs to be removed is this one:

{{ include('./subviews/navigation/clearall_links.twig') }}


Exit and clear survey pic.png


Now, there is no option to exit and clear the survey.


No exit clear survey.png


Help.png Note: This customization can be used when you create long surveys and require from your respondents to save and resume later the survey. Sometimes, the users tend to click the "Exit and clear survey" button which deletes the entry from the partially completed responses table.

Help, I accidentally...

I forgot my admin password. How do I reset it?

Version 2.x

  1. Access to your server with a command line (ssh for example)
  2. Ensure you have php command line access (see http://php.net/features.commandline.php).
  3. Go to your LimeSurvey directory
  4. Launch this command php application/commands/starter.php resetpassword NEW_ADMIN_NAME NEW_ADMIN_PASS or php application/commands/console.php resetpassword NEW_ADMIN_NAME NEW_ADMIN_PASSThe php can need complete directory access, example /usr/bin/php


Important.png
Please note that this method will not work in LimeSurvey 3.x!


Version 2.x.x and newer with only FTP access

See ResetPasswordController


Directly change the password in the database

If you have direct access to the Limesurvey database you can change the old password there by uploading the new password as SHA256 hash. You can create the SHA256 hash of your password here.

For example, you can use this instruction to set password to password:

UPDATE lime_users SET password = 0x35653838343839386461323830343731353164306535366638646336323932373733363033643064366161626264643632613131656637323164313534326438 WHERE uid =1;

Here with prefix to lime_ and database selected.


How can I restore data from a deactivated survey?

We recommend to always use the time-out option instead of deactivating a survey. If you closed your survey accidentally, it is important that you don't change anything in the survey!

Then, and only then the following steps will work:

  1. Activate your survey again
  2. Select Responses from the survey toolbar.
  3. Click on Import and select the "Import answers from a deactivated survey table" menu entry.
  4. Choose your source table.
  5. Click on the "Import" button located on the upper-right part of the screen.


Help.pngTo understand the difference between "expiry" and "deactivation", visit this following wiki section.


I deleted a question/question group/survey!

If you delete it, it is gone. Only a backup could help you recover it.


Help.pngIf you are a LimeSurvey GmbH professional user, please open a support ticket and ask the team to provide you the backup associated to your account. Please note that this service is not free of charge!


Hard- and Software requirements

For general requirements please refer to our installation instructions.


What limitations does LimeSurvey have...

...regarding speed

There is no existing speed limit on LimeSurvey. Everything depends on how fast your server and your connection are. If you expect a large number of users within a short amount of time and you are not sure if your server can handle this, check our forum for similar topics! or contact an authorized LimeSurvey partner: https://limesurvey.com.

...regarding survey size

Note: 'Survey size' refers to the maximum number of questions (and answers) in your survey - don't confuse this with the number of replies on your survey (there is no limitation on that). Theoretically there would also be no limit on the maximum number of questions/answers in LimeSurvey. But the database engine you are using has several limits. The most important one is the limit on the number of fields(columns) in the result table.

  • MySQL ISAM: The sum of the lengths of the VARCHAR and CHAR columns in a table may be up to 64KB.
  • MySQL InnoDB: Maximum number of 1000 columns
  • MS SQL Server 2000: Maximum number of 1024 columns
  • Postgres: Maximum number of 250-1600 columns depending on column types. The maximum number of columns can be quadrupled by increasing the default block size to 32k. See Installation FAQ and PostgreSQL FAQ.
Important.png
Attention : Please think about what you do before you do it! An array of 10 x 10 items already costs you 100 columns. Rule of thumb: every item on the screen that can be filled in or selected costs one column!

The mySQL ISAM engine is the most tricky one (see mysql documentation for more information). As it allows only up to 65,535 bytes per row and utf8 characters, it can require up to three bytes per character. The maximum may be only 21,844 characters (but this depends on your DB encoding).

You can roughly calculate the size of your survey like this:

  • Every multiple numerical question: 20 chars for each answer
  • Every multiple choice & array question answers: 5 chars for each answer
  • Every other question type: 5 chars
  • Add 10% for the usual overhead

How to increase the maximum number of columns in PostgreSQL

In case your survey contains too many questions, you can define a different block size in PostgreSQL to create more columns. This might be tricky because you have to recompile PostgreSQL and set BLCKSZ to a higher value, like 16kiB or 32kiB. Watch for the configuration option "--with-blocksize=BLOCKSIZE". For details see the archives of the PostgreSQL mailing list or ask there (pgsql-patches(at)postgresql(dot)org).

Instructions for Debian (thanks to Martin Pitt):

sudo apt-get build-dep postgresql-8.3
apt-get source postgresql-8.3
cd postgresql-8.3-*
debian/rules patch
sensible-editor build-tree/postgresql-8.3.5/src/include/pg_config_manual.h
dpkg-buildpackage -us -uc -b -nc

Note: the above could not be reproduced on Ubuntu 14.04 in August 2014. A patch is required (the configuration option is not enough). See (tested with PostgreSQL 9.3 on Linux): Instructions for increasing the maximum number of columns in PostgreSQL on Linux

Fatal error: Allowed memory size

Depending on your server configuration you might run into memory problems being reported by an error like "Fatal error: Allowed memory size of 8388608 bytes exhausted (tried to allocate 233472 bytes) in /path/to/htdocs/limesurvey/filename.php on line 7296".

You can try to raise the limit by adding an optional setting to LimeSurvey's config file.

Please bear in mind that changes in the default settings of an application can always be overruled by global server settings. To increase the memory limit of your sever to 128M:

  • memory_limit = 128M to your server's main php.ini file (recommended, if you have access)
  • memory_limit = 128M to a php.ini file in the LimeSurvey root
  • php_value memory_limit 32M in a .htaccess file located in the LimeSurvey root folder
  • " ini_set('memory_limit', '128M'); " in your config.php

Specific configuration

Under certain circumstances, you need to update the LimeSurvey configuration in application/config/config.php


Two LimeSurvey instances on same domain

If you run 2 LimeSurvey instances on the same domain, but within different directories, you need to update the session configuration.


For example, if you have example.org/ls1 and example.org/ls2, update the ls1 config file:

        'session' => array (
            'cookieParams' => array(
                    'path' => '/ls1',
                ),
            ),
        'request' => array(
            'csrfCookie' => array( 'path' => '/ls1' )
        ),