How it works

The web interface communicates with a web application hosted by Rhino Element Manager, which communicates with the HSS through the Sh Cache Microservice. Administrators can use it to:

  • view provisioned data

  • configure important settings

  • add new data to the HSS

  • remove data from the HSS.

Prerequisites

Before using the editor, you need to configure:

For more information on Operator Determined Barring see Operator Determined Barring.

Using the Data Editor

To use the Data Editor:

1

From REM’s monitoring screen, select Sentinel ▶ HSS Subscriber Data.

location subcriber data editor

It may take a few seconds before the screen appears on first load. It should look like this:

hss data query box

2

Follow the procedures to load or view, edit, or remove transparent data for an IMS public identity.

Load or view transparent data for an IMS public identity

Warning The HSS that the Editor queries depends on which network you’ve chosen. These instructions assume that, before loading data, you have configured the HSS address for the network operator.

To load or view data:

1

Type the IMS public identity into the IMS User Identity field, and click the Load button.

load an identity from hss

HSS Subscriber Data displays.

loaded hss subscriber data
Note
Loading errors

If there’s an error — for example, because the HSS is unavailable, the network operator is not configured properly, or the data cannot be parsed — a red-coloured error message will display in the panel, and red text in the log below. In the following example, a Sentinel network operator called ‘SteveInc’ has not been configured properly.

misconfigured network operator

Edit transparent data for an IMS public identity

To edit data that you’ve loaded in the Editor:

1

Click the Edit button.

Fields become editable.

editing a users data

2

Make your changes, depending on the field type.

Field type How to edit Example

Boolean

select from a list

 
CDIV Active

integer

enter in a text box

 
CDIV No Reply Timer

complex XML

enter in a resizable text box, with basic XML validation (checks that the XML is well-formed)

Click and drag the lower right corner to resize.

resizable box 
CDIV Rules

enumeration

select one of N values

 
OIR Default Behaviour

3

Click the Save button at the lower right.

If entered data is validated and saved successfully to the HSS, a green message displays in the panel and REM log.

editing save success

If saving fails, a red message displays in the panel and log. In the following example, the XML is not well-formed (in the CDIV Rules attribute), so REM rejects the user’s input before attempting to reach the HSS.

editing save failure

Add companion devices in transparent data for an IMS public identity

Companion devices can be added or edited in the step 2 listed above. Here is an example for adding a companion device that can use PS radio (VoLTE/VoWifi) and CS radio at the given MSISDN.

Field Example

CD Active

true

CD Devices

 
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<devices xmlns="http://metaswitch.com/XMLSchema/tas">
    <device>
        <model>Acme Watch</model>
        <radio-access>
            <PS/>
            <CS msisdn="641234568"/>
        </radio-access>
    </device>
</devices>

CD Hide

true

CD Operator Additional Attributes

null

CD Operator Authorized

true

CD SharedSipUri

sip:+641234567@example.com

CD SharedTelUri

tel:+641234567

CD User Additional Attributes

null
Note

  • It is recommended that both SharedSipUri and SharedTelUri are provisioned to a subscriber, in order to be used for properly determining the undisclosed identity. Those values are used in DetermineSharedAndUndisclosedIdentities and Hide Undisclosed Identity features.

  • The XML for CD Devices needs to match the schema shown in DeviceType, otherwise the data won’t be able to be provisioned properly in HSS.

Remove transparent data for an IMS public identity

To remove data that you’ve loaded in the Editor:

1

Click the Delete button (error ).

The editor prompts you to confirm the deletion.

remove hss data popup

2

Click OK.

The panel becomes blank, and a green message displays in the REM log below.

Required configuration for MMTel

To edit HSS transparent user data so it can use OpenCloud’s out-of-the-box IR.92 features, follow the manual configuration steps below.

Tip The sentinel-volte-mappings-config tool will carry out these steps for you. See Populate XCAP server settings and MMTel service data.

1

Select Sentinel ▶ HSS Subscriber Data.

location subcriber data editor

2

Once the data’s loaded, select the Provisioning Field Mappings tab.

Warning not the Subscriber Data Editor tab!

3

Click the Add Field Group button.

A prompt displays to enter details.

add field group

4

Fill in the following values — either by typing, or by selecting the text box and pressing the down arrow on your keyboard to select these default values:

Field Default

Service indication

 
MMTEL-Services

Service data class

 
com.opencloud.volte.sentinel.simservs.xcap.TMMTelServicesType

