Get File
Description
The Get File activity retrieves a specified file from IB Drive and returns it as an IB-X File Reference.
The returned File Reference includes information about the file and can be passed to 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.
File
Specifies the IB Drive file to be retrieved.
The file can be specified using one of the following methods:
| Method | Description |
|---|---|
| Select File | Select the file by browsing IB Drive using the file picker. |
| By Id | Specify the unique IB Drive item ID of the file. This is the default method. |
| By Path | Specify the logical path of the file within IB Drive, for example /Agents/InvoiceProcessing/Input/Invoice.pdf. |
The value can also be provided dynamically using workflow data.
This property is required.
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
File
Returns an IB-X File Reference representing the specified IB Drive file.
The 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, for example /Agents/InvoiceProcessing/Input/Invoice.pdf. |
| 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. |
Using the File Reference
File Reference is the standard IB-X abstraction for representing files across activities.
The File output can be passed directly to downstream activities that accept a File Reference as an input, avoiding the need to download the file to the local file system.
Examples include:
- Document processing activities
- Email attachment activities
- AI activities that accept file inputs
- File management activities
- Other supported storage and integration activities
Remarks
- The specified file must exist in IB Drive when the activity executes.
- The activity retrieves a reference to the file and does not modify the file or its contents.
- When using By Path, specify the complete logical IB Drive path including the file name and extension.
- The returned File Reference can be passed to compatible downstream activities without requiring a local file system path.