The MMTelTIR feature implements the Terminating Identification Restriction (TIR) service .
What is TIR?
From 3GPP TS 24.608:
The Terminating Identification Restriction (TIR) is a service offered to the terminating party which enables the terminating party to prevent presentation of the terminating identity information to originating party. |
Feature cheat sheet
B2BUA Instance | SAS Support | Originating / Terminating | Point(s) in Session Plan | Network Operator Data | Subscriber Data | Stateful or Stateless | POJO Feature or SBB Feature |
---|---|---|---|---|---|---|---|
MMTEL |
Yes |
Terminating |
SipAccess_SubscriberPreCreditCheck + SipAccess_PartyResponse |
Yes |
Yes, loaded from HSS |
Stateless |
POJO |
Network operator data
TIR’s Network Operator Data is held in a JSLEE configuration profile table named MMTelTIRConfigProfileTable
.
This data is scoped by sentinel selection key — each network operator has one entry in the table.
Attribute Name |
Type |
TIRMode (deprecated, present in `MMTelTIRServiceData`) |
An enum with values Fully qualified class name is |
Session input variables
Variable name | Type | Comments |
---|---|---|
bxref:mmtel-subscriber-data-representation#mmteltirservicedata[MMTelTIRServiceData] |
Complex |
Loaded from the HSS in SubscriberDataLookupFromHSS or from HLR in SubscriberDataLookupFromHLR |
Session output variables
Variable name | Type | Comments |
---|---|---|
RanTir |
boolean |
Signals to other features that TIR ran on this session. |
Statistics
MMTelTIR 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 → MMTelTIR
or with rhino-stats:
SLEE-Usage → [sentinel.volte.sip service name] → [sentinel.volte.sip SBB name] → .feature.MMTelTIR
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 |
ProcessingResponse |
the feature processes a SIP response |
ProcessingRequest |
the feature processes a SIP request |
FromChangeTagRemoved |
the feature removes the |
ReceivedMalformedPrivacyHeader |
a non-standard |
PrivacyHeaderChanged |
the feature changes the contents of the |
FallbackToNetworkDefaultServiceConfig |
incremented when the feature uses the network default service configuration as the session state does not contain the feature specific subscriber service data. |
Behaviour
If operator data is not present, the TIR feature:
-
Increments an error statistic.
-
Logs a message at the
Fine
level. -
Informs the Sentinel core that the feature is not configured appropriately (
Invalid Configuration
). -
Exits.
If MMTelTIRServiceData.OperatorAuthorized
is false
, the feature finishes execution without modifying any state.
Header manipulation
MMTelTIRServiceData.Mode (Operator data) |
SIP Operation | MMTelTIRServiceData.Active (Subscriber data) |
MMTelTIRServiceData.DefaultBehaviourType (Subscriber data) |
Action(s) |
---|---|---|---|---|
TEMPORARY |
|
No |
PRESENTATION_NOT_RESTRICTED |
See row for Temporary, Active, Presentation Not Restricted |
TEMPORARY |
B-Party Responses |
No |
PRESENTATION_NOT_RESTRICTED |
See row for Temporary, Active, Presentation Not Restricted |
TEMPORARY |
|
No |
PRESENTATION_RESTRICTED |
See row for Temporary, Active, Presentation Restricted |
TEMPORARY |
B-Party Responses |
No |
PRESENTATION_RESTRICTED |
See row for Temporary, Active, Presentation Restricted |
TEMPORARY |
|
Yes |
PRESENTATION_NOT_RESTRICTED |
Forward |
TEMPORARY |
|
Yes |
PRESENTATION_RESTRICTED |
Forward |
TEMPORARY |
B-Party Responses |
Yes |
PRESENTATION_NOT_RESTRICTED |
Forward Response to A party |
TEMPORARY |
B-Party Responses |
Yes |
PRESENTATION_RESTRICTED |
If a response does not contain a If the response contains a If the response contains a |
PERMANENT |
INVITE |
Yes |
Behave as though `PRESENTATION_RESTRICTED`, regardless of tge configuration value. |
If INVITE contains an option-tag |
PERMANENT |
B-Party Responses |
Yes |
Behave as though `PRESENTATION_RESTRICTED` regardless of configuration value |
If a response does not contain a If the response contains a If the response contains a |