This feature replaces the undisclosed identity with the shared identity for an originating call from a companion device where such hiding has been requested .
Feature Cheat Sheet
B2BUA Instance |
MMTel |
---|---|
SAS Support |
Yes |
Call Types |
Originating |
Point(s) in Session Plan |
|
Network Operator Data |
Yes |
Subscriber Data |
Yes |
Stateful or Stateless |
Stateless |
POJO Feature or SBB Feature |
POJO |
Other notes |
Feature Configuration
The profiles within the HideUndisclosedIdentityConfigProfileTable
are selected using the SentinelSelectionKey
and has the following field:
Parameter | Type | Description |
---|---|---|
HideUndisclosedIdentities |
boolean |
Whether undisclosed identities should be hidden |
ExcludedURIs |
String[] |
A list of URIs that should never be replaced with the shared identity, e.g. |
Session Input Variables
Session State variable name | Type | Comments |
---|---|---|
SentinelSelectionKey |
SentinelSelectionKey |
Determines which configuration to use |
HideUndisclosedIdentities |
boolean |
|
SharedIdentitySip |
URI |
Used to replace undisclosed |
SharedIdentityTel |
URI |
Used to replace undisclosed |
Statistics
HideUndisclosedIdentity 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 → HideUndisclosedIdentity
or with rhino-stats:
"SLEE-Usage.Services.ServiceID[name=sentinel.volte.sip,vendor=OpenCloud,version=4.1].SbbID[name=sentinel.volte.sip,vendor=OpenCloud,version=4.1].feature.HideUndisclosedIdentity"
Statistic | Incremented when… |
---|---|
Started |
the feature runs |
FailedToStart |
Sentinel VoLTE encounters an error while attempting to start the feature |
IssuedWarning |
a non-fatal problem is encountered and the feature issues a warning |
FailedDuringExecution |
a fatal problem is encountered and the feature cannot execute correctly |
TimedOut |
the feature takes too long to complete and Sentinel VoLTE aborts execution |
HideUndisclosedIdentities |
a message is modified to hide the undisclosed identity |
SharedIdentitySip |
a message header address is replaced with the SIP shared identity |
SharedIdentityTel |
a message header address is replaced with the TEL shared identity |
UnsupportedExecutionPoint |
the feature is called from an unsupported execution point |
Behaviour
The feature will only act if:
-
the call type is
Mobile Originating
, and -
the
HideUndisclosedIdentities
feature configuration field is set totrue
, and -
the
HideUndisclosedIdentities
session state field is set totrue
, and -
at least one of the
SharedIdentitySip
orSharedIdentityTel
session state fields has a value.
If those conditions are met, the feature will select which headers on the outgoing message to check:
-
On the initial INVITE request, the feature will check the
From
andP-Asserted-Identity
headers. -
On all other SIP requests and responses, the feature will only check the
From
header.
For each examined header, the feature does one of the following:
-
If the header value starts with or matches any of the values in the
ExcludedURIs
configuration field, the header is left unchanged. -
If the header value is a SIP URI and the
SharedIdentitySip
session state field has a value, the header value is replaced with theSharedIdentitySip
field value. -
If the header value is a Tel URI and the
SharedIdentityTel
session state field has a value, the header value is replaced with theSharedIdentityTel
field value. -
For the
From
header only, if the header value is a Tel URI and theSharedIdentityTel
session state field is not defined, the header value is replaced with theSharedIdentitySip
field value. -
In all other cases the header is left unchanged.