Ericsson Device and Data Management

Last modified: Mar 5, 2019 @ 08:15

Release Notes

This document describes all the new features, enhancements, and changes included in this release of the Device and Data Management (DDM) service. For detailed information about using the DDM features, see the online documentation in the DDM documentation portal.

To find out what versions you have installed, check the information in the About window in your DDM Admin dashboard. 

Release Version: AppIoT_2018_35 [DDM Core] and LwM2M Gateway 1.4

Release Date: w42

Contents

Main End User Improvements

Additional information is found in section Release Details.

New Features
Write Resource Attributes on Smart Object Level.
Add a Smart Object instance to a Device instance through Web Admin API.
Send Smart Object list in Registration Update to avoid re-registration of Device.
Restart of LwM2M Gateway preserves existing security sessions.
Allow same LwM2M Gateway name in different Azure regions.

 

New Web Admin API Endpoints
GET /api/v3/devicetypes/{id}/smartobjecttypeinstances
GET /api/v3/devicetypes/{id}/smartobjecttypes
PUT /api/v3/locations/{id}/settingvalues
GET /api/v3/resourceattributedefinitions
POST /api/v3/resourceattributes/{deviceidentifier}/read
POST /api/v3/resourceattributes/{deviceidentifier}/{objectid}/read
POST /api/v3/resourceattributes/{deviceidentifier}/{objectid}/{instancenumber}/read
GET /api/v3/smartobjects/{id}/resourceattributes
GET /api/v3/smartobjecttemplates/{id}/resourceattributes
PUT /api/v3/smartobjecttemplates/{id}/resourceattributes

 

Other  End User Improvements
Fixed a problem with creating a Gateway with internal Device.
Improved performance while synchronizing Resource Collections for added Devices.
Improved performance while loading Smart Object Templates.
Improved LwM2M Notifications to continue being received after Gateway restart.
Added support to allow non-LwM2M devices to register through Gateway.
Added removal date March 2019 for deprecated API endpoints and properties.

 

Customer Issues  Solved
Issue Description ID
DDM does not discover custom smart object. Discover requests were not sent to paths beginning with ‘/0’ or ‘/1’. This has been fixed to only omit ‘/0/’ and ‘/1/’. These are Security and Server objects, and are omitted from discovery to not put unnecessary load on constrained devices. DDM-14475
Zombie device. Devices were not deleted when force-deleting a Gateway, resulting in “Zombie devices”. DDM-14262
API key value  changed when modifying its roles. API key value is now changed only when updating its name or expiration time. DDM-13366
Empty BootstrapServerName and device mass registration. Improved validation. Configuration is not sent to Bootstrap server if Bootstrap server is not set on device during mass registration. DDM-23301
DDM-65798
FOTA timing issue. Fixed issue where a Device FOTA state and expected state were out of sync. DDM-68161
StatusUpdatedTimestamp on parent entry is not updated. StatusUpdatedTimestamp on parent Activity Log is now updated when updating child Activity Log. DDM-78412
Device registration does not update availability of Smart Objects. Implemented support to handle Registration Update in DDM Core for marking smart objects as Available/Unavailable (green/red) in the same way as when receiving Device Register. DDM-87125
Users being removed from groups. Fixed issue where Initialize Roles removed Admin role from Device Networks. DDM-87142

Release Details

Features

New Features

Details for New Features – From Web Admin API and GUI Perspective (Northbound Interface)
Feature Description  Documentation 
Write Resource Attributes on Smart Object Level. Resource Attributes can be written to the device on Smart Object Type level or Smart Object Type Instance level by setting attribute values on a Smart Object Template.

This can be done either through Web Admin API or GUI.

See Resource Attributes
in the DDM documentation portal.
Also see section 5.4.4 Write-Attributes,
in the OMA LwM2M specification
Add a Smart Object instance to a Device instance through Web Admin API. When using API endpoint POST /api/v3/smartobjects, it is now possible to add a Smart Object instance to a Device instance without also adding it to the corresponding DeviceType. API documentation:

If you are using DDM standalone, see swagger.

