# System Administrator’s Guide

# Managing and Configuring Short Messaging Communication Services

The following section describes configuration and maintenance attributes and operations for the communication services that expose Parlay X 2.1 Short Messaging and Extended Web Services Binary SMS Web Services interfaces. The sections also provide a workflow for the configuration:

- Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

- Properties for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
- Configuration Workflow for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
- Management Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
- Reference: Attributes and Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

## Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

This section contains a description of the configuration attributes and operations available for the Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP network protocol plug-in instances. The plug-in instance is shared between these.

To see a | Refer to
--- | ---
Detailed list of necessary information for managing and configuring the plug-in instance | Properties for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
Configuration workflow | Configuration Workflow for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
List of operations and attributes related to management and provisioning | Management Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
Reference of management attributes and operations | Reference: Attributes and Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

### Properties for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

Property | Description
--- | ---
Managed object in Administration Console | <domain name>OCSG<server name>Communication Services<plug-in instance ID>
MBean | Domain=com.bea.wlcp.wlng Name=wlng_nt InstanceName is same as plug-in instance ID. Type=com.bea.wlcp.wlng.plugin.sms.smpp.management.SmsMBean
Network protocol plug-in service ID | Plugin_px21_short_messaging_smpp
Network protocol plug-in instance ID | The ID is given when the plug-in instance is created, see Managing and Configuring the Plug-in Manager.
Supported Address Scheme | tel
North interfaces | Parlay X 2.1 Short Messaging/SMPP: com.bea.wlcp.wlng.px21.plugin.SendSmsPlugin com.bea.wlcp.wlng.px21.plugin.ReceiveSmsPlugin com.bea.wlcp.wlng.px21.plugin.SmsNotificationManagerPlugin com.bea.wlcp.wlng.px21.callback.SmsNotificationCallback Extended Web Services Binary SMS/SMPP: com.bea.wlcp.wlng.ews.plugin.BinarySmsPlugin com.bea.wlcp.wlng.ews.plugin.BinarySmsNotificationManagerPlugin com.bea.wlcp.wlng.ews.callback.BinarySmsNotificationCallback
Service type | Sms
Exposes to the service communication layer a Java representation of: | Parlay X 2.1 Short Messaging/SMPP: Parlay X 2.1 Part 4: Short Messaging Extended Web Services Binary SMS/SMPP: Extended Web Services Binary SMS
Interfaces with the network nodes using: | SMPP 3.4
Deployment artifacts NT EAR wlng_nt_sms_px21.ear | Parlay X 2.1 Short Messaging/SMPP: Plugin_px21_short_messaging_smpp.jar and px21_sms_service.jar Extended Web Services Binary SMS/SMPP: NT EAR ews_binary_sms_service.jar
AT EAR: Normal wlng_at_sms_px21.ear | Parlay X 2.1 Short Messaging/SMPP px21_sms.war, px21_sms_callback.jar, and rest_sms.war Extended Web Services Binary SMS/SMPP: ews_binary_sms.war and ews_binary_sms_callback.jar
AT EAR: SOAP only wlng_at_sms_px21_soap.ear | Parlay X 2.1 Short Messaging/SMPP px21_sms.war and px21_sms_callback.jar Extended Web Services Binary SMS/SMPP: ews_binary_sms.war and ews_binary_sms_callback.jar

### Configuration Workflow for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

Below is an outline of configuring a plug-in instance using the Oracle Communications Services Gatekeeper Management Console:

1. Create one or more instances of the plug-in service: see Managing and Configuring the Plug-in Manager. Use the plug-in service ID as detailed in Properties for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP.
2. Using the Management Console or an MBean browser, select the MBean for the plug-in instance. The MBean display name is the same as the plug-in instance ID given when the plug-in instance was created.
3. Configure the behavior of the plug-in instance:

