4 Services offered by the DCCF

29.5743GPP5G SystemData Collection Coordination ServicesRelease 18Stage 3TS

4.1 Introduction

The Ndccf services are used for the DCCF to provide collected data.

The following services are specified for the DCCF:

Table 4.1-1: Services provided by DCCF

Service Name

Description

Service Operations

Operation

Semantics

Example Consumer(s)

Ndccf_DataManagement

This service enables the NF service consumers to subscribe to/unsubscribe from notifications for different collected data from the DCCF.

Subscribe

Subscribe / Notify

NWDAF, PCF, NSSF, AMF, SMF, NEF, AF, ADRF

Unsubscribe

Notify

Fetch

Request / Response

NWDAF, PCF, NSSF, AMF, SMF, NEF, AF, ADRF

Ndccf_ContextManagement

This service enables the NF service consumers to register/deregister collected data in the DCCF.

Register

Request / Response

NWDAF, ADRF

Update

Deregister

Table 4.1-2 summarizes the corresponding APIs defined for this specification.

Table 4.1-2: API Descriptions

Service Name

Clause

Description

OpenAPI Specification File

apiName

Annex

Ndccf_DataManagement

5.1

DCCF Data Management Service

TS29574_Ndccf_DataManagement.yaml

ndccf-datamanagement

A.2

Ndccf_ContextManagement

5.2

DCCF Context Management Service

TS29574_Ndccf_ContextManagement.yaml

ndccf-contextmanagement

A.3

4.2 Ndccf_DataManagement Service

4.2.1 Service Description

4.2.1.1 Overview

The Ndccf_DataManagement service, as defined in 3GPP TS 23.288 [14], is provided by the Data Collection Coordination Function (DCCF).

This service:

– allows NF service consumers to subscribe, modify and unsubscribe for analytics or data releated events;

– notifies NF service consumers with a corresponding subscription about observed events; and

– allows NF service consumers to retrieve analytics or data according to the Fetch Instructions provided by DCCF.

4.2.1.2 Service Architecture

The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture, including the DCCF architecture, is defined in 3GPP TS 23.288 [14].

Known consumers of the Ndccf_DataManagement service are:

– Policy Control Function (PCF)

– Network Slice Selection Function (NSSF)

– Access and Mobility Management Function (AMF)

– Session Management Function (SMF)

– Network Exposure Function (NEF)

– Application Function (AF)

– Network Data Analytics Function (NWDAF)

– Analytics Data Repository Function (ADRF)

The Ndccf_DataManagement service is provided by the DCCF and consumed by the NF service consumers as shown in figure 4.2.1.2-1 for the SBI representation model and in figure 4.2.1.2-2 for the reference point representation model.

Figure 4.2.1.2-1: Ndccf_DataManagement service architecture, SBI representation

Figure 4.2.1.2-2: Ndccf_DataManagement service architecture, reference point representation

4.2.1.3 Network Functions

4.2.1.3.1 Data Collection Coordination Function (DCCF)

The DCCF (Data Collection Coordination Function) provides the functionality to coordinate collection of analytics and/or data from one or more NFs based on requests from one or more NF service consumers.

4.2.1.3.2 NF Service Consumers

The NF service consumers for the Ndccf_DataManagement service are as specified in 3GPP TS 29.520 [15] clause 4.2.1.3.2 for the Nnwdaf_EventsSubscription service, with the following differences:

– The NWDAF as a service consumer supports also (un)subscription to the notification of data collection events from the DCCF.

– The CEF and the DCCF are not NF service consumers of the Ndccf_DataManagement service.

4.2.2 Service Operations

4.2.2.1 Introduction

Service operations defined for the Ndccf_DataManagement Service are shown in table 4.2.2.1-1.

Table 4.2.2.1-1: Ndccf_DataManagement Service Operations

Service Operation Name

Description

Initiated by

Ndccf_DataManagement_Subscribe

This service operation is used by an NF service consumer to subscribe to, or modify a subscription in the DCCF for event notifications.

NF service consumer (NWDAF, PCF, NSSF, AMF, SMF, NEF, AF, ADRF)

Ndccf_DataManagement_Unsubscribe

This service operation is used by an NF service consumer to unsubscribe from event notifications.

