Skip to main content
Version: Current

Get Folder

Description

The Get Folder activity retrieves metadata for a specified folder in IB Drive.

The returned folder information can be used by downstream activities to reference or perform additional operations on the folder.


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 whose metadata is to be retrieved.

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.


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 specified IB Drive folder.

PropertyDescription
ItemIdThe unique identifier (GUID) of the folder in IB Drive.
NameThe name of the folder.
LocationThe logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing/Input.
ParentIdThe unique identifier (GUID) of the parent folder containing this 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 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 that require a reference to an IB Drive folder.


Remarks

  • The specified folder must exist in IB Drive when the activity executes.
  • The activity retrieves folder metadata without modifying the folder or its contents.
  • When using By Path, specify the logical path of the folder within IB Drive.
  • The returned ItemId can be used by downstream IB Drive activities that support identifying a folder using By Id.