XML attribute

Optional XML element

Choice icon

Mandatory XML element

Structured element

Subobject element

The occurrence of this element is 0–15.

User-defined type

This is not a standard XML schema type. It is introduced to describe MO schema structure more clearly. In practice, this type is to be replaced by the corresponding elements.

Sequence icon

A list of elements, the sequence order must be followed.

IMSAssociation

x

x

x

x

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

chargingProfId

String

maxLength value = "255"

Optional (0-1)

Identifies the Charging Profile configured in HSS-FE.

Default value is: DefaultChargingProfile

chargingId

String

Pattern value = "\d{5,15}"

5-15 digits

Each digit is 0-9

Optional (0-1)

The MSISDN to use for charging purposes.

isPsi

Boolean {true, false}

Optional (0-1)

Indicates if the IMS users belonging to this subscriber are Public Service Identities, either Distinct or Wildcarded.

Default value is: false.

privacyIndicator

Boolean {true, false}

Optional (0-1)

Indicates if data sharing with the Application Servers (AS) is allowed.

privacyIndicator = false, means that data sharing with the AS is allowed.

privacyIndicator = true, means that the data is protected.

Default value is: false

defaultPrivateUserId

String

minLength value="5"

minLength value="70"

Optional (0-1)

Describes the private user identity that is applied by default. ⁽¹⁾

defaultRemoteReferenceAccessLocation

String

maxLength value = "255"

Optional (0-1)

Describes the default physical line identifier of the end equipment in the wireline access network.

asHostingPSI

String

maxLength value = "255"

Optional

Indicates the application server name hosting the PSI user used for Routing Purposes.

esrNumber

String

Pattern value="([0-9]{7})|(0-9]{10})"/

Optional

Indicates the Emergency Services Routing Number (ESRN) for a user with a public identity belonging to this subscriber.

This attribute is only applicable if routing of emergency calls based on ESRN is supported in the network.

tenantId

Integer

minInclusive value = "1"

maxInclusive value = "100"

Optional

Indicates the identifier of the Tenant Configuration associated to the IMS subscriber.

It can only take values in the range [1-100].

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute can also be included in the IMS IMPI object.

privateUser

Sub-MO

Optional (0-n)

A list of PrivateUsers

privateUserId

String

minLength value="5"

maxLength value="70"

Mandatory

Identifies the PrivateUser.

userPassword

String

minLength value="4"

maxLength value="255"

Optional (0-1)

Used for SIP Digest authentication service purposes.

userPassword and userPrimaryHA1Password cannot be present at the same time. One of them must be set if allowedAuthMechanism = Digest and isPsi = FALSE.

Note: If isPsi = TRUE, userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userPrimaryHA1Password

String

Pattern value="[0-9A-F]{1,32}"/

Optional (0-1)

Contains the A1 hashed value to be used in SIP Digest authentication when the digest username received matches the privateUserId.

userPassword and userPrimaryHA1Password cannot be present at the same time. One of them must be set if allowedAuthMechanism = Digest and isPsi = FALSE.

Note: If isPsi = TRUE, userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userSecondaryHA1Password

String

Pattern value="[0-9A-F]{1,32}"/

Optional (0-1)

Contains the A1 hashed value to be used in SIP Digest authentication when the digest username received matches with the user part (removing the realm part) of the privateUserId.

secondPrivateUserId

Sub-MO

Optional (0-n)

A list of second Private User Id

secondPrivateUserId

String

minLength value="1"

maxLength value="255"

Mandatory

Identifies an additional IMPI associated to the Multi Service Consumer, a second private user id.

This IMPI must be derived from IMSI.

If privateUserId is derived or a user IMSI is provided, or both, the identified IMSI must be the same in all attributes.

If the IMSI is defined for another subscriber, it is not allowed.

allowedAuthMechanism

String

Enumeration value = "DIGEST"

Enumeration value = "SSO"

Enumeration value = "NBA"

Optional (0-n)

Contains a list of authentication mechanisms supported by the multiServiceConsumer (Private User).

If isPsi = FALSE:

• IMS-AKA is always supported as default value in the list, regardless of this attribute.

• If DIGEST is provide, either userPassworkd or userPrimaryHA1Password must be input as well.

If isPsi = TRUE:

• userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the multiServiceConsumer (Private User) is barred or not.

Default value is: false

roamingAllowed

Boolean {true, false}

Optional (0-1)

Indicates whether the multiServiceConsumer (Private User) is allowed to roam or not.

Default value is: false

referenceAccessLocation

String

maxLength value = "255"

Optional (0-1)

Describes the physical line identifier of the end-user equipment in the wireline access network.

Cannot be provisioned if isPsi = TRUE.

userImsi

String

Pattern value = [0-9]*

minLength value = "6"

maxLength value = "15"

Optional (0-1)

Contains the IMSI associated to the PrivateUser. ⁽²⁾

msisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Optional (0-1)

Identifies the Mobile Station ISDN number assigned to a PrivateUser.

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute can also be included in the IMS Subscriber object.

ssoMsisdn

Sub-MO

Optional (0-n)

A list of MSISDN used for Single Sign-On (SSO) authentication.

ssoMsisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Mandatory

Identifies an MSISDN used for SSO authentication.

accessIdentifier

Sub-MO

Optional (0-n)

A list of Network Access Identifier assigned to the multiServiceConsumer (Private User).

accessIdentifier

String

maxLength value = "255"

Mandatory

Contains a Network Access Identifier assigned to the multiServiceConsumer (Private User).

userAccessLineIdentifier

Sub-MO

Optional (0-n)

Contains a list of physical line identifiers of end-user equipment in a wireline access network.

lineName

String

minLength value ="1"

maxLength value = "15"

Mandatory

Identifies the Access Line

value

String

Maximum Length = 255

Mandatory

Identifies the Access Line, physically.

authMechanism

String

Enumeration value = "NBA"

Enumeration value = "NBA_LINE_PROFILE"

Enumeration value = "DIGEST_LINE_PROFILE"

Optional (0-1)

Contains the authentication type to be supported by the Access Line.

publicData

Sub-MO

Optional (0-n)

A list of public data related to one or more MultiSCs (Private Users).

publicIdValue

String

SIP URI (restricted)= sip:userinfo host where userinfo=user or telephone-subscriber and in both cases followed by an @

User and telephone-subscriber do not allow the following:
" \", " <" or " >", " @", " [" or " ]", " "", " " (space), Tab, CR, or LF.

In case of a Wildcard SIP URI, the user or telephone-subscriber ends in “!.*!”

In case of a Wildcard Extended SIP URI, the user or telephone-subscriber contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Host=hostname or IPv4address or IPv6reference. See Reference [8] for detailed description of host contents. When the configuration parameter AllowSipUriWithoutDomain is set to true, host is not mandatory.

or

TEL URL (restricted)= tel:global-phone-number where global-phone-number= “+” followed by digits 0-9 . In case of a Wildcard TEL URL the global-phone-number ends in “!.*!”

In case of a Wildcard Extended TEL URI, the global-phone-number contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Maximum length = 255

Mandatory

Identifies the Public Identity. ⁽³⁾

Can be either a:

Restricted SIP URI or TEL URL, Wildcard SIP URI or Wildcard TEL URL, Wildcard Extended SIP URI or Wildcard Extended TEL URL.

Examples:

• sip -
  sip:impu1@operator.com

• tel -
  tel:+34657881898

Can be derived from IMSI or MSISDN.

Examples:

• sip -
  sip:IMSI@ims.mncXXX.mccXXX.
  3gppnetwork.org
  sip:+MSISDN@ims.mncXXX.mccXXX.
  3gppnetwork.org

• tel -
  tel:+MSISDN

Wildcard can be used in both SIP URI and TEL URL. The wildcard has the format !.*!.

For SIP URI, the wildcard is to be placed before the “@” character. For TEL URL, the wildcard is to be placed at the end of the parameter.

Examples of SIP URI with wildcard:

• sip:department1!.*!@operator.com

• sip:!.*!@operator.com

Examples of TEL URL with wildcard:

• tel:+34657!.*!

• tel:+!.*!

Wildcard Extended is supported from 12B, and must be indicated as such with the isWildcardExtended parameter.