NF service consumer (NWDAF, PCF, NSSF, AMF, SMF, NEF, AF, ADRF)

Ndccf_DataManagement_Notify

This service operation is used by the DCCF to report the detected event(s) to the NF service consumer if subscribed before.

DCCF

Ndccf_DataManagement_Fetch

This service operation is used by an NF service consumer to retrieve collected data from the DCCF.

NF service consumer (NWDAF, PCF, NSSF, AMF, SMF, NEF, AF, ADRF)

4.2.2.2 Ndccf_DataManagement_Subscribe service operation

4.2.2.2.1 General

The Ndccf_DataManagement_Subscribe service operation is used by an NF service consumer to create or update a subscription for analytics or data notifications from the DCCF.

4.2.2.2.2 Subscription for analytics notifications

Figure 4.2.2.2.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to subscribe for analytics notifications.

Figure 4.2.2.2.2-1: NF service consumer subscribes to analytics notifications

The NF service consumer shall invoke the Ndccf_DataManagement_Subscribe service operation to subscribe to analytics notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/analytics-subscriptions" as Resource URI representing the "DCCF Analytics Subscriptions", as shown in figure 4.2.2.2.2-1, step 1, to create an "Individual DCCF Analytics Subscription" according to the information in the message body. The NdccfAnalyticsSubscription data structure provided in the request body shall include:

– analytics subscription information within the "anaSub" attribute;

– a notification target address within the "anaNotifUri" attribute; and

– a notification correlation identifier in the "anaNotifCorrId" attribute;

and may include:

– formatting instructions within the "formatInstruct" attribute;

– processing instructions within the "procInstrct" attribute;

– a target NWDAF identifier within the "targetNfId" attribute or a target NWDAF set identifier within the "targetNfSetId" attribute;

– an ADRF identifier within the "adrfId" attribute or an ADRF set identifier within the "adrfSetId" attribute; and/or

– time window of performing the requested analytics within the "timePeriod" attribute.

NOTE: This time window, over which the requested data collection or analytics was performed or to be performed, is different from the analytics target period, over which the statistics or predictions are requested. For example, in a subscription that requests "predictions that are performed during the month of May about UE_MOBILITY analytics during the month of July", this time window is "May" while the analytics target period is "July". The DCCF can use the provided time window e.g. to determine when to (un)subscribe to the NWDAF and/or what subscription duration to indicate to it.

– the purpose of data collection within the "dataCollectPurposes" attribute.

– the indication that the NF service consumer has already checked the user consent within the "checkedConsentInd" attribute.

Upon the reception of an HTTP POST request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/subscriptions" as Resource URI and NdccfAnalyticsSubscription data structure as request body, the DCCF shall use the contents of the request (e.g. "anaSub" attribute in NdccfAnalyticsSubscription data structure) to determine whether the subscription can already be served or interactions with the NWDAF and/or ADRF (e.g. creation or modification of analytics subscription for Nnwdaf_AnalyticsSubscription service) are required. If the DCCF cannot use the contents of the request to determine this, the DCCF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION_CANNOT_BE_SERVED".

NOTE 1: The "SUBSCRIPTION_CANNOT_BE_SERVED" error can occur, for example, when the request is syntactically valid and there is no DCCF internal error, but the DCCF can neither find an existing subscription to an NWDAF nor construct one based on the received subscription contents.

If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the DCCF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [20]. If the DCCF receive the response from the UDM that it is not granted for the impacted user(s), then the DCCF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER_CONSENT_NOT_GRANTED".

NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.

If the DCCF determines that the subscription can already be served (without requiring further interactions with NWDAF and/or ADRF) or a successful response from the NWDAF and/or ADRF is received for the creation or modification of subscription(s) to serve this subscription, the DCCF shall:

– create a new subscription;

– assign a subscriptionId;

– store the subscription.

If the DCCF created an "Individual DCCF Analytics Subscription" resource, the DCCF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.2.2.2.2-1, step 2. If not all the requested analytics events in the subscription are accepted, then the DCCF may include the "failEventReports" attribute within the "anaSub" attribute, indicating the event(s) for which the subscription failed and the associated reason(s). The DCCF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/ndccf-datamanagement/<apiVersion>/analytics-subscriptions/{subscriptionId}". If the immediate reporting indication in the "immRep" attribute within the "evtReq" attribute of the "anaSub" attribute sets to true in the event subscription, the DCCF shall include the reports of the events subscribed, if available, in the HTTP POST response.

