This file upload field works with Amazon S3 and you'll need S3 storage in your hosting package to be able to use it.
The field allows multiple file uploads (without zipping them as per the standard upload field) and because files are streamed client-side to S3 it can handle far larger files than the standard field.
Uploaded files are listed beneath the field and can be removed individually. Extra files can also be uploaded.
Field Value
As files are uploaded they are stored in a temporary directory. When the page this field is on is submitted, the field value includes file store references for each file, which are used by other elements of the platform to retrieve the file.
Where multiple files are uploaded, the field value is a comma separated list, for example:
When files are passed to a workflow process, the
{
"form_FIELD30": [
{
"id": "886C6D64-8505-4388-8037-7FE1C329DF4A",
"filename": "example1.png"
},
{
"id": "0CB4895D-DCD2-4E00-9A4A-461435D748C5",
"filename": "example2.png"
}
]
}
S3 Credentials
You'll need to add an Amazon S3 bucket to your hosting package to be able to use this field. Contact your account manager so we can set this up.
Browser JavaScript
This field requires users to have JavaScript enabled in their browser. It will display a warning message if JS is disabled.
Properties
| Label | Description | Type Name |
|---|---|---|
| Label | The label for this field | LABEL |
| Show Label | Whether to show the label for this field or not. This property adds/removes a class on the field's label element - the styling itself is controlled by the site's style sheet | SHOWLABEL |
| Hint | Additional information displayed alongside the field to assist the user in completing it. The value of another field can be used by adding the field's name between # characters. See Common Field Properties for more information | HINT |
| Required | Whether or not the field is required to have a value to pass validation | REQUIRED |
| Maximum File Size | Browser side validation that prevents users uploading files greater than the set size. The default options are 1MB, 2MB, 5MB and 10MB. You can also enter your own value, which can include decimals and one suffix from B|KB|MB|GB. If no suffix is set bytes are assumed. A blank or 0 value means there is no restriction. If you allow multiple file uploads this limit applies to each file | UPLOADLIMIT |
| Maximum Files | The maximum number of files that can be uploaded in this field | MAXFILES |
| Download Link | Display a download link for the uploaded file when navigating backwards through a form to a previously uploaded file and when editing form data | DOWNLOADLINK |
| Error Message | The error message that will be displayed if this field fails its validation | ERRMSG |
| Error Message Function | A function that can be used to override the default error message. You can return a different message for each error type. The message can include the value of another field by adding the field's name between # characters. See Error Message Functions for more information. This field has the following error types:
| ERRMSGFUNC |
| Width | The display width of the field. The value matches a CSS class, which actually sets the width | WIDTH |
| Require Media Capture | This property is designed for mobile devices. Set this as true to launch the phone's camera or microphone from the file upload field, instead of the file picker. On most devices this will also prevent the phone from being able to access their existing photos etc (ie it will only launch the camera). The Acceptable File Type property can also be set to prompt the phone for the type of file you're expecting | CAPTURE |
| Acceptable Types | This property prompts a user's device for the type of file you are expecting. The types in the list (PDF, Audio, Image etc) can be used with the Media Capture setting to suggest to mobiles to open the camera app etc. It will also prompt, for example on Windows machines, the file explorer window to only show files of the specified type. However, this property doesn't perform validation or restrict the type of file that can be uploaded, it's simply a prompt. Picking "Use validated file types" will use the file extensions set in the Validated File Types property below. This performs the same prompting as picking an option from the list | ACCEPT |
| Validated File Types | If you pick "Use validated file types" above, these options come into play. A comma separated list of allowed file types. If a user attempts to upload a file type not in the list, validation will fail. For example, to restrict the file upload to jpg and png files, enter | ACCEPTVALIDATED |
| Validation Function | A JavaScript function that can be used to provide custom field validation whenever the field value changes or the form is submitted. This function will be executed client-side, provided JavaScript is enabled in the browser, and repeated server-side | VALFUNC |
| Handlers | A JavaScript function that is executed client-side whenever the page loads, or the field value changes. This function is useful for modifying the values of other fields based on an entered value | HANDLERS |
| Read Only | Display the field as read only | READONLY |
| Additional Styling Modifier | An optional CSS modifier for the field. See Common Field Properties for an example | ADDITIONALSTYLINGMODIFIER |
| Described By | Links this form field to another element on the page that provides a more detailed description or instructions. Enter the name of a Guidance Text or HTML field that describes this field. The text in that field will be read out by screen readers whenever this field receives focus. See Common Field Properties for more information | DESCRIBEDBY |
| Documentation | Add documentation to your field to help explain any complex functionality to future users. You might include information on what the field does and how it relates to other fields on the form. Notes added here are only ever visible in the Forms Designer, they can be searched for, viewed and downloaded from the action panel. See Common Field Properties for an example | DOCUMENTATION |
