|
|
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:
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.
The ID is given when the plug-in instance is created, see Managing and Configuring the Plug-in Manager.
|
|
|
|
|
Below is an outline of configuring a plug-in instance using the Oracle Communications Services Gatekeeper Management Console:
Continue with the provisioning of service provider accounts and application accounts.
The following operations are related to management:
Below is a list of attributes and operations for configuration and maintenance:
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).
Specifies the plugin instance ID. Read only.
Specifies the password used by the plug-in instance when connecting to the SMSC as an ESME.
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.
Specifies the start ID of the Sequence Number range.
Specifies the end ID of the Sequence Number range.
Format: int enumeration [0, 1]
Specifies how the plug-in shall bind to the SMSC.
Format: Boolean [TRUE | FALSE]
Specifies if the plug-in instance shall deliver network-triggered short messages with missing message segments to applications or not.
Format: Boolean [TRUE | FALSE]
Specifies if binary data is being sent
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.
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:
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.
Specifies the maximum number of characters allowed in a Short Message.
Specifies the maximum number of SMPP segments an application is allowed to send when using the Extended Web Services Binary SMS interface.
Specifies the Mobile Country Code for sending operator logos.
Specifies the Mobile Network Code for sending operator logos.
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.
Specifies the The ESM_CLASS Messaging Mode for packets.
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.
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.
| Note: | You normally do not need to configure this value. |
If this attribute has been changed Operation: resetSMPPConnection must be invoked for the changes
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.
| 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.
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.
| 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.
Specifies the system ID used by the plug-in instance when connecting to the SMSC as an ESME.
Specifies the system type used by the plug-in instance when connecting to the SMSC as an ESME.
Specifies the ESME Type Of Number (TON). Used during bind operation.
Specifies the ESME Type Of Number (TON). Used as a default for originating address.
Specifies the ESME Type Of Number (TON). Used as a default for destination address.
Specifies if tunnelled parameters are forwarded to applications for network triggered requests or not. Use:
Specifies the ESME Numbering Plan Indicator (NPI).
Used during bind operation. Use:
Specifies the ESME Numbering Plan Indicator (NPI).
Used as a default for originating address.
Specifies the ESME Numbering Plan Indicator (NPI).
Used as a default for destination address.
Displays the version of the SMPP protocol being used.
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. |
Specifies the amount of time to keep trying to connect to the SMSC, when the connection is lost.
Specifies the delay time between connection attempts, when the connection to the SMSC is lost.
Specifies the value of the timer used when sending requests to the SMSC.
Specifies the value of the timer used when sending Enquire Link requests.
Format: Boolean [TRUE | FALSE]
Specifies if the default behavior of the plug-in instance is to request delivery reports or not.
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.
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.
Specifies the number of Transmitter connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transmitter and Receiver.
Specifies the number of Receiver connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transmitter and Receiver.
Specifies the number of Transceiver connections used towards the SMSC. Also see Attribute: BindType. Relevant when bind type is Transceiver.
Specifies the time to wait before a connection becomes available under the restriction defined in Attribute: WindowSize. Only valid when window size is enforced.
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.
addOriginatingAddressTypeMapping(type: String, ton: int, npi: int)
Removes an existing TON/NPI address type mapping for a given originating address type.
removeOriginatingAddressTypeMapping(type: String)
Originating address type for the mapping, see Operation: addOriginatingAddressTypeMapping and Operation: listOriginatingAddressTypeMappings.
|
|
Displays the number of entries in the off-line notification cache.
countOfflineNotificationCache()
Displays the number of entries in the on-line notification cache.
countOnlineNotificationCache()
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.
countSmsCache()
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.
enableReceiveSms(smsServiceActivationNumber: String, criteria: String, appInstanceID: String)
Displays information about a notification registered off-line, see Operation: enableReceiveSms.
getOfflineNotificationInfo(correlator: String)
Displays information about a notification registered by an application
getOnlineNotificationInfo(correlator: String)
Displays a list of all notifications registered off-line.
listOfflineNotificationInfo()
Displays a list of all notifications registered by an application.
listOnlineNotificationInfo()
Displays a list of all originating address type mappings.
listOriginatingAddressTypeMappings()
Removes a notification registered off-line.
removeOfflineNotificationInfo(correlator: String)
Removes a notification registered by an application.
removeOnlineNotificationInfo(correlator: String)
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.
resetSMPPConnection()
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.
startSmsNotification(endpoint: String, smsServiceActivationNumber: String, criteria: String, appInstanceID: String)
|