The wildcard extended has the format of a TEL URL or a SIP URI that can be defined with an extended regular expression.

Examples of Wildcard Extended are:

• tel:+34!91[0-9]{7,7}!

• tel:+34!91[0-9]{7,7}!4

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!@operator.com

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!_public@operator.com

privateUserId

String

minLength value="5"

maxLength value="70"

Optional (0-1)

This attribute indicates the associated PrivateUser to this PublicUser. If this attribute is not present, all PrivateUsers belonging to the subscriber which the PublicUser belongs to are associated to this PublicUser.

xcapAllowed

Boolean {true, false}

Optional (0-1)

States if the Public Identity can also be used in XCAP authentication.

Default value is: false.

If the IMPU is a PSI or if it is a wildcarded public identity or a TEL URL, then XCAP authentication must be set to false.

xcapPassword

String

minLength value="4"

minLength value="255"

Optional (0-1)

Used for XCAP authentication service purposes.

If value is not provisioned and xcapAllowed = TRUE, then the IMPI userPassword is used for XCAP authentication.

implicitRegSet

Integer

Mandatory

Identifies the Implicit Registration Set (IRS) which the Public Identity belongs to.

The first defined Public Identity of an ISR automatically becomes the default Public Identity in the ISR.

If the Public Identity does not belong to an IRS, the value of this attribute must be 0.

A wildcarded IMPU must belong to an IRS set to a value different from 0.

serviceProfileId

String

maxLength value="66"

Optional (0-1)

Serves as a reference to identify the Subscriber Service Profile assigned for the specific Public Identity.

wirelineAccessAllowed

String

Enumeration value = "ALLOWED_FROM_ANY_LOCATION"

Enumeration value = "ALLOWED_ONLY_FROM_RAL"

Enumeration value = "ALLOWED_FROM_AUTHORIZED_LOCATIONS"

Enumeration value = "ALLOWED_FROM_ANY_LOCATION_EXCEPT_IF_NO_PANI"

Enumeration value = "ALLOWED_ONLY_IF_PANI_INCL_AUTH_LOCATION"

Optional (0-1)

Indicates if the Public Identity is allowed to access from nomad locations.

The default value is ALLOWED_FROM_ANY_LOCATION.

authorizedVisitedAccessLine

String

maxLength value="255"

Optional (0-n)

Contains a list of userAccessLineIdentifier sub-MO identifiers, indicating the access lines that are allowed to be connected. ⁽⁴⁾

sessionBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the Public Identity is barred for HSS session establishment.

Default value is: false

maxNumberOfContacts

Integer

When configuration parameter ExMaxNumberOfContacts is set to true:

minInclusive value="1"

maxInclusive value="200"

When configuration parameter ExMaxNumberOfContacts is set to false:

minInclusive value="1"

Pattern value =""\d{1}"

maxInclusive value="5"

Optional (0-1)

Indicates the maximum number of contacts that are allowed.

When configuration parameter ExMaxNumberOfContacts is set to false, default value is 1.

priorityLevel

Integer

minLength value="0"

maxLength value="4"

Optional (0-1)

Indicates the service priority level for the IMS Public Identity (IMPU).

isWildcardExtended

Boolean {true, false}

Optional (0-1)

This attribute indicates if the IMPU is defined as a Wildcard Extended public identity (using extended regular expression to define the identity).

true or false

aliasGroupId

String

Optional

Indicates which Alias Group the Public Identity belongs to.

When adding the IMPU to an Alias Group, the IMPU must already belong to an IRS. Also, the ImsIrs and ImsServProfId attributes of the IMPU must have the same values as other IMPUs in the Alias Group.

It is not allowed to move the IMPU between Alias Groups in a single operation just by changing the ImsAliasGroupId attribute from one non-zero value to another.

If the IMPU stores Transparent Data specific to the IMPU, then it is not allowed to add the IMPU to an Alias Group.

subscriberServiceProfile

Sub-MO

Optional (0-n)

A list of subscriber service profiles associated to a public identity.

serviceProfileId

String

maxLength value="66"

Mandatory

Identifies the subscriber service profile.

configuredServiceProfile

Sub-MO

Optional (0-n)

Contains a list of all the Service Profiles in HSS-FE associated to the Subscriber Service Profile.

configuredServiceProfileId

String

maxLength value="255"

Mandatory

Identifies the configured service profile.

subscribedMediaProfile

Unsigned integer

Optional (0-1)

Used to identify the set of session description parameters that the multiServiceConsumer (Private User) is authorized to request.

maxNumberSessions

Unsigned integer

Optional (0-1)

Defines the maximum number of simultaneous sessions allowed for the user equipment.

Default value is: 1

phoneContext

String

minLength Value = "0"

maxLength value = "255"

Optional (0-1)

Defines the default dialing context used by the S-CSCF to determine which dialing plan rules that applies to a request originating from a specific Public Identity when the terminating party is identified by local phone number. If a domain name is used, it does not need to be a routable domain since it is used for logically scooping dialing plans and not for IP routing. ⁽⁵⁾

To pass validation, phoneContext must be: 1 to 15 digits with + at the beginning, or a Domain (where a . is mandatory).

1-15 digits

Example: +3586675550123

Domain

Example: fc3c399fb513f501c36b6dca35c7105de336b296d0.it

individualServiceProfile

Sub-MO

Optional (0-n)

Contains a list of individual service profiles associated to a specific subscriber service profile.

individualServiceProfileId

String

minLength value="5"

maxLength value="63"

Mandatory

Used to identify an individual service profile.

individualCapability

Unsigned integer

Optional (0-n)

Contains a list of capabilities needed for the execution of the service associated with this individual service profile.

It can only take values in the range [1 - 100].

The values in the set formed by individualCapability and individualOptionalCapability cannot be repeated.

individualOptionalCapability

Unsigned integer

Optional (0-n)

Contains a list of optional capabilities needed for the execution of the service associated with this individual service profile

The values in the set formed by individualCapability and individualOptionalCapability cannot be repeated.

individualTrigger

Sub-MO

Optional (0-n)

A list of individual triggers associated to a specific individual service profile.

triggerDescription

String

maxLength value="69"

Mandatory

Identifies the trigger.

triggerPriority

Unsigned integer

Mandatory

Identifies the priority of the trigger. The priority must be unique for a certain subscriber service profile.

Only even values are allowed.

isActive

Boolean {true, false}

Optional (0-1)

Indicates that this specific trigger is enabled.

Default value is: false

triggerType

String

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-1)

Used to identify the type of the trigger. If this attribute is empty, the trigger applies to all registration cases.

The trigger criteria belong to the group 0.

detectionPoint

String

maxLength = "255"

Optional (0-1)

Indicates when the trigger is evaluated.

The trigger criteria belong to the group 0.

negatedDetectionPoint

Boolean {true, false}

Optional (0-1)

Indicates if the Detection Point is negated or not.

conditionType

String

Enumeration value = "AND"

Enumeration value = "OR"

Optional (0-1)

This attribute indicates the relationship among the different criteria within the same trigger criteria group. The condition applies only to the attributes: triggerType, detectionPoint, requestedURI, sipHeader, and registrationType.

"AND" means that the trigger criteria are linked by an AND operator.

"OR" means that the trigger criteria are linked by an OR operator.

The opposite as the one defined applies to the relation among the different groups.

requestedURI

String

maxLength = "255"

Optional (0-1)

Defines a trigger condition based on the content of the Request-uri for the request.

The trigger criteria belong to the group 0.

negatedRequestedURI

Boolean {true, false}

Optional (0-1)

Indicates if the Requested URI is negated or not.

sipHeader

String

maxLength = "255"

Optional (0-n)

Contains a list of structures identifying a SIP Header of this specific trigger.

The trigger criteria belong to the group 0.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

applicationServer

String

maxLength = "255"

Mandatory

Presents the Application Server that is applied for this specific trigger.

registrationType

String

Enumeration value = "INITIAL_REGISTRATION"

Enumeration value = "RE-REGISTRATION"

Enumeration value = "DE-REGISTRATION"

Optional (0-2)

Contains a list of registration cases that restrict the trigger conditions when the trigger criteria group is 0. ⁽⁶⁾

defaultHandling

String

