34 Configuring IM-UIX-SMS

The following sections describe how to configure the Oracle Communications Service Broker IM-UIX-SMS Interworking Module (IM) using the Service Broker Administration Console and Java MBeans.

About IM-UIX-SMS

IM-UIX-SMS is a network-facing module that enables Service Broker to receive messages from, and send them to, Short Message Service Centers (SMSCs) through the Short Message Peer-to-Peer Protocol (SMPP).

In conjunction with application-facing IMs (for example, IM-ASF), IM-UIX-SMS provides a solution for routing messages between SMSCs and applications.

IM-UIX-SMS communicates with SMSCs as follows:

• An SMSC sends messages to IM-UIX-SMS.

  IM-UIX-SMS receives a delivery_sm request sent by an SMSC through the SMPP SSU. IM-UIX-SMS translates the request to a SAL message and sends it to the OE. The OE routes the message to an appropriate IM based on the orchestration logic.

  See the discussion on configuring incoming routing rules in the chapter on configuring SMPP Signaling Server Units in Oracle Communications Service Broker Signaling Domain Configuration Guide for more information about setting up rules for routing messages to IM-UIX-SMS instances.

• IM-UIX-SMS sends messages to an SMSC.

  IM-UIX-SMS receives a message sent by an application through an application-facing IM that supports the appropriate protocol (for example, through IM-ASF when a message is sent over SIP). Based on the received message, IM-UIX-SMS generates a submit_sm message and sends it to an SMSC through the SMPP SSU.

  See the discussion on configuring SMPP network entities in the chapter on configuring SMPP Signaling Server Units in Oracle Communications Service Broker Signaling Domain Configuration Guide for more information about setting up rules for routing messages to SMSCs.

To set up the communication between SMSCs and IM-UIX-SMS, you need to configure the following parameters:

• The body encoding format, which defines the format that IM-UIX-SMS uses to encode the parameters of a delivery_sm message. See "Specifying the Body Encoding Format" for more information.

• Parameters of SMPP operations that IM-UIX-SMS uses to generate a submit_sm message. See "Configuring SMPP Operations" for more information.

• Monitoring parameters of IM-UIX-SMS. See "Configuring Monitoring Parameters" for more information.

You can configure these parameters by using the Administration Console or Java MBeans.

Specifying the Body Encoding Format

IM-UIX-SMS receives delivery_sm messages from SMSCs. Before routing these messages to the OE, IM-UIX-SMS translates them into SAL messages. You can select the encoding format that IM-UIX-SMS uses to encode parameters of delivery_sm messages in the body of SAL messages.

Specifying the Body Encoding Format with the Administration Console

To specify the body encoding format in the Administration Console:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Expand Interworking Modules.

4. Select the instance of IM-UIX-SMS that you want to configure.

   The IM-UIX-SMS configuration pane appears.

5. Click the General tab.

6. From the Body Encoding Format list, select the format that IM-UIX-SMS uses to encode the parameters of a short message in the body of SAL messages:

   • NONE

     Select if you do not want to encode the parameters of a short message.

   • XER

     Select to use XML Encoding Rules.

   • BER

     Select to use Basic Encoding Rules.

7. Click Apply.

Specifying the Body Encoding Format with Java MBeans

Specify the body encoding format by using the GeneralMBean MBean. This MBean is created automatically. See "IM-UIX-SMS Configuration MBeans Reference" for information about the object name of this MBean.

To specify the body encoding format, set the BodyEncodingFormat attribute of GeneralMBean to one of the following values:

• NONE

  Select if you do not want to encode the parameters of a short message.

• XER

  Select to use XML Encoding Rules.

• BER

  Select to use Basic Encoding Rules.

Configuring SMPP Operations

To route a message sent by an application to an SMSC, IM-UIX-SMS generates a submit_sm message. You configure how IM-UIX-SMS generates this message by configuring SMPP operations.

Configuring SMPP Operations with the Administration Console

To configure SMPP operations:

1. In the domain navigation pane, expand OCSB.

2. Expand Processing Tier.

3. Expand Interworking Modules.

4. Select the instance of IM-UIX-SMS that you want to configure.

   The IM-UIX-SMS configuration pane appears.

