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 settings
Use Process Data to bind supported inputs to workflow values or upstream outputs. See Common Activity Features for shared execution, error-handling, and output-persistence settings. Availability depends on the activity.
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.
Execution settings
Configure Wait All Incoming when execution paths converge, and On Error for failure handling. Select Inherit where available to use the workflow-level error policy.
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 |
|---|---|
| Id | 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. |
| MimeType | 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.
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.
Example: Enumerate a folder
Select the parent Folder, set Limit to 50, and iterate over Files. Pass each current file reference to a compatible input, or bind its Id to an IB Drive selector using By Id.
Only immediate children are returned; nested folders are not traversed automatically. An omitted Folder selects the library root. Limit caps the number returned by this execution. These activities expose no page-number output or paging token; increase the limit or organize processing by parent folder when more items are required. Do not depend on an unspecified return order. Handle normal workflow failures through On Error. When used as a tool, inspect the inherited Error Message as well as the returned collection.