Document Modelling | Version 4

File Upload

Learn more about the string field type "File Upload".

The input field type File Upload allows the user to transfer a file to a FTP server. In the property configuration, the server and a folder have to be configured. The user can select a local file that will be uploaded to the configured location. File uploads run in the background an can be canceled. Once the upload is finished, the remote path will be stored in the property of the document.

Parameters
ParameterDescriptionDefault ValuePossible Values
Target ServerThe address of the FTP server to which files will be uploaded. Optionally, you can additionally specify a port. If you don't, the well-known port for FTP (21) will be used.localhost:21Hostnames or IPv4 addresses, optionally ending with :port.
Target FolderThe folder on the FTP server to which the files should be saved..A file path on the server. It may contain placeholders (see below).
Target FilenameThe filename under which the files will be stored.${filename}A string which the selected server will accept as a filename. May contain placeholders.
UsernameThe username to log in to the FTP server.anonymousArbitrary text. Ideally a username which exists on the server.
PasswordThe password for the given user to log in to the FTP server.guestArbitrary text. Ideally the password of the selected user.
Character EncodingThe character encoding to be used by the FTP control connection.ISO-8859-1Valid character encodings for FTP.
Placeholders
PlaceholderDescription
${creationDate}The creation date of the document, in the form YYYY-MM-DD. If the document has not been saved yet, the current date is used.
${creationDate:day}The day of the creation date of the document (two digits). If the document has not been saved yet, the current date is used.
${creationDate:month}The month of the creation date of the document (two digits). If the document has not been saved yet, the current date is used.
${creationDate:year}The year of the creation date of the document (four digits). If the document has not been saved yet, the current date is used.
${externalId}The external ID of the document. If the document has not been saved yet, a random string is used.
${fileName}The name of the file being uploaded (only valid for the Target Filename parameter).
${fileExtension}The filename extension of the file being uploaded (only valid for the parameter Target Filename).
Browser Tab parametersSee here

Last modified on 10/16/20

The content of this page is licensed under the CC BY 4.0 License. Code samples are licensed under the MIT License.

Icon