5. Click the SMPP Handling tab.

6. Fill in the fields described in Table 34-1.

   Table 34-1 SMPP Handling Parameters

   Name	Type	Description
   Default SMSC Alias	STRING	Specifies the alias of the SMSC to which IM-UIX-SMS sends the message. You map this alias to the physical address of an SMSC by configuring the SMPP SSU. See the discussion on configuring SMPP network entities in the chapter on configuring SMPP Signaling Server Units in Oracle Communications Service Broker Signaling Domain Configuration Guide for more information.
   Submit Destination Address Type of Number	STRING	Specifies the type of number of the destination address, which is set in the short message. Possible values: ALPHANUMERIC ABBREVIATED UNKNOWN INTERNATIONAL NATIONAL NETWORK-SPECIFIC SUBSCRIBER_NUMBER
   Submit Destination Address Numbering Plan Identification	STRING	Specifies the numbering plan identification of the destination address, which is set in the short message. Possible values: ALPHANUMERIC ABBREVIATED NATIONAL NETWORK_SPECIFIC SUBSCRIBER_NUMBER UNKNOWN ISDN DATA TELEX LAND_MOBILE
   Submit Message Mode	STRING	Specifies how the SMSC should deliver messages to the recipient SME. Possible values: DEFAULT_SMSC_MODE DATAGRAM_MODE FORWARD STORE_AND_FORWARD_MODE Note: The current release of Service Broker does not currently support FORWARD.
   Submit Message Type	STRING	Specifies the type of message that an SMPP operation carries. Possible values: DEFAULT_MESSAGE_TYPE SM_CONTAINS_ESME_DELIVERY_ACKNOWLEDGEMENT SM_CONTAINS_ESME_MANUAL_USER_ACKNOWLEDGEMENT
   Submit SM Priority Level	STRING	Specifies the priority level of a short message. Possible values: LEVEL_0 LEVEL_1 LEVEL_2 LEVEL_3
   SMSC Delivery Receipt Request	STRING	Specifies the type of the delivery receipt that the SMSC sends after receiving the short message. Possible values: NO_DELIVERY_RECEIPT_REQUESTED DELIVERY_RECEIPT_REQUESTED_FOR_SUCCESS_OR_FAILURE DELIVERY_REQUEST_RECEIPT_REQUESTED_FOR_FAILURE
   SME Acknowledgement Request	STRING	Specifies the type of the acknowledgement that the SME sends after receiving the short message from an SMSC. Possible values: NO_RECEIPIENT_SME_ACKNOWLEDGDEMENT _REQUESTED SME_DELIVERY_ACKNOWLEDGEMENT_REQUESTED SME_MANUAL_USER_ACKNOWLEDGEMENT_REQUESTED BOTH_DELIVERY_AND_MANUAL_USER_ACKNOWLEDGEMENT_REQUESTED
   Submit Validity Period Format	STRING	Specifies the format in which validity of the short message is defined. Possible values: VP_NOT_PRESENT VP_RELATIVE_FORMAT VP_ABSOLUTE_FORMAT
   Submit Validity Period Source	STRING	Specifies the source that defines the validity period of the short message. Possible values: STATIC_CONFIGURATION SAL_MESSAGE
   Submit Validity Period Value	INT	Specifies the time, in seconds, during which the short message is valid. IM-UIX-SMS applies this value only when: Submit Validity Period Source is set to STATIC_CONFIGURATION Submit Validity Period Format is set to VP_RELATIVE_FORMAT
   Replace if Present	STRING	Specifies whether to request the SMSC to replace a previously submitted message, that is still pending delivery. Possible values: DONT_REPLACE REPLACE
   Data Coding	STRING	Specifies the coding scheme of the short message. Possible values: SMSC_DEFAULT_ALPHABET IA5 LATIN_1 CYRILLIC LATIN_HEBREW UCS2 PICTOGRAM_ENCODING ISO_2022_JP EXTENDED_KANJI_JIS KS_C_5601
   Privacy Indicator	STRING	Specifies the privacy level of the short message. Possible values: NOT_RESTRICTED RESTRICTED CONDIFENTIAL SECRET
   Submit Include User Message Reference	STRING	Specifies whether IM-UIX-SMS sets the user_message_reference parameter in the submit_sm message. Possible values: TRUE FALSE

   
   

