Skip to main content
Version: Current

Get Folder

Description​

The Get Folder activity retrieves metadata for a specified folder in IB Drive.

The returned folder information can be used by downstream activities to reference or perform additional operations on the folder.


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 whose metadata is to be retrieved.

The folder can be specified using one of the following methods:

MethodDescription
Select DirectorySelect the folder by browsing IB Drive using the folder picker.
By IdSpecify the unique IB Drive item ID of the folder. This is the default method.
By PathSpecify the logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing/Input.

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​

Folder​

Returns an IB-X Folder Reference for the specified IB Drive folder. Bind the whole output to a compatible reference input, or use Id with an IB Drive By Id selector.

PropertyDescription
IdThe unique identifier (GUID) of the folder in IB Drive.
NameThe name of the folder.
LocationThe logical path of the folder within IB Drive, for example /Agents/InvoiceProcessing/Input.
ParentIdThe unique identifier (GUID) of the parent folder containing this folder.
SizeThe size associated with the folder. For folders, this is typically 0.
MimeTypeThe content type associated with the folder, if applicable.
CreatedThe UTC date and time when the folder was created in IB Drive.
ModifiedThe UTC date and time when the folder was last modified.

Bind Folder directly to a compatible Folder Reference input, or its Id to an IB Drive By Id selector.


Remarks​

  • The specified folder must exist in IB Drive when the activity executes.
  • The activity retrieves folder metadata without modifying the folder or its contents.
  • When using By Path, specify the logical path of the folder within IB Drive.
  • The returned Id can be used by downstream IB Drive activities that support identifying a folder using By Id.