/n software Adapters for BizTalk
/n software Adapters for BizTalk
Questions / Feedback?

XMPP Adapter

Properties   Configuration Settings  

The XMPP Adapter 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 adds the capability to leverage this protocol within your BizTalk Server to send instant messages to any XMPP client within your XMPP service's network.

XMPP Receive Adapter

The XMPP Receive Adapter implements a lightweight XMPP instant messaging client. At a minimum, you must supply an IMServer, IMPort for the connection.

Once configured the adapter will connect to the SMPP 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

The XMPP Send Adapter implements a lightweight XMPP instant messaging client. At a minimum, you must supply an IMServer, IMPort for the connection and a ToJID for the intended recipient of the message.

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 also supports sending HTML entities with the message via the MessageHTML property. The default behavior of sending the BizTalk Server message contents as a simple text message can also be overridden via the TreatMessageAsHTML property. 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.

AuthMethodsControls how the adapter authenticates itself with the XMPP server.
ChatroomThe name of the chatroom to join.
ChatroomNicknameThe nickname to be used within the chatroom.
ChatroomPasswordThe password for the chatroom specified in the Chatroom configuration option.
FirewallA set of properties related to firewall access.
FromJIDThe ID of the user that sent the message.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
MaxThreadsThe maximum number of threads that the adapter may consume.
MessageOtherDataThis property contains extra data for the current message.
MessageReceivedTimeThe timestamp for when an offline message was received.
MessageSubjectThis is the subject of the current message.
MessageThreadThis is the thread name of the current message.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordThis is the user's password.
PersistentConnectionInstructs the adapter whether to keep the connection to the server open.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
ResourceThis is the resource for the current session.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
ToJIDA semicolon-separated list of destination nodes to receive the current message.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe 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.

AuthMethodsControls how the adapter authenticates itself with the XMPP server.
ChatroomThe name of the chatroom to join.
ChatroomNicknameThe nickname to be used within the chatroom.
ChatroomPasswordThe password for the chatroom specified in the Chatroom configuration option.
ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
IMPortThe server port for XMPP (default 5222).
IMServerThis is the instant messaging server.
MaxPersistentConnectionsThe maximum number of simultaneous persistent connections when sending.
MaxThreadsThe maximum number of threads that the adapter may consume.
MaxTransmissionBatchSizeThe maximum number of messages that can be sent in a single batch.
MessageHTMLThis is the HTML version of the current message.
MessageOtherDataThis property contains extra data for the current message.
MessageSubjectThis is the subject of the current message.
MessageTextThis is the plain text of the current message.
MessageThreadThis is the thread name of the current message.
MessageTypeThis is the type of the current message.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordThis is the user's password.
ResourceThis is the resource for the current session.
SSLAcceptServerCertInstructs the adapter to unconditionally accept the server certificate that matches the supplied certificate.
SSLCertThe certificate to use for client authentication during the SSL handshake.
SSLStartModeDetermines how the adapter starts the SSL negotiation.
TimeoutA timeout for the adapter.
ToJIDA semicolon-separated list of destination nodes to receive the current message.
TransmitBatchModeHow the transmitter processes batches.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserThe 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.

AuthDomainThe domain under which the user must authenticate.
DateTimeFormatThe DateTime format for the MessageReceivedTime message context property.
ParseHTMLTells the adapter to parse MessageHTML into a plaintext representation.
ServerDomainThis is the domain of the XMPP service.
TreatMessageAsHTMLTells the adapter to treat the message contents as HTML.
UserDomainThe domain under which the user has registered with the XMPP service.
ReuseSSLSessionDetermines if the SSL session is reused.
SSLCipherStrengthThe minimum cipher strength used for bulk encryption.
SSLEnabledProtocolsUsed to enable/disable the supported security protocols.
SSLIncludeCertChainWhether the entire certificate chain is included in the SSLServerAuthentication event.
SSLSecurityFlagsFlags that control certificate verification.
SSLEnabledCipherSuitesThe cipher suite to be used in an SSL negotiation.
TLS12SignatureAlgorithmsDefines the allowed TLS 1.2 signature algorithms when UseInternalSecurityAPI is True.
TLSNamedGroupsThe supported (EC)DHE groups.
TLS13SignatureAlgorithmsThe allowed certificate signature algorithms.
AbsoluteTimeoutDetermines whether timeouts are inactivity timeouts or absolute timeouts.
LocalHostThe name of the local host or user-assigned IP interface through which connections are initiated or accepted.
TcpNoDelayWhether or not to delay when sending packets.
UseInternalSecurityAPITells the adapter whether or not to use the system security libraries or an internal implementation.
PersistedConnectionTimeoutHow long to leave a persisted connection alive.

 
 
Copyright (c) 2018 /n software inc. - All rights reserved.
/n software Adapters for BizTalk - Version 16.0 [Build 6659]