This feature sets the companion device headers to the initial INVITE when the subscriber has been provisioned with companion devices.
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 | Other notes |
---|---|---|---|---|---|---|---|---|
MMTel |
Yes |
Terminating |
|
No |
Yes |
Stateless |
POJO |
Session Input Variables
Session State variable name | Type | Comments |
---|---|---|
CallType |
Complex |
The calltype |
MetaswitchCompanionDevice |
Complex |
The companion device data that is provisioned in HSS |
Statistics
Feature 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 → SetCompanionDeviceHeaders
or with rhino-stats:
"SLEE-Usage.Services.ServiceID[name=sentinel.volte.sip,vendor=OpenCloud,version=3.1.0].SbbID[name=sentinel.volte.sip,vendor=OpenCloud,version=3.1.0].feature.SetCompanionDeviceHeaders"
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 |
processingSipRequest |
the sip request is processed to determine if adding |
companionDeviceHeaderAdded |
the companion device header |
companionDeviceHeaderExists |
the companion device header |
companionDeviceHeaderFailed |
fail to add companion device header |
companionDeviceHeaderNotAuthorized |
companion device provisioned is not operator authorized |
companionDeviceHeaderRetarget |
companion device header will not be added when the sip request is retargeted |
Behaviour
-
If the call type is not mobile terminating then the feature finishes with no further processing.
-
The feature increases relevant stats and finishes without adding the companion device header, if one of the following situations happens:
-
oc-retarget
header is found in the sip request; -
the companion header
X-Msw-Companion-Device
already exists; -
the companion device data is not operator authorized.
-
-
When it needs to add the companion device header, the feature goes through all the companion devices provisioned and adds the information as
X-Msw-Companion-Device
headers to the sip request. See the header format in X-Msw-Companion-Device Header.