SMPP Adapter

The SMPP Adapter implements Short Message Peer-to-Peer message transmission functionality.

Remarks

The SMPP Adapter implements a Short Message Peer-to-Peer client that can be used to send SMS messages from your BizTalk Server to any SMS-enabled entity.

SMPP Receive Adapter

Before using the SMPP Send Adapter, you must first contact a Short Message Service (SMS) vendor to create an account. Once your account is properly set up, you must set the server information on your adapter through the SMPPServer and SMPPPort properties. If your SMS vendor supplies you with a UserId or Password, you should enter those as well. Some vendors may also require specific SystemType values in order to communicate with a client. If this is the case, the vendor will supply you with that information as well.

The adapter also supports Secure Socket Layer (SSL) transport security. This may be enabled by selecting an SSLCert and a valid SSLAcceptServerCert, and then setting the SSLStartMode to an appropriate value.

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.

SMPP Send Adapter

Once the send port is set up, it will connect to the SMPP server whenever it has a message to send. By default, it will send the contents of the message body as the text of the short message. This behavior can be overridden by setting the MessageText property at design time or at runtime by writing the property to the message context.

The adapter allows you to send text messages to one or more RecipientAddress. You may also set the SendAsData property to send large (greater than 64KB) messages as binary data instead of as a text message.

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.


ErrorThreshold	The maximum number of errors before the adapter shuts down.
Firewall	A set of properties related to firewall access.
MaxBatchSize	The maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCount	The maximum number of files in the current batch (0 indicates no limit).
MaxFileSize	The maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreads	The maximum number of threads that the adapter may consume.
Other	Defines a set of configuration settings to be used by the adapter.
Password	This is the user's password.
PersistentConnection	Instructs the adapter whether to keep the connection to the server open.
PollingInterval	The amount of time, in seconds, between download attempts.
RequeueEndpoints	Whether to requeue receive endpoints if the polling interval has not been reached.
RuntimeLicense	Specifies the adapter runtime license key.
ScheduledDelivery	This value tells the server when to deliver the current message.
SMPPPort	The server port for secure SMPP (default 3551).
SMPPServer	This is the SMPP entity to which the component will connect.
SMPPVersion	This is the SMPP version to be used throughout the connection.
SourceAddress	The source address of the current message.
SSLAcceptServerCert	Instructs the adapter 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 adapter starts the SSL negotiation.
SystemType	This is a string representing the type of system during a connection.
Timeout	A timeout for the adapter.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
UserId	This value is used for identification with the SMPP service.
ValidityPeriod	The validity period of the current message.

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.


ConnectionLifetime	Instructs the adapter whether or not to leave the connection to the server open.
Firewall	A set of properties related to firewall access.
MaxPersistentConnections	The maximum number of simultaneous persistent connections when sending.
MaxThreads	The maximum number of threads that the adapter may consume.
MaxTransmissionBatchSize	The maximum number of messages that can be sent in a single batch.
MessageExpiration	Denotes the validity period of the current message.
MessagePriority	This is the priority level of the current message.
MessageText	The text of the short message to be sent.
Other	Defines a set of configuration settings to be used by the adapter.
Password	This is the user's password.
ReceivedMessageId	The identifier of the most recently sent message.
RecipientAddress	A comma-separated list of the recipient addresses of the current short message.
RecipientType	Indicates the type of entities receiving the current short message.
RuntimeLicense	Specifies the adapter runtime license key.
ScheduledDelivery	This value tells the server when to deliver the current message.
SendAsData	A boolean switch indicating whether the current short message should be sent as a data message.
SenderAddress	The addresses from which the current short message will be sent.
ServiceType	This indicates the type of service for the current message.
SMPPPort	The server port for secure SMPP (default 3551).
SMPPServer	This is the SMPP entity to which the component will connect.
SMPPVersion	This is the SMPP version to be used throughout the connection.
SSLAcceptServerCert	Instructs the adapter 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 adapter starts the SSL negotiation.
SystemType	This is a string representing the type of system during a connection.
Timeout	A timeout for the adapter.
TransmitBatchMode	How the transmitter processes batches.
TransportLog	Tells the adapter where and how to report information about its operations.
URI	The Uniform Resource Identifier (URI) of the send port or receive location.
UserId	This value is used for identification with the SMPP service.

Configuration Settings

The following is a list of configuration settings for the adapter with short descriptions. Click on the links for further details.


DataCoding	The data encoding mechanism to be used for the current message.
DestinationNPI	The Number Planning Indicator for the destination ESME.
DestinationTON	The Type of Number for the destination ESME.
MCReceipt	The type of receipt you wish to receive for the current message.
ProtocolId	The protocol identifier.
SMEAcknowledgement	The type of acknowledgement you wish to receive for the current message.
ReconnectAttemptInterval	The time, in seconds, between reconnection attempts.
ReconnectAttemptLimit	The maximum number of reconnection attempts.
SourceNPI	The Number Planning Indicator for the ESME.
SourceTON	The Type of Number for the ESME.
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 adapter whether or not to use the system security libraries or a managed implementation.
PersistedConnectionTimeout	How long to leave a persisted connection alive.