Support Import

Queues

Queues can store multiple items. Queue items can be of three data types: text, numeric or custom object. The user can configure a Queue and the items it contains to be handled in multiple ways. The two main ways to configure are:

Sequential Queues - "Passive" use of Queues. Items are added in sequential order to the Queue. A Process can be executed manually to retrieve the first available item in the Queue and perform an action with it.

Transactional Queues - "Active" use of Queues. The Queue has been configured so that a Process is executed each time an item is added to the Queue. This configuration is achieved by checking the "Enable Automatic Distribution of Queue Items" box when and selecting the Process the items will trigger creating the Queue.

In the Settings > Queues Tab, click "New Queue" to create a new Queue. Click "Edit" to edit the existing Queues at any point.

When creating or editing a Queue, the Service Level Agreement settings (SLA) can be configured. These define the way that Queue Items of different priority (Low, Normal, High) will be handled for the specific Queue.

After clicking on the "New Queue" button, the user can specify the following in the new window that appears:

  1. The Name of the Queue.

  2. The Queue Item Type (Text, Numeric or Custom Object).

  3. Enable Automatic Distribution of Queue Items.

If this last option is checked [3], then every time an Item is added to the Queue, the "Process To Start" fires on the specified Execution Target (Robot or Robot Pool).

If this option is not checked then there will be no Process designated to run automatically once an Item is added. In this case, Users may manually run a Process to get an Item from the Queue and use the item to perform the desired actions.

newqueue_1_.png

Once a Queue is created, when the user clicks "Edit", only the "Process to Start" [4] and Execution Target [5] can be edited. The Name [1] and Queue Item Type [2] cannot be changed, as they might be in use by Processes in Production.

PLEASE BEAR IN MIND THAT PROCESSROBOT DOES NOT ALLOW THE EDITING OF THESE PROPERTIES IN ORDER TO PREVENT ACCIDENTAL MISCONFIGURATION.

editqueue2_1_.png

If it is absolutely necessary to change these properties of a Queue, it is recommended to create a new Queue with the new, desired configuration.

To Delete a Queue, select it from the list of existing Queues and click "Delete".

SLA Settings

Both the New Queue and Edit Queue Windows allow for the creation or configuration of SLA Settings that define the way that Queue Items of different priority status will be handled for the specific Queue. This is possible via the SLA Tab next to the General Tab of these Windows.

The interface of the SLA Settings is similar in both cases:

sla-settings.png

The only difference is that the New Queue Window allows the user to Add this New Queue [3] to the existing ones while the Edit Queue [3] Window allows them to Update the SLA Settings of an existing Queue.

The Settings allow the user to set a Starting Point for how long until the designated Process should execute after the Queue Item with a given priority has been added to that Queue. Each Starting Point can be accompanied by a Deadline. The Deadline marks the end of the time period the Queue will treat the Items according to their priority level.

If an Item is not processed during the specific time period, then it is marked on the Queue Items Window Status Column as Expired. Otherwise, a Queue item can be marked as:

-Completed, if the Process that is Getting the Queue Items has completed successfully

-Failed, if the Process did not complete successfully

-New, if the Item has not yet been handled by the Process associated with the Queue

-In Progress, if the item is currently being handled

Let us for example consider a Queue that is being consumed by a specific Process that has Concurrency Limit 4 in its Properties and has executed on an Execution Target of a Robot Pool that consists of 5 Robots. Given these specs we understand that the maximum number of In Progress Items at any one time in this example is 4 x 5 = 20 if there is no concurrency limit imposed on a Robot level.

You can access the Queue Items Window by double clicking on a Queue at the central Queue Tab of the Control Desk:

queue-items-window-settings-tab.png