- 8 for USC2
- Attribute: EsmeAddressRange
- Attribute: EsmeNpi
- Attribute: EsmePassword
- Attribute: EsmeSystemId
- Attribute: EsmeSystemType
- Attribute: EsmeTon
- Attribute: ForwardXParams
- Attribute: RequestDeliveryReports
- Attribute: SMSCDefaultAlphabet
- Attribute: SequenceNumberRangeEndId
- Attribute: SequenceNumberRangeStartId
- Attribute: SmscAddress
- Attribute: SmscPort
- Attribute: UserTextMaxLength
- Operation: addOriginatingAddressTypeMapping
- Operation: translateOriginatingAddressNpi
- Operation: translateOriginatingAddressTon
- Attribute: ConnectDelayValue
- Attribute: ConnectTotalTimeValue
- Attribute: EnquireLinkRequestTimerValue
- Attribute: EnquireLinkTimerValue
- Attribute: RequestTimerValue
- Attribute: SegmentsLimit

4. Specify Attribute: BindType, and depending on which type, the following:

- Attribute: TransmitterProxyLocalAddressAndPort, Attribute: ReceiverProxyLocalAddressAndPort, Attribute: NumberTransmitterConnections, and Attribute: NumberReceiverConnections

or

- Attribute: TransceiverProxyLocalAddressAndPort and Attribute: NumberTransceiverConnections.

5. Specify Attribute: WindowSize, and depending on the setting, the following:

- Operation: addOriginatingAddressTypeMapping

6. Specify Attribute: ReceiveSmsIgnoreMissingSegments, and depending on the setting, the following:

- Attribute: ReceiveSegmentsWaitTime

7. Set up the routing rules to the plug-in instance: see Configuring the Plug-in Manager. Use the plug-in instance ID and address schemes detailed in Properties for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP
8. If desired, create and load a node SLA, see:

Defining Global Node and Service Provider Group Node SLAs

Managing Application SLAs

Continue with the provisioning of service provider accounts and application accounts.

### Management Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

The following operations are related to management:

- Operation: enableReceiveSms
- Operation: countOfflineNotificationCache
- Operation: countOnlineNotificationCache
- Operation: countSmsCache
- Operation: getOfflineNotificationInfo
- Operation: getOnlineNotificationInfo
- Operation: removeOfflineNotificationInfo
- Operation: removeOnlineNotificationInfo
- Operation: resetSMPPConnection

### Reference: Attributes and Operations for Parlay X 2.1 Short Messaging/SMPP and Extended Web Services Binary SMS/SMPP

Below is a list of attributes and operations for configuration and maintenance:

- Attribute: WindowSize
- Attribute: ModuleId (r)
- Attribute: EsmePassword
- Attribute: EsmeAddressRange
- Attribute: SequenceNumberRangeStartId
- Attribute: SequenceNumberRangeEndId
- Attribute: BindType
- Attribute: ReceiveSmsIgnoreMissingSegments
- Attribute: DataSm
- Attribute: SmscAddress
- Attribute: DefaultDataCoding
- Attribute: SMSCDefaultAlphabet
- Attribute: UserTextMaxLength
- Attribute: SegmentsLimit
- Attribute: MobileCountryCode
- Attribute: MobileNetworkCode
- Attribute: ReceiveSegmentsWaitTime
- Attribute: Messaging Mode
- Attribute: SmscPort
- Attribute: TransmitterProxyLocalAddressAndPort
- Attribute: ReceiverProxyLocalAddressAndPort
- Attribute: TransceiverProxyLocalAddressAndPort
- Attribute: EsmeSystemId
- Attribute: EsmeSystemType
- Attribute: EsmeTon
- Attribute: OriginatingAddressTon
- Attribute: DestinationAddressTon
- Attribute: ForwardXParams
- Attribute: EsmeNpi
- Attribute: OriginatingAddressNpi
- Attribute: DestinationAddressNpi
- Attribute: SmppVersion (r)
- Attribute: EnquireLinkTimerValue
- Attribute: ConnectTotalTimeValue
- Attribute: ConnectDelayValue
- Attribute: RequestTimerValue
- Attribute: EnquireLinkRequestTimerValue
- Attribute: RequestDeliveryReports
- Attribute: ActiveStatus (r)
- Attribute: NumberTransmitterConnections
- Attribute: NumberReceiverConnections
- Attribute: NumberTransceiverConnections
- Attribute: WindowWaitTimeout
- Operation: addOriginatingAddressTypeMapping
- Operation: countOfflineNotificationCache
- Operation: countOnlineNotificationCache
- Operation: countSmsCache
- Operation: enableReceiveSms
- Operation: getOfflineNotificationInfo
- Operation: getOnlineNotificationInfo
- Operation: listOfflineNotificationInfo
- Operation: listOnlineNotificationInfo
- Operation: listOriginatingAddressTypeMappings
- Operation: removeOfflineNotificationInfo
- Operation: removeOnlineNotificationInfo
- Operation: removeOriginatingAddressTypeMapping
- Operation: resetSMPPConnection
- Operation: startSmsNotification
- Operation: translateOriginatingAddressNpi
- Operation: translateOriginatingAddressTon