Enumeration value = "SESSION_CONTINUED"

Enumeration value = "SESSION_TERMINATED"

Optional (0-1)

Represents the default handling of the S-CSCF when the connection with the Application Server of the current trigger cannot be established.

includeRegisterRequest

Boolean {true, false}

Optional (0-1)

This parameter indicates whether the tag IncludeRegisterRequest is included or not in the 3GPP User-Data AVP.

includeRegisterResponse

Boolean {true, false}

Optional (0-1)

This parameter indicates whether the tag IncludeRegisterResponse is included or not in the 3GPP User-Data AVP.

triggerCriteriaGroup

Sub-MO

Optional (0-n)

A list of trigger criteria groups associated to a specific individual TriggerA

groupId

Integer

Mandatory

This attribute identifies each SPT Group. The value cannot be 0.

sessionDescription

String

maxLength ="255"

Optional (0-n)

Defines the trigger criteria for the content of any Session Description Protocol (SDP) field within the body of a SIP method. Format: <NegatedSessionDescription>:<SDLine>: <Content>

Example:

FALSE:m:audio49170 RTP/AVP 0 Or

FALSE:m

Type:

<Boolean>:<String>:<String>

sessionCase

String

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-n)

Defines the trigger criteria for the session cases. If this attribute is empty, the trigger applies to all registration cases.

sipMethod

String

maxLength ="255"

Optional (0-n)

Indicates when the trigger is evaluated. It includes the SIP method and the registration type when applies.

Format:

<NegatedSipMethod>:<SipMethod>: <RegistrationType>

Example:

FALSE:Subscribe

Or

FALSE:Register:2

Type:

<Boolean>:<String>:<enumerated>

groupRequestedURI

String

maxLength ="255"

Optional (0-n)

Defines a trigger condition based on the content of the Request-uri for the request.

Format:

<NegatedGroupRequestedUri>:<GroupRequestedUri>

Example:

FALSE:intranet.ericsson.com

Type:

<Boolean>:<String>

sipHeader

String

maxLength ="255"

Optional (0-n)

Contains a list of structures identifying a SIP Header of this specific trigger.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

associationId

String

maxLength value = "32"

Optional

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

impi

String

minLength value="5"

maxLength value="70"

Optional

Identifies the Private User.

impu

String

SIP URI (restricted)= sip:userinfo host where userinfo=user or telephone-subscriber and in both cases followed by an @

User and telephone-subscriber do not allow the following:
" \", " <" or " >", " @", " [" or " ]", " "", " " (space), Tab, CR, or LF.

In case of a Wildcard SIP URI, the user or telephone-subscriber ends in “!.*!”

In case of a Wildcard Extended SIP URI, the user or telephone-subscriber contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Host=hostname or IPv4address or IPv6reference. See Reference [8] for detailed description of host contents.

or

TEL URL (restricted)= tel:global-phone-number where global-phone-number= “+” followed by digits 0-9 . In case of a Wildcard TEL URL the global-phone-number ends in “!.*!”

In case of a Wildcard Extended TEL URI, the global-phone-number contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Maximum length = 255

Optional

Identifies the Public Identity. ⁽¹⁾

During an on going IMSICHO, only new IMPU will be returned.

Can be either a:

Restricted SIP URI or TEL URL, Wildcard SIP URI or Wildcard TEL URL, Wildcard Extended SIP URI or Wildcard Extended TEL URL.

Examples:

• sip -
  sip:impu1@operator.com

• tel -
  tel:+34657881898

Can be derived from IMSI or MSISDN.

Examples:

• sip -
  sip:IMSI@ims.mncXXX.mccXXX.
  3gppnetwork.org
  sip:+MSISDN@ims.mncXXX.mccXXX.
  3gppnetwork.org

• tel -
  tel:+MSISDN

Wildcard can be used in both SIP URI and TEL URL. The wildcard has the format !.*!.

For SIP URI, the wildcard is to be placed before the “@” character. For TEL URL, the wildcard is to be placed at the end of the parameter.

Examples of SIP URI with wildcard:

• sip:department1!.*!@operator.com

• sip:!.*!@operator.com

Examples of TEL URL with wildcard:

• tel:+34657!.*!

• tel:+!.*!

Wildcard Extended is supported from 12B, and must be indicated as such with the isWildcardExtended parameter.

The wildcard extended has the format of a TEL URL or a SIP URI that can be defined with an extended regular expression.

Examples of Wildcard Extended are:

• tel:+34!91[0-9]{7,7}!

• tel:+34!91[0-9]{7,7}!4

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!@operator.com

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!_public@operator.com

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

impi

String

minLength value="5"

maxLength value="70"

Optional

Identifies the Private User.

impu

String

SIP URI (restricted)= sip:userinfo host where userinfo=user or telephone-subscriber and in both cases followed by an @

User and telephone-subscriber do not allow the following:
" \", " <" or " >", " @", " [" or " ]", " "", " " (space), Tab, CR, or LF.

In case of a Wildcard SIP URI, the user or telephone-subscriber ends in “!.*!”

In case of a Wildcard Extended SIP URI, the user or telephone-subscriber contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Host=hostname or IPv4address or IPv6reference. See Reference [8] for detailed description of host contents.

or

TEL URL (restricted)= tel:global-phone-number where global-phone-number= “+” followed by digits 0-9 . In case of a Wildcard TEL URL the global-phone-number ends in “!.*!”

In case of a Wildcard Extended TEL URI, the global-phone-number contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Maximum length = 255

Optional

Identifies the Public Identity. ⁽¹⁾

During an on going IMSICHO, only new IMPU will be returned.

Can be either a:

Restricted SIP URI or TEL URL, Wildcard SIP URI or Wildcard TEL URL, Wildcard Extended SIP URI or Wildcard Extended TEL URL.

Examples:

• sip -
  sip:impu1@operator.com

• tel -
  tel:+34657881898

Can be derived from IMSI or MSISDN.

Examples:

• sip -
  sip:IMSI@ims.mncXXX.mccXXX.
  3gppnetwork.org
  sip:+MSISDN@ims.mncXXX.mccXXX.
  3gppnetwork.org

• tel -
  tel:+MSISDN

Wildcard can be used in both SIP URI and TEL URL. The wildcard has the format !.*!.

For SIP URI, the wildcard is to be placed before the “@” character. For TEL URL, the wildcard is to be placed at the end of the parameter.

Examples of SIP URI with wildcard:

• sip:department1!.*!@operator.com

• sip:!.*!@operator.com

Examples of TEL URL with wildcard:

• tel:+34657!.*!

• tel:+!.*!

Wildcard Extended is supported from 12B, and must be indicated as such with the isWildcardExtended parameter.

The wildcard extended has the format of a TEL URL or a SIP URI that can be defined with an extended regular expression.

Examples of Wildcard Extended are:

• tel:+34!91[0-9]{7,7}!

• tel:+34!91[0-9]{7,7}!4

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!@operator.com

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!_public@operator.com

chargingProfId

String

maxLength value= "255"

Optional (0-1)

Identifies the Charging Profile configured in HSS-FE.

Default value is: DefaultChargingProfile

chargingId

String

Pattern value = "\d{5,15}"

5-15 digits

Each digit is 0-9

Optional (0-1)

The MSISDN to use for charging purposes.

isPsi

Boolean {true, false}

Optional (0-1)

Indicates if the IMS users belonging to this subscriber are Public Service Identities, either Distinct or Wildcarded.

Default value is: false

privacyIndicator

Boolean {true, false}

Optional (0-1)

Indicates if data sharing with the Application Servers (AS) is allowed.

privacyIndicator = false, means that data sharing with the AS is allowed.

privacyIndicator = true, means that the data is protected.

Default value is: false

defaultPrivateUserId

String

minLength value="5"

maxLength value="70"

Optional (0-1)

Describes the private user identity that is applied by default. ⁽²⁾

During an ongoing IMSICHO, only new IMPI will be returned.

defaultRemoteReferenceAccess Location

String

maxLength value="255"

Optional (0-1)

Describes the default physical line identifier of the end equipment in the wireline access network.

asHostingPSI

String

maxLength value="255"

Optional

This attribute indicates the application server name hosting the PSI user used for Routing Purposes.

