Skip to main content
Version: Current

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 Capabilities​

Process Data Support​

info

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.

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.

note

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:

MethodDescription
Select DirectorySelect the target folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the target folder. This is the default method.
By PathSpecify 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.

warning

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.

Wait All Incoming​

Execution Control

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​

Error Handling Strategy

Defines how the workflow behaves if this activity encounters a runtime error.

Supported strategies include Fault, Continue, Suspend, and Retry.

Learn more → Error Handling

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.

PropertyDescription
ItemIdThe unique identifier (GUID) of the uploaded file in IB Drive.
NameThe name of the uploaded file, including its file extension.
LocationThe logical path of the uploaded file within IB Drive.
ParentIdThe unique identifier (GUID) of the folder containing the uploaded file.
SizeThe size of the uploaded file in bytes.
ContentTypeThe MIME type of the uploaded file, for example application/pdf or text/plain.
CreatedThe UTC date and time when the file was created in IB Drive.
ModifiedThe 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​

  • The File input must contain a valid IB-X File Reference when the activity executes.
  • The specified target folder must exist in IB Drive.
  • If New File Name is not specified, the original name of the input file is used.
  • If New File Name is specified, it must comply with the IB Drive file naming rules.
  • If a file with the resulting name already exists in the target folder, the existing file is overwritten.
  • Uploading an existing file does not automatically generate a - Copy name.
  • The returned Uploaded File can be passed to compatible downstream activities that accept File Reference inputs.
  • When using By Path for the target folder, specify the logical path of the folder within IB Drive.