If an error occurs when processing the HTTP POST request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

4.2.2.2.3 Update subscription for analytic notifications

Figure 4.2.2.2.3-1: NF service consumer updates subscription to analytics notifications

The NF service consumer shall invoke the Ndccf_DataManagement_Subscribe service operation to update a subscription to analytics notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/analytics-subscriptions/{subscriptionId}" as Resource URI, as shown in figure 4.2.2.2.3-1, step 1, to update the subscription for an "Individual DCCF Analytics Subscription" resource identified by the {subscriptionId}. The NdccfAnalyticsSubscription data structure provided in the request body shall include the same contents as described in clause 4.2.2.2.2.

Upon the reception of an HTTP PUT request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/analytics-subscriptions/{subscriptionId}" as Resource URI and NdccfAnalyticsSubscription data structure as request body, the DCCF shall use the contents of the request to determine whether the updated subscription can already be served or interactions with the NWDAF and/or ADRF (e.g. modification of analytics subscriptions with the NWDAF) are required. If the DCCF cannot use the contents of the request to determine this, the DCCF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION_CANNOT_BE_SERVED".

NOTE 1: The "SUBSCRIPTION_CANNOT_BE_SERVED" error can occur, for example, when the request is syntactically valid and there is no DCCF internal error, but the DCCF can neither find an existing subscription to an NWDAF nor construct one based on the received subscription contents.

If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations, then the DCCF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [20]. If the DCCF receive the response from the UDM that it is not granted for the impacted user(s), then the DCCF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER_CONSENT_NOT_GRANTED".

NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.

If the DCCF determines that the updated subscription can already be served (without requiring further interactions with NWDAF and/or ADRF) or a successful response from the NWDAF and/or ADRF is received for the creation or modification of subscription(s) to serve this subscription, the DCCF shall:

– update the subscription of corresponding subscriptionId; and

– store the subscription.

If the DCCF successfully updated the "Individual DCCF Analytics Subscription" resource, the DCCF shall respond with:

a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.2.2.2.3-1, step 2a. If not all the requested analytics events in the subscription are modified successfully, then the DCCF may include the "failEventReports" attribute indicating the event(s) for which the modification failed and the associated reason(s); or

b) HTTP "204 No Content" status code, as shown in figure 4.2.2.2.3-1, step 2b.

If an error occurs when processing the HTTP PUT request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

If the DCCF determines the received HTTP PUT request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.2.4 Subscription for data notifications

Figure 4.2.2.2.4-1 shows a scenario where the NF service consumer sends a request to the DCCF to subscribe for data notifications.

Figure 4.2.2.2.4-1: NF service consumer subscribes to data notifications

The NF service consumer (i.e. NWDAF) shall invoke the Ndccf_DataManagement_Subscribe service operation to subscribe to data notification(s). The NF service consumer shall send an HTTP POST request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions" as Resource URI, as shown in figure 4.2.2.2.4-1, step 1, to create a subscription for an "Individual DCCF Data Subscription" resource according to the information in message body. The NdccfDataSubscription data structure provided in the request body shall include:

– a notification target address within the "dataNotifUri" attribute;

– a notification correlation identifier within the "dataNotifCorrId" attribute; and

– a data subscription within the "dataSub" attribute, which contains one of the following:

– AMF event exposure subscription within the "amfDataSub" attribute;

– SMF event exposure subscription within the "smfDataSub" attribute;

– UDM event exposure subscription within the "udmDataSub" attribute;

– NEF event exposure subscription within the "nefDataSub" attribute;

– AF event exposure subscription within the "afDataSub" attribute;

– NRF event exposure subscription within the "nrfDataSub" attribute;

– NSACF event exposure subscription within the "nsacfDataSub" attribute;

and may include:

– formatting instructions within the "formatInstruct" attribute;

– processing instructions within the "procInstrct" attribute;

– a target NF identifier within the "targetNfId" attribute" or a target NF set identifier within the "targetNfSetId" attribute";

