MQTT Producer

The MQTT Producer step allows you to publish messages in near real time to an MQTT broker. Within a transformation, the MQTT Producer step publishes a stream of records to one MQTT topic.

For more information about the MQTT protocol, see https://www.hivemq.com/mqtt/.

MQTT Producer step dialog

Step name

• Step name: Specifies the unique name of the step on the canvas. Default: MQTT Producer.

Options

The MQTT Producer step includes the following tabs.

• Setup

• Security

• Options

Setup tab

In this tab, define the connection to the MQTT server, the topic for publishing, the Quality of Service level, and the message field.

Option	Description
Connection	Specify the address of the MQTT server to which this step will connect for sending or receiving messages.
Client ID	Specify a unique ID for the MQTT client. The MQTT server uses this client ID to recognize each distinct client and that client's current state.
Topic	Specify the topic name using one of the following methods: Specify topic: Enter a specific topic name in Topic name. Each MQTT Producer step starts a single thread for publishing. Get data from field: Select a field name from another step in the transformation stream. Use this option to dynamically control the topic name. Each message still has only one topic, but each incoming row can generate a new message with a different topic.
Quality of Service (QoS)	Quality of Service (QoS) is a level of guarantee for message delivery. Select one of the following options: At most once (0) (default) At least once (1) Exactly once (2)
Message field	Select the field that contains the message to publish.

Security tab

MQTT Producer step Security tab

Use this tab to define authentication credentials for the MQTT server.

Option	Description
Username	Specify the user name required to access the MQTT server.
Password	Specify the password associated with the user name.
Use secure protocol	Select this option to define SSL properties for the connection.
SSL Properties	ssl.contextProvider Specify the underlying JSSE provider. ssl.enabledCipherSuites Specify which ciphers are enabled. Values are dependent on the provider. ssl.keyManager Specify the algorithm that will be used to create a KeyManagerFactory object instead of using the default algorithm available in the platform. ssl.keyStore Specify the name of the file that contains the KeyStore object that you want the KeyManager to use. ssl.keyStorePassword Specify the password for the KeyStore object that you want the KeyManager to use. ssl.keyStoreProvider Specify the identifying name or string for the key store provider. ssl.keyStoreType Specify the identifying name or string for the type of key store. ssl.protocol Specify the type of SSL protocol to use. ssl.trustManager Specify the algorithm that will be used to create a TrustManagerFactory object, instead of using the default algorithm available in the platform. ssl.trustStore Specify the name of the file that contains the KeyStore object that you want the TrustManager to use. ssl.trustStorePassword Specify the password for the TrustStore object that you want the TrustManager to use. ssl.trustStoreProvider Specify the identifier or string for the trust store provider. ssl.trustStoreType Specify the type of KeyStore object that you want the TrustManager to use.

Options tab

MQTT Producer step Options tab

This tab includes the following MQTT-specific parameters.

Parameter	Description
Keep Alive Interval	Specify a maximum number of interval seconds that is permitted to elapse between the point at which the PDI client finishes transmitting one control packet and the point it starts sending the next.
Max Inflight	Specify the maximum number of messages to have in process at any given time.
Connection Timeout	Specify the time (in seconds) to disconnect if a message is not received.
Clean Session	Specify whether the broker stores or purges messages for a session: True The broker does not store any information for the client. All information from a previous persistent session is purged. False The broker stores all subscriptions for the client. When QoS is set to 1 or 2, missed messages are stored.
Storage Level	Indicates whether messages are stored in memory or on disk: Blank (default): memory Disk: enter a valid path
Server URIs	Specify the MQTT server universal resource identifier (URI).
MQTT Version	Specify the MQTT protocol version that this step connects to.
Automatic Reconnect	Enable the client to attempt an automatic reconnect to the server if it becomes disconnected: True: reconnect to the server False: do not reconnect

Metadata injection support

This step supports metadata injection. You can use it with ETL metadata injection to pass metadata to your transformation at runtime.

See also

• MQTT Consumer