Get Folders
Description
The Get Folders activity retrieves folders from a specified IB Drive folder.
The activity returns a collection containing metadata for the retrieved folders.
Common Capabilities
Process Data Support
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 from which folders are to be retrieved.
The folder can be specified using one of the following methods:
| Method | Description |
|---|---|
| Select Directory | Select the folder by browsing IB Drive using the folder picker. |
| By Id | Specify the unique IB Drive item ID of the folder. This is the default method. |
| By Path | Specify the logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing. |
The value can also be provided dynamically using workflow data.
Limit
Specifies the maximum number of folders to return.
The default value is 50.
For example, if the specified folder contains 100 folders and the Limit is set to 50, the activity returns a maximum of 50 folders.
Wait All Incoming
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
Defines how the workflow behaves if this activity encounters a runtime error.
Supported strategies include Fault, Continue, Suspend, and Retry.
Outputs
Folders
Returns a collection containing metadata for the folders retrieved from the specified IB Drive folder.
Each folder in the collection contains the following properties:
| Property | Description |
|---|---|
| ItemId | The unique identifier (GUID) of the folder in IB Drive. |
| Name | The name of the folder. |
| Location | The logical path of the folder within IB Drive. |
| ParentId | The unique identifier (GUID) of the parent folder containing the folder. |
| Size | The size associated with the folder. For folders, this is typically 0. |
| ContentType | The content type associated with the folder, if applicable. |
| Created | The UTC date and time when the folder was created in IB Drive. |
| Modified | The UTC date and time when the folder was last modified. |
If no folders are found, the activity returns an empty collection.
The returned folder metadata can be used by downstream activities that require references to IB Drive folders.
Error Message
Returns information about any errors encountered while enumerating folders from the specified IB Drive folder.
If no enumeration errors occur, no error message is returned.
This output can be used by downstream activities to inspect or handle errors that occurred while retrieving the folders.
Remarks
- The specified folder must exist in IB Drive when the activity executes.
- The activity retrieves folder information without modifying the folders or their contents.
- The Limit property controls the maximum number of folders returned by the activity.
- When using By Path, specify the logical path of the folder within IB Drive.
- If errors occur while enumerating folders, details are available through the Error Message output.
- The ItemId of a returned folder can be used by downstream IB Drive activities that support identifying folders using By Id.