tenantId

Integer

minInclusive value = "1"

maxInclusive value = "100"

Optional

Indicates the identifier of the Tenant Configuration associated to the IMS subscriber.

It can only take values in the range [1-100].

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute can also be included in the IMS IMPI object.

esrNumber

String

Pattern value="([0-9]{7})|(0-9]{10})"/

Optional

Indicates the Emergency Services Routing Number (ESRN) for a user with a public identity belonging to this subscriber.

This attribute is only applicable if routing of emergency calls based on ESRN is supported in the network.

originatingCallsS-CSCF

String

maxLength value="255"

Optional

This attribute identifies the S-CSCF that serves the registered Public Identities for originating calls.

terminatingCallsS-CSCF

String

maxLength value="255"

Optional

This attribute identifies the S-CSCF that serves the registered Public Identities for terminating calls.

diaServId

String

maxLength value="255"

Optional

This attribute indicates the Diameter Identity of the S-CSCF serving this Private Identity.

diaServRealm

String

maxLength value="255"

Optional

This attribute indicates the Diameter realm of the S-CSCF serving this Private Identity.

privateUser

Sub-MO

Optional (0-n)

A list of PrivateUsers

privateUserId

String

minLength value="5"

maxLength value="70"

Mandatory

Identifies the PrivateUser. ⁽²⁾

During an ongoing IMSICHO, only new IMPI will be returned.

secondPrivateUserId

Sub-MO

Optional (0-n)

A list of second Private User Id

secondPrivateUserId

String

minLength value="1"

maxLength value="255"

Mandatory

Identifies an additional IMPI associated to the Multi Service Consumer, a second private user id.

It must be derived from an IMSI.

allowedAuthMechanism

String

Enumeration value = "DIGEST"

Enumeration value = "SSO"

Enumeration value = "NBA"

Optional (0-n)

Contains a list of authentication mechanisms supported by the multiServiceConsumer (Private User).

If isPsi = FALSE:

• IMS-AKA is always supported as default value in the list, regardless of this attribute.

• If DIGEST is provide, either userPassworkd or userPrimaryHA1Password must be input as well.

If isPsi = TRUE:

• userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the multiServiceConsumer (Private User) is barred or not.

Default value is: false

roamingAllowed

Boolean {true, false}

Optional (0-1)

Indicates whether the multiServiceConsumer (Private User) is allowed to roam or not.

Default value is: false

referenceAccessLocation

String

maxLength value= "255"

Optional (0-1)

Describes the physical line identifier of the end-user equipment in the wireline access network.

Cannot be provisioned if isPsi = TRUE.

userImsi

String

Pattern value = [0-9]*

minLength value = "6"

maxLength value = "15"

Optional (0-1)

Contains the IMSI associated to the PrivateUser ⁽³⁾

During an ongoing IMSICHO, only new IMSI will be returned.

msisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Optional (0-1)

Identifies the Mobile Station ISDN number assigned to a multiServiceConsumer.

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute can also be included in the IMS Subscriber object.

ssoMsisdn

Sub-MO

Optional (0-n)

A list of MSISDN used for Single Sign-On (SSO) authentication.

ssoMsisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Mandatory

Identifies an MSISDN used for SSO authentication.

numOfFailedSipAuthAttempts

Integer

Optional (0-1)

Contains the number of failed authentication attempts.

accessIdentifier

Sub-MO

Optional (0-n)

A list of Network Access Identifier assigned to the multiServiceConsumer (Private User).

accessIdentifier

String

maxLength value = "255"

Mandatory

Contains a Network Access Identifier assigned to the multiServiceConsumer (Private User).

userAccessLineIdentifier

Sub-MO

Optional (0-n)

Contains a list of physical line identifiers of end-user equipment in a wireline access network.

lineName

String

minLength value="1"

maxLength value="15"

Mandatory

Identifies the Access Line

value

String

maxLength value="255"

Mandatory

Identifies the Access Line, physically.

authMechanism

String

Enumeration value = "NBA"

Enumeration value = "NBA_LINE_PROFILE"

Enumeration value = "DIGEST_LINE_PROFILE"

Optional (0-1)

Contains the authentication type to be supported by the Access Line.

publicData

Sub-MO

Optional (0-n)

A list of public data related to one or more MultiSCs (Private Users).

publicIdValue

String

SIP URI (restricted)= sip:userinfo host where userinfo=user or telephone-subscriber and in both cases followed by an @

User and telephone-subscriber do not allow the following:
" \", " <" or " >", " @", " [" or " ]", " "", " " (space), Tab, CR, or LF.

In case of a Wildcard SIP URI, the user or telephone-subscriber ends in “!.*!”

In case of a Wildcard Extended SIP URI, the user or telephone-subscriber contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Host=hostname or IPv4address or IPv6reference. See Reference [8] for detailed description of host contents.

or

TEL URL (restricted)= tel:global-phone-number where global-phone-number= “+” followed by digits 0-9 . In case of a Wildcard TEL URL the global-phone-number ends in “!.*!”

In case of a Wildcard Extended TEL URI, the global-phone-number contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Maximum length = 255

Mandatory

Identifies the Public Identity. ⁽⁴⁾

During an on going IMSICHO, only new IMPU will be returned.

Can be either a:

Restricted SIP URI or TEL URL, Wildcard SIP URI or Wildcard TEL URL, Wildcard Extended SIP URI or Wildcard Extended TEL URL.

Examples:

• sip -
  sip:impu1@operator.com

• tel -
  tel:+34657881898

Can be derived from IMSI or MSISDN.

Examples:

• sip -
  sip:IMSI@ims.mncXXX.mccXXX.
  3gppnetwork.org
  sip:+MSISDN@ims.mncXXX.mccXXX.
  3gppnetwork.org

• tel -
  tel:+MSISDN

Wildcard can be used in both SIP URI and TEL URL. The wildcard has the format !.*!.

For SIP URI, the wildcard is to be placed before the “@” character. For TEL URL, the wildcard is to be placed at the end of the parameter.

Examples of SIP URI with wildcard:

• sip:department1!.*!@operator.com

• sip:!.*!@operator.com

Examples of TEL URL with wildcard:

• tel:+34657!.*!

• tel:+!.*!

Wildcard Extended is supported from 12B, and must be indicated as such with the isWildcardExtended parameter.

The wildcard extended has the format of a TEL URL or a SIP URI that can be defined with an extended regular expression.

Examples of Wildcard Extended are:

• tel:+34!91[0-9]{7,7}!

• tel:+34!91[0-9]{7,7}!4

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!@operator.com

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!_public@operator.com

privateUserId

String

minLength value="5"

maxLength value="70"

Mandatory

This attribute indicates the associated PrivateUser to this PublicUser ⁽²⁾. If the PublicUser is connected to multiple PrivateUsers, then the value will be shared.

During an ongoing IMSICHO, only new IMPI will be returned.

xcapAllowed

Boolean {true, false}

Optional (0-1)

States if the Public Identity can also be used in XCAP authentication.

Default value is: false.

If the IMPU is a PSI or if it is a wildcarded public identity or a TEL URL, then XCAP authentication must be set to false.

implicitRegSet

Integer

Mandatory

Identifies the Implicit Registration Set (IRS) which the Public Identity belongs to.

The first defined Public Identity of an ISR automatically becomes the default Public Identity in the ISR.

If the Public Identity does not belong to an IRS, the value of this attribute must be 0.

A wildcarded IMPU must belong to an IRS set to a value different from 0.

isDefault

Boolean {true, false}

Mandatory

This attribute indicates if the Public Identity is the default of its IRS.

When an IMPU of a specific type is set to default, the former one of the same types is unmarked automatically as such. Only one IMPU of each type (SIP URI or TEL URL) can be defined as default in a set. The first IMPU of an IRS must be marked as default.

serviceProfileId

String

maxLength value="66"

Optional (0-1)

Serves as a reference to identify the Subscriber Service Profile assigned for the specific Public Identity.

wirelineAccessAllowed

String

Enumeration value = "ALLOWED_FROM_ANY_LOCATION"

Enumeration value = "ALLOWED_ONLY_FROM_RAL"

Enumeration value = "ALLOWED_FROM_AUTHORIZED_LOCATIONS"

