MQTT Listener can be used to subscribe to a topic to get messages from an MQTT Broker.


In the table below, you will find an explanation of these properties. All attributes with a ‘*’ are mandatory.




Id of the component.


Set this box to true, if you want this consumer to be enabled.

Consumer Autostart

Consumer will be started at startup of the interface.


URL to connect to the broker. The chosen URL determines whether the connection should be encrypted or not. The consumer will use the default ConnectPlaza truststore. The URL must have the following format: protocol://hostname:port, where protocol should be either ssl or tcp.


Client username to connect to the broker.


Client password to connect to the broker.


The topic(s) to subscribe to. Multiple topics must be comma delimited.

Quality of Service

A comma delimited list of QoS values. Can be a single value that is applied to all topics, or a value for each topic (in which case the lists must the same length). Default: 0.

MessagePart Name

Name of the MessagePart in a ConnectMessage where the content of the message is being stored.


Time-out in milliseconds. It only applies if the channel might block.


Name of the keystore file to use for client authentication. If the keystore file is not on the classpath the name should be preceded by file. By default no keystore will be used.

Keystore Password

Password of the keystore for client authentication.

Clean Session

Sets whether the client and server should remember state across restarts and reconnects.

Keep Alive Interval

The keep alive interval specifies the maximum amount of time in seconds that broker and client can be connected without sending a message.


Description of the specific consumer. This is for documentation purposes.

Enable SSL

When you enable SSL, you need to add some extra information. This will look like this:



Certificate Alias in Keystore

Set the certificate alias for the selected certificate. Should exist in defined keystore.

Key Password

Password for the certificate key.

Keystore Location

The location of the keystore. Should be a path to the keystore JKS file.

Keystore Password

Password of the keystore.

Advanced options

Attribute Description
Client ID A unique client id to connect to the broker. Default: "interfacename.flowname.componentname.clientid"