This article describes the RPA Queue functionality to list items in a queue.
For a full list of available functions, please read QUEUE functions.
Description
The List queue items function retrieves a list of items from a queue, optionally filtered by status. The result is an array of item records with their details. This is useful for checking queue contents, building reports, or finding specific items.
Setting it up
To use the List queue items function, follow these instructions:
{{popups:rpas/add:action=queue-list-items}}
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 List queue items 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} |
| Status filter | No | Select | All | Filter by status: New, In Progress, Successful, or Failed |
| Variable | Yes | Text | - | Variable to store the list of items |
Output variables
| Variable | Type | Description |
|---|---|---|
| Variable | Array | Array of queue item records with id, reference, status, priority, specificContent, etc. |
Tips
- Use the status filter to find only failed items for reprocessing
- Combine with a loop to iterate over the results