Enumeration value = "ALLOWED_FROM_ANY_LOCATION_EXCEPT_IF_NO_PANI"

Enumeration value = "ALLOWED_ONLY_IF_PANI_INCL_AUTH_LOCATION"

Optional (0-1)

Indicates if the Public Identity is allowed to access from nomad locations.

authorizedVisitedAccessLine

String

maxLength value = "255"

Optional (0-n)

Contains a list of userAccessLineIdentifier sub-MO identifiers, indicating the access lines that are allowed to be connected. ⁽⁵⁾

sessionBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the Public Identity is barred for HSS session establishment.

Default value is: false

maxNumberOfContacts

Integer

When configuration parameter ExMaxNumberOfContacts is set to true:

minInclusive value="1"

maxInclusive value="200"

When configuration parameter ExMaxNumberOfContacts is set to false:

minInclusive value="1"

Pattern value =""\d{1}"

maxInclusive value="5"

Optional (0-1)

Indicates the maximum number of contacts that are allowed.

When configuration parameter ExMaxNumberOfContacts is set to false, default value is 1.

priorityLevel

Integer

minLength value="0"

maxLength value="4"

Optional (0-1)

Indicates the service priority level for the IMS Public Identity (IMPU).

isWildcardExtended

Boolean {true, false}

Optional (0-1)

This attribute indicates if the IMPU is defined as a Wildcard Extended public identity (using extended regular expression to define the identity).

true or false

aliasGroupId

String

Optional

Indicates which Alias Group the Public Identity belongs to.

When adding the IMPU to an Alias Group, the IMPU must already belong to an IRS. Also, the ImsIrs and ImsServProfId attributes of the IMPU must have the same values as other IMPUs in the Alias Group.

It is not allowed to move the IMPU between Alias Groups in a single operation just by changing the ImsAliasGroupId attribute from one non-zero value to another.

If the IMPU stores Transparent Data specific to the IMPU, then it is not allowed to add the IMPU to an Alias Group.

privateUserIdState

Sub-MO

Optional (0-1)

Contains a list of structures indicating the registration state of each of the Private Identities associated to a specific Public Identity.

privatesUserId

String

minLength value="5"

maxLength value="70"

Mandatory

Identifies the PrivateUser

state

String

Enumeration value = "NOT_REGISTERED"

Mandatory

Contains the registration state.

State can only be set to NOT_REGISTERED

numOfFailedXcapAuthAttempts

Integer

Optional (0-1)

Contains the number of failed XCAP authentication attempts.

numOfFailedXcapAuthAttempts can only be set to 0.

subscriberServiceProfile

Sub-MO

Optional (0-n)

A list of subscriber service profiles associated to a public identity.

serviceProfileId

String

maxLength value="66"

Mandatory

Identifies the subscriber service profile.

configuredServiceProfile

Sub-MO

Optional (0-n)

Contains a list of all the Service Profiles in HSS-FE associated to the Subscriber Service Profile.

configuredServiceProfileId

String

maxLength value="255"

Mandatory

Identifies the configured service profile.

subscribedMediaProfile

Unsigned integer

Optional (0-1)

Used to identify the set of session description parameters that the multiServiceConsumer (Private User) is authorized to request.

maxNumberSessions

Unsigned integer

Optional (0-1)

Defines the maximum number of simultaneous sessions allowed for the user equipment.

Default value is: 1

phoneContext

String

minLength Value = "0"

maxLength value = "255"

Optional (0-1)

Defines the default dialing context used by the S-CSCF to determine which dialing plan rules that applies to a request originating from a specific Public Identity when the terminating party is identified by local phone number. If a domain name is used, it does not need to be a routable domain since it is used for logically scooping dialing plans and not for IP routing. ⁽⁶⁾

Can consist of digits or domain value:

1-15 digits

Example: +3586675550123

Domain

Example: fc3c399fb513f501c36b6dca35c7105de336b296d0.it

individualServiceProfile

Sub-MO

Optional (0-n)

Contains a list of individual service profiles associated to a specific subscriber service profile.

individualServiceProfileId

String

minLength value="5"

maxLength value="63"

Mandatory

Used to identify an individual service profile.

individualCapability

Unsigned integer

Optional (0-n)

Contains a list of capabilities needed for the execution of the service associated with this individual service profile.

individualOptionalCapability

Unsigned integer

Optional (0-n)

Contains a list of optional capabilities needed for the execution of the service associated with this individual service profile

individualTrigger

Sub-MO

Optional (0-n)

A list of individual triggers associated to a specific individual service profile.

triggerDescription

String

maxLength value="69"

Mandatory

Identifies the trigger.

triggerPriority

Unsigned integer

Mandatory

Identifies the priority of the trigger. The priority must be unique for a certain subscriber service profile.

Only even values are allowed.

isActive

Boolean {true, false}

Optional (0-1)

Indicates that this specific trigger is enabled.

Default value is: false

triggerType

String

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING _UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-1)

Used to identify the type of the trigger. If this attribute is empty, the trigger applies to all registration cases.

The trigger criteria belong to the group 0.

detectionPoint

String

maxLength = "255"

Optional (0-1)

Indicates when the trigger is evaluated.

The trigger criteria belong to the group 0.

negatedDetectionPoint

Boolean {true, false}

Optional (0-1)

Indicates if the Detection Point is negated or not.

conditionType

String

Enumeration value = "AND"

Enumeration value = "OR"

Optional (0-1)

This attribute indicates the relationship among the different criteria within the same trigger criteria group. The condition applies only to the attributes: triggerType, detectionPoint, requestedURI, sipHeader, and registrationType.

"AND" means that the trigger criteria are linked by an AND operator.

"OR" means that the trigger criteria are linked by an OR operator.

The opposite as the one defined applies to the relation among the different groups.

requestedURI

String

maxLength = "255"

Optional (0-1)

Defines a trigger condition based on the content of the Request-uri for the request.

The trigger criteria belong to the group 0.

negatedRequestedURI

Boolean {true, false}

Optional (0-1)

Indicates if the Requested URI is negated or not.

sipHeader

String

maxLength = "255"

Optional (0-n)

Contains a list of structures identifying a SIP Header of this specific trigger.

The trigger criteria belong to the group 0.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

applicationServer

String

maxLength = "255"

Mandatory

Presents the Application Server that is applied for this specific trigger.

registrationType

String

Enumeration value = "INITIAL_REGISTRATION"

Enumeration value = "RE-REGISTRATION"

Enumeration value = "DE-REGISTRATION"

Optional (0-2)

Contains a list of registration cases that restrict the trigger conditions when the trigger criteria group is 0. ⁽⁷⁾

defaultHandling

String

Enumeration value = "SESSION_CONTINUED"

Enumeration value = "SESSION_TERMINATED"

Optional (0-1)

Represents the default handling of the S-CSCF when the connection with the Application Server of the current trigger cannot be established.

includeRegisterRequest

Boolean {true, false}

Optional (0-1)

This parameter indicates whether the tag IncludeRegisterRequest is included or not in the 3GPP User-Data AVP.

includeRegisterResponse

Boolean {true, false}

Optional (0-1)

This parameter indicates whether the tag IncludeRegisterResponse is included or not in the 3GPP User-Data AVP.

triggerCriteriaGroup

Sub-MO

Optional (0-n)

A list of trigger criteria groups associated to a specific individual TriggerA

groupId

Integer

Mandatory

This attribute identifies each SPT Group. The value cannot be 0.

sessionDescription

String

maxLength ="255"

Optional (0-n)

Defines the trigger criteria for the content of any Session Description Protocol (SDP) field within the body of a SIP method. Format: <NegatedSessionDescription>:<SDLine>: <Content>

Example:

FALSE:m:audio49170 RTP/AVP 0 Or

FALSE:m

Type:

<Boolean>:<String>:<String>

sessionCase

String

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-n)

Defines the trigger criteria for the session cases. If this attribute is empty, the trigger applies to all registration cases.

sipMethod

String

maxLength ="255"

Optional (0-n)

Indicates when the trigger is evaluated. It includes the SIP method and the registration type when applies.

Format:

<NegatedSipMethod>:<SipMethod>: <RegistrationType>

Example:

FALSE:Subscribe

