33 Setting Up IM-UIX-USSD SMPP

This chapter describes how to set up an IM-UIX-USSD SMPP interworking module.

About IM-UIX-USSD SMPP Setup

The process of IM-UIX-USSD SMPP setup requires the following:

1. Adding an IM-UIX-USSD SMPP to your Oracle Communications Service Broker deployment. You can add as many modules of type IM-UIX-USSD SMPP as you need. See "Adding an IM-UIX-USSD SMPP to the Service Broker Deployment" for more information.

2. Configuring the IM-UIX-USSD SMPP. See "Configuring an IM-UIX-USSD" for more information.

Adding an IM-UIX-USSD SMPP to the Service Broker Deployment

To add an IM-UIX-USSD SMPP:

1. In the domain navigation pane, expand the OCSB node.

2. Expand the Processing Tier node.

3. Expand the Interworking Modules node.

4. Select IM Management.

5. On the bottom of the IM Management pane, click New.

6. In the New window, fill out the fields as follows:

   • In the Type list, select IMUIXUSSDSMPP34.

   • In the Version list, select the required version.

   • In the Name field, enter a name for this module as it should appear in the list of modules. In this field, you can only use lower case letters (a-z), upper case letters (A-Z), numbers (0-9), and underscores (_). If you attempt to use a character which is not allowed, Service Broker displays the error message and prompts you to enter a different name.

7. Click OK.

8. In the notification window that reminds you to commit the changes, click OK.

9. To add the new IM-UIX-USSD SMPP to your deployment, in the Change Center pane, click Commit.

   A new module of type IM-UIX-USSD SMPP is now added to your Service Broker deployment. The new module is displayed in the domain navigation pane under the Interworking Modules node.

Configuring an IM-UIX-USSD

To configure an IM-PSX ANSI-MAP:

1. In the Change Center, click Lock & Edit.

2. In the domain navigation pane, under the Interworking Modules node, select the newly added IM-PSX ANSI-MAP.

The IM-UIX-USSD configuration pane contains the tabs described in Table 33-1.

Table 33-1 IM-UIX-USSD Configuration Tabs

Tab	Description
Supplementary Service Handling	Enables you to specify a format that IM-UIX-USSD uses to encode USSD in a SAL message and the time period that IM-UIX-USSD waits for the SIP application to send a new request. See "Configuring Supplementary Service Handling" for more information.
SMPP Handling	Enables you to configure how IM-UIX-USSD handles USSD received from, and sent to, an HLR. See "Configuring SMPP Handling Parameters" for more information.
Monitoring	Enables you to define the way that Runtime MBeans and notifications operate. See "Configuring Monitoring Parameters" for more information.

Configuring Supplementary Service Handling

The Supplementary Service Handling tab enables you to specify a format that IM-UIX-USSD uses to encode USSD in a SAL message and the time period that IM-UIX-USSD waits for the SIP application to send a new request.

Table 33-2 describes the configuration parameters on the Supplementary Service Handling tab.

Table 33-2 IM-UIX-USSD Supplementary Service Handling Parameters

Name	Type	Description
Body Encoding Format	STRING	Specifies the method that the IM-UIX-USSD uses to encode USSD in the body of a SAL message. Possible options: BER XER None Default value: None
AS Idle Interval in Seconds	INT	Specifies the maximum time period, in seconds, that IM-UIX-USSD waits for the SIP application to send a new request. When the specified time is reached, IM-UIX-USSD terminates the session.
USSD Message Maximum Length	INT	Specifies the maximum length of the USSD message.

Configuring SMPP Handling Parameters

The SMPP Handling tab enables you to configure how IM-UIX-USSD generates a submit_sm message.

Table 33-3 describes the configuration parameters on the SMPP Handling tab.

Table 33-3 SMPP Handling Parameters

Name	Type	Description
Default SMSC Alias	STRING	Specifies the alias of the SMSC to which IM-UIX-USSD sends SMPP requests. 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 Server Units Configuration Guide for more information.
Service Type	STRING	Specifies the SMS Application service associated with the message.
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-USSD 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-USSD sets the user_message_reference parameter in the submit_sm message. Possible values: TRUE FALSE
Preferred Identity	STRING	Specifies a preferred identity of the SMPP submit_sm destination address. Possible values: IMSI MSISDN
USSD Confirmation Phase	STRING	Specifies the phase for which the IM-UIX-USSD sends a USSD acknowledgement to the application. Possible values: SUBMIT_SM_RESP DELIVER_SM
SMSC Reaction Interval in Seconds	INT	Specifies the time period, in seconds, during which the IM-UIX-USSD waits for the SMSC to confirm the USSD request with a deliver_sm.

Configuring Monitoring Parameters

The Monitoring tab enables you to define how Runtime MBeans and notifications operate for an IM-UIX-USSD. For more information about configuring monitoring, see "Configuring Service Broker Monitoring" in "Monitoring Service Broker Using Runtime MBeans" in Oracle Communications Service Broker System Administrator's Guide.