LimeSurvey Manual - User contributions [en]

Installation - LimeSurvey CE

2026-06-17T10:38:15Z

Tibor.pacalat:

<languages />
<translate>


__TOC__


<div class="simplebox"> Note: These installation instructions are for version 2.0 or later. Older instructions for 1.92 can be found [[Installation Version 1.92 or older|here]] and update instructions can be found [[Upgrading from a previous version|here]]. </div>

==Make sure you can use LimeSurvey on your website== 


Make sure your server meets the following additional requirements.


{{Note|The minimum set of requirements will also be checked during the installation process!}}


The minimum set of requirements for '''LimeSurvey 6.x''':
* Minimum 250 MB disk space.
* MariaDB 10.3.38 or later '''OR''' MySQL 8 or later '''OR''' Microsoft SQL Server 2019 or later '''OR''' Postgres 14 or later.
* PHP version requirements:
** LS 7.x from PHP 8.1.29 and up (Tested up to PHP 8.4.x)
** LS 6.x from PHP 7.4.x to 8.3.x
** LS 5.x from PHP 7.2.5 to 8.0.x
** LS 3.x from PHP 5.5.9 to 7.4.x
* php.ini `short_open_tag` setting should be set to `ON`
* The following PHP modules/libraries should be enabled:
** [[Installation FAQ#Requirements page#What is the mbstring (Multibyte String Functions) library|mbstring (Multibyte String Functions)]] extension library.
** PDO database driver for MySQL (pdo_mysql or pdo_mysqli) or Postgres (pdo_pgsql) or MSSQL ([https://php.net/manual/en/ref.pdo-sqlsrv.php pdo_sqlsrv] for Windows and [http://www.php.net/manual/en/ref.pdo-dblib.php pdo_dblib] for Linux).
** Also, we assume in general that all PHP default libraries are enabled
*** hash
*** session
*** openssl or mcrypt
*** fileinfo
*** SimpleXML
*** etc …


<div class="simplebox"> Note: If you are connecting from Linux to a MSSQL database on a Windows server using the dblib PDO driver, then the underlying FreeTDS needs to be set up correctly. Check out the [[Troubleshooting]] page for more information.</div>


Optional PHP Extensions:
* '''GD-Library''' '''with FreeType support''' installed is needed for captchas, nice charts in statistics or to upload images via the HTML editor - see [https://php.net/manual/image.setup.php PHP GD-Library Extension documentation]
* '''IMAP''' (pretty standard) is needed for the [[Email bounce tracking system|email bounce tracking system]] - see [https://php.net/manual/imap.setup.php PHP IMAP Extension documentation]
* '''LDAP''' installed is needed to import survey participants using LDAP - see [https://php.net/manual/en/book.ldap.php PHP LDAP Documentation]
* '''Zip''' (pretty standard) is needed for template upload, import of .zip archived resources, and excel export - see [https://php.net/manual/zip.setup.php PHP Zip Extension documentation]
* '''Zlib''' (pretty standard) is needed for the [[ComfortUpdate]] - see [https://php.net/manual/zlib.setup.php PHP Zlib Extension documentation]


In most cases, your web server provider or system administrator will be able to help you out with these optional components.


===Browser compatibility===
'''For the survey-taking side''', we currently support Edge and all newer comparable browsers like FF, Chrome, Opera etc. with activated JavaScript.


'''For the administration part''', we currently support Edge and all newer comparable browsers like FF, Chrome, Opera etc. with activated JavaScript.


====Screen sizes====
We support any reasonable screen size for survey taking (360px x 640px and up).
The minimum supported screen resolution for the LimeSurvey administration page is 1280px x 1024px.

===Hosting for LimeSurvey=== 


LimeSurvey should work with most hosting companies that provide PHP and MySQL. If you want a ready-installed version of LimeSurvey, you could try [https://www.limesurvey.org/editions-and-prices/limesurvey-pro/editions-and-prices-professional LimeSurvey Cloud] or check [https://www.limesurvey.org/manual/LimeSurvey-compatible_hosting_companies/en other hosting providers].

==Download the LimeSurvey package== 


[https://community.limesurvey.org/downloads/ Download] the latest stable LimeSurvey zip package (there are also gzip, bz2 and 7zip packages available for your convenience) and save it to your local disk.

==Unpack the LimeSurvey package== 


Uncompress the zip file into a dedicated directory/folder using your preferred compression software. When you uncompress the file make sure that you uncompress the directory structure with the files (this is default behavior for most compression programs). The path name for the installation directory should not include '(' or ')' special characters, but it may include the '''space''' character.

==Collect information about your server== 


You will need to know the following things to install LimeSurvey on your web server correctly:
*Your intended website URL where your scripts will reside (e.g. ''http://my.domain.com/limesurvey'').
*The physical disk location on your server where your scripts will reside (e.g. ''/home/usr/htdocs/limesurvey'').
*The IP/net location of your database server (i.e. ''localhost'').
*If your database server uses a non-standard port, find out which port it is.
*Your user name and password for your database server.
*With most providers you can't let the script create the database, but have to do it yourself. If you are using such a provider, please create a database (for example ''limesurvey'') yourself.

==Upload the files to your web server== 


Using your FTP program (e.g. FileZilla), connect to your web server and create a directory to store your scripts. Then upload the files using the directory structure they are in. Make sure you '''upload the files in binary mode''' (check the settings of your FTP program). Please note that uploading in ASCII mode can lead to uncommon errors (e.g. 'class not found' error during installation), also images may not be uploaded correctly.

==Set directory permissions== 


For the script to work properly it needs certain access to some directories - this applies especially to Linux/*nix systems.
*The '''"/limesurvey/tmp"''' directory (and all its subdirectories and files) are used for imports & uploads and should be set to ''Read & Write'' for your webserver.
*The '''"/limesurvey/upload/"''' directory (and all its subdirectories and files) must also have ''Read & Write'' for your webserver in order to enable picture and media files upload.
*The '''"/limesurvey/application/config/"''' directory also needs ''Read & Write'' permissions for your webserver.
*The other directories can be set to ''Read Only''. You may wish in Linux/Unix to set the permissions on each file within the /limesurvey/admin directory to ''Read Only''.


{{Alert|If you are using Linux, then setting permissions depends on your webserver configuration. For example, if you use Apache HTTPD on CentOS, type '''chmod -R 755 <directory> ; chown -R apache <directory>'''. This will give everyone access to read, and your webserver will have the permission to write. Check the [https://www.linux.com/learn/tutorials/309527-understanding-linux-file-permissions following link] for more information on Linux permissions.}}

==Create a database user== 


LimeSurvey will create a database and the tables inside it. To be able to do this, it will need the user name and password of a database user. We generally recommend creating a database user with the following permissions:


- MySQL: SELECT, CREATE, INSERT, UPDATE, DELETE, ALTER, DROP, INDEX


- PostgreSQL: SELECT, INSERT, UPDATE, DELETE, TRUNCATE, TRIGGER


- Microsoft SQL Server: ''Unknown - if you can find out this information, please complete it''.

==Run the installation script== 


'''Go to "example.org/limesurvey/admin"'''. If you configured everything correctly, the LimeSurvey installer should be starting - just follow the instructions. You will be asked whether you wish to create the database and/or create the tables inside the database. LimeSurvey will then create the needed tables in the database.

==Connect to the administration script for the first time== 


You are done when the installation finishes! Open your browser and enter the URL to the LimeSurvey administration. Assuming you used 'limesurvey' as the directory name to store the files in, this will be something like "http://www.example.com/limesurvey/admin".


You should get a login screen. The default login credentials (if they have not been changed during the installation) are:


<syntaxhighlight lang='html'>


User: admin
Password: password


</syntaxhighlight>


You will be prompted to change the default password after you logged in. Have fun!

==Further configuration== 

===Caching=== 


LimeSurvey uses the Yii file cache by default, but it can be configured to use other cache engines. Possible other caches are:


* Memcached
* Redis
* WinCache
* XCache


Please see the [https://www.yiiframework.com/doc/api/1.1/CCache Yii documentation] for full description.


Since LimeSurvey 4.0.0 you also have the possibility to cache calculations in the ExpressionScript. This can provide a significant speed-up depending on survey complexity. To enable the emcache, add this in your config.php file (components array):


<syntaxhighlight lang="php">
'emcache' => array('class' => 'CFileCache'),
</syntaxhighlight>


As with the main Yii cache, other cache systems can be used.


{{Note| The emcache is not compatible with randomized surveys, and will be automatically turned off in such cases.}}

==What if I have problems...== 


Like all computer programs, most of the time things will work just like the instructions say, but sometimes they just won't. There are too many possible reasons for things not going according to plan to describe here. If you have trouble, first check out the [[Installation FAQ]]. If you don't find your answer there, please post your problem and any error messages in the [https://www.limesurvey.org/forum LimeSurvey forums], open a [https://www.limesurvey.org/contact-us support ticket] (only for customers using LimeSurvey Cloud), or join our [https://discord.gg/DEjguXn Discord channel].

</translate>

Participant settings

2026-04-16T09:38:34Z

Tibor.pacalat: added clarification about repeated survey registration

<languages />
<translate>

=Introduction= 


From this panel, you can edit different survey participants table settings. For example, you can choose to anonymize all the responses you get from a survey or allow public survey registration. It represents together with the [[Survey participants]] panel a powerful feature of LimeSurvey.


To access these settings, '''Participant settings''' from the '''Settings''' menu.


<center>[[File:Survey menu - participant tokens.png]]</center>

=Participant settings panel= 


The following options are available:


<center>[[File:Participants tokens panel.png]]</center>


==Set token length to==
Usually, the default value of 15 (max. supported value: 35) digits does not need to be changed. However, if you wish to change this setting, please enter a number (X) which is greater than 5. If the number entered is smaller than 5, it will be converted to the default value of 15. '''When generating tokens, all tokens will use a length of X digits.'''


==Anonymized responses==
This option allows you to determine whether responses to your survey are matched up with information from your survey participants table, or kept "anonymous". The default is "No". If you choose "Yes", then your survey is set to anonymize responses - '''there will be no way to connect answers and participants'''. Even the admin will not be able to link response data and participant data. However, you will always be able to specifically view each response entered by your participants in the survey. Thus individual and anonymous analyses can still be done.


{{Alert|title=Attention|text=If this feature is activated, the response submission date and the token completed date are always set to 1980-01-01 00:00, no matter of other settings. Invalidating the submission date ensures no match with webserver logs where the token key might show up when a survey is started. Invalidating the token completed date guarantees that you can't align the order of submitted responses to the order of the token date/time.}}

==Enable token-based response persistence== 


If your survey uses tokens and your responses are not anonymized, you may want to enable this feature. If you turn this on, your participants will be able to leave the survey and resume later at any time '''without''' using the "Resume later" function - for example, when they get distracted or their browser crashes. Upon clicking the invitation link again, they will find their survey answers still in place when they return to the survey and will even find themselves on the same page where they were before leaving.


{{Alert|title=Attention|text=If this feature is not activated, all started responses but not submitted are not included in total allowed response by participant (Use left). Take particular care if you wish to have only one response per participant by using Allow multiple response to Off.}}

==Allow multiple responses or update responses with one token== 


If this option is activated, participants will be able to return to their survey by clicking the invitation link, even if they have already submitted the survey.


* If the survey is anonymous or "Enable token-based response persistence" is set to "No", this will '''add a new response'''.


* If the survey is not anonymous and token-based response persistence is enabled, the user will '''update the existing responses'''. If quota is activated : submitted response are not checked, participant can update the quota enable response and set a value out of quota.


==Allow public registration==
If you use tokens to control access to your survey, the only people who can use the survey are those who have an entry and a unique token allocated in the survey participants table. If you would like to use tokens, but also allow public registration, set this to "Yes". The "Yes" setting will allow a visitor to register his name and email address. This will create a new entry in your survey participants table for this person, then send them an invitation email. The application's backend ensures that only one person per email address can complete your survey. If a visitor tries to register for the second time with the same email address, they will not receive another email.


==Use HTML format for token emails==
When enabled, all emails sent via the LimeSurvey email system management interface (invite, reminder, confirmation) will be formatted as HTML. You'll then be able to use rich formatting for these emails. The default value is "Yes".


As of version 4.x, when using HTML format a WYSIWYG editor will be available to edit email templates.
{{Box|This settings is used for [[Notifications_%26_data#Basic_and_detailed_admin_notifications_email|basic and detailed admin notifications email ]] too.}}
{{Alert|title=Attention|text=When you switch on or off this feature, you'll have to double check that your email templates are still displayed as you want.}}


==Send confirmation emails==
If enabled, the participant will receive a confirmation email that the survey was submitted.

</translate>

First login - your user preferences

2025-04-08T12:03:19Z

Tibor.pacalat: updated breadcrumb mode setting description

<languages />
<translate>
==First Login== 

===With LimeSurvey Cloud=== 


After creating your LimeSurvey account, you will receive an email. This email contains the account activation link. Click the link to access your newly created account. Clicking the link takes you to your account on the LimeSurvey website.


You need to create a survey site before you can start creating and managing online surveys. Log in to your account and click Create survey site.


'''Create survey site''' link:


<center>[[File:NewSurveySiteSetupPage.png]]</center>


To create your LimeSurvey site:


(1) Enter your site name.


(2) Choose a domain name from the dropdown menu.


(3) Choose a server location.


(4) Click Save & Set Up LimeSurvey Site.


The process can take up to 20 seconds. When the process is complete, the window will close and you will be taken back to your account page.


You can now access your survey site by clicking View Survey Site at the top of the page.


<center>[[File:AccountHomePage.png]]</center>


Account login page:


Sign in to your account using your LimeSurvey.org credentials:


<center>[[File:LoginPage.png|0.75px]]</center>


You are ready to start creating surveys.

==Change your password== 
To change your password, use the ''Forgot your password?'' button located on the LimeSurvey administration login page.


<center>[[File:Forgotpassword.png]]</center>


After completing the required fields, click the ''Check data'' button. You will receive an email with the necessary steps that need to be followed in order to reset your password.


Another option to change your password is to do so from within your profile. Click your user name located in the upper right part of the screen (on the main LimeSurvey toolbar) and select the ''Your Profile'' tab.


Click the '''Change password''' buttonː


<center>[[File:Profilechangepassword.png]]</center>


Type the current password, and the new password twice. Then, save the new profile settings by clicking '''Save''' located in the upper right part of the screen.


<center>[[File:Forgotpassword_3.png]]</center>


<hr width="50%" style="margin:auto">


If you have superadmin permissions and one want to assist another user reset their password, you can do so by by using the ''User control panel''.


<center>[[File:LimeSurveyMenuUserManagement.png]]</center>


From the ''Action'' column click the green pen that corresponds to the respective user and change their password.


<center>[[File:LimeSurveyBleistiftSymbol.jpg]]</center>


<div class='simplebox'>[[File:help.png]] Check the wiki on [[Manage_users#User_management|the LimeSurvey user management functions]] for more information.</div>

===With LimeSurvey Cloud=== 


If you use [https://www.limesurvey.org/editions-and-prices/limesurvey-pro/editions-and-prices-professional LimeSurvey Pro], you can also reset your password from your [https://www.limesurvey.org/your-account/your-limesurvey-profile LimeSurvey profile]. From your LimeSurvey profile, click ''INSTALLATIONS'' (under the Profile Menu). Look for the ''RESET PASSWORD NOW'' button located in an orange box. Click it and a random password will be generated immediately.


{{Alert|It may take a few minutes for the changes to take effect - ca. 2 minutes.}}

=Your account preferences= 


To change your user preferences, click your username which is shown on the LimeSurvey main toolbar and then click '''Your account'''.


<center>[[File:userprofile.png]]</center>


Your account preferences toolbar contains four tabs:
*'''[[First_login_-_your_user_preferences#My profile|My profile]]''': General details about your account;
*'''[[First_login_-_your_user_preferences#My personal settings|My personal settings]]''': The user can choose the interface language and/or select other LimeSurvey-related editing modes;
*'''[[First_login_-_your_user_preferences#My personal menus|My personal menus]]'''{{NewIn|3.0}}: A list with the survey menus created by the respective user;
*'''[[First_login_-_your_user_preferences#My personal menu entries|My personal menu entries]]'''{{NewIn|3.0}}: A list with those menu entries that were created by the user.


<center>[[File:Toolbaruserpreferences.png]]</center>

==My profile== 
The following options are found under the ''My profile'' tab:
*'''Username''': Once created, it cannot be changed from the LimeSurvey interface. We recommend creating another user name instead of editing the configuration of your LimeSurvey installation;
*'''Email''': Type your new e-mail and click the 'Save' button to save the settings;
*'''Full name''': The name of the administrator;
*'''Password''' & '''Repeat password''': If you want to change your password, type the new password twice and click the 'Save' button.

==My personal settings== 
*'''Interface language''': The language of the Limesurvey administrative interface;
*'''HTML editor mode''': The inclusion of an integrated HTML editor;
*'''Question type selector''': If 'Full selector' option is chosen, then a question preview will be shown when selecting the type of a new question to be added into the survey;
*'''Template editor mode''': If 'full template editor' is selected, syntax highlighting will be used in the [[The template editor|LimeSurvey template editor]];
*'''Date format''': chooses the default date format used in the administration interface.
*'''Show script field''': The script field is specially intended for entering JavaScript while editing questions. This setting controls if it should be shown or not.
*'''Directly show edit mode''': Indicates if edit mode should be shown by default when entering a question.
*'''Non-Numerical answer option prefix''': Prefix to be used for answer options. It should be non numerical. If the prefix is "AO", answer options would be, for example, "AO001".
*'''Non-Numerical subquestions prefix''': Prefix to be used for for subquestions. It should be non numerical. If the prefix is "SQ", answer options would be, for example, "SQ001".
*'''Lock question organizer in sidebar by default''': If the question organizer should be shown or hide in the side bar.
*'''Create example question group and question''': This setting specifies if an example question group and question should be created automatically after creating a new survey.
*'''Breadcrumb mode''': User can choose between default, short and long breadcrumb representation. 'Default' takes over the setting from the Global Settings, 'Short' is the common breadcrumb representation, and 'Long' variant provides additional information (survey id, group id, question id).

===Interface language=== 


You can select the administrative language preference during log in by using the dropdown list as shown below. After a successful login, the LimeSurvey interface will change to the chosen language. The system will record this preference setting in your profile and make it the default for your next login.


<center>[[File:login language.png]]</center>


Some LimeSurvey setups hide or skip the login page to enable common authentication inside other applications. In this case, you won't have access to select the language. However, you can change your language preference from your account preferences. Access your account preferences by clicking your user name located in the upper right side of your browser and then the ''Your account'' button. Next, click the '''Your personal settings''' tab and select your desired language from the dropdown list located under '''Interface language'''.


<center>[[File:Selection 007.png]]</center>

===HTML editor mode=== 


There is an '''HTML editor''' integrated into LimeSurvey. This tool will help you develop rich formatting for your surveys, groups, questions, and answer text; for tables, and images. But as this editor takes extra space on the screen and resources on the computer, it is not always desirable to use. Therefore, four options are provided by LimeSurvey: '''default''', '''inline HTML editor''' (selected by default), '''popup HTML editor''', and '''no HTML editor'''.

====Default==== 


If the "default" option is selected, you will inherit the HTML editor mode selected by the superadminstrator from the [[Global settings#General|global settings]] of the LimeSurvey installation.

====Inline==== 
In this case, the '''HTML editor''' is always used in-line on the page. It also represents the 'default' value.


<center>[[File:InlineMode1.PNG]]</center>

====Popup==== 
The normal text editor is used, but the '''HTML editor''' is available as a pop-up option. You can always get to the '''HTML editor''' by clicking on the icon on the right of the normal text editor window as shown for the '''popup''' option below


<center>[[File:Popup1.PNG]]</center>

=====Fullscreen{{ObsoleteIn|3.0}}===== 


This option is available only for inline editor. It allows you to increase the size of the editor to fill the browser window and then decrease it back later.{{ObsoleteIn|3.0}}


<center>[[File:InlineMode2.PNG]]</center>


When switching between which editor you use, the last used editor before logout is recorded in your profile and will become the default at your next login.


Please note that when editing answers and labels, the normal text editor (or 'Popup' mode) is always used because of the larger number of windows.


{{Note|You can change the size of the HTML editor box by clicking on the bottom right corner of the editor.}}


<center>[[File:ExtendsizeHTML.png]]</center>

====Source code mode==== 


If you want to paste HTML or Javascript code directly, you must switch to the '''source code''' mode. This option is not available in your personal settings. However, it can be selected from the HTML editor menu.


<center>[[File:source_code_mode.png]]</center>


You must [[Global settings#Security|disable the ''Filter HTML for XSS'' setting]] in order to store code entered in the source code mode (or to have superadmin permissions).


<center>[[File:SourceCodeMode.png]]</center>

====No HTML editor==== 
If you do not want to use an HTML editor, select this option. You will be able to use only simple text in the surveys.


<div class="simplebox">'''Hint''': Why not always choose the '''HTML Editor'''? Depending on your use of LimeSurvey, there may be many text boxes on a single page, each with a copy of the editor. For instance, when editing the email text for a survey invitation that is offered in 5 languages, you can then have a total of 20 inline '''HTML editors''' active on the page. Each instance takes a fair amount of resources and will likely cause issues on your browser. So, if you work with multiple language surveys, we recommend you stick with the normal text editor or 'Popup' setting.</div>

===Question type selector=== 


Choose 'Full selector' to get a question type selector with preview and 'Simple selector' to get a plain select box. The 'default' option corresponds to the option selected in the [[Global settings|global settings]] of the LimeSurvey installation.

===Template editor mode=== 


Three options are available: 'default', 'full template editor', and 'simple template editor'. Choose 'Full template editor' to get an enhanced editor (with syntax-highlighting) when editing survey templates and 'Simple template editor' to get a plain editor field. The 'default' option corresponds to the option selected in the [[Global settings|global settings]] of the LimeSurvey installation.


{{Note|For a more comprehensive presentation of our template editor, check the [[The template editor|following wiki]].}}

===Date format=== 


This setting sets the date format for your profile (e.g. when you browse the survey results or for other settings located in the administration panel). It does '''not''' affect the actual surveys.


When creating a date/time question, you can set the date/time format when you edit/add a question. After you have chosen the '''date/time''' question format, type in the desired format you would like to use in the boxes located under the Input and Display tabs. For extra information, hover the mouse over the heading of each box.


<center>[[File:DateTimeFormatSurvey.png]]</center>

==My personal menus== 


You can visualise here the customized menus that are available to you or the ones you created via the [[Menu configuration|menu configuration option]].


To start editing them, access the '''Menu configuration''' option located within the '''Configuration''' menu.

==My personal menu entries== 


You can visualise here the customized menus entries that are available to you or the ones you created via the [[Menu entries configuration|menu entries configuration option]].


To edit them, you need to access the '''Menu entries configuration''' option located within the '''Configuration''' menu.

</translate>

Global settings

2025-04-08T11:59:46Z

Tibor.pacalat: added breadcrumb mode description

<languages /> <translate>


__TOC__

=General description= 


To access global settings options: '''Configuration''' ⇒ '''Settings''' ⇒ '''Global settings'''


<center>[[File:global.png]]</center>


The global settings can only be changed by those administration users with the [[Manage_users#Setting_global_permissions_for_a_user|Settings & Plugins permission]]. It can be used to adjust certain settings of LimeSurvey in a global context. Once you enter the global settings dialog and save your desired configuration, the previous LimeSurvey values will be overwritten.

=Settings and their explanation= 


<center>[[File:Global Settings Tabs.png]]</center>

==Overview== 
*'''Overview''': provides the following general information about your LimeSurvey installation:
**'''Users''': shows the number of users that can access the LimeSurvey installation via the internal database authentication system
**'''Surveys''': shows the total number of (active & inactive) surveys
**'''Active surveys''': shows the total number of active surveys (that can be accessed by other users via the web)
**'''Deactivated result tables''': at some point, you might want to change some questions during the survey runtime. If you do this, all the prior answers associated with the respective survey will be dissociated from the newly edited survey. The data that was previously collected will be stored in 'deactivated result tables'
**'''Active survey participants tables''': shows the number of active survey participants tables (that have a corresponding active survey)
**'''Deactivated survey participants tables''': shows the number of deactivated survey participants tables


{{Note|Check our [[Survey_participants#Introduction|wiki on survey participants tables]] for more information.}}


{{Note|For debug purposes, you can also find a button that shows your PHP information.}}

==General== 
*'''Site name''': is your survey site name. This name will appear in the survey list overview and in the administration header
*'''Default template''': This setting specifies the default design template used for the 'public list' of surveys and for new surveys or surveys using a non-existing template. If you would like to use a personalized template, read about how you can use the LimeSurvey's [https://manual.limesurvey.org/The_template_editor template editor]
{{Note|The templates are stored in '/limesurvey/templates/'.}}
*'''Create example question group and question''': This setting specifies if an example question group and question should be created automatically after creating a new survey.
*'''Administration template''': This setting specifies the default design template used for the LimeSurvey administration. To use a customized template, add it in '/limesurvey/upload/admintheme/'
*'''Time difference (in hours)''': If your web server is in a different time zone to the location where your surveys will be based, put the difference between your server and your home time zone here. For example, I live in Australia, but I got a US web server. The web server is 14 hours behind my local time zone. So, my setting here is "+14". In other words, it adds 14 hours to the time of the web server. This setting is particularly important when surveys timestamp the responses.


*'''Session lifetime (seconds)''' (''only available with database sessions''): Defines the time in seconds after which a survey session expires (provided there is no action from the participant). When using regular, file-based sessions, it is up to the system administrator to define the right values for 'session.gc_maxlifetime', 'session.save_path', etc., in the PHP configuration. Not only the web server settings but also the other similar settings of other applications may overwrite the setting for file-based sessions when editing it locally via the application. The maximum value that can be introduced is 65000 (seconds). It is recommendable to use a reasonable value. Bear in mind that, when using database sessions, check whether the MySQL setting called '''max_allowed_packet''' is set to a large value because some surveys generate over 2 MB of session data
*'''IP Info DB API Key''': Allows integration with the [https://ipinfodb.com IP-Info-DB service], which lets you determine the geographic location of survey takers based on their IP. To use a key, you need to [http://ipinfodb.com/register.php register] for the API


*'''Google Maps API Key''': Allows for integration with Google Maps
*'''Google Analytics Tracking ID''': Allows for integration with Google Analytics. Surveys can override this site-level value. The tracking ID can be inserted into templates using {GOOGLE_ANALYTICS_API_KEY}. The full JavaScript that Google Analytics expects to find (including the key) can be included in templates via {GOOGLE_ANALYTICS_JAVASCRIPT}
{{Note|For further details on how to use Google's API with LimeSurvey, check our [[Google API how-to]] page.}}
*'''Google Translate API Key''': The Auto-Translate feature uses version 2 of Google Translate's API. Google charges for this service. In order for the Auto-Translate feature to work, get an API key from [https://code.google.com/apis/console/?api=translate this site], and then enter the key in this field
*'''Character set for file import/export''': You can specify the character set most suiting you and your system, if you experience problems with the exporting/importing functions
*'''Show LimeSurvey branding in survey''': Enable or disable LimeSurvey branding on your Surveys.
:This setting is available in LimeSurvey Cloud only.


:By default LimeSurvey Cloud displays branding on your surveys. This includes a button at the bottom of the survey page with the text "Made in LimeSurvey" and also a message at the end of the survey with the text "Thank you for taking this survey powered by LimeSurvey".


:It is possible to remove branding from the Expert plan and above. If you have a Free or Basic plan you will first need to upgrade your plan to access this setting.


*'''Side-menu behavior'''{{ObsoleteIn|3.0}}: How the side-menu should behave while editing surveys. The default value is 'Adaptive', meaning that the side-menu can be changed when and how the users want. The other values are 'Always open' and 'Always closed'


* '''Clear assets cache:''' Reset the css and js assets url, be sure to have all new css and js file updated.


*'''Default HTML editor mode:''' Sets the default mode for integrated HTML editor. The valid settings are:
** ''inline'' (default): Inline replacement of fields by an HTML editor. Slow, but convenient and user-friendly
** ''popup'' : Adds an icon that opens a popup window with the HTML editor. Faster, but the HTML code is displayed on the form
** ''HTML source'' : No HTML editor used, just the plain HTML source


*'''Question type selector''': Choose 'Full selector' to get a question type selector with preview and 'Simple' to get a plain select box


*'''Template editor''': Choose 'Full template editor' to get an enhanced editor (with syntax-highlighting) when editing survey templates and 'Simple template editor' to get a plain editor field


*'''Default breadcrumb mode''': Choose between defaulting to short or long breadcrumb representation. Short is the common breadcrumb representation, and long variant provides additional information (survey id, group id, question id).


{{Alert|title=Attention|text=You will observe that some options can be found in your user's preferences, under [[First_login_-_your_user_preferences#Your_account_preferences#Your_personal_settings|Your personal settings tab]]. If you change the respective options from the global settings of your LimeSurvey installation, the 'default' option from the drop-down list of each option that is located under 'Your personal settings' tab will inherit the global settings values. For example, if you, as a user with [[Manage users#Set permissions for a single survey|Settings & Plugins permissions]], change the HTML editor mode to the 'popup' mode, all the other users who have chosen the 'default value' option from the HTML editor mode in their personal settings will also use the popup option.}}

==Email settings== 
*'''Default site admin email''': This is the default email address of the site administrator, and it is used for system messages and contact options
*'''Administrator name''': The real name of the site administrator
*'''Email method''': This determines how emails are being sent. The following options are available:
**''PHP'' (default value): Use internal [https://php.net/manual/function.mail.php PHP mail function]
**''Sendmail'': Use Sendmail mailer
**''SMTP'': based on SMTP relaying. Use this setting when you are running LimeSurvey on a host that is not your mail server
***Make sure that you are using your SMTP configured email (Global settings ⇒ Email settings) if you use SMTP; otherwise there might be a chance that the following error is displayed: 'SMTP -> ERROR: RCPT not accepted from server: 553 5.7.1 : Sender address rejected: not owned by user'
**''Qmail'': Set this if you are running the Qmail mailer
**''Plugin'': Using this you can select a custom email plugin to use.
</translate><translate>

*'''SMTP host''': If you use 'SMTP' as email method, then you have to put your SMTP server here. If you are using a different port than port 25 (standard for SMTP), then you have to add the port number separated be a colon (example: 'smtp.gmail.com:465')
*'''SMTP username''': If your SMTP-server needs authentication, set this to your username; otherwise it must be blank
*'''SMTP password''': If your SMTP-server needs authentication, set this to your password; otherwise it must be blank
*'''SMTP encryption''': Three options are available:
**''Off'' (default value)
**''SSL''
**''TLS''
</translate><translate>

{{Note|Check the [https://en.wikipedia.org/wiki/Transport_Layer_Security following link] for further details about SSL/TLS.}}
*'''SMTP debug mode''': It comes with three options:
**''Off'' (default value): The user wants this activated only in the case in which the SMTP relay does not work, and further details are needed to remedy the technical problem
**''On errors'': A detailed connection log and error message will be given if an error occurs
**''Always'': It provides valuable information on how an SMTP relay works. If an error occurs, further details are provided
{{Note|Debug part is shown when [[Survey_participants#Send_email_invitation|sending email to participant]].}}
</translate>
<translate>

* '''Email plugin''': If you choose 'Plugin' as sending method you can set here which plugin should be used. Currently there are two bundled email plugins in LimeSurvey. If the plugin cannot be found, check if it is activated.
**'''[[AzureOAuthSMTP_Plugin|AzureOAuthSMTP]]''': Use this to send emails using Azure/Microsoft and OAuth over SMTP
**'''GoogleOAuthSMTP''': Use this to send emails using google and OAuth over SMTP
</translate><translate>

*'''Email batch size''': When sending invitations or reminders to survey participants, this setting helps the administrator determine how many emails can be sent in one bunch. Different web servers have different email capacities, and if your script takes too long to send many emails, the script could time out and cause errors. Most web servers can send 100 emails in one go within the default 30 second time limit for a PHP script. If you get script timeout errors when sending large numbers of emails, reduce the email batch size using this setting. Clicking the 'send email invitation' button that is located on the survey participant toolbar sends one batch of invitations, displaying a list of the addresses to which the email was already delivered and a warning that ''"There are more emails pending than could be sent in one batch. Continue sending emails by clicking below. There are ### emails still to be sent."'' and provides a "Continue" button to proceed with the next batch. So, the user determines when to send the next batch after each batch gets emailed. It is not necessary to wait with this screen active. The admin could log off and come back at a later time to send the next batch of invitations.
</translate>
<translate>

* '''Email sending rate''': This setting determines the number of seconds until the next batch is automatically sent in the interface.

==Bounce settings== 
*'''Default site bounce email''': This is the email address where bounced emails will be sent to. For faster bounce back processing, the email address box should be limited to bounce back only
*'''Server type''': If set to 'Off', no bounce processing functions will be available. To activate the bounce processing function at a global level, set this to 'POP' or 'IMAP' – think of whether you wish the bounced emails to be kept on your email server (IMAP) or not (POP) after reading them. For further details on its usage, check the following [[Email_bounce_tracking_system|wiki section]]
</translate><translate>

*'''Server name & port''': Name of the server and (if needed) the port separated by a colon. The port number isn't typically needed unless the email host uses a non-standard port
*'''User name''': The user name for the POP/IMAP account
*'''Password''': The password for the POP/IMAP account
*'''Encryption type''': If encryption is used, please set the right type here (SSL or TLS)

==Security== 
*'''Survey preview only for administration users''': By default, the preview of inactive surveys is restricted only to authenticated. If you set this to 'No', any person can test your survey using the survey URL – without logging in to the administration and without having to activate the survey first
*'''Filter HTML for XSS''': It is turned 'on' by default. They will not be authorized to use dangerous HTML tags in their survey/group/question/labels texts (JavaScript code, for instance). The idea behind this is to prevent a survey operator to add a malicious script to get his permissions raised on your system. '''However, if you want to use any JavaScript in your surveys, you will need to switch this off''' (specific scripts for video hosting platforms can be used).
{{Hint|Text=The super admins never have their HTML filtered when saved or on public survey view. To see the effects of XSS filtering, it is advised to use a regular user account.}}
{{Alert|title=Warning|text=With XSS enabled, some parts of the expression manager system cannot be used: see [[ExpressionScript_-_Presentation#XSS security|XSS and ExpressionScript]].}}
</translate><translate>


*'''Disable question script for XSS restricted user''' {{NewIn|4.1.0}}: Set to 'on' by default, this mean simple user cannot add or update scripts in question editor. they can see it but don't update it. If you disable XSS protection, then this setting is not used. If you set it to 'off', then even with XSS filtering active, any user can add or update the script in question.
*'''Group member can only see own group''': By default, non-admin users defined in the LimeSurvey management interface will only be able to see other users if they belong to at least one common group. If the administrator sets this to 'No', then the users can see all the users defined in the LimeSurvey [[Manage users|User Control panel]], regardless of the group they belong to
*'''IFrame embedding allowed''': This option can be used to indicate whether a browser should be allowed to render the survey page in a <frame>, <iframe> or <object>. You can use this to avoid clickjacking attacks, by ensuring that your survey is not embedded into other sites. If you set it to 'Allow' (the default value), there is no restriction. Setting this to 'Same origin' will make the content to be loaded only if the survey runs on the same domain and port as the including <frame>, <iframe> or <object>
{{Alert|title=Attention|text=You need to update config.php file to really allow cookies to be used in iframe. See [[Optional_settings#Allow_usage_of_session_and_Csrf_Validation_in_iFrame_.28New_in_3.24.3_.29|Allow usage of session and CSRF Validation in iFrame]]}}
{{Hint|Text=When set to Same Origin : LimeSurvey add header<code>X-Frame-Options: SAMEORIGIN</code>, else LimeSurvey don't add any X-Frame-Options. You can restrict yourself X-Frame-Options with server settings. [https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options More information on X-Frame-Options] }}
{{Hint|Text=Theoretically, it is working. However, this function might not work when it is enabled because it heavily depends on the used web browser and whether it allows iframes or not. Some server configuration restrict iframe embedded by default. }}
*'''Force HTTPS''': This is set by default to "Don't force on/off". Switch the setting to "On" to force the connection to use HTTPS
{{Alert|title=Attention|text=If your server doesn't support HTTPS properly, you can lock yourself from the system! Therefore, click on the '''"check if this link works"''' located below the option. If the link does not work and you turn on HTTPS, LimeSurvey will break and you won't be able to access it.}}
{{Hint|Text=If you activate HTTPS mistakenly, you can deactivate it in application/config/config.php file, changing the value of ssl_emergency_override to 1.}}
*'''IP whitelist for login or token access''': This option can be used to exclude specific IPs from "max login attempts" checks done on the login screen as well as on the token access screen, so requests from those IPs are not blocked.

==Presentation== 
*'''Show question number and/or question code''': What to be shown to the survey participants – the question number and/or the question code, both or none. There is also a fifth option in which this option can be selected by the survey admin. The question code is shown next to each question from the survey
*'''Repeating headings in array questions every X subquestions''': If you use array type questions, you'll often have a lot of subquestions, which - when displayed on screen - take up more than one page. The repeat-headers setting lets you decide how many answers should be displayed before repeating the header information for the question. A good setting for this is around 25. If you don't want the headings to repeat at all, set this to 0
</translate><translate>

*'''Show "There are X questions in this survey"''': It shows the number of questions the survey contains to the user participants. The number of the questions right from the start of the survey.
*'''Font size of PDFs''': 9 is the default size for normal text. The group title font size is the value introduced in this box plus two, while the font size of the survey's title is the value introduced in this box plus four. In the default case scenario, the PDF uses a font size of 9 for normal text, of 11 for group titles, and of 13 for the title of the survey
*'''Width of PDF header logo''': the 'dimension' of the PDF header logo. ''The logo appears only on the PDF file that includes the answers of the survey participants to a survey – a survey participant may wish to export his answers after completing the survey.''
*'''PDF header title''': If it is left empty, the site name will be used. ''The PDF header title appears only on the PDF file that is the result of the survey participant's wish to export his answers after completing a survey.''
*'''PDF header string''': If empty, the survey name will be used. ''The PDF header string appears only on the PDF file that is the result of the survey participant's wish to export his answers after completing a survey.''
</translate><translate>

*'''Show question group title and/or description''': It works in the same manner as the '''Show question number and/or question code''' function.
*'''Show 'no answer' option for non-mandatory questions''': When a radio button/select type question that contains editable answers (i.e.: List & array questions) is not mandatory and the "show 'no answer'" is also enabled (default), an additional entry "No answer" is shown for each subquestion - so that survey respondents may choose not to answer the question. You can select from the global settings one of the following options:
**''Selectable'' : If the LimeSurvey administrator selects it, a survey administrator can choose whether his/her own survey displays the "no answer" option for non-mandatory questions or not (see the [[Presentation]] wiki section for more details)
**''On'' (default value): If this option is chosen, all non-mandatory questions will contain the "no answer" option - this cannot be changed by the survey administrator because the global settings trump [[Survey settings|survey settings]]
**''Off'' : If off, the non-mandatory questions will not display any "no answer" option - this cannot be changed by the survey administrator because the global settings trump the [[Survey settings|survey settings]]
</translate><translate>

*'''Show header in answers export PDFs''': Turn it off (default) if you would like to see nothing in the header of the PDF that contains the answers of the respondents. If it is turned on, the following information will be displayed in the header of the PDF that contains the respondents' answers
*'''Add gray background to questions in PDF''': It is turned 'On' by default. ''This function refers to export-responses PDFs.''
*'''PDF questions in bold''': It is turned 'Off' by default. ''This functions refer to export-responses PDFs.
*'''Borders around questions in PDF''': It is turned "On" by default. ''This function refers to export-responses PDFs.''
*'''Borders around responses in PDF''': It is turned "On" by default. ''This function refers to export-responses PDFs.'

==Data Policy== 
*'''Show data policy on the surveylist page::''' Whether to display the "data policy" button on the survey list. On click this will display a button that shows a popup box(modal) with the "data policy" message.
*'''Show legal notice on the surveylist page:''' Whether to display the "legal notice" button on the survey list. On click this will display a button that shows a popup box(modal) with the "legal notice".
*'''Data policy:''' Fill in the text box to add all the information related to your legal notice (e.g., rights, duties obligations).
*'''Legal notice:''' Fill in the text box to add all the information related to your survey data policy (e.g., where the data is stored, for how long, and so on).


<div class="simplebox">[[File:help.png]] All the options from above influence '''only''' the parameters of the PDF which contain the answers/responses to a survey/questionnaire. Therefore, the options mentioned above influence only the PDF result of the 'answers export PDF' function. </div>
<div class="simplebox">[[File:help.png]] LimeSurvey also allows questionnaires to be printed and to be completed offline, but the export questionnaire PDF function is an experimental option and the output is far from being perfect. Its parameters can be modified either from the 'Style' from the [https://manual.limesurvey.org/Exporting_a_survey_structure/en queXML PDF export page] or from the [https://manual.limesurvey.org/Optional_settings#Statistics_and_response_browsing config.php file].</div>

==Language== 
*'''Default site language''': The default language that is used in your administration panel can be selected via this option. It also gives the default language for the public survey list if none is given
*'''Available languages''': If you don't want all languages to be available in the 'default site language' box, just remove them from the left box. This restricts the available language in survey by administrator.

==Interfaces== 
*'''RPC interface enabled''': Using this feature you can activate/deactivate the LimeSurvey [[RemoteControl 2 API|RemoteControl2]] interface API, either using JSON-RPC (recommended) or XML-RPC


*'''URL''': http://<your_domain>/<your_limesurvey_dir>/index.php/admin/remotecontrol


*'''Publish API on /admin/remotecontrol''': If you activate this option, then under the specified URL a brief description of the API functions will be available. Usually, you should not need to activate it and should only be activated for debug purposes in general.


<div class='simplebox'>[[File:help.png]] '''Note:''' Please note that the remote control functionality is generally used by developers to access LimeSurvey from other applications (in this way, you are not restricted only to PHP). It is only recommended for advanced users. For more details on its usage, check the following [[RemoteControl 2 API|wiki section]] or join the [https://www.limesurvey.org/community/forums LimeSurvey forums].</div>

==Storage== 
The '''Storage''' settings in LimeSurvey's Global Settings allow administrators to manage file storage and database export limits.

* '''Calculate storage''' – This button recalculates the total storage used by all uploaded files in LimeSurvey. Depending on the number of files, this process may take some time.
* '''Overwrite files with the same name''' – When enabled, files with the same name will be overwritten if uploaded, moved, or copied through the file manager. By default, this setting is disabled to prevent accidental data loss.
* '''Set limit in megabytes for direct download of the database''' – This option sets the maximum file size (in MB) for direct database downloads. The recommended value is '''256 MB''', but a lower limit can be set if needed. A higher value may lead to performance issues, depending on the system configuration.

These settings help manage file storage, prevent unnecessary duplicates, and optimize database downloads in LimeSurvey.

</translate>

First login - your user preferences

2025-04-08T11:38:28Z

Tibor.pacalat: added breadcrumb mode description

<languages />
<translate>
==First Login== 

===With LimeSurvey Cloud=== 


After creating your LimeSurvey account, you will receive an email. This email contains the account activation link. Click the link to access your newly created account. Clicking the link takes you to your account on the LimeSurvey website.


You need to create a survey site before you can start creating and managing online surveys. Log in to your account and click Create survey site.


'''Create survey site''' link:


<center>[[File:NewSurveySiteSetupPage.png]]</center>


To create your LimeSurvey site:


(1) Enter your site name.


(2) Choose a domain name from the dropdown menu.


(3) Choose a server location.


(4) Click Save & Set Up LimeSurvey Site.


The process can take up to 20 seconds. When the process is complete, the window will close and you will be taken back to your account page.


You can now access your survey site by clicking View Survey Site at the top of the page.


<center>[[File:AccountHomePage.png]]</center>


Account login page:


Sign in to your account using your LimeSurvey.org credentials:


<center>[[File:LoginPage.png|0.75px]]</center>


You are ready to start creating surveys.

==Change your password== 
To change your password, use the ''Forgot your password?'' button located on the LimeSurvey administration login page.


<center>[[File:Forgotpassword.png]]</center>


After completing the required fields, click the ''Check data'' button. You will receive an email with the necessary steps that need to be followed in order to reset your password.


Another option to change your password is to do so from within your profile. Click your user name located in the upper right part of the screen (on the main LimeSurvey toolbar) and select the ''Your Profile'' tab.


Click the '''Change password''' buttonː


<center>[[File:Profilechangepassword.png]]</center>


Type the current password, and the new password twice. Then, save the new profile settings by clicking '''Save''' located in the upper right part of the screen.


<center>[[File:Forgotpassword_3.png]]</center>


<hr width="50%" style="margin:auto">


If you have superadmin permissions and one want to assist another user reset their password, you can do so by by using the ''User control panel''.


<center>[[File:LimeSurveyMenuUserManagement.png]]</center>


From the ''Action'' column click the green pen that corresponds to the respective user and change their password.


<center>[[File:LimeSurveyBleistiftSymbol.jpg]]</center>


<div class='simplebox'>[[File:help.png]] Check the wiki on [[Manage_users#User_management|the LimeSurvey user management functions]] for more information.</div>

===With LimeSurvey Cloud=== 


If you use [https://www.limesurvey.org/editions-and-prices/limesurvey-pro/editions-and-prices-professional LimeSurvey Pro], you can also reset your password from your [https://www.limesurvey.org/your-account/your-limesurvey-profile LimeSurvey profile]. From your LimeSurvey profile, click ''INSTALLATIONS'' (under the Profile Menu). Look for the ''RESET PASSWORD NOW'' button located in an orange box. Click it and a random password will be generated immediately.


{{Alert|It may take a few minutes for the changes to take effect - ca. 2 minutes.}}

=Your account preferences= 


To change your user preferences, click your username which is shown on the LimeSurvey main toolbar and then click '''Your account'''.


<center>[[File:userprofile.png]]</center>


Your account preferences toolbar contains four tabs:
*'''[[First_login_-_your_user_preferences#My profile|My profile]]''': General details about your account;
*'''[[First_login_-_your_user_preferences#My personal settings|My personal settings]]''': The user can choose the interface language and/or select other LimeSurvey-related editing modes;
*'''[[First_login_-_your_user_preferences#My personal menus|My personal menus]]'''{{NewIn|3.0}}: A list with the survey menus created by the respective user;
*'''[[First_login_-_your_user_preferences#My personal menu entries|My personal menu entries]]'''{{NewIn|3.0}}: A list with those menu entries that were created by the user.


<center>[[File:Toolbaruserpreferences.png]]</center>

==My profile== 
The following options are found under the ''My profile'' tab:
*'''Username''': Once created, it cannot be changed from the LimeSurvey interface. We recommend creating another user name instead of editing the configuration of your LimeSurvey installation;
*'''Email''': Type your new e-mail and click the 'Save' button to save the settings;
*'''Full name''': The name of the administrator;
*'''Password''' & '''Repeat password''': If you want to change your password, type the new password twice and click the 'Save' button.

==My personal settings== 
*'''Interface language''': The language of the Limesurvey administrative interface;
*'''HTML editor mode''': The inclusion of an integrated HTML editor;
*'''Question type selector''': If 'Full selector' option is chosen, then a question preview will be shown when selecting the type of a new question to be added into the survey;
*'''Template editor mode''': If 'full template editor' is selected, syntax highlighting will be used in the [[The template editor|LimeSurvey template editor]];
*'''Date format''': chooses the default date format used in the administration interface.
*'''Show script field''': The script field is specially intended for entering JavaScript while editing questions. This setting controls if it should be shown or not.
*'''Directly show edit mode''': Indicates if edit mode should be shown by default when entering a question.
*'''Non-Numerical answer option prefix''': Prefix to be used for answer options. It should be non numerical. If the prefix is "AO", answer options would be, for example, "AO001".
*'''Non-Numerical subquestions prefix''': Prefix to be used for for subquestions. It should be non numerical. If the prefix is "SQ", answer options would be, for example, "SQ001".
*'''Lock question organizer in sidebar by default''': If the question organizer should be shown or hide in the side bar.
*'''Create example question group and question''': This setting specifies if an example question group and question should be created automatically after creating a new survey.
*'''Breadcrumb mode''': User can choose between short and long breadcrumb representation. Default is set to short, and long variant provides additional information (survey id, group id, question id).

===Interface language=== 


You can select the administrative language preference during log in by using the dropdown list as shown below. After a successful login, the LimeSurvey interface will change to the chosen language. The system will record this preference setting in your profile and make it the default for your next login.


<center>[[File:login language.png]]</center>


Some LimeSurvey setups hide or skip the login page to enable common authentication inside other applications. In this case, you won't have access to select the language. However, you can change your language preference from your account preferences. Access your account preferences by clicking your user name located in the upper right side of your browser and then the ''Your account'' button. Next, click the '''Your personal settings''' tab and select your desired language from the dropdown list located under '''Interface language'''.


<center>[[File:Selection 007.png]]</center>

===HTML editor mode=== 


There is an '''HTML editor''' integrated into LimeSurvey. This tool will help you develop rich formatting for your surveys, groups, questions, and answer text; for tables, and images. But as this editor takes extra space on the screen and resources on the computer, it is not always desirable to use. Therefore, four options are provided by LimeSurvey: '''default''', '''inline HTML editor''' (selected by default), '''popup HTML editor''', and '''no HTML editor'''.

====Default==== 


If the "default" option is selected, you will inherit the HTML editor mode selected by the superadminstrator from the [[Global settings#General|global settings]] of the LimeSurvey installation.

====Inline==== 
In this case, the '''HTML editor''' is always used in-line on the page. It also represents the 'default' value.


<center>[[File:InlineMode1.PNG]]</center>

====Popup==== 
The normal text editor is used, but the '''HTML editor''' is available as a pop-up option. You can always get to the '''HTML editor''' by clicking on the icon on the right of the normal text editor window as shown for the '''popup''' option below


<center>[[File:Popup1.PNG]]</center>

=====Fullscreen{{ObsoleteIn|3.0}}===== 


This option is available only for inline editor. It allows you to increase the size of the editor to fill the browser window and then decrease it back later.{{ObsoleteIn|3.0}}


<center>[[File:InlineMode2.PNG]]</center>


When switching between which editor you use, the last used editor before logout is recorded in your profile and will become the default at your next login.


Please note that when editing answers and labels, the normal text editor (or 'Popup' mode) is always used because of the larger number of windows.


{{Note|You can change the size of the HTML editor box by clicking on the bottom right corner of the editor.}}


<center>[[File:ExtendsizeHTML.png]]</center>

====Source code mode==== 


If you want to paste HTML or Javascript code directly, you must switch to the '''source code''' mode. This option is not available in your personal settings. However, it can be selected from the HTML editor menu.


<center>[[File:source_code_mode.png]]</center>


You must [[Global settings#Security|disable the ''Filter HTML for XSS'' setting]] in order to store code entered in the source code mode (or to have superadmin permissions).


<center>[[File:SourceCodeMode.png]]</center>

====No HTML editor==== 
If you do not want to use an HTML editor, select this option. You will be able to use only simple text in the surveys.


<div class="simplebox">'''Hint''': Why not always choose the '''HTML Editor'''? Depending on your use of LimeSurvey, there may be many text boxes on a single page, each with a copy of the editor. For instance, when editing the email text for a survey invitation that is offered in 5 languages, you can then have a total of 20 inline '''HTML editors''' active on the page. Each instance takes a fair amount of resources and will likely cause issues on your browser. So, if you work with multiple language surveys, we recommend you stick with the normal text editor or 'Popup' setting.</div>

===Question type selector=== 


Choose 'Full selector' to get a question type selector with preview and 'Simple selector' to get a plain select box. The 'default' option corresponds to the option selected in the [[Global settings|global settings]] of the LimeSurvey installation.

===Template editor mode=== 


Three options are available: 'default', 'full template editor', and 'simple template editor'. Choose 'Full template editor' to get an enhanced editor (with syntax-highlighting) when editing survey templates and 'Simple template editor' to get a plain editor field. The 'default' option corresponds to the option selected in the [[Global settings|global settings]] of the LimeSurvey installation.


{{Note|For a more comprehensive presentation of our template editor, check the [[The template editor|following wiki]].}}

===Date format=== 


This setting sets the date format for your profile (e.g. when you browse the survey results or for other settings located in the administration panel). It does '''not''' affect the actual surveys.


When creating a date/time question, you can set the date/time format when you edit/add a question. After you have chosen the '''date/time''' question format, type in the desired format you would like to use in the boxes located under the Input and Display tabs. For extra information, hover the mouse over the heading of each box.


<center>[[File:DateTimeFormatSurvey.png]]</center>

==My personal menus== 


You can visualise here the customized menus that are available to you or the ones you created via the [[Menu configuration|menu configuration option]].


To start editing them, access the '''Menu configuration''' option located within the '''Configuration''' menu.

==My personal menu entries== 


You can visualise here the customized menus entries that are available to you or the ones you created via the [[Menu entries configuration|menu entries configuration option]].


To edit them, you need to access the '''Menu entries configuration''' option located within the '''Configuration''' menu.

</translate>

Manage users

2024-09-13T16:46:00Z

Tibor.pacalat: updated instructions for create user form

<languages />
<translate>

__TOC__

= User management= 


The user management tool allows you to add additional administration users to LimeSurvey. We refer to them as 'users'. Do not confuse them with [[Survey participants|survey participants]] (respondents).

==Create users== 


To create a new user, open the user management dialog by clicking on '''Configuration''' (located on the main LimeSurvey toolbar) -> '''User management'''.


<center>[[File:LimeSurveyMenuUserManagement.png]]</center>


Then, click '''Add user''' located in the upper right area of '''User control''' table. A window will be displayed asking you to:


* Enter the desired username into the '''Username''' field.
* Enter the email address into the '''Email''' field. Please note that:
** LimeSurvey sends out a confirmation email to the address entered into the '''Email''' field. This email address will be used as the standard contact email address for surveys created by the respective user.
** If you do not want the user to receive the confirmation email with a link to the LimeSurvey application, username, and password, you can use your own email address to send the confirmation email to you. After that, you can change the email address to the address of the user.
* Enter user's full name into the '''Full name''' field. Please note that the full name entered here will be used as the standard contact person name for surveys created by the respective user.
* You can optionally use '''Expiry date/time''' if you want to set expiry date for newly created user. After that date/time the user will not be able to log in any more.
* You can also optionally set user's starting password, but please advise them to change it after their initial log in.
* Click '''Save''' to create the new user.


Note that password complexity is enforced and validated by the PasswordRequirement plugin.


<center>[[File:Add_user_6x.png|500px]]</center>


You have now created your first user. To find out more about [[Manage users#Set global permissions for a user|setting user permissions]], please read on.


<center>[[File:LimeSurveyBleistiftSymbol.jpg]]</center>


Below you can see four options under the '''Action''' column that allow you to:


<center>[[File:Edit users.png]]</center>


*edit the general aspects of a user - by clicking the pen symbol.
*delete the user from the survey administrators database - by clicking the trash button.
*set global permissions for a user - by clicking the lock symbol.
*set theme permissions for a user - by clicking the pen-and-lock symbol.

==Edit user== 


Click the pen icon to edit user information.


You can enter a new email address, name, and change their password. Click '''Save''' to confirm changes.

==Delete user== 


To delete a user account, click the corresponding trash icon (located on the same line as the user account you want to delete) and click '''OK'''.

==Set global permissions for a user== 


{{Alert|Global permissions apply to the whole LimeSurvey application. If you want to set permissions only for a specific survey, you can use the [[Manage users#Setting permissions for a single survey|survey permissions settings]].}}


To set global permissions for a user, click the lock symbol.


<center>[[File:User_global_permission.png]]</center>


The CRUD (create, read, update, and delete) system is employed (as it is in the [[Manage users#Setting permissions for a single survey|survey permission settings]]). For more user permission options, we recommend extending the matrix using the double-right arrowhead, which is located in its upper right corner. If you check the first box, all the CRUD permissions in that row are automatically checked.


<center>[[File:User_global_permission_complete.png]]</center>


You can now add or remove the following permissions:


* '''Participant panel''': For more details, continue reading about the [[Central Participant Database|central participant database here]].


* '''Label sets''': Permission to create, view, update, delete, export, and import label sets. The label sets do not have specific permissions (unlike themes).


* '''Settings & Plugins''': With this permission a user can check data integrity, save the SQL database to an .sql file, manage global settings, view the PHP info in the global settings, and manage all plugins.


* '''Survey groups'''{{NewIn|v=4.4.0}}: Give access to all surveys' group. To allow user to manage their own surveys' group, give the user the 'create' permission. A creator of a surveys' group are (by default) the owner of this surveys' group.
{{Note|Permission on a surveys group does not give all permissions on surveys, but a user can give permissions on all surveys in surveys' group}}


* '''Surveys''': Gives access to all surveys. To allow a user to only create and manage their own survey, give the user the 'create' permission. A creator of a survey is the owner of the survey and will always be able to manage it. Remember that each survey can grant different permissions .
{{Note|'''The global permission is applied before the survey-specific permission!'''}}


* '''Themes''': Allows the user to use all the available design themes and edit all non-standard themes. A person with this permission should have sufficient knowledge in terms of HTML, Javascript, and CSS. If a user is not familiar with these things and is supposed to use a specific design themes, it would be better to only give them 'read' permission. Each theme can have specific permissions.


* '''User groups''': Allows a user to create/view/update/delete user groups.


* '''Users''': A user can create, modify, and delete their own administration users with this permission. The newly created users cannot have higher permissions than the parent user. You will also not be able to edit users owned by other administration users. If this has to be done, then a Superadministrator permission must be granted.


* '''Superadministrator''': Can only be added by other Superadministrator with this setting as update and grants full permission to the whole LimeSurvey application, including installing plugins and using any kind of content (including JavaScript) in survey content. (see also [[Global_settings#Security|global security settings]])


*'''Use internal database authentication''': Allows users to access LimeSurvey's panel via the authentication page (e.g. ''http://domain/admin/authentication/sa/login''). If it is unchecked and the respective user tries to connect to LimeSuvey's panel, they will get the following error: 'Internal database authentication method is not allowed for this user'.


{{Note|All the permissions mentioned above that belong to the [[Optional_settings#Security|forced super administrator]] cannot be removed via the GUI.}}

==Import and export users== 


You can import and export users in CSV and JSON format by using these buttons on User Management page.
<center>[[File:ImportExportButtons.png]]</center>


When you are importing users, a modal opens that shows you which fields should be present. You can choose to overwrite existing users by selecting this checkbox.
<center>[[File:ImportUsersModal.png]]</center>


Example of the JSON structure:


<syntaxhighlight lang="json">
[
{
"uid": 1,
"users_name": "admin2",
"full_name": "Administrator",
"email": "your-email@example.net",
"lang": "en",
"password": ""
},
{
"uid": 2,
"users_name": "ben2",
"full_name": "Ben Alister",
"email": "ben@test.ing",
"lang": "auto",
"password": "test!123"
}
]
</syntaxhighlight>


Example of the CSV structure:


<syntaxhighlight>
uid;users_name;full_name;email;lang;password
1;admin;Administrator;your-email@example.net;en;
2;ben;"Ben Alister";ben@test.ing;auto;test!123
</syntaxhighlight>

==Set theme permissions for a user== 


With theme permissions, you can decide which design themes a user can select when creating or editing a survey.


If you have specific design themes for a group of users or customers, you can restrict their access to other themes to ensure that they use only themes created for them.


To set or edit the themes permissions for a user, click the pen-and-lock symbol for design themes.


<center>[[File:LimeSurveySetDesignTemplatesLS.jpg]]</center>


Select the design themes to which the respective user or user groups should have access. After you finished your selection or deselection, do not forget to click '''Save''': [[File:Save.png|0.75px]].


To better understand this function, view [[Manage users#Examples|the examples provided below]].

==Activate and deactivate users== 


{{FeatureStarting|6.4.0}}
It's possible to mark a user as activated or deactivated.


A deactivated user is not able to log in to the admin interface.

=Use one-time passwords= 


A user can call the LimeSurvey login at /limesurvey/admin and enter a username and a one-time password (which was previously written into the users table - ''column one_time_pw'' - by an external application).


To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>'use_one_time_passwords' => true;</code>]] has to be added to config.php (it is 'false' by default) .


The URL has to contain the following variables:
* '''user:''' The username normally used to login into LimeSurvey. This username has to exist in the 'users' table of the database.
* '''onepass:''' The plain text password which is then compared to the password in the 'users' table


A valid URL to login using a one-time password will look like this:


<div class="simplebox">http://www.yourdomain.org/limesurvey/index.php/admin/authentication/login?user=myusername&onepass=secretpassword</div>


<div class='simplebox'> [[File:help.png]] The 'secretpassword' field is plain text, not a SHA 256 hash.</div>


'''Things to watch out for:'''
* To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>'use_one_time_passwords' => true</code>]] has to be added in config.php (it is 'false' by default).
* The passed username has to exist in the LimeSurvey ''users table''.
* The one-time password (which can be set via an external application) has to be stored as [https://secure.php.net/manual/en/function.md5.php MD5 hash] in the column ''one_time_pw'' of table ''users''.
* The passed plain text password will be hashed using the sha256 function and will then compared to the stored hash in column ''one_time_pw'' of table ''users''. Both passwords have to match.
* After the first login with the one-time password, it gets deleted from the database. The user won't be able to log in with that respective password a second time.

=Set permissions for a single survey= 


These permissions only apply for a single survey. If you want to set permissions for the whole system, you can use [[Manage users#Set global permissions for a user|global permissions]].
These permissions can be offered either to a single user or to a user group.


{{Alert|title=Attention|text=An existing user account is required to set permissions for a single survey. If the account doesn't exist, you have to create it first and then change the survey permissions. The same applies to offering survey permissions to a user group. Besides the necessity to have one created, you also need to add at least one user to that group in order to be able to select it and grant it survey permissions.}}


{{Note| By default, an user (non-admin) cannot grant survey permissions to users that are not part of the same group as the survey administrator. This is a security option enabled by '''default''' in LimeSurvey. To change this, you need to deactivate option [[Global_settings#Security|Group member can only see own group]], located in the '''Global settings''', under the '''Security tab'''. However, if you feel unsure about disabling this option, you can create groups containing those users that can be seen and be granted survey permissions by a survey creator.}}


To change the survey permissions, click the '''Settings''' tab. Then, click '''Survey permissions''' and choose to whom would you like to offer permissions. The permissions can be offered either separately to specific users or to a user group.


<center>[[File:LimeSurveySurveyPermissions.jpg]]</center>


<center>[[File:LimeSurveySurveyPermissionsRights.png]]</center>

==Grant survey permissions to a user== 


In the next step, select the user that will receive survey permissions and click '''Add user'''.


<center>[[File:LimeSurveyAddSurveyPermission.jpg]]</center>


After you click '''Set survey permissions''', the user's survey permissions matrix will be shown.


<center>[[File:LimeSurveyUserPermissionMatrix.jpg]]</center>


You can set in this matrix the user's survey permissions. Checking a box grants survey permissions to the respective user. If you click a checkbox from the first column, all the permissions of the corresponding line will be selected/removed.


Click the double-right arrowhead to access the extended version of the matrix to choose specifically the actions that can be performed by a user.
After you finished editing the survey permissions, click '''Save''', which is located in the upper right corner of the screen.


Some examples are provided [[Manage_users#Examples|below]] in order to help you get a better understanding of Limesurvey's survey permissions system.

==Grant survey permissions to a user group== 


Click '''add a user group''' and select the user group to which you would like to add the permission permissions.


<center>[[File:LimeSurveyPermissionpermissionsUserGroup.png]]</center>


In the next step, select the permissions that you will allocate to the members of that user group. Do not forget to click the double right arrowhead to get an extended view of the permissions matrix.


<center>[[File:UserGroupSurveyPermissions.png]]</center>


After you have finished editing the survey permissions, click '''Save''', which is located in the upper right part of the screen.


Some examples are provided [[Manage_users#Examples|below]] to help you get a better understanding of the Limesurvey's survey permissions system.


{{Note|[[Manage user groups|The user group function]] is still experimental. Use our [https://bugs.limesurvey.org/ bugs tracker] to describe any kind of inconsistencies.}}

=Examples= 


Different scenarios are presented below. They provide some advice about which permissions are necessary for some specific tasks and how they can be granted to the users.

==Add new LimeSurvey administrator== 
* Log in as '''admin'''.
* Create a new user account.
* Grant that user the '''Superadministrator''' permission.
* ''Not necessary'' : Setting the theme permissions ('''Superadministrator''' has all permissions for all themes).
* ''Not necessary'' : Setting the survey permissions ('''Superadministrator''' has all permissions for all surveys).

==A new user wants to create their own surveys== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set global permissions for that user to '''Create survey'''.
* ''Optional'' : Set theme permissions - select which theme(s) should be used by the user/user group.

==The creator of a survey needs to give another person permission to edit their survey== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set '''no global permissions''' for user.
* Set '''no theme permissions''' for user.
* Set the survey permissions the way you want. If he/she should receive all the survey permissions, you can check the first box from each row. Otherwise, click on the double-right arrowhead to see the expanded matrix (upper right corner) and select only those permissions you believe the respective user should have.

==A person responsible for the survey wants to view and export survey results== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set '''no global permissions''' for user.
* Set '''no theme permissions''' for user.
* Set survey permissions to: '''Responses''' -> '''View/read''' and '''export''', and '''Statistics''': '''View/read'''.


<center>[[File:LimeSurveyCusomerOwnStatistics.jpg]]</center>

==Granting permission for help with translation of a survey== 
* Log in as ''admin'' (or as a user that has the ''Superadministrator'' permission).
* Create ''n'' user accounts (where n is the number of translators).
* Create a user group called ''Translators'' and add the ''n'' accounts to this group.
* Go to the '''Survey permissions''' and click on '''Add a user group'''.
* If they only do translations, then offer them the '''Quick translation''' permission.


{{Note|Check our [[LimeSurvey Users|wiki section on users]] and their classification as it can be found in the code and documentation.}}
</translate>

File:Add user 6x.png

2024-09-13T16:36:53Z

Tibor.pacalat: modal with the form to add a new user

== Summary ==
modal with the form to add a new user

LimeSurvey Manual

2024-05-22T14:21:31Z

Tibor.pacalat:

<languages />

<div align="center" style= "margin-top:1em;background-color:#eeffee;-webkit-box-shadow: 0 10px 6px -6px #777;-moz-box-shadow: 0 10px 6px -6px #777;box-shadow: 0 10px 6px -6px #777;">
<span style='font-size:188%'>'''<translate> Help us to update this manual!</translate>'''</span><br>
<span style=''><translate> This manual is a Wiki - just log in with your LimeSurvey.org account and start editing!</translate></span>
</div>
<translate>
=General= 
</translate>


<div style="clear:right;float:right;"><div class="simplebox">
<translate>

Main chapters:
</translate>
#[[LimeSurvey PRO vs LimeSurvey CE/{{PAGELANGUAGE}}|<translate> LimeSurvey Cloud vs LimeSurvey CE</translate>]]
#[[Quick start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}|<translate> LimeSurvey Cloud - Quick start guide</translate>]]
#[[Installation - LimeSurvey CE/{{PAGELANGUAGE}}|<translate> LimeSurvey CE - Installation</translate>]]
#[[How to design a good survey (guide)/{{PAGELANGUAGE}}|<translate> How to design a good survey (Guide)</translate>]]
#[[Getting started/{{PAGELANGUAGE}}|<translate> Getting started</translate>]]
#[[Administering LimeSurvey/{{PAGELANGUAGE}}|<translate> LimeSurvey configuration</translate>]]
#[[Surveys - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Surveys</translate>]]
#[[Survey settings/{{PAGELANGUAGE}}|<translate> View survey settings</translate>]]
#[[Survey menu/{{PAGELANGUAGE}}|<translate> View survey menu</translate>]]
#[[Survey structure/{{PAGELANGUAGE}}|<translate> View survey structure</translate>]]
#[[Questions - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Questions</translate>]]
#[[Question groups - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Question Groups</translate>]]
#[[Surveys - management/{{PAGELANGUAGE}}|<translate> Introduction - Surveys - Management</translate>]]
#[[Survey toolbar options/{{PAGELANGUAGE}}|<translate> Survey toolbar options</translate>]]
#[[Multilingual survey/{{PAGELANGUAGE}}|<translate> Multilingual survey</translate>]]
#[[ExpressionScript Engine - Quick start guide/{{PAGELANGUAGE}}|<translate> Quick start guide - ExpressionScript</translate>]]
#[[Not categorized and advanced features/{{PAGELANGUAGE}}|<translate> Advanced features</translate>]]
#[[General FAQ/{{PAGELANGUAGE}}|<translate> General FAQ</translate>]]
#[[Troubleshooting/{{PAGELANGUAGE}}|<translate> Troubleshooting</translate>]]
#[[Workarounds/{{PAGELANGUAGE}}|<translate> Workarounds</translate>]]
#[[License/{{PAGELANGUAGE}}|<translate> License</translate>]]
#[[Version change log/{{PAGELANGUAGE}}|<translate> Version change log</translate>]]
#[[Plugins - advanced/{{PAGELANGUAGE}}|<translate> Plugins - Advanced</translate>]]
</div></div>

<translate>

<tvar|limesurvey>[https://www.limesurvey.org/{{PAGELANGUAGE}} LimeSurvey]</> allows users to quickly create intuitive, powerful online forms and surveys that can work for anyone from small business to large business. The survey software is self-guiding for the respondents. This manual shows how to install the application on your own server (although we strongly recommend our Cloud version for full support), administer the installation, as well as support survey creators, administrators, and users who need to generate reports.


There has been a big ramp-up in development within the last few years, leading to many new features and changes. Make sure to upgrade to the [<tvar|url>https://community.limesurvey.org/downloads/</> latest version] of [https://www.limesurvey.org/ LimeSurvey] to make use of the capabilities highlighted here, If you prefer using the web version then skip the downloading.


The main chapters of the manual are located in the box to the right. You can also scroll down further on this page to see the complete table of contents and go directly to the topic you are interested in.


The '''search box''' (upper right corner of the wiki), our [[General FAQ]], and [[Workarounds]] list will help you if you have any concerns. If you are looking for community help, join our [https://www.limesurvey.org/en/forum/ discussion forums] and check the [irc://irc.freenode.net/limesurvey|LimeSurvey IRC channel].


Remember that <tvar|limesurvey>[https://www.limesurvey.org/{{PAGELANGUAGE}} LimeSurvey]</> is an open source, free software application. See something missing or incorrect? Then help us fix it. This documentation is a wiki that can be edited by you or anyone else, or you can [https://donate.limesurvey.org donate] or buy Basic, Expert, Enterprise plan through the [<tvar|url>https://www.limesurvey.org/{{PAGELANGUAGE}}/pricing</> pricing] page to help support the core development group trying to make a difference :)

= Manual - Table of Contents = 
</translate>


*[[LimeSurvey PRO vs LimeSurvey CE/{{PAGELANGUAGE}}|<translate> LimeSurvey Cloud vs LimeSurvey CE</translate>]]
**[[LimeSurvey PRO vs LimeSurvey CE/{{PAGELANGUAGE}}#What do I need?|<translate> What do I need?</translate>]]
*[[Quick start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}|<translate> LimeSurvey Cloud - Quick start guide</translate>]]
**[[Quick_start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}#Introduction - What is LimeSurvey?|<translate> What is LimeSurvey?</translate>]]
**[[Quick_start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}#Create a free LimeSurvey account|<translate> Create a free LimeSurvey account</translate>]]
**[[Quick_start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}#Setting up your survey site|<translate> Setting up your survey site</translate>]]
**[[Quick_start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}#Start using LimeSurvey|<translate> Start using LimeSurvey</translate>]]
**[[Quick_start guide - LimeSurvey 3.0+/{{PAGELANGUAGE}}#Other LimeSurvey features - Advanced Users|<translate> Other LimeSurvey features</translate>]]

*[[Installation - LimeSurvey CE/{{PAGELANGUAGE}}|<translate> Installation - LimeSurvey CE</translate>]]
**[[Optional settings/{{PAGELANGUAGE}}|<translate> Optional settings</translate>]]
**[[Upgrading from a previous version/{{PAGELANGUAGE}}|<translate> Upgrading from a previous version</translate>]]
***[[ComfortUpdate]]
**[[Installation using a command line interface (CLI)/{{PAGELANGUAGE}}|<translate> Installation using a command line interface (CLI)</translate>]]
**[[Transferring an installation/{{PAGELANGUAGE}}|<translate> Transferring an installation</translate>]]
**[[Installation FAQ]]
***[[Installation security hints/{{PAGELANGUAGE}}|<translate> Installation security hints</translate>]]
***[[Localization]]
*[[How to design a good survey (guide)/{{PAGELANGUAGE}}|<translate> How to design a good survey (Guide)</translate>]]
*[[Getting Started]]
**[[First login - your user preferences/{{PAGELANGUAGE}}|<translate> First login</translate>]]
**[[First login - your user preferences#Change your password/{{PAGELANGUAGE}}|<translate> Change your password</translate>]]
**[[First login - your user preferences#Your account preferences/{{PAGELANGUAGE}}|<translate> Your account preferences</translate>]]
*[[Administering LimeSurvey/{{PAGELANGUAGE}}|<translate> LimeSurvey configuration</translate>]]
**[[Administering LimeSurvey#Settings Tab/{{PAGELANGUAGE}}|<translate> Settings</translate>]]
***[[Home page settings/{{PAGELANGUAGE}}|<translate> Home page settings</translate>]]
***[[Global settings/{{PAGELANGUAGE}}|<translate> Global settings</translate>]]
***[[Plugin manager/{{PAGELANGUAGE}}|<translate> Plugin manager</translate>]]
***[[Menu configuration/{{PAGELANGUAGE}}|<translate> Menu configuration</translate>]]{{NewIn|3.0}}
***[[Menu entries configuration/{{PAGELANGUAGE}}|<translate> Menu entries configuration</translate>]]{{NewIn|3.0}}
**[[Administering LimeSurvey#Users Tab/{{PAGELANGUAGE}}|<translate> Users</translate>]]
***[[Manage users/{{PAGELANGUAGE}}|<translate> Manage users</translate>]]
***[[Manage user groups/{{PAGELANGUAGE}}|<translate> Manage user groups</translate>]]
***[[Central Participant Database]] (CPDB)
**[[Administering LimeSurvey#Advanced Tab/{{PAGELANGUAGE}}|<translate> Advanced</translate>]]
***[[Theme editor/{{PAGELANGUAGE}}|<translate> Theme editor</translate>]] (LimeSurvey 2.x)
****[[New Template System in LS3.x/{{PAGELANGUAGE}}|<translate> New template system in LS3.x</translate>]]
****[[Themes/{{PAGELANGUAGE}}|<translate> Themes</translate>]]
****[[Question themes/{{PAGELANGUAGE}}|<translate> Question themes</translate>]]
***[[Label sets/{{PAGELANGUAGE}}|<translate> Label sets</translate>]]
***[[Check data integrity/{{PAGELANGUAGE}}|<translate> Check data integrity</translate>]]
***[[Backup entire database/{{PAGELANGUAGE}}|<translate> Backup entire database</translate>]]
***[[ComfortUpdate/{{PAGELANGUAGE}}|<translate> ComfortUpdate</translate>]]

*[[Surveys - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Surveys</translate>]]
**[[Surveys - introduction#General/{{PAGELANGUAGE}}|<translate> General</translate>]]
**[[Surveys - introduction#Surveys/{{PAGELANGUAGE}}|<translate> Surveys</translate>]]
***[[Surveys - introduction#Import a survey/{{PAGELANGUAGE}}|<translate> Import a survey</translate>]]
***[[Surveys - introduction#Copy a survey/{{PAGELANGUAGE}}|<translate> Copy a survey</translate>]]
***[[Surveys - introduction#List_surveys/{{PAGELANGUAGE}}|<translate> List surveys</translate>]]
***[[Surveys - introduction#Delete_a_survey/{{PAGELANGUAGE}}|<translate> Delete a survey</translate>]]
***[[Surveys - introduction#Export_a_survey/{{PAGELANGUAGE}}|<translate> Export a survey</translate>]]
**[[Surveys - introduction#Survey Groups/{{PAGELANGUAGE}}|<translate> Survey groups</translate>]]
***[[Surveys - introduction#Survey Groups/{{PAGELANGUAGE}}|<translate> Survey groups</translate>]]
***[[Surveys - introduction#Create a survey group/{{PAGELANGUAGE}}|<translate> Create a survey group</translate>]]
***[[Surveys - introduction#Edit survey group/{{PAGELANGUAGE}}|<translate> Edit survey group</translate>]]
***[[Surveys - introduction#Delete a survey group/{{PAGELANGUAGE}}|<translate> Delete a survey group</translate>]]
***[[Survey group permissions/{{PAGELANGUAGE}}|<translate> Survey group permissions</translate>]]
*[[Survey settings/{{PAGELANGUAGE}}|<translate> View Survey settings</translate>]]
**[[Survey settings#Introduction/{{PAGELANGUAGE}}|<translate> Introduction</translate>]]
**[[Overview/{{PAGELANGUAGE}}|<translate> Overview</translate>]]
**[[General settings/{{PAGELANGUAGE}}|<translate> General settings</translate>]]
**[[Text elements/{{PAGELANGUAGE}}|<translate> Text elements</translate>]]
**[[Data policy settings/{{PAGELANGUAGE}}|<translate> Data policy settings</translate>]]
**[[Theme options/{{PAGELANGUAGE}}|<translate> Theme options</translate>]]
**[[Presentation/{{PAGELANGUAGE}}|<translate> Presentation</translate>]]
**[[Participant settings/{{PAGELANGUAGE}}|<translate> Participant settings</translate>]]
**[[Notifications_%26_data/{{PAGELANGUAGE}}|<translate> Notifications & data</translate>]]
**[[Publication & access/{{PAGELANGUAGE}}|<translate> Publication & access</translate>]]
*[[Survey menu/{{PAGELANGUAGE}}|<translate> View survey menu</translate>]]
**[[Survey menu#Introduction/{{PAGELANGUAGE}}|<translate> Introduction</translate>]]
**[[List questions/{{PAGELANGUAGE}}|<translate> List questions</translate>]]
**[[List question groups/{{PAGELANGUAGE}}|<translate> List question groups</translate>]]
**[[Reorder questions and question groups/{{PAGELANGUAGE}}|<translate> Reorder questions & question groups</translate>]]
**[[Survey participants/{{PAGELANGUAGE}}|<translate> Survey participants</translate>]] (was ''Tokens'')
***[[Email bounce tracking system/{{PAGELANGUAGE}}|<translate> Email bounce tracking system</translate>]]
***[[Iterate survey/{{PAGELANGUAGE}}|<translate> Iterate survey</translate>]]
**[[Survey quotas/{{PAGELANGUAGE}}|<translate> Quotas</translate>]]
**[[Assessments/{{PAGELANGUAGE}}|<translate> Assessments</translate>]]
**[[Survey permissions/{{PAGELANGUAGE}}|<translate> Survey permissions</translate>]]
**[[Email templates/{{PAGELANGUAGE}}|<translate> Email templates</translate>]]
***[[Email placeholders/{{PAGELANGUAGE}}|<translate> Email placeholders</translate>]]
**[[Panel integration/{{PAGELANGUAGE}}|<translate> Panel integration</translate>]]
**[[Resources/{{PAGELANGUAGE}}|<translate> Resources</translate>]]
**[[Plugin menu/{{PAGELANGUAGE}}|<translate> Plugin menu</translate>]]
*[[Survey structure/{{PAGELANGUAGE}}|<translate> View survey structure</translate>]]
**[[Survey structure/{{PAGELANGUAGE}}|<translate> Introduction</translate>]]
**[[Survey structure/{{PAGELANGUAGE}}|<translate> The structure of a survey</translate>]]
**[[Survey structure/{{PAGELANGUAGE}}|<translate> Question groups</translate>]]
**[[Survey structure/{{PAGELANGUAGE}}|<translate> Questions</translate>]]
**[[Survey structure/{{PAGELANGUAGE}}|<translate> Reordering questions and question groups</translate>]]
*[[Questions - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Questions</translate>]]
**[[Question types/{{PAGELANGUAGE}}|<translate> Question types</translate>]]
***[[Question type - Array/{{PAGELANGUAGE}}|<translate> Question type - Array</translate>]]
***[[Question type - Array by column/{{PAGELANGUAGE}}|<translate> Question type - Array by column</translate>]]
***[[Question type - Array dual scale/{{PAGELANGUAGE}}|<translate> Question type - Array dual scale</translate>]]
***[[Question type - Array (5 point choice)/{{PAGELANGUAGE}}|<translate> Question type - Array (5 point choice)</translate>]]
***[[Question type - Array (10 point choice)/{{PAGELANGUAGE}}|<translate> Question type - Array (10 point choice)</translate>]]
***[[Question type - Array (Increase-Same-Decrease)/{{PAGELANGUAGE}}|<translate> Question type - Array (Increase-Same-Decrease)</translate>]]
***[[Question type - Array (Numbers)/{{PAGELANGUAGE}}|<translate> Question type - Array (Numbers)</translate>]]
***[[Question type - Array (Texts)/{{PAGELANGUAGE}}|<translate> Question type - Array (Texts)</translate>]]
***[[Question type - Array (Yes-No-Uncertain)/{{PAGELANGUAGE}}|<translate> Question type - Array (Yes-No-Uncertain)</translate>]]
***[[Question type - Date/{{PAGELANGUAGE}}|<translate> Question type - Date</translate>]]
***[[Question type - Equation/{{PAGELANGUAGE}}|<translate> Question type - Equation</translate>]]
***[[Question type - File upload/{{PAGELANGUAGE}}|<translate> Question type - File upload</translate>]]
***[[Question type - Gender/{{PAGELANGUAGE}}|<translate> Question type - Gender</translate>]]
***[[Question type - Language switch/{{PAGELANGUAGE}}|<translate> Question type - Language switch</translate>]]
***[[Question type - Numerical input/{{PAGELANGUAGE}}|<translate> Question type - Numerical input</translate>]]
***[[Question type - Multiple numerical input/{{PAGELANGUAGE}}|<translate> Question type - Multiple numerical input</translate>]]
***[[Question type - Ranking/{{PAGELANGUAGE}}|<translate> Question type - Ranking</translate>]]
***[[Question type - Text display/{{PAGELANGUAGE}}|<translate> Question type - Text display</translate>]]
***[[Question type - Yes-No/{{PAGELANGUAGE}}|<translate> Question type - Yes-No</translate>]]
***[[Question type - Multiple choice/{{PAGELANGUAGE}}|<translate> Question type - Multiple choice</translate>]]
***[[Question type - Multiple choice with comments/{{PAGELANGUAGE}}|<translate> Question type - Multiple choice with comments</translate>]]
***[[Question type - 5 point choice/{{PAGELANGUAGE}}|<translate> Question type - 5 point choice</translate>]]
***[[Question type - List (Dropdown)/{{PAGELANGUAGE}}|<translate> Question type - List (Dropdown)</translate>]]
***[[Question type - List (Radio)/{{PAGELANGUAGE}}|<translate> Question type - List (Radio)</translate>]]
***[[Question type - List with comment/{{PAGELANGUAGE}}|<translate> Question type - List with comment</translate>]]
***[[Question type - Short free text/{{PAGELANGUAGE}}|<translate> Question type - Short free text</translate>]]
****[[Question type_-_Short_free_text#Location/{{PAGELANGUAGE}}|<translate> Set up maps and store location</translate>]]
***[[Question type - Long free text/{{PAGELANGUAGE}}|<translate> Question type - Long free text</translate>]]
***[[Question type - Huge free text/{{PAGELANGUAGE}}|<translate> Question type - Huge free text</translate>]]
***[[Question type - Multiple short text/{{PAGELANGUAGE}}|<translate> Question type - Multiple short text</translate>]]
**[[Survey_structure#Reordering_questions_and_question_groups/{{PAGELANGUAGE}}|<translate> Change question order</translate>]]
*[[Question groups - introduction/{{PAGELANGUAGE}}|<translate> Introduction - Question groups</translate>]]
**[[Question_groups_-_introduction#Question_group_actions/{{PAGELANGUAGE}}|<translate> Question group toolbar options</translate>]]
**[[Question groups - introduction#Preview question group/{{PAGELANGUAGE}}|<translate> Preview question group</translate>]]
**[[Survey_structure#Reordering_questions_and_question_groups/{{PAGELANGUAGE}}|<translate> Change group order</translate>]]
*[[Surveys - management/{{PAGELANGUAGE}}|<translate> Introduction - Surveys - Management</translate>]]
**[[Testing a survey/{{PAGELANGUAGE}}|<translate> Testing a survey</translate>]]
**[[Activating a survey/{{PAGELANGUAGE}}|<translate> Activating a survey</translate>]]
**[[Running a survey safely/{{PAGELANGUAGE}}|<translate> Running a survey safely</translate>]]
**[[Browsing survey results/{{PAGELANGUAGE}}|<translate> Browsing survey results</translate>]]
**[[Closing a survey/{{PAGELANGUAGE}}|<translate> Closing a survey</translate>]]
**[[Changing an active survey/{{PAGELANGUAGE}}|<translate> Changing an active survey</translate>]]
**[[Data entry/{{PAGELANGUAGE}}|<translate> Data entry</translate>]]
**[[Statistics/{{PAGELANGUAGE}}|<translate> Statistics</translate>]]
**[[Exporting results/{{PAGELANGUAGE}}|<translate> Exporting results</translate>]]
**[[Display/Export survey#Export survey structure (.lss)/{{PAGELANGUAGE}}|<translate> Exporting a survey structure</translate>]]
**[[QueXML PDF Export/{{PAGELANGUAGE}}|<translate> QueXML PDF export</translate>]]
**[[Quick-translation/{{PAGELANGUAGE}}|<translate> Quick-translation</translate>]]
**[[Question toolbar options/{{PAGELANGUAGE}}|<translate> Question toolbar options</translate>]]
***[[Preview function/{{PAGELANGUAGE}}|<translate> Preview function</translate>]]
***[[Edit question/{{PAGELANGUAGE}}|<translate> Edit question</translate>]]
***[[Check question logic/{{PAGELANGUAGE}}|<translate> Check question logic</translate>]]
***[[Delete question/{{PAGELANGUAGE}}|<translate> Delete question</translate>]]
***[[Export question/{{PAGELANGUAGE}}|<translate> Export question</translate>]]
***[[Copy question/{{PAGELANGUAGE}}|<translate> Copy question</translate>]]
***[[Setting conditions/{{PAGELANGUAGE}}|<translate> Setting conditions</translate>]]
***[[Adding answers or subquestions/{{PAGELANGUAGE}}|<translate> Adding answers or subquestions</translate>]]
***[[Default answers/{{PAGELANGUAGE}}|<translate> Default answers</translate>]]
*[[Survey toolbar options/{{PAGELANGUAGE}}|<translate> Survey toolbar options</translate>]]
**[[Testing a survey/{{PAGELANGUAGE}}|<translate> Testing a survey</translate>]]
**[[Activating a survey/{{PAGELANGUAGE}}|<translate> Activating a survey</translate>]]
**[[Running a survey safely/{{PAGELANGUAGE}}|<translate> Running a survey safely</translate>]]
***[[Changing an active survey/{{PAGELANGUAGE}}|<translate> Changing an active survey</translate>]]
**[[Closing a survey/{{PAGELANGUAGE}}|<translate> Closing a survey</translate>]]
**[[Iterate survey/{{PAGELANGUAGE}}|<translate> Iterate survey</translate>]]
**[[Tools/{{PAGELANGUAGE}}|<translate> Tools</translate>]]
***[[Delete survey/{{PAGELANGUAGE}}|<translate> Delete survey</translate>]]
***[[Quick-translation/{{PAGELANGUAGE}}|<translate> Quick-translation</translate>]]
***[[Reset conditions/{{PAGELANGUAGE}}|<translate> Reset conditions</translate>]]
***[[Check_survey_logic_-_Advanced/{{PAGELANGUAGE}}|<translate> Survey logic file</translate>]]
***[[Regenerate question codes/{{PAGELANGUAGE}}|<translate> Regenerate question codes</translate>]]
**[[Display/Export survey]]
***[[QueXML PDF Export/{{PAGELANGUAGE}}|<translate> QueXML PDF export</translate>]]
***[[Tab Separated Value survey structure/{{PAGELANGUAGE}}|<translate> Tab Separated Value survey structure</translate>]]
**[[Survey participants/{{PAGELANGUAGE}}|<translate> Survey participants</translate>]]
**[[Responses (survey results)/{{PAGELANGUAGE}}|<translate> Responses (survey results)</translate>]]
***[[Responses & statistics/{{PAGELANGUAGE}}|<translate> Responses & statistics</translate>]]
****[[Responses & statistics#Responses summary/{{PAGELANGUAGE}}|<translate> Response summary</translate>]]
****[[Responses/{{PAGELANGUAGE}}|<translate> Responses</translate>]]
****[[Data entry/{{PAGELANGUAGE}}|<translate> Data entry</translate>]]
****[[Statistics/{{PAGELANGUAGE}}|<translate> Statistics</translate>]]
*****[[Statistics - expert mode/{{PAGELANGUAGE}}|<translate> Statistics - expert mode</translate>]]
*****[[Statistics - simple mode/{{PAGELANGUAGE}}|<translate> Statistics - simple mode</translate>]]
****[[Timing statistics/{{PAGELANGUAGE}}|<translate> Timing statistics</translate>]]
****[[Export responses/{{PAGELANGUAGE}}|<translate> Export responses</translate>]]
****[[Import responses/{{PAGELANGUAGE}}|<translate> Import responses</translate>]]
*****[[Problems & solutions/{{PAGELANGUAGE}}|<translate> Problems & solutions</translate>]]
****[[View saved but not submitted responses/{{PAGELANGUAGE}}|<translate> View saved but not submitted responses</translate>]]
****[[Iterate survey#General/{{PAGELANGUAGE}}|<translate> Iterate survey</translate>]]
****[[Batch deletion/{{PAGELANGUAGE}}|<translate> Batch deletion</translate>]]
***[[Data entry/{{PAGELANGUAGE}}|<translate> Data entry</translate>]]
***[[Partial (saved) responses/{{PAGELANGUAGE}}|<translate> Partial (saved) responses</translate>]]
*[[Multilingual survey/{{PAGELANGUAGE}}|<translate> Multilingual survey</translate>]]
*[[ExpressionScript Engine - Quick start guide/{{PAGELANGUAGE}}|<translate> ExpressionScript Engine - Quick start guide</translate>]]
**[[ExpressionScript - Presentation/{{PAGELANGUAGE}}|<translate> ExpressionScript - Presentation</translate>]]
**[[ExpressionScript How-tos/{{PAGELANGUAGE}}|<translate> ExpressionScript how-tos</translate>]]
**[[ExpressionScript examples/{{PAGELANGUAGE}}|<translate> ExpressionScript examples</translate>]]
**[[ExpressionScript Engine roadmap/{{PAGELANGUAGE}}|<translate> ExpressionScript Engine roadmap</translate>]]
**[[ExpressionScript for developers/{{PAGELANGUAGE}}|<translate> ExpressionScript for developers</translate>]]
**[[ExpressionScript sample surveys/{{PAGELANGUAGE}}|<translate> ExpressionScript sample surveys</translate>]]
***[[Expression Manager/{{PAGELANGUAGE}}|<translate> Expression Manager</translate>]] - old page with full documentation
*[[Not categorized and advanced features/{{PAGELANGUAGE}}|<translate> Advanced features</translate>]]
**[[SGQA identifier/{{PAGELANGUAGE}}|<translate> SGQA identifier</translate>]]
**[[Using regular expressions/{{PAGELANGUAGE}}|<translate> Using regular expressions</translate>]]
**[[URL fields/{{PAGELANGUAGE}}|<translate> URL fields</translate>]]
**[[RemoteControl 2 API/{{PAGELANGUAGE}}|<translate> RemoteControl 2 API</translate>]]
**[[REST API]]
**[[Data encryption/{{PAGELANGUAGE}}|<translate> Data encryption</translate>]]
**[[Custom translation|<translate> Custom translation</translate>]]
*[[Data protection|<translate> Data Protection</translate>]]
**[[Data protection#Cookies|<translate> Cookies</translate>]]
*[[General FAQ/{{PAGELANGUAGE}}|<translate> General FAQ</translate>]]
*[[Troubleshooting/{{PAGELANGUAGE}}|<translate> Troubleshooting</translate>]]
*[[Workarounds/{{PAGELANGUAGE}}|<translate> Workarounds</translate>]]
**[[Workarounds: Question design, layout and templating/{{PAGELANGUAGE}}|<translate> Workarounds: Question design, layout and templating</translate>]]
**[[Workarounds: Manipulating a survey at runtime using Javascript/{{PAGELANGUAGE}}|<translate> Workarounds: Manipulating a survey at runtime using Javascript</translate>]]
**[[Workarounds: Survey behaviour/{{PAGELANGUAGE}}|<translate> Workarounds: Survey behaviour</translate>]]
**[[Workarounds: Further solutions provided by LimeSurvey users/{{PAGELANGUAGE}}|<translate> Workarounds: Further solutions provided by LimeSurvey users</translate>]]
*[[License/{{PAGELANGUAGE}}|<translate> License</translate>]]
*[[Version change log/{{PAGELANGUAGE}}|<translate> Version change log</translate>]]
*[[Plugins - advanced/{{PAGELANGUAGE}}|<translate> Plugins - advanced</translate>]]
**[[Make your plugin compatible with LS4/{{PAGELANGUAGE}}|<translate> Make your plugin compatible with LS5</translate>]]
**[[Available third party plugins/{{PAGELANGUAGE}}|<translate> Available third party plugins</translate>]]

<translate>

=LimeSurvey Development= 
</translate>
*[[Version guide/{{PAGELANGUAGE}}|<translate> Version guide</translate>]] - <translate> A short guide on version numbering</translate>
*[[Development overview|<translate> Development overview</translate>]] - <translate> General pages about LimeSurvey development</translate>
*[[LimeSurvey 2.x development documentation/{{PAGELANGUAGE}}|<translate> LimeSurvey 2.x development documentation</translate>]]
*[[New Template System in LS3.x/{{PAGELANGUAGE}}|<translate> New Template System in LS3.x</translate>]] - <translate> Quick overview of the novelties of the LimeSurvey 3 template system</translate>

<translate>

=Translating LimeSurvey= 


If you want to '''add new translations''' or '''correct a translation''', please follow these instructions:
</translate>
*[[Translating LimeSurvey/{{PAGELANGUAGE}}|<translate> How to translate LimeSurvey</translate>]]
*[[LimeSurvey manual translation - summary/{{PAGELANGUAGE}}|<translate> LimeSurvey manual translation - summary</translate>]]

<translate>
=Semester of Code Participation= 
</translate>

*[[Semester of Code 2014/{{PAGELANGUAGE}}|<translate> Semester of Code 2014</translate>]]

<translate>
=Google Summer of Code / Code-In Participation= 
</translate>
*[[Project ideas for GSoC 2015|<translate> Project ideas for GSoC 2015</translate>]]
*[[Project Ideas for GSoC 2013|<translate> Project Ideas for GSoC 2013</translate>]]
*[[LimeSurvey Google Code-in 2012|LimeSurvey Google Code-in 2012]]
*[[LimeSurvey Google Code-in 2011|LimeSurvey Google Code-in 2011]]
*[[LimeSurvey GSoC 2011]]/[[GSoC getting started|<translate> GSoC getting started</translate>]]
*[[LimeSurvey GSoC 2010|LimeSurvey GSoC 2010]]
*[[LimeSurvey GSoC 2009|LimeSurvey GSoC 2009]]

Not categorized and advanced features

2024-05-22T14:14:11Z

Tibor.pacalat:

<languages /> <translate>


Table of contents:
*[[SGQA identifier]]
*[[Using regular expressions]]
*[[URL fields]]
*[[RemoteControl 2 API]]
*[[Data encryption]]
*[[Custom translation]]

</translate>

Custom translation

2024-05-22T14:11:35Z

Tibor.pacalat: corrected grammar and typos

=Introduction=

Since LimeSurvey 5.4.0 you can have your own translation for all strings in all included languages with direct access to your database.

This system can be used if an existing translation is not compatible with your business needs.

It should be reserved for specific cases, since text modifications in the heart of LimeSurvey will again require a modification of your database.

Furthermore, you can use this method for translating Survey Theme specific strings.

=How database translations works=

For database translations, LimeSurvey uses a method inspired by [https://www.yiiframework.com/doc/api/1.1/CDbMessageSource CDbMessageSource] from the Yii framework.

# find the string in SourceMessage table lime_source_message->message, get the id : lime_source_message->id
# if exists, find the related translation in Message table lime_message->translation for current language lime_message->language with current id lime_message->id

LimeSurvey creates the array with translations from po file (see [[Translating LimeSurvey]] for information how to update this file), and afterwards merges it with all translations from the database.

Then the translations from the database are always returned if they exist.

=Sample for “Submit” button in English and French=

You want to show _Validate_ and not _Submit_ for the submit button in all of your surveys (with a specific theme). If you just update the theme and replace gT('Submit') by gT('Validate') : it always shows _Validate_ in all languages.

==For all surveys with all themes==

# Create the source message <code>INSERT INTO lime_source_message (id, category, message) VALUES (NULL, NULL, 'Submit');</code>
# Check the ID (if it's the 1st : ID is 1) and use it for next instruction
# Create the related translation : <code>INSERT INTO lime_message (id, language, translation) VALUES ('1', 'en', 'Validate'), ('1', 'fr', 'Valider'); </code>

==Using your own theme (recommended solution)==

This method uses a solution with your own template, it updates the default string for all other languages as well.

# In [[Theme editor]] select the Navigation part
# Search for <code>{{ gT("Submit") }}</code> (in navigator.twig)
# Replace by <code>{{ gT("Validate") }}</code>
# Create the source message <code>INSERT INTO lime_source_message (id, category, message) VALUES (NULL, NULL, 'Validate');</code>
# Check the ID (if it's the 1st : ID is 1) and use it for next instruction
# Create the related translation : <code>INSERT INTO lime_message (id, language, translation) VALUES ('1', 'fr', 'Valider'); </code>

Manage users

2024-01-29T14:54:22Z

Tibor.pacalat:

<languages />
<translate>

__TOC__

= User management= 


The user management tool allows you to add additional administration users to LimeSurvey. We refer to them as 'users'. Do not confuse them with [[Survey participants|survey participants]] (respondents).

==Create users== 


To create a new user, open the user management dialog by clicking on '''Configuration''' (located on the main LimeSurvey toolbar) -> '''User management'''.


<center>[[File:LimeSurveyMenuUserManagement.png]]</center>


Then, click '''Add user''' located in the upper right area of '''User control''' table. A window will be displayed asking you to:


* Enter the desired username into the '''Username''' field.
* Enter the email address into the '''Email''' field. Please note that:
** LimeSurvey sends out a confirmation email to the address entered into the '''Email''' field. This email address will be used as the standard contact email address for surveys created by the respective user.
** If you do not want the user to receive the confirmation email with a link to the LimeSurvey application, username, and password, you can use your own email address to send the confirmation email to you. After that, you can change the email address to the address of the user.
* Enter user's full name into the '''Full name''' field. Please note that the full name entered here will be used as the standard contact person name for surveys created by the respective user.
* Click '''Save''' to create the new user.


Note that password complexity is enforced and validated by the PasswordRequirement plugin.


<center>[[File:LimeSurveyAddUser.jpg]]</center>


You have now created your first user. To find out more about [[Manage users#Set global permissions for a user|setting user permissions]], please read on.


<center>[[File:LimeSurveyBleistiftSymbol.jpg]]</center>


Below you can see four options under the '''Action''' column that allow you to:


<center>[[File:Edit users.png]]</center>


*edit the general aspects of a user - by clicking the pen symbol.
*delete the user from the survey administrators database - by clicking the trash button.
*set global permissions for a user - by clicking the lock symbol.
*set theme permissions for a user - by clicking the pen-and-lock symbol.

==Edit user== 


Click the pen icon to edit user information.


You can enter a new email address, name, and change their password. Click '''Save''' to confirm changes.

==Delete user== 


To delete a user account, click the corresponding trash icon (located on the same line as the user account you want to delete) and click '''OK'''.

==Set global permissions for a user== 


{{Alert|Global permissions apply to the whole LimeSurvey application. If you want to set permissions only for a specific survey, you can use the [[Manage users#Setting permissions for a single survey|survey permissions settings]].}}


To set global permissions for a user, click the lock symbol.


<center>[[File:User_global_permission.png]]</center>


The CRUD (create, read, update, and delete) system is employed (as it is in the [[Manage users#Setting permissions for a single survey|survey permission settings]]). For more user permission options, we recommend extending the matrix using the double-right arrowhead, which is located in its upper right corner. If you check the first box, all the CRUD permissions in that row are automatically checked.


<center>[[File:User_global_permission_complete.png]]</center>


You can now add or remove the following permissions:


* '''Participant panel''': For more details, continue reading about the [[Central Participant Database|central participant database here]].


* '''Label sets''': Permission to create, view, update, delete, export, and import label sets. The label sets do not have specific permissions (unlike themes).


* '''Settings & Plugins''': With this permission a user can check data integrity, save the SQL database to an .sql file, manage global settings, view the PHP info in the global settings, and manage all plugins.


* '''Survey groups'''{{NewIn|v=4.4.0}}: Give access to all surveys' group. To allow user to manage their own surveys' group, give the user the 'create' permission. A creator of a surveys' group are (by default) the owner of this surveys' group.
{{Note|Permission on a surveys group does not give all permissions on surveys, but a user can give permissions on all surveys in surveys' group}}


* '''Surveys''': Gives access to all surveys. To allow a user to only create and manage their own survey, give the user the 'create' permission. A creator of a survey is the owner of the survey and will always be able to manage it. Remember that each survey can grant different permissions .
{{Note|'''The global permission is applied before the survey-specific permission!'''}}


* '''Themes''': Allows the user to use all the available design themes and edit all non-standard themes. A person with this permission should have sufficient knowledge in terms of HTML, Javascript, and CSS. If a user is not familiar with these things and is supposed to use a specific design themes, it would be better to only give them 'read' permission. Each theme can have specific permissions.


* '''User groups''': Allows a user to create/view/update/delete user groups.


* '''Users''': A user can create, modify, and delete their own administration users with this permission. The newly created users cannot have higher permissions than the parent user. You will also not be able to edit users owned by other administration users. If this has to be done, then a Superadministrator permission must be granted.


* '''Superadministrator''': Can only be added by other Superadministrator with this setting as update and grants full permission to the whole LimeSurvey application, including installing plugins and using any kind of content (including JavaScript) in survey content. (see also [[Global_settings#Security|global security settings]])


*'''Use internal database authentication''': Allows users to access LimeSurvey's panel via the authentication page (e.g. ''http://domain/admin/authentication/sa/login''). If it is unchecked and the respective user tries to connect to LimeSuvey's panel, they will get the following error: 'Internal database authentication method is not allowed for this user'.


{{Note|All the permissions mentioned above that belong to the [[Optional_settings#Security|forced super administrator]] cannot be removed via the GUI.}}

==Import and export users== 


You can import and export users in CSV and JSON format by using these buttons on User Management page.
<center>[[File:ImportExportButtons.png]]</center>


When you are importing users, a modal opens that shows you which fields should be present. You can choose to overwrite existing users by selecting this checkbox.
<center>[[File:ImportUsersModal.png]]</center>

Example of the JSON structure: 

<syntaxhighlight lang="json">
[
{
"uid": 1,
"users_name": "admin2",
"full_name": "Administrator",
"email": "your-email@example.net",
"lang": "en",
"password": ""
},
{
"uid": 2,
"users_name": "ben2",
"full_name": "Ben Alister",
"email": "ben@test.ing",
"lang": "auto",
"password": "test!123"
}
]
</syntaxhighlight>

Example of the CSV structure: 

<syntaxhighlight>
uid;users_name;full_name;email;lang;password
1;admin;Administrator;your-email@example.net;en;
2;ben;"Ben Alister";ben@test.ing;auto;test!123
</syntaxhighlight>

==Set theme permissions for a user== 


With theme permissions, you can decide which design themes a user can select when creating or editing a survey.


If you have specific design themes for a group of users or customers, you can restrict their access to other themes to ensure that they use only themes created for them.


To set or edit the themes permissions for a user, click the pen-and-lock symbol for design themes.


<center>[[File:LimeSurveySetDesignTemplatesLS.jpg]]</center>


Select the design themes to which the respective user or user groups should have access. After you finished your selection or deselection, do not forget to click '''Save''': [[File:Save.png|0.75px]].


To better understand this function, view [[Manage users#Examples|the examples provided below]].

==Activate and deactivate users==

{{FeatureStarting|6.4.0}}
It's possible to mark a user as activated or deactivated.

A deactivated user is not able to log in to the admin interface.

=Use one-time passwords= 


A user can call the LimeSurvey login at /limesurvey/admin and enter a username and a one-time password (which was previously written into the users table - ''column one_time_pw'' - by an external application).


To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>'use_one_time_passwords' => true;</code>]] has to be added to config.php (it is 'false' by default) .


The URL has to contain the following variables:
* '''user:''' The username normally used to login into LimeSurvey. This username has to exist in the 'users' table of the database.
* '''onepass:''' The plain text password which is then compared to the password in the 'users' table


A valid URL to login using a one-time password will look like this:


<div class="simplebox">http://www.yourdomain.org/limesurvey/index.php/admin/authentication/login?user=myusername&onepass=secretpassword</div>


<div class='simplebox'> [[File:help.png]] The 'secretpassword' field is plain text, not a SHA 256 hash.</div>


'''Things to watch out for:'''
* To enable this login method, the line [[Optional settings#Use_one_time_passwords|<code>'use_one_time_passwords' => true</code>]] has to be added in config.php (it is 'false' by default).
* The passed username has to exist in the LimeSurvey ''users table''.
* The one-time password (which can be set via an external application) has to be stored as [https://secure.php.net/manual/en/function.md5.php MD5 hash] in the column ''one_time_pw'' of table ''users''.
* The passed plain text password will be hashed using the sha256 function and will then compared to the stored hash in column ''one_time_pw'' of table ''users''. Both passwords have to match.
* After the first login with the one-time password, it gets deleted from the database. The user won't be able to log in with that respective password a second time.

=Set permissions for a single survey= 


These permissions only apply for a single survey. If you want to set permissions for the whole system, you can use [[Manage users#Set global permissions for a user|global permissions]].
These permissions can be offered either to a single user or to a user group.


{{Alert|title=Attention|text=An existing user account is required to set permissions for a single survey. If the account doesn't exist, you have to create it first and then change the survey permissions. The same applies to offering survey permissions to a user group. Besides the necessity to have one created, you also need to add at least one user to that group in order to be able to select it and grant it survey permissions.}}


{{Note| By default, an user (non-admin) cannot grant survey permissions to users that are not part of the same group as the survey administrator. This is a security option enabled by '''default''' in LimeSurvey. To change this, you need to deactivate option [[Global_settings#Security|Group member can only see own group]], located in the '''Global settings''', under the '''Security tab'''. However, if you feel unsure about disabling this option, you can create groups containing those users that can be seen and be granted survey permissions by a survey creator.}}


To change the survey permissions, click the '''Settings''' tab. Then, click '''Survey permissions''' and choose to whom would you like to offer permissions. The permissions can be offered either separately to specific users or to a user group.


<center>[[File:LimeSurveySurveyPermissions.jpg]]</center>


<center>[[File:LimeSurveySurveyPermissionsRights.png]]</center>

==Grant survey permissions to a user== 


In the next step, select the user that will receive survey permissions and click '''Add user'''.


<center>[[File:LimeSurveyAddSurveyPermission.jpg]]</center>


After you click '''Set survey permissions''', the user's survey permissions matrix will be shown.


<center>[[File:LimeSurveyUserPermissionMatrix.jpg]]</center>


You can set in this matrix the user's survey permissions. Checking a box grants survey permissions to the respective user. If you click a checkbox from the first column, all the permissions of the corresponding line will be selected/removed.


Click the double-right arrowhead to access the extended version of the matrix to choose specifically the actions that can be performed by a user.
After you finished editing the survey permissions, click '''Save''', which is located in the upper right corner of the screen.


Some examples are provided [[Manage_users#Examples|below]] in order to help you get a better understanding of Limesurvey's survey permissions system.

==Grant survey permissions to a user group== 


Click '''add a user group''' and select the user group to which you would like to add the permission permissions.


<center>[[File:LimeSurveyPermissionpermissionsUserGroup.png]]</center>


In the next step, select the permissions that you will allocate to the members of that user group. Do not forget to click the double right arrowhead to get an extended view of the permissions matrix.


<center>[[File:UserGroupSurveyPermissions.png]]</center>


After you have finished editing the survey permissions, click '''Save''', which is located in the upper right part of the screen.


Some examples are provided [[Manage_users#Examples|below]] to help you get a better understanding of the Limesurvey's survey permissions system.


{{Note|[[Manage user groups|The user group function]] is still experimental. Use our [https://bugs.limesurvey.org/ bugs tracker] to describe any kind of inconsistencies.}}

=Examples= 


Different scenarios are presented below. They provide some advice about which permissions are necessary for some specific tasks and how they can be granted to the users.

==Add new LimeSurvey adminisrator== 
* Log in as '''admin'''.
* Create a new user account.
* Grant that user the '''Superadministrator''' permission.
* ''Not necessary'' : Setting the theme permissions ('''Superadministrator''' has all permissions for all themes).
* ''Not necessary'' : Setting the survey permissions ('''Superadministrator''' has all permissions for all surveys).

==A new user wants to create their own surveys== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set global permissions for that user to '''Create survey'''.
* ''Optional'' : Set theme permissions - select which theme(s) should be used by the user/user group.

==The creator of a survey needs to give another person permission to edit their survey== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set '''no global permissions''' for user.
* Set '''no theme permissions''' for user.
* Set the survey permissions the way you want. If he/she should receive all the survey permissions, you can check the first box from each row. Otherwise, click on the double-right arrowhead to see the expanded matrix (upper right corner) and select only those permissions you believe the respective user should have.

==A person responsible for the survey wants to view and export survey results== 
* Log in as '''admin''' (or as a user that has the '''Superadministrator''' permission).
* Create a new user account.
* Set '''no global permissions''' for user.
* Set '''no theme permissions''' for user.
* Set survey permissions to: '''Responses''' -> '''View/read''' and '''export''', and '''Statistics''': '''View/read'''.


<center>[[File:LimeSurveyCusomerOwnStatistics.jpg]]</center>

==Granting permission for help with translation of a survey== 
* Log in as ''admin'' (or as a user that has the ''Superadministrator'' permission).
* Create ''n'' user accounts (where n is the number of translators).
* Create a user group called ''Translators'' and add the ''n'' accounts to this group.
* Go to the '''Survey permissions''' and click on '''Add a user group'''.
* If they only do translations, then offer them the '''Quick translation''' permission.


{{Note|Check our [[LimeSurvey Users|wiki section on users]] and their classification as it can be found in the code and documentation.}}
</translate>

File:ImportExportButtons.png

2024-01-29T13:47:13Z

Tibor.pacalat:

File:ImportUsersModal.png

2024-01-29T13:46:48Z

Tibor.pacalat:

The bugtracker and git

2023-10-23T08:51:25Z

Tibor.pacalat: added more details

This article should help developers on the LimeSurvey when resolving issues.

General process outline:

# Bug reported by a user in [https://bugs.limesurvey.org Mantis]
# Bug assigned to a developer (by the developer or someone else)
# Bug fixed and a PR (pull request) made at github.com
# Mantis ticket status changed to '''ready for code review''', '''Assigned To''' can remain to be the developer that fixed the issue
# When creating the PR, please assign reviewer (DenisChenu or gabrieljenik for bugs, developer suggested by Github for features - suggested reviewers are based on git blame data)
# If the code review fails, reviewer puts comments in the PR what needs to be fixed
# After successful code review, quality assurance tests and verifies the bugfix/feature
# If testing fails, quality assurance puts comments in the Mantis ticket
# Finally if all is well, quality assurance merges the PR and code gets published with a new version
# Mantis ticket status changed to '''resolved''' and later '''closed'''

This method of working should allow for efficient bug fixing with multiple developers.

Please respond on what you think of this process, or what should be changed.

The bugtracker and git

2023-10-23T08:23:09Z

Tibor.pacalat: updated workflow and formatting

This article should help developers on the LimeSurvey when resolving issues.

General process outline:

# Bug reported by a user in [https://bugs.limesurvey.org Mantis]
# Bug assigned to a developer (by the developer or someone else)
# Bug fixed and a PR (pull request) made at github.com
# Mantis ticket status changed to '''ready for code review'''
# When creating the PR, please assign reviewer (DenisChenu or gabrieljenik for bugs, developer recommended by Github for features)
# If the code review fails, reviewer puts comments in the PR what needs to be fixed
# After successful code review, quality assurance tests and verifies the bugfix/feature
# If testing fails, quality assurance puts comments in the Mantis ticket
# Finally if all is well, quality assurance merges the PR and code gets published with a new version
# Mantis ticket status changed to '''resolved''' and later '''closed'''

This method of working should allow for efficient bug fixing with multiple developers.

Please respond on what you think of this process, or what should be changed.

Standard for Git commit messages

2023-07-26T14:28:39Z

Tibor.pacalat: corrected standard for security commit message

__TOC__

=General overview=

This page describes the standard format of commit messages. Indeed, standard commit messages will make sure that the automatic generation of releases change logs will work properly. '''If you do not follow these rules your contribution(s) might not be properly credited in the change log.
'''

=Rules=

==Syntax==
* Each commit message is made up of one or more commit blocks
* A commit block:
** The first line is the 'Commit Summary' and describes the committed patch '''in a user friendly way'''
** The following lines begin with the Keyword '''Dev''' and are intended to the developpers team

<syntaxhighlight lang="text"><Commit type>: <commit label> <commit description> <NEWLINE>

[ Dev <development details> <NEWLINE> ]

[ Dev <development details> <NEWLINE> ]

<Commit type>: <commit label> <commit description> <NEWLINE>

[ Dev <development details> <NEWLINE> ]

[ Dev <development details> <NEWLINE> ]</syntaxhighlight>

==The commit type==

The first word in the commit message gives the commit type:
* If the commit is about a fix, the commit message must begin with the keyword ''''Fixed issue #<bug ID without leading zeros>'''' or if there is no bug ID just ''''Fixed issue''''
* If the commit is about a change in LS feature, the commit message must begin with the keyword ''''Updated feature''''
* If the commit is about a change in a translation, the commit message must begin with the keyword ''''Updated translation''''
* If the commit is about a new feature, the commit message must begin with the keyword ''''New feature''''
* If the commit is about a new translation, the commit message must begin with the keyword ''''New translation''''
* If the commit is not connected to any tracker issue and not of public interest (changelog), just pure development then use ''''Dev''''

==The commit label : security ==

If commit is a security fix, add "[security]" label to first line commit description like in the example below.

Example : <code>Fixed issue #1234: [security] Persistent XSS</code>

==The commit description==

Following the commit type is the commit description. This must be a single line (no newline character), and is intended to be used in the generated changelog.

Ideally it is a text readable by end-users: for instance if you're resolving a bug ticket give the commit a user-friendly description and make sure it describes the problem, not the solution. Remember that an end-user would scan the log that way for a fix for his/her specific problem.

==The development details==

Develoment details are added in extra optional lines, each one beginning with the keyword ''''Dev''''.

==Patches which require multiple commits==

When multiple commits are linked to the same topic (same new feature, same fix, ...), the 'Commit Summary' line of subsequent commits must be the same as the one provided for the first commit.

The development details (line starting with the keyword 'Dev') can differ, of course.

== Examples==

Example of a simple language file update:

<syntaxhighlight lang="text">Updated translation: German</syntaxhighlight>

Example of a security fix:

<syntaxhighlight lang="text">Fixed issue #9762: [security] XSS possible</syntaxhighlight>

Example of a single bug which is fixed in several commits:

Commit 1:

<syntaxhighlight lang="text">Fixed issue #2565: Can't access survey more than once on the same browser window

Dev: This fixes this bug for survey with tokens.

Dev: When showing a new token (different from the one in session), the previous session is destroyed.</syntaxhighlight>

Commit 2:

<syntaxhighlight lang="text">

Fixed issue #2565: Can't access survey more than once on the same browser window

Dev: This fixes this bug for survey without tokens and without answer preview.

Dev: Session is destroyed at submit time.</syntaxhighlight>

Commit 3:

<syntaxhighlight lang="text">Fixed issue #2565: Can't access survey more than once on the same browser window

Dev: This fixes this bug for survey without tokens and with answer preview.

Dev: Session is destroyed when closing the answer preview window or closing the Submit confirmation page.</syntaxhighlight>

Example of a single commit containing several fixes each with a Dev comment:

<syntaxhighlight lang="text">Fixed issue #1234: Fixed some untranslated strings

Dev: Missing call to clang-gT in admin.php

Fixed issue #2345: Fixed a small layout issue in condition editor

Dev: Fixed div HTML elements</syntaxhighlight>

[[Category:Development]]