8.2 Generic DM SDT modules management

Note

This clause defines generic guidelines for handling all DM SDT modules; clause 8.3. will add detailed information for each specific module.

8.2.1 Create DM SDT <flexContainer>

Besides the generic create procedure defined in oneM2M TS-0001 [2] clause 10.1.2, the procedure in table 8.2.1-1 shall be used.

Table 8.2.1-1: DM SDT <flexContainer> CREATE

<flexContainer> CREATE
Information in Request message	*From:* Identifier of the IPE that initiates the Request *To:* The address of the [flexNode] where the <flexContainer> resource is intended to be Created *Content:* The representation of the <flexContainer> resource for which the attributes are described in oneM2M TS-0023 [3] clause 5.8.
Processing at Originator before sending Request	The Originator should be a Creator IPE that manages the corresponding entity in the Proximal IoT Technology. The Originator first collects the Proximal IoT Technology specific data model object (the management tree structure or also the value of the tree nodes if needed) of the Proximal IoT device and transforms the object into the DM SDT <flexContainer> resource representation, then requests the Hosting CSE to create the corresponding <flexContainer> resource. See note.
Processing at Receiver	According to clause 10.1.2
Information in Response message	According to clause 10.1.2
Processing at Originator after receiving Response	The originator shall create at least the mandatory children, if any, of the created <flexContainer> (e.g. [reboot] as child of [dmAgent]).
Exceptions	The creation of the DM SDT <flexContainer> object is not allowed The created DM SDT <flexContainer> object already exists

Note

    - the Creator IPE shall create at least the custom attributes that correspond to mandatory datapoints of SDT moduleClasses;

it should create as many as possible custom attributes that correspond to optional datapoints of SDT moduleClasses;
it should not create optional attributes that have no associated equivalent in the Proximal IoT Technology specific data model.

8.2.1.1 Create <subscription >

Update requests to this created <flexContainer> shall be retargeted to the Managing IPE. For this, the IPE can create a <subscription> resource, child of the <flexContainer> resource, with the attributes given in Table 8.2.1.1-1.

Table 8.2.1.1-1: <subscription> resource

Attributes of <subscription> resource	Description / Value
notificationURI	IPE URI
notificationContentType	all attributes
notificationEEventType	G. Update to attributes of the subscribed-to resource with blocking UPDATE

8.2.2 Retrieve DM SDT <flexContainer>

This procedure shall be used to retrieve information from an existing DM SDT <flexContainer> resource. Besides the generic retrieve procedure defined in oneM2M TS-0001 [3] clause 10.1.3, the procedure in table 8.2.2-1 shall be used.

Table 8.2.2-1: DM SDT <flexContainer> RETRIEVE

<flexContainer> RETRIEVE
Information in Request message	*From:* Identifier of the AE or the CSE that initiates the Request *To:* The address of the DM SDT <flexContainer> resource
Processing at Originator before sending Request	None
Processing at Receiver	According to clause 10.1.3,
Information in Response message	Error code if the new technology specific data model object cannot be retrieved
Processing at Originator after receiving Response	None
Exceptions	Corresponding technology specific object data cannot be retrieved from the managed entity (e.g. technology specific object not found)

Note

the Managing IPE is responsible for providing updated data to DM SDT <flexContainer> resources of the entities it manages (see clause 6.2.2).

8.2.3 Update DM SDT <flexContainer>

This procedure shall be used to update information of an existing DM SDT <flexContainer> resource. Besides the generic update procedure defined in oneM2M TS-0001 [2] clause 10.1.4, the procedure in table 8.2.3-1 shall be used.

Table 8.2.3-1: <flexContainer> UPDATE

DM SDT <flexContainer> UPDATE
Information in Request message	*From:* Identifier of the AE or the CSE that initiates the Request *To:* The address of the DM SDT <flexContainer> resource *Content:* The representation of the <flexContainer> resource for which the attributes are described in oneM2M TS-0023 [3] clause 5.8.
Processing at Originator before sending Request	None
Processing at Receiver	Send a blocking UPDATE notification to the Managing IPE. Wait for the notification response. If the notification is successful, modify the current <flexContainer> with the attributes in the originating request.
Processing at Managing IPE	The Managing IPE is responsible for invoking the appropriate non-oneM2M Proximal IoT function(s). See NOTIFY procedures on each DM flexContainer specialization in clauses 8.3.*
Information in Response message	The resource (or attributes defined in the originating request, depending on the result content) as it has been modified.
Processing at Originator after receiving Response	None
Exceptions	Error code if a timeout happens before the notification completes, otherwise returns the retargeted response. Error code if the request is trying to modify a read-only attribute (see note). Error code if the Managing IPE returned an error.

Note

    - The creation and update of the &lt;flexContainer>'s custom attributes that correspond to datapoints specified as R (read only) in clauses 5.8.x of TS-0023 [\[3\]](../2.1/#_ref_3) are allowed only to the Creator and Managing IPE.

The <flexContainer>'s custom attributes that correspond to datapoints specified as RW are updatable by external AEs. This is ensured by the Managing IPE when it is notified about the UPDATE request.

8.2.4 Delete DM SDT <flexContainer >

This procedure shall be used to delete an existing DM SDT < flexContainer > resource. Besides the generic delete procedure defined in oneM2M TS-0001 [2] clause 10.1.5, the procedure in table 8.2.4-1 shall be used.

Table 8.2.4-1: DM SDT < flexContainer > DELETE

DM SDT <flexContainer> DELETE
Information in Request message	*From:* Identifier of the AE, or the CSE that initiates the Request *To:* The address of the <flexContainer> resource
Processing at Originator before sending Request	The Originator should be a Creator or Managing IPE that manages the corresponding entity in the Proximal IoT Technology.
Processing at Receiver	According to clause 10.1.5
Information in Response message	Error code OPERATION_NOT_ALLOWED if the <flexContainer> resource corresponds to a mandatory entity in the SDT data model (e.g. [dmDeviceInfo]).
Processing at Originator after receiving Response	None
Exceptions	Corresponding technology specific data model object cannot be deleted from managed entity (e.g. not reachable, technology specific data model object not found)

8.2.5 Notify on DM SDT <flexContainer>

Following the <subscription> resource defined in clause 8.2.1.1, the Managing IPE shall be notified when the <flexContainer>, representing a DM SDT module, will be updated by an external entity. The IPE is responsible for invoking the appropriate non-oneM2M Proximal IoT function(s) when any change in the <flexContainer> resource, as specified in the received notification, is meant to trigger the execution of that non-oneM2M Proximal IoT function. For specific behaviour, depending on the type of <flexContainer>, see clause 8.3.

If the triggered IoT function is not successful (timeout or returned error), the Managing IPE shall respond to the notification with an error, otherwise it will respond with success.

If the UPDATE request contains custom attributes that correspond to read-only datapoints, the Managing IPE shall raise an error.

If the UPDATE request contains custom attributes that correspond to optional read-write datapoints that are not present in the resource, the Managing IPE may raise an error (there can be exceptions to this rule, for instance the description attribute of the [dmDeviceInfo]).