– an ADRF identifier within the "adrfId" attribute or an ADRF set identifier within the "adrfSetId" attribute; and/or

– time window of the occurrence of the requested data collection within the "timePeriod" attribute.

NOTE: The DCCF can use the provided time window e.g. to determine when to (un)subscribe to the data source NF and/or what subscription duration to indicate to it.

– the purpose of data collection within the "dataCollectPurposes" attribute.

– the indication that the NF service consumer has already checked the user consent within the "checkedConsentInd" attribute.

Upon the reception of an HTTP POST request with: "{apiRoot}/ndccf-datamanagement/<apiVersion>/subscriptions" as Resource URI and NdccfDataSubscription data structure as request body, the DCCF shall use the contents (e.g. "smfDataSub" attribute in NdccfDataSubscription data structure) of the request to determine whether the subscription can already be served or interactions with data sources (e.g. creation or modification of event exposure subscription for Nsmf_EventExposure service) are required. If the DCCF cannot use the contents of the request to determine this , the DCCF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION_CANNOT_BE_SERVED".

NOTE 1: The "SUBSCRIPTION_CANNOT_BE_SERVED" error can occur, for example, when the request is syntactically valid and there is no DCCF internal error, but the DCCF can neither find an existing subscription to a data source nor construct one based on the received subscription contents.

If the user consent has not been checked by the NF service consumer and is required for the requested data collection depending on local policy and regulations, then the DCCF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [20]. If the DCCF receive the response from the UDM that it is not granted for the impacted user(s), then the DCCF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER_CONSENT_NOT_GRANTED".

NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.

If the DCCF determines that the subscription can already be served (without requiring further interactions with the data sources) or a successful response from the data source(s) is received for the creation or modification of subscription(s) to serve this subscription, the DCCF shall:

– create a new subscription;

– assign a subscriptionId;

– store the subscription.

If the DCCF created an "Individual DCCF Data Subscription" resource, the DCCF shall respond with "201 Created" with the message body containing a representation of the created subscription, as shown in figure 4.2.2.2.4-1, step 2. The DCCF shall include a Location HTTP header field. The Location header field shall contain the URI of the created subscription i.e. "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions/{subscriptionId}".

If an error occurs when processing the HTTP POST request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

4.2.2.2.5 Update subscription for data notifications

Figure 4.2.2.2.5-1: NF service consumer updates subscription to data notifications

The NF service consumer (i.e. NWDAF) shall invoke the Ndccf_DataManagement_Subscribe service operation to update a subscription to data notifications. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions/{subscriptionId}" as Resource URI, as shown in figure 4.2.2.2.5-1, step 1, to update the subscription for an "Individual DCCF Data Subscription" resource identified by the {subscriptionId}. The NdccfDataSubscription data structure provided in the request body shall include the same contents as described in clause 4.2.2.2.4.

Upon the reception of an HTTP PUT request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions/{subscriptionId}" as Resource URI and NdccfDataSubscription data structure as request body, the DCCF shall use the contents of the request to determine whether the updated subscription can already be served or interactions with the data sources (e.g. modification of event exposure subscriptions) are required. If the DCCF cannot use the contents of the request to determine this, the DCCF shall send an HTTP "400 Bad Request" error response including the "cause" attribute set to "SUBSCRIPTION_CANNOT_BE_SERVED".

NOTE 1: The "SUBSCRIPTION_CANNOT_BE_SERVED" error can occur, for example, when the request is syntactically valid and there is no DCCF internal error, but the DCCF can neither find an existing event exposure subscription nor construct one based on the received subscription contents.

If the user consent has not been checked by the NF service consumer and is required for the requested analytics collection depending on local policy and regulations), then the DCCF shall check user consent for the targeted UE(s) by retrieving the user consent subscription data via the Nudm_SDM service API of the UDM as described in clause 5.2.2 of 3GPP TS 29.503 [20]. If the DCCF receive the response from the UDM that it is not granted for the impacted user(s), then the DCCF shall send an HTTP "403 Forbidden" error response including the "cause" attribute set to "USER_CONSENT_NOT_GRANTED".

