28 Native SMPP

SMPP Server Service

The core module of the Native SMPP communication service is an SMPP Server Service deployed as an Oracle WebLogic Server Service. It provides connection services for the Native SMPP and Parlay X 2.1 Short Messaging plug-ins. The SMPP Server Service:

• Receives SMPP data from the socket.

• Constructs the SMPP protocol data unit (PDU).

• Associates the current PDU with the correct application instance.

• Invokes the plug-in.

• Manages connections between Services Gatekeeper and applications.

• Manages connections between Services Gatekeeper and Short Message Service Centers (SMSCs).

Because the SMPP Server Service is deployed in the NT, applications using the Native SMPP Native communication service must be able to connect directly to the network tier. Firewalls must be configured to allow connection to the ports defined for the SMPP Server Service.

Connection Handling and Provisioning

The Native SMPP communication service uses the Services Gatekeeper SMPP Server Service to establish and manage southbound (client) connections between Services Gatekeeper and SMSCs.

See "System Properties for SMPP Server Service" and "Reference: Attributes and Operations for SMPP Server Service" for information about configuring connections between the Services Gatekeeper SMPP server service and a short messaging service center (SMSC).

A client connection is created when this plug-in successfully binds with an SMSC. A successful rebind changes the connection ID.

Creating an Interceptor With a Custom Error Code

For mobile-originated (MO) traffic, you can create an interceptor that includes any checks or validation tests for the SMS DeliverSm request message. In cases where you want to reject the DeliverSm message, you can send the DeliverSMResp message back to the SMSC with the SMPP commandStatus of your choosing. You create and add a DenyPluginException to the interceptor to set the error code. For example:

new DenyPluginException("custom_smpp_errorcode", decimal_smpp_commandstatus); 

Where decimal_smpp_commandstatus is the decimal format of a hexadecimal SMPP error code. For example, an error code value of ("custom_smpp_errorcode", 123) translates to the 0x0000007b command status.

See ”Using Service Interceptors to Manipulate Requests” in Services Gatekeeper Extension Developer's Guide for more information on using interceptors.

Example 28-1 shows an example interceptor that checks MO messages (ignoring delivery reports), confirms their sourceaddress, and if necessary, throws one of two DenyPluginException exception messages.

Deploy this interceptor the MO_NORTH interceptor point.

package com.bea.wlcp.wlng.interceptor;
 
import java.lang.reflect.Method;
import com.bea.wlcp.wlng.api.plugin.DenyPluginException;
import org.apache.log4j.Logger;
 
import com.bea.wlcp.wlng.api.interceptor.Context;
import com.bea.wlcp.wlng.api.interceptor.Interceptor;
 
 
public class NativeSMPPInterceptor implements Interceptor {
  private Logger logger = Logger.getLogger(NativeSMPPInterceptor.class);
 
  @Override
  public Object invoke(Context ctx) throws Exception {
 
    Object[] args = ctx.getArguments();
    String address = null;
 
    if (args == null || args.length == 0 || args[0] == null){
      //do nothing
    } else if (args[0].getClass().getName().equals(new String("oracle.ocsg.protocol.smpp.event.DeliverSm"))){
 
      try {
        Class<?> c = args[0].getClass();
        Method m = c.getMethod("isDeliverReceipt", new Class[0]);
        boolean isDeliverReceipt = (boolean) m.invoke(args[0], new Object[0]);
        if (!isDeliverReceipt) { //we only want to check MO messages, not delivery receipts
          m = c.getMethod("getSourceAddress", new Class[0]);
          Object obj = m.invoke(args[0], new Object[0]);
          Class<?> c1 = obj.getClass();
          Method m1 = c1.getMethod("getAddress", new Class[0]);
          address = (String) m1.invoke(obj, new Object[0]);
        }
      }catch(Exception e){
        e.printStackTrace();
        throw new RuntimeException();
      }
 
      if(address!= null && address.endsWith("9999")){
        //reject
        throw new DenyPluginException("custom_smpp_errorcode", 123);
      }else if(address!= null && address.endsWith("8888")) {
        //reject
        throw new DenyPluginException("custom_smpp_errorcode", 456);
      }else {
        //We 'approve' all other sourceaddresses
      }
    }
    return ctx.invokeNext(this);
  }
}

Authentication

