GetTransactionItem

Gets an item from the Orchestrator queue so that you can process it (start the transaction) and sets its status to In Progress. Starting its processing makes it a transaction. Note that to execute this method, the Robot role needs to have Edit permissions on queues. The method runs under the Robot which executes it.

If the queue is empty, the following error is thrown upon accessing the retrieved TransactionItem: System.Exception: Object reference not set to an instance of an object.

Definition

Namespace: UiPath.Activities.System.API

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

Overloads

GetTransactionItem(String)	Gets an item from the Orchestrator queue so that you can process it (start the transaction) and sets its status to In Progress.
GetTransactionItem(String, String)	Gets an item from the Orchestrator queue, and from a specified folder path, so that you can process it (start the transaction) and sets its status to In Progress.
GetTransactionItem(String, String, ReferenceFilterStrategy, String, Int32)	Gets an item from the Orchestrator queue, and from a specified folder path, along with other configurations, so that you can process it (start the transaction) and sets its status to In Progress.

GetTransactionItem(String)

Gets an item from the Orchestrator queue so that you can process it (start the transaction) and sets its status to In Progress.

QueueItem GetTransactionItem(
	string queueType
)

queueType String

The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was defined as "MyFirstQueue", it matches "myfirstqueue".

GetTransactionItem(String, String)

Gets an item from the Orchestrator queue, and from a specified folder path, so that you can process it (start the transaction) and sets its status to In Progress.

QueueItem GetTransactionItem(
	string queueType,
	string folderPath
)

queueType String

The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was defined as "MyFirstQueue", it matches "myfirstqueue".

folderPath String

The path of the folder where the specified queue is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

GetTransactionItem(String, String, ReferenceFilterStrategy, String, Int32)

Gets an item from the Orchestrator queue, and from a specified folder path, along with other configurations, so that you can process it (start the transaction) and sets its status to In Progress.

QueueItem GetTransactionItem(
	string queueType,
	string folderPath,
	ReferenceFilterStrategy filterStrategy,
	string reference,
	int timeoutMS
)

queueType String

The queue where the QueueItem object is to be added. The name is case insensitive, meaning that if in Orchestrator it was defined as "MyFirstQueue", it matches "myfirstqueue".

folderPath String

The path of the folder where the specified queue is located, if different from the folder where the process is running. This field only supports string values, with / as the separator to indicate subfolders. For example "Finance/Accounts Payable".

filterStrategy ReferenceFilterStrategy

The strategy to use when filtering according to reference. The following options are available:

• StartWith - looks for items whose references start with the value indicated in the Reference field.
• Equals - looks for items whose references are the same as the value indicated in the Reference field.

reference String

Filters items according to their reference.

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).

Return value

QueueItem

The retrieved TransactionItem.