| Attributes |
integerKeyString
key
mandatory
noNotification
restricted |
-
vtasFcd
-
This attribute defines the primary key of VtasFcd and this section describes the VtasFcd attributes.
|
MtasFcdActiveCallPreferenceDT |
-
vtasFcdActiveCallPreference
=
NONE
-
This attribute defines influence of served user's active calls on FCD to Primary User's devices. If 0, then there is no influence. If 1, then if any of the served user's fixed devices are in active calls, a new incoming call will be distributed only to these fixed devices and all mobile devices. The setting is applicable only if the "FCD to Primary User's Devices" has been activated by an operator at node level.
Dependencies: vtasFcdDistributeToPrimaryUserDevices must be enabled for this setting to take effect.
Takes effect: New session
|
MtasString0to255DT
mandatory |
-
vtasFcdAdditionalTermSelectorFixed
-
This attribute defines a fixed terminal selector added by the "FCD to Primary User's Devices" function to outgoing INVITE and CANCEL requests towards fixed devices of a served user typically to aid in triggering fixed access network selection. It is a string containing an Accept-Contact header value, e.g. mobility="fixed";require. An empty string, being a default value of the CM parameter, means that no fixed terminal selector should be added. The setting is applicable only if the "FCD to Primary User"s Devices" has been activated by an operator at node level.
Dependencies: vtasFcdDistributeToPrimaryUserDevices must be enabled for this setting to take effect.
Takes effect: New session
|
MtasString0to255DT
mandatory |
-
vtasFcdAdditionalTermSelectorMobile
-
This attribute defines a mobile terminal selector added by the "FCD to Primary User's Devices" function to outgoing INVITE and CANCEL requests towards mobile devices of a served user typically to aid in triggering mobile access network selection. It is a string containing an Accept-Contact header value, e.g. mobility="mobile";require. An empty string, being a default value of the CM parameter, means that no mobile terminal selector should be added. The setting is applicable only if the "FCD to Primary User's Devices" has been activated by an operator at node level.
Dependencies: vtasFcdDistributeToPrimaryUserDevices must be enabled for this setting to take effect.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdAddPrefix
=
LOCKED
-
This attribute defines whether a prefix is to be added to the A and B numbers.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdAdministrativeState
=
LOCKED
-
This attribute defines the administrative state of the FCD service is used to lock or unlock the service.
- When UNLOCKED (1), the MTAS provides the FCD service to end-user provisioned with the service.
- When LOCKED (0), the MTAS does not provide the Communication Distribution service.
Dependencies: The vtasFcdAdministrativeState must not be set to UNLOCKED (1) if vtasGCacAdministrativeState is set to UNLOCKED (1).
Takes effect: New session
|
MtasFcdAlertingModeDT |
-
vtasFcdAlertingMode
=
RECEIVE_INVITE
-
This attribute defines when FCD sends 180 Ringing when transparent mode is disabled (mtasMmtTransparentMode = 0).
Dependencies: None
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdAudioAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired audio announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service request is made and call is being connected. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|
MtasString0to032DT
mandatory |
-
vtasFcdAutoAnswerAvoidanceAnnouncement
-
This attribute defines the code that corresponds to the desired audio announcement to be played to the called target when waiting for the DTMF input. It is used as key for VtasGaAnn.
Dependencies: An instance of VtasGaAnn with each entry must exist.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdAVAudioAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired audio stream in the audio/video announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service call is being attempted. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdAVVideoAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired video stream in the audio/video announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service call is being connected. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|
MtasFcdBusyEverywhereBehaviorDT |
-
vtasFcdBusyEverywhereBehavior
=
ONLY_DEVICES_OF_SERVED_USER
-
This attribute defines what kind of user targets are considered by Busy Everywhere function.
If all user targets are considered by Busy Everywhere function, FCD distribution will be terminated on receiving Busy Everywhere response.
Dependencies: None
Takes effect: New session
|
MtasString0to100DT[0..1] |
-
vtasFcdBusyEverywhereReason
-
This attribute defines the reason text for Reason header in CANCEL message sent to devices when the user has indicated busy everywhere.The content of the attribute is copied to the reason text field of the Reason header. The value shall be added without quotation mark. If the value of vtasFcdBusyEverywhereReason set to Busy everywhere, then the Reason header in CANCEL message looks like:Reason: SIP; cause=600; text=Busy everywhere.The protocol type and the cause code are non-configurable. If vtasFcdBusyEverywhereReason attribute is empty then the CANCEL message does not contain the Reason header.
Takes effect: New session
|
MtasFcdBusyEverywhereResponsesDT[1..10] nonUnique |
-
vtasFcdBusyEverywhereResponses
=
603
-
This attribute defines Reason header or response phrase values which can trigger a Busy Everywhere treatment. It is a list of strings; every string shall consist of 1-3 parts separated by colons. First part shall contain the SIP code, second, optional part shall contain the Reason header or response phrase and the third, optional part shall contain the SIP code of alerting message.
In case of Application Server Controlled Forking (i.e. if either FCD to Primary User devices is unlocked or particular User Common Data defined devices are addressed in the active FCD rule), on receipt of such a response from any device of a served user, call legs to all remaining devices of the served user within the same session get cancelled
There is no additional condition like this on other response codes.
Takes effect: New session
|
MtasFcdBusyIndicationDT |
-
vtasFcdBusyIndication
=
BUSY_HERE_486
-
This attribute defines the behavior of FCD when at least one of the targets of the last attempted rule set was considered to be busy.
If 0, then FCD responds with 480 Temporarily Unavailable; if 1, then FCD responds with 486 Busy Here depending on other targets responses; if 2, then FCD responds with 486 Busy Here without additional dependencies.Having FCD respond with 486 Busy allows for triggering of CDIV Call Forwarding Busy.
Takes effect: New session
|
MtasBusyResponsesDT[0..3] |
-
vtasFcdBusyResponses
=
486
-
This attribute is used to determine the INVITE method responses for which the FCD busy condition must be true.
The default value is the TISPAN R1 compliant value.
Dependencies: Can not have the same value as vtasFcdNotReachableResponses or vtasFcdBusyEverywhereResponses, with an exception to 486, since the interpretation of 486 in vtasFcdBusyEverywhereResponses is '486 - call rejected by user' only. If 486 is configured in both vtasFcdBusyEverywhereResponses and vtasFcdBusyResponses, 486 with "call rejected by user" reason text will be interpreted as "Busy Everywhere", and 486 with different or without any reason text will be interpreted as "Busy Here".
Takes effect: New session
|
MtasString0to100DT
mandatory |
-
vtasFcdCallCompletedElsewhereReason
-
This attribute defines the reason text for Reason header in CANCEL message sent to devices not answering the incoming call distributed by FCD service. The content of the attribute is copied to the reason text field of the Reason header. The value shall be added without quotation mark. If the value of vtasFcdCallCompletedElsewhereReason set to Call completed elsewhere, then the Reason header in CANCEL message looks like: Reason: SIP; cause=200; text=Call completed elsewhere.The protocol type and the cause code are non-configurable.If vtasFcdCallCompletedElsewhereReason attribute is empty then the CANCEL message does not include the Reason header.
Takes effect: New session
|
MtasHexDigitString0to6DT[0..1] |
-
vtasFcdCalledPrefix
-
This attribute defines the Prefix that is added between the "+" and <CC> to the main Called number in the FCD service Tel or SIP E164 URI.
Takes effect: New session
|
MtasFcdCalledPrefixLocationDT |
-
vtasFcdCalledPrefixLocation
=
ADDED_AFTER_CC
-
This attribute specifies the location where the vtasFcdCalledPrefix is added to the Tel or SIP E164 URI of Non-IMS primary called number in the FCD service.
0=vtasFcdCalledPrefix is added between + and CC,
1=vtasFcdCalledPrefix is added after the CC
Takes effect: New session
|
MtasFcdCallerPrefReqFilterDT[0..10] |
-
vtasFcdCallerPrefReqFilter
-
This attribute defines, which caller preference parameters of the Accept-Contact and Reject-Contact headers of an incoming request should not be copied by the FCD service to outgoing requests towards distribution targets, to avoid collisions with caller preferences added by the FCD service itself. It contains a list of feature tags, e.g. "mobility". An empty string, being a default value of the CM parameter, means that all caller preferences, besides "sip.instance", will be copied. The "sip.instance" caller preference is always filtered out, independent of this setting. The setting is applicable independent of the vtasFcdDistributeToPrimaryUserDevices setting. Note: Parameters configured as mobile and fixed terminal selectors (vtasFcdAdditionalTermSelectorMobile and vtasFcdAdditionalTermSelectorFixed) should typically be added to this list.
Dependencies: Individual entries must be different from each other.
Takes effect: New session
|
MtasFcdCallerPrefReqFilterFixedDT[0..10] |
-
vtasFcdCallerPrefReqFilterFixed
-
This attribute defines which caller preference parameters of the Accept-Contact and Reject-Contact headers of an outgoing INVITE request towards a fixed device, that should be filtered out. It contains a list of feature tags, e.g. "mobility". An empty string, being a default value of the CM parameter, means that the filtering function is disabled. The setting is applicable only if the "FCD to Primary User's Devices" has been activated by an operator at node level. The filtering function is applied following execution of the "mtasFcdAdditionalTermSelectorFixed" and " mtasFcdCallerPrefReqFilter" functions.
Dependencies: Individual entries must be different from each other.mtasFcdDistributeToPrimaryUserDevices must be enabled for this setting to take effect.
Takes effect: New session
|
MtasHexDigitString0to6DT[0..1] |
-
vtasFcdCallingPrefix
-
This attribute defines the Prefix that is added between the "+" and <CC> to the P-Asserted-Identity Tel or SIP E164 URI. If both a Tel and SIP E164 P-Asserted-Identity exist then it is added to both.
Takes effect: New session
|
MtasFcdCDivInvocSeqCtrlDT |
-
vtasFcdCDivInvocationSequenceControl
=
INVOKING_FCD_AFTER_CDIV_AND_APPLYING_NORMAL_BEHAVIOUR_FOR_FCDDP
-
This attribute defines whether Terminating MTAS shall invoke Flexible Communication Diversion (FCD) service before or after Communication Diversion (CDiv) service, and defines whether Flexible Communication Distribution Divert Primary (FCDDP) service is disabled or set to behave normally. It is strongly recommended to set the value always to 1.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdDistributeToPrimaryUserDevices
=
LOCKED
-
This attribute defines if distribution to Primary User's devices (IMS PRIMARY user's registered devices) shall be done or not. A Primary User's device is identified by the registered contacts sip.instance.
Dependencies: vtasSubsDataCacheContactData must be enabled for the function controlled by this setting to work properly.
Takes effect: New session
|
MtasFcdDistributeToPrimaryUserDevicesBehaviorDT |
-
vtasFcdDistributeToPrimaryUserDevicesBehavior
=
IMPLICIT_PRIMARY_USER_DEVICE_DISTRIBUTION
-
This attribute defines the type of distribution done to Primary User's devices (IMS PRIMARY user's registered devices). A Primary User's device is identified by the registered contacts sip.instance.
Dependencies: vtasFcdDistributeToPrimaryUserDevices must be enabled for this setting to take effect.
Takes effect: New session
|
MtasString0to255DT[0..1] |
-
vtasFcdDpOutgoingCallMessage
=
You have Communication Distribution Divert Primary active
-
This attribute defines the contents of the MESSAGE that is sent to remind a served user, when an outgoing call is made, that diversions to the PRIMARY target are active.
Takes effect: New session
|
MtasString0to255DT[0..1] |
-
vtasFcdDpServedUserNotifyMessage
=
Distributed Communication Diverted away from Primary
-
This attribute defines the contents of the MESSAGE that is sent to inform served user that a call distributed to the PRIMARY target has been diverted elsewhere.
Takes effect: New session
|
VtasDropBackDT |
-
vtasFcdDropBack
=
USE_OTP_VALUES
-
This attribute allows the Virtual Telephony Provider (VTP) to use the values of the corresponding Operating Telephony Provider (OTP) attributes in MtasFcd.
When this attribute is set to "Use own values", the initial values of the attributes in VtasFcd are set to the values of the corresponding attributes in MtasFcd,and the behavior of MTAS for the served users belonging to this VTP is determined by the values of the attributes of VtasFcd.
When this attribute is set to "Use OTP values", the behavior of MTAS for the served users belonging to this VTP is determined by the values of the attributes of MtasEct.
Takes effect: New session
|
MtasFcdEarlyMediaBehaviorDT |
-
vtasFcdEarlyMediaBehavior
=
DISABLED
-
This attribute defines whether to enable or disable Early Media negotiation using 183 Session Progress in FCD Service. If enabled, then QoS precondition negotiation is performed using 183 Session Progress message. Additionally if vtasMmtTransparentMode is disabled an empty 180 Ringing is sent on a new dialog after negotiation is finished. If vtasFcdEarlyMediaBehavior is disabled, the then QoS precondition negotiation is performed using 180 Ringing message.The recommended value is to have this CM enabled.
Dependencies: None
Takes effect: New session
|
MtasFcdEarlyMediaSuppressionHeaderTargetDT |
-
vtasFcdEarlyMediaSuppressionHeaderTarget
=
TARGET_NONE
-
This attribute defines a target type the early media suppression header is added to INVITE sent to target of primary user. The header is defined by CM vtasMmtSuppressEarlyMediaHeader.
Dependencies: None
Takes effect: New session
|
MtasFcdEmergencyDistributionDT |
-
vtasFcdEmergencyDistribution
=
EMERGENCY_DISTRIBUTION_ENABLED
-
This attribute controls if FCD shall apply specific distribution (ignoring user's distribution rule and instead uses a predefined device distribution) towards primary users devices whenever the subscriber is in emergency state.
Dependencies: vtasFcdEmergencyTimer is only applicable when vtasFcdEmergencyDistribution is enabled.
Takes effect: New session
|
MtasTimerSec00005to000060DT |
-
vtasFcdEmergencyTimer
=
10
-
This attribute defines the number of seconds while distribution of incoming call during the Emergency Call-Back Window is limited to device(s) suspected as originator(s) of the emergency call. After timer expires, the call will be distributed to all devices of the subscriber.
Dependencies: None
Takes effect: New session
|
MtasUint00001to000064DT |
-
vtasFcdMaxNumber
=
2
-
This attribute defines the maximum number of times the same communication is allowed to be subject to Flexible Communication Distribution forwarding legs.
This is the maximum number of History-Info entries with cause-param value 302 which are permitted to allow FCD to execute.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdNegAudioAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired audio announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service call is made and there is a failure to connect the call.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdNegAVAudioAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired audio stream in the audio/video announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service request is made and there is a failure to connect the call.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdNegAVVideoAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired video stream in the audio/video announcement to be played to the calling party when a Flexible Communication Distribution (FCD) service request is made and there is a failure to connect the call.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdNegPlayAudioAnnouncement
=
LOCKED
-
This attribute defines whether to enable or disable the playing of a audio announcement to the Calling party when a Flexible Communication Distribution (FCD) service call request is made and there is a failure to connect the call.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdNegPlayVideoAnnouncement
=
LOCKED
-
This attribute defines whether to enable or disable the playing of a video announcement to the Calling party when a Flexible Communication Distribution (FCD) service request is made and there is a failure to connect the call.
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdNegVideoAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired pure video stream to be played to the calling party when a Flexible Communication Distribution (FCD) service request is made and there is a failure to connect the call.
Takes effect: New session
|
MtasNotReachableResponsesDT[0..30] |
-
vtasFcdNotReachableResponses
=
408,500,503,504
-
The attribute is used to determine the INVITE method responses for which the FCD not reachable condition must be true. The default value is the TISPAN R1 compliant value.
Dependencies: Can not have the same value as vtasFcdBusyResponses or vtasFcdBusyEverywhereResponses, with an exception to 486, since the interpretation of 486 in vtasFcdBusyEverywhereResponses is '486 - call rejected by user' only. If 486 is configured in both vtasFcdBusyEverywhereResponses and vtasFcdNotReachableResponses, 486 with "call rejected by user" reason text will be interpreted as "Busy Everywhere", and 486 with different or without any reason text will be interpreted as "Not Reachable".
Takes effect: New session
|
MtasTimerSec00000to000020DT |
-
vtasFcdNotReachableTimer
=
10
-
The attribute is used to set the network timer for which the FCD not reachable condition needs to be true.
The special value 0 indicates that the time is not to be started.
Takes effect: New session
|
MtasFcdNotRegisteredBxDT |
-
vtasFcdNotRegisteredBehaviour
=
CONDITIONALLY_EXECUTED
-
This attribute is used to determine the behaviour of FCD when served user is not registered. If 0, then FCD is always executed when served user is not registered; if 1, then FCD is only executed for a not registered user, when condition for not-registered is set.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdPlayAudioAnnouncement
=
LOCKED
-
This attribute defines whether to enable or disable the playing of an audio announcement to the Calling party when a Flexible Communication Distribution (FCD) service request is made. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|
BasicAdmState |
-
vtasFcdPlayVideoAnnouncement
=
LOCKED
-
This attribute defines whether to enable or disable the playing of a video announcement to the Calling party when a Flexible Communication Distribution (FCD) service call is being attempted. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|
MtasFcdRelatedUserRoutingDT |
-
vtasFcdRelatedUserRouting
=
CALL_OUT_OF_THE_BLUE_ROUTING
-
This attribute defines how FCD should route the call to a related user. It is recommended to set the value to 1.
Takes effect: New session
|
MtasTimerSec00005to000060DT |
-
vtasFcdTimer
=
20
-
This attribute is used to set the time interval within which the callee must respond before a session is distributed. The attribute can be overridden per user by an element in the served user's XML. The relative values of vtasFcdTimer and mtasCwAlertTimer determine whether Communication Distribution No Reply or Communication Waiting takes precedence. The timer with the smaller value will take precedence.
Takes effect: New session
|
MtasFcdPrimaryUserSubscriptionDT |
-
vtasFcdToPrimaryUserSubscription
=
SUBSCRIPTION_NOT_NEEDED
-
This attribute defines when a subscription for FCD service is needed when divert to primary user.
Dependencies: None
Takes effect: New session
|
BasicAdmState |
-
vtasFcdUseFromHeader
=
LOCKED
-
The attribute is used to disable and enable the use of the From header when matching FCD rules.
Takes effect: New session
|
MtasFcdVersionDT |
-
vtasFcdVersion
=
LEGACY
-
This attribute controls the behavior of the FCD service.
Dependencies: None
Takes effect: New session
|
MtasUint00000to065535DT |
-
vtasFcdVideoAnnounceCode
=
0
-
This attribute defines the code that corresponds to the desired pure video stream to be played to the calling party when a Flexible Communication Distribution (FCD) service call is being connected. Service orders this announcement to be played indefinitely. This also means the service stops the announcement.
Takes effect: New session
|