Connect to Azure Storage
Connects to Azure Storage 
queue provider server.
Command availability: IBM RPA SaaS and IBM RPA on premises
Description
Connects to Azure Storage queue provider server. You can use an existing Azure Storage 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 Azure Storage, you must have access to an existing Azure Storage 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. |
| Development Environment | isdevelopment |
Required when the Storage Configurations parameter is not enabled |
Boolean |
When enabled, it allows using the local machine as a development environment. |
| Account Name | accountname |
Required when the Development Environment parameter is not enabled |
Text |
Account name to access the queue server. |
| Account Key | accountkey |
Required when the Development Environment parameter is not enabled |
Text |
Account password or key to access the queue server. |
| Protocol | protocol |
Required when the Development Environment parameter is not enabled |
EndpointsProtocol |
Protocol options for sending information to the queue server. See the options in the protocol parameter options. |
| 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. |
| Storaged Configurations | fromconfiguration |
Optional |
Boolean |
When enabled, you can select a queue provider previously configured in the IBM RPA Control Center. |
protocol parameter options
The following table displays the options available for the protocol input parameter. The table shows the options available when working in Script mode and the equivalent label in the Designer mode.
| Designer mode label | Script mode name | Description |
|---|---|---|
| HTTP | http |
HTTP protocol used to connect to the queue server. |
| HTTPS | https |
HTTPS protocol used to connect to the queue server. |
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
The following example connects to the Azure Storage queue server, gets the Clients queue using the Get Queue (getQueue) command and removes the first item from the queue
using the Dequeue (dequeue) command.
defVar --name azureStorageConnection --type QueueConnection
defVar --name clientsQueue --type MessageQueue
// Connects to Azure Storage in a Development Environment
connectAzureStorage --isdevelopment azureStorageConnection=value
// Getes the Clients queue
getQueue --connection ${azureStorageConnection} --name Clients clientsQueue=value
// Removes the first item from the queue
dequeue --collection "${clientsQueue}"
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.