Skip to main content
Version: Current

Move Folder

Description​

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

The source folder can be identified using either a Folder Reference or a remote folder path.

After a successful move, the activity returns a Folder Reference representing the folder 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 Folder​

The folder to move.

You can provide either:

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

Examples:

  • /data/reports
  • /archive/2024

When a remote path is used, you can browse the remote directory structure using the path browser, which connects through the selected SFTP connection.

Destination​

The destination location for the folder.

Specify either:

  • A destination folder path.
  • A parent folder into which the source folder should be moved.

Examples:

  • /archive
  • /archive/reports
  • /archive/2024/reports
info

If the destination does not already include the source folder name, the source folder name is appended automatically.

For example, moving /data/reports to /archive results in /archive/reports.

If the destination is specified as /archive/reports, the path is used as provided.

Overwrite​

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

When disabled, the activity faults if a folder 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 folder to /archive/2024/reports automatically creates any missing parent folders 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​

Folder Reference​

A Folder Reference to the folder at its new location. Folder References are an IB-X file system abstraction and can be passed directly to other activities that accept folder inputs, regardless of the underlying storage provider.

PropertyDescription
NameThe folder name (for example, reports).
Full PathThe complete path of the folder at its new location on the SFTP server.
Last ModifiedUTC date and time the folder was last modified. May be empty if the SFTP server does not provide this information.

Remarks​

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