Referencing a Queue in Your App

To create better, more complex apps, UiPath Apps can connect and interact with queues from UiPath Orchestrator.

Referencing a Queue From Orchestrator

Once a queue has been created in Orchestrator, you can reference that queue from an app.

For more information on queues, check the Queues section from the Orchestrator guide.

Attention: Only queues containing a Specific Data JSON Schema file in Orchestrator are supported by Apps. To better understand how the Specific Data JSON Schema should look like, see the example below:

{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "The Root Schema",
    "required": [
        "name"
    ],
    "properties": {
        "name": {
            "type": "string"
        },
        "isPermanent": {
            "type": "boolean"
        },
        "age": {
            "type": "number"
        },
        "department": {
            "type": "string",
            "enum": ["Sales", "Marketing", "HR"]
        }
        }
    }{
    "definitions": {},
    "$schema": "http://json-schema.org/draft-07/schema#",
    "$id": "http://example.com/root.json",
    "type": "object",
    "title": "The Root Schema",
    "required": [
        "name"
    ],
    "properties": {
        "name": {
            "type": "string"
        },
        "isPermanent": {
            "type": "boolean"
        },
        "age": {
            "type": "number"
        },
        "department": {
            "type": "string",
            "enum": ["Sales", "Marketing", "HR"]
        }
        }
    }

Specific Data JSON Schema file sample

In the example below, we'll show you how to reference an existing entity into an app.

From an existing app in App Studio, click the Add any icon from the top of the canvas.
Click on Queue to open the queue reference dialog.
Choose an Orchestrator tenant that you have access to within your account. Choose the one that hosts the queues you need and click Next. You can also connect to a standalone on-prem tenant, choose Use other orchestrator tenant. After choosing your tenant, click Next.
A list of queues, organized by folders, is shown for the currently selected tenant. Highlighting a queue displays its contents.
Check the checkbox next to the queue you want to use in your app and click Add.

Note: Only queues containing a Specific Data JSON Schema file in Orchestrator are supported by Apps.

The queue has now been added to your app.

Note: Queue permissions are managed in Orchestrator. Make sure you have the right permissions for the queue you want to reference from Orchestrator.

Updating a Referenced Queue

If there are any changes made to a queue schema, follow the steps bellow to update it in Apps.

Once a queue is referenced, select it from the Queues menu in Apps.
Select the queue from the list.
Click on the Refresh icon.

Binding a Queue

In the example below we will bound a queue to a textbox control.

Before You Start

Before binding a queue to a control in App Studio, make sure that the queue is referenced in your app.

Note: If you want to send a date-time object, datatables, objects, or arrays to a queue, make sure that you bind it to a string type field. You can also bind a complex object to a queue input using the string type field.