8 UE Data Collection, Reporting and Notification API

26.5323GPPData Collection and ReportingProtocols and FormatsRelease 17TS

8.1 Overview

This clause specifies the UE Data Collection, Reporting and Notification API used by internal UE entities, namely a UE Application and the associated Direct Data Collection Client, in support of UE data collection by the Direct Data Collection Client for subsequent reporting to the Data Collection AF, and related exchange of notifications.

As noted in clause 4.3 of TS 26.531 [7] this API is not used when the Direct Data Collection Client is embedded in the UE Application (i.e., Collaboration E according to clause A.6 of [7]). However, this clause can serve as guidance to the design of the internal APIs for a UE Application with an embedded Direct Data Collection Client.

The UE architecture depicting the overall interactions between the UE Application and the Direct Data Collection Client is shown in figure 8.1-1.

Figure 8.1‑1: UE architecture for data collection, reporting and notification via R7 API

8.2 Direct Data Collection Client state model

8.2.1 Overview

Figure 8.2.1-1 represents an informative Direct Data Collection Client state model in order to properly describe the methods invoked on the R7 API. Five different states as indicated in the diagram are described in table 8.2.1-1.

Figure 8.2.1-1: State model diagram

The depicted Direct Data Collection Client is dedicated to a corresponding UE Application and would correspond to a context-specific instance in the case where a single logical Direct Data Collection Client supports multiple UE Applications in the UE. The state model does not imply any implementation requirements for an instance of the Direct Data Collection Client, but rather is intended for use as a model to support the description of the R7 API.

State changes may occur as result of:

– Registration or deregistration of the UE Application at the Direct Data Collection Client.

– Data collection and reporting configuration request by the UE Application.

– Data report received by the Direct Data Collection Client.

– Notification received by the Direct Data Collection Client (e.g., of a busy condition at, or impending failure/crash of, the UE Application).

– Timeout at the Direct Data Collection Client due to inactivity or prolonged busy state of the UE Application.

Table 8.2.1-1 defines the states of the Direct Data Collection Client.

Table 8.2.1-1: States of Direct Data Collection Client

State	Definition
IDLE	The Direct Data Collection Client has not yet registered a UE Application, or a previous registration has been revoked due to explicit deregistration request from that UE Application, or upon receiving notification of an impending fatal error condition at the UE Application, or upon local timer expiration due to inactivity or prolonged busy state of the UE Application.
REGISTERED	The Direct Data Collection Client has received valid registration from a UE Application. Having obtained the UE data collection and reporting configuration for that UE Application, it is now ready to provide the UE data collection and reporting configuration to the UE Application.
READY	The Direct Data Collection Client has received a valid request from and returns a UE data collection and reporting configuration to, the registered UE Application.
ACTIVE	The Direct Data Collection Client has received a UE data report, or a notification from the registered UE Application that the latter has recovered from a previously busy/stalled condition and is ready to send UE data reports to the Data Collection AF.
BUSY	The Direct Data Collection Client enters this state upon having received notification that its registered UE Application is in a temporarily busy state and unable to perform UE data reporting.

8.2.2 Direct Data Collection Client internal operations

This aspect is for further study.

8.2.3 Starting and stopping the Direct Data Collection Client

The Direct Data Collection Client (instance) shall be started (i.e., transition from IDLE to REGISTERED state) upon receiving a valid registration over R7 from a UE Application. Correspondingly, the Direct Data Collection Client shall be stopped (transition to IDLE state from one of several possible operating states) due to occurrence of one of the corresponding conditions as described in table 8.2.1-1.

8.3 Methods

8.3.1 Overview

Table 8.3.1-1 provides an overview of the methods and notifications defined for the UE Data Collection, Reporting and Notification API at reference point R7. Different types of method are indicated, namely:

1. State change of the Direct Data Collection Client triggered by the UE Application action (registration or deregistration).

2. Request from the UE Application to the Direct Data Collection Client for a UE data collection and reporting configuration.

3. Acknowledgment and related response information returned by the Direct Data Collection Client to the UE Application for a successful UE Application registration event.

4. Data report by the UE Application to the Direct Data Collection Client according to the previously obtained configuration.

5. Notification from the UE Application to the Direct Data Collection Client.

Table 8.3.1-1: Methods invoked by the UE Application on the Direction Data Collection Client

Method name	Type	Description
registerUeApplication	State change	UE Application registers with the Direct Data Collection Client, including a callback listener for receiving event notifications.
deregisterUeApplication	State change	UE Application deregisters with the Direct Data Collection Client.
setUserConsent		UE Application grants permission for the Direct Data Reporting Client to include the GPSI when creating Data Reporting Sessions.
getDataCollectionAnd‌ReportingConfiguration	Configuration request	UE Application obtains its UE data collection and reporting configuration from the Direct Data Collection Client.
reportUeData	Data report	UE Application reports collected UE data to the Direct Data Collection Client according to its configuration.
resetClientReportingIdentifier		UE Application requests that the Direct Data Collection Client generates a new opaque client reporting identifier for use in data reporting until further notice. This requires any existing Data Reporting Session to be destroyed and a new one (including the replacement client reporting identifier) to be created.
uEApplicationBusy	Notification	UE Application notifies the Direct Data Collection Client that it is temporarily unable to perform UE data collection and reporting due to a busy or stalled condition.
impendingUeApplication‌Failure	Notification	UE Application notifies the Direct Data Collection Client of an impending fatal error condition that will cause abrupt shutdown of the UE Application.

Table 8.3.1‑2 lists the different callback notifications from the Direct Data Collection Client to the UE Application.

Table 8.3.1-2: Notifications from the Direct Data Collection Client to the UE Application

Callback notification name	Description
dataCollectionAndReporting‌Configuration‌Changed	Direct Data Collection Client notifies the UE Application that the data collection and reporting configuration has changed.
dataCollectionClientBusy	Direct Data Collection Client notifies the UE Application that it is temporarily unable to support UE data collection and reporting due to a busy or stalled condition.
impendingDataCollectionClient‌Failure	Direct Data Collection Client notifies the UE Application of an impending fatal error condition that will cause abrupt shutdown of the Direct Data Collection Client.