NOTE 2: When the target of reporting is a SUPI or a GPSI then the subscription can be rejected, e.g. because user consent is not granted, and the error is sent to the consumer. When the target of reporting is an Internal Group Id, or a list of SUPIs/GPSI(s) or any UE, and the user consent is not granted for a subset of the impacted users, then no error is sent, but a subset of the SUPIs/GPSIs is skipped if user consent is not granted.

If the DCCF determines that the updated subscription can already be served (without requiring further interactions with the data sources) or a successful response from the data source(s) is received for the creation or modification of subscription(s) to serve this subscription, the DCCF shall:

– update the subscription of the corresponding subscriptionId; and

– store the subscription.

If the DCCF successfully updated the "Individual DCCF Data Subscription" resource, the DCCF shall respond with:

a) HTTP "200 OK" status code with the message body containing a representation of the updated subscription, as shown in figure 4.2.2.2.5-1, step 2a; or

b) HTTP "204 No Content" status code, as shown in figure 4.2.2.2.5-1, step 2b.

If an error occurs when processing the HTTP PUT request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

If the DCCF determines the received HTTP PUT request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.3 Ndccf_DataManagement_Unsubscribe service operation

4.2.2.3.1 General

The Ndccf_DataManagement_Unsubscribe service operation is used by an NF service consumer to remove a subscription for analytics or data notifications from the DCCF.

4.2.2.3.2 Unsubscribe from analytics notifications

Figure 4.2.2.3.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to unsubscribe from analytics notifications.

Figure 4.2.2.3.2-1: NF service consumer unsubscribes from analytics notifications

The NF service consumer shall invoke the Ndccf_DataManagement_Unsubscribe service operation to unsubscribe from analytics notifications. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/ndccf-datamanagement /<apiVersion>/analytics-subscriptions/{subscriptionId}" as Resource URI representing an "Individual DCCF Analytics Subscription" resource, as shown in figure 4.2.2.3.2-1, step 1, where "{subscriptionId}" is the identifier of the existing analytics subscription that is to be deleted.

Upon the reception of an HTTP DELETE request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/analytics-subscriptions /{subscriptionId}" as Resource URI, if the DCCF successfully processed and accepted the received HTTP DELETE request, the DCCF shall:

– remove the corresponding subscription;

– respond with HTTP "204 No Content" status.

If errors occur when processing the HTTP DELETE request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

If the DCCF determines the received HTTP DELETE request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.3.3 Unsubscribe from data notifications

Figure 4.2.2.3.3-1 shows a scenario where the NF service consumer sends a request to the DCCF to unsubscribe from data notifications.

Figure 4.2.2.3.3-1: NWDAF unsubscribes from data notifications

The NWDAF shall invoke the Ndccf_DataManagement_Unsubscribe service operation to unsubscribe to data notifications. The NWDAF shall send an HTTP DELETE request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions/{subscriptionId}" as Resource URI representing an "Individual DCCF Data Subscription" resource, as shown in figure 4.2.2.3.3-1, step 1, where "{subscriptionId}" is the identifier of the existing data subscription that is to be deleted.

Upon the reception of an HTTP DELETE request with "{apiRoot}/ndccf-datamanagement/<apiVersion>/data-subscriptions /{subscriptionId}" as Resource URI, if the DCCF successfully processed and accepted the received HTTP DELETE request, the DCCF shall:

– remove the corresponding subscription;

– respond with HTTP "204 No Content" status.

If errors occur when processing the HTTP DELETE request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

If the DCCF determines the received HTTP DELETE request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.4 Ndccf_DataManagement_Notify service operation

4.2.2.4.1 General

The Ndccf_DataManagement_Notify service operation is used by DCCF to notify NF service consumers about subscribed events related to analytics or data.

4.2.2.4.2 Notification about subscribed analytics

Figure 4.2.2.4.2-1 shows a scenario where the DCCF sends a request to the NF Service Consumer to notify it about analytics event(s).

NF service consumer

DCCF

1

.

POST

{

notificationURI

}

2

.

204

No Content

Figure 4.2.2.4.2-1: DCCF notifies the NF service consumer about a subscribed analytics event