### Attribute: WindowSize

Scope: Server

Unit: n/a

Format: int [-1 | 1..n]

Specifies the maximum allowed number of unacknowledged SMPP operations between a plug-in instance and an SMSC, enforced for each connection.

This setting applies only to requests sent from the plug-in to the SMSC, not to requests from the SMSC to the plug-in.

A value of -1 indicates that the number of unacknowledged operations is not restricted. Other valid values must be greater than 0 (zero).

### Attribute: ModuleId (r)

Scope: Server

Unit: n/a

Format: string

Specifies the plugin instance ID. Read only.

### Attribute: EsmePassword

Scope: Server

Unit: n/a

Format: string

Specifies the password used by the plug-in instance when connecting to the SMSC as an ESME.

### Attribute: EsmeAddressRange

Scope: Server

Unit: n/a

Format: String formatted as a regular expression.

Specifies the ESME address range. Specifies the address range of the SMSes to be sent to the plug-in instance by the SMSC. The address range is specified as a UNIX regular expression.

### Attribute: SequenceNumberRangeStartId

Scope: Server

Unit: n/a

Format: int

Specifies the start ID of the Sequence Number range.

### Attribute: SequenceNumberRangeEndId

Scope: Server

Unit: n/a

Format: int

Specifies the end ID of the Sequence Number range.

### Attribute: BindType

Scope: Server

Unit: n/a

Format: int enumeration [0, 1]

Specifies how the plug-in shall bind to the SMSC.

Use:

- 0 to bind as TRANSMITTER and RECEIVER
- 1 to bind as Transceiver

### Attribute: ReceiveSmsIgnoreMissingSegments

Scope: Server

Unit: n/a

Format: Boolean [TRUE | FALSE]

Specifies if the plug-in instance shall deliver network-triggered short messages with missing message segments to applications or not.

Use:

- true if the plug-in shall assemble received segments and deliver the incomplete message to the application.
- false if the plug-in shall not deliver messages to the application unless all segments are received.

### Attribute: DataSm

Scope: Server

Unit: n/a

Format: Boolean [TRUE | FALSE]

Specifies if binary data is being sent

- true if binary data is being sent
- false otherwise

### Attribute: SmscAddress

Scope: Server

Unit: n/a

Format: string

Specifies the SMSC address as an IP-address or a host name. The setting will not be applied in until the plug-in service is restarted or Operation: resetSMPPConnection is performed.

### Attribute: DefaultDataCoding

Scope: Server

Unit: n/a

Format: int

Specifies the default data coding to use when sending SMS messages. This value will be used if a data coding is not provided by the north interface.

See `data_coding` parameter in the SMPP specification for valid values. Use:

- 0 for SMSC Default Alphabet
- 1 for ASCII

### Attribute: SMSCDefaultAlphabet

Scope: Server

Unit: n/a

Format: int

