Managing Queues in Orchestrator

Learn how to confgure queues in Orchestrator.

Creating a Queue

1. In the Queues page, click Add. The Create Queue window is displayed.
2. In the Name field, enter a name for the queue. The maximum value is 50 characters.
3. In the Description field, add a description for the queue. The maximum value is 250 characters.
4. In the Unique Reference field, select Yes or No, to indicate if you want transaction references to be unique or not.
5. In the Auto Retry field, select Yes or No to indicate if you want to use the auto-retry mechanism.
6. In the Max # of retries field, if you selected Yes at step 5, input the number of times you want a queue item to be retried when an Application Exception is encountered. By default, the value is 1. The maximum number of retries is 50.
7. Upload a JSON schema by using the corresponding Browse button.

   Field	Description
   Specific Data	File size limited to 256kb by default. Enables you to upload a JSON schema for the specific data of all transactions in the queue. All transactions added to the queue must adhere to the schema, or an error will be triggered, and the request to add the transaction will fail. Note: The uploaded schema is not enforced retroactively. Existing transaction items are not affected.
   Output Data	File size limited to 256kb by default. Enables you to upload a JSON schema for the output data of all transactions in the queue. If a transaction status is set to Successful, but its output data violates the schema, the transaction will fail with a Business Exception.
   Analytics Data	File size limited to 256kb by default. Enables you to upload a JSON schema for the analytics data of all transactions in the queue. If a transaction status is set to Successful but its output data violates the schema, then the transaction will fail with a Business Exception. Use of and validation of an Analytics Data schema requires Robots and Activities of version 19.10 or greater.

8. Enable SLA predictions if you want to better control the processing time of your items, and to asses what resources you need such that they meet their deadline. If SLA predictions are enabled, configure the following fields:
   • From the Process drop-down, select the process which handles the queue items, and then fill in the SLA value below. The maximum value is 90 days.
   • Enable Risk SLA if you want to define a buffer zone before the actual SLA, and fill in the value below. The risk SLA must be smaller than the SLA.
9. Click Add. The queue is created and displayed in the Queues page, yet it is empty.

You can populate queues either using Studio or on the Upload Items window. Processing items from a queue is only possible using Studio. For more information, see Managing Queues in Studio.

Displaying Transactions

In the Queues page, click More Actions > View Transactions. The Transactions page is displayed, containing only the items from the indicated queue.

Displaying Review Requests

In the Queues page, click on Review Requests to display all the queue items assigned for revision to the currently logged in user. The page allows for status changes, and managing item information.

Displaying the Queue Chart

To view the chart for a specific queue, click More Actions button, and then View Chart.

A line chart displays the transaction status evolution over a specific amount of time. The time period (last hour, day, week, 30 days) can be changed, and you can view the average execution time and the maximum number of retries.

Uploading Items Into a Queue

This section concerns adding items into a queue in Orchestrator. For details on how to do that through workflows in Studio, click here.

1. In the Queues page, click the corresponding More Actions button of your desired queue, and then Upload Items. The Upload Items window is displayed.
2. Click Browse and select the desired .csv file.
3. Click Upload. If your file is compliant with thesupported formatting rules, the upload operation is successful.
4. Select the upload strategy.
5. Click Upload. The items are added into your queue according to the previously selected strategy.
6. If you used the Process All Independently option and there are unprocessed items, the Upload button becomes Download and enables you to download a .csv file containing the unprocessed items.

Monitoring a Queue

To monitor a queue, click the corresponding More Actions button and then Monitor Queue. Alternatively, select it from the Queues Overview widget (Monitoring > Queues).

Note that monitoring a queue requires your user to have View permissions on Queues and on Monitoring. Additionally, Edit on Monitoring is required in order to disable errors from the Error Feed widget on the Monitoring > Queues page.

Deleting a Queue

To delete a queue, click the corresponding More Actions button and then Remove.

Alternatively, select it from the Queues page and click Remove. The queue is no longer displayed in the Queues page.

Note: After a queue is deleted, assigned transaction items belonging to the queue are no longer visible in the Review Requests page.