5 Mapping

32.3073GPPConfiguration Management (CM)Notification Integration Reference Point (IRP)Release 9SOAP Solution Set (SS)Telecommunication managementTS

5.1 Operation mapping

Notification IRP: IS (3GPP TS 32.302 [5]) defines semantics of operations visible across this IRP. These operations are the operations of the IOCs defined in 3GPP TS 32.302 [5].

Table 5.1 maps the operations defined in Notification IRP: IS (3GPP TS 32.302 [5]) to their equivalents (methods) in this Solution Set (SS). Specifically, the table 5.1 maps the operations of the IOCs defined in 3GPP TS 32.302 [5] to their equivalents in this SS. Since one of the IOCs, the NotificationIRP IOC, inherits from the ManagedGenericIRP IOC [4], the table 5.1 also maps the operations of ManagedGenericIRP IOC to their equivalents (methods) in this SS.

Table 5.1 also qualifies if a method is Mandatory (M) or Optional (O).

Table 5.1: Mapping from IS Operation to SS Equivalents

IS Operations in 3GPP TS 32.302 [5]

SS Operations

Qualifier

subscribe

subscribe

M

unsubscribe

unsubscribe

M

getSubscriptionIds

getSubscriptionIds

O

getSubscriptionStatus

getSubscriptionStatus

O

changeSubscriptionFilter

changeSubscriptionFilter

O

suspendSubscription

suspendSubscription

O

resumeSubscription

resumeSubscription

O

getNotificationCategories

getNotificationCategories

O

getIRPVersion (see note.)

getIRPVersion

M

getOperationProfile (see note.)

getOperationProfile

O

getNotificationProfile (see note.)

getNotificationProfile

O

NOTE: These 3 operations are operations of ManagedGenericIRP IOC specified in 3GPP TS 32.312 [4].
The NotificationIRP IOC of 3GPP TS 32.302 [5] inherits from it.

5.2 Filter language

The filter language used in the SS is the XPath Language (see W3C XPath 1.0 specification [13]). IRPAgents may throw a FilterComplexityLimit fault when a given filter is too complex.

5.3 Common datatype definition

5.3.1 NotificationCategorySetType

<complexType name="NotificationCategorySetType">

<complexContent>

<extension base="ntfIRPData:VersionNumberSetType">

</extension>

</complexContent>

</complexType>

5.3.2 SubscriptionStateType

<simpleType name="SubscriptionStateType">

<restriction base="string">

<enumeration value="Suspended"/>

<enumeration value="NotSuspended"/>

</restriction>

</simpleType>

5.4 Operation parameter mapping

3GPP TS 32.302 [5] defines semantics of parameters carried in operations across the Notification IRP. The tables below show the mapping of these parameters, as per operation, to their equivalents defined in this SS.

5.4.1 Operation subscribe

5.4.1.1 Input parameters

Table 5.4.1.1: Mapping from IS subscribe input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

managerReference

anyURI managerReference

M

timeTick

long timeTick

O

notificationCategories

ntfIRPData:NotificationCategorySetType notificationCategories

O

filter

string filter (see note 1)

O

anyURI ntfTransServiceNS (see note 2)

M

NOTE1: The grammar of the filter string is XPath defined by W3C XPath 1.0 specification [12].

NOTE2: This parameter is used to specify the name space of the Web Notification Transmission Service that will be used for sending notification.
The “http://www.3gpp.org/ftp/Specs/archive/32_series/32.307/schema/32307-810/notification” URI
should be supported.

Here is the XML schema fragment of the subscribe request:

<!– subscribe Request –>

<element name="subscribe">

<complexType>

<sequence>

<element name="managerReference" type="anyURI"/>

<element name="timeTick" type="long" minOccurs="0"/>

<element name="notificationCategories" type="ntfIRPData:NotificationCategorySetType" minOccurs="0"/>

<element name="filter" type="string" minOccurs="0"/>

<element name="ntfTransServiceNS" type="anyURI"/>

</sequence>

</complexType>

</element>

5.4.1.2 Output parameters

Table 5.4.1.2: Mapping from IS subscribe output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionId

string subscriptionId

M

status

ntfIRPData:subscribeFault

M

Here is the XML schema fragment of the subscribe response:

<!– subscribe Response –>

<element name="subscribeResponse">

<complexType>

<sequence>

<element name="subscriptionId" type="string"/>

</sequence>

</complexType>

</element>

5.4.1.3 Fault definition

<!– subscribe Fault –>

<element name="subscribeFault">

<complexType>

<choice>

<element name="AlreadySubscribedFault" type="string"/>

<element name="AtLeastOneNotificationCategoryNotSupportedFault" type="string"/>

<element name="subscribeFault" type="string"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.2 Operation unsubscribe

5.4.2.1 Input parameters

