The Send a Text Message output connector can be used to send a formatted message containing processed event data as a text message. Messages are structured as plain text and are sent as a request to a configured SMTP server to generate the text message for the identified recipients.
Usage notes
Keep the following in mind when using the Send a Text Message output connector:
- This output connector functions by taking event data, adapting it to construct a message as plain text, and then sending the message to an independent SMTP server as a request for it to generate the outgoing email.
- This output connector pairs the Message Formatter outbound adapter with the SMS outbound transport.
- A valid email address for each recipient is constructed using the phone number followed by the domain of the carrier, for example, 6075557878@txt.att.net. The event count reported the output in GeoEvent Manager indicates the message containing event data has been sent to the specified SMTP server for delivery to the identified recipients. It does not indicate the success or failure of the SMTP server to create and send the email.
- If a carrier is not present in the default carrier list, a new carrier can be specified in the SMS settings in the GeoEvent Manager global settings. All that is required is the carrier name (key) and carrier domain (value). After adding, the new carrier will be displayed in the Carrier parameter list.
- If there are different carriers for each recipient, configure multiple Send a Text Message outputs for each expected carrier. This avoids appending the incorrect carrier domain to a recipient phone number.
- Contact your IT administrator to identify the host name, port, and authentication mode of your organization’s SMTP server. For example, port 25 is the well-known port for SMTP, but other ports may be in use by your organization.
- The default SMTP server host name, port number, authentication mode, username, and password can be specified in the SMTP settings in the GeoEvent Manager global settings. By defining default values for each SMTP parameter, any newly configured output using the SMTP outbound transport—such as the Send an Email output connector—will display the correct information.
Parameters
The following are the parameters for the Send a Text Message output connector:
| Parameter | Description |
|---|---|
| Name | A descriptive name for the output connector used for reference in GeoEvent Manager. |
Sender’s Email Address | The email address of the sender. The email address can be provided directly as a string of text or it can be dynamically obtained from a field in the event data using ${FIELD-NAME}. |
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. |
Carrier | Specifies the carrier the recipient phone numbers are a member of. GeoEvent Manager pairs the gateway/domain of the specified carrier to the recipient phone number in order to construct the recipient address. The default carriers include the following:
|
Recipient(s) | The phone number of the recipients. If there are multiple recipients, provide a comma separated list of the phone numbers. The phone numbers can be dynamically obtained from a field in the event data using ${FIELD-NAME}. There is no default for this parameter. Note:If the recipient's phone number is 607-555-7878, specify it as 6075557878. GeoEvent Server will append the value of the carrier domain to the phone number to create a recipient email for the text message. |
SMTP Server Host Name | Specifies the SMTP server host name. This is the SMTP server to use for sending email messages. The default is a placeholder string, smtp.HOST-NAME.com. |
SMTP Server Port Number | Specifies the SMTP server port number. This is the port that the SMTP server receives on. The default is 25. |
SMTP Authentication Mode | Specifies the SMTP server authentication mode. Available authentication modes include Anonymous, SSL, and TLS. The default is Anonymous.
|
Username (Conditional) | Specifies the SMTP authenticated user responsible for sending the email. The default for this parameter is a placeholder string, MyUsername. The parameter is shown when SMTP Authentication Mode is set to SSL or TLS and is hidden when set to Anonymous. |
Password (Conditional) | Specifies the password of the SMTP authenticated user sending the email. The parameter is shown when SMTP Authentication Mode is set to SSL or TLS and is hidden when set to Anonymous. |
Verify server hostname | Specifies whether the server's certificate content will be checked to ensure that it matches the server hostname. The purpose of the check is to prevent man-in-the-middle attacks. The default is No.
|