Some features described in this article are available starting with meshIQ Manage version 12.1 and greater.
For a quick overview of what's new or changed, visit the meshIQ Highlights page for a version-by-version breakdown.  

Jump to Section:
Version 12.x and Later
Version 11.3 and Earlier

Version 12.x and Later

This article will guide you through the process of creating a Solace MQTT Session object.

An MQTT session object represents a connection between a client and the messaging system using the MQTT protocol. It holds the state of an MQTT client. MQTT sessions are identified by their Client ID and associated Message VPN.

Before creating the MQTT Session object, you must establish a Solace Manager connection. To learn how, click on Create Remote Solace Manager Connection.

Create a Solace MQTT Session

You can create a Solace MQTT Session object by following these steps:

1. Open the Solace MQTT Session widget, click the Add Solace MQTT Session button. 
2. The Select Object Path dialog will open. Specify the Workgroup server, Node, Broker, and Message VPN, then click Select path.

By default, all available Workgroup servers, Nodes, Brokers, and Message VPNs are selected. If you want to limit the selection, you must explicitly choose which ones to include.

3. The Solace MQTT Session Create Window will open. Enter the MQTT Session Client ID (required) and any other necessary details.
   
4. Click on the Advanced slide at the bottom left to view more advanced options. 
5. Click Ok to create the MQTT Session object immediately. Alternatively, click Schedule to create it at a future time (see Scheduling for details).
6. Now, go to the MQTT Session widget to see the newly added object. If you can't find it, refresh the widget using the Refresh icon. 

Version 11.3 and Earlier

This article will guide you through the process of creating a Solace MQTT Session object.

An MQTT session object represents a connection between a client and the messaging system using the MQTT protocol. It holds the state of an MQTT client. MQTT sessions are identified by their Client ID and associated Message VPN.

Before creating the MQTT Session object, you must establish a Solace Manager connection. To learn how, click on Create Remote Solace Manager Connection.

Create a Solace MQTT Session

You can create a Solace MQTT Session object by following these steps:

1. Open the Solace MQTT Session viewlet, click the Add button . 
2. The Select Object Path window will open. Specify the Workgroup server, Node, Broker, and Message VPN, then click Select path.

By default, all available Workgroup servers, Nodes, Brokers, and Message VPNs are selected. If you want to limit the selection, you must explicitly choose which ones to include.

3. The Solace MQTT Session Create Window will open. Enter the MQTT Session Client ID(required ) and any other necessary details.
   
4. Click on the Advanced slide at the bottom left to view more advanced options. 
5. Click Ok to create the MQTT Session object immediately. Alternatively, click Schedule to create it at a future time (see Scheduling for details).
6. Now, go to the MQTT Session viewlet to see the newly added object. If you can't find it, refresh the viewlet using the Refresh icon.