Table 5.4.2.1: Mapping from IS unsubscribe input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

managerReference

anyURI managerReference

M

subscriptionId

string subscriptionId

O

Here is the XML schema fragment of the unsubscribe request:

<!– unsubscribe Request –>

<element name="unsubscribe">

<complexType>

<sequence>

<element name="managerReference" type="anyURI"/>

<element name="subscriptionId" type="string" minOccurs="0"/>

</sequence>

</complexType>

</element>

5.4.2.2 Output parameters

Table 5.4.2.2: Mapping from IS unsubscribe output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

Status

ntfIRPData:unsubscribeFault

M

Here is the XML schema fragment of the unsubscribe response:

<!– unsubscribe Response –>

<element name="unsubscribeResponse">

</element>

5.4.2.3 Fault definition

<!– unsubscribe Fault –>

<element name="unsubscribeFault">

<complexType>

<choice>

<element name="unsubscribeFault" type="string"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.3 Operation getSubscriptionIds

5.4.3.1 Input parameters

Table 5.4.3.1: Mapping from IS getSubscriptionIds input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

managerReference

anyURI managerReference

M

Here is the XML schema fragment of the getSubscriptionIds request:

<!– getSubscriptionIds Request –>

<element name="getSubscriptionIds">

<complexType>

<sequence>

<element name="managerReference" type="anyURI"/>

</sequence>

</complexType>

</element>

5.4.3.2 Output parameters

Table 5.4.3.2: Mapping from IS getSubscriptionIds output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionIdSet

sequence of string subscriptionIdSet

M

status

ntfIRPData:getSubscriptionIdsFault

M

Here is the XML schema fragment of the getSubscriptionIds response:

<!– getSubscriptionIds Response –>

<element name="getSubscriptionIdsResponse">

<complexType>

<sequence>

<element name="subscriptionIdSet">

<complexType>

<sequence>

<element name="subscriptionId" type="string" maxOccurs="unbounded"/>

</sequence>

</complexType>

</element>

</sequence>

</complexType>

</element>

5.4.3.3 Fault definition

<!– getSubscriptionIds Fault –>

<element name="getSubscriptionIdsFault">

<complexType>

<choice>

<element name="getSubscriptionIdsFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.4 Operation getSubscriptionStatus

5.4.4.1 Input parameters

Table 5.4.4.1: Mapping from IS getSubscriptionStatus input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionId

string subscriptionId

M

Here is the XML schema fragment of the getSubscriptionStatus request:

<!– getSubscriptionStatus Request –>

<element name="getSubscriptionStatus">

<complexType>

<sequence>

<element name="subscriptionId" type="string"/>

</sequence>

</complexType>

</element>

5.4.4.2 Output parameters

Table 5.4.4.2: Mapping from IS getSubscriptionStatus output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

notificationCategories

ntfIRPData:NotificationCategorySetType notificationCategories

C

filterInEffect

string filterInEffect (see note)

O

SubscriptionState

ntfIRPData:SubscriptionStateType SubscriptionState

O

timeTick

long timeTick

O

status

ntfIRPData:getSubscriptionStatusFault

M

NOTE: The grammar of the filter string is XPath defined by W3C XPath 1.0 specification [12].

Here is the XML schema fragment of the getSubscriptionStatus response:

<!– getSubscriptionStatus Response –>

<element name="getSubscriptionStatusResponse">

<complexType>

<sequence>

<element name="notificationCategories" type="ntfIRPData:NotificationCategorySetType" minOccurs="0"/>

<element name="filterInEffect" type="string" minOccurs="0"/>

<element name="SubscriptionState" type="ntfIRPData:SubscriptionStateType" minOccurs="0"/>

<element name="timeTick" type="long" minOccurs="0"/>

</sequence>

</complexType>

</element>

5.4.4.3 Fault definition

<!– getSubscriptionStatus Fault –>

<element name="getSubscriptionStatusFault">

<complexType>

<choice>

<element name="getSubscriptionStatusFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.5 Operation changeSubscriptionFilter

5.4.5.1 Input parameters

Table 5.4.5.1: Mapping from IS changeSubscriptionFilter input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionId

string subscriptionId

M

filter

string filter (see note)

O

NOTE: The grammar of the filter string is XPath defined by W3C XPath 1.0 specification [12].

Here is the XML schema fragment of the changeSubscriptionFilter request:

<!– changeSubscriptionFilter Request –>

<element name="changeSubscriptionFilter">

<complexType>

<sequence>

<element name="subscriptionId" type="string"/>

<element name="filter" type="string" minOccurs="0"/>

</sequence>

</complexType>

</element>

5.4.5.2 Output parameters

Table 5.4.5.2: Mapping from IS changeSubscriptionFilter output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

status