7. Click Apply.

Configuring SMPP Operations with Java MBeans

You configure SMPP operations with JavaMBeans, you use the SmppHandlingGeneralMBean MBean. See "IM-UIX-SMS Configuration MBeans Reference" for more information about the object name of this MBean.

To configure SMPP operations, set the following attributes of SmppHandlingMBean

• DefaultSmscAlias

• SubmitDestinationAddressTypeOfNumber

• SubmitDestinationAddressNumberingPlanIdentification

• SubmitMessageMode

• SubmitMessageType

• SubmitSmPriorityLevel

• SmscDeliveryReceiptRequest

• SmeAcknowledgementRequest

• SubmitValidityPeriodFormat

• SubmitValidityPeriodSource

• SubmitValidityPeriodValue

• ReplaceIfPresent

• DataCoding

• PrivacyIndicator

• SubmitIncludeUserMessageReference

See Table 34-1 for information about these attributes.

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-UIX-SMS. For more information about configuring monitoring, see "Configuring Monitoring with the Administration Console".

IM-UIX-SMS Configuration MBeans Reference

The following sections provide reference information for the IM-UIX-SMS configuration MBeans.

Note:

MBeans described in this chapter may include additional advanced attributes, which are not described in the chapter. Advanced attributes are reserved for internal use. Do not change any attributes that are not described in this chapter.

The following MBeans are common for all components of Service Broker and described in "Configuring Monitoring with Java MBeans":

• MonitoringGeneralMBean

• ThresholdCrossedNotificationRulesMBean

• ThresholdCrossedNotificationRuleMBean

• StateChangedNotificationRulesMBean

• StateChangedNotificationRuleMBean

---

Impuixsmssmpp34MBean

Impuixsmssmpp34MBean is the root MBean for configuring IM-UIX-SMS.

Object Name

com.convergin:Type=IMPUIXSMSSMPP34,Version=MBean_Version,Location=AdminServer,Name=IM-UIX-SMS.Instance_Name

Factory Method

Created automatically.

Attributes

None

Operations

ObjectName getGeneral()

Gets a reference to the instance of GeneralMBean.

ObjectName getSmppHandling()

Gets a reference to the instance of SmppHandlingMBean.

ObjectName getMonitoringGeneral()

Gets a reference to the instance of MonitoringGeneralMBean.

ObjectName getThresholdCrossedNotificationRules()

Gets a reference to the instance of ThresholdCrossedNotificationRulesMBean.

ObjectName getStateChangedNotificationRules()

Gets a reference to the instance of StateChangedNotificationRulesMBean.

---

GeneralMBean

Use GeneralMBean to specify the format that IM-UIX-SMS uses to encode parameters of a delivery_sm message in the body of SAL messages that are sent to the OE.

Object Name

com.convergin:Type=General,Version=MBean_Version,Location=AdminServer,Name=IM-UIX-SMS.Instance_Name

Factory Method

Created automatically.

Attributes

BodyEncodingFormat

Operations

None

---

SmppHandlingMBean

Use SmppHandlingMBean to configure SMPP operations that IM-UIX-SMS uses to generate submit_sm messages that are sent to an SMSC.

Object Name

com.convergin:Type=SmppHandling,Version=MBean_Version,Location=AdminServer,Name=IM-UIX-SMS.Instance_Name

Factory Method

Created automatically.

Attributes

• DefaultSmscAlias

• SubmitDestinationAddressTypeOfNumber

• SubmitDestinationAddressNumberingPlanIdentification

• SubmitMessageMode

• SubmitMessageType

• SubmitSmPriorityLevel

• SmscDeliveryReceiptRequest

• SmeAcknowledgementRequest

• SubmitValidityPeriodFormat

• SubmitValidityPeriodSource

• SubmitValidityPeriodValue

• ReplaceIfPresent

• DataCoding

• PrivacyIndicator

• SubmitIncludeUserMessageReference

See Table 34-1 for information about these attributes.

Operations

None