The DCCF shall invoke the Ndccf_DataManagement_Notify service operation to notify about a subscribed analytics event. The DCCF shall send an HTTP POST request with "{notificationURI}" as Resource URI (where "{notificationURI}" has the value of the notification URI received in the NdccfAnalyticsSubscription data structure of the Ndccf_DataManagement_Subscribe service operation, see clause 5.1.5 for the definition of this notification URI), as shown in figure 4.2.2.4.2-1, step 1. The NdccfAnalyticsSubscriptionNotification data structure provided in the request body shall include:

– the analytics notification correlation identifier within the "anaNotifCorrId" attribute;

– the time stamp which represents the time when DCCF completes preparation of the requested analytics within the "timeStamp" attribute;

– one of the following:

– information about network data analytics function events that occurred in the "anaNotifications" attribute;

– summarized analytics derived from events based on processing instructions and formatting instructions that occurred in the "anaReports" attribute;

– information for fetching the contents of the notification in the "fetchInstruct" attribute.

The NdccfAnalyticsSubscriptionNotification data structure provided in the request body may include:

– a termination request provided by the DCCF within the "terminationReq" attribute.

If the NF service consumer successfully processed and accepted the received HTTP POST request, the NF service consumer shall:

– store the notification;

– respond with HTTP "204 No Content" status code.

If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7.

If NF service consumer determines the received HTTP POST request needs to be redirected, the NF service consumer shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.4.3 Notification about subscribed data event

Figure 4.2.2.4.3-1 shows a scenario where the DCCF sends a request to the NF Service Consumer to notify it about data event(s).

NWDAF

DCCF

1

.

POST

{

notificationURI

}

2

.

204

No Content

Figure 4.2.2.4.3-1: DCCF notifies the NF service consumer about a subscribed data event

The DCCF shall invoke the Ndccf_DataManagement_Notify service operation to notify about a subscribed data event. The DCCF shall send an HTTP POST request with "{notificationURI}" as Resource URI (where "{notificationURI}" has the value of the notification URI received in the NdccfDataSubscription data structure of the Ndccf_DataManagement_Subscribe service operation, see clause 5.1.5 for the definition of this notification URI), as shown in figure 4.2.2.4.3-1, step 1. The NdccfDataSubscriptionNotification data structure provided in the request body shall include:

– the data notification correlation identifier within the "dataNotifCorrId" attribute;

– the time stamp which represents the time when DCCF completes preparation of the requested data within the "timeStamp" attribute;

– one of the following:

– the data notification within the "dataNotif" attribute;

– summarized data derived from events based on processing instructions and formatting instructions that occurred in the "dataReports" attribute;

– information for fetching the contents of the notification in the "fetchInstruct" attribute.

The NdccfDataSubscriptionNotification data structure provided in the request body may include:

– a termination request provided by the DCCF within the "terminationReq" attribute.

If the NF service consumer successfully processed and accepted the received HTTP POST request, the NF service consumer shall:

– store the notification;

– respond with HTTP "204 No Content" status code.

If errors occur when processing the HTTP POST request, the NF service consumer shall send an HTTP error response as specified in clause 5.1.7.

If the NWDAF determines the received HTTP POST request needs to be redirected, the NWDAF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.2.2.5 Ndccf_DataManagement_Fetch service operation

4.2.2.5.1 General

The Ndccf_DataManagement_Fetch service operation is used by an NF service consumer to retrieve analytics or data notifications indicated by fetch instructions from the DCCF.

4.2.2.5.2 Retrieve notified analytics and data

Figure 4.2.2.5.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to retrieve notified analytics or data.

Figure 4.2.2.5.2-1: NF service consumer requesting to retrieve notified analytics or data

The NF service consumer shall invoke the Ndccf_DataManagement_Fetch service operation to retrieve notified analytics or data. The NF service consumer shall send an HTTP POST request to the URI "{fetchUri}" which was previously provided by the DCCF within a FetchInstruction data structure in a DCCF notification, as shown in figure 4.2.2.5.2-1, step 1, to request notified analytics or data from the DCCF.

The request body shall include fetch correlation identifiers, which were previously provided by the DCCF in the "fetchCorrIds" attribute within FetchInstruction data structure in the DCCF notification.

Upon the reception of the HTTP POST request, the DCCF shall:

– find the analytics or data according to the request.

