|
In a Windows operating system, the broker runs as a service after installation.
|
|
The ThingWorx extension support model has recently changed. Most extensions are no longer available on the downloads page. See this article for more information.
|
Call-out | Description |
1 | The green icon indicates that the Thing you created is connected to the broker. It appears red when the Thing is disconnected. |
2 | The isConnected property is set to TRUE in the Value field when connection is established between Thing and broker. The Value field is set to FALSE when it is disconnected. The property is set to false when the singleton node in a ThingWorx HA environment has connectivity issues with the broker. However, other nodes will continue to publish messages, even when the property is false. |
For successful data change event execution, make sure a System User has the following permissions. • Service Execute and Event Subscribe permission on the Collection level. For example, on Thing, ThingTemplate or ThingShape. |
JDBC Settings | Description | ||
clientIdFormat | The name of the client that is registered with the MQTT broker.
The token {s} is for the server name of ThingWorx platform. It takes the value mentioned in the Federation Subsystem configuration for server name. The token {t} is for the current Thing name. If you want different platforms to be connected to one broker and have Things with same name, it is recommended to specify the server name in the Federation Subsystem | ||
useSSL | Select this if your broker supports secure connections. | ||
serverName | The host name where MQTT broker is running.
| ||
serverPort | The port for the MQTT broker. The default value is 1883. | ||
userId | The user name to connect to the broker. | ||
Password | The password for the userId. | ||
Timeout | The time in milliseconds to wait for a publish request to be successful. The default value is 5000 mS. | ||
ConnectTimeout | The time in milliseconds to wait for a connection to be established between the ThingWorx Platform and MQTT broker. | ||
retryInterval | The interval time in milliseconds to retry the connection if a connection to an MQTT broker is broken. The retry mechanism works only if the connection was established at some time and it later got broken. | ||
retryAttempts | The number of times retry connection attempts are made. For example, if an established connection is broken by network disturbances or due to any other issues, the number of attempts made to reset the connection are provided by value entered in this field. Each retry attempt is separated by the retryInterval mentioned above. | ||
pingInterval | The time in milliseconds to do periodic check of the connection status between ThingWorx Platform and the MQTT broker. The default value is 45 seconds. Every 45 seconds, a ping message is sent to the MQTT broker to check if there is a response. The response from the broker means that the connection is valid. | ||
connectionIdleTimeout | The idle time in milliseconds for a connection. If the connection is idle beyond this set time, it indicates that there was no message communication in the channel, and the Thing is marked as disconnected. When properties are not published or subscribed to, the pingInterval keeps updating the last active time so that the Thing does not get disconnected. | ||
qos | This value sets the priority level of communication between the broker and its clients. | ||
maxInFlight | Sets the maxinflight. Increase this value in a high traffic environment. |
AutoMapping | Description |
format | The format of the topic name that corresponds to a property. The {s} token is for the server name, {t} is for Thing name, and {p} is for the property name. |
enabled | You can select the automatic mapping feature. |
Subscribe | Subscribes the property to receive published changes on the specified topic from the MQTT broker. |
Publish | Publishes property value changes to the MQTT broker using the specified topic. |
Retain | Retains the last published property value in the MQTT broker. When a new device or client subscribes to a topic with a retained message, the broker automatically sends a message that contains the last published value. Retaining message values may be useful when a client requires an initial value. Instead of setting an initial placeholder value and waiting for the next message, a retained value is sent. |
Name | The name of the Thing property to map the MQTT broker to. |
Topic | The name of the topic to publish or subscribe to on the MQTT broker. |