Specifies the SMSC Default Alphabet. This is the default character encoding scheme used by the SMSC when encoding short messages. The plug-in instance needs to use the same character encoding scheme for the characters to be decoded correctly. All encoding schemes supported by JAVA are possible.

Use:

- ASCII for American Standard Code for Information Interchange
- Cp1252 for Windows Latin-1
- ISO8859_1 for ISO 8859-1, Latin alphabet No. 1.
- GSM_DEFAULT for default GSM character set.

### Attribute: UserTextMaxLength

Scope: Server

Unit: n/a

Format: int

Specifies the maximum number of characters allowed in a Short Message.

### Attribute: SegmentsLimit

Scope: Server

Unit: n/a

Format: int

Specifies the maximum number of SMPP segments an application is allowed to send when using the Extended Web Services Binary SMS interface.

### Attribute: MobileCountryCode

Scope: Server

Unit: n/a

Format: int

Specifies the Mobile Country Code for sending operator logos.

### Attribute: MobileNetworkCode

Scope: Server

Unit: n/a

Format: int

Specifies the Mobile Network Code for sending operator logos.

### Attribute: ReceiveSegmentsWaitTime

Scope: Server

Unit: seconds

Format: int

Specifies the maximum time to wait for the arrival of the segments of a concatenated short message from the SMSC since the arrival of the first segment.

### Attribute: Messaging Mode

Scope: Server

Units: n/a

Format: int

Specifies the The ESM_CLASS Messaging Mode for packets.

- 2: Forward (Transaction mode). Used only when DataSm is true.
- 3: Store and Forward mode

### Attribute: SmscPort

Scope: Server

Unit: n/a

Format: string

Specifies the port used by the SMSC. The setting will not be applied in until the plug-in service is restarted or Operation: resetSMPPConnection is performed.

### Attribute: TransmitterProxyLocalAddressAndPort

Scope: Server

Unit: n/a

Format: String

The address and port which the transmitter of the SMPP SMSC should bind to on the server where the plug-in instance executes. This allows for specifying which NIC the transmitter should bind on.

The default value is an empty string, which means that it will bind to the default NIC. This should be sufficient for most cases as it uses the default values, but the plug-in instance can also bind on specific NICs and specific local ports.

The format of this attribute is:

`<local IP address on external NIC>:<port the SMPP SMSC should bind to on the local machine>`

The port number must be stated, unless an empty string is used. The port number should not be set to any port number that is already bound.

Examples:

- myHostname:4767
- 10.41.26.34:7890

Note: | You normally do not need to configure this value.

If this attribute has been changed Operation: resetSMPPConnection must be invoked for the changes

### Attribute: ReceiverProxyLocalAddressAndPort

Scope: Server

Unit: n/a

Format: String

The address and port which the receiver of the SMPP SMSC should bind to on the server on which the plug-in instance executes. This allows for specification of the NIC on which the receiver should bind.

The default value is an empty string, which means that it will bind to the default NIC. This should be sufficient for most cases as it uses the default values, but the plug-in instance can also bind on specific NICs and specific local ports.

The format of this attribute is:

`<local IP address on external NIC>:<port the SMPP SMSC should bind to on the local machine>`

The port number must be stated, unless an empty string is used. The port number should not be set to any port number that is already bound.

Examples:

- myHostname:4767
- 10.41.26.34:7890

Note: | You normally do not need to configure this value.

If this attribute has been changed Operation: resetSMPPConnection must be invoked for the changes to apply.

### Attribute: TransceiverProxyLocalAddressAndPort

Scope: Server

Unit: n/a

Format: String

The address and port which the transceiver of the SMPP SMSC should bind to on the server where the plug-in instance executes. This allows for specifying which NIC the transceiver should bind on.

The default value is an empty string, which means that it will bind to the default NIC. This should be sufficient for most cases as it uses the default values, but the plug-in instance can also bind on specific NICs and specific local ports.

The format of this attribute is:

`<local IP address on external NIC>:<port the SMPP SMSC should bind to on the local machine>`

