List Queues
Verb: listQueues
Available from: <Enterprise>
Lists all queues that are configured in IBM Robotic Process Automation's Web Client and associated with a specific queue provider.
Syntax
listQueues --connection(QueueConnection) (Boolean)=success (List<String>)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --connection | Connection | Required | Queue Connection | Connection variable with a queue provider.
The "Queue Connection" type variable is obtained through the commands: |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| success | Success | Boolean | Returns "True", if the queue listing configured at the queue provider was successful, or "False", otherwise. |
| value | Queues | List<Text> | Returns a list of all queues configured at the specified queue provider. |
Example
After making the connection to the queue provider Connection to Queue Server System, the command List Queues lists all the queues configured at that provider. Thus, the command Log Message is used in this context to show the listing on the IBM Robotic Process Automation Studio console.
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"
Remarks
For the listing to occur successfully, the queues must be configured in the Web Client of IBM Robotic Process Automation and associated with the specified queue provider, which is also configured in the same environment.