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

SMPP Adapter

Properties   Configuration Settings  

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

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 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.

ErrorThresholdThe maximum number of errors before the adapter shuts down.
FirewallA set of properties related to firewall access.
MaxBatchSizeThe maximum size, in MB, of the current batch (0 indicates no limit).
MaxFileCountThe maximum number of files in the current batch (0 indicates no limit).
MaxFileSizeThe maximum size, in MB, of a file in the current batch (0 indicates no limit).
MaxThreadsThe maximum number of threads that the adapter may consume.
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.
PollingIntervalThe amount of time, in seconds, between download attempts.
RequeueEndpointsWhether to requeue receive endpoints if the polling interval has not been reached.
ScheduledDeliveryThis value tells the server when to deliver the current message.
SMPPPortThe server port for secure SMPP (default 3551).
SMPPServerThis is the SMPP entity to which the component will connect.
SMPPVersionThis is the SMPP version to be used throughout the connection.
SourceAddressThe source address of the current message.
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.
SystemTypeThis is a string representing the type of system during a connection.
TimeoutA timeout for the adapter.
TransportLogTells the adapter where and how to report information about its operations.
URIThe Uniform Resource Identifier (URI) of the send port or receive location.
UserIdThis value is used for identification with the SMPP service.
ValidityPeriodThe 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.

ConnectionLifetimeInstructs the adapter whether or not to leave the connection to the server open.
FirewallA set of properties related to firewall access.
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.
MessageExpirationDenotes the validity period of the current message.
MessagePriorityThis is the priority level of the current message.
MessageTextThe text of the short message to be sent.
OtherDefines a set of configuration settings to be used by the adapter.
PasswordThis is the user's password.
ReceivedMessageIdThe identifier of the most recently sent message.
RecipientAddressA comma-separated list of the recipient addresses of the current short message.
RecipientTypeIndicates the type of entities receiving the current short message.
ScheduledDeliveryThis value tells the server when to deliver the current message.
SendAsDataA boolean switch indicating whether the current short message should be sent as a data message.
SenderAddressThe addresses from which the current short message will be sent.
ServiceTypeThis indicates the type of service for the current message.
SMPPPortThe server port for secure SMPP (default 3551).
SMPPServerThis is the SMPP entity to which the component will connect.
SMPPVersionThis is the SMPP version to be used throughout the connection.
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.
SystemTypeThis is a string representing the type of system during a connection.
TimeoutA timeout for the adapter.
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.
UserIdThis 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.

DataCodingThe data encoding mechanism to be used for the current message.
DestinationNPIThe Number Planning Indicator for the destination ESME.
DestinationTONThe Type of Number for the destination ESME.
MCReceiptThe type of receipt you wish to receive for the current message.
ProtocolIdThe protocol identifier.
SMEAcknowledgementThe type of acknowledgement you wish to receive for the current message.
ReconnectAttemptIntervalThe time, in seconds, between reconnection attempts.
ReconnectAttemptLimitThe maximum number of reconnection attempts.
SourceNPIThe Number Planning Indicator for the ESME.
SourceTONThe Type of Number for the ESME.
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]