Authentication credentials are configured in the Native SMPP plug-in instance MBean. See "Reference: Attributes and Operations for Native SMPP Plug-in" for more information.

Applications use an application instance ID as the ESME system_id and the related password when binding to Services Gatekeeper.

Connection Pooling

The SMPP Server Service maintains server and client connection pools.

Timeouts

You can configure timers for both application-facing and network-facing connections. Some of the timers for application-facing and network-facing connections have the same names, but they are configured in different MBeans.

Windowing

To maximize throughput, Native SMPP supports windowing on both the application-facing and network-facing interfaces. Windowing provides a way to specify the amount of data that can be transmitted without receiving an acknowledgment.

Requests wait in a windowing queue until they can be submitted. Two values apply to the windowing queue. The windowing maximum queue size is the size of the queue, specifying the maximum number of requests that can wait in the queue at one time. The windowing maximum wait time value specifies the maximum amount of time that a single request can wait in the windowing queue.

The windowing size value is the number of unacknowledged requests that can be sent simultaneously.

Windowing for mobile-originated requests toward the application is configured in the following parameters in the SMPP Server Service's addApplicationSpecificSettings operation:

• windowingSize

• windowingMaxQueueSize

• windowingMaxWaitTime

See "Operation: addApplicationSpecificSettings" for more information.

Windowing for mobile-terminated requests toward the SMSC is configured in the following plug-in instance MBean attributes:

• Attribute: WindowingSize

• Attribute: WindowingMaxQueueSize

• Attribute: WindowingMaxWaitTime

A request moves from the windowing queue to the window. From the window it is submitted for processing. A submitted request remains in the window until its response is received. When the response is received, the request is released and another request can be moved from the windowing queue to the window.

If any one of these three windowing parameters is set to a value less than zero, windowing is turned off. If all of these three parameters are greater than zero, windowing is turned on.

In both directions, if the windowing request queue is full or the timer has expired, the request is not sent and an error code is returned to the plug-in instance.

Connection-Based Routing

Connection-based routing lets network operators configure geo-redundant sites to allow applications to send mobile-originated (MO), mobile-terminated (MT,) and delivery receipt (DR) traffic to and from any of the redundant sites. For example, a DR can be sent to a site other than the one through which the original message was submitted.

Short Code Translation

The Native SMPP communication service does not offer short code translations.

USSD Support

Native SMPP provides Unstructured Supplementary Services Data (USSD) through the its_session_info, service_type, and ussd_service_operation optional parameters.

Billing Identification

The native SMPP communication service supports the billing_identification parameter in the format in the SMPP Specification 5.1 through an optional parameter named smpp_billing_id.

The parameter works with SMPP 5.1 SMSCs, but with not with SMPP 3.4 SMSCs.

Load Balancing, High Availability and Fail-Over

To optimize system utilization, applications should load-balance application-triggered requests among all network tier servers.

The SMSC should load-balance network-triggered requests among all network tier servers.

Load balancing is supported only among plug-in instances that are located in same network tier server and share same large account. When a request is sent to a plug-in instance, the plug-in instances use the SMPP Server Service in the same server to forward the request to the applications. When a request is sent to the SMPP Server Service, the SMPP Server Service uses a plug-in instance in the same server to process the request.

High availability and fail-over is supported between Services Gatekeeper and the SMSC. High availability between the application and Services Gatekeeper must be handled by each application.

A prerequisite for high-availability for the Native SMPP communication service is redundant network tier servers, redundant network interface cards in each network tier server, and a redundant set of SMPP servers to connect to. High availability between Services Gatekeeper and the network is achieved by using at least two different plug-in instances per network tier server and having the plug-in instances connect to different SMPP servers.

Between SMPP applications and Services Gatekeeper, the applications handle high availability and fail-over for application-initiated requests by binding to two or more network tier servers. For network-triggered requests, the same requirement that the applications bind to two or more network tier servers applies.

High availability behavior is as follows:

• In a Services Gatekeeper cluster, if the server becomes unavailable after sending a Submit SM request to and receiving the SUBMIT_SM_RESP from the SMSC, the SMSC routes the subsequent delivery receipt to another server. This other server retrieves the message information from cluster-level storage and processes it.