If you are using Ericsson IoT Accelerator, see apidoc.
Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Send Smart Object list in Registration Update to avoid re-registration of Device. Support is implemented to handle Registration Update in DDM Core for marking Smart Objects as Available/Unavailable (green/red) in the same way as when receiving Device Register. No effect on DDM documentation.
Details for New Features – From Device Perspective (Southbound Interface)
Feature Description Documentation
Write Resource Attributes on Smart Object Level. This feature allows Resource Attributes to be sent from DDM to the Device. See
Resource Attributes in
the DDM documentation portal.
Also see section 5.4.4 Write-Attributes, in the OMA LwM2M specification
Send Smart Object list in Registration Update to avoid re-registration of Device. This feature allows a Device to inform about changes in its supported object list to DDM in Registration Update message payload, without needing to re-register. The full list of supported objects of the Device must be in this payload. See Queue Mode in the DDM documentation portal.
Restart of LwM2M Gateway preserves existing security sessions. This feature stores security session information persistently in DDM to prevent session loss after restart. This allows DDM to continue receiving notifications from Devices after DDM restarts. See Getting Started with LwM2M in the DDM documentation portal.
Allow same LwM2M Gateway name in different Azure regions.  LwM2M Gateway name is now unique per Azure region, so different regions can have LwM2M Gateways with same name. See Getting Started with LwM2M in the DDM documentation portal.

Web Admin API

New API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Web Admin API – New API Endpoint
Description
GET /api/v3/devicetypes/{id}/smartobjecttypeinstances
Returns a list of all SmartObjectTypeInstances with available SmartObjectTemplates.
GET /api/v3/devicetypes/{id}/smartobjecttypes
Returns a list of all SmartObjectTypes with available SmartObjectTemplates.
PUT /api/v3/locations/{id}/settingvalues
Modifies setting values for a Location. Can include values for multiple settings of different SettingCategories and can be used to add, update or delete setting values. Settings that are not included in the request will not be modified in any way.
GET /api/v3/resourceattributedefinitions
Returns a list of all available Resource Attribute Definitions.
POST /api/v3/resourceattributes/{deviceidentifier}/read
Executes a Read Attributes command for the specified Device.
POST /api/v3/resourceattributes/{deviceidentifier}/{objectid}/read
Executes a Read Attributes command for the specified Smart Object.
POST /api/v3/resourceattributes/{deviceidentifier}/{objectid}/{instancenumber}/read
Executes a Read Attributes command for the specified Smart Object Instance.
GET /api/v3/smartobjects/{id}/resourceattributes
Returns a list of Resource Attributes for a Smart Object.
GET /api/v3/smartobjecttemplates/{id}/resourceattributes
Returns a list of Resource Attributes for a Smart Object Template.
PUT /api/v3/smartobjecttemplates/{id}/resourceattributes
Updates the Resource Attributes of a Smart Object Template.

Changed API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Web Admin API – Changed API Endpoint
Description Change Description
POST /api/v3/dataCollectors/register
Registers a new DataCollector. Changed request parameters:

Settings are deprecated and will be removed in the first release after March 2019.

Managing settings is instead done using api/v3/datacollectors/{id}/settingvalues.

PUT /api/v3/dataCollectors/{id}
Updates the configuration for the DataCollector. Changed request parameters:

Settings are deprecated and will be removed in the first release after March 2019.

Managing settings is instead done using api/v3/datacollectors/{id}/settingvalues.

POST /api/v3/devicetemplates
Creates a DeviceTemplate. Changed request parameters:

SmartObjectTypes is deprecated and will be removed in the first release after March 2019.

The request parameter is replaced by SmartObjectTypeInstanceTemplates.

Added SmartObjectTypeInstanceTemplates.

PUT /api/v3/devicetemplates/{id}
Updates a DeviceTemplate. Changed request parameters:

SmartObjectTypes is deprecated and will be removed in the first release after March 2019.

The request parameter is replaced by SmartObjectTypeInstanceTemplates.

Added SmartObjectTypeInstanceTemplates.

GET /api/v3/devicetemplates
Returns a paged list of DeviceTemplates. Changed response body:

SmartObjectTypesWithTemplates is deprecated and will be removed in the first release after March 2019.

The response body is replaced by SmartObjectTypeInstanceTemplates.

Added SmartObjectTypeInstanceTemplates.

GET /api/v3/devicetemplates/{id}
Returns a single DeviceTemplate. Changed response body:

SmartObjectTypes is deprecated and will be removed in the first release after March 2019.

The response body is replaced by SmartObjectTypeInstanceTemplates.

Added SmartObjectTypeInstanceTemplates.

GET /api/v3/devicetypes/list/{deviceTypeId}/templates
Returns a list of templates for a DeviceType. Changed response body:

SmartObjectTypes is deprecated and will be removed in the first release after March 2019.

