MQTT Receiver

How to Configure a MQTT Receive Location with the BizTalk Server Administration Console

To configure the receive location by using the BizTalk Server Administration console, use the following procedure:

NOTE: Before completing the following procedure you must have already added a one-way receive port. For more information, see How to Create a Receive Port.

To configure receive location variables for a MQTT receive location:

1. In the BizTalk Server Administration console, expand BizTalk Server Administration, expand BizTalk Group, expand Applications, and then expand the application you want to create a receive location in.
2. In the left pane, click the Receive Port node. Then in the right pane, right-click the receive port that is associated with an existing receive location or that you want to associate with a new receive location, and then click Properties.
3. In the left pane of the Receive Port Properties dialog box, select Receive Locations, and in the right pane double-click an existing receive location or click New to create a new receive location.
4. In the Receive Location Properties dialog box, in the Transport section next to Type, select nsoftware.MQTT 2020 from the drop-down list, and then click Configure to configure the transport properties for the receive location.
5. In the nsoftware.MQTT 2020 Transport Properties dialog box, you will find the following properties:

   CleanSession	Determines whether a clean session is used once connected. Type: bool    Default Value: true
   ClientId	A string that uniquely identifies this instance of the component to the server. Type: xs:string    Default Value: ""
   Duplicate	Whether the messages Duplicate flag is set. Type: bool    Default Value: false
   Firewall	A set of properties related to firewall access. Type: Firewall    Default Value: null
   MaxThreads	The maximum number of threads that the component may consume. Type: xs:int    Default Value: 20
   Other	Defines a set of configuration settings to be used by the component. Type: xs:string    Default Value: ""
   PacketId	The message's packet Id. Type: xs:int    Default Value: 0
   Password	A password if authentication is to be used. Type: baf:Password    Default Value: ""
   PersistentConnection	Instructs the component whether to keep the connection to the server open. Type: bool    Default Value: false
   ProtocolVersion	The MQTT protocol version that the component will conform to. Type: xs:int    Default Value: 0
   QOS	The messages QoS level. Type: xs:int    Default Value: 0 NOTE: This property must have a value.
   RemoteHost	The address of the remote host. Domain names are resolved to IP addresses. Type: xs:string    Default Value: "" NOTE: This property must have a value.
   RemotePort	The port of the MQTT server (default is 1883). The default port for SSL is 8883. Type: xs:int    Default Value: 1883
   RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached. Type: bool    Default Value: false
   Retained	Whether or not this message's Retain flag is set. Type: bool    Default Value: false
   RuntimeLicense	Specifies the component runtime license key. Type: xs:string    Default Value: ""
   SSLAcceptServerCert	Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. Type: Certificate    Default Value: null
   SSLCert	The certificate to use for client authentication during the SSL handshake. Type: Certificate    Default Value: null NOTE: The digital id must have a private key associated with it.
   SSLStartMode	Determines how the component starts the SSL negotiation. Type: xs:int    Default Value: 0
   Timeout	A timeout for the component. Type: xs:int    Default Value: 60
   Topic	The topic to subscribe or publish to. Type: xs:string    Default Value: "" NOTE: This property must have a value.
   TransportLog	Tells the component where and how to report information about its operations. Type: Log    Default Value: null
   URI	The Uniform Resource Identifier (URI) of the send port or receive location. Type: xs:string    Default Value: ""
   User	A username if authentication is to be used. Type: xs:string    Default Value: ""
   WillMessage	The message that the server should publish in the event of an ungraceful disconnection. Type: xs:string    Default Value: ""
   WillTopic	The topic that the server should publish the WillMessage to in the event of an ungraceful disconnection. Type: xs:string    Default Value: ""

6. Click OK.
7. Enter the appropriate values in the Receive Location Properties dialog box to complete the configuration of the receive location and click OK to save settings. For information about the Receive Locations Properties dialog box, see How to Create a Receive Location.