Service data codec class

 
com.opencloud.volte.sentinel.provisioning.hss.TMMTelServicesCodec

JXPath factory class

 
com.opencloud.volte.sentinel.simservs.xcap.MMTelJXPathFactory

And select OK.

5

Once the field group for MMTEL-Services has been added, select it; and click the Add Field button to add the following fields:

Field

Type

Description

Xpath

OIP Active

 
java.lang.Boolean

Whether or not originating identity presentation is active for this user. Refer to documentation for the ‘unset’ value.

 
complete-originating-identity-presentation/originating-identity-presentation/@active

OIP Authorized

 
java.lang.Boolean

Whether or not Originating Identity Presentation is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-originating-identity-presentation/operator-originating-identity-presentation/@authorized

OIR Active

 
java.lang.Boolean

Whether or not originating identity presentation restriction is active for this user. Refer to documentation for the ‘unset’ value

 
complete-originating-identity-restriction/originating-identity-presentation-restriction/@active

OIR Authorized

 
java.lang.Boolean

Whether or not Originating Identity Presentation Restriction is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-originating-identity-restriction/operator-originating-identity-presentation-restriction/@authorized

OIR Default Behaviour

 
com.opencloud.volte.sentinel.simservs.xcap. OriginatingIdentityPresentationRestriction$DefaultBehaviourType

Default behaviour value

 
complete-originating-identity-restriction/originating-identity-presentation-restriction/default-behaviour

TIR Default Behaviour

 
com.opencloud.volte.sentinel.simservs.xcap. TerminatingIdentityPresentationRestriction$DefaultBehaviourType

Default behaviour value

 
complete-terminating-identity-restriction/terminating-identity-presentation-restriction/default-behaviour

TIP Active

 
java.lang.Boolean

Whether or not Terminating Identity Presentation is active for this user. Refer to documentation for the ‘unset’ value

 
complete-terminating-identity-presentation/terminating-identity-presentation/@active

TIP Authorized

 
java.lang.Boolean

Whether or not Terminating Identity Presentation is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-terminating-identity-presentation/operator-terminating-identity-presentation/@authorized

TIR Active

 
java.lang.Boolean

Whether or not Terminating Identity Presentation Restriction is active for this user. Refer to documentation for the ‘unset’ value

 
complete-terminating-identity-restriction/terminating-identity-presentation-restriction/@active

TIR Authorized

 
java.lang.Boolean

Whether or not Terminating Identity Presentation Restriction is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-terminating-identity-restriction/operator-terminating-identity-presentation-restriction/@authorized

ICB Active

 
java.lang.Boolean

Whether or not Incoming Communication Barring is active for this user. Refer to documentation for the ‘unset’ value

 
complete-communication-barring/incoming-communication-barring/@active

ICB Authorized

 
java.lang.Boolean

Whether or not Incoming Communication Barring is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-communication-barring/operator-incoming-communication-barring/@authorized

OCB Active

 
java.lang.Boolean

Whether or not Outgoing Communication Barring is active for this user. Refer to documentation for the ‘unset’ value

 
complete-communication-barring/outgoing-communication-barring/@active

OCB Authorized

 
java.lang.Boolean

Whether or not Outgoing Communication Barring is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-communication-barring/operator-outgoing-communication-barring/@authorized

CW Active

 
java.lang.Boolean

Whether or not Communication Waiting is active for this user. Refer to documentation for the ‘unset’ value

 
complete-communication-waiting/communication-waiting/@active

CW Authorized

 
java.lang.Boolean

Whether or not Communication Waiting is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-communication-waiting/operator-communication-waiting/@authorized

CDIV Active

 
java.lang.Boolean

Whether or not Communication Diversion is active for this user. Refer to documentation for the ‘unset’ value

 
complete-communication-diversion/communication-diversion/@active

CDIV Authorized

 
java.lang.Boolean

Whether or not Communication Diversion is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-communication-diversion/operator-communication-diversion/@authorized

CDIV No Reply Timer

 
java.lang.Integer

Communication Diversion no reply timer

 
complete-communication-diversion/communication-diversion/NoReplyTimer

CDIV Rules

 
com.opencloud.volte.sentinel.common.policy.Ruleset

Communication Diversion rules

 
complete-communication-diversion/communication-diversion/ruleset

ICB Rules

 
com.opencloud.volte.sentinel.common.policy.Ruleset

Incoming Communication Barring rules

 
complete-communication-barring/incoming-communication-barring/ruleset

