This feature decodes the X-Msw-Companion-Device headers in a SIP request into a list of CompanionDevice objects in CompanionDevices session state field for access by other features .

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

SCC

Yes

Terminating

SCCTerm_SipAccess_SessionCheck

No

No

Stateless

POJO

Session output variables

Variable name Type Comments 
CompanionDevices

List<CompanionDevice>

One entry per X-Msw-Companion-Device header in the triggering message.

Statistics

SCCDecodeCompanionDeviceInfo statistics are tracked by the SCCDecodeCompanionDeviceInfo SBB and can be found using the parameter set SLEE-Usage.Services.ServiceID[name=sentinel.volte.sip,vendor=OpenCloud,version=3.1.0].SbbID[name=scc-decode-companion-device-info-feature,vendor=OpenCloud,version=3.1.0]

Or in REM under the following parameter sets:
SLEE-Usage → Services → sentinel.volte.sip service → scc-decode-companion-device-info-feature SBB

Parameter Type Description 
Started

Counter

Incremented when the feature is invoked.

 
Failed

Counter

Incremented when a fatal error has occurred.

 
SCCDecodeCompanionDeviceInfoSuccess

Counter

Incremented when a message with X-Msw-Companion-Device headers has those headers decoded successfully

 
SCCDecodeCompanionDeviceInfoFailure

Counter

Incremented when there is a parsing exception while decoding a X-Msw-Companion-Device header

 
DecodeCompanionDeviceInfoParameterDecodeError

Counter

Incremented when a X-Msw-Companion-Device header has a parameter that is not supported

 
DecodeCompanionDeviceInfoDeviceDecodeError

Counter

Incremented when an inconsistency exists in the parameters

Behaviour

If the trigger is not a SIP request, the feature fails to execute.

If there are no X-Msw-Companion-Device headers in the request, the feature finishes with no further processing.

Each X-Msw-Companion-Device header is decoded in turn and added to a list of CompanionDevice s.

The resulting list is saved in the CompanionDevices session state field.

Decoding

RadioAccess is extracted from the header.

The following parameters on the header are extracted when present

  • msisdn

  • imei

  • impi

  • imsi

  • model

Any other parameters result in a decode error, incrementing the DecodeCompanionDeviceInfoDeviceDecodeError stat.

Finally the consistency of the parameters are checked, and failure results in SCCDecodeCompanionDeviceInfoDeviceDecodeError stat being incremented and CompanionDevices session state field not being set.

  • radioAccessType must be specified

  • if radioAccessType is CS or PS_CS then msisdn must also be specified.

Previous page Next page
Sentinel VoLTE Version 3.1.0