If requested analytics is found, the DCCF shall respond with "200 OK" status code with the message body containing the NdccfAnalyticsSubscriptionNotification data structure. The NdccfAnalyticsSubscriptionNotification data structure in the response body shall include the same contents as described in clause 4.2.2.4.2 with the difference that the "fetchInstruct" attribute shall not be included.

If requested data is found, the DCCF shall respond with "200 OK" status code with the message body containing the NdccfDataSubscriptionNotification data structure. The NdccfDataSubscriptionNotification data structure in the response body shall include the same contents as described in clause 4.2.2.4.3 with the difference that the "fetchInstruct" attribute shall not be included.

If the requested analytics or data does not exist, the DCCF shall respond with "204 No Content".

If an error occurs when processing the HTTP POST request, the DCCF shall send an HTTP error response as specified in clause 5.1.7.

If the DCCF determines the received HTTP POST request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.3 Ndccf_ContextManagement Service

4.3.1 Service Description

4.3.1.1 Overview

The Ndccf_ContextManagement service, as defined in 3GPP TS 23.288 [14], is provided by the Data Collection Coordination Function (DCCF).

This service:

– allows NF service consumers to register, update or deregister the collected data or analytics information in the DCCF.

4.3.1.2 Service Architecture

The 5G System Architecture is defined in 3GPP TS 23.501 [2]. The Network Data Analytics Exposure architecture, including the DCCF architecture, is defined in 3GPP TS 23.288 [14].

Known consumers of the Ndccf_ContextManagement service are:

– Network Data Analytics Function (NWDAF)

– Analytics Data Repository Function (ADRF)

The Ndccf_ContextManagement service is provided by the DCCF and consumed by the NF service consumers (e.g. NWDAF, ADRF) as shown in figure 4.3.1.2-1 for the SBI representation model and in figure 4.3.1.2-2 for the reference point representation model.

Figure 4.3.1.2-1: Ndccf_ContextManagement service architecture, SBI representation

Figure 4.3.1.2-2: Ndccf_ContexManagement service architecture, reference point representation

4.3.1.3 Network Functions

4.3.1.3.1 Data Collection Coordination Function (DCCF)

The DCCF (Data Collection Coordination Function) provides functionality to create, update, and delete data collection profiles.

4.3.1.3.2 NF Service Consumers

The NWDAF and ADRF may register and/or update a data collection profile to the DCCF to enable data consumers to get the data which has been collected by NWDAF or ADRF directly (i.e. not via DCCF).

4.3.2 Service Operations

4.3.2.1 Introduction

Service operations defined for the Ndccf_ContextManagement Service are shown in table 4.3.2.1-1.

Table 4.3.2.1-1: Ndccf_ContextManagement Service Operations

Service Operation Name

Description

Initiated by

Ndccf_ContextManagement_Register

This service operation is used by an NF service consumer to register data or analytics it is collecting in the DCCF.

NF service consumer (NWDAF, ADRF)

Ndccf_ContextManagement_Update

This service operation is used by an NF service consumer to update an existing data or analytics registration.

NF service consumer (NWDAF, ADRF)

Ndccf_ContextManagement_Deregister

This service operation is used by an NF service consumer to delete an existing data or analytics registration.

NF service consumer (NWDAF, ADRF)

4.3.2.2 Ndccf_ContextManagement_Register service operation

4.3.2.2.1 General
4.3.2.2.2 Register data collection profile to DCCF

Figure 4.3.2.2.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to register data or analytics it is collecting to the DCCF.

Figure 4.3.2.2.2-1: NF service consumer registers data collection profile

The NF service consumer shall invoke the Ndccf_ContextManagement_Register service operation to register data or analytics it is collecting to the DCCF. The NF service consumer shall send an HTTP POST request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles" as Resource URI representing the "DCCF Data Collection Profiles", as shown in figure 4.3.2.2.2-1, step 1, to create an "Individual DCCF Data Collection Profile" according to the information in the message body. The NdccfDataCollectionProfile data structure provided in the request body shall include:

– one of the following data or analytics collection information:

– analytics subscription information within the "anaSub" attribute;

– data subscription information within the "dataSub" attribute, which contains one of the following:

– AMF event exposure subscription within the "amfDataSub" attribute;

– SMF event exposure subscription within the "smfDataSub" attribute;

– UDM event exposure subscription within the "udmDataSub" attribute;