• In a Services Gatekeeper cluster, if a server becomes unavailable after sending a SUBMIT_ SM request to and receiving the SUBMIT_SM_RESP from an application, the application routes the subsequent CANCEL_SM, QUERY_SM or REPLACE_SM request to another server. This other server retrieves the message information from cluster-level storage and processes it.

• In a geo-redundant configuration, all sites are connected to the SMSC. If a site becomes unavailable after sending a SUBMIT_ SM request to and receiving the SUBMIT_SM_RESP from the SMSC, the SMSC routes the subsequent delivery receipt to another site. This other site uses connection-based routing to process the delivery receipt.

• In a geo-redundant configuration, if an application is configured to support subsequent operations (CANCEL_SM, QUERY_SM, and REPLACE_SM) through the subsequentOperationsAllowed parameter to the addApplicationSpecificSettings operation, those requests must be sent to the same geographic site from which the original submit requests were sent. They will not be accepted if they are sent to another site.

• In a geo-redundant configuration, if an application is configured to support subsequent operations and a submit request is sent through site 1 but delivery receipt arrives on site 2, the data stored about the message in the database on site 1 is not deleted until the information is considered to be too old. The consequence is that an application can continue sending subsequent operations related to the message through site 1 even after the message was delivered.

The Native SMPP communication service can be provisioned for applications to share the same large account in the SMPP server, so that they share the same bind. However, his configuration is not recommended since it impacts high availability for network-triggered requests. When there is only one bind between Services Gatekeeper and the SMPP server, and more than one application is listening for network-triggered messages, the Native SMPP communication service must listen to incoming messages on behalf of all the applications. The bind between the plug-in and the network node is performed on all network tier servers, so network-triggered messages can be sent to any of these servers. If the network-triggered request ends up in a server that the application has not bound to, the communication service does not try to look up a server that the application has bound to. Instead, it does not see an active bind and treats the request as undeliverable to the application. Because it is common for SMPP servers to load-balance between binds, it is very likely that 50% or more of the requests will fail in this setup. The only way to ensure high availability in this scenario is to mandate that all applications bind to all network tier servers.

Event Data Records

Table 28-2 lists IDs of the EDRs created by the SMPP Server Service.

The Native SMPP plug-in instance does not exchange events directly with the application or the SMSC, so it does not generate any EDRs.

Charging Data Records

Native SMPP plug-in-specific CDRs are generated under the following conditions:

• When a submitSm or submitSmMulti method has successfully been sent to the network, and Services Gatekeeper has received a response with OK status.

• When a deliverSm method with a mobile-originated message has been received by Services Gatekeeper, and a deliverSm has been forwarded to an application. Note that the CDR is generated regardless of commandstatus in DeliverSmResp from application.

• After Services Gatekeeper receives and processes DeliverSm with a delivery receipt. The CDR is generated regardless of whether Services Gatekeeper was able to forward the deliverSm to any applications. If the deliverSm was forwarded to an application, the CDR is generated regardless of commandstatus in DeliverSmResp from application.

Statistics

Table 28-3 maps methods invoked from either the application or the network to the transaction types collected by the Services Gatekeeper statistics counters.

Alarms

For the list of alarms, see Services Gatekeeper Alarms Handling Guide.

Attribute: native_smpp_mo_destAddressHasAppMapping

Format: Boolean

Default Value: False

If it is set to true, Services Gatekeeper checks whether there is an application matching the destination address in the DeliverSm action. False means that Services Gatekeeper does not to check for a matching application in DeliverSm.

Attribute: native_smpp_mo_hasActiveReceiver

Format: Boolean

Default Value: False

If set to true, Services Gatekeeper checks whether the application matching the destination address in DeliverSm has an active receiver connection. False means that Services Gatekeeper does not check whether the application has an active receiver connection.

System Property: oracle.ocsg.protocol.smpp.serverservice.max_threads

Format: Integer

Maximum number of threads available to server connections.

The default is 32.

System Property: oracle.ocsg.protocol.smpp.serverservice.min_threads

Format: Integer

Minimum number of threads available to client and server connections. Each client connection uses one thread. Each server port uses one thread.

The default is 2.

System Property: wlng.legacy.smpp.PDUManipulationAllowed

Format: Boolean

Specifies whether an interceptor can modify a parameter passed between the SMPP Server Service and a plug-in.

Set to true to allow parameter modification, false to prohibit it.