OCB Rules

 
com.opencloud.volte.sentinel.common.policy.Ruleset

Outgoing Communication Barring rules

 
complete-communication-barring/outgoing-communication-barring/ruleset

Flexible Alerting Group Type

 
com.opencloud.volte.sentinel.simservs.xcap.OperatorFlexibleAlertingGroup$GroupType

Whether the type of the group is single-user or multiple-users. For single user, the pilot number is busy if one of the members is busy. For multiple-user’s the pilot number is busy when all members are busy.

 
complete-flexible-alerting/operator-flexible-alerting-group/group-type

Flexible Alerting Membership Type

 
com.opencloud.volte.sentinel.simservs.xcap.OperatorFlexibleAlertingGroup$MembershipType

The membership type specifying whether a member is allowed to unsubscribe from the group or not. ‘Permanent’ means not allowed.

 
complete-flexible-alerting/operator-flexible-alerting-group/membership

Flexible Alerting Group Members

 
com.opencloud.volte.sentinel.simservs.xcap.OperatorFlexibleAlertingGroup$Members

The identities of the members that belong to this group

 
complete-flexible-alerting/operator-flexible-alerting-group/members

Flexible Alerting Pilot Number

 
com.opencloud.volte.sentinel.common.policy.IdentityType

The URI that defines the flexible alerting group and triggers the feature to activate.

 
complete-flexible-alerting/operator-flexible-alerting-group/identity

Flexible Alerting Group Authorized

 
java.lang.Boolean

Whether or not Flexible Alerting is authorized for this group. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-flexible-alerting/operator-flexible-alerting-group/@authorized

Flexible Alerting Authorized

 
java.lang.Boolean

Whether or not Flexible Alerting is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-flexible-alerting/operator-flexible-alerting/@authorized

Explicit Communication Transfer Authorized

 
java.lang.Boolean

Whether or not Explicit Communication Transfer is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-explicit-communication-transfer/operator-explicit-communication-transfer/@authorized

Operator CDIV Rules

 
com.opencloud.volte.sentinel.common.policy.Ruleset

Operator Communication Diversion rules

 
complete-communication-diversion/operator-communication-diversion/ruleset

Operator CDIV Maximum Diversion Count

 
java.math.BigInteger

Operator Communication Diversion maximum diversion count

 
complete-communication-diversion/operator-communication-diversion/total-number-of-diversions-for-each-communication

Operator CDIV No Reply Timer

 
java.lang.Integer

Operator Communication Diversion no reply timer

 
complete-communication-diversion/operator-communication-diversion/communication-forwarding-on-no-reply-timer

Communication Hold Authorized

 
java.lang.Boolean

Whether or not Communication Hold is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-communication-hold/operator-communication-hold/@authorized

Conferencing Authorized

 
java.lang.Boolean

Whether or not Conferencing is authorized for this user. The Authorized indicator is present in the Operator Data, so it is not visible to the subscriber.

 
complete-conference/operator-conference/@authorized
Note

To delete a field: select it, and click the error that displays next to it.

6

Click Save.

7

Once you have finished adding, editing, and/or removing fields — for the changes to take effect — disconnect from REM, and then log in again

Active flags information

There is special behaviour for each service’s "active" attribute. This is described in the Active attributes portion of the architecture document.

The user interface has three possible values for each services active flag:

  • Unset means that the XML document does not have an active attribute for this service

  • True means that the attribute exists and has the value true,

  • False means that the attribute exists and has the value false

Required configuration for Operator Determined Barring

To edit HSS transparent user data so it can use OpenCloud’s out-of-the-box IR.92 features:

1

Select Sentinel ▶ HSS Subscriber Data.

location subcriber data editor

2

Once the data’s loaded, select the Provisioning Field Mappings tab.

Warning not the Subscriber Data Editor tab!

3

Click the Add Field Group button.

A prompt displays to enter details.

add field group

4

Fill in the following values — either by typing, or by selecting the text box and pressing the down arrow on your keyboard to select these default values:

Field Default

Service indication

 
IMS-ODB-Information

Service data class

 
com.opencloud.volte.sentinel.mmtel.odb.TOdbForImsOrientedServices

Service data codec class

 
com.opencloud.mmtel.feature.hssdata.OdbServiceDataCodec

JXPath factory class

 
com.opencloud.volte.sentinel.mmtel.odb.OdbJXPathFactory

And select OK.

5

Once the field group for IMS-ODB-Information has been added, select it; and click the Add Field button to add the following fields:

Field

Type

Description

