XMPP Activities

The XMPP Activity adds instant messaging functionality to your WorkFlow.

Remarks

eXtensible Messaging and Presence Protocol is a highly extensible instant message service based on XML packets. The XMPP Activity adds the capability to leverage this protocol within your WorkFlow to send instant messages to any XMPP client within your XMPP service's network.

XMPP Send Activity

The XMPP Send Activity 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.

The activity will send the contents of the MessageText property as the instant message body

The activity also supports sending HTML entities with the message via the MessageHTML property. The default behavior of sending the WorkFlow 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 activity to parse an HTML entity into the simple text body of the instant message.

The XMPP Send Activity 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.

Sender Property List

The following is the full list of the properties of the sender activity with short descriptions. Click on the links for further details.


AuthMethods	Controls how the activity 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.
IMPort	The server port for XMPP (default 5222).
IMServer	This is the instant messaging server.
LogFile	The file to write logging information to at runtime.
LogMode	What information gets logged during activity execution.
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 activity.
Password	This is the user's password.
PersistentConnection	Instructs the activity whether to keep the connection to the server open.
Resource	This is the resource for the current session.
RuntimeLicense	Specifies the activity runtime license key.
SSLAcceptServerCert	Instructs the activity to unconditionally accept the server certificate that matches the supplied certificate.
SSLAcceptServerCertAcceptAny	Tells the activity to accept any server certificate.
SSLCert	The certificate to use for client authentication during the SSL handshake.
SSLStartMode	Determines how the activity starts the SSL negotiation.
Timeout	A timeout for the activity.
ToJID	A semicolon-separated list of destination nodes to receive the current message.
User	The user portion of this entity's Jabber ID.

Configuration Settings

The following is a list of configuration settings for the activity 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 activity to parse MessageHTML into a plaintext representation.
ServerDomain	This is the domain of the XMPP service.
TreatMessageAsHTML	Tells the activity to treat the message contents as HTML.
UserDomain	The domain under which the user has registered with the XMPP service.
SSLEnabledProtocols	Used to enable/disable the supported security protocols.
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.
UseManagedSecurityAPI	Tells the activity whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.