ntfIRPData: changeSubscriptionFilterFault

M

Here is the XML schema fragment of the changeSubscriptionFilter response:

<!– changeSubscriptionFilter Response –>

<element name="changeSubscriptionFilterResponse">

</element>

5.4.5.3 Fault definition

<!– changeSubscriptionFilter Fault –>

<element name="changeSubscriptionFilterFault">

<complexType>

<choice>

<element name="changeSubscriptionFilterFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.6 Operation suspendSubscription

5.4.6.1 Input parameters

Table 5.4.6.1: Mapping from IS suspendSubscription input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionId

string subscriptionId

M

Here is the XML schema fragment of the suspendSubscription request:

<!– suspendSubscription Request –>

<element name="suspendSubscription">

<complexType>

<sequence>

<element name="subscriptionId" type="string"/>

</sequence>

</complexType>

</element>

5.4.6.2 Output parameters

Table 5.4.6.2: Mapping from IS suspendSubscription output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

status

ntfIRPData:suspendSubscriptionFault

M

Here is the XML schema fragment of the suspendSubscription response:

<!– suspendSubscription Response –>

<element name="suspendSubscriptionResponse">

</element>

5.4.6.3 Fault definition

<!– suspendSubscription Fault –>

<element name="suspendSubscriptionFault">

<complexType>

<choice>

<element name="suspendSubscriptionFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.7 Operation resumeSubscription

5.4.7.1 Input parameters

Table 5.4.7.1: Mapping from IS resumeSubscription input parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

subscriptionId

string subscriptionId

M

Here is the XML schema fragment of the resumeSubscription request:

<!– resumeSubscription Request –>

<element name="resumeSubscription">

<complexType>

<sequence>

<element name="subscriptionId" type="string"/>

</sequence>

</complexType>

</element>

5.4.7.2 Output parameters

Table 5.4.7.2: Mapping from IS resumeSubscription output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

status

ntfIRPData:resumeSubscriptionFault

M

Here is the XML schema fragment of the resumeSubscription response:

<!– resumeSubscription Response –>

<element name="resumeSubscriptionResponse">

</element>

5.4.7.3 Fault definition

<!– resumeSubscription Fault –>

<element name="resumeSubscriptionFault">

<complexType>

<choice>

<element name="resumeSubscriptionFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

<element ref="ntfIRPData:InvalidParameterFault"/>

</choice>

</complexType>

</element>

5.4.8 Operation getNotificationCategories

5.4.8.1 Input parameters

None.

Here is the XML schema fragment of the getNotificationCategories request:

<!– getNotificationCategories Request –>

<element name="getNotificationCategories">

</element>

5.4.8.2 Output parameters

Table 5.4.8.2: Mapping from IS getNotificationCategories output parameters to SS equivalents

IS Operation parameter

SS Method parameter

Qualifier

NotificationCategoryList

ntfIRPData:NotificationCategorySetType NotificationCategoryList

M

status

ntfIRPData:getNotificationCategoriesFault

M

Here is the XML schema fragment of the getNotificationCategories response:

<!– getNotificationCategories Response –>

<element name="getNotificationCategoriesResponse">

<complexType>

<sequence>

<element name="NotificationCategoryList" type="ntfIRPData:NotificationCategorySetType"/>

</sequence>

</complexType>

</element>

5.4.8.3 Fault definition

<!– getNotificationCategories Fault –>

<element name="getNotificationCategoriesFault">

<complexType>

<choice>

<element name="getNotificationCategoriesFault" type="string"/>

<element ref="ntfIRPData:OperationNotSupportedFault"/>

</choice>

</complexType>

</element>

5.5 Parameter mapping

Notification IRP: IS (3GPP TS 32.302 [5]) defines the semantics of common attributes carried in notifications. This SS does not provide the mapping of these attributes to their SOAP SS equivalents. Other IRPs such as Alarm IRP: IS (3GPP TS 32.111-2 [6]) identify and qualify these common attributes for use in their environment. Their corresponding SS documents define the mapping of these attributes to their SS equivalents.

5.6 NotificationIRPNotification Interface definition

The operation name is defined as “notify”.

5.6.1 Input parameters

Table 5.6.1: notify input parameters

IS Operation parameter

SS Method parameter

Qualifier

xe:Notification notification

M

The notifications of the various IRPs extend the input parameter above.

Here is the XML schema fragment of the notify request:

<!– notify Request –>

<element name="notify">

<complexType>

<sequence>

<element name="notificationHeaderAndBody" type="ntfIRPNtfData:AnySequenceType"/>

</sequence>

</complexType>

</element>

<complexType name="AnySequenceType">

<sequence>

<any namespace="##any" processContents="lax" maxOccurs="unbounded"/>

</sequence>

</complexType>

5.6.2 Output parameters

None.