Xpath

Outgoing barring condition

 
java.lang.Short

Set the condition for outgoing barring

 
OdbForImsMultimediaTelephonyServices/OutgoingBarring

Incoming barring condition

 
java.lang.Short

Set the condition for incoming barring

 
OdbForImsMultimediaTelephonyServices/IncomingBarring

Barring of roaming condition

 
OdbForImsMultimediaTelephonyServices/BarringOfRoaming

Set the condition for barring of roaming

 
OdbForImsMultimediaTelephonyServices/BarringOfRoaming

Bar premium rate communications information

 
java.lang.Boolean

Set the condition for outgoing barring of premium rate communication information

 
OdbForImsMultimediaTelephonyServices/OutgoingPremiumRateBarring/PremiumRateCommunicationsInformation

Bar premium rate calls information when roaming outside hplmn country

 
java.lang.Boolean

Set the condition for outgoing barring of premium rate communication information when roaming"

 
OdbForImsMultimediaTelephonyServices/OutgoingPremiumRateBarring/PremiumRateCallsInformationWhenRoamingOutsideHplmnCountry

Bar premium rate communications entertainment

 
java.lang.Boolean

Set the condition for outgoing barring of premium rate communication entertainment

 
OdbForImsMultimediaTelephonyServices/OutgoingPremiumRateBarring/PremiumRateCommunicationsEntertainment

Bar premium rate calls entertainment when roaming outside hplmn country

 
java.lang.Boolean

Set the condition for outgoing barring of premium rate communication entertainment when roaming

 
OdbForImsMultimediaTelephonyServices/OutgoingPremiumRateBarring/PremiumRateCallsEntertainmentWhenRoamingOutsideHplmnCountry"

Evaluate ruleset Type1

 
java.lang.Boolean

Activate/Deactivate processing barring ruleset type1

 
OdbForImsMultimediaTelephonyServices/OperatorSpecificBarring/Type1

Evaluate ruleset Type2

 
java.lang.Boolean

Activate/Deactivate processing barring ruleset type2

 
OdbForImsMultimediaTelephonyServices/OperatorSpecificBarring/Type2

Evaluate ruleset Type3

 
java.lang.Boolean

Activate/Deactivate processing barring ruleset type3

 
OdbForImsMultimediaTelephonyServices/OperatorSpecificBarring/Type3

Evaluate ruleset Type4

 
java.lang.Boolean

Activate/Deactivate processing barring ruleset type4

 
OdbForImsMultimediaTelephonyServices/OperatorSpecificBarring/Type4

Barring of supplementary services management

 
java.lang.Boolean

Set the condition to bar the supplementary services management

 
OdbForImsMultimediaTelephonyServices/BarringOfSupplementaryServicesManagement

Diverted to address registration barring

 
java.lang.Short

Set the condition to bar the registration of diverted address

 
OdbForImsMultimediaTelephonyServices/DivertedToAddressRegistrationBarring

Simple invocation of communication transfer barring

 
java.lang.Short

Set the condition to bar a communication transfer

 
OdbForImsMultimediaTelephonyServices/SimpleInvocationOfCommunicationTransferBarring

Multiple invocation of communication transfer barring

 
java.lang.Boolean

Set the condition to bar multiple communication transfer

 
OdbForImsMultimediaTelephonyServices/MultipleInvocationOfCommunicationTransferBarring

Invocation of chargeable communication transfer barring

 
java.lang.Boolean

Set the condition to bar a chargeable communication transfer

 
OdbForImsMultimediaTelephonyServices/InvocationOfChargeableCommunicationTransferBarring
Note

None of these fields are required.

To delete a field: select it, and click the error that displays next to it.

6

Click Save.

7

Once you have finished adding, editing, and/or removing fields — for the changes to take effect — disconnect from REM, and then log in again

Required configuration for Metaswitch TAS Services

To edit HSS transparent user data so it can use Metaswitch TAS Services custom document

1

Select Sentinel ▶ HSS Subscriber Data.

location subcriber data editor

2

Once the data’s loaded, select the Provisioning Field Mappings tab.

Warning not the Subscriber Data Editor tab!

3

Click the Add Field Group button.

A prompt displays to enter details.

add field group

4

Fill in the following values — either by typing, or by selecting the text box and pressing the down arrow on your keyboard to select these default values:

Field Default

Service indication

 
Metaswitch-TAS-Services

Service data class

 
com.metaswitch.xmlschema.tas.MetaswitchServicesType

