Upload File
Description
The Upload File activity uploads a file to a specified folder in IB Drive.
The file can be uploaded using its original name or assigned a different name using the New File Name property.
If a file with the same name already exists in the target folder, the existing file is overwritten.
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 file to be uploaded to IB Drive.
Provide an IB-X File Reference representing the file to upload. The File Reference can be obtained from an upstream activity that produces a file output.
The value can also be provided dynamically using workflow data.
This property is required.
New File Name
Specifies an optional name for the uploaded file.
If a new file name is not specified, the original name of the input file is used.
When specified, include the appropriate file extension, for example ProcessedInvoice.pdf.
The value can also be provided dynamically using workflow data.
IB Drive file names:
- Can contain up to 255 characters.
- Cannot contain
\ / : * ? " < > |. - Cannot start or end with a space or period.
- Are case-insensitive within the same folder.
Target Folder
Specifies the IB Drive folder where the file will be uploaded.
The target folder can be specified using one of the following methods:
| Method | Description |
|---|---|
| Select Directory | Select the target folder by browsing IB Drive using the folder picker. |
| By Id | Specify the unique IB Drive item ID of the target folder. This is the default method. |
| By Path | Specify the logical path of the target folder within IB Drive, for example /Agents/InvoiceProcessing/Input. |
The value can also be provided dynamically using workflow data.
This property is required.
If a file with the same name already exists in the target folder, the existing file is overwritten.
The name used to determine a conflict is the New File Name, when specified; otherwise, the original name of the input file is used.
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
Uploaded File
Returns an IB-X File Reference representing the uploaded file in IB Drive.
The File Reference provides access to the uploaded file and its associated IB Drive metadata.
| Property | Description |
|---|---|
| Id | The unique identifier (GUID) of the uploaded file in IB Drive. |
| Name | The name of the uploaded file, including its file extension. |
| Location | The logical path of the uploaded file within IB Drive. |
| ParentId | The unique identifier (GUID) of the folder containing the uploaded file. |
| Size | The size of the uploaded file in bytes. |
| MimeType | The MIME type of the uploaded 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 Reference can be passed directly to downstream activities that accept File Reference inputs.
Remarks
Use the returned reference for subsequent operations on the resulting item. IB Drive paths are logical library paths, not physical paths on the workflow host. The conflict and naming rules above apply when the activity executes.