Skip to main content
Version: Current

Move File

Description​

Moves a file to a new location on a remote SFTP server.

The source file can be identified using either a File Reference or a remote file path.

After a successful move, the activity returns a File Reference representing the file at its new location.

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 SFTP connection used to authenticate with the remote server.

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

Learn more → SFTP Connection

Source File​

The file to move.

You can provide either:

  • A File Reference returned by a previous activity.
  • A Remote Path identifying the file on the SFTP server.

Examples:

  • /inbox/report.csv
  • /reports/2024/summary.xlsx

Destination​

The destination location for the file.

Specify either:

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

Examples:

  • /archive/reports/report.csv
  • /archive/reports/
info

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

For example, moving /inbox/report.csv to /archive/reports/ results in /archive/reports/report.csv.

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 off.

Create Missing Directories​

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

Defaults to on.

info

For example, moving a file to /archive/2024/reports/ 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 file at its new location. 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 file at its new location on the SFTP server.
SizeThe file size in bytes. May be empty if the SFTP server does not provide this information.
Last ModifiedUTC date and time the file was last modified. May be empty if the SFTP server does not provide this information.

Remarks​

  • Moving a file removes it from its original location.
  • The activity does not create a copy of the file.
  • Metadata availability depends on the SFTP server implementation.
  • Some SFTP servers may not provide file size or modification date information.
  • If the source file does not exist, the activity faults unless handled through the configured error strategy.
  • If the destination file already exists and Overwrite is disabled, the activity faults.