The default is true.

System Property: wlng.smpp.max_payload_size

Format: Integer

Specifies the maximum number of characters in an SMS message.

The default is the maximum defined by the Parlay X 2.1 SMS specification: 160 GSM 7-bit characters or 70 Unicode characters.

Attribute: ConnectionBasedRouting

Scope: Cluster

Unit: Not applicable

Format: Boolean

Enables and disables connection-based routing for Native SMPP plug-ins.

Connection-based routing lets operators configure geo-redundant sites to allow applications to send MO, MT, and DR traffic to and from either of the sites.

Set to true to enable, false to disable. The default is false.

For more information, see "Connection-Based Routing".

This attribute can be modified only when there are no active connections between SMPP applications and the SMPP Server Service.

Attribute: EnquireLinkMaxFailureTimes

Scope: Cluster

Unit: Not applicable

Format: Integer

Maximum number of failed ENQUIRE_LINK requests to the application before the connection with the application is closed.

Attribute: EnquireLinkTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Minimum interval between the submission of ENQUIRE_LINK requests (heartbeats) to an application.

To disable the sending of ENQUIRE_LINK requests, set this value to 0 (zero).

Attribute: InactivityTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Maximum period of inactivity for an application before the connection with the application is closed.

Use 0 (zero) for no timeout.

Attribute: InitiationTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Maximum time between establishment a connection to the application and the BIND request.

If the timeout value is reached, the server connection is closed.

Use 0 (zero) for no timeout.

Attribute: LooseBinding

Scope: Server

Unit: Not applicable

Format: Boolean

Controls behavior on application BIND and UNBIND.

If true, the following applies:

• As long as there are transmitting-capable connections (TX, TRX) from applications, TX and TRX connections will be kept open to SMSCs.

• As long as there are receiving-capable connections (RX, TRX) from applications, RX and TRX connections will be kept open to SMSCs.

If false, the binding rules are more restrictive:

• As long as there are TX connections from applications, TX connections will be kept open to SMSCs.

• As long as there are RX connections from applications, RX connections will be kept open to SMSCs.

• As long as there are TRX connections from applications, TRX connections will be kept open to SMSCs.

This attribute value cannot be changed while there is an active connection with an application.

The default is true.

Attribute: OfflineMO

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies whether the JMS-based routing functionality for network-triggered messages is enabled. If true, a message from the network to an NT server that does not have an active bind to the appropriate application can be placed in a JMS queue from which another server that does have an active bind can fetch it and send it to the application.

The default is false.

The time that the message stays alive in the JMS queue is configurable. The default value is 3600000 milliseconds. To change this value, in the administrative console:

1. Select Services ->Messaging->JMS Modules.

2. Click WLNGJMSResource. The Settings page opens.

3. On the Configuration tab, click LegacySMSConnectionFactory. The Settings for LegacySMSConnectionFactory page opens

4. On the Configuration tab, select the Default Delivery sub-tab.

5. Make your changes to the Default Time-to-Live attribute.

6. Click Save.

7. Click the Activate Changes button in the Change Center.

This attribute is not applicable if ConnectionBasedRouting is true.

Attribute: rejectMOMessagesWithNoAppReceiverConnection

Scope: Cluster

Format: Boolean

Default value: FALSE.

If set to true, rejects a MO DeliverSm request early in the processing flow.

If set to false, the request is still rejected, but much later in the processing flow, and in some cases after attempting a resend of the message.

Both cases address the condition where:

• A receiver connection exists between Services Gatekeeper and an SMSC

• No matching receiver connection between Services Gatekeeper and application exists that can handle a DeliverSm action.

Attribute: RequestTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Maximum time between the submission of a request to an application and the receipt of the corresponding response, before the connection is closed.

Set to 0 (zero) for no timeout.

Attribute: ServerAddress

Scope: Server

Unit: Not applicable

Format: String

Default host name or IP address that applications use to connect to the SMPP Server Service.

Multiple addresses are supported as a comma-separated list of IP addresses.

Attribute: ServerPort

Scope: Server

Unit: Not applicable

Format: Integer [1024–65535]

Default port that applications use to connect to the SMPP Server Service.

Updating this attribute takes effect immediately if the old port and the new port are not in use. In this case, the SMPP Server Service closes the old port and opens the new port.

