Actions

Question type - File upload

From LimeSurvey Manual

Revision as of 14:45, 31 March 2018 by Han (talk | contribs) (Marked this version for translation)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

Short description

The file upload question type can be used to collect file(s) from a user in response to a question. For example, a company with employment opportunities could use this question type to request the candidate to submit/upload his or her updated CV, as well as any other scanned documents in the employment survey.


Example: File upload question type.zip

This question gives the survey designer the ability to restrict the files that can be uploaded by the user in response to the question. For example, the survey administrator can allow only PNG, JPG, and JPEG images which are less than 1 MB in size.

General options

Condition (previously "Relevance equation")

Description

If the result value of the condition is "1" or "true", the question is "relevant" in the survey context, i.e. it is shown to the survey participant. If not, the question is hidden. Any survey question allows you to specify a relevance equation. This function is the successor of conditions and supports much more complex conditional logic.

Syntax Highlighting

Whenever you save the condition, it is evaluated and syntax-highlighted. Any errors will be color coded so that you can quickly detect and fix them.

 Hint: To check if all conditions are used correctly within your survey, read about our show logic file feature.


Valid values

  • Any condition that makes use of the ExpressionScript syntax, without surrounding curly braces.

Examples

Here are good examples of syntax highlighting.


Display

Hide tip (hide_tip)

Description

Most questions will usually include a tip that says "Please choose one of the following options" or a hint text on how to fill out the question. This attribute allows you to turn off or on this tips/hints.

These tips/hints include validation criteria messages (such as min/max number of answers, min/max/equals sum value). If hide_tip is enabled, these messages will be hidden. However, if the user enters invalid data, the tips will appear. They will be coloured in red, getting changed to green once the validation criteria are met.

Available options

  • On - the tips/hints are hidden;
  • Off (default).


Question theme (question_theme)

Description

It allows you to use customized themes for the respective question.

Available options

  • Your created question themes which are located under the Question themes in the Themes panel.

See: Question themes

Note: This feature is under development at the moment.


Always hide this question (hidden)

Description

If enabled, the question will always be hidden - it will not be displayed to the survey participants. This function can be used in the following scenarios:

  • If you wish to prefill a question with a URL and you want not to have it displayed on the screen. This overrides any conditions used within the survey because the respective question will not even be embedded on the page.
  • If you wish to store or calculate a value on the fly via the ExpressionScript - Presentation.
Note: A common question type that is used with this function is the Equation one.

Available options

  • On
  • Off (default)


CSS class (css_class)

Description

If you want to add special CSS classes to certain questions, you can enter the CSS class name(s) in this box. Make sure you leave an empty space between different class names.

Valid values

  • Any text string with a space between different CSS class names.
 Hint: You can also insert an expression in this box (New in 3.0.0 ). Remember that the output of the expression will not be updated dynamically.


  According to the W3C, CSS class names can contain only the characters [a-zA-Z, and 0-9] and ISO 10646 characters U+00A1 and higher, plus the hyphen (-) and the underscore (_). They cannot start with a digit, or a hyphen followed by a digit. LimeSurvey encodes CSS classes, but it does not fix it totally.



File metadata

Show title (show_title)

Description

If enabled, a title textbox will be displayed where the respondent can enter a suitable title/subject for the uploaded file.

Available options

  • On (default) - a title textbox is displayed
  • Off



Show Comment (show_comment)

Description

If enabled, a comment textbox will be displayed where the respondent can enter any comments on the uploaded file.

Available options

  • On (default) - a comment textbox is displayed
  • Off


Logic

Randomization group name (random_group)

Description

It places the questions into a specified randomization group, all questions included in the specified group being displayed in a random order to the survey respondents.

You can find a sample survey using randomization group name in ExpressionScript sample survey.

Valid values

Just enter any string you like (for example: 'group1'). All question which have set the same string within the randomization group name box will have their place in the survey randomized (=randomly exchanged among each other).


Preview To preview the questions use the preview survey instead of the preview question group function, as the second has been reported to not show the questions in a randomized order.


Other

Insert page break in printable view (page_break)

Description

This attribute is only active when you actually print a survey from the Printable View. It forces a page break before the question.

Available options

  • On
  • Off (default)



Maximum file size allowed (max_filesize)

The maximum size of a file that should be allowed to be uploaded by the user.

Example

If the maximum filesize is set to 1024 KB, any files larger than 1024 KB will be discarded, and the user will be asked to upload a smaller file.

Note: The final value shown to the survey participant is also depending on PHP settings, like post_max_size and upload_max_filesize. Of all three possible values (upload_max_filesize, post_max_size and max_filesize) the lowest one will be shown and used.



Maximum number of files (maximum_number_of_files)

Description

The maximum number of files that can be uploaded in response to this question.

Valid values

  • Any positive integer
  • Any number (will be rounded to integer)
  • Any SGQA code
  • Any question code (variable name)
  • Any equation, using any Expression Manager syntax, without surrounding curly braces.



Minimum number of files (minimum_number_of_files)

Description

The minimum number of files that must be uploaded in response to this question.

Valid values

  • Any positive integer
  • Any number (will be rounded to integer)
  • Any SGQA code
  • Any question code (variable name)
  • Any equation, using Expression Manager syntax, without surrounding curly braces.



Allowed file types (allowed_filetypes)

Description

You may enter in this field the file types that are allowed to be uploaded by the respondent as answer to the question. The file formats must be separated by a comma.

Example

  • One may enter: JPG, jpeg, png, gif.
  When checking the allowed file types, LimeSurvey check extension and mime type. Default system know common mime types. If you need specific file type, you have to update your config.php file.



Statistics

Display chart (display_chart)

Description

This attribute allows the survey administrator to choose if a chart that contains the question results should be displayed to the survey participants after they filled out the survey.

Note: To have the chart displayed on the last page, you have to enable the following options:


Available options

  • On
  • Off (default)



Chart type (chart_type)

Description

This attribute allows the survey administrator to choose which type of chart will be displayed to the respondent once he/she finished filling out the survey.

Note: Do not forget to change the question and survey settings in order to have the charts displayed at the end on the survey. For more details, check the wiki section on the display chart question attribute.

Available options

  • Bar chart
  • Pie chart
  • Radar
  • Line
  • PolarArea
  • Doughnut