UiPath Orchestrator Guide

About Queues and Transactions

A queue is a container that enables you to hold an unlimited number of items. Queue items can store multiple types of data, such as invoice information or customer details. This information can be processed in other systems - SAP or Salesforce, for instance.

In Orchestrator, newly created queues are empty by default. To populate them with items you can either use the upload functionality in Orchestrator, or Studio activities. The latter also enable you to change item statuses and process them. As soon as queue items are processed, they become transactions.

Queues Overview

Queues enable you to create large automation projects underlined by complex logic. For example, you can create a process that collects all invoice information and creates a queue item for each piece of data to store it. Subsequently, you can create another process that gathers the information from Orchestrator, and uses it to perform additional tasks, such as paying the invoices in a different application, postponing their payment according to their due date or value, sending emails to the accounting team every time a bill is paid, etc.

The Queues page enables you to create new queues. It also provides you with viewing access on previously created queues, charts with the transaction status progress over time, and on various other details, such as average execution time and the total number of successful transactions.

Item statuses are controlled by RPA developers when they create the automation projects, while revision statuses are controlled in Orchestrator and enable you to perform version control, but only of queue items that have been abandoned or have failed with an application or business exception.

Failed or abandoned items can also be assigned to a reviewer, which can be changed or cleared at any point, if needed. Each of these changes are tracked in the History tab of the Audit Details window. The reviewer is in charge of assessing the current status of the transactions he is assigned to, and changing the review status. The status of queue items up for revision can be changed in the Review Requests page.

Transactions Overview

The Transactions page displays the transactions from a given queue. It also shows their statuses, the dates when they should be processed, the Robot that processed them, and the type of exception thrown or assigned reference, if any.

You can search for a specific transaction or a group of them, according to a custom reference, which is added through the Reference property of the Add Queue Item and Add Transaction Item activities. The reference can be used to link your transactions to other applications used within an automation project. Additionally, this feature enables you to search for certain transactions in Orchestrator, according to the provided custom reference.

Transaction references can also be enforced to be unique, at queue level. This feature is enabled when creating the queue and applies to all transactions except deleted or retried ones. This makes identifying a specific item a breeze and eases the review process.

If a duplicate reference is encountered while adding items to a queue, the job fails with a Faulted status and displays the Execution error: UiPath.Core.Activities.OrchestratorHttpException: Error creating Transaction. Duplicate Reference. error message in the Job Details window.

Information stored in queue items is displayed in Orchestrator, in the Transaction Details window, under Specific Data. Additionally, if the item failed and was retried, the history of the item is displayed in the same window.

The Transaction Details window contains three tabs:

  • Details - enables you to view the exact information added to a transaction, as well as the statuses it went through, and the number of times it was retried.
  • Comments - enables you to view and add transaction-related comments in case you need to share information about a specific transaction with your teammates. All the users with View, Edit, and Delete permissions on Queues and Transactions can add, edit, or remove comments, respectively, however, keep in mind you can make changes to your own comments only.
  • History - enables you to see what action was performed by who, see who the reviewer is and what the review status is. For more information, see the Managing Transactions and Field Descriptions for Transactions pages.

Processing Order

Within any given queue the transactions are processed in a hierarchical manner, according to this order:

  1. Items that have a Deadline, as follows:
    a. in order of Priority; and
    b. according to the set Deadline for items with the same Priority.
  2. Items with no Deadline, in order of Priority.

When setting a Deadline or a Postpone date, we recommend populating the respective fields with relative dates. For example, DateTime.Now.AddHours(2), DateTime.Now.AddDays(10) and DateTime.Now.Add(New System.TimeSpan(5, 0, 0, 0)). Additionally, you can use the US notation to add an exact time, such as 10/10/2019 07:40:00. Automatic correction of this date is available, for example, if you write 12 10 2019 9:0, it is automatically transformed to 12/10/2019 09:00:00.

The dates added in Studio for the Deadline and Postpone fields, these are displayed in Orchestrator, in the Transactions page, under the Deadline and Postpone columns.

Exporting Transactions

You can export all the transactions and information related to a given queue to a .csv file, by clicking the Export button, in the Transactions page. All page filtering options apply to the generated file, too.

To ensure the best performance, please note that the exported entries are not in reverse chronological order.

Bulk Uploading Items

Enables you to bulk upload queue items into a specific queue, directly from a .csv file. To do that, first upload your file into your Orchestrator instance for a specific queue. After the file is successfully processed, the contained items are uploaded into the queue according to the selected strategy. Please note that the file must be populated beforehand using predefined formats so that the upload operation is successful.

Note

The upload is limited to 15,000 items per file. You can lower the limit using the Upload.Queues.MaxNumberOfItems parameter in web.config.

Column Mapping

File Column Header
Orchestrator Field

Reference
Mandatory for unique reference queues.
It supports all special characters, except double quotes - ".

Reference
Note: References are not compatible with v2016.2 or lower versions of Orchestrator or Robot.

Deadline
Must be populated with a date in one of the following formats:

  • YYYY-MM-DD
  • YYYY/MM/DD
  • YYYY MM DD
  • YYYY-MM-DD HH:mm
  • YYYY/MM/DD HH:mm
  • YYYY MM DD HH:mm
  • YYYY-MM-DD HH:mm:ss
  • YYYY/MM/DD HH:mm:ss
  • YYYY MM DD HH:mm:ss

DueDate

Postpone
Must be populated with a date in one of the following formats:

  • YYYY-MM-DD
  • YYYY/MM/DD
  • YYYY MM DD
  • YYYY-MM-DD HH:mm
  • YYYY/MM/DD HH:mm
  • YYYY MM DD HH:mm
  • YYYY-MM-DD HH:mm:ss
  • YYYY/MM/DD HH:mm:ss
  • YYYY MM DD HH:mm:ss

DeferDate

Priority
Must be populated with one of the following values:

  • Low or 1
  • Normal or 2
  • High or 3
    If the priority is not specified in the file, the items are uploaded with a high priority, by default.

Priority
Mapped to the following values, respectively:

  • Low
  • Normal
  • High

[Custom_Name]
The name can only be made of alphanumeric characters: 0-9, a-z, or underscores.

Specific Data
Mapped in JSON format.
For example:
On-Us Check: 5540

Please note that you cannot have empty column headers in your file. More details about field descriptions are available here.

Upload Strategies

There are two strategies of handling the upload:

  • ProcessAllIndependently - processes all items individually and adds them to the queue, if successful. If not, it returns a list of those whose processing failed. You have the option to download the list into a .csv file populated with the same fields as in the initially uploaded file.
  • AllOrNothing - adds the items only if all of them are successfully processed. Otherwise, none are added.


About Queues and Transactions


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.