Or

FALSE:Register:2

Type:

<Boolean>:<String>:<enumerated>

groupRequestedURI

String

maxLength ="255"

Optional (0-n)

Defines a trigger condition based on the content of the Request-uri for the request.

Format:

<NegatedGroupRequestedUri>:<GroupRequestedUri>

Example:

FALSE:intranet.ericsson.com

Type:

<Boolean>:<String>

sipHeader

String

maxLength ="255"

Optional (0-n)

Contains a list of structures identifying a SIP Header of this specific trigger.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

aliasGroup

Sub-MO

Optional (0-n)

A list of alias groups associated to a public identity.

aliasGroupId

String

Mandatory

Identifies the Alias Group assigned to a subscriber (public identity).

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

chargingProfId

String

maxLength value = "255"

Optional (0-1)

Identifies the Charging Profile configured in HSS-FE.

Default value is: DefaultChargingProfile

chargingId

String

Pattern value = "\d{5,15}"

5-15 digits

Each digit is 0-9

Optional (0-1)

The MSISDN to use for charging purposes.

isPsi

Boolean {true, false}

Optional (0-1)

Indicates if the IMS users belonging to this subscriber are Public Service Identities, either Distinct or Wildcarded.

Default value is: false

privacyIndicator

Boolean {true, false}

Optional (0-1)

Indicates if data sharing with the Application Servers (AS) is allowed.

privacyIndicator = false, means that data sharing with the AS is allowed.

privacyIndicator = true, means that the data is protected.

Default value is: false

defaultPrivateUserId

String

minLength value = "5"

maxLength value = "70"

Optional (0-1)

Describes the private user identity that is applied by default. ⁽¹⁾

defaultRemoteReferenceAccessLocation

String

maxLength value = "255"

Optional (0-1)

Describes the default physical line identifier of the end equipment in the wireline access network.

Cannot be provisioned if isPsi = TRUE.

asHostingPSI

String

maxLength value = "255"

Optional

This attribute indicates the application server name hosting the PSI user used for Routing Purposes.

esrNumber

String

Pattern value="([0-9]{7})|(0-9]{10})"/

Optional

Indicates the Emergency Services Routing Number (ESRN) for a user with a public identity belonging to this subscriber.

This attribute is only applicable if routing of emergency calls based on ESRN is supported in the network.

tenantId

Integer

minInclusive value = "1"

maxInclusive value = "100"

Optional

Indicates the identifier of the Tenant Configuration associated to the IMS subscriber.

It can only take values in the range [1-100].

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute may also be included in the IMS IMPI object.

privateUser

Sub-MO [nillable]

Optional (0-n)

A list of PrivateUsers

privateUserId

String

minLength value="5"

maxLength value="70"

Optional (0-1)

Can only be added

Identifies the PrivateUser.

userPassword

String

minLength value="4"

maxLength value="255"

Optional (0-1)

Used for SIP Digest authentication service purposes.

userPassword and userPrimaryHA1Password cannot be present at the same time. One of them must be set if allowedAuthMechanism = Digest and isPsi = FALSE.

Note: If isPsi = TRUE, userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userPrimaryHA1Password

String

Pattern value="[0-9A-F]{1,32}"/

Optional (0-1)

Contains the A1 hashed value to be used in SIP Digest authentication when the digest username received matches the privateUserId.

userPassword and userPrimaryHA1Password cannot be present at the same time. One of them must be set if allowedAuthMechanism = Digest and isPsi = FALSE.

Note: If isPsi = TRUE, userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userSecondaryHA1Password

String

Pattern value="[0-9A-F]{1,32}"/

Optional (0-1)

Contains the A1 hashed value to be used in SIP Digest authentication when the digest username received matches with the user part (not the realm part) of the privateUserId.

secondPrivateUserId

Sub-MO [nillable]

Optional (0-n)

A list of second Private User Id

secondPrivateUserId

String

minLength value="1"

maxLength value="255"

Mandatory

Identifies an additional IMPI associated to the Multi Service Consumer, a second private user id. It is not allowed to modify the value of secondPrivateUserId. It must be deleted and then created with the new value.

It must be derived from an IMSI.

allowedAuthMechanism

String

Enumeration value = "DIGEST"

Enumeration value = "SSO"

Enumeration value = "NBA"

Enumeration value = ""

Optional (0-n)

Contains a list of authentication mechanisms supported by the multiServiceConsumer (Private User).

If isPsi = FALSE:

• IMS-AKA is always supported as default value in the list, regardless of this attribute.

• The Set operation uses value "" to clear up the list. Then only IMS-AKA is supported.

• If DIGEST is provide, either userPassworkd or userPrimaryHA1Password must be input as well.

If isPsi = TRUE:

• userPassword, userPrimaryHA1Password, and allowedAuthMechanism do not take effect in the HSS traffic handling.

userBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the multiServiceConsumer (Private User) is barred or not.

Default value is: false

roamingAllowed

Boolean {true, false}

Optional (0-1)

Indicates whether the multiServiceConsumer (Private User) is allowed to roam or not.

Default value is: false

referenceAccessLocation

String

maxLength value = "255"

Optional (0-1)

Describes the physical line identifier of the end-user equipment in the wireline access network.

Cannot be provisioned if isPsi = TRUE.

userImsi

String

Pattern value = [0-9]*

minLength value = "6"

maxLength value = "15"

Optional (0-1)

Can only be added

Contains the IMSI associated to the PrivateUser ⁽²⁾

msisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Optional (0-1)

Can only be added

Identifies the Mobile Station ISDN number assigned to a PrivateUser.

looseRouteId

String

Enumeration value = "LOOSE_ROUTE_REQUIRED"

Enumeration value = "LOOSE_ROUTE_NOT_REQUIRED"

Optional (0-1)

Indicates to the S-CSCF whether Loose Routing mechanism is to be applied or not.

This attribute may also be included in the IMS Subscriber object.

ssoMsisdn

Sub-MO [nillable]

Optional (0-n)

A list of MSISDN used for Single Sign-On (SSO) authentication.

ssoMsisdn

String

Pattern value = [0-9]*

minLength value = "5"

maxLength value = "15"

Mandatory

Identifies an MSISDN used for SSO authentication.

numOfFailedSipAuthAttempts

Integer

Optional (0-1)

Contains the number of failed authentication attempts.

accessIdentifier

Sub-MO [nillable]

Optional (0-n)

A list of Network Access Identifier assigned to the multiServiceConsumer (Private User).

accessIdentifier

String

maxLength value = "255"

Mandatory

Contains a Network Access Identifier assigned to the multiServiceConsumer (Private User).

userAccessLineIdentifier

Sub-MO [nillable]

Optional (0-n)

Contains a list of physical line identifiers of end-user equipment in a wireline access network.

lineName

String

minLength value="1"

maxLength value="15"

Optional (0-1)

Identifies the Access Line

value

String

maxLength value =" 255"

Optional (0-1)

Identifies the Access Line, physically.

authMechanism

String

Enumeration value = "NBA"

Enumeration value = "NBA_LINE_PROFILE"

Enumeration value = "DIGEST_LINE_PROFILE"

Optional (0-1)

Contains the authentication type to be supported by the Access Line.

publicData

Sub-MO [nillable]

Optional (0-n)

A list of public data related to one or more MultiSCs (Private Users).

publicIdValue

String

SIP URI (restricted)= sip:userinfo host where userinfo=user or telephone-subscriber and in both cases followed by an @

User and telephone-subscriber do not allow the following:
" \", " <" or " >", " @", " [" or " ]", " "", " " (space), Tab, CR, or LF.

In case of a Wildcard SIP URI, the user or telephone-subscriber ends in “!.*!”

In case of a Wildcard Extended SIP URI, the user or telephone-subscriber contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Host=hostname or IPv4address or IPv6reference. See Reference [8] for detailed description of host contents. When the configuration parameter AllowSipUriWithoutDomain is set to true, host is not mandatory.

or

TEL URL (restricted)= tel:global-phone-number where global-phone-number= “+” followed by digits 0-9 . In case of a Wildcard TEL URL the global-phone-number ends in “!.*!”

In case of a Wildcard Extended TEL URI, the global-phone-number contains an Extended Regular Expression placed between a pair of exclamation marks (" !").

