This article describes the RPA Queue functionality to add a work item to a queue.
For a full list of available functions, please read QUEUE functions.
Description
The Add item to queue function adds a single work item with data to a processing queue. The item is created with status "new" and waits to be picked up by a performer process. This is typically used in a dispatcher process that loads data and enqueues it for processing.
Setting it up
To use the Add item to queue function, follow these instructions:
{{popups:rpas/add:action=queue-add-item}}
Once on a process map:
- Navigate to the process where you would like to add the function
- Click on the green button’s drop-down (right side of the green button labelled “Process”)
- On the menu that appears, click on the “+ Activity” item
- From here you can select the QUEUE Add item to queue option
- Click "Add" once you are done
Input parameters
| Parameter | Required | Type | Default | Description |
|---|---|---|---|---|
| Queue ID | Yes | Text | - | The ID of the queue, or a variable such as {queue_id} |
| Reference | No | Text | - | Optional unique reference for the item (e.g. invoice number) |
| Priority | No | Select | Normal | Item priority: High (1), Normal (2), or Low (3) |
| Variable | Yes | Text | - | Variable to store the created item result |
| Data (JSON) | No | Textarea | - | JSON data payload, e.g. {"name":"{name}","email":"{email}"} |
| Defer until date | No | Date | - | Do not process before this date |
| Due date | No | Date | - | SLA deadline date |
Output variables
| Variable | Type | Description |
|---|---|---|
| Variable | Object | The created queue item with id, status, priority, and other fields |
Errors
- Duplicate reference – if the queue enforces unique references and the reference already exists
- Queue not found – if the queue ID is invalid
Tips
- Use the Reference field to track items by a business identifier (e.g. invoice number, order ID)
- Enable "Enforce unique references" on the queue to prevent duplicate processing
- Use variables in the JSON data field, e.g. {"invoice":"{invoice_number}"}