Integration Server 10.5 | Built-In Services Reference Guide | MQTT Folder | pub.mqtt:triggerSpec
 
pub.mqtt:triggerSpec
WmPublic. Specification for the signature of an MQTT trigger service.
Input Parameters
MqttMessage
Document Document (IData object) A document representing the MQTT message received by the MQTT trigger.
Key
Description
payload
Document Optional. A document containing the MQTT message payload. The Decoding Type value for the MQTT trigger determines the format for the message payload passed to the trigger service.
Value
Description
bytes
byte [ ] Optional. MQTT message body in the form of a one-dimensional byte array.
string
String Optional. The MQTT message body as a String.
id
String Optional. The message ID for the MQTT message which is set only if qos is 1 or 2.
qos
String Optional. The Quality of Service (QoS) level used for delivery of the message to the MQTT trigger.
The QoS for a message can be different than the QoS value set for the MQTT trigger. The QoS for publishing messages to the MQTT server is separate from the QoS for receiving messages. When sending the message to the MQTT trigger, the MQTT server uses the lower QoS regardless of whether it was set by the message publisher or by the MQTT trigger.
MQTT version 3.1.1 does not require MQTT servers to support QoS 2. An MQTT server may downgrade a QoS of 2 to 1.
isRetained
String Optional. Flag indicating whether the MQTT message was saved by the MQTT server as the last known good message for the topic. Whether or not a message is retained is determined by the retain flag in the message which is set by the publisher.
*true indicates the MQTT message was retained by the MQTT server as the last known good message.
*false indicates the MQTT message was not retained by the MQTT server as the last known good message.
isDuplicate
String Optional. Flag indicating whether the MQTT message is a duplicate of one previously retrieved by the MQTT trigger. The MQTT server resends messages when the MQTT server does not receive an acknowledgment for the message from the MQTT trigger. isDuplicate applies only when the qos is greater than 0.
topicName
String Name of the topic from which the message was received. An MQTT trigger can use wildcards to subscribe to multiple topics.
Output Parameters
None.