class MtasSubsData

ManagedElement
+-MtasFunction
+-MtasSubsData
+-MtasShIf [1..1]
+-MtasSubsDataMgmt [1..1]

The MtasSubsData MO controls the subscriber data function for a complete MTAS node.

This MO is created by the system.

Attributes
integerKeyString
key
mandatory
noNotification
restricted
mtasSubsData
This attribute defines the primary key of MtasSubsData and this section describes the MtasSubsData attributes.
OperState
mtasSubsDataCacheContactData = ENABLED
This attribute defines whether to enable or disable caching contact data for device handling in MTAS. If enabled, the contact data will be fetched from extended 3rd-party REGISTER request. If no cached data is available for a given subscriber at an initial INVITE, the contact data will be downloaded from S-CSCF with one-time subscription to the "reg" event. This CM attribute should specifically be enabled in SCC AS deployments (mtasSccAdministrativeState=1) and for MMTel AS using Flexible Communication Distribution to Primary User's devices (mtasFcdDistributeToPrimaryUserDevices=1). In order for caching contact data to work properly, Initial Filtering Criteria (iFC) for S-CSCF must be configured to send 3rd-party REGISTER request to MTAS extended with a MIME body containing the original REGISTER request and the 200 OK response as "message/sip" parts. If iFC are not configured for extended 3rd-party registration but this setting is enabled, MTAS will behave differently depending on deployment configuration. SCC AS (standalone or collocated with MMTel AS) will reject the third-party REGISTER with a SIP 400 Bad Request response with the Warning header set to 399: "MIME body message/sip content not sufficient". MMTel AS standalone will try to fetch the Contact Data from S-CSCF using one time subscription for "reg" event. SUBSCRIBE will be sent on receipt of each 3rd-party REGISTER. In order to avoid these superfluous messages in MMTel AS deployments where caching contact data is not needed, this setting must be disabled manually.

Dependencies: This setting should specifically be enabled in SCC AS deployments (mtasSccAdministrativeState=1) and for MMTel AS using FCD to Primary User's devices (mtasFcdDistributeToPrimaryUserDevices=1). In order for caching contact data to work properly, Initial Filtering Criteria (iFC) for S-CSCF must be configured to send 3rd-party REGISTER request to MTAS extended with a MIME body containing the original REGISTER request and the 200 OK response as "message/sip" parts. mtasSubsDataCacheContactData can not be Disabled if mtasSubsDataCachePani is Enabled.
Takes effect: New session
MtasSubsDataCachePaniDT
mtasSubsDataCachePani = CACHEPANI_DISABLED
This attribute defines whether to enable or disable caching PANI header in MTAS. If set to "0" then function is disabled. If set to "1" then PANI header is cached from SIP messages during call-setup, at registration, at re-registration and when access change is reported during active session. If set to "2" then the PANI header is cached from SIP messages at registration, at re-registration and when access change is reported during active session.

Dependencies: It must not be possible to enable mtasSubsDataCachePani when mtasSubsDataCacheContactData is disabled. mtasSubsDataCacheContactData can not be Disabled if mtasSubsDataCachePani is Enabled or EnabledRegistration, mtasSubsDataCachePani should be Disabled first.
Takes effect: New session
MtasTimerMin00001to032000DT
mtasSubsDataDefaultRegTimer = 21600
This attribute defines what value is used for registration timer.
This timer defines the maximum time subscriber data remains in the cache.
The value is to be larger than or equal to the typical registration lifetime in the S-CSCF
to allow receiving a reregistration before the expiry of the timer.


Dependencies: The value of this timer must be greater than or equal to mtasCcbsT3ServiceDurationTimer.
Takes effect: New session
MtasTimerMin00000to001000DT
mtasSubsDataDeregTimer = 360
This attribute defines the duration of the deregistration timer. This timer
defines how long subscriber data remains in the cache following termination of the last session for
an unregistered subscriber. It is started when the last call for the unregistered subscriber is
completed. It is stopped when a new session is initiated for the subscriber.


Takes effect: Session tear down
MtasTimerSec00030to003600DT
mtasSubsDataHSSOverloadTimer = 300
This attribute defines the time in seconds while the HSS is considered as in an overloaded state once the HSS overload indication is triggered, but not by a constant overload indication.

Takes effect: New session
MtasSubsDataInitRegHSSFetchDDT
mtasSubsDataInitRegHSSFetchDelay = DISABLED_FETCH_DELAY
This attribute defines the HSS data fetching behaviour of the collocated MMTel and SCC AS, standalone MMTel AS and standalone SCC AS deployment cases during initial registration:
- 0 (Disabled): All HSS data fetching is performed at the receival of the initial registration. No data fetching during first attempt of making or receiving a call, meaning that no call setup latency impact.
- 1 (Delay all queries except ATCF related queries): Only the data fetchings related to ATCF anchoring (IRS pull, C-MSISDN pull and the ATCF update via SIP MESSAGE) are performed during initial registration in case of SCC AS while other data fetchings from HSS are delayed to the subscriber's first attempt of making or receiving a call. This means increased call setup latency. In case of standalone MMTel AS deployment all requests are delayed as there are no ATCF related queries.
- 2 (All HSS data fetching delayed, including ATCF related ones as well): During initial registration, all HSS queries, including the ATCF related ones as well (IRS and C-MSISDN pull), are delayed to the first attempt of making or receiving a call. This means increased call setup latency. In case of standalone MMTel AS deployment all requests are delayed as there are no ATCF related queries.
- 3 (HSS data fetching delayed except ATCF related but fallback to delaying all in HSS overload situation is enabled): Similar to the 'HSS data fetching delayed except ATCF related queries' case, most of the queries are delayed, but when the HSS is in overload situation (while the mtasSubsDataHSSOverloadTimer is not expired) all HSS queries, including ATCF related ones as well, are delayed to the first attempt of making or receiving a call. This means increased call setup latency. In HSS overload situation, the ATCF is updated with a dummy C-MSISDN via SIP MESSAGE. In case of standalone MMTel AS deployment all requests are delayed as there are no ATCF related queries.


