Get Queue
Verb: getQueue
Available from: <Enterprise>
Gets a specific queue, which is configured and attached to a queue provider on IBM Robotic Process Automation's Web Client.
Syntax
getQueue --connection(QueueConnection) [--fromconfiguration(Boolean)] --queue(String) --name(String) (Boolean)=success (MessageQueue)=value
Inputs
| Script | Designer | Required | AcceptedTypes | Description |
|---|---|---|---|---|
| --connection | Connection | Required | Queue Connection | Queue provider connection variable.
The variable of type "Queue Connection" is obtained through the commands: |
| --fromconfiguration | Storaged Configurations | Optional | Boolean | When enabled, it allows the selection of a queue previously created on the Web Client and linked to the specified queue provider. |
| --queue | Queue | Only whenStoraged Configurations is True | Text | Queue that should be used and which is already configured in Web Client. |
| --name | Name | Only whenStoraged Configurations is False | Text | Queue name configured on the Web Client and attached to the specified queue provider. |
Outputs
| Script | Designer | AcceptedTypes | Description |
|---|---|---|---|
| success | Success | Boolean | Returns "True", if the specified queue was obtained successfully, or "False", otherwise. |
| value | Queue Obtained | Message Queue | Returns the queue information specified in the Name parameter, as its name and value. |
Example
After making the connection with the queue provider Active MQ connection, using the settings stored on the Web Client, the Get Queue command gets the queue "Return" configured in the environment. Thus, the Log Message command is used in this context to show the return of the command in the IBM Robotic Process Automation Studio console.
defVar --name queueConnection --type QueueConnection
defVar --name obtainedQueue --type MessageQueue
connectActiveMQ --queueprovider Training --fromconfiguration queueConnection=value
getQueue --connection ${queueConnection} --name Return obtainedQueue=value
logMessage --message "Queue obtained from the queue provider:${obtainedQueue}" --type "Info"
Remarks
To successfully obtain the queue, it must be configured on the IBM Robotic Process Automation's Web Client and attached to the specified queue provider, which is also configured on the same environment.
The queue providers available on IBM Robotic Process Automation offer an administrative panel for creating queues. Some of which, such Connection to Queue Server System, Connect to Azure Storage, IBM MQ Connection, Rabbit MQ Connection and Active Active MQ connection, alternatively, offer other ways that allow queues to be created by the Get Queue command, with some restrictions. To see these restrictions, see the documentation for each command.
When registering queues in the Web Client, the nomenclature of the queues must be exactly the same as the queues already created at the provider.
Remember that each provider has different rules for naming the queues.