Connect to IBM RPA Queue Server

Connects to te IBM RPA queue provider server.

Command availability: IBM RPA SaaS and IBM RPA on premises


Connects to the default System Queue Provider in IBM RPA. Unlike other queue connection commands, you do not need to enter connection data, as this command is completely integrated with the IBM RPA server system queue.

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.

connectSystemMQ (Boolean)=success (QueueConnection)=value


  • For IBM RPA on premises offerings, you must ensure that there is a System Queue Provider registered in the IBM RPA Control Center. System admins might use IBM MQ as the System Queue Provider. For IBM RPA SaaS offering, the System Queue Provider is previously registered and can be used on any environment.

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.


The command connects to the queue server provided by IBM Robotic Process Automation, returning whether the connection was created successfully.

defVar --name connectionResult --type Boolean
defVar --name systemQueue --type QueueConnection
// Connect to the queue server
connectSystemMQ connectionResult=success systemQueue=value
// Displays if the connection was created successfully
logMessage --message "${connectionResult}" --type "Info"


  • This command does not create a new queue. You can create a new queue by creating a new variable with type Message Queue and adding items to the queue using the Enqueue (enqueue) command or by obtaining a queue previously registered in the IBM RPA Control Center.