XMPP Adapter
Properties Configuration Settings
The XMPP Component adds instant messaging functionality to your BizTalk Server.
Remarks
eXtensible Messaging and Presence Protocol is a highly extensible instant message service based on XML packets. The XMPP Adapter is a lightweight XMPP instant messaging client which enables you to send instant messages to any XMPP client within your service's network.
XMPP Receive Adapter
At a minimum, you must supply an IMServer and IMPort for the connection. In order to authenticate with the XMPP server you will need to specify a User and Password. The AuthMethods property contains a preferential list of authentication methods to be enabled on the adapter.
The adapter will connect to the XMPP server on the first PollingInterval and remain connected to receive incoming messages. It will remain connected until the adapter is shut down.
XMPP Send Adapter
At a minimum, you must supply an IMServer, IMPort for the connection and a ToJID for the intended recipient of the message. In order to authenticate with the XMPP server you will need to specify a User and Password. The AuthMethods property contains a preferential list of authentication methods to be enabled on the adapter.
By default, the adapter will attempt to send the contents of the outbound BizTalk Server message as the instant message body. This can be overridden by setting a static message in the send port's MessageText property at design-time. To set a dynamic message, you can write to the same property in the message context at runtime. The adapter will send the contents of the MessageText property as the instant message body. The adapter also supports sending HTML in the message body via the MessageHTML property.
A simple text message in the MessageText property can alternatively be treated as HTML via the TreatMessageAsHTML configuration setting. Also, when sending to clients that may not support reading HTML entities, ParseHTML can be set to cause the adapter to parse an HTML entity into the simple text body of the instant message.
The XMPP Send Adapter has support for SSL transport layer security. This may be enabled by setting SSLStartMode, SSLCert and SSLAcceptServerCert to appropriate values.
Please refer to the section on adapter configuration for a description of how to configure receive locations and send ports for this adapter.
Receiver Property List
The following is the full list of the properties of the receiver adapter with short descriptions. Click on the links for further details.
| AuthMethods | Controls how the component authenticates itself with the XMPP server. |
| Chatroom | The name of the chatroom to join. |
| ChatroomNickname | The nickname to be used within the chatroom. |
| ChatroomPassword | The password for the chatroom specified in the Chatroom configuration option. |
| Firewall | A set of properties related to firewall access. |
| FromJID | The ID of the user that sent the message. |
| IMPort | The server port for XMPP (default 5222). |
| IMServer | This is the instant messaging server. |
| MaxThreads | The maximum number of threads that the component may consume. |
| MessageOtherData | This property contains extra data for the current message. |
| MessageReceivedTime | The timestamp for when an offline message was received. |
| MessageSubject | This is the subject of the current message. |
| MessageThread | This is the thread name of the current message. |
| Other | Defines a set of configuration settings to be used by the component. |
| Password | This is the user's password. |
| PersistentConnection | Instructs the component whether to keep the connection to the server open. |
| RequeueEndpoints | Whether to requeue receive endpoints if the polling interval has not been reached. |
| Resource | This is the resource for the current session. |
| RuntimeLicense | Specifies the component runtime license key. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| Timeout | A timeout for the component. |
| ToJID | A semicolon-separated list of destination nodes to receive the current message. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| User | The user portion of this entity's Jabber ID. |
Sender Property List
The following is the full list of the properties of the sender adapter with short descriptions. Click on the links for further details.
| AuthMethods | Controls how the component authenticates itself with the XMPP server. |
| Chatroom | The name of the chatroom to join. |
| ChatroomNickname | The nickname to be used within the chatroom. |
| ChatroomPassword | The password for the chatroom specified in the Chatroom configuration option. |
| ConnectionLifetime | Instructs the component whether or not to leave the connection to the server open. |
| Firewall | A set of properties related to firewall access. |
| IMPort | The server port for XMPP (default 5222). |
| IMServer | This is the instant messaging server. |
| MaxPersistentConnections | The maximum number of simultaneous persistent connections when sending. |
| MaxThreads | The maximum number of threads that the component may consume. |
| MaxTransmissionBatchSize | The maximum number of messages that can be sent in a single batch. |
| MessageHTML | This is the HTML version of the current message. |
| MessageOtherData | This property contains extra data for the current message. |
| MessageSubject | This is the subject of the current message. |
| MessageText | This is the plain text of the current message. |
| MessageThread | This is the thread name of the current message. |
| MessageType | This is the type of the current message. |
| Other | Defines a set of configuration settings to be used by the component. |
| Password | This is the user's password. |
| Resource | This is the resource for the current session. |
| RuntimeLicense | Specifies the component runtime license key. |
| SSLAcceptServerCert | Instructs the component to unconditionally accept the server certificate that matches the supplied certificate. |
| SSLCert | The certificate to use for client authentication during the SSL handshake. |
| SSLStartMode | Determines how the component starts the SSL negotiation. |
| Timeout | A timeout for the component. |
| ToJID | A semicolon-separated list of destination nodes to receive the current message. |
| TransmitBatchMode | How the transmitter processes batches. |
| TransportLog | Tells the component where and how to report information about its operations. |
| URI | The Uniform Resource Identifier (URI) of the send port or receive location. |
| User | The user portion of this entity's Jabber ID. |
Configuration Settings
The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.
| AuthDomain | The domain under which the user must authenticate. |
| DateTimeFormat | The DateTime format for the MessageReceivedTime message context property. |
| ParseHTML | Tells the component to parse MessageHTML into a plaintext representation. |
| ServerDomain | This is the domain of the XMPP service. |
| TreatMessageAsHTML | Tells the component to treat the message contents as HTML. |
| UserDomain | The domain under which the user has registered with the XMPP service. |
| ReuseSSLSession | Determines if the SSL session is reused. |
| SSLCipherStrength | The minimum cipher strength used for bulk encryption. |
| SSLEnabledCipherSuites | The cipher suite to be used in an SSL negotiation. |
| SSLEnabledProtocols | Used to enable/disable the supported security protocols. |
| SSLIncludeCertChain | Whether the entire certificate chain is included in the SSLServerAuthentication event. |
| SSLSecurityFlags | Flags that control certificate verification. |
| TLS12SignatureAlgorithms | Defines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True. |
| TLS12SupportedGroups | The supported groups for ECC. |
| TLS13KeyShareGroups | The groups for which to pregenerate key shares. |
| TLS13SignatureAlgorithms | The allowed certificate signature algorithms. |
| TLS13SupportedGroups | The supported groups for (EC)DHE key exchange. |
| AbsoluteTimeout | Determines whether timeouts are inactivity timeouts or absolute timeouts. |
| LocalHost | The name of the local host or user-assigned IP interface through which connections are initiated or accepted. |
| TcpNoDelay | Whether or not to delay when sending packets. |
| UseInternalSecurityAPI | Tells the component whether or not to use the system security libraries or an internal implementation. |