The port number must be stated, unless an empty string is used. The port number should not be set to any port number that is already bound.

Examples:

- myHostname:4767
- 10.41.26.34:7890

Note: | You normally do not need to configure this value.

If this attribute has been changed Operation: resetSMPPConnection must be invoked for the changes to apply.

### Attribute: EsmeSystemId

Scope: Server

Unit: n/a

Format: string

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

### Attribute: EsmeSystemType

Scope: Server

Unit: n/a

Format: string

Specifies the system type used by the plug-in instance when connecting to the SMSC as an ESME.

### Attribute: EsmeTon

Scope: Server

Unit: n/a

Format: Integer

Specifies the ESME Type Of Number (TON). Used during bind operation.

Use:

- 0 for UNKNOWN
- 1 for INTERNATIONAL
- 2 for NATIONAL
- 3 for NETWORK
- 4 for SUBSCRIBER
- 5 for ALPHANUMERIC
- 6 for ABBREVIATED
- 7 for RESERVED_EXTN

### Attribute: OriginatingAddressTon

Scope: Server

Unit: n/a

Format: Integer

Specifies the ESME Type Of Number (TON). Used as a default for originating address.

Use:

- 0 for UNKNOWN
- 1 for INTERNATIONAL
- 2 for NATIONAL
- 3 for NETWORK
- 4 for SUBSCRIBER
- 5 for ALPHANUMERIC
- 6 for ABBREVIATED
- 7 for RESERVED_EXTN

### Attribute: DestinationAddressTon

Scope: Server

Unit: n/a

Format: Integer

Specifies the ESME Type Of Number (TON). Used as a default for destination address.

Use:

- 0 for UNKNOWN
- 1 for INTERNATIONAL
- 2 for NATIONAL
- 3 for NETWORK
- 4 for SUBSCRIBER
- 5 for ALPHANUMERIC
- 6 for ABBREVIATED
- 7 for RESERVED_EXTN

### Attribute: ForwardXParams

Scope: Server

Unit: n/a

Format: Boolean

Specifies if tunnelled parameters are forwarded to applications for network triggered requests or not. Use:

- true to enable forwarding
- false to disable forwarding

### Attribute: EsmeNpi

Scope: Server

Unit: n/a

Format: int

Specifies the ESME Numbering Plan Indicator (NPI).

Used 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

### Attribute: OriginatingAddressNpi

Scope: Server

Unit: n/a

Format: int

Specifies the ESME Numbering Plan Indicator (NPI).

Used as a default for originating address.

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

### Attribute: DestinationAddressNpi

Scope: Server

Unit: n/a

Format: int

Specifies the ESME Numbering Plan Indicator (NPI).

Used as a default for destination address.

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

### Attribute: SmppVersion (r)

Read only.

Displays the version of the SMPP protocol being used.

### Attribute: EnquireLinkTimerValue

Scope: Server

Unit: minutes

Format: int

Specifies the Enquire Link Timer value. The plug-in instance performs an Enquire Link operation to the SMSC to keep the connection alive. The time between enquiries is specified by this timer value.

Note: | To turn off the sending of Enquire Link, set the timer value to 0.

### Attribute: ConnectTotalTimeValue

Scope: Server

Unit: minutes

Format: int

Specifies the amount of time to keep trying to connect to the SMSC, when the connection is lost.

- 8 for USC2

### Attribute: ConnectDelayValue

Scope: Server

Unit: seconds

Format: int

Specifies the delay time between connection attempts, when the connection to the SMSC is lost.

### Attribute: RequestTimerValue

Scope: Server

Unit: milliseconds

Format: int

Specifies the value of the timer used when sending requests to the SMSC.

### Attribute: EnquireLinkRequestTimerValue

Scope: Server

Unit: milliseconds

Format: int

Specifies the value of the timer used when sending Enquire Link requests.

### Attribute: RequestDeliveryReports

Scope: Cluster

Unit: n/a

Format: Boolean [TRUE | FALSE]

