Skip to main content
Version: Current

Move Folder

Description

The Move Folder activity moves an existing folder and its contents in IB Drive from its current location to a specified target folder.

After the operation completes, the folder and its contents are available in the target location and are no longer available at their original 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

Display Text

Specifies a user-defined name for the activity.

The display text appears on the workflow canvas and can be used to identify the purpose of the activity.


Folder

Specifies the IB Drive folder to be moved.

The folder can be specified using one of the following methods:

MethodDescription
Select DirectorySelect the folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the folder. This is the default method.
By PathSpecify the logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing/Input.

The value can also be provided dynamically using workflow data.

This property is required.


Target Folder

Specifies the IB Drive folder to which the source folder will be moved.

The target folder can be specified using one of the following methods:

MethodDescription
Select DirectorySelect the target folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the target folder. This is the default method.
By PathSpecify the logical path of the target folder within IB Drive, for example /Agents/InvoiceProcessing/Archive.

The value can also be provided dynamically using workflow data.

This property is required.

warning

If a folder with the same name already exists in the target folder, the activity fails with an error.

The activity does not merge with or overwrite the existing folder, nor does it automatically generate a different name.


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 incoming paths complete 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


Outputs

Folder

Returns metadata for the folder at its new location in IB Drive.

PropertyDescription
ItemIdThe unique identifier (GUID) of the moved folder.
NameThe name of the moved folder.
LocationThe logical path of the folder at its new location in IB Drive.
ParentIdThe unique identifier (GUID) of the target folder containing the moved folder.
SizeThe size associated with the folder. For folders, this is typically 0.
ContentTypeThe content type associated with the folder, if applicable.
CreatedThe UTC date and time when the folder was originally created in IB Drive.
ModifiedThe UTC date and time when the folder was last modified.

The returned folder metadata can be used by downstream activities to perform additional operations on the moved folder.


Remarks

  • The source folder and target folder must exist in IB Drive when the activity executes.
  • The source folder, including its files and subfolders, is moved to the target location.
  • After the move operation completes, the folder and its contents are no longer available at their original location.
  • Moving a folder changes its location within IB Drive and does not create a separate copy.
  • If a folder with the same name already exists in the target folder, the activity fails with an error.
  • The activity does not merge with, overwrite, or automatically rename an existing folder in the target location.
  • When using By Path, specify the logical IB Drive path of the applicable folder.