/n software Adapters for BizTalk

Questions / Feedback?

MQTT Transmitter

Setting the MQTT Adapter Configuration Properties for a Dynamic Send Port

A dynamic send port does not provide any transport configuration options in BizTalk Explorer because it is expected that these properties will be provided with the context properties associated with the message. These properties can be set in a custom pipeline or in an orchestration. To set message configuration properties in an orchestration you can do the following:

  • Add a Construct Message shape to your orchestration.
  • Configure the Construct Message shape to construct a new message. (for example Message_2)
  • Add a Message Assignment shape to the Construct Message shape.
  • Add code to the Message Assignment shape to initialize the message that you constructed and to set the appropriate configuration properties for the message.

Configuring the MQTT Send Port with the BizTalk Server Administration Console

To configure the send port by using the BizTalk Server Administration console, use the following procedure:

To configure variables for a MQTT send port:

  1. In the BizTalk Server Administration console, create a new send port or double-click an existing send port to modify it. For more information, see How to Create a Send Port. Configure all of the send port options and specify nsoftware.MQTT 2020 for the Type option in the Transport section of the General tab.
  2. On the General tab, in the Transport section, click the Configure button next to Type.
  3. In the nsoftware.MQTT 2020 Transport Properties dialog box, use the following properties to:


    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: ""
    ConnectionLifetime Instructs the component whether or not to leave the connection to the server open.
    Type: xs:int    Default Value: 0
    Firewall A set of properties related to firewall access.
    Type: Firewall    Default Value: null
    MaxPersistentConnections The maximum number of simultaneous persistent connections when sending.
    Type: xs:int    Default Value: 1
    MaxThreads The maximum number of threads that the component may consume.
    Type: xs:int    Default Value: 20
    MaxTransmissionBatchSize The maximum number of messages that can be sent in a single batch.
    Type: xs:int    Default Value: 1
    MessageText The messages payload.
    Type: xs:string    Default Value: ""
    Other Defines a set of configuration settings to be used by the component.
    Type: xs:string    Default Value: ""
    Password A password if authentication is to be used.
    Type: baf:Password    Default Value: ""
    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 be specified.
    RemoteHost The address of the remote host. Domain names are resolved to IP addresses.
    Type: xs:string    Default Value: ""
    NOTE: This property must be specified.
    RemotePort The port of the MQTT server (default is 1883). The default port for SSL is 8883.
    Type: xs:int    Default Value: 1883
    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 be specified.
    TransmitBatchMode How the transmitter processes batches.
    Type: xs:int    Default Value: 0
    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: ""

  4. Click OK and OK again to save settings.

Copyright (c) 2022 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 20.0 [Build 8319]