If the old port is in use when this attribute is set, it is closed after the last application instance that used it is removed by the deleteApplicationSpecificSettings operation. See "Operation: deleteApplicationSpecificSettings" for more information.

When a new application instance is added with the addApplicationSpecificSettings operation, if the acceptPort parameter to that operation is a negative value, all traffic from the application uses the new port. See "Operation: addApplicationSpecificSettings" for more information.

Attribute: skipAddressrangeCheckInBindRequest

Scope: Cluster

Unit: NA

Format: Boolean

Default Value: False

If set to false, Services Gatekeeper confirms that the address range provided in the bind request from a Native SMPP application exactly matches what is provisioned in the application-specific setting. The address range must exactly match.

You can remove this checking by setting this attribute to true.

Attribute: SmscSystemId

Scope: Cluster

Unit: Not applicable

Format: String; maximum 16 characters

SMSC system ID. Sent to an ESME client upon a successful BIND.

Operation: addApplicationSpecificSettings

Scope: Cluster

Specifies connection details for an application with the specified applicationInstanceId.

Required for an application instance to access the SMPP Server Service.

This operation takes effect immediately after it is invoked. The SMPP Server Service closes the old port, if it is not in use, and opens the new port, if it is not in use.

See "Windowing" for more information about the windowingSize, windowingMaxQueueSize, and windowingMaxWaitTime parameters.

Signature:

addApplicationSpecificSettings(applicationInstanceId: int, acceptPort: int, maxSession: int, subsequentOperationsAllowed: boolean, notificationEnabled: boolean, addressRange: String, windowingSize: int, windowingMaxQueueSize: int, windowingMaxWaitTime: int)

Operation: closeClientConnection

Scope: Server

Closes the specified client connection between the communication service and the SMSC.

You use the connectionId and pluginInstanceId parameters to establish connections. See "Connection Handling and Provisioning" for information on using these parameters.

Signature:

closeClientConnection(connectionId: String, pluginInstanceId: String)

Operation: closeServerConnection

Scope: Server

Closes the specified server connections between the communication service and the application.

You use the connectionId and pluginInstanceId parameters to establish connections. See "Connection Handling and Provisioning" for information on using these parameters.

If the port parameter is matched, closes all connections to that port.

Signature:

closeServerConnection(connectionId: string, appInstanceId: string, port: int)

Operation: closeServerPort

Scope: Server

Closes the specified server port on which the SMPP Server Service is listening. Closes all server and client connections on the specified port.

Signature:

closeServerPort(port: int)

Operation: deleteApplicationSpecificSettings

Scope: Cluster

Deletes application-specific settings for an application with the specified applicationInstanceId.

The application will no longer be able to access the SMPP Server Service.

Signature:

deleteApplicationSpecificSettings(applicationInstanceId: String)

Operation: listApplicationSpecificSettings

Scope: Cluster

Displays all application-specific settings.

Signature:

listApplicationSpecificSettings()

Operation: listClientConnections

Scope: Server

Displays description and status of all client connections. These are connections between the communication service and the SMSC.

Signature:

listClientConnections()

Operation: listClusterServerConnectionsForMOJumping

Scope: Cluster

Displays the description and status for cluster server connections for which the MO jumping is enabled.

For information about MO jumping, see "Attribute: OfflineMO" for more information.

Signature:

listClusterServerConnectionsForMOJumping()

Operation: listPluginInstances

Scope: Server

Displays description and status for all registered plug-in instances.

listPluginInstances()

Operation: listServerConnections

Scope: Server

Displays description and status of each server connection.

Signature:

listServerConnections()

Operation: listServerPorts

Scope: Server

Displays description and status of each server port.

Signature:

listServerPorts()

Operation: resetClientConnection

Scope: Server

Closes and restarts the specified client connection between the communication service and the SMSC. See "About Creating and Resetting Connections" for information on using the connectionId and pluginstanceId parameters to create connections.

connectionId Syntax for the Native SMPP plug-in:

plugin_instance_id#plugin_version

For example:

Plugin_px21_short_messaging_smpp_myinstance#6.0.0.0

connectionId Syntax for the Parlay X 2.1 Short Messaging/SMPP plug-in:

Plugin_px21_short_messaging_smpp_myinstance

For example:

plugin_instance_id

Signature:

