Get Queue Items

UiPath.Core.Activities.GetQueueItems

Description

Enables you to retrieve a list of up to 100 transactions from an indicated Orchestrator queue, according to multiple filters, such as creation date, priority, state, and reference. Obtaining a different set is possible with the use of Pagination properties.

An example of how to use this activity is available here.

Project compatibility

Windows - Legacy | Windows | Cross-platform

Cross-platform, Windows configuration

• Orchestrator Folder Path - The path of the folder where 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".

  Note:

  The Orchestrator Folder Path parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.

  Relative folder paths are supported in an X-UIPATH-FolderPath-Encoded header, as follows:

  -right: Path starting with / - starts from the root folder of the tree the ambient folder is part of.

  -right: Path starting with . - starts from the ambient folder.

  -right: Path starting with .. - starts one level up in the hierarchy of the ambient folder for each .. in the path (e.g. ../ for one level up, ../../ for two levels up in the hierarchy).

  Note that trailing slashes are not accepted.

• Queue Name - The name of the queue you want to extract data from. The name has to be the same as the one in Orchestrator and needs to have the same capitalization.

Advanced options

Options

• Duration - Filters transactions by the minimum time they spent in the previous attempt.
• From - Filters transactions by the minimum creation date. It accepts DateTime values.
• To - Filters transactions according to the maximum creation date. It accepts DateTime values.

• Priority - Filters transactions according to their priority. This field supports only integers and integer variables. The priorities are as follows:

  • 0 - High;
  • 1 - Normal;
  • 2 - Low.

• QueueItemStates - Filters the queue item states. The following options are available:

  • All - The default option.
  • New
  • InProgress
  • Failed
  • Successful
  • Abandoned
  • Retried
  • Deleted

• FilterStrategy - 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 - Filters Orchestrator queue items by reference.
• Skip - Helps you skip the first "n" items. This property supports only integers and integer variables.
• Top - Returns only a specified number of items out of the total. The maximum value is 100. This property supports only integers and integer variables.
• Timeout (milliseconds) - 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).
• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (true, false). The default value is false. As a result, if the field is not configured and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.

Output

• Queue Items - The list of items that you want to mark as retrieved from Orchestrator. This property supports only IEnumerable<QueueItem> variables.

Windows - Legacy configuration

Properties panel

Common

• Continue On Error - Specifies if the automation should continue even when the activity throws an error. This field only supports Boolean values (true, false). The default value is false. As a result, if the field is blank and an error is thrown, the execution of the project stops. If the value is set to true, the execution of the project continues regardless of any error.
• DisplayName - The display name of the activity.
• Timeout (milliseconds) - 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).

Input

• Queue Name - The name of the queue you want to extract data from. The name has to be the same as the one in Orchestrator and needs to have the same capitalization.

Misc

• Folder Path - The path of the folder where 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".

  Note:

  The FolderPath parameter does not work for processes executed by robots in classic folders. Only robots in modern folders have the ability to pass data outside of their folder.

  Relative folder paths are supported in an X-UIPATH-FolderPath-Encoded header, as follows:

  -right: Path starting with / - starts from the root folder of the tree the ambient folder is part of.

  -right: Path starting with . - starts from the ambient folder.

  -right: Path starting with .. - starts one level up in the hierarchy of the ambient folder for each .. in the path (e.g. ../ for one level up, ../../ for two levels up in the hierarchy).

  Note that trailing slashes are not accepted.

• Private - If selected, the values of variables and arguments are no longer logged at Verbose level.

Options

• Duration - Filters transactions by the minimum time they spent in the previous attempt.
• From - Filters transactions by the minimum creation date. It accepts DateTime values.

• Priority - Filters transactions according to their priority. This field supports only integers and integer variables. The priorities are as follows:

  • 0 - High;
  • 1 - Normal;
  • 2 - Low.

• QueueItemStates - Filters the queue item states. The following options are available:

  • All - The default option.
  • New
  • InProgress
  • Failed
  • Successful
  • Abandoned
  • Retried
  • Deleted
• To - Filters transactions according to the maximum creation date. It accepts DateTime values.

Output

• Queue Items - The list of items that you want to mark as retrieved from Orchestrator. This property supports only IEnumerable<QueueItem> variables.

Pagination

• Skip - Helps you skip the first "n" items. This property supports only integers and integer variables.
• Top - Returns only a specified number of items out of the total. The maximum value is 100. This property supports only integers and integer variables.

Reference

• FilterStrategy - 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 - Filters Orchestrator queue items by reference.