Specifies if the default behavior of the plug-in instance is to request delivery reports or not.

Use:

- true if delivery reports should be requested.
- false if delivery reports should not be requested.

If delivery requests are not requested, applications will, by default, not have the ability to poll for delivery status. However it is possible to override the default setting by in the service provider SLA, application SLA, or by a custom policy rule.

### Attribute: ActiveStatus (r)

Read-only.

Scope: Server

Unit: n/a

Displays the state of the connection between the plug-in instance and the SMSC. True if the transmitter is successfully connected to the SMPP server; false if not.

### Attribute: NumberTransmitterConnections

Scope: Server

Unit: n/a

Format: int

Specifies the number of Transmitter connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transmitter and Receiver.

### Attribute: NumberReceiverConnections

Scope: Server

Unit: n/a

Format: int

Specifies the number of Receiver connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transmitter and Receiver.

### Attribute: NumberTransceiverConnections

Scope: Server

Unit: n/a

Format: int

Specifies the number of Transceiver connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transceiver.

### Attribute: WindowWaitTimeout

Scope: Server

Unit: milliseconds

Format: int

Specifies the time to wait before a connection becomes available under the restriction defined in Attribute: WindowSize. Only valid when window size is enforced.

### Operation: addOriginatingAddressTypeMapping

Scope: Cluster

If a tunnelled parameter, `com.bea.wlcp.wlng.plugin.sms.OriginatingAddressType`, is a available in a request, the value of the parameter is extracted and matched against the originating address type mapping list. The matching is with the parameter type.

Signature:

    addOriginatingAddressTypeMapping(type: String, ton: int, npi: int)

Table 23-1 addOriginatingAddressTypeMapping
addOriginatingAddressTypeMapping
Parameter | Description
--- | ---
type | Specifies the originating address type to be mapped.
ton | Specifies the ESME Type Of Number (TON). Use: 0 for UNKNOWN 1 for INTERNATIONAL 2 for NATIONAL 3 for NETWORK 4 for SUBSCRIBER 5 for ALPHANUMERIC 6 for ABBREVIATED
npi | Specifies the ESME Numbering Plan Indicator (NPI). 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

### Operation: removeOriginatingAddressTypeMapping

Scope: Cluster

Removes an existing TON/NPI address type mapping for a given originating address type.

Signature:

    removeOriginatingAddressTypeMapping(type: String)

Table 23-2 removeOnlineNotificationInfo
removeOriginatingAddressTypeMapping
Parameter | Description
--- | ---
type | Originating address type for the mapping, see Operation: addOriginatingAddressTypeMapping and Operation: listOriginatingAddressTypeMappings.

### Operation: translateOriginatingAddressNpi

Internal operation.

### Operation: translateOriginatingAddressTon

Internal operation.

### Operation: countOfflineNotificationCache

Read only.

Scope: Cluster

Displays the number of entries in the off-line notification cache.

Signature:

    countOfflineNotificationCache()

Table 23-3 countOfflineNotificationCache
countOfflineNotificationCache
Parameter | Description
--- | ---
- | -

### Operation: countOnlineNotificationCache

Read only.

Scope: Cluster

Displays the number of entries in the on-line notification cache.

Signature:

    countOnlineNotificationCache()

Table 23-4 countOnlineNotificationCache
countOnlineNotificationCache
Parameter | Description
--- | ---
- | -

### Operation: countSmsCache

Read only.

Scope: Cluster

Displays the sum of short messages in the cache for mobile originating messages and mobile terminated short messages. There are separate caches (stores) for mobile originating and mobile terminating short messages but this method returns the sum.

Signature:

    countSmsCache()

Table 23-5 countSmsCache
countSmsCache
Parameter | Description
--- | ---
- | -

### Operation: enableReceiveSms

Read only.

Scope: Cluster

Adds an offline notification for applications that poll for mobile originated short messages. Those mobile originating Short Messages which match the criteria will not result in a notification callback to an application. Instead the message is stored in Oracle Communications Services Gatekeeper. The application has to use the correlator returned by this method to poll for Short Messages.

