The Send an Instant Message output connector is used to send a formatted message containing processed event data as an instant message. Messages are structured as plain text and are sent as a request to a configured XMPP server to generate the instant message for the identified instant message address.
Usage notes
Keep the following in mind when using the Send an Instant Message output connector:
- This output connector adapts event data to construct a message as plain text and sends the message to an independent XMPP server as a request for it to generate and send an outgoing instant message.
- This output connector pairs the Message Formatter outbound adapter with the XMPP outbound transport.
- The event count reported the output in GeoEvent Manager indicates the message containing event data has been sent to the specified XMPP server for delivery to the identified address. It does not indicate the success or failure of the XMPP server to create and send the instant message.
- Work with your IT administrator to identify the XMPP server name, resource name, connection type, address, and credentials for the authenticated user.
- GeoEvent Server does not support dynamic addressing by specifying a value such as ${IM-Address} in the Address parameter.
- A single address must be specified. A comma separated list of recipient addresses is not supported.
Parameters
The following are the parameters for the Send an Instant Message output connector:
| Parameter | Description |
|---|---|
| Name | A descriptive name for the output connector used for reference in GeoEvent Manager. |
Message Body | The message body of the email. Fields from the processed event data can be used to reference specific values in the outbound email message body. The default for this parameter is a placeholder string, Enter Message Body Here. Example: A message structured like “Driver, ${DRIVER}, was going ${SPEED} miles per hour at ${TIME}” returns as Driver, John Doe, was going 82 miles per hour at 14:25:30 in an outbound email. |
| Server Name | Specifies the XMPP instant messaging server host name. This is the XMPP instant messaging server to use for sending instant messages. |
Resource Name | The name of an XMPP resource clients can use to enable users to be online at work or at home or available via a mobile device. |
Username | Specifies the XMPP authenticated user responsible for sending the instant message. |
Password | Specifies the password of the XMPP authenticated user sending the instant message. |
Connection Type | Specifies the connection type that the instant message will be sent to. Available connection types include Chat and Room. The default is Chat.
|
Address | Specifies the XMPP user account to which the instant message will be sent. The address must include the XMPP server’s simple name (omit the domain suffix). When instant messaging via the connection type Chat, use [Username]@[Server]. When instant messaging via the connection type Room, use [Room Name]@conference.[Server]. |
Room Password (Conditional) | Specifies the password of the XMPP conference room or group that is password protected. |