This feature uses information from a SIP INVITE and session state to determine if the call includes shared or undisclosed identity information associated with a companion device. The feature is run in both originating and terminating session execution plans.

Feature cheat sheet

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

MMTEL

Yes

Originating and Terminating

MMTelOrig_SipAccess_SubscriberCheck, MMTelTerm_SipAccess_SubscriberCheck

Yes

Yes

Stateless

POJO

Prerequisite features

These features must run before DetermineSharedUndisclosedIdentities:

  • SubscriberDataLookupFromHlr/SubscriberDataLookupFromHss

Session input variables

Session State variable name Variable type
SentinelSelectionKey

SentinelSelectionKey

MetaswitchCompanionDevice

CompanionDeviceData

Subscriber

String

Session output variables

Session State variable name Variable type Comments
SharedIdentitySip

String

SIP shared identity used by the companion device.

SharedIdentityTel

String

TEL shared identity used by the companion device.

UndisclosedIdentity

String

The undisclosed identity of the companion device.

HideUndisclosedIdentities

Boolean

Set to true if call is to the undisclosed identity of the companion device. Used by the HideUndisclosedIdentity feature.

BarIncomingCall

Boolean

Set to true if the call is made to undisclosed identity and configuration is set to bar.

Network operator data

This feature reads HideUndisclosedIdentities in the feature configuration profile table HideUndisclosedIdentityConfigProfileTable to determine if the feature should execute.

Parameter Type Description Default
HideUndisclosedIdentities

Boolean

Determines if calls to Undisclosed Identities should be hidden.

true

Statistics

DetermineSharedUndisclosedIdentities statistics are tracked by the sentinel.volte.sip SBB and can be found under the following parameter set in REM:
SLEE-Usage → sentinel.volte.sip service → sentinel.volte.sip SBB → feature → DetermineSharedUndisclosedIdentities
or with rhino-stats:
"SLEE-Usage.Services.ServiceID[name=sentinel.volte.sip,vendor=OpenCloud,version=4.0.0].SbbID[name=sentinel.volte.sip,vendor=OpenCloud,version=4.0.0].feature.DetermineSharedUndisclosedIdentities"

Name Type Description
Started

Counter

Incremented each time the feature runs

FailedToStart

Counter

Incremented when a fatal error occurs before feature execution

IssuedWarning

Counter

Incremented when a non-fatal error occurs during feature execution

FailedDuringExecution

Counter

Incremented when a fatal error occurs during feature execution

TimedOut

Counter

Incremented when feature execution does not complete within a reasonable time frame

UnableToDetermineUndisclosedIdentity

Counter

Incremented when the feature fails to find the subscriber id, sharedIdentitySip, and sharedIdentityTel when determining if undisclosed and shared identity logic should be applied.

SubscriberIsUndisclosedIdentity

Counter

Incremented if the subscriber is a companion device undisclosed identity.

SubscriberIsSharedIdentity

Counter

Incremented if the subscriber is a companion device shared identity.

HideUndisclosedIdentities

Counter

Incremented if the subscriber is undisclosed and the call will be barred.

Behaviour

The feature checks session state, feature configuration, and the incoming SIP request in order to set session state fields, which are subsequently used by downstream features associated with companion calls.

  • If triggered in the originating execution plan the feature sets session state fields to hide the companion device number from the callee.

  • If triggered in the terminating execution plan, when the call is made to an undisclosed identity, then the feature sets the BarIncomingCall session state field. This is used by the General Barring feature to bar the incoming call.

Values examined

Value Name Source Notes
MetaswitchCompanionDevice

Session State

Store information used to determine if the call is from or to a companion device.

SharedIdentitySip

Session State

Set by the DetermineSharedUndisclosedIdentities feature which is used by the HideUndisclosedIdentity feature.

SharedIdentityTel

Session State

Set by the DetermineSharedUndisclosedIdentities feature which is used by the HideUndisclosedIdentity feature.

UndisclosedIdentity

Session State

Set by the DetermineSharedUndisclosedIdentities feature.

HideUndisclosedIdentities

Session State

Flag set by the DetermineSharedUndisclosedIdentities feature to indicate to the HideUndisclosedIdentity feature to "hide" the identity of the caller by replacing SIP headers with the shared identity of the companion device.

BarIncomingCall

Session State

Set by the DetermineSharedUndisclosedIdentities feature which is used by the GeneralBarring Feature to bar the call.

Previous page Next page
Sentinel VoLTE Version 4.0.0