This feature reads the IMS user state from the HSS, and updates session state. Information is read during InitialDP processing. It reads the IMS user state via the Sh Cache Microservice. For more information about the Sh Cache Microservice see Sh Cache Microservice architecture.

Feature cheat sheet

B2BUA Instance Originating / Terminating Point in Session Plan Network Operator Data Subscriber Data Stateful or Stateless POJO Feature or SBB Feature

SCC

Terminating

DirectAccessNetworkCheck

No

No

Stateless

SBB

Prerequisite features

These features must run before IMSUserStateLookupFromHSS:

Session input and output variables

Session input variables

Session State variable name Variable type

Subscriber

String

Note This is the IMS Public Identity for the Served User, which is extracted from the InitialDP.

Session output variables

Session State variable name Variable type Comments
IsLoggedIn

boolean

True, if the IMS user state indicates the subscriber is Registered in the IMS.

Statistics

IMSUserStateLookupFromHSS statistics are tracked by the IMSUserStateLookupFromHSS feature and can be found under the following parameter sets:

SLEE-Usage ▶ sentinel.volte.ss7 service ID ▶ sentinel.volte.ss7 SBB ID ▶ IMSUserStateLookupFromHSS feature.

Name Type Description
Started

Counter

Incremented when the feature runs.

FailedToStart

Counter

Incremented when Sentinel VoLTE encounters an error while attempting to start the feature.

IssuedWarning

Counter

Incremented when a non-fatal problem is encountered and the feature issues a warning.

FailedDuringExecution

Counter

Incremented when a fatal problem is encountered and the feature cannot execute correctly.

TimedOut

Counter

Incremented when the feature takes too long to complete and Sentinel VoLTE aborts execution.

SLEE-Usage ▶ sentinel.volte.ss7 service ID ▶ volte.sentinel.scc-lookup-ims-user-state-hss-feature SBB ID.

Name Type Description
Started

Counter

Incremented when the feature runs.

FailedToStart

Counter

Incremented when Sentinel VoLTE encounters an error while attempting to start the feature.

IssuedWarning

Counter

Incremented when a non-fatal problem is encountered and the feature issues a warning.

FailedDuringExecution

Counter

Incremented when a fatal problem is encountered and the feature cannot execute correctly.

FeatureError

Counter

Incremented when a feature error occurs.

TimedOut

Counter

Incremented when the feature takes too long to complete and Sentinel VoLTE aborts execution.

SubscriberNotRegistered

Counter

Incremented if the subscriber is not registered in the IMS.

ImsUserStateQueried

Counter

Incremented when the ShCM is queried for a subscriber’s IMS user state.

ImsUserStateRetrieveSuccess

Counter

Incremented when the ShCM lookup succeeds.

ImsUserStateRetrieveFail

Counter

Incremented when the ShCM lookup fails.

ImsUserStateUnknownSubscriber

Counter

Incremented when the ShCM lookup fails, as the subscriber in unknown in the IMS.

ImsUserStateRetrieveSuccessNoData

Counter

Incremented when the ShCM lookup succeeds, but no IMS user state data is returned.

ImsUserStateSourceNotApplicable

Counter

Incremented when Sentinel VoLTE is configured to determine the IMS user state from Third Party Registration

Behaviour

The feature queries the ShCM for the IMS user state of the Served User (as identified by the IMS Public Identity that is extracted from the InitialDP). The IsLoggedIn session state field is set to true if the IMS user state returned indicates the server user is registered in the IMS. Otherwise the IsLoggedIn session state field is set to false.

Previous page Next page
Sentinel VoLTE Version 4.0.0