Maximum length = 255

Mandatory

Can only be added

Identifies the Public Identity. ⁽³⁾

Can be either a:

Restricted SIP URI or TEL URL, Wildcard SIP URI or Wildcard TEL URL, Wildcard Extended SIP URI or Wildcard Extended TEL URL.

Examples:

• sip -
  sip:impu1@operator.com

• tel -
  tel:+34657881898

Can be derived from IMSI or MSISDN.

Examples:

• sip -
  sip:IMSI@ims.mncXXX.mccXXX.
  3gppnetwork.org
  sip:+MSISDN@ims.mncXXX.mccXXX.
  3gppnetwork.org

• tel -
  tel:+MSISDN

Wildcard can be used in both SIP URI and TEL URL. The wildcard has the format !.*!.

For SIP URI, the wildcard is to be placed before the “@” character. For TEL URL, the wildcard is to be placed at the end of the parameter.

Examples of SIP URI with wildcard:

• sip:department1!.*!@operator.com

• sip:!.*!@operator.com

Examples of TEL URL with wildcard:

• tel:+34657!.*!

• tel:+!.*!

Wildcard Extended is supported from 12B, and must be indicated as such with the isWildcardExtended parameter.

The wildcard extended has the format of a TEL URL or a SIP URI that can be defined with an extended regular expression.

Examples of Wildcard Extended are:

• tel:+34!91[0-9]{7,7}!

• tel:+34!91[0-9]{7,7}!4

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!@operator.com

• sip:ExW.Us![a-zA-Z]{2,2}[0-9]!_public@operator.com

privateUserId

String

minLength value="5"

maxLength value="70"

Optional (0-1)

Can only be added

This attribute indicates the associated PrivateUser to this PublicUser. If this attribute is not present, all PrivateUsers belonging to the subscriber which the PublicUser belongs to are associated to this PublicUser.

xcapAllowed

Boolean {true, false}

Optional (0-1)

States if the Public Identity can also be used in XCAP authentication.

Default value is: false.

If the IMPU is a PSI or if it is a wildcarded public identity or a TEL URL, then XCAP authentication must be set to false.

xcapPassword

String [nillable]

minLength value="4"

minLength value="255"

Optional (0-1)

Used for XCAP authentication service purposes.

If value is not provisioned and xcapAllowed = TRUE, then the IMPI userPassword is used for XCAP authentication.

implicitRegSet

Integer

Mandatory

Identifies the Implicit Registration Set (IRS) which the Public Identity belongs to.

The first defined Public Identity of an ISR automatically becomes the default Public Identity in the ISR.

If the Public Identity does not belong to an IRS, the value of this attribute must be 0.

A wildcarded IMPU must belong to an IRS set to a value different from 0.

isDefault

Boolean {true, false}

Optional (0-1)

This attribute indicates if the Public Identity is the default of its IRS.

When an IMPU of a specific type is set to default, the former one of the same types is unmarked automatically as such. Only one IMPU of each type (SIP URI or TEL URL) can be defined as default in a set. The first IMPU of an IRS must be marked as default.

serviceProfileId

String

maxLength value="66"

Optional (0-1)

Serves as a reference to identify the Subscriber Service Profile assigned for the specific Public Identity.

wirelineAccessAllowed

String

Enumeration value = "ALLOWED_FROM_ANY_LOCATION"

Enumeration value = "ALLOWED_ONLY_FROM_RAL"

Enumeration value = "ALLOWED_FROM_AUTHORIZED_LOCATIONS"

Enumeration value = "ALLOWED_FROM_ANY_LOCATION_EXCEPT_IF_NO_PANI"

Enumeration value = "ALLOWED_ONLY_IF_PANI_INCL_AUTH_LOCATION"

Optional (0-1)

Indicates if the Public Identity is allowed to access from nomad locations.

authorizedVisitedAccessLine

String

maxLength value="255"

Optional (0-n)

Contains a list of userAccessLineIdentifier sub-MO identifiers, indicating the access lines that are allowed to be connected. ⁽⁴⁾

sessionBarringInd

Boolean {true, false}

Optional (0-1)

Indicates if the Public Identity is barred for HSS session establishment.

Default value is: false

maxNumberOfContacts

Integer

When configuration parameter ExMaxNumberOfContacts is set to true:

minInclusive value="1"

maxInclusive value="200"

When configuration parameter ExMaxNumberOfContacts is set to false:

minInclusive value="1"

Pattern value =""\d{1}"

maxInclusive value="5"

Optional (0-1)

Indicates the maximum number of contacts that are allowed.

When configuration parameter ExMaxNumberOfContacts is set to false, default value is 1.

priorityLevel

Integer [nillable]

minLength value="0"

maxLength value="4"

Optional (0-1)

Indicates the service priority level for the IMS Public Identity (IMPU).

isWildcardExtended

Boolean {true, false}

Optional (0-1)

This attribute indicates if the IMPU is defined as a Wildcard Extended public identity (using extended regular expression to define the identity).

true or false

aliasGroupId

String [nillable]

Optional

Indicates which Alias Group the Public Identity belongs to.

When adding the IMPU to an Alias Group, the IMPU must already belong to an IRS. Also, the ImsIrs and ImsServProfId attributes of the IMPU must have the same values as other IMPUs in the Alias Group.

It is not allowed to move the IMPU between Alias Groups in a single operation just by changing the ImsAliasGroupId attribute from one non-zero value to another.

If the IMPU stores Transparent Data specific to the IMPU, then it is not allowed to add the IMPU to an Alias Group.

privateUserIdState

Sub-MO

Optional (0-1)

Contains a list of structures indicating the registration state of each of the Private Identities associated to a specific Public Identity.

privateUserId

String

minLength value="5"

maxLength value="70"

Mandatory

Identifies the PrivateUser

state

String

Enumeration value = "NOT_REGISTERED"

Mandatory

Contains the registration state.

State can only be set to NOT_REGISTERED

numOfFailedXcapAuthAttempts

Integer

Optional (0-1)

Contains the number of failed XCAP authentication attempts.

numOfFailedXcapAuthAttempts can only be set to 0.

subscriberServiceProfile

Sub-MO [nillable]

Optional (0-n)

A list of subscriber service profiles associated to a public identity.

serviceProfileId

String

maxLength value="66"

Optional (0-1)

Identifies the subscriber service profile.

configuredServiceProfile

Sub-MO [nillable]

Optional (0-n)

Contains a list of all the Service Profiles in HSS-FE associated to the Subscriber Service Profile.

configuredServiceProfileId

String

maxLength value="255"

Mandatory

Identifies the configured service profile.

subscribedMediaProfile

Unsigned integer

Optional (0-1)

Used to identify the set of session description parameters that the PrivateUser is authorized to request.

maxNumberSessions

Unsigned integer

Optional (0-1)

Defines the maximum number of simultaneous sessions allowed for the user equipment.

Default value is: 1

phoneContext

String

minLength Value = "0"

maxLength value = "255"

Optional (0-1)

Defines the default dialing context used by the S-CSCF to determine which dialing plan rules that applies to a request originating from a specific Public Identity when the terminating party is identified by local phone number. If a domain name is used, it does not need to be a routable domain since it is used for logically scooping dialing plans and not for IP routing. ⁽⁵⁾

To pass validation, phoneContext must be: 1 to 15 digits with + at the beginning, or a Domain (where a . is mandatory).

1-15 digits

Example: +3586675550123

Domain

Example: fc3c399fb513f501c36b6dca35c7105de336b296d0.it

individualServiceProfile

Sub-MO [nillable]

Optional (0-n)

Contains a list of individual service profiles associated to a specific subscriber service profile.

individualServiceProfileId

String

minLength value="5"

maxLength value="63"

Optional (0-1)

Used to identify an individual service profile.

individualCapability

Unsigned integer [nillable]

Optional (0-n)

Contains a list of capabilities needed for the execution of the service associated with this individual service profile.

It can only take values in the range [1 - 100].

The values in the set formed by individualCapability and individualOptionalCapability cannot be repeated.

individualOptionalCapability

Unsigned integer [nillable]

Optional (0-n)

Contains a list of optional capabilities needed for the execution of the service associated with this individual service profile

