The Upload File Field allows the user to upload a file by dragging and dropping the file in the upload file field, or by browsing their computer and selecting the file to upload.
Buttons to download and/or clear the file can be configured to display when a file is uploaded.
When an image is uploaded, an additional button will be displayed to open the image in a popup window. An image thumbnail can also be configured to display when an image is uploaded.
When a PDF file is uploaded, an additional button will be displayed to view the PDF in a popup window.
A video player can be configured to display when a video file is uploaded, and an audio player can be configure to display when an audio file is uploaded.
The Upload File Field also supports the use of integration and migration targets.
Storage Location
Specifies the storage location defined at the workspace level where the uploaded file will be saved.
Max File Size (MB)
Specifies the maximum file size allowed for upload, measured in megabytes. If a user attempts to upload a file larger than this limit, the upload will fail. It is recommended to inform the user of the maximum file size through one of the description fields.
Allowed File Types
To restrict the types of files that can be uploaded, a comma-separated list of permitted file extensions can be specified. For example, to permit only PNG, GIF, and XML files, the field should be populated with .png,.gif,.xml.
If left empty, no restrictions will be applied, and all file types will be accepted.
Use Uploaded File as Workspace Icon
If Workspace Cards are in use, setting this option to “Yes” will ensure that the uploaded file is used as the image for the card associated with the workspace. If the uploaded file is removed, the workspace card icon will also be updated accordingly. The icon will be synchronized with the file uploaded to this field.
The file will be used for the workspace card only if it meets the following criteria: it must be an image, the storage location must be public, and Workspace Cards must be enabled. If any of these conditions are not met while this field is set to “Yes,” errors will be logged in the Application Logs.
It is advisable to have only one field that synchronizes with the workspace icon.
Enable File Compression
Determines whether the file will be compressed before uploading, which reduces the size of large files. It is advisable to set this option to “Yes” if large files are expected to be uploaded.
Enable File Encryption
Only applicable when “Enable File Compression” is set to “Yes”.
Determines whether the compressed file will be encrypted before uploading. Enabling encryption ensures that the file remains secure and protected during transmission. It is recommended to activate this option if sensitive data is included in the file.
Upload Button Text
Overrides the text on the button to upload a file. This should be a short phrase that clearly states what will happen when the user clicks the button. If this field is left blank, the default button text will be “Drag and drop or click to upload”.
Upload Button Icon Class
Should the upload icon be overridden by a different icon? If so, the icon can be specified here using CSS classes.
For example, if using FontAwesome’s light cloud icon, fa-light fa-cloud would be entered in this Field.
Display Download Button
Determines if the download button will be visible. This button allows users to download the file once a file has been uploaded.
Display Copy File URL Button
Determines if the copy file URL button will be visible. This button allows users to copy the file URL once a file has been uploaded.
Display Clear Button
Determines if the clear button will be visible. This button allows users to clear the uploaded file once a file has been uploaded.
Clear Button Text
Only applicable when “Display Clear Button” is set to “Yes”.
Overrides the text on the button that clears the file upload. This should be a short phrase that clearly states what will happen when the user clicks the button. If this field is left blank, the default button text will be “Clear File”.
Display Image Thumbnail
Determines if a thumbnail will be rendered if an image is uploaded. If set to “Yes”, a preview of the image will be rendered on the page when an image is successfully uploaded.
Display Audio Player
Determines if an audio player will be displayed if an audio file is uploaded. If set to “Yes”, an audio player will be displayed on the page when an audio file is successfully uploaded.
Display Video Player
Determines if a video player will be displayed if a video file is uploaded. If set to “Yes”, a video player will be displayed on the page when a video is successfully uploaded.
Autoplay Video
Only applicable when “Display Video Player” is set to “Yes”.
Determines if the video player will automatically start playing once it’s loaded.
Video Player Height
Only applicable when “Display Video Player” is set to “Yes”.
Determines the height of the video player in pixels. The recommended aspect ration for video players is 16:9.
Video Player Width
Only applicable when “Display Video Player” is set to “Yes”.
Determines the height of the video player in pixels. The recommended aspect ration for video players is 16:9.
Enable Integration Targets
Determines if the use of integration targets will be permitted. If set to “Yes”, a field to select the import target will appear once a file has been successfully uploaded.
Select Import Target Placeholder Text
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines the placeholder text that is displayed when the import target has not yet been selected in the “Select Import Target” field. This is used to prompt the user with instructions on what to do with the field. If this field is left blank, the default text will be “Select your import type”.
Import Button Text
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines the text on the import button. This should be a short phrase that clearly states what will happen when the user clicks the button. If this field is left blank, the default button text will be “Load”.
Integration Targets
Only applicable when “Enable Integration Targets” is set to “Yes”.
Specifies the integration targets that will appear in the list of available integration targets for the user to select from.
Confirm Import
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines whether there should there be a confirmation window popup when a user is trying to do an import.
Confirm Import Window Content
Only applicable when “Confirm Import” is set to “Yes”.
Defines the text that will appear in the confirmation window popup when a user is trying to do an import. This should ask the user to confirm that they want to proceed with this action.
Confirm Undo Import
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines whether there should there be a confirmation window popup when a user is trying to undo an import.
Import Undo Button Label
Only applicable when “Confirm Undo Import” is set to “Yes”.
Defines the text on the undo import button. This should be a short phrase that clearly states what will happen when the user clicks the button.
Confirm Undo Window Content
Only applicable when “Confirm Undo Import” is set to “Yes”.
Defines the text that will appear in the confirmation window popup when a user is trying to undo an import. This should ask the user to confirm that they want to proceed with this action.
Import Support Role
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines the administrator roles that have access to view the list of errors when an error occurs during an import (for example: if rows in dataset that are configured incorrectly or missing data).
Contact Support Button Text
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines the text on the button to contact support. This button will be displayed if an error occurs during an import, and the user does not have one of the import support roles. This should be a short phrase that clearly states what will happen when the user clicks the button.
View Errors Button Text
Only applicable when “Enable Integration Targets” is set to “Yes”.
Defines the text on the button to view the import errors. This button will be displayed if an error occurs during an import, and the user has one of the import support roles. This should be a short phrase that clearly states what will happen when the user clicks the button.
Enable Migration Targets
Determines if the use of migration targets will be permitted. If set to “Yes”, a field to select the migration target will be displayed under the upload field.
Select Export Placeholder Text
Only applicable when “Enable Migration Targets” is set to “Yes”.
What should the placeholder text be for the select export target? This is used to prompt the user with instructions on what to do with the field. If this field is left blank, the default text will be “Select a migration Target”.
Export Button Text
Only applicable when “Enable Migration Targets” is set to “Yes”.
Defines the text on the export button. This should be a short phrase that clearly states what will happen when the user clicks the button. If this field is left blank, the default button text will be “Call API”.
Outbound Migration Targets
Only applicable when “Enable Migration Targets” is set to “Yes”.
Specifies the migration targets that will appear in the list of available migration targets for the user to select from.
