Send Feedback
Skip to content

Upload

This page describes how to set up and configure the Upload component.

The Upload component supports uploading and downloading files to and from the server.

The Upload component gives a view of a directory on the server and supports uploading and downloading files to and from it. Files are stored in ~/delta-data/fileStore.

The following example shows a file upload in progress.

Screenshot

Set Up Upload

To set up an Upload component, click-and-drag the component into the workspace and configure the following:

  • Define the Server to which files are to be uploaded.
  • Define the file path Directory on the Server to which files are to be uploaded.

Refer to Upload properties described in the next section for details on additional properties.

Upload Properties

The following sections provides details on how to configure the properties of the Upload component.

Basics

Open the Basics properties on the right and configure the properties described in the following table.

Screenshot

Field Description
Name Enter a name for the component.
Port Number The port number used by the server.
Server The Server URL to which the files are uploaded. Uses localhost when no server URL is specified.

Screenshot

Field Description
Name Enter a name for the component.
Valid File Names A regex that determines if a file name is acceptable for upload. If undefined, all file names are accepted. For example, Log_\d{6} matches file names like Log_20200101.
Valid File Types A comma-separated list of acceptable file types for upload. If undefined, all file types are accepted. Types are specified as extensions or MIME types. For example: .csv, .pdf — CSV and PDF files; image/* — any image file; .csv, .pdf, image/* — CSV, PDF and any image type.
Upload File Size Rule / Upload File Size Rule Error Defines the maximum allowed file size for uploads (in MB), or a view state parameter. Files exceeding this size are rejected and the message defined in Upload File Size Rule Error is displayed. By default, this field is empty, meaning no file size limit is enforced.
Directory The subdirectory to use within the fileStore directory on the server.
Server A server connection with Type daemon. If set to <default> then files are uploaded to the DC server (or servers for a clustered deploy).
Download Enabled When checked, downloads are enabled.
Upload Enabled When checked, uploads are enabled.
Refresh Interval Time in seconds after which to fetch an updated list of files from the server. If set to 0 the file list is only fetched when the dashboard is loaded.

Action

This applies only if you're deploying KX Dashboards on Platform.

Refer to Actions for details.

Style

Refer to Style for common settings.

If deploying KX Dashboards on Platform

Screenshot

Field Description
Display Type Select either Table or Icons. Table is the default.

Icons view: Screenshot

Table view: Screenshot
Header Row Height / Row Height Set the row height, applicable in Table view.
Advanced CSS Refer to Advanced CSS for details.

Margins, Format

Refer to Style for common settings.

Further Reading