Login to follow
Upload Core

Upload Core (ODC)

Stable version 1.0.0 (Compatible with ODC)
Uploaded on 15 May 2024 by Kiandra IT
Upload Core

Upload Core (ODC)

Documentation
1.0.0

Upload Core is an application with Service Actions and a REST API for uploading files in chunks, optionally asynchronously.

It is currently used by the FilePondUpload library.

In order to upload a file, call

  1. SendFileChunksStart, which will return a Token for identifying the file.
  2. SendFileChunk for each chunk of the file. Throws an exception if the chunk has already been uploaded.
  3. SendFileChunksVerify to verify the file was uploaded correctly. Throws an exception if not valid.
  4. Then call Upload_GetUploadedFile passing the Token to retrieve the uploaded file. The file will be deleted from temporary storage unless Remove is specifically set to False. If the file is not found Exists will be returned as False.

File chunks are stored in the database in a temporary table while the file is being uploaded.

The upload will handle file chunks delivered in any order, and store them in the correct order. This relies on the ChunkNumber being correct for the part of the file being uploaded.


Settings

TraceLog (Boolean) Defaults to False. If set to True, will log server-side messages.

UploadFileExpiryMinutes (Integer) Upload files are removed if they are older than this number of minutes

UploadFileTimeoutSeconds (Integer) The timeout for the server action called from the client that uploads a file chunk. Valid values are 30, 60, 120, and 180. Any other values will fail. SendFileChunk ignores this setting. However, SendFileChunk30, SendFileChunk60, etc validates it and with throw an exception if the configured value does not match eg If configured to 180, and SendFileChunk60 is called an exception will be thrown, but SendFileChunk180 and SendFileChunk will not throw an exception.