Workflow Activities

Last updated Dec 20, 2024

ReadStorageText

Downloads a file from a specified Storage Bucket in Orchestrator and stores it in a string variable.

Definition

Namespace: UiPath.Activities.System.API

Assembly: UiPath.System.Activities.Api (in UiPath.System.Activities.Api.dll)

Overloads


`ReadStorageText(String, String)`	Returns the contents of a certain file in an Orchestrator storage bucket.
`ReadStorageText(String, String, String)`	Returns the contents of a certain file in an Orchestrator storage bucket, at a specified Orchestrator folder.
`ReadStorageText(String, String, String, String, Int32)`	Returns the contents of a certain file in an Orchestrator storage bucket, while inputting an encoding name, and configuring `TimeoutMS`.

`ReadStorageText(String, String)`

Returns the contents of a certain file in an Orchestrator storage bucket.

string ReadStorageText(
	string path,
	string storageBucketName
)string ReadStorageText(
	string path,
	string storageBucketName
)

path String: The path of the text you want to retrieve from the specified Storage Bucket. The file must exist in the source Orchestrator Storage container.
storageBucketName String: The name of the Storage Bucket the file is located in.

`ReadStorageText(String, String, String)`

Returns the contents of a certain file in an Orchestrator storage bucket, at a specified Orchestrator folder.

string ReadStorageText(
	string path,
	string storageBucketName,
	string folderPath
)string ReadStorageText(
	string path,
	string storageBucketName,
	string folderPath
)

path String: The path of the text you want to retrieve from the specified Storage Bucket. The file must exist in the source Orchestrator Storage container.
storageBucketName String: The name of the Storage Bucket the file is located in.
folderPath String: The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used.

Return value

String

The text retrieved from the specified Storage Bucket, stored in a String variable.

`ReadStorageText(String, String, String, String, Int32)`

Returns the contents of a certain file in an Orchestrator storage bucket, while inputting an encoding name, and configuring TimeoutMS.

string ReadStorageText(
	string path,
	string storageBucketName,
	string folderPath,
	string encoding,
	int timeoutMS
)string ReadStorageText(
	string path,
	string storageBucketName,
	string folderPath,
	string encoding,
	int timeoutMS
)

path String: The path of the text you want to retrieve from the specified Storage Bucket. The file must exist in the source Orchestrator Storage container.
storageBucketName String: The name of the Storage Bucket the file is located in.
folderPath String: The path to the Orchestrator Folder you want to use with this activity. If left empty, the current Orchestrator folder is used.
encoding String: The encoding name for decoding the file content. You can find the complete list of codes for each character encoding on the Supported Character Encoding page. If no encoding type is specified, the activity will search for the file's Byte Order Marks to detect the encoding. If no Byte Order Marks are detected, the system ANSI code page is selected by default.
timeoutMS Int32: Specifies the amount of time (in milliseconds) to wait for the activity to run before an error is thrown. The default value is 30000 milliseconds (30 seconds).