Connect to Active MQ
Connects to the Active MQ 
queue provider.
Command availability: IBM RPA SaaS and IBM RPA on premises
Description
Connects to the Active MQ queue provider. You can use an existing Active MQ connection by enabling the Storaged Configurations option, or configure it manually by leaving it disabled.
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.
connectActiveMQ --queueprovider(String) --address(String) [--fromconfiguration(Boolean)] [--port(Numeric)] [--timeout(TimeSpan)] (Boolean)=success (QueueConnection)=value
Dependencies
- You must have access to a server exposing the queue service. For Active MQ, you must have access to an existing Active MQ server before using this command.
- If you enable the
Storaged Configurationsparameter, you must have a previously configured queue provider in the IBM RPA Control Center. See Queue Provider for more information.
Input parameters
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 |
|---|---|---|---|---|
| Queue Provider | queueprovider |
Required when the Storage Configurations parameter is enabled |
Text |
Connects to a Queue Provider configured in the IBM RPA Control Center. This option only works if the Queue Provider is already registered in the IBM RPA Control Center. |
| Address | address |
Required when the Storage Configurations parameter is not enabled |
Text |
URL address to connect to the queue provider server. |
| Storaged Configurations | fromconfiguration |
Optional |
Boolean |
When enabled, you can select a queue provider previously configured in the IBM RPA Control Center. |
| Port | port |
Optional |
Number |
Port number used to connect to the queue provider server. |
| Timeout | timeout |
Optional |
Time Span |
Maximum waiting time for establishing a connection to the queue server. If no value is defined, the default timeout of 5 seconds is used. It can also use the timeout value defined in the Set Timeout ( setTimeout) command. |
Output parameters
| Designer mode label | Script mode name | Accepted variable types | Description |
|---|---|---|---|
| Success | success |
Boolean |
Returns True if the connection contains a valid IP or hostname, otherwise returns False. |
| Connection | value |
Queue Connection |
Returns a variable with the connection to the queue provider. |
Example
The command connects to the Active MQ queue provider, gets the ClientQueue using the Get Queue (getQueue) command and dequeues the first item from the queue using the
Dequeue (dequeue) command.
defVar --name activemqConnection --type QueueConnection
defVar --name clientQueue --type MessageQueue
connectActiveMQ --address "127.0.0.1" --port 8161 activemqConnection=value
getQueue --connection ${activemqConnection} --name ClientQueue clientQueue=value
dequeue --collection "${clientQueue}"
Limitations
- This command does not create a new queue. You can create a new queue by creating a new variable with type
Message Queueand adding items to the queue using the Enqueue (enqueue) command or by obtaining a queue previously registered in the IBM RPA Control Center. - The
successparameter returnsTrueif the connection is valid, but the command does not check if the connection was successfully established.