Connect to Rabbit MQ
Connects to the Rabbit MQ 
queue provider server.
Command availability: IBM RPA SaaS and IBM RPA on premises
Description
Connects to Rabbit MQ queue provider server. You can use an existing Rabbit 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.
connectRabbitMQ --queueprovider(String) --address(String) [--username(String)] [--password(String)] [--fromconfiguration(Boolean)] [--port(Numeric)] [--timeout(TimeSpan)] (Boolean)=success (QueueConnection)=value
Dependencies
- You must have access to a server exposing the queue service. For Rabbit MQ, you must have access to an existing Rabbit 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 server. |
| User Name | username |
Optional |
Text |
The user name to access the queue provider. |
| Password | password |
Optional |
Text |
The password to access the queue provider. |
| 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 it successfully establishes a connection with the server, or False otherwise. |
| Connection | value |
Queue Connection |
Returns a variable with the connection to the queue provider. |
Example
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.