Get Files
Description
The Get Files activity retrieves files from a specified IB Drive folder.
The activity returns a collection of IB-X File References that can be used by downstream activities that accept file inputs.
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 files 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/Input. |
The value can also be provided dynamically using workflow data.
Limit
Specifies the maximum number of files to return.
The default value is 50.
For example, if the specified folder contains 100 files and the Limit is set to 50, the activity returns a maximum of 50 files.
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
Files
Returns a collection of IB-X File References representing the files retrieved from the specified IB Drive folder.
Each File Reference provides access to the file and its associated metadata.
| Property | Description |
|---|---|
| ItemId | The unique identifier (GUID) of the file in IB Drive. |
| Name | The name of the file, including its file extension. |
| Location | The logical path of the file within IB Drive. |
| ParentId | The unique identifier (GUID) of the parent folder containing the file. |
| Size | The size of the file in bytes. |
| ContentType | The MIME type of the file, for example application/pdf or text/plain. |
| Created | The UTC date and time when the file was created in IB Drive. |
| Modified | The UTC date and time when the file was last modified. |
The returned File References can be passed to compatible downstream activities that accept File Reference inputs.
If no files are found in the specified folder, the activity returns an empty collection.
Error Message
Returns information about any errors encountered while enumerating files from the specified IB Drive folder.
If the enumeration completes without errors, this output is empty.
This output can be used by downstream activities to inspect or handle errors that occurred while retrieving the files.
Remarks
- The specified folder must exist in IB Drive when the activity executes.
- The activity retrieves files without modifying their contents or locations.
- The Limit property controls the maximum number of files returned by the activity.
- When using By Path, specify the logical path of the folder within IB Drive.
- The returned File References can be passed to compatible downstream activities without requiring local file system paths.