List Queues
Lists all queues in the current queue connection.
Command availability: IBM RPA SaaS and IBM RPA on premises
Script syntax
IBM RPA's proprietary script language has a syntax similar to other programming languages. The script syntax defines the command's syntax in the script file. You can work with this syntax in IBM RPA Studio's Script mode.
listQueues --connection(QueueConnection) (Boolean)=success (List<String>)=value
Dependencies
- You need at least one queue registered in the IBM RPA Control Center or in your queue provider.
- You need an active connection to a queue server. The following commands can be used to connect to a queue server:
- Connect to Active MQ (
connectActiveMQ) - Connect to Azure Storage (
connectAzureStorage) - Connect to IBM MQ (
connectIbmMQ) - Connect to JMS MQ (
connectJmsMQ) - Connect to Microsoft MQ (
connectMicrosoftMQ) - Connect to SQL MQ (
connectSqlMQ) - Connect to IBM RPA Queue Server (
connectSystemMQ)
- Connect to Active MQ (
Input parameter
The following table displays the list of input parameters available in this command. In the table, you can see the parameter name when working in IBM RPA Studio's Script mode and its Designer mode equivalent label.
| Designer mode label | Script mode name | Required | Accepted variable types | Description |
|---|---|---|---|---|
| Connection | connection |
Required |
Queue Connection |
Connection variable to the queue provider. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Success | success |
Boolean |
Returns True if it successfully obtained a list of queues from the queue connection, otherwise returns False. |
| Queues | value |
List<Text> |
Returns a list of all queues available in the current queue provider. |
Example
This example lists all queues available in the IBM RPA System Queue provider.
defVar --name queuesList --type List --innertype String
defVar --name connection --type QueueConnection
connectSystemMQ connection=value
listQueues --connection ${connection} queuesList=value
logMessage --message "Queues available at the connected queue provider: ${queuesList}" --type "Info"