Skip to main content
Version: Current

Upload File

Description​

Uploads a file to a remote FTP server.

The source file is provided using a File Reference, allowing files from any supported IB-X storage provider or file-producing activity to be uploaded to the FTP server.

After a successful upload, the activity returns a File Reference representing the uploaded file on the FTP server.

Common Capabilities​

Process Data Support​

info

This activity supports dynamic configuration using variables from the Process Data drawer.

You can bind values from Model Data, Form Data, System Data, Enterprise Variables, and Activity Outputs.

Learn more → Using Process Data

Design-Time Configuration​

Connection Name​

The name of the configured FTP connection used to authenticate with the remote server.

If no connection exists, click Add Connection to create one inline.

Learn more → FTP Connection

File​

A File Reference identifying the file to upload. Required.

File References are an IB-X file system abstraction and can originate from any activity that produces a file, regardless of the underlying storage provider.

Examples include:

  • Get File
  • Download File
  • Read Email Attachment
  • Generate File activities
  • Other file-producing activities

Destination​

The destination location on the FTP server. Required.

Specify either:

  • A complete destination file path.
  • A destination folder path.

Examples:

  • /uploads/report.csv
  • /archive/2024/report.xlsx
  • /uploads/
info

If the destination does not include a file name, the original file name is preserved automatically.

For example, uploading report.csv to /uploads/ results in /uploads/report.csv.

You can browse the remote directory structure using the path browser, which connects through the selected FTP connection.

Overwrite​

When enabled, an existing file at the destination location is replaced.

When disabled, the activity faults if a file already exists at the destination.

Defaults to on.

Create Missing Directories​

When enabled, any missing parent directories in the destination path are created automatically.

Defaults to on.

info

For example, uploading a file to /archive/2024/reports/report.csv automatically creates any missing folders in the path if they do not already exist.

Wait All Incoming​

Execution Control

Controls how this activity behaves when multiple incoming execution paths converge.

Determines whether the activity executes when:

  • any incoming path completes, or
  • all relevant paths have completed before execution

Learn more → Execution Control

On Error​

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include Fault, Continue, Suspend, and Retry.

Learn more → Error Handling

Output​

File Reference​

A File Reference to the uploaded file on the FTP server. File References are an IB-X file system abstraction and can be passed directly to other activities that accept file inputs, regardless of the underlying storage provider.

PropertyDescription
NameThe file name (for example, report.csv).
Full PathThe complete path of the uploaded file on the FTP server.
SizeThe file size in bytes. May be empty if the FTP server does not provide this information.
Last ModifiedUTC date and time the file was last modified. May be empty if the FTP server does not provide this information.

Remarks​

  • The source file is not modified or deleted after upload.
  • Metadata availability depends on the FTP server implementation.
  • Some FTP servers may not provide file size or modification date information.
  • If the destination file already exists and Overwrite is disabled, the activity faults.
  • Large file uploads may take longer depending on network conditions and FTP server performance.