Service data codec class

 
com.opencloud.volte.sentinel.provisioning.hss.MetaswitchServiceDataCodec

JXPath factory class

 
com.metaswitch.xmlschema.tas.MetaswitchServicesJXPathFactory

And select OK.

5

Once the field group for Metaswitch-TAS-Services has been added, select it; and click the Add Field button to add the following fields:

Field

Type

Description

Xpath

Basic Settings Active Flag

 
boolean

Set the user basic settings active flag

 
metaswitch-services/complete-basic-settings/basic-settings/@active

Basic Settings Operator Authorized Flag

 
boolean

Set the operator basic settings authorized flag

 
metaswitch-services/complete-basic-settings/operator-basic-settings/@authorized

Basic Settings User Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the basic settings additional attributes

 
metaswitch-services/complete-basic-settings/basic-settings/additional-attributes

Basic Settings Operator Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the basic settings additional attributes

 
metaswitch-services/complete-basic-settings/operator-basic-settings/additional-attributes

LBD Active Flag

 
boolean

Set the user location based dialling active flag

 
metaswitch-services/complete-location-based-dialling/location-based-dialling/@active

LBD Operator Authorized Flag

 
boolean

Set the location based dialling authorized flag

 
metaswitch-services/complete-location-based-dialling/operator-location-based-dialling/@authorized

LBD Group ID

 
java.lang.String

Set the location based dialling group ID

 
metaswitch-services/complete-location-based-dialling/operator-location-based-dialling/group-id

LBD User Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the user location based dialling additional attributes

 
metaswitch-services/complete-location-based-dialling/location-based-dialling/additional-attributes

LBD Operator Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the operator location based dialling additional attributes

 
metaswitch-services/complete-location-based-dialling/operator-location-based-dialling/additional-attributes

FTV Active

 
boolean

Set the user forward to voicemail active flag

 
metaswitch-services/complete-forward-to-voicemail/forward-to-voicemail/@active

FTV Operator Authorized Flag

 
boolean

Set the operator forward to voicemail authorized flag

 
metaswitch-services/complete-forward-to-voicemail/operator-forward-to-voicemail/@authorized

FTV Allow Subscriber Update

 
boolean

Set whether the subscriber is permitted to update their own voicemail server.

 
metaswitch-services/complete-forward-to-voicemail/operator-forward-to-voicemail/allow-subscriber-update

FTV Server URI

 
java.lang.String

Set the URI of the subscriber’s voicemail server URI

 
metaswitch-services/complete-forward-to-voicemail/forward-to-voicemail/voicemail-server

FTV User Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the user forward to voicemail additional attributes

 
metaswitch-services/complete-forward-to-voicemail/forward-to-voicemail/additional-attributes

FTV Operator Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the operator forward to voicemail additional attributes

 
metaswitch-services/complete-forward-to-voicemail/operator-forward-to-voicemail/additional-attributes

CD Active Flag

 
boolean

Set the user companion device active flag

 
metaswitch-services/complete-companion-device/companion-device/@active

CD Operator Authorized Flag

 
boolean

Set the companion device authorized flag

 
metaswitch-services/complete-companion-device/operator-companion-device/@authorized

CD Devices

 
com.metaswitch.xmlschema.tas.DevicesType

Set the companion devices

 
metaswitch-services/complete-companion-device/operator-companion-device/devices

CD SharedSipUri

 
java.lang.String

Set the companion device shared sip uri identity

 
metaswitch-services/complete-companion-device/operator-companion-device/shared-identity-sip

CD SharedTelUri

 
java.lang.String

Set the companion device shared tel uri identity

 
metaswitch-services/complete-companion-device/operator-companion-device/shared-identity-tel

CD Hide

 
java.lang.Boolean

Set the companion device hide and block flag

 
metaswitch-services/complete-companion-device/operator-companion-device/hide-companion-identity

CD User Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the user companion device additional attributes

 
metaswitch-services/complete-companion-device/companion-device/additional-attributes

CD Operator Additional Attributes

 
com.metaswitch.xmlschema.tas.AdditionalAttributes

Set the operator companion device additional attributes

 
metaswitch-services/complete-companion-device/operator-companion-device/additional-attributes
Note

The Operator Authorized Flag fields are required. All other fields are optional.

To delete a field: select it, and click the error that displays next to it.

6

Click Save.

7

Once you have finished adding, editing, and/or removing fields — for the changes to take effect — disconnect from REM, and then log in again
Previous page Next page
Sentinel VoLTE Version 4.0.0