resetClientConnection(connectionId: String, pluginInstanceId: String)

Operation: resetServerPort

Scope: Server

Closes and restarts the specified application-facing server port on which the SMPP Server Service is listening. This operation resets all server and client connections on the specified port.

Signature:

resetServerPort(port: int)

Operation: updateAllServerPorts

Scope: Server

Closes and restarts all server ports all local server ports in the current configuration.

Signature:

updateAllServerPorts()

Attribute: BindType

Scope: Server

Unit: Not applicable

Format: Integer

Specifies how the plug-in binds to the SMSC.

Use:

• 1 to bind as Transceiver

• 2 to bind as Transmitter

• 3 to bind as Receiver

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: DeliverSmRespCommandStatus

Scope: Cluster

Unit: Not applicable

Format: Integer

Error code to used in the command_status field when the application is unavailable. See section 5.1.3 command_status in SMPP Protocol Specification v3.4.

Specifies how the plug-in responds to an SMSC if a network-triggered short message cannot be delivered to an application that subscribed for notifications on incoming short messages.

The default is ESME_RINVDSTADR.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Table 28-13 lists the possible values for DeliverSmRespCommandStatus.

Attribute: EnableDeleteAfterCancel

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies whether to delete SMPP session information from storage after receipt of a CANCEL_SM_RESP.

The default is true.

Attribute: EnableDeleteAfterNotify

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies whether to delete SMPP session information from storage after receipt of the delivery report with the final message state.

The default is true.

Attribute: EnableDeleteAfterQuery

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies whether to delete SMPP session information from storage after the receipt of the query response with the final message state.

The default is false.

Attribute: EnquireLinkTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Minimum interval between ENQUIRE_LINK requests to the SMSC.

The default is 60.

To disable the sending of ENQUIRE_LINK requests, set this value to 0 (zero).

Attribute: EsmeAddressRange

Scope: Server

Unit: Not applicable

Format: String formatted as a regular expression.

ESME address range. This is the address range of the SMS messages to be sent to the plug-in instance by the SMSC.

The default is ^.*$.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: EsmeNpi

Scope: Server

Unit: Not applicable

Format: Integer

The ESME Numbering Plan Indicator (NPI) used in a BIND request.

Used for destination address and as a default for originating address. Also used for both destination address and originating address during bind operation. Use:

• 0 for Unknown

• 1 for ISDN (E163/E164)

• 3 for Data (X.121)

• 4 for Telex (F.69)

• 6 for Land Mobile (E.212)

• 8 for National

• 9 for Private

• 10 for ERMES

• 14 for Internet (IP)

• 18 for WAP Client ID

The default is 0.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: EsmePassword

Scope: Cluster

Unit: Not applicable

Format: String

Password used by the plug-in instance for connecting to the SMSC as an ESME.

Attribute: EsmeSystemId

Scope: Cluster

Unit: Not applicable

Format: String

System ID used by the plug-in instance when connecting to the SMSC as an ESME.

The default is OCSG.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: EsmeSystemType

Scope: Cluster

Unit: Not applicable

Format: String

System type used by the plug-in instance for connecting to the SMSC as an ESME.

The default is mess_gateway.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: EsmeTon

Scope: Cluster

Unit: Not applicable

Format: Integer

ESME Type Of Number (TON).

Used for destination address and as a default for originating address. Also used for both destination address and originating address in a BIND request. Use:

• 0 for Unknown

• 1 for International

• 2 for National

• 3 for Network

• 4 for Subscriber

• 5 for Alphanumeric

• 6 for Abbreviated

• 7 Reserved

The default is 0.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: LocalAddress

Scope: Server

Unit: Not applicable

Format: String

Local server address used by the plug-in to connect to the SMSC. The address can be expressed as an IP address or host name. The address or host name must resolve to a local address.

Enter "" to use the default address of the server.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: LocalPort

Scope: Server

Unit: Not applicable

Format: Integer [1 - (65535 - number of connections)]

Local port used by the plug-in to connect to the SMSC.

The default is 3000.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: MessageIdInHexFormat

Scope: Cluster

Unit: Not applicable

Format: Boolean

Specifies the message_id format used in SUBMIT_SM_RESP, SUBMIT_MULTI_RESP, DATA_SM_RESP operations.