– NEF event exposure subscription within the "nefDataSub" attribute;

– AF event exposure subscription within the "afDataSub" attribute;

– NRF event exposure subscription within the "nrfDataSub" attribute;

– NSACF event exposure subscription within the "nsacfDataSub" attribute;

– one of the following identifiers related to the NF service consumer:

– NWDAF instance identifier within the "nwdafId" attribute;

– ADRF instance identifier within the "adrfId" attribute;

– NWDAF set identifier within the "nwdafSetId" attribute;

– ADRF set identifier within the "adrfSetId" attribute;

Upon the reception of an HTTP POST request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles" as Resource URI and NdccfDataCollectionProfile data structure as request body, the DCCF shall:

– create a new profile;

– assign a profileId;

– store the profile.

If the DCCF created an "Individual DCCF Data Collection Profile" resource, the DCCF shall respond with "201 Created" with the message body containing a representation of the created profile, as shown in figure 4.3.2.2.2-1, step 2. The DCCF shall include a Location HTTP header field. The Location header field shall contain the URI of the created profile, i.e. "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}".

If an error occurs when processing the HTTP POST request, the DCCF shall send an HTTP error response as specified in clause 5.2.7.

4.3.2.3 Ndccf_ContextManagement_Update service operation

4.3.2.3.1 General
4.3.2.3.2 Update registered data collection profile

Figure 4.3.2.3.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to update a registration of a data collection profile to the DCCF.

Figure 4.3.2.3.2-1: NF service consumer updates registered data collection profile

The NF service consumer (e.g. NWDAF or ADRF) shall invoke the Ndccf_ContextManagement_Update service operation to update a registration of data or analytics collection to DCCF. The NF service consumer shall send an HTTP PUT request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}" as Resource URI, as shown in figure 4.3.2.3.2-1, step 1, to update the registration of data or analytics for an "Individual DCCF Data Collection Profile" resource identified by the {profileId}. The NdccfDataCollectionProfile data structure provided in the request body shall include the same contents as described in clause 4.3.2.2.

Upon the reception of an HTTP PUT request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}" as Resource URI and NdccfDataCollectionProfile data structure as request body, the DCCF shall:

– update the profile of the corresponding profileId; and

– store the profile.

If the DCCF successfully processed and accepted the received HTTP PUT request, the DCCF shall update an "Individual DCCF Data Collection Profile" resource, and shall respond with:

a) HTTP "200 OK" status code with the message body containing a representation of the updated profile, as shown in figure 4.3.2.3.2-1, step 2a; or

b) HTTP "204 No Content" status code, as shown in figure 4.3.2.3.2-1, step 2b.

If an error occurs when processing the HTTP PUT request, the DCCF shall send an HTTP error response as specified in clause 5.2.7.

If the DCCF determines the received HTTP PUT request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].

4.3.2.4 Ndccf_ContextManagement_Deregister service operation

4.3.2.4.1 General
4.3.2.4.2 Deregister Data collection profile

Figure 4.3.2.4.2-1 shows a scenario where the NF service consumer sends a request to the DCCF to delete a registration of data collection profile.

Figure 4.3.2.4.2-1: NF service consumer deregisters data collection profile

The NF service consumer shall invoke the Ndccf_ContextManagement_Deregister service operation to delete a registration of data or analytics collection profile to the DCCF. The NF service consumer shall send an HTTP DELETE request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}" as Resource URI representing an "Individual DCCF Data Collection Profile" resource, as shown in figure 4.3.2.4.2-1, step 1, where "{profileId}" is the identifier of the existing Data Collection Profile that is to be deleted.

Upon the reception of an HTTP DELETE request with "{apiRoot}/ndccf-contextmanagement/<apiVersion>/data-collection-profiles/{profileId}" as Resource URI, if the DCCF successfully processed and accepted the received HTTP DELETE request, the DCCF shall:

– remove the corresponding registered profile;

– respond with HTTP "204 No Content" status.

If errors occur when processing the HTTP DELETE request, the DCCF shall send an HTTP error response as specified in clause 5.2.7.

If the DCCF determines the received HTTP DELETE request needs to be redirected, the DCCF shall send an HTTP redirect response as specified in clause 6.10.9 of 3GPP TS 29.500 [4].