Versions Compared

Version Old Version 1 New Version Current
Changes made by

Former user

Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

The To open the MQTT agent configuration window is displayed when double clicking on the agent in dialog from a workflow , or when right clicking on the agent and selecting Configuration.configuration, you can do the following:

  • right-click the agent icon and select Configuration...

...

  • double-click the agent icon


Ui tabs


Ui tab
titleGeneral

General Tab

 The General tab contains configurations related to the MQTT Connection Details.

Image Removed

MQTT Agent Configuration

,

- General tab


SettingDescription

Username

Enter the user name to be used for the connection to the MQTT server.

Password

Enter the password to be used for the connection to the MQTT server.

Use TLS

Select this check box to have the MQTT agent use TLS.

The fields beneath will then be activated. Notetitle

 


Security Profile

Select the security profile available to be used for encryption.

Note!

This field is enabled when the Use TLS checkbox is selected.

Only the Java Keystore Type, Keystore Path and Keystore Password fields in the Security profile are used by MQTT agent.

A new security profile is automatically generated when importing the MQTT agent workflow configuration of an earlier version prior to  9.


Setting up TLS

For more information on setting up TLS, refer to

4. Network Security.Keystore PathEnter the location of the keystore used by the TLS.

Keystore PasswordEnter the password for the keystore indicated in the Keystore Path field

.


Broker ConnectionEnter the IP address or hostname of the target broker.
Broker PortEnter the port value of the target broker.



Ui tab
titleSubscribe

Subscribe Tab

The Subscribe tab contains configurations related to topic subscription, where the MQTT agent will subscribe to 1 or many topics in the subscriber/publisher.

Image Removed

MQTT Agent Configuration

,

- Subscribe tab


SettingDescription
TopicEnter the value for the MQTT topic in this field.
QoS

Select the value for the Quality of Service

out of 3 choices,

.

The three available options are:

  • At Most
once
  • Once (0)
,
  • At Least
one
  • Once (1)
and
  • Exactly
once
  • Once (2)



Ui tab
titleAdvanced

Advanced Tab

The Advanced tab contains additional properties for the MQTT agent.

...

MQTT Agent Configuration

...

- Advanced tab

SettingDescription
Keep AliveEnter a Keep Alive (in seconds) value for the MQTT agent. The Keep Alive is set to 60 seconds by default.
Use Clean Session

Select this check box to have the MQTT agent set to use clean session. MQTT agent is set to use persistent session by default.

Client IDEnter the value for the Client ID of the MQTT agent.
Use Will Message

Select this check box to have the MQTT agent use Will Message.

...

By selecting this checkbox will enable the following fields.

Will Message

The following parameters are used to set up a Will Message as specified in the OASIS Standard MQTT Version 3.1.1 Specification


Enable Will Message Retain

Select this check box to have the MQTT agent to set retain Will Message to true in the MQTT server.

Note!

This field is enabled when the Use Will Message checkbox is selected.


Will Message Topic

Enter the value for the topic to be used in the Will Message.

Note!

This field is enabled when the Use Will Message checkbox is selected.


Will Message

Enter the message to be included in the Will Message.

Note!

This field is enabled when the Use Will Message checkbox is selected.


Will Message Quality of Service

Select the value for the Quality of Service to be used by Will Message.

...

The three available options are:

  • At Most Once (0)

...

  • At Least

...

  • Once (1)

...

  • Exactly

...

  • Once (2)
Note!

This field is enabled when the Use Will Message checkbox is selected.