If true, the format is hexadecimal; if false, it is decimal.

The default is false.

Attribute: NumberReceiverConnections

Scope: Cluster

Unit: Not applicable

Format: Integer

Number of connections used to connect to the SMSC if the bind type is 3.

The default is 1.

See "Attribute: BindType" for more information.

The connections are established with the first successful BIND between the application and Services Gatekeeper, if connection-based routing is disabled.

If connection-based routing is enabled, connections to the SMSC cannot be shared among different application instances, so this attribute is ignored.

Attribute: NumberTransceiverConnections

Scope: Cluster

Unit: Not applicable

Format: Integer

Number of connections used to connect to the SMSC if the bind type is 1.

The default is 1.

See "Attribute: BindType" for more information.

The connections are established with the first successful BIND between the application and Services Gatekeeper, if connection-based routing is disabled.

If connection-based routing is enabled, connections to the SMSC cannot be shared among different application instances, so this attribute is ignored.

Attribute: NumberTransmitterConnections

Scope: Cluster

Unit: Not applicable

Format: Integer

Number of connections used to connect to the SMSC if the bind type is or 2.

The default is 1.

See "Attribute: BindType" for more information.

The connections are established with the first successful BIND between the application and Services Gatekeeper, if connection-based routing is disabled.

If connection-based routing is enabled, connections to the SMSC cannot be shared among different application instances, so this attribute is ignored.

Attribute: RequestTimerValue

Scope: Cluster

Unit: Seconds

Format: Integer

Maximum time between the submission of a request to the SMSC and the receipt of the corresponding response before the connection is terminated.

The default is 20.

Set to 0 (zero) for no timeout.

Attribute: RetryTimesBeforeGiveUp

Scope: Cluster

Unit: Not applicable

Format: Integer

Maximum number of times for the plug-in to try to reconnect to the server service.

The default is 30.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: RetryTimesBeforeReconnect

Scope: Cluster

Unit: Not applicable

Format: Integer

Maximum number of times for the plug-in to try to connect to the server service before attempting to reconnect.

The default is 3.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: SmscAddress

Scope: Cluster

Unit: Not applicable

Format: String

SMSC address as an IP address or host name.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: SmppVersion

Scope: Cluster

Unit: Not applicable

Format: String

SMPP version of the communication service used between Services Gatekeeper and the SMSC.

Valid values are 3.4 and 5.1.

3.4 is the fully-supported version.

5.1 is provided to support the billing identification parameter and the ussd_service_operation parameter for the DELIVER_SM operation. See "USSD Support" and "Billing Identification" for information about these parameters

The default is 3.4.

Attribute: SmscPort

Scope: Cluster

Unit: Not applicable

Format: Integer

Listening port used by the SMSC

The default is 5016.

The setting is not applied until the plug-in is restarted or the SMPP Server Service "Operation: resetClientConnection" is performed.

Attribute: WindowingMaxQueueSize

Scope: Cluster

Unit: Not applicable

Format: Integer

Maximum number of mobile-terminated requests to the SMSC allowed in the windowing queue.

The default is 100.

If any one of the three windowing attributes (WindowingMaxQueueSize, WindowingMaxWaitTime, or WindowingSize) is set to a value less than zero, windowing is turned off. If all of these three attributes have values greater than zero, windowing is turned on.

See "Windowing" for general information about windowing.

Attribute: WindowingMaxWaitTime

Scope: Cluster

Unit: Seconds

Format: Integer

Maximum time that a mobile-terminated request to the SMSC is allowed to wait in the windowing queue.

The default is 15.

If any one of the three windowing attributes (WindowingMaxQueueSize, WindowingMaxWaitTime, or WindowingSize) is set to a value less than zero, windowing is turned off. If all of these three attributes have values greater than zero, windowing is turned on.

See "Windowing" for general information about windowing.

Attribute: WindowingSize

Scope: Cluster

Unit: Not applicable

Format: Integer

Maximum number of simultaneous unacknowledged mobile-terminated requests to the SMSC enforced for each connection.

The default is 5.

If any one of the three windowing attributes (WindowingMaxQueueSize, WindowingMaxWaitTime, or WindowingSize) is set to a value less than zero, windowing is turned off. If all of these three attributes have values greater than zero, windowing is turned on.

See "Windowing" for general information about windowing.