File transfer and archives

Applies to 1.0.0. Tasks → New/Edit → plugin FILE_TRANSFER.

Before you start

Use ADMIN to create, configure and save tasks. ADMIN or OPERATOR can execute published definitions; ADMIN reads detailed logs and input/output variables. Resources must be enabled and reachable from the execution node. See tasks for common timeout, retry and version settings, and the permission matrix.

Field reference

“Default” means the initial value of a new 1.0.0 form. An empty value means the field has not been filled in; required fields still need a value. Visibility follows the selected branch; conditional requirements apply only to that branch.

Transfer and publication

• Transfer mode: Choose read-only access or transfer to a target.
• Source file resource: Provide the source file location and access configuration.
• Target file resource: Provide the upload target location and access configuration.
• Source directory (optional): Select the source directory within the resource path constraints.
• Target directory (optional): Select the target directory within the resource path constraints.
• File pattern: Filter files to read or transfer.
• Recursive: Include matching files in subdirectories when enabled.
• Decompress after download: Choose the decompression format after download.
• Compress before upload: Choose the compression format before upload.
• Remote publication: Choose direct writes or temporary-file publication followed by rename; capabilities depend on the target protocol.
• Overwrite existing files: Choose whether existing target files may be overwritten.
• Delete source after success: Delete source files after success; cross-system copy and deletion do not form one transaction.
• Archive name (optional): Name the output archive for applicable compression formats.
• Compression level: Set the ZIP compression level.

Execution limits

• Maximum scan depth: Maximum recursive directory depth, 0–64.
• Scan entry limit: Maximum directory and file entries scanned per task, 1–100000.
• Source file limit (bytes): Per-source-file byte limit, 1–1073741824.
• Source total limit (bytes): Cumulative source byte limit, at least the per-file limit and at most 10737418240.
• Staging limit (bytes): Cumulative staging-byte limit, 1–21474836480.
• Extraction entry limit: Maximum extracted entries, 1–100000.
• Extracted entry limit (bytes): Per-extracted-entry byte limit, 1024–1073741824.
• Extraction total limit (bytes): Cumulative extracted-byte limit, at least the per-entry limit and at most 10737418240.
• Maximum compression ratio: Maximum allowed extraction compression ratio, 1–1000.

Behavior and boundaries

• READ_ONLY does not upload files and cannot delete source files.
• TEMP_RENAME depends on the target protocol and does not guarantee atomic publication for every target.
• With deleteSource=true, source and target cannot be the same resource; cross-system copy and deletion do not form one transaction.

The new form selects TEMP_RENAME; older configuration without remotePublishMode falls back to DIRECT. Choose explicitly for the target protocol and inspect temporary/final files after failures.

Typical configuration: Copy CSV files between isolated directories

Fill in the form below, replacing resource names with your enabled resources. This is a configuration guide, not importable JSON. Follow the tutorial linked below for data preparation and execution.

Prepare CSV files in the source directory and a separate empty target directory; the executing Worker must be able to access both LOCAL directories.

Expected result: Corresponding target files exist with matching contents/hashes, and source files remain.

Follow the full tutorial. Save the definition before running it; inspect execution state and business results separately.

Actual interface

Configuration keys

Use these keys when inspecting imported configuration, API payloads or errors. [] denotes a collection item; the form does not require you to enter key names.

Related pages

Tasks and versions · Parameters and expressions · Scenario tutorials