The values in the set formed by individualCapability and individualOptionalCapability cannot be repeated.

individualTrigger

Sub-MO [nillable]

Optional (0-n)

A list of individual triggers associated to a specific individual service profile.

triggerDescription

String

maxLength value="69"

Optional (0-1)

Identifies the trigger.

triggerPriority

Unsigned integer

Optional (0-1)

Identifies the priority of the trigger. The priority must be unique for a certain subscriber service profile.

Only even values are allowed.

isActive

Boolean {true, false}

Optional (0-1)

Indicates that this specific trigger is enabled.

Default value is: false

triggerType

String

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING _UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-1)

Used to identify the type of the trigger. If this attribute is empty, the trigger applies to all registration cases.

The trigger criteria belong to the group 0.

detectionPoint

String

maxLength value="255"

Optional (0-1)

Indicates when the trigger is evaluated.

The trigger criteria belong to the group 0.

negatedDetectionPoint

Boolean {true, false}

Optional (0-1)

Indicates if the Detection Point is negated or not.

conditionType

String

Enumeration value = "AND"

Enumeration value = "OR"

Optional (0-1)

This attribute indicates the relationship among the different criteria within the same trigger criteria group. The condition applies only to the attributes: triggerType, detectionPoint, requestedURI, sipHeader, and registrationType.

"AND" means that the trigger criteria are linked by an AND operator.

"OR" means that the trigger criteria are linked by an OR operator.

The opposite as the one defined applies to the relation among the different groups.

requestedURI

String

maxLength value="255"

Optional (0-1)

Defines a trigger condition based on the content of the Request-uri for the request.

The trigger criteria belong to the group 0.

negatedRequestedURI

Boolean {true, false}

Optional (0-1)

Indicates if the Requested URI is negated or not.

sipHeader

String [nillable]

maxLength value="255"

Optional (0-n)

Contains a list of structures identifying a SIP Header of this specific trigger.

The trigger criteria belong to the group 0.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

applicationServer

String

maxLength value="255"

Optional (0-1)

Presents the Application Server that is applied for this specific trigger.

registrationType

String [nillable]

Enumeration value = "INITIAL_REGISTRATION"

Enumeration value = "RE-REGISTRATION"

Enumeration value = "DE-REGISTRATION"

Optional (0-2)

Contains a list of registration cases that restrict the trigger conditions when the trigger criteria group is 0. ⁽⁶⁾

defaultHandling

String

Enumeration value = "SESSION_CONTINUED"

Enumeration value = "SESSION_TERMINATED"

Optional (0-1)

Represents the default handling of the S-CSCF when the connection with the Application Server of the current trigger cannot be established.

includeRegisterRequest

Boolean {true, false} [nillable]

Optional (0-1)

This parameter indicates if whether the tag IncludeRegisterRequest is included or not in the 3GPP User-Data AVP.

includeRegisterResponse

Boolean {true, false} [nillable]

Optional (0-1)

This parameter indicates whether the tag IncludeRegisterResponse is included or not in the 3GPP User-Data AVP.

triggerCriteriaGroup

Sub-MO [nillable]

Optional (0-n)

A list of trigger criteria groups associated to a specific individual TriggerA

groupId

Integer

Optional (0-1)

This attribute identifies each SPT Group. The value cannot be 0.

sessionDescription

String [nillable]

maxLength value="255"

Optional (0-1)

Defines the trigger criteria for the content of any Session Description Protocol (SDP) field within the body of a SIP method. Format: <NegatedSessionDescription>:<SDLine>: <Content>

Example:

FALSE:m:audio49170 RTP/AVP 0 Or

FALSE:m

Type:

<Boolean>:<String>:<String>

sessionCase

String [nillable]

Enumeration value = "ORIGINATING"

Enumeration value = "TERMINATING_REGISTERED"

Enumeration value = "TERMINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING"

Enumeration value = "NOT_TERMINATING_REGISTERED"

Enumeration value = "NOT_TERMINATING_UNREGISTERED"

Enumeration value = "NOT_ORIGINATING_UNREGISTERED"

Enumeration value = "ORIGINATING_CDIV"

Enumeration value = "NOT_ORIGINATING_CDIV"

Optional (0-1)

Defines the trigger criteria for the session cases. If this attribute is empty, the trigger applies to all registration cases.

sipMethod

String [nillable]

maxLength value="255"

Optional (0-1)

Indicates when the trigger is evaluated. It includes the SIP method and the registration type when applies.

Format:

<NegatedSipMethod>:<SipMethod>: <RegistrationType>

Example:

FALSE:Subscribe

Or

FALSE:Register:2

Type:

<Boolean>:<String>:<enumerated>

groupRequestedURI

String [nillable]

maxLength value="255"

Optional (0-1)

Defines a trigger condition based on the content of the Request-uri for the request.

Format:

<NegatedGroupRequestedUri>:<GroupRequestedUri>

Example:

FALSE:intranet.ericsson.com

Type:

<Boolean>:<String>

sipHeader

String [nillable]

maxLength value="255"

Optional (0-1)

Contains a list of structures identifying a SIP Header of this specific trigger.

Format:

The format shown below MUST be written on the same line.

<NegatedHeader>:<SIPHeaderName>:<SIPHeaderContent>
If a ":" character is used in the <SIPHeaderContent>, it needs to be escape, since this character is acting as a delimiter. The ":" character need to be written as "\:"
Example -
FALSE:Event:/presence/

TRUE:Refer-To:sip\:user2@ericsson.com

Or

<NegatedHeader>:<SIPHeaderName>

Type:

<Boolean>:<String>:<String>

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

associationId

String

maxLength value = "32"

Mandatory

Contains the identifier of the Association (subscriber).

Note that associationId is a new parameter to provision in UDC compared to Monolithic solution. The customer system should be properly adapted to make sure that the associationId does not exceed the maximum length 32. This means that it is not a good idea to use the subscriberId from Monolithic as associationId in UDC. The recommendation is also to NOT use any of the subscriber Identifiers (like IMSI, MSISDN, IMPI, IMPU) as associationId. This, since features like IMSI Changeover will only change impacted subscriber Identifiers, it will not change the assocaitionId. Use any random value or other value the customer has.

12006

DATABASE LOCKED FOR BACKUP

This information varies depending on the actual error.

IMSAssociation

C/S/D

12013

OPERATION FAILED, ROLLBACK HAS BEEN PERFORMED SUCCESSFULLY

This information varies depending on the actual error.

IMSAssociation

C

12014

OPERATION FAILED, ROLLBACK WAS UNSUCCESSFUL

This information varies depending on the actual error.

IMSAssociation

C

13001

SERVICE NOT DEFINED

IMPI not defined

IMSAssociation

S

IMPU not defined

IMSAssociation

S

13002

SERVICE ALREADY DEFINED

IMPI defined and IMS service exist

IMSAssociation

C/S

IMSI defined and IMS service exist

IMSAssociation

C/S

MSISDN defined and IMS service exist

IMSAssociation

S

secIMPI already defined for this IMPI: <IMPI>

IMSAssociation

S

13003

IDENTITY MISMATCH

MSISDN joint to other identities

IMSAssociation

C/S

IMSI joint to other identities

IMSAssociation

C/S

IMPU joint to other association (subscriber)

IMSAssociation

C/S

IMSI identities are in conflict

IMSAssociation

C/S

IMSI changeover ongoing

IMSAssociation

C/S

This secIMPI is not valid: <secIMPI>

IMSAssociation

C/S

13004

ASSOCIATION ALREADY DEFINED

This information varies depending on the actual error.

IMSAssociation

C

13005

ASSOCIATION NOT DEFINED

This information varies depending on the actual error.

IMSAssociation

S/G/D

13006

INCONSISTENT DATA IN CUDB

This information varies depending on the actual error.

IMSAssociation

C/S/G/D

13007

SERVICE DATA DOES NOT EXIST

List of one or more MO Attributes that do not exist for this service.

IMSAssociation

S

13008

OPERATION NOT ALLOWED

Operation not allowed during IMSICHO.

IMSAssociation

S

14001

CONSTRAINT VIOLATION

MO Attributes which are incompatible⁽¹⁾.

IMSAssociation

C/S