The response body is replaced by SmartObjectTypeInstanceTemplates.

Added SmartObjectTypeInstanceTemplates.

POST /api/v3/smartobjects
Creates a SmartObject with the resources belonging to the specified SmartObjectType. The SmartObject is added to the device specified in the request. Changed request parameters:

Added smartObject.InstanceNumber. Specifies the instance number of the SmartObject.

Cannot be changed on a PUT request.

Example: [SmartObjectType]/[InstanceNumber]/[ResourceType]

PUT /api/v3/smartobjects/{id}
Updates a SmartObject. Changed request parameters:

Added smartObject.InstanceNumber, which specifies the instance number of the SmartObject.

Cannot be changed on a PUT request.

Example: [SmartObjectType]/[InstanceNumber]/[ResourceType]

GET /api/v3/devices/datacollectorinternal/{dataCollectorId}
Return the Gateway’s Internal Device. The API endpoint is deprecated and will be removed in the first release after March 2019.
POST /api/v3/locations
Creates a new Location. Changed request parameters:

Settings are deprecated and will be removed in the first release after March 2019.

Managing settings is done using api/v3/locations/{id}/settingvalues.

PUT /api/v3/locations/{id}
Updates a Location. Changed request parameters:

Settings are deprecated and will be removed in the first release after March 2019.

Managing settings is done using api/v3/locations/{id}/settingvalues.

POST /api/v3/locations/{id}/settingcategories/{settingCategoryId}/settings
Adds a setting to a Location in a specific SettingCategory. The API endpoint is deprecated and will be removed in the first release after March 2019.
POST /api/v3/barcode
Parses Sens Barcode data into Hardware Type, Mac Address and checks if the device is registered in the Device Network. The API endpoint is deprecated and will be removed in the first release after March 2019.
GET /api/v3/dataCollectors/{id}/log
Get log posts written by the Data Collector or SensationBackend. The API endpoint is deprecated and will be removed in the first release after March 2019.
POST /api/v3/dataCollectors/{id}/downloadregistrationTicket
Returns the Data Collectors Registration tickets. This API endpoint needs the RegistrationTicket permission. The API endpoint is deprecated and will be removed in the first release after March 2019.
DELETE /api/v3/deviceNetworks/{id}
Removes a Device Network. The API endpoint is deprecated and will be removed in the first release after March 2019.
GET /api/v3/kpi/{resourceId}/{dimension}/since/{start}/untilNow
Returns a list of raw measurements for a resource from the specified time until now. The API endpoint is deprecated and will be removed in the first release after March 2019.
POST /api/v3/measurements/advanced
Advanced Measurement/KPI query. The API endpoint is deprecated and will be removed in the first release after March 2019.
PUT /api/v3/networkSettings/{id}
Updates a Network Setting. The API endpoint is deprecated and will be removed in the first release after March 2019
GET /api/v3/networkSettings/{id}
Returns a single Network Setting. The API endpoint is deprecated and will be removed in the first release after March 2019.
DELETE /api/v3/networkSettings/{id}
Removes a Network Setting. The API endpoint is deprecated and will be removed in the first release after March 2019.
GET /api/v3/networkSettings
Returns a paged list of Network Settings in the DeviceNetwork. The API endpoint is deprecated and will be removed in the first release after March 2019.
POST /api/v3/networkSettings
Creates a new Network Setting. The API endpoint is deprecated and will be removed in the first release after March 2019.
GET /api/v3/user/thumbnail
Downloads the current users thumbnail image from Azure AD. The API endpoint is deprecated and will be removed in the first release after March 2019.

Removed API Endpoints

API documentation:

  • If you are using DDM standalone, see swagger.
  • If you are using Ericsson IoT Accelerator, see apidoc.
    Note: Open this link with Google Chrome.

For details, see Overview of APIs in the DDM documentation portal.

Web Admin API – Removed  API Endpoints
API Endpoint Description Replaced with API Endpoint
Nothing for this release.

Known Limitations

Known Limitations
LwM2M Gateway restart will restore all previously existing connections to Devices, but there is no guarantee that all Devices will be able to use restored connections. Some Devices may not be able to send notifications over restored connections.
It is not possible to import hardware types and templates that were exported from a version earlier than AppIoT_2018_35.
The Resource Attributes and their values on the Smart Object Template cannot be exported/imported between Device Networks.

Known Issues

Known Issue
TransformerDevice does not transform.