File Upload
How to handle uploading of images and other file types
To upload a file (typically a photo) which can subsequently be attached to emails or returned to the host system, select 'File Upload' from the Question Type menu (if this option is not listed, please contact Support as this functionality may be disabled).
Properties
Admin Display – a descriptive name to identify the Question.
Operator Display - the Question text as displayed to the Operator.
File Types – defines the permitted file types. This text is displayed to the end user. More information below...
Max Files - This option allows script authors to control how many files users can attach whilst completing the question. If the user attempts to upload more than the allowed max files a validation message will be presented informing users they cannot upload any more files.
Max File Size - This option allows script authors to control the maximum file size allowed for any individual file uploaded whilst completing the question. Any individual file uploaded must be below the "Max File Size" otherwise a validation message will be displayed informing the user the file is too big. This setting does not limit the total size of all combined files. For example, if you allow the user to upload 5 files and set a max file size of 10mb then the user can upload 5 10mb files for the question which would of course total 50mb on the server. If any individual upload exceeded 10mb then the file would be rejected, and the file is too big validation message would be displayed – other valid files would still be processed if you selected multiple files.
Record Value - if checked the value will be added to the recorded text.
Mandatory - check this box to make an upload mandatory.
More about File Types
The permitted file types will be displayed to the operator/end-user. You can specify the permitted file types in various ways...
'jpg' and 'gif' and 'png' and 'docx' and 'mp4' and 'zip' and 'pdf'
jpg, gif, png, docx, mp4, zip, pdf
jpg,gif,png,docx,mp4,zip,pdf
.jpg, .gif, .png, .docx, .mp4, .zip, .pdf
.jpg,.gif,.png,.docx,.mp4,.zip,.pdf
.jpg,.gif,.png,.docx,mp4,zip,pdf
Setting sensible defaults
Although the File Types, Max Files & Max File Size can be customized on a per question basis it's also possible to set global defaults for these fields. These defaults will be used when creating new file upload questions or editing existing questions before these fields were introduced. For assistance with setting these defaults please contact support.
User Experience
Typically, the path(s) of the uploaded files can be subsequently used in (e.g.) email attachments or can be returned to the host system. As part of your initial implementation (or upgrade), Support can advise how to access the Filepaths and URLs that are available for use, either within Keyfax or when returned to the host.
Here, the path is written to a Databox:
...which can then be specified as an email attachment:
Housekeeping
WIth potentially large amounts of disc storage required for uploaded files, automatic housekeeping jobs will run every night in order to delete old files. The retention period is configurable; please Contact Us for assistance with customizing your upload retention period.
Export Uploads
Files uploaded during a Keyfax script are exposed within the Keyfax export XML / JSON for host systems to consume. Examples of the exposed upload results can be seen below.
Example XML
Example JSON
Security
Although we whitelist the file type extension (configurable above in the File Type definition), we do not interrogate the file content to confirm the content type or perform any other checks. This should be further secured with 3rd party AV scanning software running on the file server.
Last updated