Dependencies: Cannot set to 2 (ALL_DATA_FETCH_DELAY) or 3 (OVERLOAD_IND_DELAY), when mtasSubsDataSccAtcfInfoInHss is set to 1 (ATCF_INFO_IN_HSS_ENABLED).
Takes effect: New session
MtasSubsDataMobileClassificationDT[0..10] nonUnique
mtasSubsDataMobileClassification
This attribute defines the basis for device classification as “mobile” at the registration and the “reg” event notification. It is a list of strings where each string represents one Contact header parameter (feature tag) and its value identifying a mobile device. A feature tag name and value match is case insensitive. A feature tag name and value match is not exact, i.e. when a given substring is found in a respective feature tag value then the match is successful. A feature tag value is optional. A feature tag without value denotes just presence of a given feature tag. The keyword “false” set as a feature tag value denotes absence of a given feature tag. The list is evaluated top down. Evaluation is abandoned on the first match. A device will be classified as “mobile” if at least one feature tag condition is fulfilled. Otherwise it will be classified as “fixed”. If this setting contains at least one entry, the classification will be done based on feature tags only, without taking P-Access-Network-Info header into account. Otherwise, i.e. if this setting is empty (default value), a device will be classified as “mobile” based on the P-Access-Network-Info header indicating GERAN, UTRAN or E-UTRAN access, and if P-Access-Network-Info header is absent - based on presence of +g.3gpp.ics=”server” or +g.3gpp.accesstype=”cellular” feature tag. If none of the above conditions is fulfilled, a device will be classified as “fixed” by default. Note: mtasSubsDataCacheContactData must be enabled for this setting to take effect. Examples: +sip.instance=”urn:gsma:imei”, +g.gsma.rcs.ipcall=false.

Dependencies: Individual entries must be different from each other and cannot be mutually exclusive. mtasSubsDataCacheContactData must be enabled for this setting to take effect.
Specification: Each item in the list is a string of at minimum 1 and maximum 255 characters, in the following format: <parameter>[=<value>].
Takes effect: New session
MtasSubsDataPINFormatDT
mtasSubsDataPINFormat = PLAINTEXT
This attribute defines whether the MTAS stores the new PIN code value in MD5 hashed format or in plain text, when a user requests modification of the PIN using an SSC command.
The format is based on the mtasSubsDataPINFormat configuration parameter.
If the value of the parameter is 0, the storing format is plain text.
If the value of the parameter is 1, the storing format is MD5 hashed.
This is independent of the current storing format


Takes effect: New session
MtasTimerMSec00200to004000DT
mtasSubsDataRegEventResponseTimer = 2000
This attribute defines the time that the SCC AS waits for a response to a SUBSCRIBE sent to the S-CSCF to obtain a served user's registration status.
The attribute is also used as the duration of the time that the SCC AS waits for a NOTIFY if it receives a 2xx response to the SUBSCRIBE.


Takes effect: New session
MtasSubsDataRegistrationModeDT
mtasSubsDataRegistrationMode = NORMAL_REGISTER_MODE
This attribute defines the registration mode the MTAS node will operate with.
The possible modes are as follows:
- Normal Register Mode. Normal Register Mode is the default mode.
- Dynamic Register Mode. Dynamic Register Mode is not implemented.
- No Register Mode.

Transition between registration modes is not allowed.


Takes effect: New registration
MtasSubsDataSccAtcfInfoInHssDT
mtasSubsDataSccAtcfInfoInHss = ATCF_INFO_IN_HSS_DISABLED
This attribute defines the method for storing/restoring ATCF Info registration information in the SCC AS node. If set to 0 (ATCF_INFO_IN_HSS_DISABLED) , the legacy way of restoring ATCF info from RegInfo applies. If set to 1 (ATCF_INFO_IN_HSS_ENABLED) then the SCC AS stores the ATCF Info of the registered user in HSS as transparent data and restores the ATCF Info from HSS if it is not already present in the RegInfo fetched from the S-CSCF.

Dependencies: mtasSubsDataSccAtcfInfoInHss can be set to 1 (ATCF_INFO_IN_HSS_ENABLED) only when mtasSrvccAdministrativeState is 1 (UNLOCKED). When mtasSubsDataSccAtcfInfoInHss is set to 1 (ATCF_INFO_IN_HSS_ENABLED), mtasSubsDataInitRegHSSFetchDelay cannot be set to 2 (ALL_DATA_FETCH_DELAY) or 3 (OVERLOAD_IND_DELAY).
Takes effect: New session
MtasSubsDataServiceRecordsLimitDT
mtasSubsDataServiceRecordsLimit = 450000
This attribute defines limit for the number of cached service data records per board (includes registered and unregistered subscribers).


Takes effect: New registration
MtasTimerMin00000to006000DT
mtasSubsDataStLastSessionTimer = 3000
This attribute defines the duration of the Last Session timer. This timer defines how long PBX data remains in the cache following termination of the last session for a PBX originating or terminating call when static mode is applied. It is started when the last call for a PBX is completed. It is stopped when a new session is initiated for the PBX.

Takes effect: Session tear down
MtasString0to032DT
mandatory
mtasSubsDataVolteCaseName
This attribute defines the VoLTE call case name that is used to distinguish the call case (VoLTE or 2g/3g) by matching with the ServerName property in topmost Route header in terminating INVITE.

Takes effect: New session

  class MtasSubsData