Signature:

    enableReceiveSms(smsServiceActivationNumber: String, criteria: String, appInstanceID: String)

Table 23-6 countSmsCache
countSmsCache
Parameter | Description
--- | ---
smsServiceActivationNumber | Destination address of the short message. Prefixed with the URI, for example `tel:`
criteria | Text to match against to determine if the application should receive the notification.
appInstanceID | ID of the application instance.

### Operation: getOfflineNotificationInfo

Read only.

Scope: Cluster

Displays information about a notification registered off-line, see Operation: enableReceiveSms.

Signature:

    getOfflineNotificationInfo(correlator: String)

Table 23-7 getOfflineNotificationInfo
getOfflineNotificationInfo
Parameter | Description
--- | ---
correlator | Correlator identifying the notification.

### Operation: getOnlineNotificationInfo

Read only.

Scope: Cluster

Displays information about a notification registered by an application

Signature:

    getOnlineNotificationInfo(correlator: String)

Table 23-8 getOnlineNotificationInfo
getOnlineNotificationInfo
Parameter | Description
--- | ---
correlator | Correlator identifying the notification.

### Operation: listOfflineNotificationInfo

Read only.

Scope: Cluster

Displays a list of all notifications registered off-line.

Signature:

    listOfflineNotificationInfo()

Table 23-9 listOfflineNotificationInfo
listOfflineNotificationInfo
Parameter | Description
--- | ---
- | -

### Operation: listOnlineNotificationInfo

Read only.

Scope: Cluster

Displays a list of all notifications registered by an application.

Signature:

    listOnlineNotificationInfo()

Table 23-10 listOnlineNotificationInfo
listOnlineNotificationInfo
Parameter | Description
--- | ---
- | -

### Operation: listOriginatingAddressTypeMappings

Read only.

Scope: Cluster

Displays a list of all originating address type mappings.

Signature:

    listOriginatingAddressTypeMappings()

Table 23-11 listOriginatingAddressTypeMappings
listOriginatingAddressTypeMappings
Parameter | Description
--- | ---
- | -

### Operation: removeOfflineNotificationInfo

Scope: Cluster

Removes a notification registered off-line.

Signature:

    removeOfflineNotificationInfo(correlator: String)

Table 23-12 removeOfflineNotificationInfo
removeOfflineNotificationInfo
Parameter | Description
--- | ---
correlator | Correlator identifying the notification.

### Operation: removeOnlineNotificationInfo

Scope: Cluster

Removes a notification registered by an application.

Signature:

    removeOnlineNotificationInfo(correlator: String)

Table 23-13 removeOnlineNotificationInfo
removeOnlineNotificationInfo
Parameter | Description
--- | ---
correlator | Correlator identifying the notification.

### Operation: resetSMPPConnection

Scope: Server

Resets the connection to the SMSC. If the plug-in instance has stopped trying to connect to the SMSC, invoking this method will restart the reconnect procedure.

Signature:

    resetSMPPConnection()

Table 23-14 resetSMPPConnection
resetSMPPConnection
Parameter | Description
--- | ---
- | -

### Operation: startSmsNotification

Scope: Cluster

Registers a notification for mobile originating Short Messages on behalf of an application. Has the same result as if the application used`startSmsNotification` in the Parlay X 2.1 interface SmsNotificationManager.

Signature:

    startSmsNotification(endpoint: String, smsServiceActivationNumber: String, criteria: String, appInstanceID: String)

Table 23-15 startSmsNotification
startSmsNotification
Parameter | Description
--- | ---
endpoint | Notification endpoint implemented by the application. This endpoint implements the Parlay X 2.1 Interface: SmsNotification. Format: URL.
smsServiceActivationNumber | Destination address to the short message address.
criteria | Text in the payload of the Short Message to match to determine the application to receive the notification.
appInstanceID | ID of the application instance.