Description

Feature name

USSDNotification

Applicable contexts

  • SS7 service

  • Diameter Service

  • SIP Service

Prerequisite features

  • Optional: Any feature which sets NotificationMessage

  • Optional: Any feature which sets NotificationAddress

The USSD Push Notification feature is a pre-credit-check, post-credit-check, or end-session feature early in the feature list. It always allows the session to continue even in the event of a feature execution failure.

The notification information will be accessed from the NotificationMessage session state variable which was set by a prior feature. If no message has been set, the SendFailures usage stat is incremented and the feature ends.

The notification message will be sent to (in order of precedence):

  • Address in NotificationAddress session state variable (if set)

  • Address in Subscriber session state variable

If neither of these variables are set then the message will not be sent.

Session state inputs and outputs

Inputs

Name Type Format Description Behaviour if null/invalid

Sentinel?SelectionKey

com.?opencloud.?sentinel.?common.?Sentinel?SelectionKey

selection key (for example, <platform>::::)

For selecting configuration data

Increment SendFailures Return

NotificationMessage

String

Arbitrary text

The text content of the outgoing USSD notification

Increment SendFailures Return

NotificationAddress

String

MSISDN

The destination address of the outgoing USSD notification

Fall back to Subscriber session state field

Subscriber

String

MSISDN

The destination address of the outgoing USSD notification if NotificationAddress is null

Increment SendFailures Return

Outputs

This feature does not write to session state.

Error scenarios

Scenario Handling

Missing configuration profile in USSDNotificationFeatureConfigProfileTable

Increment SendFailures

Null sessionstate NotificationMessage

Increment SendFailures

Null sessionstate NotificationAddress

Increment SendFailures

Could not create destination MSISDN from NotificationAddress

Increment SendFailures

Could not create SccpAddress from NotificationAddress

Increment SendFailures

USSD message encoding failed

Increment EncodingFailures

Failed to send unstructured SS notify request

Increment SendFailures

OpenRefuse from HLR

Increment HlrProviderErrors or HlrUserErrors

Abort from HLR Increment

HlrAborts

Timeout waiting for HLR response

Increment HlrTimeouts

Feature responses

Response Reason

featureHasFinished

feature has finished

Configuration

The USSD Push Notification configuration includes:

Parameters Type Description

SccpOriginatingAddress

SCCP address

Will be used as the TCAP Calling Party Address in dialogs initiated towards the HLR and MSC. May be null in which case the local SCCP address configured for the platform will be used. Example: type=c7,?ri=gt,?digits=34607012345,?nature=national,?national=true

InvokeTimeout

Long

UnstructuredSS_Notify invoke timeout in milliseconds (for example, 5000). A 0 value results in CGIN RA defaults being used.

UssdDataEncodingScheme

Byte

USSD data encoding scheme. Currently must be 15 (coding scheme must be 0x0f (0000 1111) GSM 7 bit language unspecified)

WaitForConfirmation

Boolean

true/false, when true will wait for the response from the HLR, if false will proceed with feature execution immediately

Call flow

ussd push notification interaction diagram

The HLR SCCP Address will be based on the MSISDN of the subscriber (See MAP SPEC, Section 4, concerning the use of SCCP and TC/4.1.3.3 The Home Location Register (HLR) — refer to MAP SPEC footnote below).

hlrSccpAddress.address={SessionState.NotificationAddress or SessionState.Subscriber)
hlrSccpAddress.nature=International
hlrSccpAddress.numberingPlan=ISDN
hlrSccpAddress.routingIndicator=(GT for extra/inter-PLMN, GT or SPC for intra-PLMN) default 0 (GT)
hlrSccpAddress.GTI=0100 (Global title indicator = 0100 (Global title includes translation type, numbering plan, encoding scheme and nature of address indicator)
hlrSccpAddress.type=C7
hlrSccpAddress.ssnIndicator=1 (MAP SSN always included)
hrlSccpAddress.ssn=(configured per network) default 6
hrlSccpAddress.pc=(configured per network) default not set
hlrSccpAddress.tt=0 (not used)
The USSD String of the message sent will be taken from the notification session state variables.
The ProcessUnstructuredSS_Request will include the MSISDN of the subscriber taken from the IDP.

  • In WaitForConfirmation true mode, the feature will immediate return continue once the notify request is sent and will not wait for the response.

  • In WaitForConfirmation false mode, the feature will return when one of the following occurs:

    • the response is received

    • a MAP error is reported

    • the invoke times out (ProviderError(NO_RESPONSE) is received

    • the dialog is aborted.

Configuration profile naming

Configuration Profile Table Name Description Profile Naming

USSD?Notification?Feature?Config?Profile?Table

Feature configuration

SentinelSelectionKey (for example, OpenCloud::::)

Provisioning interfaces

The feature is provisioned using the Sentinel Features REST API or web interface.

MAP SPEC

Digital cellular telecommunications system (Phase 2+); Mobile Application Part (MAP) specification (3GPP TS 09.02 version 5.17.0 Release 1996)

ETSI/3GPP

2002-03

ETSI
Previous page Next page
Sentinel Express Version 2.7.0