/n software BizTalk Adapters V4 - Online Help
Available for:
/n software BizTalk Adapters V4
Questions / Feedback?

SMPP Configuration

The adapter accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the adapter, access to these internal properties is provided through the Other property.

SMPP Configuration Settings

DataCoding:   The data encoding mechanism to be used for the current message.

This value informs the message recipient about how the data was encoded. The possible values are as follows:

0MC Specific encoding
1IA5 (CCITT T.50)/ASCII (ANSI X3.4)
2Octet unspecified (8-bit binary)
3Latin 1 (ISO-8859-1)
4Octet unspecified (8-bit binary)
5JIS (X 0208-1990)
6Cyrillic (ISO-8859-5)
7Latin/Hebrew (ISO-8859-8)
8UCS2 (ISO/IEC-10646)
9Pictogram Encoding
10ISO-2022-JP (Music Codes)
11Reserved
12Reserved 2
13Extended Kanji JIS (X 0212-1990)
14KS C 5601

DestinationNPI:   The Number Planning Indicator for the destination ESME.

When sending messages, this value is used to indicate the numbering plan the destination ESME. For a list of possible values, please see SourceNPI.

DestinationTON:   The Type of Number for the destination ESME.

When sending messages, this value is used to indicate the Type of Number for the destination ESME. For a list of possible values, please see SourceTON.

MCReceipt:   The type of receipt you wish to receive for the current message.

Setting this config property will cause the component to ask the SMSC for a message delivery receipt. The default value is None (0). The possible values are:

None (0)The SMSC will send no notification.
Final (1)The SMSC will only send a notification when the message has been delivered.
Failure (2)The SMSC will only send a notification if the message encounters an error.
Success (3)The SMSC will only send a notification when it has successfully received the message from the SME.

ProtocolId:   The protocol identifier.

This config property allows control of the protocol identifier field value used in the outgoing messages.

SMEAcknowledgement:   The type of acknowledgement you wish to receive for the current message.

Setting this config property will cause the component to ask the remote SME for a delivery acknowledgement. The default value is None (0). The possible values are:

None (0)The SME need not acknowledge the message.
Delivery (1)The SME should acknowledge when it has received the message.
Manual (2)The SME should prompt a user to manually acknowledge the message, typically once they have read it.
Both (3)The SME should perform both types of acknowledgement.

ReconnectAttemptInterval:   The time, in seconds, between reconnection attempts.

When receiving messages, this value is used to indicate the number of seconds to wait between reconnection attempts. This is only applicable when PersistentConnection is set to Yes.

ReconnectAttemptLimit:   The maximum number of reconnection attempts.

When receiving messages, this value is used to indicate that maximum number of reconnection attempts. This is only applicable when PersistentConnection is set to Yes.

SourceNPI:   The Number Planning Indicator for the ESME.

When binding, this value is used to specify the numbering plan of the ESME. Mobiles tend to set this value to 1. Since most ESMEs are mobiles, the default value for SourceNPI is 1. The possible value are:

Unknown (0)
ISDN (1)
Data (3)
Telex (4)
LandMobile (6)
National (8)
Private (9)
ERMES (10)
Internet (14)
WAP (18)

SourceTON:   The Type of Number for the ESME.

When binding, this value is used to indicate the Type of Number for the ESME address. The possible values are:

Unknown (0)The number type is unknown
International (1)The number includes the international trunk prefix
National (2)The number includes the national trunk prefix
NetworkSpecific (3)The number exists on a network that uses a specific delivery protocol
SubscriberNumber (4)The number is just the subscriber number, without prefixes
Alphanumeric (5)The address is human-readable (contains letters and digits)
Abbreviated (6)The number is abbreviated

SSL Configuration Settings

SSLEnabledProtocols:   Used to enable/disable the supported security protocols.

Used to enable/disable the supported security protocols.

Not all supported protocols are enabled by default (the value of this setting is 240). If you want more granular control over the enabled protocols, you can set this property to the binary 'OR' of one or more of the following values:

TLS1.23072 (Hex C00) (Default)
TLS1.1768 (Hex 300) (Default)
TLS1 192 (Hex C0) (Default)
SSL3 48 (Hex 30)
SSL2 12 (Hex 0C)

TLS 1.1 and TLS1.2 support are only available starting with Windows 7.

General Configuration Settings

AbsoluteTimeout:   Determines whether timeouts are inactivity timeouts or absolute timeouts.

If AbsoluteTimeout is set to True, any method which does not complete within Timeout seconds will be aborted. By default, AbsoluteTimeout is False, and the timeout is an inactivity timeout.

LocalHost:   The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

The LocalHost configuration contains the name of the local host as obtained by the Gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the adapter initiate connections (or accept in the case of server adapters) only through that interface.

If the adapter is connected, the LocalHost configuration shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

TcpNoDelay:   Whether or not to delay when sending packets.

When true, the socket will send all data that is ready to send at once. When false, the socket will send smaller buffered packets of data at small intervals. This is known as the Nagle algorithm.

By default, this config is set to false.

UseManagedSecurityAPI:   Tells the adapter whether or not to use the system security libraries or a managed implementation.

By default the adapter will use the system security libraries to perform cryptographic functions. This means calls to unmanaged code will be made. In certain environments this is not desirable. To use a completely managed security implementation set this setting to True. Setting this to True tells the adapter to use the internal managed implementation instead of using the system's security API.

Note that when this value is set the product's system dll is no longer required as a reference, as all unmanaged code is stored in this file.

Connections Configuration Settings

PersistedConnectionTimeout:   How long to leave a persisted connection alive.

If persisted connections are enabled and PersistedConnectionTimeout is set to a positive value, the connection will be kept alive for that number of minutes after a message transmission. If no other messages are sent over that connection during the timeout period, the adapter will disconnect from that server.

Note: the default value is 0. This value means that the connection will be kept alive unless the server disconnects it due to idling.

Supported Macros

The adapter also supports the following Macros. These values are not case sensitive and would be supplied to a property in the form %MacroName%.

TempThis is resolved to the full path to the system's temporary directory.
MessageIDGlobally unique identifier (GUID) of the message in BizTalk Server.
SourceFileNameThe original file name. This includes the extension and excludes the file path, for example, Sample.xml
SourceFileNameNoExtThe original file name without the extension or file path, for example, Sample
RemoteFileNameThe name of the file as it was uploaded to the remote server. This includes the extension and excludes the file path, for example, Sample.xml. Valid only for AS3, FTP, and SFTP Send Adapters.
DestinationPartyName of the destination party.
DestinationPartyQualifierQualifier of the destination party.
SourcePartyName of the source party.
SourcePartyQualifierQualifier of the source party.
DateTime:CustomFormatThis special value allows you to specify your own custom time format. For instance DateTime:yyyy would be resolved to the 4 digit year.
DateThe date format yyyy-MM-dd.
DateTimeThe date format yyyy-MM-ddThhmmss.
TimeThe date format hhmmss.
DateTime_BTS2000The date format yyyyMMddhhmmssf.
DateTime.TZThe date format yyyy-MM-ddThhmmsszzz.
Time.TZThe date format hhmmsszzz.

 
 
Copyright (c) 2017 /n software inc. - All rights reserved.
Build 4.0.6240.0